Skip to content

Installation

Matt MacDougall edited this page Sep 9, 2026 · 1 revision

Installation

Install this development version in an isolated Mage-OS or Magento Open Source environment first. Read Known limitations, especially if the project needs multiple inventory locations.

Package and platform requirements

Requirement Source at the reviewed commit
Composer package mage-os/module-netsuite-connector
Magento module MageOS_NetSuiteConnector
PHP namespace MageOS\NetSuiteConnector
PHP constraint PHP 8.1, 8.2, 8.3, 8.4, or 8.5; also satisfy the host platform's PHP requirements.
Framework constraint magento/framework: ^103.0 or ^104.0
SOAP SDK ryanwinchester/netsuite-php: ^2024.2
Enum library myclabs/php-enum: ^1.8
Runtime PHP SOAP support, the host platform dependencies, MSI APIs used by this module, database and writable Magento var/media directories.
Scheduling Magento cron for maintenance, plus a separate scheduler entry for connector synchronization.

These are package constraints and source dependencies, not a tested compatibility matrix. The README names Mage-OS 3.4.0 and Magento Open Source 2.4.8-p4 test targets, but this repository contains no CI runs or standalone test harness confirming those claims. See Testing and validation.

Composer installation

Packagist published only dev-main when checked on September 9, 2026. Use an explicit development constraint; the unversioned composer require example in the README may fail under a stable-only project policy.

From the store root:

composer require 'mage-os/module-netsuite-connector:dev-main'
bin/magento module:enable MageOS_NetSuiteConnector
bin/magento setup:upgrade
bin/magento config:set mageos_netsuite/general/enabled 0
bin/magento cache:clean

Keep synchronization unscheduled while configuring the integration. The shipped enable flag is 1, and several flows also default to enabled. The explicit disable step above prevents ordinary queue processing while the initial configuration is prepared. It does not undo the installation-wide stock hooks described in Inventory.

For a review pinned to this wiki's source, use mage-os/module-netsuite-connector:dev-main#fec65e2b67e18da3d9d3bf4c007d3c7fd5228537 as the Composer constraint and retain the resulting lock file. Recheck the code and wiki before moving that reference.

Use the host project's normal dependency compilation and static-asset deployment process when its deployment mode requires them. Verify bin/magento module:status MageOS_NetSuiteConnector and bin/magento list netsuite after installation.

Source checkout

A development checkout belongs at app/code/MageOS/NetSuiteConnector. The host store must still resolve the SDK and enum dependencies through Composer. Copying this repository by itself does not install them. Do not install the same module simultaneously in app/code and vendor.

First configuration

Open Stores > Configuration > Mage-OS > NetSuite, or System > NetSuite > Settings. Use the default configuration scope, complete NetSuite setup, select the intended flows, and test a small representative set of records.

The operational screen is System > NetSuite > Monitor Dashboard. A successful connection test only verifies a SOAP server-time request. It does not verify permissions for every record type, saved search, file, or workflow.

Existing Rocket Web installations

There is no automatic migration. The package declares Composer replace entries for seventeen Rocket Web packages. Composer replacement metadata is not a data migration mechanism. Review the complete dependency graph, custom extensions, tables, EAV attributes, and pending jobs before replacing an existing installation. Follow Migration from Rocket Web.

Sources: manifest, registration, module dependencies, defaults, admin menus.

Clone this wiki locally