Integrating Sterling Order Management System Software with Sterling Intelligent Promising Inventory Visibility

Complete the steps to enable the integration of Sterling Order Management System Software with Sterling Intelligent Promising Inventory Visibility.

Note: The existing SIV activator functionality is deprecated. Instead, a new SIV_1.1 activator functionality is introduced. For more information about the new activator functionality, see Activating the Sterling Order Management System Software and Sterling Intelligent Promising Inventory Visibility integration.

Procedure

Note: In the Applications Manager, the service name references provided in this topic adheres to the <InventoryOrgCode_>ServiceName<_ActivatorVersion> naming convention. Similarly, the action name references provided in this topic adheres to the Actionname<_ActivatorVersion> naming convention.

  1. Enable the appropriate events to call actions and the corresponding services.
    To enable the events, from the Applications Manager, select Applications > Applications Platform > General Repository > Transactions.
    • To access the Inventory Change events, expand Inventory Change > Events.
    • To access the Inventory Snapshot events, expand Inventory Snapshot > Events.
    Note: The HUB or default event must be enabled with the enterprise action that is activated. The actions are created as part of activation.
    • INVENTORY_CHANGE.DEMAND_CHANGE event - calls the DemandChange action, which in turn calls the IVAdjustDemandAsynchronously service.
    • INVENTORY_CHANGE.SUPPLY_CHANGE_LIST event - calls the SupplyChange action, which in turn calls the IVAdjustSupplyAsynchronously service.
    • INV_SNAPSHOT.SUPPLY_SYNC event - calls the SupplySync action, which in turn calls the IVSyncSupplySynchronously service.
    • INV_SNAPSHOT.DEMAND_SYNC event - calls the DemandSync action, which in turn calls the IVSyncDemandSynchronously service.
  2. Activate the integration by using the activation script.
    The activation script generates the following services for each enterprise:
    • IVAdjustDemandAsynchronously - This is a general service that considers demands raised by the INVENTORY_CHANGE.DEMAND_CHANGE event, copies the message to a JMS queue, and calls the IVAdjustDemandSynchronously service. This service enables the replication of demand from Sterling Order Management System Software to Sterling Intelligent Promising Inventory Visibility. This allows the external systems to invoke the Sterling Intelligent Promising Inventory Visibility REST APIs for availability lookups. Starting this service invokes the IVAdjustDemandSynchronously service and transforms the XML message into JSON and POST https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v1/demands REST API call.
      Sample REST Input
      <InventoryVisibilityAPI URL="https://api.watsoncommerce.ibm.com/inventory/tenant1/v1/demands" HTTPMethod="POST" Content-Type="application/json">
  <Headers/>
  <Input>
{
  "demands": [{
    "productClass": "NEW",
    "minShipByDate": "1900-01-01T00:00:00Z",
    "shipNode": "Matrix-Store-001",
    "unitOfMeasure": "EACH",
    "type": "OPEN_ORDER",
    "segmentType": " ",
    "segment": " ",
    "itemId": "SKU1024",
    "cancelDate": "2500-01-01T00:00:00Z",
    "shipDate": "2017-10-04T00:00:00Z",
    "tagNumber": "|||",
    "referenceType": " ",
    "changedQuantity": 1.0,
    "reference": " ",
    "sourceTs": "2017-10-04T17:14:37-00:00"
  }]
}
</Input>
</InventoryVisibilityAPI>
      Sample REST Output
      <InventoryVisibilityAPI URL="https://api.watsoncommerce.ibm.com/inventory/tenant1/v1/demands" HTTPMethod="POST">
  <ResponseHeaders />
  <Output Status="202"/>
</InventoryVisibilityAPI>
    • IVAdjustSupplyAsynchronously - This is a general service that considers supplies raised by the INVENTORY_CHANGE.SUPPLY_CHANGE_LIST event, copies the message to a JMS queue, and calls the IVAdjustSupplySynchronously service. This service enables the replication of supply from Sterling Order Management System Software to Sterling Intelligent Promising Inventory Visibility. This allows the external systems to invoke the Sterling Intelligent Promising Inventory Visibility REST APIs for availability lookups. Starting this service invokes the IVAdjustSupplySynchronously service and transforms the XML message into JSON and POST https://api.watsoncommerce.ibm.com/inventory/{tenantId}/v1/supplies REST API call.
      Sample REST Input
      <InventoryVisibilityAPI URL="https://api.watsoncommerce.ibm.com/inventory/tenant1/v1/supplies" HTTPMethod="POST" Content-Type="application/json">
  <Input>
{
  "supplies": [{
    "adjustmentReason": "POS_ORDER",
    "shipNode": "Matrix-Store-001",
    "lineReference": " ",
    "productClass": "NEW",
    "type": "ONHAND",
    "itemId": "SKU1024",
    "reference": " ",
    "tagNumber": "|||",
    "sourceTs": "2016-12-05T17:14:37-00:00",
    "eta": "1900-01-01TT00:00:00Z",
    "segment": " ",
    "segmentType": " ",
    "changedQuantity": -1.0,
    "unitOfMeasure": "EACH",
    "referenceType": " ",
    "shipByDate": "2500-01-01TT00:00:00Z"
  },{
    "adjustmentReason": "POS_ORDER",
    "shipNode": "Matrix-Store-001",
    "lineReference": " ",
    "productClass": "NEW",
    "type": "ONHAND",
    "itemId": "SKU2048",
    "reference": " ",
    "tagNumber": "|||",
    "sourceTs": "2016-12-05T17:14:37-00:00",
    "eta": "1900-01-01T00:00:00Z",
    "segment": " ",
    "segmentType": " ",
    "changedQuantity": -1.0,
    "unitOfMeasure": "EACH",
    "referenceType": " ",
    "shipByDate": "2500-01-01T00:00:00Z"
  }]
}
</Input>
</InventoryVisibilityAPI>
      Sample REST Output
      <InventoryVisibilityAPI URL="https://api.watsoncommerce.ibm.com/inventory/tenant1/v1/supplies" HTTPMethod="POST">
  <Output Status="202"/>
</InventoryVisibilityAPI>
    • IVSyncDemandService SDF Service - This service provides a synchronized replication of demand to ensure consistency between order and inventory operations. This service is raised by the INVENTORY_SNAPSHOT.DEMAND_SYNC event and is very similar to the IVAdjustDemandSynchronously service, except for which a URL is invoked. The same XSLT is used for translation, but the HTTPMethod component is set to PUT instead of POST.
    • IVSyncSupplyService SDF Service - This service provides a synchronized replication of supply to ensure consistency between order and inventory operations. This service is raised by the INVENTORY_SNAPSHOT.SUPPLY_SYNC event and is very similar to IVAdjustSupplySynchronously, except for which a URL is invoked. The same XSLT is used for translation, but the HTTPMethod component is set to PUT instead of POST.
  3. For the asynchronous services, ensure to Configure the properties in customer_overrides.properties and iv_intergation.properties.
  4. Configure the InventorySnapShot agent for JMS Queues and connection information.
  5. Ensure to start the InventorySnapShot agent for both supply and demand periodically to correct any data inconsistencies. For more information, see Starting an integration server.