Escaux UCS Global Parameter Reference Guide

Global Parameters types and subtypes

Global Parameters are variables or constants which are used in the various callflows present in your Escaux UCS system. There are different types of global parameters, identified by the following subtypes:

  • Creation Type: identifies the way the global variable is created
    • Reserved : created by Escaux Developer. Name, type and description cannot be changed by the Escaux UCS administrator. The naming convention of 'Reserved' global parameters is listed below. For example, the Global Parameter 'ExternalCall' is set in the mapDDI action and is set by Escaux to indicate if an incoming call is internal or external.
    • Custom : created by the Escaux UCS administrator

  • Scope Type
    • Var: value is set per extension
    • Const: value is set system wide. Global parameters with 'Scope Type' set to 'Const' will affect ALL the calls on the Escaux UCS.

  • Control Type
    • User: value can be set by extension owner: Global parameters with 'Control Type' set to 'User' can be changed by the owner of the extension through the SMP web interface or the net.Desktop.
    • Admin: value can be set by administrator: Global parameters with 'Control Type' set to 'Admin' can be changed by the Escaux UCS administrator only, through the SMP web interface.
    • System: value is hard coded in the system: Global parameters with 'Control Type' set to 'System' are fixed and cannot be changed by the user or the administrator.

Because not all the subtype combination are relevant, only the following global parameter types are present in a Escaux UCS system:

TYPE Creation Type Scope Type Control Type Example
ResAdminConst Reserved Const Admin NationalRedialPrefix
DevConst Reserved Const System LastUserPrimaryPhone
UserVar Custom Var User Fallback extension
AdminVar Custom Var Admin Manager extension
AdminConst Custom Const Admin Big Boss extension

Global Parameter Manipulation

When a free field is available (for example in an action SetVar), you can combine existing Global Parameters to make new Global Parameters. Remark that, even if it should not harm to manipulate DevConst or AdminConst parameters, it is advised to manipulate only UserVar or AdminVar because it is advised to stay in the call scope.

