Running a Flow from a URL
- 17 Feb 2020
- 1 Minute to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
Running a Flow from a URL
- Updated on 17 Feb 2020
- 1 Minute to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
It is possible to run a flow, either as a service or by showing forms and Decisions user interface in a web browser, just by accessing its URL. This URL can be used to allow the execution of the workflow from a browser or as a service.
This document illustrates how to use Integration Details for a flow in Decisions. The Integration Details page allows different ways to integrate with the selected designer element.
Example
In this example, generate a URL to run a flow, either as a service or by rendering UI, using a URL inside a web browser.
Navigate to the Integration Details on a flow. Right-click any flow and navigate to Run[Advanced] > Integration > View Integration Details. This will bring up the Integration Details page for the workflow. This page will build a URL based on the settings.
A series of options will be shown to configure the URL you are generating.
| Configuration Option | Summary |
|---|---|
| Run As | Choose to create a URL to call the flow as a REST service, or to have any UI/Forms show in a web browser. |
| Credential | Option to choose user authentication type. |
| Refer Flow By | URL to use either Folder Id, Path, or Alias to the Flow. |
| Rest Data | This option is only shown if you selected Run As: Service, and will return the results of a flow in the selected format. |
| Display Settings | This option is only showing if you select "UI/Form". Here, you can set some display choices for how the UI will be shown in the browser, such as centering the form on the page or making it fill the entire browser. |
Once the settings are configured select Show Service API.
Finally, because the Flow may have Forms and User Interface, there's an option to Run Flow As UI/Form. With this option selected the System generates a UI Code link to run the Flow. Select Generate UI Code.
This URL can be copied into any web browser to run the workflow.
Was this article helpful?
