Flows

These extensions deal with flow metadata.

Table of content

• Flow Picker
• Generate Flow Link
• Get Flow Metadata
• Launch Autolaunched Flow

---

Flow Picker

A dropdown that lets you select a flow definition.

Type: Flow Screen Component

Properties:

Label	Type	Description
Label	String	Set the text to appear above the Flow selection box
Placeholder	String	Set the placeholder text to appear in the Flow selection box
Store the API name of the selected Flow	String	On output this stores the API name of the selected Flow, and the component can be initialized with a value on input
Only Show Active Flows	Boolean	If set to true, only active Flows will be displayed
Only Show Specific Flow Types	String	Comma separated list of Flow Process Types to be included (see documentation)
Required	Boolean	If set to true, an error message will appear when trying to advance to the next screen.
Flow Name Filter	String	Set an optional value to search and filter the returned list of Flows. This adds a LIKE %filtertext% to the Flow lookup.
Component width (out of 12)	Integer	By dividing the full display area width into 12 equal sections, you can specify the percentage of the total width to be used by this component in 12ths. For example, a value of 9 would be 75% width, 6 would be 50% width, 3 would be 25% width.

---

Generate Flow Link

Generates a Flow start link with up to 3 parameters.

Type: Invocable Action

Inputs:

Name	Type	Description
flowApiName	String	Flow API name
namespace	String	Flow's namespace
param1Name	String	Name of first parameter (optional)
param1Value	String	Value of first parameter (optional)
param2Name	String	Name of second parameter (optional)
param2Value	String	Value of second parameter (optional)
param3Name	String	Name of third parameter (optional)
param3Value	String	Value of third parameter (optional)

Outputs:

Name	Type	Description
flowLink	String	Flow start link

---

Get Flow Metadata

Gets a Flow definition metadata.

Type: Invocable Action

Inputs:

Only one of these inputs is required.

Name	Type	Description
flowApiName	String	Flow API name
flowDefinitionId	String	Flow definition Id

Outputs:

Name	Type	Description
flowApiName	String	Flow API name
flowDefinitionId	String	Flow definition Id
activeVersionId	String	Current active version Id
description	String	Flow description
label	String	Flow label
latestVersionId	String	Latest version Id
namespacePrefix	String	Namespace prefix
flowType	String	Flow type

---

Launch Autolaunched Flow

Launches an Autolaunched Flow with up to 3 parameters.

Type: Invocable Action

Inputs:

Name	Type	Description
flowApiName	String	Flow API name
namespace	String	Flow's namespace
param1Name	String	Name of first parameter (optional)
param1Value	String	Value of first parameter (optional)
param2Name	String	Name of second parameter (optional)
param2Value	String	Value of second parameter (optional)
param3Name	String	Name of third parameter (optional)
param3Value	String	Value of third parameter (optional)

Outputs:

Name	Type	Description
isSuccess	Boolean	A flag that reports whether the flow was successfully launched.
errorMessage	String	An error message in case the operation failed.