CAS R2 scripting - Revision history

Luc Morissette: Add link to Routing scripts calling category

2018-10-22T18:56:59Z

Add link to Routing scripts calling category

Allyntree: Needs revising edit

2018-03-08T18:28:11Z

Needs revising edit

Alexandre Tremblay at 20:09, 10 June 2013

2013-06-10T20:09:06Z

Luc Morissette: Added BWD_VP_GROUP = 0 description to scripts

2011-11-15T16:15:20Z

Added BWD_VP_GROUP = 0 description to scripts

Show changes

Atremblay: Added ABCD_PATTERN_MATCH_MASK

2011-11-14T15:56:30Z

Added ABCD_PATTERN_MATCH_MASK

Atremblay: Added metering variable.

2011-01-26T22:56:57Z

Added metering variable.

Atremblay: Added new variable.

2010-10-28T17:34:11Z

Added new variable.

Atremblay: /* References */ Added dots.

2010-08-16T19:39:59Z

References: Added dots.

Atremblay: /* Stack variables */ Updated answer timeouts.

2010-08-16T19:39:13Z

Stack variables: Updated answer timeouts.

Atremblay: /* Fwd_HandleBwdSignal */ +event

2010-07-06T22:23:42Z

Fwd_HandleBwdSignal: +event

@@ Line 384: / Line 384: @@
   CATEGORY_TEST
   CATEGORY_PAYPHONE
 = References =

@@ Line 6: / Line 6: @@
 = Overview =
-[[CAS|CAS R2]] signaling is done in two parts: line signaling and register signaling. In CAS R2 for [[E1]] trunks, [[Line signaling|line signaling]] uses a single [[timeslot]] to communicate call states (such as off-hook, answering) for the remaining timeslots. [[Register signaling]] is the exchange of MFR2 tones to convey information such as the calling number, called number and calling party category. TelcoBridges CAS R2 scripts allow complete customization of the register signaling process, while having some characteristics of the line signaling process customizable. Scripts also contain information relative to the conversion of register signaling data - group B signals and categories - into a format that the application can interpret. The scripting language is [[Lua]].
+[[CAS|CAS R2]] signaling is done in two parts: line signaling and register signaling. In CAS R2 for E1 trunks, Line signaling|line signaling uses a single [[timeslot]] to communicate call states (such as off-hook, answering) for the remaining timeslots. Register signaling is the exchange of MFR2 tones to convey information such as the calling number, called number and calling party category. TelcoBridges CAS R2 scripts allow complete customization of the register signaling process, while having some characteristics of the line signaling process customizable. Scripts also contain information relative to the conversion of register signaling data - group B signals and categories - into a format that the application can interpret. The scripting language is Lua.
 = Mandatory elements =
-In order for CAS R2 variant scripts to work, some variables, tables and events must be defined from within scripts. All of the following elements are required; if one of these elements is not present, it will not be possible to save the script in the Toolpack Web Portal or load it on the adapter.
+In order for CAS R2 variant scripts to work, some variables, tables and events must be defined from scripts. All of the following elements are required. If one of these elements is not present, it will not be possible to save the script in the Toolpack Web Portal or load it on the adapter.
 === VARIANT_ID ===
