Contents x
Create List Builder
  • 27 Sep 2023
  • 3 Minutes to read
  • Print
  • Dark
    Light
Contents

Create List Builder

  • Updated on 27 Sep 2023
  • 3 Minutes to read
  • Print
  • Dark
    Light
Article Summary

Step Details
Introduced in Version---
Last Modified in Version7.12.0
LocationData > 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.

Additional Step NamesDescriptionInputs
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.

Properties

Inputs

PropertyDescriptionData Type
ListTypeSelect the data type desired for the list being created.---

Outputs

PropertyDescriptionData Type
ListEmpty list to be manipulated with data in the Flow with the additional steps created when adding this step to the workspace.---

Was this article helpful?
What's Next
Decisions
Resources
Organization
Connect