Open topic with navigation

Gateway Integration Endpoints

Gateway integration endpoints enable STEP to access external systems through business rules that make calls to fetch data or update status. For example, to create objects in STEP using an ID from an external Enterprise Resource Planning (ERP) system, STEP can use a gateway endpoint to access and retrieve the external system ID.

The gateway endpoint controls all access to a given system. It holds the information that is required to access the external system including the user name, password, and the server URL. This means the information does not have to be included in the JavaScript business action and that the duration and frequency of calls can be monitored and logged.

The business rule uses synchronous REST calls from JavaScript. For more information about REST and the REST API, click the STEP API Documentation button on the STEP Start Page.

Note: Keystore is not supported.

Setup Requirements

Setting up and using a gateway integration endpoint involves the following steps:

  1. Create a setup group to hold the endpoint as described in Initial Setup for a Gateway Integration Endpoint here.
  2. Create a gateway endpoint as described in Creating a Gateway Integration Endpoint here.
  3. Configure the endpoint as described in Configuring a Gateway Integration Endpoint here.
  4. Create a business rule to access the gateway endpoint as defined in Gateway Integration Endpoint Bind in the Resource Materials online help here.
  5. Enable the endpoint and test connectivity as described in Running a Gateway Integration Endpoint here.

Additional Information

The following information is useful once a gateway integration endpoint is set up:

  1. Maintain or modify the endpoint as described in Maintaining a Gateway Integration Endpoint here.
  2. Monitor the endpoint as described in Monitoring a Gateway Integration Endpoint here.
  3. Export gateway integration endpoint definition for comparison purposes in an external source control system in Exporting Gateway Integration Endpoint Definitions as Comments here.

 

2019, Stibo Systems – Confidential