Name

The client name used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax.

The first choice for Realm Pattern value should always be the exact peer realm name.

Extract Avps

Name

Enter a logical name for the extracted AVP. This name will be used in Initiator conditions and CRD tables to identify the extracted AVP. This is a mandatory parameter.

Avp Path

Enter the complete AVP path. This is a mandatory parameter.

Command Code

If Command Code is specified, CPS attempts to extract the AVPs from only that command (and skip the rest). This is an optional parameter.

Name

The client name used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax.

The first choice for Realm Pattern value should always be the exact peer realm name.

Add Subscriber Id

Adds Subscription-Id grouped AVP in Gx CCA-i message with one of the following Subscription-Id-Type AVP value and Subscription-Id-Data AVP value depending on the selection. The values will be copied from the incoming Gx CCR-i message if available.

• NONE (default): No Subscription-Id grouped AVP in Gx CCA

• IMSI: END_USER_IMSI (1)

• MSISDN: END_USER_E164 (0)

• NAI: END_USER_NAI (3)

Rx PCC Rule Flow Direction Behavior

Controls how the Flow-Direction AVP value under Flow-Information grouped AVP is derived. This option is used for Rx dedicated bearers.

• Derive Flow-Direction (default): Flow-Direction AVP is derived based on Flow-Description AVP value and Flow-Status AVP value. This option is used in case the PCEF advertised support for Rel10 feature under Supported-Features AVP.

• 3GPP Gx Rel11 Compliant: Flow-Direction AVP is derived as per 3GPP TS 29.212 v11

• Exclude Flow-Direction: Flow-Direction AVP is not set.

Emergency Called Station Ids

List of APNs that are allowed to initiate IMS emergency calls. For more information, see CPS Mobile Configuration Guide.

Sending Delayed Message Wait Time Ms

This parameter specifies the amount of time the Gx RAR will be delayed after Gx CCA is sent when "Gx Triggered Session-Release-Cause in RAR" is enabled.

In case of multiple Media-Component-Descriptions being received in an AAR message by CPS, where one of them is rejected after evaluating for Gx Authorization, CPS sends a successful AAA for the accepted Media-Component-Descriptions and also creates a scheduled event for sending a delayed Rx RAR for rejected Media component.

This Gx RAR is sent to AF based on Sending Delayed Message Wait Time configured.

Default value is 500 milliseconds.

Control Session Lifecycle

Decides if all the other sessions bound to the current Gx session get terminated upon Gx session termination.

Default value is checked.

Remove Realm In User ID Mapping

When enabled removes the realm from the NAI (if present) before attempting to load the session by username.

Default value is not checked.

Exclude Sponsor Identity AVP

When enabled it does not add the Sponsor-Identity AVP to the Charging-Rule-Definition grouped AVP. This option is used only in case the PCEF advertised support for SponsoredConnectivity feature under Supported-Features AVP.

Default value is not checked.

Load By Imsi

When enabled attempts to load the session by IMSI (Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_IMSI (1)).

Default value is not checked.

Load By Nai

When enabled attempts to load the session by NAI (Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_NAI (3)).

Default value is not checked.

Load By Msisdn

When enabled attempts to load the session by MSISDN (Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_E164 (0)).

Default value is not checked.

Imsi Based Nai

If checked, the subscriber is identified by PCRF using "IMSI based NAI", where the identity is represented in NAI form as specified in RFC 4282 [5], and formatted as defined in 3GPP TS 23.003 [6], clause 19.3.2. The IMSI based NAI is sent within the Subscription-Id AVP with the Subscription-Id-Type set to END_USER_NAI at IP-CAN session establishment.

Default value is unchecked.

Load By Framed Ip

When enabled attempts to load the session by IP v4 address (Framed-IP-Address AVP value).

Default value is not checked.

Load By Ip V6 Prefix

When enabled attempts to load the session by IP v6 address (Framed-IPv6-Prefix AVP value).

Default value is not checked.

Session Chained

When enabled it does not attempt to terminate the Gx session by sending a Gx RAR to PCEF.

Default value is not checked.

Remove Realm In User Id Mapping

If checked, removes the realm from the NAI (if present) before attempting to load the session by username. For more details on NAI see RFC 2486.

Default value is unchecked.

Exclude Sponsor Identity Avp

If checked, it does not add the Sponsor-Identity AVP to the Charging-Rule-Definition grouped AVP. This option is used only in case the PCEF advertised support for SponsoredConnectivity feature under Supported-Features AVP.

Default value is unchecked.

Load By Called Station Id

When enabled attempts to load the session by IMSI and APN. To effectively use this option Load By Imsi option needs to be enabled.

Re-install Rule on Monitoring Key Change

When enabled attempts to re-install a charging rule in case the only AVP value that changed for a PreConfiguredRule is the monitoring key value.

Default value is not checked.

Limit with Requested QoS on modification failure

If checked, authorizes bound QoS between retained and calculated QoS after CPS has received QoS modification failure event from PCEF.

Default value is checked.

If this attribute is unchecked, then CPS will not perform the missing AVP validation.

Default value is checked.

This parameter applies only to the dynamic charging rules over Gx that are generated by CPS due to the APPLICATION_START event trigger received over the Sd interface for ADC rules.

When enabled CPS creates one dynamic charging rule over Gx per flow information received in the Application-Detection-Info AVP over the Sd interface. CPS also creates a unique TDF-Application-Identifier over Gx for each of these rules. So, each generated rule has a unique TDF-Application-Identifier and only one Flow-Information AVP.

When disabled CPS generates only one rule per TDF-Application-Identifier received over the Sd interface. This one rule has all the Flow-Information AVPs. The TDF-Application-Identifier over Gx is same as over Sd.

Default value is unchecked.

Selective Muting

When enabled CPS selectively mutes the flow corresponding to a TDF-Application-Identifier on dedicated bearer after it receives the first Application_Start event trigger on the dedicated bearer.

After CPS receives Application_Stop event trigger for a specific TDF-Application-Identifier (with TDF-App-Instance-ID=0), CPS removes that rule from dedicated bearer and installs the rule on the default bearer and unmutes all the rules related to that TDF-Application-Identifier on default bearer.

Re-Install Predefined Rules on Rulebase Change

Indicates whether all the existing predefined rules that are applicable for the session are re-installed if there is a Rule-Base change. Select this option if you want all the predefined rules (that are applicable to the session) to be re-installed if the Rule-Base changes due to any reason. If unchecked, whenever there is a Rule-Base change, CPS only notifies the changes (if any) in predefined rules to PCEF and does not re-install all the existing predefined rules.

Gx triggered Session-Release-Cause in RAR

When enabled, any Gx initiated session termination is responded to with a RAR immediately after CCR/CCA exchange with the PCEF. The RAR contains the Session-Release-Cause AVP.

When disabled, any Gx initiated session termination response from the PCRF in the CCA-U contains the Session-Release-Cause AVP. This is the default behavior.

Cisco Pending Transaction Retry

Select to enable Cisco Pending Transaction Retry.

Sponsored Profile

Allows for customization of the monitoring key name.

This option is used only in case the PCEF advertises support for SponsoredConnectivity feature under Supported-Features AVP.

Rx Based QoS Upgrade Of Default Bearer

Select to enable Rx based QoS upgrade

Count of Flow Descriptions in one Charging

Select to enable Count of Flow Descriptions in one Charging Rule.

Max number of Flow Descriptions on a bearer

Defines the maximum number of flows that can be installed on a default bearer per QCI.

