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 The Boolean data type accepts one of two values: true, or, false. logic check.

The Includes operator only works with a single value or an array An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects.. 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:

Setting	Description
Category	Grayed out and non-adjustable setting indicating the operation type.
Label	Sets the label for your operator, displaying below the operator on your Data Workflow canvas. This field is optional, but set a label if you use more than one of the same operator type. A label helps you identify your operators without opening any Info windows.
Preserve Argument Type	When selected, this setting ensures the argument data type is respected when the operator executes.
Value	The value the Includes operator locates from the data passed to it. If your data contains this value, the operator produces true as the output. If the data does not contain this value, the operator produces false as the output.

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 A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter dtUsers.

3.

In the data table, enter the following:

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 A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter dwfIncludesSingleValue.

3.

In the Canvas Label Text Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the . 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:

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:

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:

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:

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 A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter initDwf.

3.

In theCanvas Label Text Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the ., enter initDwf.

4.

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

5.

In the Outputs table Enter outputs components and actions you want the component to perform., enter the following:

6.

Click Save Component.

7.

Save your module.

Your completed module looks like the following:

Preview your module in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View. and open the DevTools Console The DevTools Console helps you securely store, build, test, and deploy your software.. You'll see the Does [1].role Include Administrator? key displays a value of true.

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 The Boolean data type accepts one of two values: true, or, false. logic check.

The Includes operator only works with a single value or an array An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects.. 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:

Setting	Description
Category	Grayed out and non-adjustable setting indicating the operation type.
Label	Sets the label for your operator, displaying below the operator on your Data Workflow canvas. This field is optional, but set a label if you use more than one of the same operator type. A label helps you identify your operators without opening any Info windows.
Preserve Argument Type	When selected, this setting ensures the argument data type is respected when the operator executes.
Value	The value the Includes operator locates from the data passed to it. If your data contains this value, the operator produces true as the output. If the data does not contain this value, the operator produces false as the output.

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 Label and PropertyName fields, enter dtUsers.

3.

In the data table, enter the following:

4.

Click Save.

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 Canvas Label Text and Property Name fields, 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:

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:

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:

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:

3.

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

4.

Click Save.

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 A Property ID is the unique field ID used by Unqork to track and link components in your module. field, enter initDwf.

3.

In theCanvas Label Text Canvas Label Text indicates the purpose of the corresponding field or component. For non-input components, the Canvas Label Text isn't end-user facing, and only appears in the . field, enter initDwf.

4.

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

5.

In the Outputs table, enter the following:

6.

Click Save & Close.

7.

Save your module.

Your completed module looks like the following:

Preview your module in Express View Express View is how your end-user views your application. Express View also lets you preview your applications to test your configuration and view the styling. This is also the view your end-users will see when interacting with your application. After configuring a module, click Preview in the Module Builder to interact with the module in Express View. and open the DevTools Console The DevTools Console helps you securely store, build, test, and deploy your software.. You'll see the Does [1].role Include Administrator? key displays a value of true.