Jacada Interact supports calling web services to retrieve information from external data sources. Such web service calls are known as web service Integration Points.
Integration Points are commonly used to:
- Obtain information that can be used in Interactions (e.g., retrieving tax rates or weather forecasts based on location)
- Get data that can be used to populate values of collections (e.g., retrieving sets of customer records from a database)
- Set information in other applications and databases, based on inputs and decisions made in your Interaction
Integration Points are created and managed in the Admin Console. (For more details, click here.)
All Integration Points that have been approved are available for use in the Interaction Designer.
Integration Points in the Designer
In the Designer, you can use an Integration Point in your Interaction by inserting an Integration Point step as a navigation logic element at the relevant point in the flow. An Integration Point element can use any Integration Point that is defined for your account in the Admin Console.
In the following example, the Integration Point selected (Get Customer) receives a number input (inputID) and returns customer information (a customer object) based on that input. The returned data is stored in an object type variable. In the next step, one field of the customer object (the name) returned is allocated into a user variable.
Creating an Integration Point step involves giving your element a unique name, selecting the Integration Point to use, and configuring relevant input and output parameters.
To create an Integration Point step:
- From the Interaction map, right-click anywhere and select Add a Step, or hover over any step.
- Select Navigation Logic > Integration Point. The Integration Point editor opens.
- In the Interaction Name frame, enter a unique name for the element.
- From the drop-down list, select the required Integration Point.
The Input Variables Mapping and Output Variables Mapping frames are automatically populated with expected parameter types for the selected Integration Point (if relevant).
For example, the Integration Point selected below expects to receive a number input and put the response into an object type variable:
- In the Input Variables Mapping frame, enter a value or open the Variables list to select a variable (or create a new variable).
In our example, we select the input variable that holds the answer provided by the customer in the number input question:
- In the Output Variables Mapping frame, select or create a variable that will store the data received from the Integration Point.
In our example, we need to select a variable that holds a customer object. Note that only existing variables that match the required type appear in the Variables list:
- Click Create Integration Point.
The Integration Point step is added to the Interaction map.
Note: When you add or make changes to an Integration Point, we recommend that you Refresh currently active Interactions to update them with the new information and redraw them in the Web Designer. Use the Refresh button in the main toolbar of the Web Designer. For more information, click here.