On receiving the APPLICATION_START event trigger over the Sd interface, CPS installs the corresponding flows over the Gx interface and QCI maps to that of the default bearer. Essentially, this is the limit of flows per QCI that CPS can accept from TDF over the Sd interface. Once this limit is reached, CPS ignores any more flows received from TDF does not install any rules for those flows.

Default value is 64.

Charging Rule Retry

Select to enable Charging Rule Retry Configuration.

Redirect Requests

CPS can reject incoming CCR-I messages with DIAMETER_REDIRECT_INDICATION (3006) error by acting as a redirect agent (RFC 3588). This decision to redirect a request is configured using an STG or CRD.

CPS expects the STG or CRD to include a Redirect Request Column (of type True or False). There is no restriction on the condition that determines the redirect behavior.

Pending Transaction Retry

Back Off Algorithm

• Constant_Interval: The configured retry Interval is used (without any change) for all retry attempts.
• Linear_Interval: Retry interval is derived by multiplying the attempt number with the retry interval. This is applicable only when RAR messages are retried due to pending transactions.

Default value is Constant_Interval.

RAR Retry Interval (MilliSeconds)

Retry time interval (milliseconds) after which same RAR is retried after receipt of Pending Transactions (4144) Experimental Result code in RAA.

Default value is 1000 milliseconds.

Time (MilliSeconds) to hold CCR-U processing

Time interval (milliseconds) during which CCR-U processing is withheld till pending RAA is received from PCEF.

Default value is 1000 milliseconds.

Time (MilliSeconds) to wait for CCR-U retry

Time interval (milliseconds) during which CPS should wait for PCEF to initiate a CCR-U retry after sending a RAA with Pending Transactions (4144) Experimental Result code.

Default value is 1000 milliseconds.

Max No of additional RAR's to be stored

Number of RARs generated during pending transactions situations that need to be held and retried in sequence. Additional maximum RARs that can be stored is three. If this value is more that three, Policy Builder displays configuration violation error message.

Default value is 1. If set to 0, additional RAR's are discarded.

Extract Avps

Name

Enter a logical name for the extracted AVP. This name will be used in Initiator conditions and CRD tables to identify the extracted AVP. This is a mandatory parameter.

Avp Path

Enter the complete AVP path. This is a mandatory parameter.

Command Code

If Command Code is specified, CPS attempts to extract the AVPs from only that command (and skip the rest). This is an optional parameter.

Custom Dynamic Rule Name

Af Application Id

The AF-Application-Id for which the QoS values should be applied.

Media type

The Media-Type for which the QoS values should be applied. (Use an Integer value as per 3GPP specifications).

Partial Rule Name

Value matching the current Af Application Id and Media Type values for the current Media-Sub-Component grouped AVP or "AF" if no match.

Name

The client name used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax.

The first choice for Realm Pattern value should always be the exact peer realm name.

Session Binding Attribute

Allows the Rx sessions initiated by this client to bind to the Gx session by other attribute than the IP address as per 3GPP TS 29.214.

Flow Description Source Ip Evaluation

• None: When selected, CPS does not take any action on source IP.

• Replace with 'any': When selected, CPS replaces the flow description source IP with ‘any’.

• Replace with UE IP: When selected, CPS replaces flow description source IP with UE framed IP.

STA Hold Time Ms

Defines the timer by which the STA will be held back. Once the timer expires even if the CCR-U is not received, STA will be sent to the AF and the rxSession will be removed.

Default value is 4000 milliseconds.

CCR-U Wait Time (in seconds)

After expiry of the CCR-U Wait Time (in seconds), CPS sends the Rx RAR message.

Sending Delayed Message Wait Time Ms

This parameter is used to configure wait timer for sending delayed messages.

Default value is 500 milliseconds.

In case of multiple Media-Component-Descriptions being received in an AAR message by CPS, where one of them is rejected after evaluating for Rx Authorization, CPS sends a successful AAA for the accepted Media-Component-Descriptions and also creates a scheduled event for sending a delayed Rx RAR for rejected Media component.

This Rx RAR is sent to AF based on Sending Delayed Message Wait Time configured.

Emergency URN List

The list of URNs that are used to indicate that a AF session relates to emergency traffic as per procedures described in 3GPP TS 29.214.

Override AF App Id with URN for Emergency sessions

When selected, CPS overrides the AF-Application-Identifier AVP value with the Service-URN AVP value for emergency calls. This option is provided in order to overcome the lack of AF-Application-Identifier AVP value in Rx AAR in case of IMS emergency calls.

Default value is unchecked.

Validate Flow-Description AVP Value

When checked, CPS validates the Flow-Description AVP values received as part of Media-Sub-Component based on restrictions provided in the 3GPP 29.214 Release 11 specification. If the Flow-Description value does not comply with the format specified, then the AAR request is rejected with FILTER_RESTRICTIONS (5062) value in Experimental-Result-Code.

When the check box is unchecked, CPS does not validate the Flow-Description AVP value and forwards it to PCEF as part of generated rules.

Default value is unchecked.

29.213 standard QoS for preliminary service

When selected, CPS supports the QoS handling for Preliminary Service Status. So, on receiving Service-Info-Status AVP as preliminary service information from AF, CPS will generate the dynamic PCC rule and assign QCI and ARP values of the default bearer to these PCC rule to avoid signaling to the UE.

When unchecked, CPS ignores the Service-Info-Status AVP value and derive the ARP and QCI values as per the QoS derivation algorithm defined in 3GPP TS 29.213 specification.

Default value is unchecked.

Auto Increment Precedence AVP

When selected, CPS automatically increments the precedence AVP value by 1 for every Rx charging rule that is installed as part of any Rx session that is using this Rx client within the same Gx session. For example, Gx session (Gx1) has one Rx session (Rx1). When Rx1 starts two Rx charging rules, they are assigned precedence values 1 and 2. A second Rx session (Rx2) starts for Gx1 and also installs two Rx charging rules. These rules are assigned precedence values 3 and 4.

The precedence values are stored in the Gx session in the rxPrecedenceCounter attribute.

Using this option overrides any other Rx charging rule precedence settings (for example, any that may have been configured for the RxSponsoredDataChargingParameters service option).

You can use the Precedence Start Value and Precedence End Value options to set lower and upper limits for the precedence AVP values. If you do not set these options, the starting precedence value is set to 1 and will increment to 9223372036854775807.

The default setting is unchecked.

Remove Rule On Rule Deactivation

When selected, CPS manages the expiration of Rule-Deactivation time triggers. On expiration of the installed Rule-Deactivation time, CPS initiates removal of the inactive dynamic rules and tear down of existing Rx session.

Default value is unchecked (false).

Authorize Sponsor Data Connectivity

When selected, CPS validates the sponsor ID received in AAR request. If the received sponsor ID is unauthorized, CPS returns UNAUTHORIZED_SPONSORED_DATA_CONNECTIVITY (5067) code in AAA.

Default value is unchecked (false).

Enforce Unique AF-Charging-Identifier

When selected, CPS enforces a unique AF-Charging-Identifier across all Rx sessions within a given subscriber or network session. During an Rx session establishment, if there is already an Rx session (within the subscriber or network session) containing the same AF-Charging-Identifier value, CPS rejects the new Rx session with DUPLICATED_AF_SESSION (5064) experimental result code.

Default value is unchecked.

Prefer command level AF-Application-Identifier

The AF-Application-Identifier AVP present in the AAR message indicates the particular service that the AF session belongs to. This AVP can be present at the command level and within the Media-Component-Description AVP.

When selected, and if the AF-Application-Identifier is sent both at command level and within the Media-Component-Description AVP, the AF-Application-Identifier AVP value present at the command level is considered.

