@itentialopensource/allocate-a-pair-of-numbers
v0.0.13-2023.1.1
Published
[Deprecated] A JST to find a pair of consecutive integers from within an array to allocate
Downloads
5
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
Allocate a Pair of Numbers
Table of Contents
- Overview
- Installation Prerequisites
- Features
- Future Enhancements
- How to Install
- How to Run
- Additional Information
Overview
This Pre-Built consists of a JST document that finds the first available consecutive pair of numbers from a given starting integer, a given ending integer, and a given array of already allocated integers (allocated
).
For instance, a range is defined by start and end values: ex: 0 through 255. These values are assumed for the following examples.
Example 1: allocated: [12,200,199,0,2,4,100,101,150]
. The output from this JST is an object containing the next available consecutive pair of numbers availible in the range. { "assigned": [5,6] }
.
Example 2: allocated: [187,19,0,1,2,18,10,140]
The output for this JST will be { "assigned": [3,4] }
.
In case the range is all allocated, the output object will be: { "assigned": false }
Example use cases when this JST can be used: an array of ports, an array of IP addresses (can only handle 1 quadrant: 0-255), etc.
Estimated Run Time: depends on the size of the array. usually within second(s)
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.
- Finds the first available consecutive pair of numbers within an array.
Future Enhancements
- Increasing an algorithm's efficiency by converting logic onto a recursive call.
How to Install
To install the artifact:
- 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 artifact and click the install button.
How to Run
In order to run this JST, add the appropriate JST task onto the workflow, then search for "allocateNewPair" and assign values to all incoming variables:
startRange: INT
endRange: INT
allocated: ARRAY of INT
Additional Information
Please use your Itential Customer Success account if you need support when using this Pre-Built Transformation.