View Integration Details

Last Updated: 03/28/2018 Introduced in Version: 2.0

This document illustrates how to use Integration Details for entities in Decisions. Integration Details page contains information on different ways to integrate with selected entity.

First, we are going to take a look at the Integration Details for Folder Entity. Navigate to the Folder, and from the Folder Actions click Manage > Integrations > View Integration Details option.

View Integration Details For Folder page opens in a new window. This page will build a URL for us based on our settings.

Credential: option to choose user authentication type.

Refer Form By: URL to use either Folder Id or Path to the Folder.

Select Page: option to pick from different Folder Views.

Display Type: option to pick Portal type to display Folder.

Chrome: breadcrumbs setting.

When we are finished with all settings we can click Generate UI Code button.

View Integration Details helper generates a URL for us based on our settings. We can use this URL to integrate with our Folder. Because Folder Entity is a visual type of Entity in Decisions, only User Interface integration type is available.

Next, we are going to look at Integration Details page for the Rule. Rule is different type of entity than Folder. Rule is an entity that accepts data and returns data so it may be called via Rest without any UI. Let’s create a simple Rule and check Allow Rest API Calls check-box in Service Settings.

Back in the Designer Folder we locate our Rule and from the Action menu we click Run [Advanced] > Integration > View Integration Details option.

Then, View Integration Details For Rule page opens. Because Rule Entity does not have User Interface we can only see options to call our Rule via Service/Rest call.

We can set up the Credentials Type, Refer Rule by Id or Path, and Return Data Type (XML, JSON or Raw). If we click Generate Service API button, system will tell us how to call our Rule using GET or POST method.

At the bottom of the View Integration Page we can find a link to Type Serialization Helper

On the Type Serialization Helper page we can pick any Type in Decisions, Select XML or JSON Output type and click Show Sample Object.

Then, System generates a sample serialized object for us.

Next, we are going to create a simple Flow with an Input and Output. In the Flow Designer we check Create Service check-box in the Service Settings. This option will provide us with more integration options.

Back in the Designer Folder we locate our Flow. From thumbnail Actions we click Run [Advanced] > Integration > View Integration Details.

View Integration Details For Flow page opens. Because we Created Service for our Flow, if we set Run Flow as Service we have four options: Rest, WCF, Webservice, Javascript.

If we pick Rest option, we can see integration similar to our Rule Rest integrations.

Then, if we pick WCF option, View Integration Details helper provide us with information on how to Add Service Reference and use Service Methods. 

Webservice option looks similar to WCF integration… It demonstrates how to add Web Reference to the web application.

Javascript option shows how to run Decisions Services using JQuery

Finally, because our Flow may have Forms and a User Interface, we are able to Run Flow As UI/Form. With this option System generates us a URL link to run the Flow.

 

 

Additional Resources