The default setting is unchecked, that is, the AF-Application Identifier provided within the Media-Component-Description AVP is considered.

Send timezone and location info

When selected, CPS sends time zone and location information in an Rx AAA response message provided that 3GPP-MS-TimeZone AVP and 3GPP-User-Location-Info AVP are already received in the CCR message.

To receive the updated time zone and location information in the Rx AAA message, CPS should arm the UE_TIME_ZONE_CHANGE event trigger and USER_LOCATION_CHANGE event trigger in the service option under Event-Trigger configuration.

Precedence Avp Lower And Upper

Precedence Start Value

The precedence value for the first Rx charging rule that is installed as part of an Rx session. The number will continue to increment for each Rx charging rule installed until it reaches the value set in the Precedence End Value field. When the value is reached, the rxPrecedenceCounter is reset to the Precedence Start Value, and continues incrementing.

This value is optional, but when used, must be greater than 0 and less than the Precedence End Value.

Precedence End Value

The upper limit of the precedence values for Rx charging rules that are installed. When this value is reached, the rxPrecedenceCounter is reset to the Precedence Start Value, and it must be greater than the Precedence Start Value.

Netloc Access Not Supported Configuration

By default, this configuration is disabled. This means that PCRF will not check for NetLoc access support based on IP-CAN-Type or Rat-Type AVP and AN-Trusted AVP.

If this configuration is enabled but there are no entries in the two tables associated with it, then PCRF will not check for NetLoc access support based on IP-CAN-Type or Rat-Type AVP and AN-Trusted AVP.

Extract Avps

Name

Enter a logical name for the extracted AVP. This name will be used in Initiator conditions and CRD tables to identify the extracted AVP. This is a mandatory parameter.

Avp Path

Enter the complete AVP path. This is a mandatory parameter.

Command Code

If Command Code is specified, CPS attempts to extract the AVPs from only that command (and skip the rest). This is an optional parameter.

Name

The client name used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax.

The first choice for Realm Pattern value should always be the exact peer realm name.

Load By Imsi

When enabled attempts to load the session by IMSI (Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_IMSI (1)).

Default value is not checked.

Load By Nai

When enabled attempts to load the session by NAI (Subscription-Id-Data AVP value under Subscription-Idgrouped AVP where Subscription-Id-Type AVP valueis END_USER_NAI (3)).

Default value is not checked.

Load By Msisdn

When enabled attempts to load the session by MSISDN (Subscription-Id-Data AVP value under Subscription-Id grouped AVP where Subscription-Id-Type AVP value is END_USER_E164 (0)).

Default value is not checked.

Load By Framed Ip

When enabled attempts to load the session by IP v4 address(Framed-IP-Address AVP value).

Default value is not checked.

Load By Ip V6 Prefix

When enabled attempts to load the session by IP v6 address (Framed-IPv6-Prefix AVP value).

Default value is not checked.

Extract Avps

Name

Enter a logical name for the extracted AVP. This name will be used in Initiator conditions and CRD tables to identify the extracted AVP. This is a mandatory parameter.

Avp Path

Enter the complete AVP path. This is a mandatory parameter.

Command Code

If Command Code is specified, CPS attempts to extract the AVPs from only that command (and skip the rest). This is an optional parameter.

Name

The client name used to reference this particular client in the service configuration object.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used. The pattern needs to follow the standard Java regular expression syntax.

The first choice for Realm Pattern value should always be the exact peer realm name.

Load Options

Load By Realm And User Id

Loads the session by realm (Origin-Realm AVP value) and User Id.

Default value is not checked.

Load By APN And User Id

Loads the session by APN (Called-Station-Id AVP value) and User Id.

Default value is not checked.

Extract Avps

Name

Enter a logical name for the extracted AVP. This name will be used in Initiator conditions and CRD tables to identify the extracted AVP. This is a mandatory parameter.

Avp Path

Enter the complete AVP path. This is a mandatory parameter.

Command Code

If Command Code is specified, CPS attempts to extract the AVPs from only that command (and skip the rest). This is an optional parameter.

AVP Name

Any string that will be used to identify this custom AVP.

AVP Code

AVP Code combined with Vendor Id field, identifies the attribute uniquely.

• 1-255: Backward compatibility with Radius, without setting the Vendor Id field.

• 256-above: Used for Diameter, and are allocated by IANA.

Vendor Id

Indicates if the Vendor Id field is there in the AVP or not.

Vendor Code

Vendor Id value as assigned by IANA. The Vendor Id bit known as the Vendor-Specific bit, indicates if the optional Vendor Code field is present in the AVP header. When set the AVP Code belongs to the specific vendor code address space.

Mandatory Bit

Indicates if the support of the AVP is required. If this Bit is enabled, then Diameter Client, Server, Proxy and Translation Agent must support the handling of this AVP.

Protected Bit

Indicates the need for encryption for end-to-end security. If this bit is enabled, it indicates that AVP data is encrypted for end-to-end security.

Vendor Id Bit

Indicates whether the optional Vendor-ID field is present in the AVP header.

Data Type

Any valid basic AVP data format:

• Float32Avp

• Float64Avp

• Integer32Avp

• Integer64Avp

• OctetStringAvp

• Unsigned32Avp

• Unsigned64Avp

• UTF8String

Source Avp

Name of AVP for possible mapping.

Source Avp Id

The Application Interface Id (Gx) in numeric format (16777238) on which the Source AVP is received.

Source Cmd Code

The command code of the message on interface Source APPID that contains the Source AVP.

Source Cmd Type

The message indicated by Source Command Code that is a request or response.

Origin Host

Identification of the source point of the operation.

Origin Realm

Identification of the realm of the operation originator.

Target Avp

AVP Name mapped to Source AVP.

Target App Id

Target Application Identifier

Target Cmd Code

The command code of the message that goes on Target APP ID and has Target AVP.

Target Cmd Type

The message having Target Command Code request or a response.

Destination Host

Identification of the destination point of the operation.

Destination Realm

Realm of the operation destination

Source Avp

Name of AVP that has to be looked up for possible mapping.

Is SPR AVP?

Check if the source is an SPR attribute. The Source AVP originates from a Source Command or from Subscriber profile in Subscriber Profile Repository.

Source App Id

The Application Interface Id (Gx) in numeric format (16777238) on which the Source AVP is received.

Source Cmd Code

The command code of the message on interface Source APP ID that contains the Source AVP.

Source Cmd Type

Origin Host

Identification of the source point of the operation.

Origin Realm

Identification of the realm of the operation originator.

Target Avp

AVP Name that is actually mapped to Source AVP.

Target App Id

Target Application Identifier (Sy - 16777302).

Target Cmd Code

The command code of the message that goes on Target APP ID and have Target AVP.

Target Cmd Type

Destination Host

Identification of the destination point of the operation.

Destination Realm

Realm of the operation destination.

Source Avp

Name of AVP that has to be looked up for possible mapping.

Is SPR AVP?

Check if the source is an SPR attribute. The Source AVP originates from a Source Command or from Subscriber profile in Subscriber Profile Repository.

Default value is unchecked.

Source App Id

The Application Interface Id (Gx) in numeric format (16777238) on which the Source AVP is received.

Source Cmd Code

The command code of the message on interface Source APP ID that contains the Source AVP.

Source Cmd Type

Origin Host

Identification of the source point of the operation.

Origin Realm

Identification of the realm of the operation originator.

Target Avp

AVP Name that is actually mapped to Source AVP.

Target App Id

Target Application Identifier (Sy - 16777302).

Target Cmd Code

The command code of the message that goes on Target APP ID and have Target AVP.

Target Cmd Type

Destination Host

Identification of the destination point of the operation.

