Nest By Operator

The Nest By operator creates a nested table (array of objects) in a connected parent table. Nesting arrays allows you to group rows by a shared parent key. Rows with the same parent key value are combined, and the remaining fields are nested under a specified child name key.

You'll configure the operator with a parent key that'll remain un-nested for each row. Then, you’ll provide a child name key where your new nested array will exist. This configuration lets you group rows of data by a parent key value. For example, you can nest by a parent key that has the same value across multiple rows. All rows with the same parent key value group into one row. The remaining fields nest as individual rows in the same child name array.

Keys that are not consistent across all arrays will be dropped, which can result in data loss.

You'll find the Nest By operator under the Table Operators group to the left of the Data Workflow canvas.

About the Info Window

Here's a breakdown of each setting in the Nest By operator’s Info window:

Adding a Nest By Operator

In this example, you'll use the Nest By operator to group by the duplicate account numbers in your Data Table component. That way, you can set the table's account number as the operator's key.

These instructions assume you have a module open, saved, and titled.

Configure the Data Table Component

First, you'll set up a Data Table component with a list of customers, account values, and account numbers.

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

2. In the Property ID field, enter dtAccountInfo.

3. In the data table, enter the following:

   #	accountNumber	firstName	lastName	accountValue
   1	12345	Josephine	Darakjy	543891
   2	12346	Lenna	Paprocki	1000000
   3	12346	Sage	Wieser	1000000
   4	12347	Abel	Maclead	7432572
   5	12348	Ernie	Stenseth	5000000
   6	12349	Valentine	Gillian	5439294
   7	12346	Dyan	Oldroyd	17890
   8	12347	Fatima	Saylors	19578
   9	12347	Willow	Kusko	54389

   You purposely added duplicate information to show the power of the Nest By operator.

   

   4. Click on Save Component.

Configure the Button Component

To trigger the Data Workflow, you'll add a Button component.

1. Drag and drop a Button component onto your canvas, placing it below your dtAccountInfo Data Workflow component.

2. In the Property ID, enter btnNestByNumber.

3. In the Label Text field, enter Nest by Account Number.

4. From the Action Type drop-down, select Event.

5. In the Triggers On Click field, enter dwfNestByNumber.

   

6. Click Save Component.

Configure the Data Workflow Component

Now, you'll set up your Data Workflow to input and nest the data from your Data Table component.

1. Drag and drop a Data Workflow component onto your canvas, placing it below your btnNestByNumber Button component.

2. In the Property ID and Canvas Label Text fields, enter dwfNestByNumber.

   

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:

   Setting	Value
   Category	Input
   Component	dtAccountInfo
   Required	No
   Source	Default

Configure the Nest By Operator

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

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

   Setting	Value
   Category	Nest By
   Label	Nest by accountNumber
   Parent Keys	accountNumber
   Child Name	account

3. Connect the output port (right) of the dtAccountInfo Input operator to the input port (left) of the Nest by accountNumber Nest By 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:

   Setting	Value
   Category	Console
   Label	Nest by Account Number

3. Connect the output port (right) of the Nest by accountNumber Nest By operator to the input port (left) of the Nest by accountNumber Console operator.

4. Click on Save Component.

5. Save your module.

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

Preview your module in Express View, and open the DevTools Console. Click the Nest By Account Number button, and you'll see the nine table rows grouped into five rows. Each new array now has the child name of the account. You can also see that these new arrays are nested by accountNumber.