Actions
Actions are non-blocking handlers for various events.
1 - addItem
Appends value to an array stored in another variable.
Appends value to an array stored in another variable.
| Property | Type | Description |
|---|
| fromVar | String | Fetch value from session variable. |
| toVar | String | Destination variable with the array. |
| value | String | Verbatim value. |
2 - addToInt
Add value to integer variable in the session.
Add value to integer variable in the session.
| Inline definition |
|---|
Accepting one of: var++, var–, var += value, |
var -= value. |
| Property | Type | Description |
|---|
| orElseSetTo | int | If the variable is currently not set, set it to this value instead of addition. |
| value | int | Value added (can be negative). |
| var | String | Variable name. |
3 - addToSharedCounter
Adds value to a counter shared by all sessions in the same executor.
Adds value to a counter shared by all sessions in the same executor.
| Inline definition |
|---|
Use on of: counter++, counter–, counter += <value>, |
counter -= <value> |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| key | String | Identifier for the counter. |
| operator | enum | Operation to perform on the counter. Default is ADD.
Options: |
| value | int | Value (integer). |
4 - clearHttpCache
Drops all entries from HTTP cache in the session.
Drops all entries from HTTP cache in the session.
5 - conditional
Perform an action or sequence of actions conditionally.
Perform an action or sequence of actions conditionally.
| Property | Type | Description |
|---|
| actions | Action.Builder | Actions that should be executed should the condition hold. |
| allConditions | Builder | Condition combining multiple other conditions with ‘AND’ logic. |
| boolCondition | Builder | Condition comparing boolean variables. |
| intCondition | Builder | Condition comparing integer variables. |
| stringCondition | Builder | Condition comparing string variables. |
allConditions
Test more conditions and combine the results using AND logic.
allConditions.<list of mappings>
Selector for condition type.
| Property | Type | Description |
|---|
| allConditions | Builder | Condition combining multiple other conditions with ‘AND’ logic. |
| boolCondition | Builder | Condition comparing boolean variables. |
| intCondition | Builder | Condition comparing integer variables. |
| stringCondition | Builder | Condition comparing string variables. |
allConditions.<list of mappings>.allConditions
Test more conditions and combine the results using AND logic.
allConditions.<list of mappings>.boolCondition
Tests session variable containing boolean value.
| Property | Type | Description |
|---|
| fromVar | String | Variable name. |
| value | boolean | Expected value. |
allConditions.<list of mappings>.intCondition
Condition comparing integer in session variable.
| Inline definition |
|---|
| Parses condition in the form <variable> <operator> <value> |
where operator is one of: ==, !=, |
<> (the same as !=), |
>=, >, <=, <. |
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| fromVar | Object | Variable name. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
allConditions.<list of mappings>.stringCondition
Condition comparing string in session variable.
| Property | Type | Description |
|---|
| caseSensitive | boolean | True if the case must match, false if the check is case-insensitive. |
| endsWith | CharSequence | Suffix for the string. |
| equalTo | CharSequence | Literal value the string should match (the same as {@link #value}). |
| fromVar | Object | Variable name. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| length | int | Check the length of the string. |
| length (alternative) | Builder | Check the length of the string. |
| matchVar | String | Fetch the value from a variable. |
| negate | boolean | Invert the logic of this condition. Defaults to false. |
| notEqualTo | CharSequence | Value that the string must not match. |
| startsWith | CharSequence | Prefix for the string. |
| value | CharSequence | Literal value the string should match. |
boolCondition
Tests session variable containing boolean value.
| Property | Type | Description |
|---|
| fromVar | String | Variable name. |
| value | boolean | Expected value. |
intCondition
Condition comparing integer in session variable.
| Inline definition |
|---|
| Parses condition in the form <variable> <operator> <value> |
where operator is one of: ==, !=, |
<> (the same as !=), |
>=, >, <=, <. |
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| fromVar | Object | Variable name. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
intCondition.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition
Condition comparing string in session variable.
| Property | Type | Description |
|---|
| caseSensitive | boolean | True if the case must match, false if the check is case-insensitive. |
| endsWith | CharSequence | Suffix for the string. |
| equalTo | CharSequence | Literal value the string should match (the same as {@link #value}). |
| fromVar | Object | Variable name. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| length | int | Check the length of the string. |
| length (alternative) | Builder | Check the length of the string. |
| matchVar | String | Fetch the value from a variable. |
| negate | boolean | Invert the logic of this condition. Defaults to false. |
| notEqualTo | CharSequence | Value that the string must not match. |
| startsWith | CharSequence | Prefix for the string. |
| value | CharSequence | Literal value the string should match. |
stringCondition.length
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
stringCondition.length.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
6 - fail
Fail the phase with given message. Used mostly for testing/debugging.
Fail the phase with given message. Used mostly for testing/debugging.
| Inline definition |
|---|
| Message to fail with (unconditionally). |
| Property | Type | Description |
|---|
| allConditions | Builder | Condition combining multiple other conditions with ‘AND’ logic. |
| boolCondition | Builder | Condition comparing boolean variables. |
| intCondition | Builder | Condition comparing integer variables. |
| message | String | Message attached to the failure exception. |
| stringCondition | Builder | Condition comparing string variables. |
allConditions
Test more conditions and combine the results using AND logic.
allConditions.<list of mappings>
Selector for condition type.
| Property | Type | Description |
|---|
| allConditions | Builder | Condition combining multiple other conditions with ‘AND’ logic. |
| boolCondition | Builder | Condition comparing boolean variables. |
| intCondition | Builder | Condition comparing integer variables. |
| stringCondition | Builder | Condition comparing string variables. |
allConditions.<list of mappings>.allConditions
Test more conditions and combine the results using AND logic.
allConditions.<list of mappings>.boolCondition
Tests session variable containing boolean value.
| Property | Type | Description |
|---|
| fromVar | String | Variable name. |
| value | boolean | Expected value. |
allConditions.<list of mappings>.intCondition
Condition comparing integer in session variable.
| Inline definition |
|---|
| Parses condition in the form <variable> <operator> <value> |
where operator is one of: ==, !=, |
<> (the same as !=), |
>=, >, <=, <. |
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| fromVar | Object | Variable name. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
allConditions.<list of mappings>.stringCondition
Condition comparing string in session variable.
| Property | Type | Description |
|---|
| caseSensitive | boolean | True if the case must match, false if the check is case-insensitive. |
| endsWith | CharSequence | Suffix for the string. |
| equalTo | CharSequence | Literal value the string should match (the same as {@link #value}). |
| fromVar | Object | Variable name. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| length | int | Check the length of the string. |
| length (alternative) | Builder | Check the length of the string. |
| matchVar | String | Fetch the value from a variable. |
| negate | boolean | Invert the logic of this condition. Defaults to false. |
| notEqualTo | CharSequence | Value that the string must not match. |
| startsWith | CharSequence | Prefix for the string. |
| value | CharSequence | Literal value the string should match. |
boolCondition
Tests session variable containing boolean value.
| Property | Type | Description |
|---|
| fromVar | String | Variable name. |
| value | boolean | Expected value. |
intCondition
Condition comparing integer in session variable.
| Inline definition |
|---|
| Parses condition in the form <variable> <operator> <value> |
where operator is one of: ==, !=, |
<> (the same as !=), |
>=, >, <=, <. |
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| fromVar | Object | Variable name. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
intCondition.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition
Condition comparing string in session variable.
| Property | Type | Description |
|---|
| caseSensitive | boolean | True if the case must match, false if the check is case-insensitive. |
| endsWith | CharSequence | Suffix for the string. |
| equalTo | CharSequence | Literal value the string should match (the same as {@link #value}). |
| fromVar | Object | Variable name. |
| isSet | boolean | Check if the value is set or unset. By default the variable must be set. |
| length | int | Check the length of the string. |
| length (alternative) | Builder | Check the length of the string. |
| matchVar | String | Fetch the value from a variable. |
| negate | boolean | Invert the logic of this condition. Defaults to false. |
| notEqualTo | CharSequence | Value that the string must not match. |
| startsWith | CharSequence | Prefix for the string. |
| value | CharSequence | Literal value the string should match. |
stringCondition.length
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
stringCondition.length.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringCondition.length.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
7 - getIndex
Lookup index of an item in an array/collection.
Lookup index of an item in an array/collection.
| Property | Type | Description |
|---|
| collection | String | Variable to fetch the collection from. |
| item | Builder | Item that should be looked up (using equality). |
| toVar | String | Integer variable to store the index, or -1 if the item is not found. |
item
| Inline definition |
|---|
| Verbatim value. |
| Property | Type | Description |
|---|
| fromVar | String | Fetch value from session variable. |
| value | String | Verbatim value. |
8 - getItem
Retrieves n-th item from an array or collection.
Retrieves n-th item from an array or collection.
| Property | Type | Description |
|---|
| fromVar | String | Source variable with an array or list. |
| index | Builder | Source for index into the array/list. |
| toVar | String | Destination variable for the n-th element. |
index
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
9 - getSharedCounter
Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.
Retrieves value from a counter shared by all sessions in the same executor and stores that in a session variable.
If the value exceeds allowed integer range (-2^31 .. 2^31 - 1) it is capped.
| Inline definition |
|---|
| Both the key and variable name. |
| Property | Type | Description |
|---|
| key | String | Identifier for the counter. |
| toVar | String | Session variable for storing the value. |
10 - getSize
Calculates size of an array/collection held in variable into another variable
Calculates size of an array/collection held in variable into another variable
| Property | Type | Description |
|---|
| boolFilter | Builder | Count only items matching the condition. |
| fromVar | String | Variable holding the collection. |
| intFilter | Builder | Count only items matching the condition. |
| stringFilter | Builder | Count only items matching the condition. |
| toVar | String | Variable storing the size. |
| undefinedValue | int | Value to use when fromVar is unset or it does not contain any array/collection. |
boolFilter
| Property | Type | Description |
|---|
| value | boolean | Expected value. |
intFilter
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
intFilter.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intFilter.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intFilter.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intFilter.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intFilter.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intFilter.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringFilter
| Property | Type | Description |
|---|
| caseSensitive | boolean | True if the case must match, false if the check is case-insensitive. |
| endsWith | CharSequence | Suffix for the string. |
| equalTo | CharSequence | Literal value the string should match (the same as {@link #value}). |
| length | int | Check the length of the string. |
| length (alternative) | Builder | Check the length of the string. |
| matchVar | String | Fetch the value from a variable. |
| negate | boolean | Invert the logic of this condition. Defaults to false. |
| notEqualTo | CharSequence | Value that the string must not match. |
| startsWith | CharSequence | Prefix for the string. |
| value | CharSequence | Literal value the string should match. |
stringFilter.length
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
stringFilter.length.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringFilter.length.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringFilter.length.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringFilter.length.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringFilter.length.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
stringFilter.length.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
11 - log
Log a message and variable values.
Log a message and variable values.
| Inline definition |
|---|
| A pattern for |
| string |
| interpolation. |
12 - markRequestInvalid
Unconditionally mark currently processed request as invalid.
Unconditionally mark currently processed request as invalid.
13 - newSequence
Instantiates a sequence for each invocation.
Instantiates a sequence for each invocation.
| Inline definition |
|---|
| Sequence name. |
| Property | Type | Description |
|---|
| concurrencyPolicy | enum |
Options: |
| forceSameIndex | boolean | Forces that the sequence will have the same index as the currently executing sequence. This can be useful if the sequence is passing some data to the new sequence using sequence-scoped variables. Note that the new sequence must have same concurrency factor as the currently executing sequence. |
| sequence | String | Name of the instantiated sequence. |
14 - publishAgentData
Makes the data available to all sessions in the same agent, including those using different executors.
Makes the data available to all sessions in the same agent, including those using different executors.
| Inline definition |
|---|
| Both name of source variable and the key used to read the data. |
| Property | Type | Description |
|---|
| fromVar | String | Source session variable name. |
| name | String | Arbitrary unique identifier for the data. |
15 - publishGlobalCounters
Gathers values from session variables and publishes them globally (to all agents).
Gathers values from session variables and publishes them globally (to all agents).
You can name the counters individually (example 1) or use the variable names (example 2):
<code>
# Example 1:
- publishGlobalCounters:
key: myKey
vars: [ foo, bar ]
# Example 2:
- publishGlobalCounters:
key: someOtherKey
vars:
- foo: myFoo
- bar: bbb
</code>
| Property | Type | Description |
|---|
| key | String | Identifier of the global record. |
| vars | Builder | List of names and session variables. |
vars
| Property | Type | Description |
|---|
| <any> | <unknown> | <no description> |
| <list of strings> | <unknown> | <no description> |
16 - readAgentData
Reads data from agent-wide scope into session variable.
Reads data from agent-wide scope into session variable.
The data must be published in a phase that has terminated before this phase starts: usually this is achieved using the startAfterStrict property on the phase.
| Inline definition |
|---|
| Both the identifier and destination session variable. |
| Property | Type | Description |
|---|
| name | String | Unique identifier for the data. |
| toVar | String | Destination session variable name. |
17 - removeItem
Removes element from an array of variables.
Removes element from an array of variables.
| Property | Type | Description |
|---|
| fromVar | String | Variable containing an existing array of object variables. |
| index | Builder | Set index at which the item should be removed. Elements to the right of this are moved to the left. |
index
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
18 - restartSequence
Schedules a restart of this sequence.
Schedules a restart of this sequence.
19 - set
Set variable in session to certain value.
Set variable in session to certain value.
| Inline definition |
|---|
Use var <- value. |
| Property | Type | Description |
|---|
| intArray | Builder | Set variable to an (unset) integer array. |
| objectArray | Builder | Set variable to an (unset) object array. |
| value | String | String value. |
| var | String | Variable name. |
intArray
Creates integer arrays to be stored in the session.
| Property | Type | Description |
|---|
| fromVar | String | Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value. |
| size | int | Size of the array. |
objectArray
Creates object arrays to be stored in the session.
| Property | Type | Description |
|---|
| fromVar | String | Contents of the new array. If the variable contains an array or a list, items will be copied to the elements with the same index up to the size of this array. If the variable contains a different value all elements will be initialized to this value. |
| size | int | Size of the array. |
20 - setInt
Set session variable to an integral value.
Set session variable to an integral value.
| Inline definition |
|---|
Use var <- value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| intCondition | Builder | Set variable only if the current value satisfies certain condition. |
| max | Builder | Set to value that is the maximum of this list of values. |
| min | Builder | Set to value that is the minimum of this list of values. |
| onlyIfNotSet | boolean | Set variable to the value only if it is not already set. |
| value | int | Value (integer). |
| var | String | Variable name. |
intCondition
| Property | Type | Description |
|---|
| equalTo | Builder | Compared variable must be equal to this value. |
| greaterOrEqualTo | Builder | Compared variable must be greater or equal to this value. |
| greaterThan | Builder | Compared variable must be greater than this value. |
| lessOrEqualTo | Builder | Compared variable must be lower or equal to this value. |
| lessThan | Builder | Compared variable must be lower than this value. |
| notEqualTo | Builder | Compared variable must not be equal to this value. |
intCondition.equalTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.greaterOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.greaterThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.lessOrEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.lessThan
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
intCondition.notEqualTo
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
max
max.<list of mappings>
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
min
21 - setItem
Set element in a collection on given position.
Set element in a collection on given position.
| Property | Type | Description |
|---|
| fromVar | String | Fetch value from session variable. |
| index | Builder | Integer session variable with an index into the collection. |
| toVar | String | Session variable with the collection. |
| value | String | Verbatim value. |
index
| Inline definition |
|---|
| Uses the argument as a constant value. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| value | int | Value (integer). |
22 - setSharedCounter
Sets value in a counter shared by all sessions in the same executor.
Sets value in a counter shared by all sessions in the same executor.
| Inline definition |
|---|
| Both the name of the counter and variable name. |
| Property | Type | Description |
|---|
| fromVar | String | Input variable name. |
| key | String | Identifier for the counter. |
| value | int | Value (integer). |
23 - stringToInt
Parse string into integer and store it in a variable.
Parse string into integer and store it in a variable.
If the parsing fails the target variable is not modified.
| Inline definition |
|---|
Use fromVar -> toVar |
| Property | Type | Description |
|---|
| fromVar | String | Source variable name. |
| toVar | String | Target variable name. |
24 - unset
Undefine variable name.
Undefine variable name.
| Inline definition |
|---|
| Variable name. |
| Property | Type | Description |
|---|
| var | Object | Variable name. |