Destination Realm

Realm of the operation destination.

Push Pre-Configured Rule Option

Determines if the configured default bearer QoS will be installed on the default bearer or on the secondary bearers.

• PushOnDefaultBearerQoS (default)

• PushWithUpgradedDefaultBearerQoS

Logical Apn

Allows for a default APN name to be defined. This APN name is going to be further used as an input into the AF Application Id Validation feature described below. The APN value will be set based on the available data and the priorities as described below:

1. A policy derived AVP having the same value as the Logical Apn.

2. Called-Station-Id AVP from incoming Rx AAR.

3. Called-Station-Id AVP from Gx session.

Gx Client QoS Exclusion List

Gx client names that are allowed not to have a default bearer QoS installed. In case a default bearer QoS has not been configured in the policy and the Gx client name has not been added to this list an error response will be sent to the PCEF containing the Result-Code AVP value DIAMETER_ERROR_BEARER_NOT_AUTHORIZED (5143).

Grant Requested QoS

Determines if the requested QoS should be granted or not as the default bearer QoS.

Default value is not checked.

Grant Requested QoS Over Global QoS

If this option is selected then the requested QoS should be granted even if the global QoS is provisioned. There are three type of QoS, first is taken from service second is from default QoS and third one is from request. If this flag is checked then requested QoS will take priority over default QoS.

Default value is not checked.

Global Default Granted QoS

Select to enable Exclusion List

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable bitrates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0,10 – 255 are divided for usage as follows:

•  0: Reserved

• 10-127: Reserved

• 128-254: Operator specific

• 255: Reserved

Max Req Bandwidth U L

Defines the maximum bit rate allowed for the uplink direction.

Max Req Bandwidth D L

Defines the maximum bit rate allowed for the downlink direction.

Guaranteed Bit Rate U L

Defines the guaranteed bit rate allowed for the uplink direction.

Guaranteed Bit Rate D L

Defines the guaranteed bit rate allowed for the downlink direction.

Apn Agg Max Bit Rate U L

Defines the total bandwidth usage for the uplink direction of non-GBR QCIs at the APN.

Apn Agg Max Bit Rate D L

Defines the total bandwidth usage for the downlink direction of non-GBR QCIs at the APN.

ARP

Select the Arp type from the drop-down list to open parameters for the corresponding selection. ARP is used to indicate the priority of allocation and retention.

Relaxed USAGE_REPORT Event-Trigger Handling

Use this checkbox to enable the functionality for supporting old event-trigger value (26) for the usage report.

This configuration will be applicable only when CPS is configured to use R10 event-trigger values by unchecking the 'Use V9 Event Trigger Mapping' flag in Diameter Configuration.

Realm Pattern

The pattern that peer realm name should match in order for this diameter client to be used.

Host Pattern

Host name pattern as received in Origin-Host AVP in AAR message. The pattern needs to follow standard Java pattern conventions.

QOS retry on APN-AMBR_FAILURE_MOFIDICATION

Select to receive APN-AMBR_FAILURE_MODIFICATION events from PCEF.

Number Of Retry

Number of retries to push calculated QoS information.

QoS Retry Options

Action On QoS Retry Exhaust

Time To Trigger Release RAR In Minutes

CPS sends RAR with Release Cause value as UNSPECIFIED_REASON after the time configured in Time To Trigger Release RAR expires.

Time To Reset QoS Retry Counter In Minutes

Once CPS receives APN-AMBR_FAILURE_MODIFICATION, CPS sets next reset timer to value configured in Time to Reset QoS Retry Counter. If CPS does not receive APN-AMBR_FAILURE_MODIFICATION within this specified time, CPS resets the retry count to 0.

Ims Apn

List of IMS APNs for which the MPS feature is supported.

This field can accommodate several Ims Apn that are used to match with the incoming service request for priority service. The values that are received by the Default Bearer QoS are looked up for a suitable Ims Apn match. If the APN value of a Gx session request matches IMS APN IMS signaling priority from EMPS service is used as priority level.

Priority Level

Priority level is used to decide if a bearer establishment or modification request can be accepted or needs to be rejected in case of resource limitations (used for admission control of GBR traffic). The AVP can also be used to decide which existing bearers to pre-empt during resource limitations. The priority level defines the relative importance of a resource request. Values 1 to 15 are defined with value 1 as the highest level of priority.

• Values 1 to 8: Assigned for services that are authorized to receive prioritized treatment within an operator domain.

• Values 9 to 15: Can be assigned to resources that are authorized by the home network and thus applicable when a UE is roaming.

Preemption Capability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can get resources that were already assigned to another service data flow with a lower priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can get resources that were already assigned to another bearer with a lower priority level.

• 0: This value indicates that the service data flow or bearer is allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level.

• 1: This value indicates that the service data flow or bearer is not allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level. This is the default value applicable if this AVP is not supplied.

Preemption Vulnerability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can lose the resources assigned to it in order to admit a service data flow with higher priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can lose the resources assigned to it in order to admit a pre-emption capable bearer with a higher priority level.

• 0: This value indicates that the resources assigned to the service data flow or bearer can be pre-empted and allocated to a service data flow or bearer with a higher priority level. This is the default value applicable if this AVP is not supplied.

• 1: This value indicates that the resources assigned to the service data flow or bearer shall not be pre-empted and allocated to a service data flow or bearer with a higher priority level.

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable bit rates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0, 10 – 255 are divided for usage as follows:

• 0: Reserved

• 10-127: Reserved

• 128-254: Operator specific

• 255: Reserved

Prefer answer Codec-Data

Default QoS Policy

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable bitrates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0, 10 – 255 are divided for usage as follows:

•  0: Reserved

• 10-127: Reserved

• 128-254: Operator specific

• 255: Reserved

Max Requested Bandwidth U L

Defines the maximum bit rate allowed for the uplink direction.

Max Requested Bandwidth D L

Defines the maximum bit rate allowed for the downlink direction.

Guaranteed Bit Rate U L

Defines the guaranteed bit rate allowed for the uplink direction.

Guaranteed Bit Rate D L

Defines the guaranteed bit rate allowed for the downlink direction.

MPS QoS Policy

M P S Id

The MPS Id contains the national variant for MPS service name indicating an MPS session.

Priority Level

Priority level is used to decide if a bearer establishment or modification request can be accepted or needs to be rejected in case of resource limitations (used for admission control of GBR traffic). The AVP can also be used to decide which existing bearers to pre-empt during resource limitations. The priority level defines the relative importance of a resource request. Values 1 to 15 are defined with value 1 as the highest level of priority.

• Values 1 to 8: Assigned for services that are authorized to receive prioritized treatment within an operator domain.

• Values 9 to 15: Can be assigned to resources that are authorized by the home network and thus applicable when a UE is roaming.

Preemption Capability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can get resources that were already assigned to another service data flow with a lower priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can get resources that were already assigned to another bearer with a lower priority level.

• 0: This value indicates that the service data flow or bearer is allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level.

• 1: This value indicates that the service data flow or bearer is not allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level. This is the default value applicable if this AVP is not supplied.

Preemption Vulnerability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can lose the resources assigned to it in order to admit a service data flow with higher priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can lose the resources assigned to it in order to admit a pre-emption capable bearer with a higher priority level.

• 0: This value indicates that the resources assigned to the service data flow or bearer can be pre-empted and allocated to a service data flow or bearer with a higher priority level. This is the default value applicable if this AVP is not supplied.

• 1: This value indicates that the resources assigned to the service data flow or bearer shall not be pre-empted and allocated to a service data flow or bearer with a higher priority level.

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable bitrates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0, 10 – 255 are divided for usage as follows:

