Set Outputs Operator
Overview
The Set Outputs operator outputs data from the Data Workflow to multiple locations. You can use this operator to output the same value to 2 or more locations. It's important to note that it doesn't output different values to different locations.
You can also use this operator to trigger multiple components. Most components have a single Trigger setting. So, using the Set Outputs operator is a good way to trigger more than one component at once. You can choose up to 5 components.
Similar Data Workflow Operators
The Set Outputs operator is almost identical to the Output operator. Here are the operators compared:
-
Set Outputs operator: Outputs data from the Data Workflow to multiple locations.
-
Output operator: Outputs data from the Data Workflow to one location.
What You'll Learn
In this article, you'll learn:
About the Info Window
Here's what the Set Outputs operator looks like, along with its Info window:
And here's a breakdown of each setting in the Info window:
Setting |
Description |
---|---|
Component |
Your output destination or the component where you want the output value pushed to. Here, you'll see a drop-down containing the Property ID of every component in your module. Select the component you want to reference from the drop-down list. You can also type the name of the component's Property ID in the Component field and it will filter the drop-down based on your input. After selecting a Property ID, the Component field remains editable. You can type in the Component field to define a property path or target fields nested under the selected Property ID. Your selection here displays as the operator's label. Only your selection in the first Component field shows on your Data Workflow canvas. TIP The Data Workflow component supports using grid referencing syntax to target the Dynamic Grid, Uniform Grid, and Freeform Grid components. Grid referencing syntax supports targeting at the component, column, row, and cell level. To learn more, see the following articles in our In-Product Help: Dynamic Grid: Targeted Logic and Referencing Syntax and Uniform Grid and Freeform Grid: Logic and Referencing Syntax. |
Component 1-5 |
Here you link the additional output locations. Each extra field lets you choose a component to reference in your Data Workflow. Select a unique Property ID from each drop-down. If you reference less than 5 extra components, leave the rest empty. |
Action |
The action you want to output in your Data Workflow. The most common action is value, which outputs a value. To perform another type of action, select that specific action. |
setValue |
To push a text or number value to the output locations, enter the value here. |
Adding the Set Outputs Operator
To demonstrate the Set Outputs operator, you'll create a simple module. If the end-user clicks a button, both fields populate with Not Applicable.
Here's how the completed use case looks in the Module Builder:
What You Need
To set up this use case, you need:
-
2 Text Field components
-
1 Button component
-
1 Data Workflow component
To set up your Data Workflow, you need:
-
1 Create Value operator
-
1 Set Outputs operator
Configure the Text Field Components
First, add 2 Text Fields to serve as the output components.
1. | Drag and drop 2 Text Field components onto your canvas. |
2. | Enter the following Property IDs and Label Text: |
Property ID |
Label Text |
---|---|
jobTitle |
Job Title |
salary |
Salary |
3. | Save each component as you add it. |
Configure the Data Workflow Component
Next, you'll set up the Data Workflow itself.
1. | Drag and drop a Data Workflow component onto your canvas. Place the Data Workflow component under the Text Fields. |
2. | In the Canvas Label Text and Property Name fields, enter dwfValue. |
Configure the Create Value Operator
1. | Drag and drop a Create Value operator onto your Data Workflow canvas. |
2. | Configure the Input operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Create Value |
Label |
Create GO Value |
Expression/Value |
"yes" |
Configure the Set Outputs Operator
1. | Drag and drop a Set Outputs operator onto your Data Workflow canvas. |
2. | Configure the Set Outputs operator's Info window as follows: |
Setting |
Value |
---|---|
Category |
Set Outputs |
Component |
jobTitle |
Component 1 |
salary |
Action |
Value |
setValue |
Not Applicable |
3. | Connect the output port (right) of the Create Value operator to the input port (left) of the Set Outputs operator. |
4. | Click Save. |
Configure the Button Component
Finally, to trigger the Data Workflow, add a Button component.
1. | Drag and drop a Button component onto your canvas. Place your Button component above your Data Workflow component. |
2. | In the Property ID field, enter btnValue. |
3. | In the Label Text field, enter Not Applicable. |
4. | Select Event as the Action Type. |
5. | In the Trigger on Click field, enter dwfValue. |
6. | Click Save. |
In Express View you can test the Data Workflow. Click the button, and you'll see both fields populate with Not Applicable.
Changing a Set Outputs Operator Settings
You can revisit and make changes to this operator.
1. | Click the Data Workflow component. |
A 5-button toolbar displays above the component on hover-over.
2. | Click the (Settings) button to open the Data Workflow canvas. |
3. | Click the operator to open its Info Window. |
4. | Make changes to the operator's settings as needed. |
5. | Click Save. |
6. | Save your module. |
Copying a Set Outputs Operator
You can make a copy of your operator using familiar keyboard settings. You can copy and paste an exact copy of your operator, matching all settings.
1. | Hover over the Data Workflow component. |
A 5-button toolbar displays above the component on hover-over.
2. | Click the (Settings) button to open the Data Workflow canvas. |
3. | Click the operator you want to duplicate. |
4. | On your keyboard, press Command + C (Mac OS) or Ctrl + C (Windows/Linux) to copy the operator. |
TIP You can copy more than one operator at a time. Hold Command or Ctrl on your keyboard and click all the operators you want to copy. Follow the rest of the steps as usual.
5. | On your keyboard, press Command + V (Mac OS) or Ctrl + V (Windows/Linux) to paste the copied operator(s) to the Data Workflow canvas. |
6. | Click Save. |
7. | Save your module. |
TIP Did you know you can copy an operator and paste it into a different Data Workflow? You'll use the same steps outlined above.
Removing a Set Outputs Operator
Lastly, you can delete this operator from your Data Workflow canvas. You can also use these same steps to delete a connection between two operators.
1. | Hover over the Data Workflow component. |
A 5-button toolbar displays above the component on hover-over.
2. | Click the (Settings) button to open the Data Workflow canvas. |
3. | Click the operator you want to delete. |
4. | On your keyboard, press Delete. |
NOTE Once you delete this operator, make sure to connect your remaining operators. If your Data Workflow path doesn't end with an Output or Console operator, your Data Workflow won't work. So, once you delete an operator, make sure to update any remaining paths to end at an Output or Console operator.
5. | Click Save. |
6. | Save your module. |
Resources
Lab
You can view the complete lab here: https://training.unqork.io/#/form/5f52855a811147022224e2ae/edit.