Gateway Integration Endpoint Bind

Gateway Integration Endpoints (GIEPs) provide real-time inbound and outbound integration under STEP’s control. The Gateway Integration Endpoint bind is accessed from JavaScript in business rule conditions and actions. The bind can work with the REST methods included in the Gateway REST Methods section below.

Important: Gateway Integration Endpoints will not always use the REST plugin. This topic only applies to and that what is in the topic only applies for GIEPs that use the REST plugin.

Note: A gateway IEP functions as an HTTP client and supports all of the standard HTTP methods. Therefore a sound basic understanding of the HTTP protocol is essential to be able to configure and use a gateway IEP.

Configuration

To use any bind:

  1. Create a business rule as defined in the Creating a Business Rule, Function, or Library topic.

  2. Edit the business rule as defined in the Editing a Business Rule or Function topic.

  3. In the Edit Operation dialog, add the bind to a business rule, as defined in the Adding a Bind topic in the Resource Materials online help documentation.

  4. In the Edit Operation dialog, optionally add Messages, as defined in the Localized Messages for JavaScript Business Rules topic.

  5. In the Edit Operation dialog, add JavaScript to call the bind.

Gateway REST Methods

This bind can work with the following REST methods. For more information about these methods, click the Technical Documentation button on the Start Page.

REST Method

Syntax Example

 
delete
 
delete().path("products").pathQuery({
workspace: "Approved", context: "GL"}).body("Test").invoke();
 
get
 
get().path("products").pathQuery({ 
workspace: "Approved", context: "GL"}).invoke();
 
head
 
head().path("products").pathQuery({ 
workspace: "Approved", context: "GL"}).invoke();
 
options
 
options().path("products").pathQuery({ 
workspace: "Approved", context: "GL"}).invoke();
 
post
 
post().path("products").pathQuery({ 
workspace: "Approved", context: "GL"}).invoke();
 
put
 
put().path("products").pathQuery({ 
workspace: "Approved", context: "GL"}).body("Test").invoke();

Example

The following is an example JavaScript that uses this bind.

Important: Example scripts should not be used as-is without thorough testing, including updating the script to match object and link types that exist on your system. JavaScript variable names are case-sensitive.

The following example uses a REST gateway integration endpoint to access the external server for information.

When the business action is executed, the gateway endpoint is accessed. The gateway endpoint Statistics tab displays an overview of executed REST methods. For more information, refer to the Gateway Integration Endpoint Statistics section here.