Use the URL to Start or Open a Workflow

You can use runtime URLs to open an existing workflow, start a new workflow, and control some UI elements, such as show/hide the left-panel tree.

To perform these procedures, you call the Runtime.aspx page with several parameters.

Runtime URL

As long as the client does not have special IIS configurations, the runtime URL should follow this following format.

http://[ServerNameAndPort]/_Layouts/RunTime.aspx

[ServerNameAndPort] is the IP/DNS name of the server, with the port, for example: 22.34.232.12:8080.

When you build URLs in code, never hard code the server name and port, since they might change for a single instance, and will most likely be different between environments. For client-side code, you can get the host name using JavaScript, for more information read this article.  For server-side code, you can keep the server and port in reference tables.

Main Parameters

ParameterDescription
workflowInstanceId=[int]Open a specific workflow instance ID.
workflowid=[Guid]Start a new instance for this workflow ID.
WorkflowSpaceId=[Guid]Start a new workflow instance for the workflow space, using the active version.

NOTE: It is acceptable to use workflowid, but the best practice (unless there are specific requirements), is to use WorkflowSpaceId. The URL always opens the active version of the workflow.

Other Parameters

ParameterDescription
ShowTree=noneAdd this parameter to hide the left-panel tree.
ShowTabs=noAdd this parameter to hide the main form container tab bar.
Culture=[Language Culture Name]Add a culture to force a system globalization settings in the form, such as date formats.
uiculture=[Language Culture Name]Add a uiculture to force a system globalization settings in the form, such as date formats.

UPDATE: For Sequence 7 and later, ShowTree and ShowTabs were replaced with new parameters. The old parameters are still supported, but the new ones are more consistent and easy to use. For more information, read this post.

Example

  • Open workflow instance 87, 
  • Without left-side tree
  • Without form tabs
  • Globalization settings for UK (en-GB)

http://10.20.20.11:8080/_layouts/15/runTime.aspx?culture=en-GB&uiculture=en-GB&workflowInstanceId=87&ShowTree=none&ShowTabs=no