How to use IBM App Connect with IBM Sterling Order Management System

What to consider first

App Connect supports connecting to an IBM Sterling Order Management System account by using either the REST API or IBM MQ server. You can log in to your IBM Sterling OMS account by selecting one of these options.

Connecting to IBM Sterling Order Management System

Complete the connection fields that you see in the App Connect Designer Catalog page or flow editor. If necessary, work with your IBM Sterling Order Management System administrator to obtain these values.

• Connection fields to connect to IBM Sterling Order Management System via the REST API:

  Endpoint URL

  Specify the URL of the IBM Order Management System REST webservice

  • Required: True

  Login ID

  Specify the email address of the registered IBM Order Management System account

  • Required: True

  Password

  Specify the password for the IBM Order Management System account

  • Required: True

  Certificate

  Specify the client certificate content in Base64-encoded (PEM) format. The certificate and key are generated from the personal certificate that is obtained during the Order Management System account creation.

  • Required: True

  Key

  Specify the client certificate key in Base64-encoded (PEM) format. The certificate and key are generated from the personal certificate that is obtained during the Order Management System account creation.

  • Required: True

  To obtain connection values for IBM Sterling Order Management System and to connect to IBM App Connect, complete the following steps:

  1. Enter the Endpoint URL. For more information, see Order Management APIs or Services on the IBM Documentation page.
  2. Enter your Login ID and Password. For more information, see IBMid authentication for Sterling Order Management on the IBM Documentation page.
  3. Enter the Certificate and Key. For more information, see Generating client certificates on the IBM Documentation page.
  4. To convert the P12 certificate provided by the OMS team to PEM format, use one of the following two methods:
     Method 1, using an online SSL converter:

     1. Open the https://www.leaderssl.com/tools/ssl_converter website
     2. Upload the CRT file, by clicking Choose file next to the Select the file to convert field
     3. For Certificate Type, select Standard PEM
     4. For The new extension of the certificate, select DER/Binary
     5. Click Convert to convert and download the certificate file
     Method 2, using the openssl command line utility:

     1. Open the openssl command line utility installed in your system.
     2. Run following command to convert a certificate from CRT to PEM format:

        openssl pkcs12 -in certificateName.p12 -out certificateName.crt.pem -clcerts -nokeys
        openssl pkcs12 -in certificateName.p12 -out certificateName.key.pem -nocerts -nodes

        where:
        • certificateName.p12 is the name of your certificate along with the .p12 extension which is provided as an input to OpenSSL
        • certificateName.crt.pem is the certificate filename with the crt.pem extension
        • certificateName.key.pem is the key filename with the key.pem extension
  5. Replace the next line characters (hidden characters) in the certificate.
     1. Open the certificate file in a text editor. Example of a certificate file:
        Note: In this example, the file gets opened in the text editor Notepad++. You can use any other text editor of your choice.
        
     2. Enable the show hidden characters feature in your text editor.
        Note: In Notepad++, go to View > Show Symbol > Show All Characters to view the hidden characters.
        
     3. Replace all the next line characters (hidden characters) with \n.
        Note: You can use the Replace function in your text editor to replace LF by \n.
        .
        
     4. Manually add \n at the end of the certificate.
        

        Use this certificate as input while connecting to IBM Sterling Order Management System.

  6. Replace the next line characters (hidden characters) in the key. For more information, see Step 5.

• Connection fields to connect to IBM Sterling Order Management System via the IBM MQ server:

  Endpoint URL

  Specify the IBM Order Management System instance URL in the format https://<hostname>.

  • Required: True

  Queue manager name

  Specify the name of the queue manager

  • Required: True

  Channel name

  Specify the server-connection channel definition for the queue manager

  • Required: True

  Cipher specification

  Select a cipher specification or use the default value of ECDHE_RSA_AES_128_GCM_SHA256 to enable the standard TLS for a cloud deployment. Leave the field blank for a TCP connection.

  • Required: True
  • Default value: ECDHE_RSA_AES_128_GCM_SHA256

  Passphrase

  Specify the passphrase that is associated with the IBM Order Management System certificate

  • Required: False

  Certificate label

  Specify the client certificate label

  • Required: True

To connect to a IBM Sterling Order Management System endpoint from the App Connect Designer Catalog page for the first time, expand IBM Sterling Order Management System, then click Connect. For more information about ways to connect to IBM Sterling Order Management System, see Managing accounts in App Connect.

General considerations

Before you use App Connect Designer with IBM Sterling Order Management System, take note of the following considerations:

• (General consideration) You can see lists of the trigger events and actions that are available on the Catalog page of the App Connect Designer.

  For some applications, the events and actions in the catalog depend on the environment (IBM Cloud Pak for Integration or App Connect on IBM Cloud) and whether the connector supports configurable events and dynamic discovery of actions. If the application supports configurable events, you see a Show more configurable events link under the events list. If the application supports dynamic discovery of actions, you see a Show more link under the actions list.

• (General consideration) If you are using multiple accounts for an application, the set of fields that is displayed when you select an action for that application can vary for different accounts. In the flow editor, some applications always provide a curated set of static fields for an action. Other applications use dynamic discovery to retrieve the set of fields that are configured on the instance that you are connected to. For example, if you have two accounts for two instances of an application, the first account might use settings that are ready for immediate use. However, the second account might be configured with extra custom fields.

Events and actions

IBM Sterling Order Management System events

These events are for changes in this application that trigger a flow to start performing the actions in the flow.

Orders

Orderline back order

Cancelled order

Released order

New order

Updated order

Release orders

New or updated release order

Shipments

New shipment

IBM Sterling Order Management System actions

These are actions on this application that you want a flow to complete.

Catalog items

Create catalog item

Create or update catalog item (async)

Retrieve catalog items

Delete catalog item (async)

Customers

Create customer

Create or update customer (async)

Retrieve customers

Delete customer (async)

Update customer

Delete customer

Orders

Create order

Create order (async)

Retrieve orders

Update order (async)

Update order

Delete order (async)

Delete order

Organizations

Create organization

Create or update organization (async)

Retrieve organizations

Delete organization (async)

Update organization

Delete organization

Shipments

Update or create shipment

Create shipment (async)

Retrieve shipments

Update shipment (async)

Delete shipment (async)