Create List Builder

Updated on 17 Sep 2024
4 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Step Details
Introduced in Version	---
Last Modified in Version	9.3.0
Location	Data > List > List Builder

The Create List Builder is a step used to create or manipulate List Data. This List Data is specified in the step by defining the desired ListType. Upon running Create List Builder, the step provides users access to additional steps that may be used to append and further edit the List. These additional steps are found in the Toolbox under Data In Flow > List > Methods.

How the Step works - Version 9.3 and Above

List Builders are special, high performance, lists of things like strings or custom data types. When using a list builder, changes are made directly to the list and not mapped out of different steps. After placing the step the kind of data that will make up the list is chosen from a drop-down menu.

Create List Builder has a setting called "Output Data as List". When this setting is enabled the step will function as it would in v9.2 and below (see the next section for more information). When the setting is disabled the step can be used to create arrays and data can be added to it.

The output of the step can only be used within the Flow that the step is in. For instance, its output cannot be passed into a Subflow. If work needs to be divided new List Builders will have to be added to those Subflows.

How the Step works - Version 9.2 and Below

The Create List Builder step prior to v9.3 creates a dynamic data type. Because it is a unique data type it cannot be used with steps such as Add Items to List, despite List being in the name, because the List type is not an Array type.

Breaking Change

Users upgrading to version 9 with Legacy Projects containing the Create List Builder step are advised to upgrade directly to v9.3 or higher. Users that have upgraded to an earlier version of v9 should not convert their Legacy Projects. The Create List Builder step will not compile properly.

Additional Step Names	Description	Inputs
Add (item [data structure name])	This step adds an item of the specified data structure to the list. The item gets appended to the end of the list.	item: Item to add to the list On Object: List to add the item to
AddIfDoesNotExist (item [data structure name])	Similar to the "Add" step, this one adds an item to the list. However, it only adds the item if it does not already exist in the list. It checks for the item's presence before adding.	item: Item to add to the list On Object: List to add the item to
Clear()	This step removes all the elements from the list.	On Object: List to remove all items from
Contains (item [data structure name])	This step checks whether the specified item exists in the list. It returns a boolean value (true or false) indicating whether the item is present in the list.	item: Item to check if it exists in the list On Object: List to check if the item exists within it
CopyTo (array [data structure name], arrayIndex Int32)	This step copies the elements of the list to another array of the same data structure, starting at the specified index in the destination array. It allows for data transfer between lists or arrays.	array: Destination array where elements will be copied. array Index: Index in the destination array where copying begins. On Object: List to copy elements from.
GetByKey (key String)	If the list contains items with keys, this step retrieves an item from the list based on a provided key. It returns the item associated with the specified key.	key: Key to search for in the list. On Object: List to retrieve the item from.
IndexOf (item [data structure name])	This step finds the index (position) of the list's first occurrence of the specified item. It returns the index if the item is found and -1 if the item is not in the list.	item: Item to add to the list On Object: List to add the item to
Insert (index Int32, item [data structure name])	This step allows for the insertion of an item at a specific index in the list. Existing elements shift to accommodate the new item.	index: Index at which to insert the item. item: Item to add to the list On Object: List to add the item to
Remove (item [data structure name])	This step removes the first occurrence of the specified item from the list. If the item exists multiple times, only the first occurrence is removed.	item: Item to remove from the list On Object: List to remove the item from
RemoveAt (index Int32)	This step removes the item at the specified index in the list. It allows targeting and removing a specific element by its position in the list.	index: Item to remove from the list On Object: List to remove the item from
RemoveByKey (key String)	Similar to "Remove," this step removes an item from the list based on a provided key if the list contains items with keys. It removes the item associated with the specified key.	key: Key to identify the item to remove from the list. On Object: List to remove the item from.