• 0: Reserved

• 10-127: Reserved

• 128-254: Operator specific

• 255: Reserved

Media Type

Applicable Media-Type (session level or specific to Media-Component-Description). Select from drop-down list. The list includes Audio, Video, Data, Application, Control, Text, Message, and Other.

Application QoS Policy

Priority Level

Priority level is used to decide if a bearer establishment or modification request can be accepted or needs to be rejected in case of resource limitations (used for admission control of GBR traffic). The AVP can also be used to decide which existing bearers to pre-empt during resource limitations. The priority level defines the relative importance of a resource request. Values 1 to 15 are defined with value 1 as the highest level of priority.

• Values 1 to 8: Assigned for services that are authorized to receive prioritized treatment within an operator domain.

• Values 9 to 15: Can be assigned to resources that are authorized by the home network and thus applicable when a UE is roaming.

Preemption Capability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can get resources that were already assigned to another service data flow with a lower priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can get resources that were already assigned to another bearer with a lower priority level.

• 0: This value indicates that the service data flow or bearer is allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level.

• 1: This value indicates that the service data flow or bearer is not allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level. This is the default value applicable if this AVP is not supplied.

Preemption Vulnerability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can lose the resources assigned to it in order to admit a service data flow with higher priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can lose the resources assigned to it in order to admit a pre-emption capable bearer with a higher priority level.

• 0: This value indicates that the resources assigned to the service data flow or bearer can be pre-empted and allocated to a service data flow or bearer with a higher priority level. This is the default value applicable if this AVP is not supplied.

• 1: This value indicates that the resources assigned to the service data flow or bearer shall not be pre-empted and allocated to a service data flow or bearer with a higher priority level.

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable bitrates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0, 10 – 255 are divided for usage as follows:

• 0: Reserved

• 10-127: Reserved

• 128-254: Operator specific

• 255: Reserved

Max Requested Bandwidth U L

Defines the maximum bit rate allowed for the uplink direction.

Max Requested Bandwidth D L

Defines the maximum bit rate allowed for the downlink direction.

Guaranteed Bitrate U L

Defines the guaranteed bit rate allowed for the uplink direction.

Guaranteed Bitrate D L

Defines the guaranteed bit rate allowed for the downlink direction.

AF Application Identifier

It contains information that identifies the particular service that the AF service session belongs to. This information may be used by the PCRF to differentiate QoS for different application services.

Media Type

Applicable Media-Type (session level or specific to Media-Component-Description). Select from drop-down list. The list includes Audio, Video, Data, Application, Control, Text, Message, and Other.

Codec QoS Policy

Codec Data Pattern

Contains codec related information known at the AF.

Codec Details Pattern

Contains codec related information.

Qci

The QoS class identifier identifies a set of IP-CAN specific QoS parameters that define QoS, excluding the applicable bitrates and ARP. It is applicable both for uplink and downlink direction. The QCI values 0, 10 – 255 are divided for usage as follows:

• 0: Reserved

• 10-127: Reserved

• 128-254: Operator specific

• 255: Reserved

Max Requested Bandwidth U L

Defines the maximum bit rate allowed for the uplink direction.

Max Requested Bandwidth D L

Defines the maximum bit rate allowed for the downlink direction.

Guaranteed Bitrate U L

Defines the guaranteed bit rate allowed for the uplink direction.

Guaranteed Bitrate D L

Defines the guaranteed bit rate allowed for the downlink direction.

Reservation QoS Policy

Reservation Priority

The Reservation Priority includes the priority value of the related priority service. The Reservation Priority is populated with a default value if the priority value is unknown.

Priority Level

Priority level is used to decide if a bearer establishment or modification request can be accepted or needs to be rejected in case of resource limitations (used for admission control of GBR traffic). The AVP can also be used to decide which existing bearers to pre-empt during resource limitations. The priority level defines the relative importance of a resource request. Values 1 to 15 are defined with value 1 as the highest level of priority.

• Values 1 to 8: Assigned for services that are authorized to receive prioritized treatment within an operator domain.

• Values 9 to 15: Can be assigned to resources that are authorized by the home network and thus applicable when a UE is roaming.

Preemption Capability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can get resources that were already assigned to another service data flow with a lower priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can get resources that were already assigned to another bearer with a lower priority level.

• 0: This value indicates that the service data flow or bearer is allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level.

• 1: This value indicates that the service data flow or bearer is not allowed to get resources that were already assigned to another service data flow or bearer with a lower priority level. This is the default value applicable if this AVP is not supplied.

Preemption Vulnerability

If it is provided within the QoS-Information AVP, the AVP defines whether a service data flow can lose the resources assigned to it in order to admit a service data flow with higher priority level. If it is provided within the Default-EPS-Bearer-QoS AVP, the AVP defines whether the default bearer can lose the resources assigned to it in order to admit a pre-emption capable bearer with a higher priority level.

• 0: This value indicates that the resources assigned to the service data flow or bearer can be pre-empted and allocated to a service data flow or bearer with a higher priority level. This is the default value applicable if this AVP is not supplied.

• 1: This value indicates that the resources assigned to the service data flow or bearer shall not be pre-empted and allocated to a service data flow or bearer with a higher priority level

AF Application Id Validation

AF Application Identifier Pattern

It contains information that identifies the particular service that the AF service session belongs to. This information may be used by the PCRF to differentiate QoS for different application services.

Apn

Access point name is the name of the gateway between the mobile network and another network.

Media Type

Applicable Media-Type (session level or specific to Media-Component-Description). Select from drop-down list. The list includes Audio, Video, Data, Application, Control, Text, Message, and Other.

Input parameters

Gx Realm

Origin-Realm

Gx host Pattern

Origin-Host

Output parameters

TDF Realm

Destination-Realm

TDF Host

Destination-Host

Code

Name of the Schedule.

Scheduled Switch Times

Name

Name of the scheduled switch time.

Start Time

Start time of the scheduled switch time.

End Time

End time of the scheduled switch time.

Retry Interval

Delay between retry attempts.

The default interval is 10 seconds or is capped at 15 seconds (configurable).

If value is less than 15 seconds, then the retries will be scheduled at second level granularity.

If value is greater than 15 secs, then granularity is 1 minute.

Max Retry Attempts

The maximum times retry is attempted for a rule.

Default value is 3 attempts.

BackoffAlgorithm

Determines the actual delay between retry attempts.

You can use the following option:

Constant Interval: Uses the configured retry interval for delay of all retry attempts.

Name

Name of the Rule Retry Profile.

Max Retry Interval (seconds)

Enter the maximum time in seconds between the first and the last retry.

If set to zero, the PCRF will not enforce a time limit for sending the retry messages.

Default is 0.

Rule Failure Code

Select the failure codes for which CPS will retry.

If no Rule Failure Code is specified CPS will retry regardless of the failure code reported.

Code

Required unique name for the template.

Description

Optional field to contain a brief description of the template's use case.

Units

The choice of units determines functionality options within the system. For example, Time units such as seconds or minutes will cause the system to behave differently than Data units like Bytes or Megabytes. Additionally, currency is an option and can be used to account for usage credit in a direct manner.

Default value is Bytes.

Limiting Balance

Limiting Balance refers to a Balance template that is used by a shared balance template. This establishes a link from the shared balance to a limit balance, so that Balance Manager knows which two balance codes it needs to reserve/charge against in the shared per user limit use case.

Error On Provision With Non Zero Balance

If a provisioning request is made when there is remaining balance, then the balance module throws an error and does not provision the quota.

Default value is False (unchecked).

Thresholds

Code

