CAS R2 scripting

Revision as of 16:39, 21 June 2010 (view source) Atremblay (Talk | contribs) m (→Mandatory elements) ← Older edit		Revision as of 16:46, 21 June 2010 (view source) Atremblay (Talk | contribs) (Added Group B meanings) Newer edit →
Line 56:		Line 56:
	=== Stack variables ===		=== Stack variables ===
	=== Group B meanings ===		=== Group B meanings ===
		+	Here is the list of all defined group B meanings:
		+	ACCEPT_CHARGE
		+	ACCEPT_NO_CHARGE
		+	REJECT_UNSPECIFIED
		+	REJECT_UNALLOCATED_NUMBER
		+	REJECT_NO_ROUTE_TO_NETWORK
		+	REJECT_NO_ROUTE_TO_DESTINATION
		+	REJECT_USER_BUSY
		+	REJECT_SUBSCRIBER_ABSENT
		+	REJECT_CALL_REJECTED
		+	REJECT_NUMBER_CHANGED
		+	REJECT_EXCHANGE_ROUTING_ERROR
		+	REJECT_DESTINATION_OUT_OF_ORDER
		+	REJECT_ADDRESS_INCOMPLETE
		+	REJECT_NO_CIRCUIT_AVAILABLE
		+	REJECT_NETWORK_OUT_OF_ORDER
		+	REJECT_TEMPORARY_FAILURE
		+	REJECT_SWITCHING_EQUIP_CONGESTION
		+	REJECT_REQUESTED_CIRCUIT_NOT_AVAILABLE
		+	REJECT_RESOURCE_UNAVAILABLE
		+	REJECT_SERVICE_NOT_AVAILABLE
		+	REJECT_CALL_IDENTITY_DOES_NOT_EXIST
		+	REJECT_CALL_IDENTITY_IN_USE
		+	REJECT_PROTOCOL_ERROR
		+	REJECT_INTERWORKING_UNSPECIFIED
		+
	=== Category meanings ===		=== Category meanings ===

---

Revision as of 16:46, 21 June 2010

This page contains information about Toolpack CAS R2 variant scripting.

Refer to the default script (itu.lua) in the Toolpack Web Portal for a complete working variant script example.

Contents 1 Mandatory elements 1.1 VARIANT_ID 1.2 Group B conversion information 1.2.1 GROUPB_DIGIT_TO_MEANING 1.2.2 GROUPB_MEANING_TO_DIGIT 1.2.3 GROUPB_DEFAULT_DIGIT 1.2.4 GROUPB_OTHER_DIGITS 1.3 Category conversion information 1.3.1 CATEGORY_DIGIT_TO_MEANING 1.3.2 CATEGORY_MEANING_TO_DIGIT 1.3.3 CATEGORY_OTHER_DIGITS 1.3.4 CATEGORY_DEFAULT_DIGIT 1.4 Backward event handlers 1.4.1 Bwd_HandleNewCall 1.4.2 Bwd_HandleFwdSignal 1.5 Forward event handlers 1.5.1 Fwd_HandleNewCall 1.5.2 Fwd_HandleBwdSignal 2 Optional elements 2.1 SCRIPT_FILE_NAME 2.2 VARIABLES 3 Reference 3.1 Stack variables 3.2 Group B meanings 3.3 Category meanings

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.

VARIANT_ID

The VARIANT_ID variable must be filled to distinguish variants from another. More precisely, it is used when transporting group B and category information with calls in order to possibly 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.

Group B conversion information

Group B conversion information in scripts is used to convert group B information between CAS R2 variants and between other signaling types. The following elements must be filled so that these conversions can be completed successfully.

GROUPB_DIGIT_TO_MEANING

Each GROUPB_DIGIT_TO_MEANING table element must contain two values: a digit and a meaning. The digit must be a valid digit value (1 to 15) and the meaning must be a valid meaning (see Group B meanings). Each digit must be present in the table.

This table is used to convert group B digits to meaning in the context of an outgoing call. For a given digit, the specified meaning will be propagated to Toolpack.

GROUPB_MEANING_TO_DIGIT

Each GROUPB_MEANING_TO_DIGIT table element must contain two values: a meaning and a digit. All 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 table.

If a meaning is not found in this table, the meaning corresponding to GROUPB_DEFAULT_DIGIT will be used.

GROUPB_DEFAULT_DIGIT

This variable must be filled with a valid digit value. It will be used when lookups in the GROUPB_MEANING_TO_DIGIT table fail.

GROUPB_OTHER_DIGITS

Each GROUPB_OTHER_DIGITS table element must contain three values: a variant ID and two valid digit values. This table may be empty but cannot be omitted.

This table is used to convert a variant ID and a digit combination to a digit for the current variant in an outgoing call scenario.

Category conversion information

CATEGORY_DIGIT_TO_MEANING

CATEGORY_MEANING_TO_DIGIT

CATEGORY_OTHER_DIGITS

CATEGORY_DEFAULT_DIGIT

Backward event handlers

Bwd_HandleNewCall

Bwd_HandleFwdSignal

Forward event handlers

Fwd_HandleNewCall

Fwd_HandleBwdSignal

Optional elements

SCRIPT_FILE_NAME

VARIABLES

Reference

Stack variables

Group B meanings

Here is the list of all defined group B meanings:

ACCEPT_CHARGE
ACCEPT_NO_CHARGE
REJECT_UNSPECIFIED
REJECT_UNALLOCATED_NUMBER
REJECT_NO_ROUTE_TO_NETWORK
REJECT_NO_ROUTE_TO_DESTINATION
REJECT_USER_BUSY
REJECT_SUBSCRIBER_ABSENT
REJECT_CALL_REJECTED
REJECT_NUMBER_CHANGED
REJECT_EXCHANGE_ROUTING_ERROR
REJECT_DESTINATION_OUT_OF_ORDER
REJECT_ADDRESS_INCOMPLETE
REJECT_NO_CIRCUIT_AVAILABLE
REJECT_NETWORK_OUT_OF_ORDER
REJECT_TEMPORARY_FAILURE
REJECT_SWITCHING_EQUIP_CONGESTION
REJECT_REQUESTED_CIRCUIT_NOT_AVAILABLE
REJECT_RESOURCE_UNAVAILABLE
REJECT_SERVICE_NOT_AVAILABLE
REJECT_CALL_IDENTITY_DOES_NOT_EXIST
REJECT_CALL_IDENTITY_IN_USE
REJECT_PROTOCOL_ERROR
REJECT_INTERWORKING_UNSPECIFIED

Category meanings