Using URL Paths With Flows

Last Updated: 12/03/2015 Introduced in Verision: 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 FlowId 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.

getFlowId

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

copyId

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

http://localhost/decisions/Primary/?FlowId=89233e2f-db7a-11e3-8e25-00155db8db0a

urlFlowById

And our Flow runs…

resultFlowIdRun

Second option is to run flow by path. We use FlowPath 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=Designer_Folder/Drop%20Down%20Flow

runFlowByPathUrl

Browser runs our flow…

flowRunningByPath

Another option to run the flow is to refer by FlowAlias parameter.

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

To use FlowAlias in URL we build it as follow:

http://localhost/decisions/Primary/?FlowAlias=Drop+Down+Flow

runFlowByAliasUrl

…and our Flow executes.

flowRunningByAlias

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. 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=51ab5883-4595-11e4-9c19-4ceb4297b7be&Action=api&sessionId=NS-590cc8a5-294a-11e4-9c12-4ceb4297b7be

runFlowApiByIdUrl

The result is xml formatted output from our flow.

runFlowApiByIdResult

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=Flow+Demos%2fFlow+1&Action=api&sessionId=NS-590cc8a5-294a-11e4-9c12-4ceb4297b7be

runFlowApiByPathUrl

And result is the same xml structured flow outcome…

runFlowApiByPathResult

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=51ab5883-4595-11e4-9c19-4ceb4297b7be&Action=viewapi

viewApiByIdUrl

With FlowPath parameter it would be:

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

viewApiByPathUrl

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

integrationPageOpensById

…and using FlowPath.

integrationPageOpensByPath

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