@itentialopensource/remove-element-from-array-by-value
v0.0.12-2023.1.1
Published
[Deprecated] A JST to remove an element from an array by value
Downloads
7
Readme
Deprecation Notice
This Pre-Built has been deprecated as of 01-15-2024 and will be end of life on 01-15-2025. The capabilities of this Pre-Built have been replaced by the IAP - Data Manipulation
Remove Element from Array by Value
Table of Contents
Overview
This pre-built is used to remove an element from an array by a value. The first input is an array consisting of numbers, strings or a boolean. The second input is the value to be removed from the array. The third input is a boolean input removeMany, which is used to decide whether to remove only the first occurrence of the value or all the occurrences. A 'true' value results in the removal of all the occurrences of the value whereas a 'false' value results in the removal of that value at the first index present. It returns the newArray and a count of removed elements noOfRemovedItems.
Installation Prerequisites
Users must satisfy the following pre-requisites:
- Itential Automation Platform
^2022.1.x
Features
The main benefits and features of the Pre-Built are outlined below.
- Uses low code approach to remove element from array by value.
- Utilizes the new feature called transformation in IAP version 2020.1.
How to Install
To install the Pre-Built:
- Verify you are running a supported version of the Itential Automation Platform (IAP) as listed above in the Requirements section in order to install the Pre-Built.
- The Pre-Built can be installed from within App-Admin_Essential. Simply search for the name of your desired Pre-Built and click the install button.
How to Run
How to use JST in a workflow:
- In order to run this JST, add the appropriate JST task onto the workflow, then search for "Remove element from array by value" and assign values to all incoming variables: array : ARRAY of INT, STRING, BOOLEAN, value: INT and removeMany: BOOLEAN.
- The output will return the newArray and count of removed elements noOfRemovedItems.
Additional Information
Please use your Itential Customer Success account if you need support when using this Pre-Built.