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

Configure the integration properties, JWT properties, and the public key to integrate Sterling Intelligent Promising with Sterling Order Management System Software developer toolkit.

1. Set up the IBM® Sterling Order Management System Software developer toolkit by configuring the following properties in the Developer_toolkit/compose/docker/integration.properties file. For more information, see Setting up the Integrated Developer Toolkit environment.

   IV_ENABLE=Y
   IV_TENANTID=default
   IV_CLIENTID=DEFAULT
   IV_SECRET=DEFAULT
   IV_BASEURL=https://<SIPHOSTNAME>/inventory
   IV_ENDPOINTURL=${IV_BASEURL}/${IV_TENANTID}/v1
   

2. Configure the following setup properties in system management administration (SMA) to enable V2 mode.

   iv_integration.IVApiVersion=v2
   iv_integration.nodesAvailability.apiUrl=/v2/availability/node/
   iv_integration.networkAvailability.cached.apiUrl=/v2/availability/network/
   iv_integration.nodeAvailability.cached.apiUrl=/v2/availability/node/
   iv_integration.reservations.apiUrl=/v2/reservations/

3. To enable JWT authentication, set the following property in the customer_overrides file.

   iv_integration.authentication.mode=JWT
   

   By default, JWT authentication is disabled in Sterling Order Management System Software developer toolkit.

4. 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.
5. Configure this public key in OMS Gateway. For more information, see Creating a JWT issuer secret by using a public key.
   Note:

   • When the Sterling Order Management System Software generates the JWT by using its own private-public key pairs, a public-private key pair can exist for each JVM, depending on the sequence of the way you use the different JVMs. Each JVM generates its own public key in the specified folder or in a default location. These public keys are generated by using the same key identifier, which is an alias term that is used when the private key is imported. To ensure successful authentication, when you configure the public keys in Sterling Intelligent Promising, do not use key identifiers for any of the public keys.