Skip to main content

Installation and Upgrade

A supply chain application or solution built on InterSystems Supply Chain Orchestrator™ consists of the following components:

  • Core InterSystems IRIS® data platform

  • InterSystems Supply Chain Framework features delivered through InterSystems Package Manager (IPM)

    Together with InterSystems IRIS, this forms the core of Supply Chain Orchestrator.

  • Application or solution implementation code

The installation and upgrade process depends on which components are being installed or updated. This page provides detailed instruction for different scenarios.

Also see the online learning path Building Smart Real-Time Supply Chain ApplicationsOpens in a new tab.

New Installation

To deploy a new instance, there are three steps:

  1. Deploy InterSystems IRIS data platform.

  2. Deploy InterSystems Supply Chain Framework, thus creating the core of Supply Chain Orchestrator.

  3. Deploy application code.

InterSystems IRIS Deployment

There are different ways to deploy InterSystems IRIS: in containers, on Kubernetes, using installation kits, and so on. For more details on each approach, see Deployment.

Adding the Supply Chain Framework

After deploying an InterSystems IRIS server, use the following steps:

  1. Create a new namespace reserved for use by Supply Chain Orchestrator. This documentation uses the namespace name SC, but you can use a different name.


    Make sure that the namespace is interoperability-enabled and analytics-enabled. The latter option enables you to use the Business Intelligence Analyzer so that you can explore the cubes.

  2. Start the Terminal application and complete the rest of the steps in the Terminal.

    Or on Unix®, where the Terminal application is not available, start the ObjectScript shell.

  3. Change to the newly created namespace.

  4. Check to see if IPM is installed. To do so, enter the command zpm. If IPM is not installed, this command results in an error. If IPM is installed, the Terminal prompt then looks like this:


    Where the part after the colon is the namespace in which you are working.

  5. If InterSystems Package Manager (IPM) is not installed, install it as follows:

     set r = ##class(%Net.HttpRequest).%New()
     set r.Server="",
     set r.SSLConfiguration="ISC.FeatureTracker.SSL.Config" 
     do r.Get("/packages/zpm/latest/installer"),
     do $system.OBJ.LoadStream(r.HttpResponse.Data,"c") 

    For convenience, the following single line of code represents all the preceding lines.

    set r = ##class(%Net.HttpRequest).%New(),r.Server="",r.SSLConfiguration="ISC.FeatureTracker.SSL.Config" d r.Get("/packages/zpm/latest/installer"),$system.OBJ.LoadStream(r.HttpResponse.Data,"c") 

    Then start IPM. To do so, enter the command zpm

  6. If you do not yet have an IPM token, login to Pm.InterSystems.comOpens in a new tab using your InterSystems account credentials and obtain a token.

  7. At the IPM prompt, use the following command to log in to the IPM repository:

    repo -n registry -r -url -token YOUR_IPM_TOKEN

    Where YOUR_IPM_TOKEN is the IPM token from the previous step.

  8. Still at the IPM prompt, install InterSystems Supply Chain Framework. To install the latest framework:

    install isc-supply-chain

    Or to install a specific version of the framework (in this example version 1.0.0):

    install isc-supply-chain 1.0.0
  9. After the installation is complete, enter q to exit the IPM prompt.

Application Deployment

Any application code can be deployed using DevOps tools. Application code may include (but not limited to):

  • Extensions to the supply chain data model

  • Custom analytics cube design

  • Business processes

  • Any DTL implementations

  • Custom APIs

  • Others

Contents of the InterSystems Supply Chain Framework

After you install the InterSystems Supply Chain Framework into a namespace, you will see the following new packages in that namespace:

  • The SC package.

    • The SC.Data subpackage contains the data model classes that you can modify.

    • The SC.Core.BP subpackage contains classes you refer to when creating business processes to manage issues.

    • The SC.Core.Tasks subpackage contains the tasks to be scheduled in the Task Manager.

    Other code in this package is purely internal.

  • The datamodelAPI, scbi, and utils packages, which are purely for internal use.

After installation, you will also see new tasks in the Task Manager schedule, specifically the tasks in the SC.Core.Tasks subpackage.

Also see Guidelines for Safe Customizations.


As mentioned above, there are three deployable components involved: InterSystems IRIS, InterSystems Supply Chain Framework, and application code. Each of these components can be upgraded, together or independently. If you need to upgrade more than one of the deployable components at the same time, do so in the following order:

  1. Upgrade core InterSystems IRIS data platform.

    See the InterSystems IRIS upgrade instructions, and be sure to recompile the %SYS namespace as instructed.

  2. Upgrade InterSystems Supply Chain Framework.

    To upgrade the InterSystems Supply Chain Framework, use the same command as for the initial deployment:

    zpm:SC> install isc-supply-chain

    Optionally, to upgrade to a specific version of the framework (in this example version 1.1.0):

    zpm:SC> install isc-supply-chain 1.1.0
  3. Upgrade application code. Use client DevOps tool to do this.

See Also

FeedbackOpens in a new tab