Gate Operator

Overview

The Gate operator filters your data based on given criteria. If your data does not meet the criteria, the Gate operator blocks it. Blocking the data frees up your application to improve performance elsewhere.

Let's say you build a module that requires an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. to enter a user name. Suppose you want to transfer an end-user's date of birth from a text field to a data table. Maybe you want to exclude displaying October birth dates. You can use the Gate operator to either block or transfer October birthdates.

Similar Data Workflow Operators

The Gate operator is similar to the Filter and Decision operators. Here are the operators compared: 

• Gate operator: Returns only the data that meets your Condition's criteria. If the data does not meet your criteria, the Gate operator blocks it.

• Filter operator: Separates data that meets your Condition’s criteria from data that does not. Data that meets your criteria passes through one pathway while data that does not meet your criteria passes through another.

• Decision operator: Separates data that meets your Condition’s criteria from data that does not. But, the Decision operator differs from the Filter operator because it only returns one output. If the input matches the criteria, it it passes through one pathway. If the input does not match the criteria, it passes through another pathway.

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

About the Info Window

Here's a breakdown of each setting in the 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.
Do Not Sanitize Formula	When this checkbox is clear, the operator cleans values coming into or defined in the operator. For example, removing special characters. Some of those special characters include ', $, #, &amp. The operator also cleans up complex values. For example, logically breaking up strings of numbers and letters using underscores. A sample module ID can go from 5f6b4cdfabf886024d4de2d3 to 5f_6b_4cdfabf_886024d_4de_2d_3. Sanitizing improves performance. But, it can also lead to unexpected data behavior. If your Create Field is not behaving as expected, try selecting this box. When selected, the operator uses your values and expressions as-is. This is best when working with complex values or values that should remain unchanged. By default, this setting is selected, which means the operator does not attempt to sanitize.
Preserve Argument Type	When selected, this setting ensures the argument data type is respected when the operator executes.
Condition	Defines the condition of the Gate operator based on the argument (_arg) used. When the condition is true, the Gate operator passes the input value to the output. When the condition is false, the Gate operator blocks the input value. When the Gate operator blocks a value, the Data Workflow stops.

Adding a Gate Operator

You'll configure a module that transfers a username from one Text Field component to another. The Gate operator lets end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. decide if they want their username transferred or not. If the end-user selects chooses not to transfer the username, the transfer is blocked.

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

Configure the Text Field Components

First, add two Text Field components to your module. The first component collects a username from the end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.. The second displays the username if they choose to confirm it.

1.

In the Module Builder, drag and drop two  Text Field components 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. and Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. fields, enter the following:

3.

Click Save Component for each component after you add it.

Configure the Radio Buttons Components

Next, add a Radio Buttons component so your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. can select whether they want to confirm their username.

1.

Drag and drop a Radio Buttons component onto your canvas, placing it between the gateInput and gateOutput Text Field components.

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

3.

In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Confirm your username submission?.

4.

Set Horizontal Layout to  (ON).

5.

In the Label and Value fields, enter the following:

6.

Click Save Component.

Configure the Data Workflow Component

Now, add the Data Workflow component to retrieve the data from your gateInput  Text Field component and pass it through a Gate operator. Then, the results are passed and displayed in the gateOutput Text Field component.

1.

Drag and drop a Data Workflow component onto your canvas, placing it between the gateArg Radio Buttons and gateOutput Text Field components.

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

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 ., enter dwfGate.

Configure the First 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 Second 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 Gate Operator

1.

Drag and drop a Gate operator onto your Data Workflow canvas.

2.

Configure the operator's Info window as follows:

3.

Connect the output port (right) of the gateInput Input operator to the input port (left) of the _arg ='Yes'Gate operator.

4.

Connect the output port (right) of the gateArg Input operator to the argument port (top) of the _arg ='Yes'Gate 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 _arg ='Yes' Gate operator to the input port (left) of the Gates _arg='Yes' Console operator.

Configure the Output Operator

1.

Drag and drop an Output operator onto your Data Workflow canvas.

2.

Configure the operator's Info window as follows:

3.

Connect the output port (right) of the _arg ='Yes' Gate operator to the input port (left) of the gateOutput Output operator.

4.

Click Save Component.

5.

Save your module

Here's how a completed example looks in the Module Builder:

Preview the 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.. Enter sample_User in the first field and select Yes. When you click Yes, sample_User displays in the second field.

Overview

The Gate operator filters your data based on given criteria. If your data does not meet the criteria, the Gate operator blocks it. Blocking the data frees up your application to improve performance elsewhere.