Unique name for the threshold object.

Amount

An integer representing the amount of quota that will trigger the threshold notification.

Type

Unit of calculation.

For example, Percentage or Bytes.

Group

Thresholds can be associated with each other as a group. When thresholds are grouped by name, only messages for the first (top to bottom in the table in Policy Builder) threshold breached in the given threshold group will be returned.

Trigger On Remaining

This inverts the threshold function. A threshold is calculated against the usage. For example, if a threshold is defined for 80%, by default that means 80% of quota used or 20% remaining. If the Trigger on Remaining check box is selected, then the function inverts and a threshold defined as 80% would trigger when 80% of the quota remains.

Code

Unique name that identifies the quota template.

Description

Optional field to contain a brief description of the template's use case.

Amount

A default provisioning amount which can be overridden at the initial provision time via API or Policy configuration.

Priority

Priority ranks the template such that when the Balance module is determining the next credit to use for reservations and debits, the template with the highest rank (Positive number Integer) wins. The highest rank is 1 and the default of no value is lowest priority. After priority, the most recent end date (Next to Expire) is used to determine the next credit.

Default value is null.

Validity Period Amount

Integer used in conjunction with the Validity Period to determine the length of time for which the quota is valid.

Default value is 30.

Validity Period Units

Value used in conjunction with the Validity Period Amount to determine the length of time for which the quota is valid.

Stackable

When selected the One Time quota becomes stackable. The general idea is that it is possible to provision a Stackable Quota multiple times, but only one instance will be active at any given time. The other instances will stack up or queue behind the active one waiting to be used.

Default value is False (unchecked).

Thresholds

Code

Unique name for the threshold object.

Amount

An integer representing the amount of quota that will trigger the threshold notification.

Type

Unit of calculation like Percentage or Bytes.

Group

Thresholds can be associated with each other as a group. When thresholds are grouped by name, only messages for the first (top to bottom in the table in Policy Builder) threshold breached in the given threshold group will be returned.

Trigger on Remaining

This inverts the threshold function. A threshold is calculated against the usage. For example, if a threshold is defined for 80%, by default that means 80% of quota used or 20% remaining. If the Trigger on Remaining check box is selected, then the function inverts and a threshold defined as 80% would trigger when 80% of the quota remains.

Code

Unique name that identifies the quota template.

Description

Optional field to contain a brief description of the template's use case.

Amount

A default provisioning amount which can be overridden at the initial provision time via API or Policy configuration.

Priority

Priority ranks the template such that when the Balance module is determining the next credit to use for reservations and debits, the template with the highest rank (positive number integer) wins. The highest rank is 1 and the default of no value is lowest priority. After priority, the most recent end date (next to expire) is used to determine the next credit.

Default value is null.

Recurrence Frequency Amount

Integer used in conjunction with the Recurrence Frequency to determine the refresh period.

Default value is 1.

Recurrence Frequency

Value used in conjunction with the Recurrence Frequency Amount to determine the refresh period.

Default value is Months.

Rollover Quota

A Rollover Quota Template that the recurring quota will rollover unused quota to when the quota refreshes for the next recurrence period.

Calendar Type

MsBM supports both the Gregorian and Hijra calendar. The Hijri calendar is the Islamic calendar which is a moon-phase based calendar.

Default value is Gregorian.

Recurrence Limit

Integer that determines the duration for a recurring quota. When set to 0, the duration is infinite. When set to any positive number, the quota will refresh that number of times and then stop. For example, if the Recurrence Frequency is set to 1 Month, and the Recurrence Limit is set to 6, then the quota will refresh 6 times. If the quota is provisioned on January 1st, it will expire on June 30th.

Default value is 0.

Auto Rollover (If checked, recurrence frequency must be >= 1 day)

When selected, automatically roll unexpired quota over into a Rollover quota when the refresh occurs.

Default value is False (unchecked).

Use Rollover Expiration Time for Change Priority

When selected, the Balance module will use the sum of recurring quota template's credit end date and the rollover credit's end date to determine priority for which credit to debit in the normal processing of charges.

Default value is False (unchecked).

Thresholds

Code

Unique name for the threshold object.

Amount

An integer representing the amount of quota that will trigger the threshold notification.

Type

Unit of calculation.

For example, Percentage or Bytes.

Group

Thresholds can be associated with each other as a group. When thresholds are grouped by name, only messages for the first (top to bottom in the table in Policy Builder) threshold breached in the given threshold group will be returned.

Trigger On Remaining

This inverts the threshold function. A threshold is calculated against the usage. For example, if a threshold is defined for 80%, by default that means 80% of quota used or 20% remaining. If the Trigger on Remaining check box is selected, then the function inverts and a threshold defined as 80% would trigger when 80% of the quota remains.

Code

Unique name that identifies the quota template.

Description

Optional field to contain a brief description of the template's use case.

Priority

Priority ranks the template such that when the Balance module is determining the next credit to use for reservations and debits, the template with the highest rank (Positive number Integer) wins. The highest rank is 1 and the default of no value is lowest priority. After priority, the most recent end date (Next to Expire) is used to determine the next credit.

Default value is null.

Validity Period Amount

Integer used in conjunction with the Validity Period to determine the length of time for which the quota is valid.

Default value is 30.

Validity Period Units

Value used in conjunction with the Validity Period Amount to determine the length of time for which the quota is valid.

Default value is Days.

Maximum Rollover Amount

The maximum amount of quota that can be rolled over at any one time.

Quota Maximum Amount

The total amount of rollover the quota can contain.

Thresholds

Code

Unique name for the threshold object.

Amount

An integer representing the amount of quota that will trigger the threshold notification.

Type

Unit of calculation.

For example, Percentage or Bytes.

Group

Thresholds can be associated with each other as a group. When thresholds are grouped by name, only messages for the first (top to bottom in the table in Policy Builder) threshold breached in the given threshold group will be returned.

Trigger On Remaining

This inverts the threshold function. A threshold is calculated against the usage. For example, if a threshold is defined for 80%, by default that means 80% of quota used or 20% remaining. If the Trigger on Remaining check box is selected, then the function inverts and a threshold defined as 80% would trigger when 80% of the quota remains.

Code

Name of the code.

Timezone

Select timezone based on the place of business.

For example, America/New_York

Tariff Switch Times

Enables you to change usage rates for a subscriber.

Name

Readable name.

Start Time (hh:mm)

Enables you to set start time

End Time (hh:mm)

Enables you to set end time.

Tariff Time Identifier

Enables you to determine rates.

Associated Valid Dates

Valid Days of the Week

Enables you to associate days of the week to various tariff times, according to your business rules.

Additional Valid Dates (Holidays)

Enables you to add additional dates such as holidays.

Name

A textual description of the LDAP connection. This should be something easily recognizable as the name of the LDAP server containing the subscriber profiles.

Use Asynchronous Operations

This should be is checked (true). Setting to unchecked (false) can result in unpredictable performance and is not supported.

Name

Name of the notification message.

Badge

Default is 0 (number).

The number to display as the badge of the Apple Push Notification icon. If this property is absent, the badge is not changed. To remove the badge, set the value of this property to 0.

For example: 1, 2, 3, …

Sound

Default is "default".

The name of a sound file in the application bundle. The sound in this file is played as an alert. If the sound file does not exist or default is specified as the value, the default alert sound is played. The audio must be in one of the audio data formats that are compatible with system sounds.

For example: sound1, alert7, buzzSound_A

Send Once Per Session

Select this check box to send the notification once per session.

Custom Fields

You can add custom fields with values that can be sent to the application.

Field Name/Field Value

String

Alert (limit 163 characters)

