Navigation :

Notifications

Notification Messages

As part of handling any N2IWF action rule, a pre-configured notification message may be sent via SMPP or USSD.

All notifications for the N2IWF are configured in the NOTIFICATIONS LogicApp service global variable.

Several default parameters may be defined as additional LogicApp service global variables and these may be overridden on a per-notification basis. Note that if default values are not specified, all notification messages must specify all values.

Each parameter, both per-notification and default parameters are N2SVCD rule engine rulesets where the N2IWF selector rule extensions apply.

A sample notification configuration might be:

<global name="NOTIFICATION_TO_DEFAULT" from_var="logical"/>
<global name="NOTIFICATION_FROM_DEFAULT" type="array">
    <rule from_var="notf_from"/>
</global>
<global name="NOTIFICATION_APP_DEFAULT" literal="SMPP"/>
<global name="NOTIFICATION_PROTO_DEFAULT" literal="smpp"/>
<global name="NOTIFICATIONS" type="array">
    <notification name="notf1">I am a default notification.</notification>
    <notification name="notf2">
        <to from_var="called"/>
        <from literal="456"/>
        <protocol type="array">
            <rule literal="ussd"/>
        </protocol>
        <app literal="SIGTRAN"/>
        <text>I am a notification with overrides.</text>
    </notification>
</global>

In the above, two notifications are defined and would have the following configuration:

Name	To Address	From Address	Protocol	Sending Application	Body
`notf1`	Variable `logical`	Variable `notf_from`	SMPP	`SMPP`	I am a default notification.
`notf2`	Variable `called`	`456`	USSD	`SMPP2`	I am a notification with overrides.

Notification Defaults

The following notification defaults may be specified as LogicApp service global variables:

Global	Type	Description
`NOTIFICATION_TO_DEFAULT`	String	An N2IWF selector ruleset to specify the default notification to address.
`NOTIFICATION_FROM_DEFAULT`	String	An N2IWF selector ruleset to specify the default notification from address.
`NOTIFICATION_APP_DEFAULT`	String	An N2IWF selector ruleset to specify the default notification sending application.
`NOTIFICATION_PROTO_DEFAULT`	String	An N2IWF selector ruleset to specify the default notification protocol. Must be either `smpp` or `ussd`.

Notification Definition

Each notification can support the following parameters:

Attribute	Type	Description
`name`	String	[Required] The unique name for this notification message. Used in rules to specify the notification to send.
`to`	String	[Conditional] The normalised destination address for the notification message. Must be specified if no default value applies.
`from`	String	[Conditional] The normalised from address for the notification message. Must be specified if no default value applies.
`app`	String	[Conditional] The N2SVCD application to use to send the notification message. Must be specified if no default value applies.
`protocol`	String	[Conditional] The protocol to send the notification message in on the wire. Must be specified if no default value applies.
`flash`	Boolean	Whether the message should be treated as a flash message (i.e. displayed without storage). Only applicable to SMPP messages. (Default: `false`)
`text`	String	The plain text body of the notification message. Will be encoded into the appropriate on-the-wire characters by the sending N2SVCD application.