Custom Service Variables

Custom Service Variables can be defined and used within a Service call flow. The variables are available to the whole Service XML including any sub plans.

These values can persist for the duration of the call or can be defined as global to persist the values for all calls to the service. If a Custom Service Variable has not been assigned a value prior to its use within the service flow or its assignment within the service flow is not valid, the DefaultValue attribute value will be used.

The CustomServiceVariables section must be placed inside the Service node under the Version element.

The name attribute must be unique within the list of variables, and it must begin with the “@” character. The name attribute can be up to a maximum of 100 characters.

The DefaultValue attribute value is mandatory. The value specified will be used to validate against the property values where the variable has been used.

Example

<CustomServiceVariables>
  <Variable Name="@Destination" DefaultValue="020123456789" Description="" Scope="Global" />
  <Variable Name="@Enabled" DefaultValue="true" Description="" Scope="Call" />
  <Variable Name="@BranchNodeID" DefaultValue="20" Description="" Scope="Call" />
</CustomServiceVariables>

Custom Service Variables can be used for the:

Mandatory Property value attributes

<MandatoryProperties>
    <Property Name="DestinationNumber" Value="@Destination"/>
    <Property Name="RingDuration" Value="30"/>
</MandatoryProperties>

Optional Settings Property value attributes.

 <Option Name="RestrictCLI">
   <Properties>
     <Property Name="Enabled" Value="@Enabled"/>
   </Properties>
 </Option>

Branch NodeID attribute values.

<Branches>
  <Branch Name="Continue" NodeID="@BranchNodeID"/>
</Branches>

Within the text of the Body and Subject in a node custom email settings.

<Property Name="Subject" Value="Call was made to @Destination"/>
<Property Name="Body" Value="Hi @Name, this is the email body"/>

Custom Service Variables can be assigned a value within a call flow by using:-

· The DTMF Capture node to assign a value captured by a caller via the telephone keypad.

· The response data returned from a Send Post node.

· The Set Variable node.