This is the text that appears on the subscriber’s iPhone. If the message is too long, it is simply truncated. Test your messages before you place them into production.

If you want to use a string and substitute session information, use the syntax $Name to insert the receiver’s name in the email.

Alerts are limited to 160 characters. Alerts longer than that are truncated.

Name

Name of the message.

Message Encoding (DCS)

Select the required message coding from drop-down list. Valid values are ISO-8859-1, US-ASCII, UTF-16 (UCS-2) and UTF-8.

Send Once Per Session

When enabled realtime notifications are generated for each session and not for all messages within that session.

Default is checked (true).

Subject

Subject line of the email to the subscriber.

From Email Address

The From field in the email.

Reply To Email Address

Who the subscriber may reply to.

Body (Text/Plain)

The text of the email the subscriber receives in plain format.

Body (Text/Html)

The text of the email the subscriber receives in HTML format.

Name

Name of the notification message. This name is used later in the policy definition to send the SMS.

Source Address

Source address of the SMS message.

Callback Number

This is an optional field. This parameter is used to configure the callback number adhering to specification. The input format is a hexadecimal string. It will correspond to the exact hexadecimal sent in the stream.

Currently, only a single callback number is supported.

Addresses TON

Type of Number for the source. It defines the format of the phone numbers.

Values: ABBREVIATED, ALPHANUMERIC, INTERNATIONAL, NATIONAL, NETWORK_SPECIFIC, SUBSCRIBER_NUMBER, UNKNOWN.

Default value is INTERNATIONAL.

Addresses NPI

Numbering Plan Indicator. It defines the format of the addresses.

Values: DATA, ERMES, INTERNET, ISDN, LAND_MOBILE, NATIONAL, PRIVATE, TELEX, UNKNOWN, WAP.

Default value is UNKNOWN.

Message Class (DCS)

The message class per the SMPP specification. Valid values are CLASS0, CLASS1, CLASS2. Default value is CLASS1.

Message Encoding (DCS)

Defines the alphabet and byte encoding used for the message. Valid values are US-ASCII (7 bit), ISO-8859-1 (8 bit), and UTF-16 (UCS-2) which is 16 bit.

Default value is US-ASCII(7 bit).

Override Character Limit (Advanced)

Some SMSCs create multi-part messages for long SMS messages instead of having CPS create the multiple messages. This option provides such behavior by overriding the default single message size.

This option is for advanced use only. Because if space in the message submitted from CPS does not allow for header information, such as the User Data Header (UDH), then many SMSC do not accept the messages.

Send Once Per Session

When enabled realtime notifications are generated for each session and not for all messages within that session.

Default is checked (true).

Compressed (DCS)

Select this check box to set whether compression is used per the SMPP specification.

Default is false.

Contain Message Class (DCS)

Select this check box to set whether the contain message class options is used per the SMPP specification.

Default is false.

Use Plugin Config Data Coding Instead (DCS Advanced)

Select this check box when you want to use the value specified in Data Coding field in the Notifications Configuration screen instead of the Message Class, Message Encoding, Compressed, and Contain Message Class values on this screen.

Use Message Encoding with Plugin Config Data Coding (DCS Advanced)

Select this check box when the “Use Plugin Config Data Coding Instead” check box above is enabled. The check box “Use Plugin Config Data Coding Instead” must be true to use this value.

This check box allows the Message Encoding value on this screen to define the byte conversion method that is used in conjunction with the Data Coding value in the Notifications Configuration screen.

By default, the byte conversion method is US-ASCII regardless of the Plugin Configuration’s Data Coding value. Other UTF-16 conversions may use Big Endian, Little Endian or Byte Order Mark (BOM).

This field is also important for ensuring the proper division of messages, particularly for non-English languages, for multi-part SMS message support.

WAP Push Configuration (WAP Push via SMS)

Select to enable WAP Push

Message (or custom data of WAP Push via SMS)

The text that the subscriber receives.

SMS messages have character limits dependent on the selected DCS values. Text in excess of this limit triggers the submission of the multi-part messages to the SMSC.

Name

Name of the realtime notification message.

No of Retries

When CPS sends realtime notification to the provided HTTP URL and if it is not reachable then this field specifies how many times CPS should send the notification. Same is true for HTTP Fallback URL.

Default is 3.

Retry Interval (secs)

Interval during two retries.

Default is 2.

Content Type

The content type that you choose must match the template in the Payload Template field.

Default value is text/xml.

User Name

The user name for accessing the endpoint specified in the Server URL and Server Fallback URL fields.

If no user name is required, leave this field blank.

Password

The password for accessing the endpoint specified in the Server URL and Server Fallback URL fields.

If no password is required, leave this field blank.

Send Once Per Session

If checked, real-time notifications are generated for each session and not for all messages within that session.

Default value is true.

Server URL

Primary URL where CPS sends real-time notifications.

Server Fallback URL

When the Primary URL is not reachable, CPS tries to send notification to this URL for the configured No of Retries. When the number of retries are exhausted, CPS tries to send notification to the Server Fallback URL.

HTTP Post Parameter name (Keep this field if not applicable, Eg: SOAP)

For SOAP this field is not applicable and hence should be blank. This field specifies the HTTP Post parameter name.

Payload Template (Text/XML/JSON)

This field contains the payload template, so real-time notifications are generated using the configured template. CPS provides values to the fields specified in the template from the ongoing session. For all fields that are specified in the template with values found, the real-time notification is generated.

The names of the variables/placeholders defined here must match with the notification service parameter codes defined in service parameters of the corresponding use case template.

You should also ensure that the correct value retriever is selected for each notification service parameter code in the use case template.

Name

Name of the GCM notification message.

Collapse Key

String - This parameters identifies a group of messages (for example, with collapse_key: “Updates Available”) that can be collapsed, so that only the last message gets sent when delivery can be resumed. This is intended to avoid sending too many of the same messages when the device comes back online or becomes active.

Time To Live (Days)

Integer - Overrides setting in the GCM Notifications Plug-in Configuration for this message.

Default is checked (true).

Send Once Per Session

When enabled realtime notifications are generated for each session and not for all messages within that session.

Delay While Idle

When enabled it overrides setting in GCM Notifications Plug-in Configuration for this message.

Message (Text/Plain or JSON)

JSON or Plain text can be used for the templates. JSON must be a complete JSON document, not a partial document.

For example: {"json":{"id":"$id","some":"thing","someother":"$thing"}, "additional":"$replacement"} is valid but "id":"$id","some":"thing","someother":"$thing", "additional":"$replacement" is not valid because it is not a complete document.

Name

Name of the domain that describes the APN mapped to the domain node. For example, VOLTE would imply that the domain contains all VOLTE sessions. The name should be short and descriptive to find the associated business rules.

Is Default

Indicates that the domain is the default domain if the incoming message does not map to any of the other domains.

General

Authorization

Valid options that can be used in mobile configuration. For more information, see CPS Mobile Configuration Guide.

User Id Field

Set this to either Session MSISDN or Session IMSI depending on which credential is used to store the data in the SPR.

Password Field

Remove Db Lookup Key Field

This field is optional and should be used only in conjunction with USuM remote DB functionality. If this functionality is enabled, then the key field should match the user id field.

Domain Naming

Domain Prefix

Optional

Append Location

When enabled the user location will be appended with credential ID and will happen while authenticating the user on the network.

Provisioning

Defines whether auto provisioning of subscribers within the SPR should occur. This method is generally used in scenarios where the system is configured to "auto-learn" subscribers and assign a default service profile.

For more information about provisioning tab options, refer to CPS Mobile Configuration Guide.

Additional Profile Data

