Predefined Functions in the Multiple Call Destination System

Definition

The multiple call destination system offers several predefined functions that you can use like a destination system call. In contrast to a destination system call, you do not need to configure a destination system for a function call.

Procedure

Navigate to the Destination System Calls tab in a multiple call destination system.
Create a step in the Sequence of Destination System Calls area.
In the Destination System field, select a function from the list.

Note

Functions are at the end of the destination system list and begin with the at sign (@).
Then assign variables of the multiple call destination system to the input and output variables of the selected function.

List of Predefined Functions

@ArrayGetValue

This function reads the value of an array element.

Input Variables
Input Variable	Description
inArray (System.String)	Array
inIndex (System.Int32)	Index of the element to be read

Output Variable
Output Variable	Description
outValue (System.String)	Value of the array element

@ArraySetValue

This function sets the value of an array element.

Input Variables
Input Variable	Description
inArray (System.String)	Array that is to be changed
inIndex (System.Int32)	Index of the element to be written
inValue (System.String)	Value of the array element

Output Variable
Output Variable	Description
outArray (System.String)	The changed array

@Calculation

You can use this function to perform a calculation explicitly in one step and assign the result to a variable of the multiple call destination system.

Input Variable
Input Variable	Description
inExpression	A calculation expression that you formulate using the expression editor. In the calculation expression, you can use variables of the multiple call destination system and functions of the expression editor.

Output Variable
Output Variable	Description
outResult	Result of the calculation Assign the result to a variable of the multiple call destination system.

@Increment

This function increases the value of a numerical multiple call destination system variable by one.

Input Variable
Input Variable	Description
inVar (System.Int64)	Variable that contains the value before the increase

Output Variable
Output Variable	Description
outVar (System.Int64)	Variable that contains the value after the increase

@RaiseException

This function raises an exception. An exception can be used in another multiple call destination system to trigger exception handling. Or it can be used in a tag-based notification to cancel delivery of a notification message and to initiate a repeat delivery for the notification message.

Input Variable
Input Variable	Description
inExceptionMessage (System.String)	Text of the exception Note that the exception text always has the prefix `Configured exception raised:`.

@SetValue

This function sets the value of a multiple call destination system variable.

Input Variable
Input Variable	Description
inValue (System.String)	Variable that contains the value that is assigned to the variable outAssignedVariable.

Output Variable
Output Variable	Description
outAssignedVariable (System.String)	Variable whose value is to be changed

@Wait

Waits for a specific amount of time.

Note: The wait function blocks an execution thread for the specified time so it is not possible to stop an agent instance during this time. You can recognize that this is the case because it might take longer than usual to shut down an agent instance.

Input Variable
Input Variable	Description
inMilliseconds (System.Int32)	Wait time in milliseconds