Includes Operator

Overview

The Includes operator verifies that workflow data contains a specific value. If there's a match, the operator outputs true. If there is not a match, the operator outputs false. This functionality is similar to a Boolean logic check.

The Includes operator only works with a single value or an array. To process data from a table, use a Get or Col2Array operator to select a specific value or array.

You'll find the Includes operator under the Array group to the left of your Data Workflow canvas.

About the Info Window

Learn more about each setting in the Includes operator's Info window:

Adding an Includes Operator

For this example, set up a Data Table component with a list of users and their roles. Then, use an Includes operator in a Data Workflow component to verify that a specific user has the role of administrator.

These instructions assume you have a new module open, saved, and with a title.

Configure the Data Table Component

First,  configure a Data Table component with a list of users and their roles.

1. In the Module Builder, drag and drop a Data Table component onto your canvas.

2. In the Property ID  field, enter dtUsers.

3. In the data table, enter the following:

   	A	B
   1	userName	role
   2	rmoose	architect
   3	kbell	administrator
   4	rgreen	authenticated

   

4. Click Save Component.

Configure the Data Workflow Component

Now, let's configure the Data Workflow component that uses a Get operator to retrieve the role of the second user in your data table. Next, configure an Includes operator to verify that the data contains the administrator value. Finally, add a Console operator to view how the data is passed.

1. Drag and drop a Data Workflow component onto your canvas, placing it below the dtUsers   Data Table  component.

2. In the Property ID field, enter dwfIncludesSingleValue.

3. In the Canvas Label Text field, enter dwfIncludesSingleValue.

Configure the Input Operator

1. Drag and drop an Input operator onto your Data Workflow canvas.

2. Configure the  operator's Info window as follows:

   Info
   Category	Input
   Component	dtUsers
   Required	Yes
   Source	Default

Configure the Get Operator

1. Drag and drop a Get operator onto your Data Workflow canvas.

2. Configure the  operator's Info window as follows:

   Info
   Category	Get
   Label	Get [1].role
   Preserve Argument Type	☐ (unchecked)
   Path	[1].role

3. Connect the output port (right) of the Input operator to the input port (left) of the Get operator.

Configure the Includes Operator

1. Drag and drop an Includes operator onto your Data Workflow canvas.

2. Configure the  operator's Info window as follows:

   Info
   Category	Includes
   Label	Includes Administrator
   Preserve Argument Type	☐ (unchecked)
   Value	administrator

3. Connect the output port (right) of the Get operator to the input port (left) of the Includes operator.

Configure the Console Operator

1. Drag and drop a Console operator onto your Data Workflow canvas.

2. Configure the  operator's Info window as follows:

   Info
   Category	Console
   Label	Does [1].role Include Administrator?

3. Connect the output port (right) of the Includes operator to the input port (left) of the Console operator.

4. Click Save Component.

Here's how the completed Data Workflow looks:

Configure the Initializer Component

Lastly, configure an Initializer component to trigger the Data Workflow.

1. Drag and drop an Initializer component onto your canvas, placing it above the dtUsers  Data Table  component.

2. In the Property ID field, enter initDwf.

3. In theCanvas Label Text, enter initDwf.

4. From the Trigger Type drop-down, select New Submission.

5. In the Outputs table, enter the following:

   	Source	Type	Value
   1	dwfIncludesSingleValue	trigger	GO

6. Click Save Component.

7. Save your module.

Your completed module looks like the following:

Preview your module in Express View and open the DevTools Console. You'll see the Does [1].role Include Administrator? key displays a value of true.