Enables retrieving subscriber profile from Home Subscriber Server (HSS) and LDAP/Ud Server.

Profile Mappings

External Code

Defines the attribute name to retrieve. This field should match the Code Literal field in the Sh Parsing Rules table. This represents the internal system attribute name which can be used to apply policies.

Mapping Type

Defines the mapping of the data to an internal CPS data type. Select SubscriberAttribute.

The following data types are supported:

• Service: Selecting this type will add a service to the user profile with the code returned on the HSS attribute.

• ChargingId: Selecting this type will allow the External Charging Id retriever to retrieve the HSS value. This attribute would only be used if the local balance database is enabled and provisioned with the external charging ID and the charging id is defined in the HSS.

• SubscriberAttribute: Selecting this type will add a policy derived AVP with the external code mapped to the code field and the value mapped to the value field. This attribute type is the most common type to set in the profile mappings.

• SubscriberIdentifier: Selecting this type will allow the “An external subscriber id exists” condition within a policy to return the subscriber id.

Regex Expression and Regex Group

If parsing of the incoming AVP is required then a regular expression and regular expression group can be defined to support retrieval of the parsed values.

In general, Regex Expression can be left blank and each attribute should be assigned to Regex Group number 1.

Missing Avp Value

Defines the default AVP value when subscriber attribute received from the external profile is missing.

Empty Avp Value

Defines the default AVP value when subscriber attribute received from external profile has empty or blank value.

Sh Realm

Enter the HSS Diameter realm name.

Subscribe to Notifications

When enabled CPS subscribes to HSS notifications by sending SNR and when disabled CPS will send UDR.

By default, this option is enabled.

Enable External Profile Cache Lookup

When enabled allows CPS to use subscriber profile cached in the local CPS SPR database (if available) before querying the external SPR/HSS. The fetched profile is provisioned as per the provisioning configuration in the Provisioning tab. This configuration is used to reduce the number of Sh requests (SNR/UDR) in case there are multiple Gx sessions for a single subscriber. The first Gx session initiates the Sh request and retrieves the profile and all further Gx sessions for the same subscriber lookup the local SPR database for the subscriber's profile.

Broadcast Profile Change

Select to enable triggering a broadcast message for changes in subscriber profile due to a PNR message. A broadcast message is sent only when there are multiple sessions for the same subscriber

User Identity Avp Formatting

In User Identity Avp Formatting drop down menu, select either SIPURI or TBCD. This setting configures the User-Identity AVP Format as either MSISDN TBCD encoding or SIP URI (Session Initiation Protocol Uniform Resource Identifier).

If SIPURI is selected, use the Sip Parsing Rules table to determine how the SIP URI is constructed.

Sip Parsing Rules

In the Sip Parsing Rules table, click Add to define a parsing rule.

Static

A literal String value that will be inserted into the SIP URI as is.

Dynamic

Dynamic uses the Retrievers paradigm to get dynamic data from the policy session and insert it into the SIP URI.

Service Indications

In the Service Indications table, click Add to filter users by a service indication (group) name.

If no Service Indication value is entered, the HSS will deliver data from all available service indication groups.

Sh Parsing Rules

In the Sh Parsing Rules table, click Add to define which parameters to parse from the XML provided by the HSS. Each AVP includes a Code and Value pair, and this table allows you to define which literal or dynamic XML values should be parsed from the XML file.

Code Literal

Use this field to define the literal XML element which represents the Code portion of the user’s AVP. Use this when a static value should be set.

For example: Entitlement

Code Xpath

Use this field to define a dynamic XML element which represents the Code portion of the user’s AVP. Use this when a dynamic value should be parsed.

For example: /SampleShUser/Custom[@AttributeName='BillingPlan']

To map default empty and missing value, Sh parsing rule needs to be with Code XPath:

Sample XML:

<Sh-Data>
           <RepositoryData>
           <ServiceIndication>CamiantUserData</ServiceIndication>
           <SequenceNumber>0</SequenceNumber>
           <ServiceData>
           <CamiantShUser xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="CamiantShUser.xsd">
           <Version>1.0</Version>
           <UserId Type="E164" Scope="Public">19010921003</UserId>
           <UserId Type="NAI" Scope="Private">311482310921003@nai.epc.mnc482.mcc311.3gppnetwork.org</UserId>
           <UserId Type="IMSI" Scope="Private">311482310921003</UserId>
           <Custom AttributeName="BillingPlanCode">BPC_LO3</Custom>
           <Custom AttributeName="ServiceName">ServiceA</Custom>
           </CamiantShUser>
           </ServiceData>
           </RepositoryData>
         </Sh-Data>

Value Literal

Use this field to define the literal XML element which represents the Value portion of the user’s AVP. Use this when a static value should be set.

Value Xpath

Use this field to define a dynamic XML element which represents the Value portion of the user’s AVP. Use this when a dynamic value should be parsed.

For example:

/SampleShUser/Custom[@AttributeName='4G']

Retry Interval

Select this check box to open the Retry Profile parameters.

Retry Interval

The number of minutes between retry attempts.

Max Retry Attempts

The maximum number of retries that will occur after a failed attempt.

The default value is 3 attempts.

Backoff Algorithm

The back-off algorithm is used while determining the actual delay between retry attempts. You can select from two options:

Constant_Interval: The configured Retry Interval is used (without any change) for all retry attempts.

Linear_Interval: Each retry is scheduled after the number of minutes derived from multiplying the Retry Interval by the number of attempts since the last report.

The default setting is Constant Interval.

Granularity in Seconds (Default is minutes)

When selected, the granularity of the retry interval is in seconds. By default, the check box is unchecked, that is, retry granularity is in minutes.

Retry on CCR-u

When selected, the system will attempt Sh UDR on CCR-u if the UDR is not successful during CCR-i. If the UDR is not successful, the Sh Retry Interval (if active) will be reset.

Retry on Alternate Host

When selected, the system sends the Sh retry messages to a different host in the same realm provided there are multiple hosts in the same realm.

Result Code Based Retries

• Result Code: The result codes for which Sh SNR/UDR needs to be retried by QNS. If this list is empty, the Sh SNR/UDR is retried for all 3xxx and 4xxx result codes.

• Is Experimental: Indicates that the configured result code is an experimental result code. Hence, retry happens only if the result code is received in Experimental-Result-Code AVP.

Locations

Location Matching Type

This attribute should be set to AVP value. The AVP value matching type allows the information from a Custom Reference Data table (CRD) to be used in the domain assignment.

Name

Enter a name that is equal to the logical APN.

Mapping Values

Enter mapping value equal to the CRD column code (for example, logical_apn) with a “\” and then the logical APN value.

Timezone

Timezone attribute is not used in mobility configurations and should be left blank.

Advanced Rules

Transparent Auto-Login (TAL) Type

Enables subscribers to maintain an always-on connection without the need to authenticate on each connect.

Tal with no domain

When enabled the operator allows user to auto login without including the Domain in credential.

EAP Correlation Attribute

EAP Correlation attribute will look up into the EAP reference table.

Imsi to Mac Format

When enabled the user IMSI is converted to MAC format before the user can log on to the network.

Unknown Service

Unknown service assigned to subscriber when it is not found in SPR.

Autodelete Expired Users

When enabled the expired users are deleted from SPR.

Default Service

Used when service is not found for subscriber in SPR.

Anonymous Subscriber Service

Used for Anonymous Authorization method of authentication. The service configured in this will be assigned to anonymous subscriber.

Authentication Dampening

Subscribers or unknown subscribers who tried number of failed attempts for authorization can be blocked for configurable time period with Authentication Dampening.