Skip to main content
Feedback

Publishing a flow

Publishing a flow allows you to build and execute a flow in the same way that a flow can be run, except that the published flow 'snapshot' is then set as the default version of the flow.

note

Care should be taken when publishing a flow; when a flow is published it will overwrite and become the new default version of the flow, which will impact any users currently running and using the flow. Typically, a flow would only be published after it has been run and tested. Refer to Running a flow.

Overview

When you publish a flow, a snapshot is taken of the current version of the flow, with this version becoming the default version of the flow.

  • The default URL for the flow is generated for this version of the flow, allowing you to access the flow in a browser as a web application, and share the flow with other users.

  • This default flow URL will always present the latest published version of your flow; this will be the version of the flow that users will run if a Flow Version Id is not specified.

Publishing a flow

The action button you see on the flow canvas (Publish or Build) is determined by whether the Environments feature is enabled in your tenant's settings:

  • If Environments is set to OFF (Default Behavior), you will see the Publish button. The flow is published as described in the steps outlined in this section.
  • If Environments is set to ON, the button is replaced with Build. For more detailed information on this process, refer to the documentation: Adding a Flow to a Release and Deployment.

To publish a flow.

  1. Select Publish from the right-hand menu on the flow canvas.

  2. The Publish Flow form is displayed.

    Publish Flow form

    • Enter a comment if required to provide information about this published version of the flow.

    • Tenant Administrators can also select which runtime environment to publish to by selecting the from the Runtime Environment drop-down menu. Standard users do not have this drop-down menu available.

  3. Click Publish to publish the flow.

  4. The Publish Flow form is displayed.

    Publish Flow form

    • Flow Run URL: The flow run URL is displayed. This URL identifies the default version of the flow, and will remain constant throughout the lifetime of the flow. Any user who accesses the flow with this URL will always be presented with the latest published version of the flow.

    • Player: Select the player you wish to use with the flow. The player section of the URL will update with the corresponding player that you select here. See Players.

  5. Click Run to launch and run the published flow web application in a browser.

The Flow Run URL

The URL generated when you publish a flow is the Flow Run URL.

The Flow Run URL

This URL includes the following information:

  • The Tenant ID for the tenant that the flow is stored in. See Tenants. Step 1

  • The Player that is being used to run the flow in a browser. Changing the player when you run a flow will change this value to the corresponding player in the URL. See Players. Step 2

  • The Flow ID that is the unique identifier for the flow. This remains constant throughout the life cycle of a flow. Step 3

When the published flow is launched in a browser, the Join URI is generated for the URL. See System state values for more information on joining and resuming flows using the Join URI.

On this Page