Integrating with IBM Sterling Order Management System Software developer toolkit over phase 1

You can integrate and use Sterling Inventory Visibility as the inventory management system for managing your inventory. However, Sterling Order Management System Software continues to manage ordering, sourcing, promising, and scheduling.

About this task

If you are an existing Sterling Order Management System Software Containers user and using Sterling Global Inventory Visibility for managing inventory, ensure to sync your demands and supplies to Sterling Inventory Visibility by using the phase 1 integration. In phase 1, Sterling Global Inventory Visibility continues to be your inventory management system. To replace Sterling Global Inventory Visibility with Sterling Inventory Visibility, migrate from phase 1 to phase 2. After migrating to phase 2, Sterling Inventory Visibility becomes your inventory management system for Sterling Order Management System Software.

The following procedure explains steps to configure the integration properties, JWT properties, and the public key to integrate Sterling Intelligent Promising with Sterling Order Management System Software developer toolkit over Inventory Visibility phase 1.

Procedure

  1. Set up the IBM® Sterling Order Management System Software developer toolkit. For more information, see Setting up the Integrated Developer Toolkit environment.
  2. Configure the following integration properties in the customer_overrides file to establish the communication between developer toolkit and Inventory Visibility.
    yfs.iv.integration.demand.providerurl=file:/<Path_jndi>
    yfs.iv.integration.senddemandupdates.event.queue=<Demand_queue>
    yfs.iv.integration.demand.qcf=AGENT_QCF
    yfs.iv.integration.supply.providerurl=file:///data/devtoolkit_docker/jndi
    yfs.iv.integration.sendsupplyupdates.event.queue=<Supply_queue>
    yfs.iv.integration.supply.qcf=AGENT_QCF
    yfs.iv.integration.icf=com.sun.jndi.fscontext.RefFSContextFactory
    iv_integration.baseUrl=https://<Sip_Hostname>/inventory
    iv_integration.<Enterprise_Code>.tenantId=default
    iv_integration.<Enterprise_Code>.clientId=DEFAULT
    iv_integration.<Enterprise_Code>.secret=DEFAULT
    iv_integration.demands.untaggedinv.tagnumber.useblank=Y
    iv_integration.supplies.untaggedinv.tagnumber.useblank=Y
  3. By default, JWT authentication is disabled in the developer toolkit. To enable JWT authentication, set the following property in the customer_overrides file.
    iv_integration.authentication.mode=JWT
    
  4. Activate the event handlers and templates by running the enterprise activation script. For more information, see Activating Sterling Order Management System Software and Inventory Visibility integration.
  5. Enable the appropriate events to call actions and the corresponding services. For more information, see Integrating Sterling Order Management System Software with Inventory Visibility.
  6. Start the integration server for syncing supplies and demands to Inventory Visibility by using phase 1 adapter.
  7. Generate the JWT key.
    Any incoming request to Sterling Intelligent Promising is authenticated by a signed JWT. This JWT is signed by using a private key that is configured in Sterling Order Management System Software and validated by using a public key that is configured in Sterling Intelligent Promising. The IBM Sterling Order Management System Software developer toolkit can generate the JWT key by default by using its own private-public key pair. After setup or upgrade, the public key is available in the directory that is defined by the yfs.jwt.create.public.key.save Dir property. If the property is not defined, then the file is saved to the HOME_DIR location that is defined in the sandbox.cfg file, which is the product installation location. The private key is imported to the keystore.
    • If the Sterling Order Management System Software is communicating with Sterling Intelligent Promising through an app server JVM, then by default, the public key is generated in /opt/ssfs/runtime in the Docker runtime [om-appserver]container.
    • If the Sterling Order Management System Software is communicating to Sterling Intelligent Promising through an integration server JVM that you are running from a runtime container, then by default, the public key is generated in /opt/ssfs/runtime in the Docker runtime [om-runtime] container.
    • If the Sterling Order Management System Software is communicating to Sterling Intelligent Promising through an integration server JVM that you are running from an extracted container, then by default, the public key is generated in <Developer_toolkit>/runtime.
  8. Configure this public key in OMS Gateway. For more information, see Creating a JWT issuer secret by using a public key.
    Note:
    • When supply sync and demand sync integration servers try to reach Sterling Intelligent Promising, a certificate is required to establish a secure connection to Sterling Intelligent Promising. This certificate is used to verify the identity of the Sterling Intelligent Promising and to establish a secure encrypted connection between developer toolkit and Sterling Intelligent Promising.
    • If you are using Sterling Intelligent Promising Operator certificate, ensure to add the root CA certificate [tls.crt] to the truststore of integration servers JVM.
    • If you are using your own certificate, ensure to add it to the truststore of integration servers JVM.

What to do next

If you are using Order Hub to display Sterling Intelligent Promising inventory data, you need to configure a connection and add properties to the system_overrides.properties file.

For more information, see Configuring a connection to Sterling Intelligent Promising.