String Length function

  • ${LEN(string_to_know_the_length)} : returns the length of the string 'string_to_know_the_length' (ie:25) . The string can obviously be a parameter. For example,

  • ${LEN(${LastUserPrimaryPhone}} : returns the length of the user primary device. This is an excellent way to check for a NULL or empty string.

Substrings

  • ${mystring:offset:length} : returns a substring of the string 'mystring', beginning at offset 'offset' and returning the next 'length' characters.
    • If 'offset' is negative, it is taken leftwards from the right hand end of the string.
    • If 'length' is omitted or is negative, then all the rest of the string beginning at offset is returned.

Examples:

   ${123456789:1}        - returns the string 23456789
   ${123456789:-4}       - returns the string 6789
   ${123456789:0:3}      - returns the string 123
   ${123456789:2:3}      - returns the string 345
   ${123456789:-4:3}     - returns the string 678

String Concatenation

To concatenate two strings, simply write them together:

  • Example
    • ${LastUserFirstName} ${LastUserLastName} returns the complete name
    • 555${theNumber} prefix ${theNumber} by 555

Variable math

To perform math on variables e.g. increment, multiplication, addition simply write:

  • $[${I} + 1]
  • $[2 * ${SOMEVAR}]

Reserved Global Parameter Reference Guide

The following list of Global Parameter can be useful to get informations from a callflow
Name Owner Type Description Type
ACCOUNTCODE DevConst Contains the accountcode. Please use ${CDR(accountcode)} as this will be deprecated in the future. Set by Asterisk. STRING
ANSWEREDTIME DevConst Contains the amount of time(in seconds) for the actual call Set by Asterisk. STRING
CalleridDefault ResUserVar INTEGER
CALLERIDNAME DevConst Contains the calling name. Please use now ${CALLERID(name)}. STRING
CALLERIDNUM DevConst Contains the calling number. Please use now ${CALLERID(num)}. EXTENSION
CHANNEL DevConst Contains the Asterisk Channel variable. Set by Asterisk. STRING
COMMA ResAdminConst STRING
DefaultStatus ResAdminConst PUM Set this status when logging in. Used in Personal User Mobility modification IVR callflow. STRING
DialAsteriskOption ResAdminConst Parameters passed to the Asterisk dial string when making calldevice. More details avalaible via Asterisk shell: CLI> show application Dial (version >=1.23) STRING
DOUBLEQUOTE ResUserVar STRING
EPOCH DevConst The current UNIX-style epoch (number of seconds since 1 Jan 1970) STRING
ExtDepartment DevConst This variable contains the Department retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtEmail DevConst This variable contains the Email retrieved by the last GetExtensionInfo (or similar) action. STRING
ExternalCall DevConst Positioned to 'yes' if the call is an external call. Set by MapDDI version > 1.20 Set also in STARDYNAMICAPPLICATION version>4.0 (set to 'yes' if the callerid length is > InternalNumberLength length or '0') STRING
ExtFaxNumber DevConst This variable contains the Fax Number retrieved by the last GetExtensionInfo (or similar) action. EXTENSION
ExtFirstName DevConst This variable contains the First Name retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtGroup DevConst This variable contains the Group retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtHomeNumber DevConst This variable contains the Home Number retrieved by the last GetExtensionInfo (or similar) action. EXTENSION
ExtLanguage DevConst This variable contains the Language retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtLastName DevConst This variable contains the Last Name retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtMobileNumber DevConst This variable contains the Mobile Number retrieved by the last GetExtensionInfo (or similar) action. EXTENSION
ExtOffice DevConst This variable contains the Office retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtPincode DevConst This variable contains the Pincode retrieved by the last GetExtensionInfo (or similar) action. STRING
ExtPrimaryPhone DevConst This variable contains the Primary Phone retrieved by the last GetExtensionInfo (or similar) action. DEVICE
ExtSecondaryPhone DevConst This variable contains the Secondary Phone retrieved by the last GetExtensionInfo (or similar) action. DEVICE
ExtSite DevConst This variable contains the Site retrieved by the last GetExtensionInfo (or similar) action. STRING
FollowMeIVR12 DevConst To activate the Follow Me, press1. To deactivate the Follow Me, press 2. Pour activer le Follow Me, appuyez sur 1. Pour désactiver le Follow Me, appuyez sur 2. Used in Follow Me callflow. PROMPT
FollowMeLoginError DevConst Follow Me activation failed. Please try again later. Echec de l'activation du Follow Me. Veuillez réessayer plus tard. Used in Follow Me callflow. PROMPT
FollowMeLoginOK DevConst Follow Me activated. Follow Me activé. Used in Follow Me callflow. PROMPT
FollowMeLogoutError DevConst Follow Me deactivation failed. Please, try again later. Echec de la déactivation du Follow Me. Veuillez réessayer plus tard. Used in the follow me IVR PROMPT
FollowMeLogoutOK DevConst Follow Me deactivated. Follow Me désactivé. Used in Follow Me callflow. PROMPT
IncomingToCalleridPrefix ResAdminConst INTEGER
InternalNumberLength ResAdminConst Internal number length, have influence on the ExternalCall choice EXTENSION
InternationalRedialPrefix ResAdminConst Contains the prefix needed to redial a national number. Used in MapDDI version > 1.10 EXTENSION
IntNumberLengthTrigger ResAdminConst This variable contains the number length trigger which defines that the number is an international number. Used in MapDDI version > 1.10 EXTENSION
LastCalledDDI DevConst Initial Called DDI . Set by MapDDI version > 1.20 EXTENSION
LastUserExt DevConst This variable contains the initial called user extension. EXTENSION
LastUserLogin DevConst This variable contains the admin user of the initial called extension (Set using STARTDYNAMICAPPLICATION 5.0+). n.a.
LastUserOwner DevConst This variable contains the owner user of the initial called extension (Set using STARTDYNAMICAPPLICATION 5.0+). n.a.
LastUserLang DevConst This variable contains the language of the initial called extension's owner. STRING
LastUserEmail DevConst This variable contains the initial called extension's email (not the owner's email). STRING
LastUserFaxNumber DevConst This variable contains the initial called user fax number. EXTENSION
LastUserFirstName DevConst This variable contains the initial called user first name. STRING
LastUserGroup DevConst This variable contains the initial called user group. INTEGER
LastUserHomeNumber DevConst This variable contains the initial called user home number. EXTENSION
LastUserLastName DevConst This variable contains the initial called user last name. STRING
LastUserMobileNumber DevConst This variable contains the initial called user mobile number. EXTENSION
LastUserPincode DevConst This variable contains the initial called user pincode. STRING
LastUserPrimaryPhone DevConst This variable contains the initial called user primary phone as indicated in the directory. DEVICE
LastUserSecondaryPhone DevConst This variable contains the initial called user secondary IP phone as indicated in the directory. DEVICE
LastUserSite DevConst This variable contains the initial called user site id. STRING
LastUserDepartment DevConst This variable contains the initial called user department as indicated in the directory. (only valid for SMP 1.4 or higher, set using STARTDYNAMICAPPLICATION 4.5+) STRING
LastUserOffice DevConst This variable contains the initial called user office as indicated in the directory. (only valid for SMP 1.4 or higher, set using STARTDYNAMICAPPLICATION 4.5+) STRING
MACRO_RECURSION ResAdminConst This variable is used to define the max recursion depth in a macro. It should be used to solve multi (>=3) blind transferts from the Console. INTEGER
NationalRedialPrefix ResAdminConst Contains the prefix needed to redial a national number. Used in MapDDI version > 1.10 EXTENSION
PIPE ResAdminConst STRING
PumExtensionPrompt DevConst Enter your extension followed by the pound key. Entrez votre extension suivit de 'carré'. Used in PUM modification IVR callflow. PROMPT
PumLoginError DevConst Login Failed. Please try again later. Echec du login. Veuillez réessayer plus tard. Used in PUM modification IVR callflow. PROMPT
PumLoginOk DevConst Login confirmed Login confirmé. Used in PUM modification IVR callflow. PROMPT
PumLogoutError DevConst Logout Failed. Please try again later. Echec du logout. Veuillez réessayer plus tard. Used in PUM modification IVR callflow. PROMPT
PumLogoutOk DevConst logout confirmed logout confirmé. Used in PUM IVR callflow. PROMPT
PumPincodeIncorrect DevConst Pincode Incorrect. Pincode Incorrecte. Used in PUM modification IVR callflow. PROMPT
PumPincodePrompt DevConst Enter your pincode followed by the pound key. Entrez votre pincode suivit de 'carré'. Used in PUM modification IVR callflow. PROMPT
Result DevConst Result code of last action STRING
SIPCALLID DevConst Contains the Asterisk SIP dialog Call-ID: header Set by Asterisk. STRING
SIPUSERAGENT DevConst Contains the calling SIP user agent. Set by Asterisk. STRING
StatusConfirmationIntro DevConst Status changed to: Status changé vers: Used in Status modification IVR callflow. PROMPT
StatusCurrent ResUserVar Used in Status modification IVR callflow. STRING
StatusCurrentProfile ResUserVar Used in Status modification IVR callflow. STRING
StatusCurrentStatus ResUserVar Used in Status modification IVR callflow. STRING
StatusCurrentStatusPrompt ResUserVar Used in Status modification IVR callflow. PROMPT
StatusFirstInstruction DevConst To change your status, press 2. Pour changer votre status, appuyez sur 2. Used in Status modification IVR callflow. PROMPT
StatusFirstIntro DevConst Current Status: Status actuel: Used in Status modification IVR callflow. PROMPT
StatusInstruction DevConst Press 1.For the next status, press 2. Appuyez sur 1. Pour le status suivant, appuyez sur 2. Used in Status modification IVR callflow. PROMPT
StatusIntro DevConst For status: Pour le status: PROMPT
StatusNextStatus ResUserVar Used in Status modification IVR callflow. STRING
StatusWelcome DevConst Used in Status modification IVR callflow. PROMPT
UNIQUEID DevConst Contains the call unique id. STRING

Copyright © Escaux SA