Next-generation platform

Integration guidelines for the next-generation platform

Ensure that you follow these guidelines to enable integration of Sterling™ Order Management System with external systems.

The two outbound integrations that Sterling Order Management System supports are RESTful APIs and SFTP for Data extract services. Select the port in Self Service for your TCP communication. If you want to set up email services, it is recommended that you use the email services over the 443 outbound port.

Important: You must ensure that all outbound communications to a third-party system are encrypted to ensure security compliance.

If you want to open certain connections for egress on the firewall, you must create a firewall policy in Self Service. For more information, see Managing firewall policies.

As part of client integration with Sterling Order Management System, which by default uses MQ Client channel, you must specify specific MQ message header parameters and values. This ensures that Sterling Order Management System is able to process the messages that are placed in the client queues.
  • By default, Sterling Order Management System processes all the messages of type javax.jms.TextMessage and does not explicitly check for MQ headers during processing of such messages. For more information about how to drop a message of type javax.jms.TextMessage to IBM MQ, see JMS message types and conversion.
  • By default, Sterling Order Management System is configured to process text-based messages. SI users must use the standard MQ Client to browse the messages in queues where header detail is available.
  • The following example shows a correctly formatted header, which can be processed by Sterling Order Management System.
    StrucId : 'MD ' Version : 2
Report  : 64 MsgType : 8
Expiry  : -1 Feedback : 0
Encoding : 273 CodedCharSetId : 1208
Format : 'MQSTR'
Priority : 5 Persistence : 1
MsgId : X'414D51204F4D5F514D47522020202020520CB65BE5F15A2C'
CorrelId : X'D34DF8E3CE78FDD69E6FFE386B8FDB7F4EBF73D7766F8F77'
BackoutCount : 0
ReplyToQ      : '       '
ReplyToQMgr   : 'OM_QMGR
Note:
  • Request for network firewall policy is not required for inbound communications. Configure inbound connections to Sterling Order Management System by using Mutual Authentication. For more information, see Accessing Sterling Order Management System applications.
  • Inbound HTTPS connections use port 443, while MQ inbound connections use port 15443. By default both ports are opened and no further action is required.