Version 5.1

Introduction Installation SysAdmin Network Objects E-mail Signals Access Services Directory Clusters Applications Miscellaneous Licensing   WebMail PBX

Overview Rules SIP XMPP PSTN NAT Media Automated Signal Processing Rules Specifying Signal Rules Rule Conditions Rule Actions CPL Scripts CG/PL Programs Logging Rules Activity The CommuniGate Pro Server can automatically process Signals using sets of Automated Rules. Rules are not applied to Signal Requests sent inside already established Dialogs. The system-wide (Server-Wide and Cluster-wide) Rules are applied to all Signals sent to the Server and/or to the Cluster. When a Signal request is directed to a CommuniGate Pro Server Account, the Account-level Rules are applied. The Account-level Rules are the Rules specified for the particular Account along with the Rules specified for the Account Domain.

Specifying Signal Rules

System administrators can specify Server-Wide and Cluster-wide Signal Rules. Use the WebAdmin Interface to open the Real-Time pages in the Settings realm, and click the Rules link.

System and Domain Administrators can specify Account Rules using links on the Account Settings WebAdmin Interface pages.

Account users can specify their Rules themselves, using the WebUser Interface. System or Domain Administrators can limit the set of Rule actions a user is allowed to specify.

System and Domain Administrators can specify Domain-Wide Rules using the Rules links on the Domain Settings pages.

See the generic Automated Rules section to learn how to set Rules.

Rule Conditions

Each Rule can use universal conditions specified in the Rules section.
Additionally, the following Rule conditions can be used in Signal processing Rules:

Method        [is | is not | in | not in]  string

This condition checks if the Request Method address is (or is not) equal to the specified string.

Sample:

Method is

This condition will be met for all INVITE Requests.

CallType        [is | is not | in | not in]  string

This condition checks if the Request SDP type address is (or is not) equal to the specified string.
The SDP type is AV if the request methoid is INVITE and it contains at least one audio or video media channel;
The SDP type is IM if the request method is MESSAGE or if the request method is INVITE and it contains an IM channel.
The SDP type is an empty string in all other cases.

Sample:

CallType is

This condition will be met for all audio/video INVITE Requests.

From  [is | is not | in | not in]  string

This condition checks if the Request From address is (or is not) equal to the specified string.

Sample:

From is

This condition will be met for all signals coming from any account on any of communigate.com subdomains.

To        [is | is not | in | not in]  string

The same as above, but the Request To address is checked.

'From' Name  [is | is not | in | not in]  string

The same as above, but the instead of the address, the "address comment" (the real name) included in the From address is checked.

Sample:

'From' Name is

This condition will be met for Requests with the following From: addresses:

From: <sip:jsmith@company.com> (John J. Smith)

From: "Bill J. Smith" <sip:b.smith@othercompany.com>

From: Susan J. Smith <sips:susan@thirdcompany.com>

Authenticated  [is | is not | in | not in]  string

This condition checks the Request authentication. If the Request has been authenticated by this CommuniGate Pro Server, the authenticated Account name (account@domain) is compared with the specified string.

Sample:

Authenticated is

This condition will be met for all signals coming from any account on any of communigate.com subdomains.

Presence        [is | is not | in | not in]  string

This condition checks the aggregated presence of the request target. This condition can be used in the Domain- and Account- level Rules only.
The Presence is one of the strings online, busy, away. The Presence is an empty string when the call target is offline.

Sample:

Presence in

This condition will be met for all audio/video INVITE Requests.

Rule Actions

Each Rule can have zero, one, or several actions. If a Request meets all the Rule conditions, the Rule actions are performed.

You can use all universal actions described in the Rules section. This section describes the Rule actions that can be used in Signal Rules:

Stop Processing

This action should be the last one in a Rule. Execution of this Rule stops and no other (lower-priority) Rules are checked for this Signal at this time. Signal processing proceeds.

Discard Rules

This action should be the last one in a Rule. Execution of this Rule stops and no other (lower-priority) Rules are checked for this Signal, and all remaining Rules (scheduled to apply at later times or if the Signal fails) are removed, too. Signal processing proceeds.

Redirect to addresses

The Signal is redirected to one or several specified addresses: the current Signal "destination set" is cleared, and the specified addresses form the new "destination set".
Each address should be specified as a sip:, sips:, or tel: URI. If several addresses are specified, they should be separated with the comma (,) sign.

Sample:

Method is Authenticated is not

Redirect to sip:adManager@domain.com

This Rule will direct all INVITE Signals to the adManager@domain.com address, unless the Signal authenticated source is adManager@domain.com.
You can use this Rule to implement an advertizing server: the adManager@domain.com Account can start a PBX application that will play some media to the caller, and then, acting as a B2BUA, will connect the caller with the original destination. The calls made by that application will have adManager@domain.com as their autenticated source, so this Rule will not redirect them.

Fork to addresses

Same as Redirect to, but the specified addresses are added to the current "destination set" without clearing it first.

CPL Scripts

You can create and use CPL scripts to control Signal Processing. Under Construction

CG/PL Programs

You can create and use CG/PL programs to control Signal Processing. Under Construction

Logging Rules Activity

The Signal component records system-wide Rules activity in the Log. Set the Signal Log Level to Low-Level or All Info to see the Rules checked and the actions executed.