View Integration Details
- 28 Aug 2023
- 4 Minutes to read
- Print
- DarkLight
View Integration Details
- Updated on 28 Aug 2023
- 4 Minutes to read
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
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. 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.
The following chart represents the three available options found via the Integration Types dropdown:
| Integration Types | |
| API Service | This Integration type allows users to allow to configure Get or Post calls for Flows, Rules, and Reports. |
| User Interface | This Integration type allows users to configure how UI elements will be configured via URL. Note that this Integration Type is not available for Rules. |
| Webhook | This 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 integrations for the Page and Form Designers, they can be configured in the integration via an iFrame. For more information please refer to the following article: Decisions Platform in an iFrame.
Version 8 Endpoints for SAML, OpenID, and OAuth
- LoginURL - [base]:[port]/Login
- LogoutURL - [base]:[port]/Logout
- SAML - [base]:[port]/SAML/AssertionConsumer
- TokenHandler - [base]:[port]/HandleTokenResponse
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:
- Navigate to and right-click a Folder in the Decisions Studio.
- 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 Setup Option to choose the user authentication type. Additional Options Description Call Form By The URL used is called the Folder by Id or Path. Select Page Provides the option to Enable Page Selection; toggling this enables the Pages option. Pages Allows 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 Type Option to pick Portal Type to display Folder; options include HTML, Mobile, or Tablet. Chrome Breadcrumbs setting. Options include None, Off, Small, TopBarOnly, TopBarFolderTreeCollapsed, NoTopBarHasFolderTree, and NoTopBarFolderTreeCollapsed. 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
- CREATE a Rule. From the Properties tab, under SERVICE SETTINGS > Integration Type, select API Service.
- Define any desired SERVICE SETTINGS. Then, click VIEW.
Below is the list of configurable settings.Options Integration Type Configures what type of Integration will be allowed on this Designer Element Data Format Configures the output data that would be expected to be outputted Reference Type Configures how the Integration call will be referenced by either Id, URL, or Path Override Service URL Allows 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 Methods Allows users to permit which HTTP Methods can be used for Integration 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. Review the chart to determine the best service type to use:
| Service Type | Description |
|---|---|
| API Service | This Integration Type allows users to configure Get or Post calls for Flows, Rules, and Reports. |
| 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 configuring the Flow Integration Settings, 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.
API Call Authentication Types
The following chart represents the API Call Authentication options available to users when creating an Integration in Decisions.
Decisions Recommendation
Decisions Developers will most often use the Named Sessions for the API calls authentication type when applicable. These are more secure than other options.
| Authentication Type Options | |
| Login | Uses 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. |
| Guest | Uses the Guest Account, when enabled before Integration, for the REST call. |
| Named Sessions | Uses user-configured Named Sessions that are associated with a Decisions account. This is configured in the System > Security > Named Session Folder. |
| SessionID | Uses the current Login's SessionID for API call authentication. |
| Specify Session ID | Allows 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 Credentials | Allows the user to specify Constant user credentials to be used for integration. |
Using Swagger
Swagger docs can be created to help manage a customer's API design in Decisions. Any Decisions environment can generate a Swagger doc. Add /apidoc to the end of any Decisions website - www.example.decisions.com/apidoc.
Testing Integration
To test Integration behavior at any time:
- Click the TEST tab on the right-hand side of the INTEGRATION DETAILS screen.
- Select the desired method (ex: POST, GET), then click RUN.
- Once the Integration runs, confirm the Post or Get Results match the specified outputtype (ex: Json).
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:
To view this serialized String:
- Search for the desired Data Type in the Select Type box.
- Under Output Type, select either XML or Json.
- Click SHOW SAMPLE OBJECT. The Serialized Data will display at the bottom of the screen.
Was this article helpful?
