---
title: "Includes Operator"
slug: "includesoperator"
updated: 2025-09-26T02:27:46Z
published: 2025-09-26T02:27:46Z
canonical: "docs.unqork.io/includesoperator"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.unqork.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Includes Operator

UDesignerClassic Designer

## 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.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/includesOperator_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

The Includes operator only works with a single value or an array. To process data from a table, use a [Get](/v1/docs/get-operator) or [Col2Array](/v1/docs/col2array-operator) operator to select a specific value or array.

You'll find the Includes operator under the [Array](/v1/docs/array-operators) group to the left of your [Data Workflow](/v1/docs/data-workflow-component) 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](/v1/docs/data-table-component) component with a list of users and their roles. Then, use an Includes operator in a [Data Workflow](/v1/docs/data-workflow-component) component to verify that a specific user has the role of **administrator**.

> [!NOTE]
> These instructions assume you have a new module open, saved, and with a title.

### Configure the Data Table Component

First, configure a [Data Table](/v1/docs/data-table-component) 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 |

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/dtUsers_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)
4. Click **Save Component**.

### Configure the Data Workflow Component

Now, let's configure the [Data Workflow](/v1/docs/data-workflow-component) component that uses a [Get operator](/v1/docs/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](/v1/docs/console-operator) operator to view how the data is passed.

1. Drag and drop a **D****ata 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 **I****nput** operator onto your **D****ata 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 **G****et** operator onto your **D****ata 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 **I****nput** operator to the input port (left) of the **G****et** operator.

#### Configure the Includes Operator

1. Drag and drop an **I****ncludes** operator onto your **D****ata 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 **G****et** operator to the input port (left) of the **I****ncludes** operator.

#### Configure the Console Operator

1. Drag and drop a **C****onsole** operator onto your **D****ata 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 **I****ncludes** operator to the input port (left) of the **C****onsole** operator.
4. Click **Save Component**.

Here's how the completed Data Workflow looks:

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/dwfIncludesSIngleValue_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

### Configure the Initializer Component

Lastly, configure an [Initializer](/v1/docs/initializer-component) component to trigger the Data Workflow.

1. Drag and drop an **I****nitializer** 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:

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/moduleComplete_thumb_0_0(9).jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

**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**.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/expressView_thumb_0_0(16).jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

## 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.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/includesOperatorClassic_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

The Includes operator only works with a single value or an array. To process data from a table, use a [Get](/v1/docs/get-operator) or [Col2Array](/v1/docs/col2array-operator) operator to select a specific value or array.

You'll find the Includes operator under the [Array](/v1/docs/array-operators) group to the left of your [Data Workflow](/v1/docs/data-workflow-component) 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](/v1/docs/data-table-component) component with a list of users and their roles. Then, use an Includes operator in a [Data Workflow](/v1/docs/data-workflow-component) component to verify that a specific user has the role of **administrator**.

> [!NOTE]
> These instructions assume you have a new module open, saved, and with a title.

### Configure the Data Table Component

First, configure a [Data Table](/v1/docs/data-table-component) 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:

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

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/dtUsersClassic_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)
4. Click Save.

### Configure the Data Workflow Component

Now, let's configure the [Data Workflow](/v1/docs/data-workflow-component) component that uses a [Get operator](/v1/docs/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](/v1/docs/console-operator) operator to view how the data is passed.

1. Drag and drop a **D****ata 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 **I****nput** operator onto your **D****ata Workflow** canvas.
2. Configure the operator's **Info** window as follows:

| Setting | Value |
| --- | --- |
| Category | Input |
| Component | dtUsers |
| Required | Yes |
| Source | Default |

#### Configure the Get Operator

1. Drag and drop a **G****et** operator onto your **D****ata Workflow** canvas.
2. Configure the operator's **Info** window as follows:

| Setting | Value |
| --- | --- |
| Category | Get |
| Label | Get [1].role |
| Preserve Argument Type | ☐ (**unchecked**) |
| Path | [1].role |
3. Connect the output port (right) of the **I****nput** operator to the input port (left) of the **G****et** operator.

#### Configure the Includes Operator

1. Drag and drop an **I****ncludes** operator onto your **D****ata Workflow** canvas.
2. Configure the operator's **Info** window as follows:

| Setting | Value |
| --- | --- |
| Category | Includes |
| Label | Includes Administrator |
| Preserve Argument Type | ☐ (**unchecked**) |
| Value | administrator |
3. Connect the output port (right) of the **G****et** operator to the input port (left) of the **I****ncludes** operator.

#### Configure the Console Operator

1. Drag and drop a **C****onsole** operator onto your **D****ata Workflow** canvas.
2. Configure the operator's **Info** window as follows:

| Setting | Value |
| --- | --- |
| Category | Console |
| Label | Does [1].role Include Administrator? |
3. Connect the output port (right) of the **I****ncludes** operator to the input port (left) of the **C****onsole** operator.
4. Click **Save**.

Here's how the completed Data Workflow looks:

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/dwfIncludesSIngleValueClassic_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

### Configure the Initializer Component

Lastly, configure an [Initializer](/v1/docs/initializer-component) component to trigger the Data Workflow.

1. Drag and drop an **I****nitializer** 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 field, 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 & Close**.
7. **Save** your module.

Your completed module looks like the following:

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/moduleCompleteClassic_thumb_0_0(4).jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

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**.

![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/expressView_thumb_0_0(17).jpg?sv=2026-02-06&spr=https&st=2026-11-08T18%3A00%3A58Z&se=2026-11-08T19%3A00%3A58Z&sr=c&sp=r&sig=Gv%2BkH4GF8qbs7NCOe7w%2F%2F0motHQsMDfSCk%2FOn7lpvG0%3D)

## Resources

- [Modify the Includes operator](/v1/docs/modifying-data-workflow-operators).
- [Introduction to Data Workflow](/v1/docs/introduction-to-data-workflow)
- [Introduction to Data Workflow Operators](/v1/docs/data-workflow-operators)
- [Data Workflow component](/v1/docs/data-workflow-component)

The Boolean data type accepts one of two values: true, or, false.

An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

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 outputs components and actions you want the component to perform.

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.

The DevTools Console helps you securely store, build, test, and deploy your software.