Let's say you build a module that requires an end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. to enter a user name. Suppose you want to transfer an end-user's date of birth from a text field to a data table. Maybe you want to exclude displaying October birth dates. You can use the Gate operator to either block or transfer October birthdates.

Similar Data Workflow Operators

The Gate operator is similar to the Filter and Decision operators. Here are the operators compared: 

• Gate operator: Returns only the data that meets your Condition's criteria. If the data does not meet your criteria, the Gate operator blocks it.

• Filter operator: Separates data that meets your Condition’s criteria from data that does not. Data that meets your criteria passes through one pathway while data that does not meet your criteria passes through another.

• Decision operator: Separates data that meets your Condition’s criteria from data that does not. But, the Decision operator differs from the Filter operator because it only returns one output. If the input matches the criteria, it it passes through one pathway. If the input does not match the criteria, it passes through another pathway.

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

About the Info Window

Here's a breakdown of each setting in the 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.
Do Not Sanitize Formula	When this checkbox is clear, the operator cleans values coming into or defined in the operator. For example, removing special characters. Some of those special characters include ', $, #, &amp. The operator also cleans up complex values. For example, logically breaking up strings of numbers and letters using underscores. A sample module ID can go from 5f6b4cdfabf886024d4de2d3 to 5f_6b_4cdfabf_886024d_4de_2d_3. Sanitizing improves performance. But, it can also lead to unexpected data behavior. If your Create Field is not behaving as expected, try selecting this box. When selected, the operator uses your values and expressions as-is. This is best when working with complex values or values that should remain unchanged. By default, this setting is selected, which means the operator does not attempt to sanitize.
Preserve Argument Type	When selected, this setting ensures the argument data type is respected when the operator executes.
Condition	Defines the condition of the Gate operator based on the argument (_arg) used. When the condition is true, the Gate operator passes the input value to the output. When the condition is false, the Gate operator blocks the input value. When the Gate operator blocks a value, the Data Workflow stops.

Adding a Gate Operator

You'll configure a module that transfers a username from one Text Field component to another. The Gate operator lets end-users End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. decide if they want their username transferred or not. If the end-user selects chooses not to transfer the username, the transfer is blocked.

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

Configure the Text Field Components

First, add two Text Field components to your module. The first component collects a username from the end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product.. The second displays the username if they choose to confirm it.

1.

In the Module Builder, drag and drop two  Text Field components onto your canvas.

2.

Enter the following Property ID A Property ID is the unique field ID used by Unqork to track and link components in your module. and Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field.:

3.

Click Save & Close

Configure the Radio Buttons Component

Next, add a Radio Buttons component so your end-user End-users, also known as Express Users, are the individuals accessing an application through Express View. In most cases, end-users are the customers using the product. can select whether they want to confirm their username.

1.

Drag and drop a Radio Buttons component onto your canvas, placing it between the gateInput and gateOutput Text Field components.

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

3.

In the Label Text Label Text conveys what the input component is and what information it displays. Enter the purpose of the corresponding component or field. field, enter Confirm your username submission?.

4.

Set Horizontal Layout to  (ON).

5.

In the Option Label and Value to Store in Submission Data fields, enter the following:

6.

Click Save & Close.

Configure the Data Workflow Component

Now, add the Data Workflow component to retrieve the data from your gateInput  Text Field component and pass it through a Gate operator. Then, the results are passed and displayed in the gateOutput Text Field component.

1.

Drag and drop a Data Workflow component onto your canvas, placing it between the gateArg Radio Buttons and gateOutput Text Field components.

2.

In the Canvas Label Text and Property Name fields, enter dwfGate.

Configure the First 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 Second 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 Gate Operator

1.

Drag and drop a Gate operator onto your Data Workflow canvas.

2.

Configure the operator's Info window as follows:

3.

Connect the output port (right) of the gateInput Input operator to the input port (left) of the _arg ='Yes'Gate operator.

4.

Connect the output port (right) of the gateArg Input operator to the argument port (top) of the _arg ='Yes'Gate 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 _arg ='Yes'Gate operator to the input port (left) of the Gates _arg='Yes'Console operator.

Configure the Output Operator

1.

Drag and drop an Output operator onto your Data Workflow canvas.

2.

Configure the Output operator's Info window as follows:

3.

Connect the output port (right) of the _arg ='Yes'Gate operator to the input port (left) of the gateOutputOutput operator.

4.

Click Save.

5.

Save your module.

Here's how a completed example looks in the Module Builder:

Preview the 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.. Enter sample_User in the first field and select Yes. When you click Yes, sample_User displays in the second field.