shiftFromArray
- 23 May 2023
-
DarkLight
-
PDF
shiftFromArray
- Updated on 23 May 2023
-
DarkLight
-
PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
shiftFromArray Task Purpose
The shift
task removes the first item from a non-empty job array variable and returns the removed item with a success finish state. It returns a failure finish state if the the job array variable has no elements.
Properties
Incoming | Description |
---|---|
Select Job Variable (required) | Select the job variable that will be modified. |
Outgoing | Description |
---|---|
shifted_item |
The outgoing variable which contains the removed item. |
Example
Assume a job variable named fruits
with value ["apple","banana","orange"]
and you want to remove the first element.
- In the pop task's properties dialog box, select
fruits
from the Select Job Variables dropdown. - Click UPDATE.
The shift task changes job variable fruits
to have value ["banana","orange"]
, and it returns value apple
in its outgoing variable shifted item
.
Was this article helpful?