-The VARIANT_ID variable must be filled to distinguish variants from another. More precisely, it is used when transporting [[#Group B conversion information|group B]] and [[#Category conversion information|category]] information with calls in order to possibly convert information meaning across variants.
+The VARIANT_ID variable must be filled to distinguish variants from each other. More precisely, it is used when transporting [[#Group B conversion information|group B]] and [[#Category conversion information|category]] information with calls in order to convert information meaning across variants.
-Default CAS R2 TelcoBridges scripts have variant IDs starting from 1. To avoid future conflicts, user scripts variant IDs should be prefixed with a sufficiently high value. For example, a modified ITU variant could have a ID equal to 0x0001001. Scripts may only share the same variant ID as other scripts if and only if the category and group B meanings are exactly identical.
+Default CAS R2 TelcoBridges scripts have variant IDs starting from 1. To avoid future conflicts, user scripts variant IDs should be prefixed with a sufficiently high value. For example, a modified ITU variant could have a ID equal to 0x0001001. Scripts may only share the same variant ID as other scripts if the category and group B meanings are exactly identical.
 == Group B conversion information ==
@@ Line 27: / Line 27: @@
 Each GROUPB_MEANING_TO_DIGIT table element must contain two values: a meaning and a digit. Meanings must not appear more than once in the table.
-This table is used to convert meanings to digits for an incoming call. This is mostly used for calls where the other leg belongs to another signaling type, although it will be used if the other leg's signaling type is CAS R2 but the variant is different and there was no match in the [[#GROUPB_OTHER_DIGITS|GROUPB_OTHER_DIGITS]] table.
+This table is used to convert meanings to digits for an incoming call. This is mostly used for calls where the other call legs belong to another signaling type. It will be used if the other leg's signaling type is CAS R2 but the variant is different and there was no match in the [[#GROUPB_OTHER_DIGITS|GROUPB_OTHER_DIGITS]] table.
 If a meaning is not found in this table, the meaning corresponding to [[#GROUPB_DEFAULT_DIGIT|GROUPB_DEFAULT_DIGIT]] will be used.
@@ Line 129: / Line 129: @@
 | WAIT_SIGNAL || Waits for the next compelled sequence to be initiated. The second return value must be a valid digit as it is emitted as a response to the current compelled sequence.
 |-
-| END_SIGNALING || Ends the call immediately. The second return value can either be '''NO_DIGIT''' or a valid digit. If the digit is valid and has an acceptance meaning (see the [[#Group B conversion information|Group B conversion information section]]), the call will be accepted without explicit validation by the application. Otherwise, the call will be refused. In both cases, the digit will be emitted.
+| END_SIGNALING || Ends the call immediately. The second return value can be either '''NO_DIGIT''' or a valid digit. If the digit is valid and has an acceptance meaning (see the [[#Group B conversion information|Group B conversion information section]]), the call will be accepted without explicit validation by the application. Otherwise, the call will be refused. In both cases, the digit will be emitted.
 |-
 | VALIDATE_CALL || Sends the cumulated signaling information to the application. The application will then provide a group B meaning (or digit) that will be sent to the outgoing end.
@@ Line 149: / Line 149: @@
 ! align="left" | Description
 |-
-| WAIT_SIGNAL || Waits for the response to the compelled sequence to be received. The second return value can be '''NO_DIGIT''' if a pulsed signal is expected. Otherwise, it must be a valid digit that will be used to initiate the first compelled sequence.
+| WAIT_SIGNAL || Waits for the response to the compelled sequence to be received. The second return value can be '''NO_DIGIT''' if a pulsed signal is expected. Otherwise, it must be a valid digit that is used to initiate the first compelled sequence.
 |-
 | END_SIGNALING || Ends the call immediately. The second return value must be '''NO_DIGIT'''.
@@ Line 164: / Line 164: @@
 ! align="left" | Description
 |-
-| WAIT_SIGNAL || Waits for the response to the compelled sequence to be received. The second return value can be '''NO_DIGIT''' if a pulsed signal is expected. Otherwise, it must be a valid digit that will be used to initiate the first compelled sequence.
+| WAIT_SIGNAL || Waits for the response to the compelled sequence to be received. The second return value can be '''NO_DIGIT''' if a pulsed signal is expected. Otherwise, it must be a valid digit that is used to initiate the first compelled sequence.
 |-
 | END_SIGNALING || Ends the call immediately. The second value must be '''NO_DIGIT'''.
@@ Line 170: / Line 170: @@
 = Optional elements =
-The following elements may or may not be defined into a CAS R2 script.
+The following elements may, or may not be, defined in a CAS R2 script.
 === SCRIPT_FILE_NAME ===
-When affecting a value to this variable, the Toolpack Web Portal will automatically replace the value to the script name followed by the script revision. If the following piece of code is added appended at the end of the script (this is done for default scripts), it will print a trace when loading a CAS R2 stack which can be recovered using an application such as [[Toolpack Application:tblogtrace|tblogtrace]].
+When affecting a value to this variable, the Toolpack Web Portal will automatically replace the value to the script name followed by the script revision. If the following piece of code is appended at the end of the script (this is done for default scripts), it will print a trace when loading a CAS R2 stack which can be recovered using an application such as [[Toolpack Application:tblogtrace|tblogtrace]].
 === VARIABLES ===
@@ Line 191: / Line 191: @@
 == Stack variables  ==
-Here is the list of stack variables. These variables are declared before the VARIABLES table is parsed in a script. A single script affectation will modify the value one of these variables. It is also possible to edit these variables in the Toolpack Web Portal.
+These variables are declared before the VARIABLES table is parsed in a script. A single script will modify the value one of these variables. It is also possible to edit these variables in the Toolpack Web Portal.
 {| cellspacing="0" border="1" class="wikitable"
@@ Line 390: / Line 390: @@
 * [http://en.wikipedia.org/wiki/Line_signaling Line signaling Wikipedia article]
 * [http://en.wikipedia.org/wiki/Register_signaling Register signaling Wikipedia article]

@@ Line 222: / Line 222: @@
 | 300000
 | Maximum wait time for an ANSWER API message.
 |-
 | TIMER_BWD_TERMINATE
@@ Line 233: / Line 245: @@
 | TIMER_BWD_HOLD_ANSWER
 | 100
-| Maximum time for which the CAS bits should stay in the ANSWER state before chaning to CLEAR_BACKWARD.
+| Maximum time for which the CAS bits should stay in the ANSWER state before changing to CLEAR_BACKWARD.
 |-
 | TIMER_BWD_HOLD_CLEAR_BACKWARD
@@ Line 322: / Line 334: @@
 | 0
 | Flag indicating if the CAS R2 line signaling state machine should use the forced release method.
 |}

@@ Line 248: / Line 248: @@
 |-
 |ABCD_PATTERN_BWD_FORCED_RELEASE || 0x0001     || CAS R2 bit pattern for the backward FORCED RELEASE state.
 |-
 |USE_FORCED_RELEASE              || 0          || Flag indicating if the CAS R2 line signaling state machine should use the forced release method.

@@ Line 222: / Line 222: @@
 |-
 |TIMER_FWD_ANSWER_BIT            || 300000     || Maximum time for which the forward end should wait for a CAS bits ANSWER state.
 |-
 |TIMER_FWD_TERMINATE             || 3000       || Maximum wait time for an TERMINATE API message.

@@ Line 204: / Line 204: @@
 |-
 |TIMER_BWD_TERMINATE             || 3000       || Maximum wait time for an TERMINATE API message.
 |-
 |TIMER_BWD_HOLD_ANSWER           || 100        || Maximum time for which the CAS bits should stay in the ANSWER state before chaning to CLEAR_BACKWARD.

@@ Line 201: / Line 201: @@
 |TIMER_BWD_ALERT                 || 14000      || Maximum wait time for an ALERT API message.
 |-
-|TIMER_BWD_ANSWER                || 14000      || Maximum wait time for an ANSWER API message.
+|TIMER_BWD_ANSWER                || 300000     || Maximum wait time for an ANSWER API message.
 |-
 |TIMER_BWD_TERMINATE             || 3000       || Maximum wait time for an TERMINATE API message.
@@ Line 219: / Line 219: @@
 |TIMER_FWD_SEIZURE_ACK_BIT       || 200        || Maximum time for which the forward end should wait for a CAS bits SEIZURE_ACKNOWLEDGE state.
 |-
-|TIMER_FWD_ANSWER_BIT            || 14000      || Maximum time for which the forward end should wait for a CAS bits ANSWER state.
+|TIMER_FWD_ANSWER_BIT            || 300000     || Maximum time for which the forward end should wait for a CAS bits ANSWER state.
 |-
 |TIMER_FWD_TERMINATE             || 3000       || Maximum wait time for an TERMINATE API message.

@@ Line 155: / Line 155: @@
 ==== Fwd_HandleBwdSignal ====
-The Fwd_HandleBwdSignal is called whenever a tone signal has been received as a response to the current compelled sequence, which is most likely the beginning of a compelled sequence.
+The Fwd_HandleBwdSignal event is called whenever a tone signal has been received as a response to the current compelled sequence, which is most likely the beginning of a compelled sequence.
 The event will receive two parameters: the call context table (which was also passed to Fwd_HandleNewCall) and the received tone signal. The event must use the available DestinationNumber, OriginNumber and Category fields from the call context table to communicate information to the incoming end.