Data ingestion from IBM Sterling Order Management System Software to IBM Sterling Intelligent Promising

IBM® Sterling Order Management System Software publishes transactional and non-transactional events. Applications like IBM Sterling Intelligent Promising can subscribe to these events to receive the data from Sterling Order Management System Software.

  • Transactional events: A transactional event is triggered by a change to a business object. For example, an order is created, or an order is modified.
  • Non-transactional events: A non-transactional event is triggered periodically to publish different types of master or configuration data sets. For example, sending items to an enterprise, ship nodes, and more. Ideally, a background process (agent) publishes the non-transactional events.
Sterling Order Management System Software publishes data to Sterling Intelligent Promising through Kafka by using the Datapublish Agent framework. For more information, see Data Publish agent. You can enable the integration with Kafka by configuring the following properties in the customer_overrides.properties file.
Table 1. Kafka properties
Property Default value Required Description
kafka.cluster.names.ext   Yes Specify the comma-separated list of logical cluster names to be supplied to Sterling Order Management System Software instance.
kafka.cluster.<clusterName>.producer.<producerConfig>   Yes Specify the Kafka producer properties for a specific cluster. These properties are utilized to create a Kafka Producer Instance. For example, kafka.cluster.test-cluster.producer.bootstrap.servers=172.23.144.1:9092. You can specify multiple Kafka producer properties by using this pattern.
yfs.datapublish.target   Yes Specify the target for datapublish agent. The value for Kafka integration must be kafka.
yfs.datapublish.kafka.cluster.name   Yes Specify the logical kafka cluster name that is used by Datapublish Agent framework to send the events to.
yfs.datapublish.<eventName>.topic.name   Yes Specify the topic name that is used to send the event identified by <eventName>.
Note: The Sterling Intelligent Promising supports only the shipNodeSync event. Hence, set the value of <eventName> to shipNodeSync and yfs.datapublish.shipNodeSync.topic.name to {topicPrefix}-config-events.
yfs.datapublish.tenant default No Specify the tenant ID value that should be used to generate V1 format JSON payload.
yfs.datapublish.shipNodeSync.supportedversions v0 Yes Specify the supported format version for shipNodeSync event as v1.
Note: The only supported version for Sterling Intelligent Promising is v1

Data Publish agent

The Data Publish agent publishes the ship node data. For Ship Node, the supported agent mode is FULL. When the agent runs in FULL mode, all the ship node data is published periodically.

Table 2. Data Publish agent properties
Parameter Description Value
ConfigurationType Indicates the type of data set. CONFIG
  • Node Data belong to CONFIG Configuration Type.
Mode In the FULL mode, the agent pulls complete ship node information that is to be published. FULL

DATA_PUBLISH_CONFIG_FULL_SYNC is the only agent criteria definition supported out-of-the box for Sterling Intelligent Promising Kafka Integration. It triggers the agent based on the scheduled interval for CONFIG data in FULL mode.