Set Variable

This node is used to update the contents of a Custom Service Variable, during the call flow. There are a range of mathematical, text and call information functions available.

Branch	Mandatory	Description
Success	Yes	Taken when the custom service variable has been successfully updated.
Failed	Yes	Taken when it hasn't been able to update the custom service variable.

Node Properties

The results can either be stored in the variable that contained the original data (Input Variable) or stored in a separate variable (Output Variable). The variable(s) have to be defined using the Custom Variable Manager before the properties of this node can be set.

Specifying an Output Variable is optional. If the Output Variable has been specified the results of the function are placed in that variable, if it is not specified the results of the function are placed in the Input Variable.

There are three types of functions which are all chosen from the drop down list in the Function field:

• Set – This function overwrites a variable with the contents of the Value field. This can be a literal value, a Call Variable or another variable that contains the required data. To choose a Call Variable select the Call Variable tick box and then choose from the drop down list in the Value field. See below for more information on Call Variables.

• Add, Subtract, Multiply, Divide, Modulus – The variable contents are updated with the results of performing the specified mathematical function to the Input Variable using the value contained in the Value field. When using any of the mathematical functions you are permitted to use positive and negative numbers. When using the Divide function if there are any decimal places it will be rounded to the nearest whole number. The Input Variable and Value field must contain Integers.

The [Success] branch will be taken if the custom service variable was successfully updated, the [Failed] branch will be taken when it was not possible to update the value

e.g. if you tried to perform one of the basic mathematical functions with a non numeric character or a number with decimal places in either the Variable or Value properties.

Call Variable Options

• Call ID The unique identifier for the Inbound call e.g. 950302111

• Calling Number This is the Network CLI of the originating caller, not the Presentation CLI (CLIP).

• Called Number This is the Service Number called by the originating caller e.g. 01132003000

• Call Start Time The date and time when the Inbound call hit the platform in UTC. If the TimeZone option is set in the Start node the date and time will be adjusted accordingly.
• Calling Number Withheld This is the CLIR ("CLI Restricted") flag of the originating caller. 0 = Not Withheld/Restricted, 1 = Withheld/Restricted.

• Minutes This Hour Minutes from completed calls to this Service Number this hour, not the previous 60 minutes. See below for more information.

• Minutes Today Minutes from completed calls to this Service Number since 00:00 today. See below for more information.

• Minutes This Month Minutes from completed calls to this Service Number since 00:00 on the 1st of this month. See below for more information

• Calls This Hour Total completed calls to this Service Number this hour, not the previous 60 minutes. See below for more information.

• Calls Today Total completed calls to this Service Number since 00:00 today. See below for more information.

• Calls This Month Total completed calls to this Service Number since 00:00 on the 1st of this month. See below for more information.

• Calls In Progress (Service Number) Total active calls in progress to this Service Number - including this call. This could be used to build comfort messages in to the caller e.g. "we are experiencing a high number of calls", or protect your destinations if you only have limited channels.

• Calls In Progress (Service Plan) Total active calls in progress to this Service Plan which could be linked to many Service Numbers - including this call. This could be used to build comfort messages in to the caller e.g. "we are experiencing a high number of calls", or protect your destinations if you only have limited channels.

• Service ID The unique identifier for the Service Plan currently being used for this call.

• Current Date Time The date and time now when this Set Variable node was evaluated in UTC. If the TimeZone option is set in the Start node the date and time will be adjusted accordingly.

Minutes This Hour, Today or This Month

The cumulative minute total for a service number is only updated at the end of each call. There are no interim updates on the cumulative minutes, whilst a call is in progress.

Therefore the cumulative minutes figure is only correct if there are no calls in progress. This information to rounded up and down to the nearest minute.

These are statistical minutes not billable data. They require the statistic feeds to be online - occasionally these are disabled for planned works and upgrades which would not update any figures for calls during that period.

Calls This Hour, Today or This Month

The cumulative total calls for a service number is only updated at the end of each call. There are no interim updates on the cumulative calls, whilst a call is in progress. Therefore the cumulative total calls figure is only correct if there are no calls in progress.

These is statistical data not billable call data. They require the statistic feeds to be online - occasionally these are disabled for planned works and upgrades which would not update any figures for calls during that period.

Text Manipulation Functions

Concatenate

This option will add the contents of the value field to the end of the contents of the Input Variable

Trim

This option will remove any space characters that are at the beginning and end of the contents of the Input Variable

Left Trim

This option will remove any space characters that are at the beginning (left hand side) of the contents of the Input Variable

Right Trim

This option will remove any space characters that are at the end (right band side) of the contents of the Input Variable

Left

This function will select characters from the contents of the Input Variable starting at the beginning (left hand side).

The number of characters chosen is specified in the Length field. If the number of characters specified in the Length field is longer than the contents of the Input Variable the entire contents of the Input Variable are selected.

Right

This function will select characters from the contents of the Input Variable starting at the end (right hand side).

The number of characters chosen is specified in the Length field. If the number of characters specified in the Length field is longer than the contents of the Input Variable the entire contents of the Input Variable are selected.

Extract

This function will select characters from the contents of the Input Variable starting in the middle. The starting position for the selection is specified in the Start field.

The number of characters chosen is specified in the Length field. If the number of characters specified in the Length field is longer than the available contents of the Input Variable the contents of the Input Variable from the specified start position to the end are selected.

Remove

This function will remove characters from the contents of the Input Variable.

The characters to be removed are specified in the Value field. If more than one character is specified these will only be removed from the variable when they are next to each other.

If the specified characters are not found the original contents of the Input Variable are returned as the result. If the specified characters occur multiple times in the Input Variable all instances are removed.