View Integration Details
  • 04 Apr 2022
  • 5 Minutes to read
  • Dark
    Light

View Integration Details

  • Dark
    Light

Overview

Configuring Integration refers to the ability to call Flows, Rules, Reports, and other Designer Elements as services from outside of Decisions for sending and retrieving data.

In Decisions installations v.7x and onward, users are allowed the ability to designate Integration Types within the Flow, Rule, and Report Designer. Though Designer Elements have Integration disabled by default, this can be enabled by editing the Publish As: toolbar or by editing the SERVICE SETTINGS in the Properties panel. 

Upgrades from Older Versions to 7.1+
To preserve functionality on upgrades from older versions to 7.1+, the installer first searches all existing designer elements for "REST enabled". When true, a System initializer will automatically update the Integration Type to "API Service", data format to "All", and Reference Type to "Id or Path". The System modifies and saves the elements, resulting in a recent MODIFIED DATE and MODIFIED BY "-------" value.  Previous element history is available as usual.

Repository Check-in After First Upgrade to 7.1+
The integration configuration changes introduced in v7.1 (described above) REQUIRES checking in every updated project element to the repository after upgrade.

The following chart represents the four available options found via the Integration Types dropdown:
Integration Types
API ServiceThis Integration type allows users to allow to configure Get or Post calls for Flows, Rules, and Reports.
Internal OnlyMakes endpoints only internally accessible. 
User InterfaceThis Integration type allows users to configure how UI elements will be configured via URL. Note that this Integration Type is not available for Rules. 
WebhookThis Integration type configures the Designer to use this Integration's capabilities. Note that this Integration Type is only available for Flows. 

While there are no API integration for the Page and Form Designers, they can be configured in the integrated via an iFrame.

For more information on configuring Decisions in an iFrame, refer to "Decisions Platform in an iFrame"
Version 7 Endpoints for SAML, OpenID, and OAuth
  • LoginURL - [base]:[port]/Login 
  • LogoutURL - [base]:[port]/Logout 
  • SAML - [base]:[port]/SAML/AssertionConsumer 
  • TokenHandler - [base]:[port]/HandleTokenResponse
An example of an endpoint would appear in the address bar as -> localhost:81/Logout 
The port number is ONLY needed if Decisions is installed to a non-standard port, which would be anything other than port 80 for HTTP or port 443 for HTTPS.

Folder Entity

Prerequisite: Set up Integration Details:
Attempts to view Integration details on a Flow, Rule, etc. ahead of configuring SERVICE SETTINGS will not display complete Integration details. 
To view the Integration Details of a Folder Entity:
  1. Navigate to and right-click a Folder in the Decisions Studio.
  2. From the Folder Actions, click Manage > Integrations > View Integration Details option.
    The View Integration Details For Folder page will open in a new window. The following charts represent the options available to configure a Folder's Integration. 
    Setup Description
    SetupOption to choose the user authentication type.
    Additional OptionsDescription
    Call Form ByThe URL used to use either call the Folder by Id or Path.
    Select PageProvides the option to Enable Page Selection; toggling this enables the Pages option.
    PagesAllows the ability to select how the Folder will display its contents. Options include Folder View, List, Tiles, Columns,  and Unit Test Results
    Display Settings
    Display TypeOption to pick Portal Type to display Folder; options include HTML, Mobile, or Tablet.
    Chromebreadcrumbs setting. Options include None, Off, Small, TopBarOnly, TopBarFolderTreeCollapsed, NoTopBarHasFolderTree, and NoTopBarFolderTreeCollapsed.


  3. Select and define the desired settings. After configuring the Integration, copy the URL on the right. 

    Adjusting the settings will alter the URL on the right automatically. This URL can now be used to integrate with the Folder outside of Decisions.



Rule Integration

