Using URL Paths With Flows

Last Updated: 05/04/2018 Introduced in Version: 2.0

Decisions URL’s paths system were designed to provide user with powerful navigation control in the System between Folders, Flows, Rules, Pages, Reports, Forms and much more using wide variety of additional options like Security and View.

 

Flows

We have several options to run the flow using URL in Decisions.

First option is to use Flow Id parameter in our base URL. Our url should be built as follow:

http://localhost/decisions/Primary/?FlowId=<flowID value goes here>

Example:

First, we need to get flow id. From Flow’s Thumbnail we click Action and select Manage > Get Flow ID.

26-get-flow-id

 

Next, we copy Flow’s Id to the clipboard from the resulting pop-up window.

27-flow-id

 

We can build our URL now. It should look like this:

http://localhost/decisions/Primary/H/?FlowId=d2867a32-a5f0-11e6-a27b-14feb59fb140

28-flow-url-in-chrome

And our Flow runs…

29-flow-url-runs

 

Second option is to run flow by path. We use Flow Path parameter for this.

Example:

Our Flow is in Designer_Folder and named Drop Down Flow.

So our URL should look like:

http://localhost/decisions/Primary/?FlowPath=InsuranceApplicationDesign/Flow/populateCityState

30-using-the-path

 

Browser runs our flow…

31-flow-run-via-path

 

Another option to run the flow is to refer by Flow Alias parameter. For creating Flow Alias, please refer to this article

Drop Down Flow alias was created for our flow in this example.

To use Flow Alias in URL we build it as follow:

http://localhost/decisions/Primary/?FlowAlias=populateCityState

32-flow-alias

 

…and our Flow executes.

33-flowalias

 

Next, we can run Flow API from URL, and we also have two options to do it. To run Flow API by ID we need to pass FlowId, action and sessionid parameters to the URL. In this case url would look like: http://localhost/decisions/Primary/?FlowId=<flow id value goes here>&action=api&sessionid=<named session’s id goes here>

This will run REST Api.

Example:

We are getting FlowId and Named Session Id first. For creating Name Session ID, please refer to this article. Next we use these values to build our URL, we use API value for action parameter to run Flow API:

http://localhost/decisions/Primary/?FlowId=d2867a32-a5f0-11e6-a27b-14feb59fb140&action=api&sessionid=NS-d319b707-c08b-11e6-80d8-080027c38b6c

34-name-session-id

 

The result is xml formatted output from our flow.

35-output-from-our-flow

 

Another option to run Flow API by Path. This is similar to running Flow Api by Id but we use FlowPath parameter instead of FlowId.

Example:

Our URL should look like follow:

http://localhost/decisions/Primary/?FlowPath=InsuranceApplicationDesign/Flow/populateCityState&Action=api&sessionId=NS-d319b707-c08b-11e6-80d8-080027c38b6c

36-flow-path-api

 

And result is the same xml structured flow outcome…

37-output-message

 

To view Flow Integration options we need to use FlowId or FlowPath parameter and action parameter. In this case we need to pass viewapi value for action parameter.

Example:

If we want to use FlowId parameter our URL would be like:

http://localhost/decisions/Primary/?FlowId=d2867a32-a5f0-11e6-a27b-14feb59fb140be&Action=viewapi

38-viewapi

 

With FlowPath parameter it would be:

http://localhost/decisions/Primary/?FlowPath=InsuranceApplicationDesign/Flow/populateCityState&Action=viewapi

39-view-api

 

 

And our Integration Page for Flow opens… By using FlowId…

40-view-through-flow-id

 

…and using FlowPath.

41-flow-path-to-view-api

 

We can also open Flow Designer to edit our flow using URL. To accomplish it we are using FlowId or FlowPath parameter with action parameter. We need to pass edit value to action parameter in the URL.

Example:

With FlowId our Url should look like:

http://localhost/decisions/Primary/?FlowId=51ab5883-4595-11e4-9c19-4ceb4297b7be&Action=edit

With FlowPath parameter it would be:

http://localhost/decisions/Primary/?FlowPath=Flow+Demos%2fFlow+1&Action=edit

Additional Resources