Navigation :

SVC Usage

Overview

The CUG SVC call library offers a way to control CUG calls with an appropriate underlying protocol-specific handler.

Refer to the CUG SVC installation or CUG configuration for further information of how to install and configure the CUG SVC call library.

Error Handling

At any point in the CUG SVC call handling, an error may occur. In such cases, the CUG SVC library will:

Raise an N2SVCD warning alarm with the error text.
Write a CUG_SCP EDR containing the error text.
Either release or continue the call, according to the global release-on-error handling flag.

CUG Lookup Context Values

After a CUG lookup has been performed, the service_context.cug table may contain the following items:

Attribute	Type	Description
`user_found`	Boolean	Always Present `true` if a CUG user was found, otherwise `false`.
`user_number`	String	Always Present The user number found in the CUG lookup. Note that this may be different to the user number initially provided for the CUG query.
`group_id`	Integer	The database ID of the CUG group for the CUG user.
`group_name`	String	The name of the CUG user’s CUG group.
`user_id`	Integer	The database ID of the CUG user.
`user_short_code`	String	The short code of the CUG user.
`user_long_number`	String	The long number of the CUG user.
`user_prefix_match`	Boolean	`true` if the CUG user was matched by prefix, otherwise `false`.
`user_range_size`	Integer	The range size of the CUG user.
`user_orig_on_net_allowed`	Boolean	`true` if the CUG user is allowed to make calls within the CUG group, otherwise `false`.
`user_orig_off_net_allowed`	Boolean	`true` if the CUG user is allowed to make calls outside the CUG group, otherwise `false`.
`user_term_on_net_allowed`	Boolean	`true` if the CUG user is allowed to receive calls from within the CUG group, otherwise `false`.
`user_term_off_net_allowed`	Boolean	`true` if the CUG user is allowed to receive calls from outside the CUG group, otherwise `false`.
`match_found`	Boolean	`true` if a CUG match was found, otherwise `false`.
`match_id`	Integer	The database ID of the CUG match user.
`match_short_code`	String	The short code of the CUG match user.
`match_long_number`	String	The long number of the CUG match user.
`match_is_ln`	Boolean	`true` if the match was made against the long number of the CUG match user, otherwise `false`.
`match_is_prefix`	Boolean	`true` if the match was made by prefix, otherwise `false`.
`match_range_size`	Integer	The range size of the CUG match user.
`match_virtual`	Boolean	`true` if the CUG match user is virtual, otherwise `false`.
`match_display_caller_sc`	Boolean	`true` if the caller shortcode was sent for presentation in the `Connect` messages, otherwise `false`.
`list_found`	Boolean	`true` if a match was made to a blacklist or a whitelist, otherwise `false`.
`list_disallowed`	Boolean	`true` if the applicable list disallowed the call, otherwise `false`.
`list_entry_id`	Integer	The database ID of the applicable list entry number.
`list_whitelist_match`	String	The match number found in the list lookup. Note that this may be different to the match number initially provided for the CUG query.
`list_is_prefix`	Boolean	`true` if the applicable list is a whitelist, otherwise `false`.

These fields are available to be written to N2SVCD rule engine variables using the context source service.cug.*. Note that they will only contain values if the appropriate outcome happened, e.g. there will be no user_number present if no CUG user was found.