A Rule is an entity that accepts and returns data. Rules can be integrated with via API.
To Integrate with a Rule:
  1. CREATE a Rule. From the Properties tab, under SERVICE SETTINGS > Integration Type, select API Service
  2. Define any desired SERVICE SETTINGS. Then, click VIEW.
    The configurable SERVICE SETTINGS are as follows:
    Options
    Integration TypeConfigures what type of Integration will be allowed on this Designer Element
    Data FormatConfigures the output data that would be expected to be outputted
    Reference TypeConfigures how the Integration call will be reference by either Id, URL, or Path
    Override Service URLAllows users to create a custom service URL Endpoint. Services generated using this setting can be found either at  http://localhost/decisions/Primary/apidoc for IIS hosted environments or http://localhost/Primary/apidoc for Self-Hosted environments.
    Configure HTTP MethodsAllows users to permit which HTTP Methods can be used for Integration

  3. Adjust the Setup to desired parameters, then use the displayed INFO to build an API call. 





Flow Integration

Similar to the Rule Designer, integrating with Flows follows the same process. The SERVICE SETTINGS are also located in the Properties tab.

When defining the Flow's SERVICE SETTINGS, select the desired Integration Type. To figure out which Integration Type to use, consider the chart below:

API Service

This Integration Type allows users to allow to configure Get or Post calls for Flows, Rules, and Reports.

Internal Only 

Makes endpoints internally accessible.

User Interface

This Integration Type allows users to configure how UI elements will be configured via URL.

Webhook

This Integration Type configures the Designer to use this Integration's capabilities.

After the Flow Integration Settings have been configured, click VIEW to open the Integration Details page. 

For more information on running Flows via Integration review the Running Flows as a URL to learn more.

User Interface Integration

  1. To configure a Form's UI elements using User Interface, first open the Flow Designer and connect a Show Form step to the Start and End steps.
  2. In the top-right corner of the Flow Designer, select Configure Integration.
  3. In the Integration Type drop down, select User Interface. Then select Path for the reference type and click DONE.

  4. Click the VIEW button to view the Integration details.
  5. From here, a user may adjust the Form's UI elements, embed type, etc.
  6. To view the Form, select OPEN URL.

  7. After selecting OPEN URL, a user will see the Form they have created with the selected UI elements.

API Call Authentication Types 

The following chart represents the options for API Call Authentication that are available to users when creating an Integration in Decisions. 

Decisions Recommendation
Decisions Developers will most often used the Named Sessions for the API calls authentication type when applicable. 
Authentication Type Options
LoginUses the Login credentials of the user calling this Decisions Element. Upon execution, the user will be brought to a Login Page before proceeding with the Integration.
GuestUses the Guest Account, when enabled prior to Integration, for the REST call.
Named SessionsUses user-configured Named Sessions that are associated with a Decisions account. This is configured in the System > Security > Named Session Folder.
SessionIDUses the current Login's SessionID for API call authentication. 
Specify Session IDAllows a user to specify a SessionId for call authentication. This is specified in the SessionId box and stored via the STORE SESSION ID button. 
Specify User CredentialsAllows the user to specify Constant user credentials to be used for integration.

Test

By using the TEST feature on the INTEGRATION DETAILS screen, users can test their Integration. To do so:
  1. From the INTEGRATION DETAILS screen, on the right-hand side, navigate to the TEST tab.
  2. If available, select either POST or GET, then click RUN. 
  3. Once the Integration runs, ensure that it produced Post or Get Results
    Results 
    The Integration will output a result in the expected outputtype. The screenshot below demonstrates an Integration that has output a Json result. 




Type Serialization Helper

Navigating to the TEST page and selecting TYPE SERIALIZATION HELPER will display a serialized String for a defined Data Type in Decisions in either XML or JSON format.
To view this serialized String: 
  1. Search for the desired Data Type in the Select Type box.
  2. Under Output Type, select either XML or Json
  3. Click SHOW SAMPLE OBJECT. 
    The Serialized Data will display at the bottom of the screen. 



Was this article helpful?