Creating Your First FlowLast Updated: 05/02/2018 Introduced in Version: 2.0
A Flow is a diagram of interconnected components that sequentially execute steps to accomplish a task. Almost all steps result in an outcome, such as true or false, and most output some type of data. Outcomes in a flow are represented as arrows that connect steps together. These outcome paths determine the direction of a flow which can be built in the Flow Designer.
Every flow begins with a Start Step and ends with at least one End Step. Between these two steps, flows can be built with unlimited size and complexity, and can even be nested within one-another as sub-flows. Many common or complex tasks have dedicated components already designed for use in a flow, and they can be found in the Toolbox panel of the Flow Designer.
As a flow progresses, each subsequent step has access to any output data created in the steps preceding it. This document will outline the creation of a simple flow.
In the example, we will:
- Create a Designer Folder.
- Create a flow in the Designer Folder that sends a notification.
- Run the flow to see the notification display.
Our example flow will display a pop-up notification containing the message “Test Notification.”
We’ll begin in the portal by creating a Designer Folder to contain our flow. A Designer Folder is a place in Decisions where a user can build things such as flows, rules, and forms. On the left hand side, from the Navigation menu, select My Tasks > Add > Designer Folder.
In the Add Designer Folder pop-up, type “My First Designer Project” in the Folder Name field, select Add At Root which will create the designer folder at the base level of the tree structure, then click OK.
Inside the new Designer Folder, click the Flow icon.
In the New Flow dialog, name the flow “Send Notification” and click OK to open the Flow Designer. In this example, we can leave the rest of the settings as default.
In the Flow Designer, click the arrow from the Start Step. This will bring up the Quick Add for Step dialog, expand the All Steps[Catalog] > Communication category then click the Send Notification component and click Add.
To complete the structure of the flow, connect the outcome paths of the steps. Connect Send Notifications outcome, Done, to the End Step. To connect this click and drag the Done arrow to End Step.
When the Flow Designer believes that a component is not configured correctly, it highlights the invalid component with an alert icon, a red rounded square with a white exclamation mark. In the example flow, the Send Notification step is still considered invalid.
Send Notification will become valid once its properties are configured in the Properties panel. Click on the Send Notification step. In the Properties panel on the right side of the screen, under the Notify To tab, add groups and users to receive the notification. Under Notify To > NotifyUser click the Add New button.
In the Pick Entity dialog, click your current user and click OK.
In the Properties panel under the Inputs tab, configure the details of the notification. We already set up email@example.com to be notified, leave the Mapping Type of Accounts and Groups set to Ignore.The Send Notification step builds a notification from three inputs, Accounts and Groups, Message and Subject.
Under Inputs > Message, change the Mapping type. Every type of data allows certain mapping operations to be performed which can alter or create the input that is needed. Because we know the exact value that Message should contain, set its Mapping Type to Constant and type in “Test Notification” in the Value field. Input data into steps can also come from data the flow knows about, or that the step can go fetch. For more information about Mapping Type click here.
If we wanted our message to be the output of an earlier flow step, we could select Select Value for the Mapping Type. We could also nullify this input, ignore it, transform some other input into the required type with a conversion flow, or even construct in plain text or HTML.
Under Inputs > Subject, select a Mapping Type of Constant and fill in Value with “My First Notification.”
Click on Save Flow at the top of the workspace, this will generate a dialog allowing notes to be added to this flow’s history folder. In this example we will leave this blank and select Save.
Click on Debug Flow in the top panel to run the flow in the debugger. Click the run button in the middle of the screen. Notice a pop-up notification appears in the upper-right corner of the screen. Its subject reads “My First Notification” and the message reads “Test Notification.”