PreRating Callout Action Properties

You define PreRating call out actions on the PreRating Call Out Actions tab.

General Callout Action Properties describes PreRating general call out action properties.
Table 1. General Callout Action Properties
Property Description
Name A descriptive name for the callout action.
Note: You must specify a name that is unique across all the following types of actions:
  • Announcement details
  • Announcement menu actions
  • Call out actions
  • Data modify actions
Description Information about the purpose of the callout action.
External ID An optional field that can be set on MATRIXX pricing objects.
Start Date/Time The day, month, year, and time that sets when the callout action becomes activated in the Pricing Database.

For revisions, the start date defaults to the date the revision is created. Setting future start dates allows you to have several inactive revisions, with each one becoming valid as soon as the start date occurs. Only one revision can be active in the system at one time.

Query Frequency The frequency with which the query is performed if this PreRating callout action is selected during rating. Select from the following:
  • Initial Only — Performs the query only when the PreRating callout action is first selected.
  • Every Update — Performs the query after every update.
  • Based on Age — Performs the query on update only if the number of seconds since the last query is greater than Age.
Age In Seconds This field becomes available only when age is selected for the Query Frequency field.

Sets the minimum number of seconds between queries. Queries on updates are performed only if the number of seconds since the last query is greater than the Age In Seconds value.

MAP Callout Action Properties describes configuration properties specific to PreRating MAP call out actions.
Table 2. MAP Callout Action Properties
Property Description
Call Out Type The MAP callout service for the query. Select one of:
  • map_v2_plus_ati
  • map_v1_sri
  • map_v2_sri
  • map_v2_plus_sri
  • map_v2_plus_interrogate_ss
Info Query Flags

Preferred Domain

 (Applicable only if the Call Out Type is map_v2_plus_ati.)
Configures the preferred signaling network domain to query. Select the form of signaling from the following list:
  • Circuit Switched: Typically used for mobile calls.
  • Packet Switched: Used for data.
Note: The Preferred Domain field is not applicable to custom queries. Selecting the Custom flag disables this field.
Info Query Flags check boxes Select one or more check boxes for the type of information you want returned in the query results, such as subscriber location information, MNP, State, IMEI, and routing information.
Note:
  • The Interrogate Supplementary Service check box is the only check box available for map_v2_plus_interrogate_ss call outs, and is disabled for all other callout types.
  • The Force Current Location check box becomes available only when the Call Out Type is MAP ATI and Ask Subscriber Location is selected. Select Force Current Location to request a forced update of the subscriber's location.
  • Select Custom to use selective updates to customize the callout object after it is in the message. Selecting Custom disables all other Info Query Flags fields, including Preferred Domain. If you unselect Custom, and select another flag, the Custom flag is disabled.
Query Source The subscriber ID type to use in the query. For example, for queries based on the subscriber's IMSI (International Mobile Subscriber Identity) number, select IMSI. Select one of:
  • Called Station ID
  • Calling Station ID
  • Access Number
  • IMSI
  • Subscriber Name
  • Subscriber ID
  • Other
Note: When Other is selected, the value in the MtxDiamRoMsg OtherSubscriberQuerySource field is used for the source Subscriber ID. You can set the OtherSubscriberQuerySource field value in the following ways:
  • Using a data modify action in the same profile.
  • Using selective updates.
  • Using a system attribute.
  • Through a normalizer's result information.
If OtherSubscriberQuerySource is not set then the service logic raises an error.
Use Query Source For Destination Select to use the Subscriber ID from the query source as the destination Subscriber ID. This disables the Global Title Address and Nature of Address fields. Depending on the selected global title type, other global title fields might also become unavailable.
Note: When 'Other' is selected, the value in the MtxDiamRoMsg OtherSubscriberQuerySource field is used for the source Subscriber ID. You can set the OtherSubscriberQuerySource field value in the following ways:
  • Using a data modify action in the same profile.
  • Using selective updates.
  • Setting it as a system attribute.
  • From a normalizer's result information.
The service logic raises an error if OtherSubscriberQuerySource has not been set.
Timeout In Milliseconds (Optional) The number of milliseconds that the query waits for a response before timing out. Set to 0 (zero) to force a TIMEOUT result for the callout, without trying to make the callout. This triggers a follow on call to the PreRating profile generator, allowing the results of other call outs in the profile to be considered for selecting and configuring the next callout profile.

If not set, then the default timeout value defined in system configuration is used.

SS Code (Applicable only if the Call Out Type is map_v2_plus_interrogate_ss)

The code for the supplementary service or services. Specify a value in the range 0 to 255. For more information, see the discussion about SS-Code in the 3GPP TS 29.002 specification document.
Basic Service (Applicable only if the Call Out Type is map_v2_plus_interrogate_ss)
Select one of the following service types:
  • None (default). When set to None, the Basic Service Value field is unavailable.
  • Bearer Service
  • Tele Service
For more information, see the 3GPP TS 29.002 specification document.
Basic Service Value (Applicable only if the Call Out Type is map_v2_plus_interrogate_ss)

An integer value between 0 and 255 that identifies the bearer or tele service. For more information, see the 3GPP TS 29.002 specification document.
Long FTN Supported (Applicable only if the Call Out Type is map_v2_plus_interrogate_ss)

Select if the supplementary service supports Long Forward to Phone Number (Long FTN).
Routing Indicator Sets whether to route on global title or subsystem number (SSN).
Point Code (Optional) Configures the Point Code to use for routing.
Subsystem Number (Optional) Configures the subsystem number to use for routing.
Global Title Type Sets the type of the global title to use in the destination SCCP address. Select one of:
  • No Global Title (GTI=0000)
  • 1. GTI=0001 — Use digits and nature of address.
  • 2. GTI=0010 — Use digits and translation type.
  • 3. GTI=0011 — Use digits, translation type, and numbering plan.
  • 4. GTI=0100: Use digits, translation type, numbering plan, and nature of address
Note: The availability of each of the following global title fields depends on the selected global title type, as defined in the ITU standard Q.713.
Global Title Address Sets the global title digits to use in the destination SCCP address.
Translation Type Sets the translation type of the global title. Specify a value in the range 0 to 255.
Numbering Plan Sets the numbering plan of the global title. Specify a value in the range 0 to 15:
  • 0 — Unknown.
  • 1 — ISDN/telephony numbering plan (ITU-T E.163 and E.164).
  • 2 — Generic numbering plan.
  • 3 — Data numbering plan (ITU-T X.121).
  • 4 — Telex numbering plan (ITU-T F.69).
  • 5 — Maritime mobile numbering plan (ITU-T E.210, E.211).
  • 6 — Land mobile numbering plan (ITU-T E.212).
  • 7: ISDN/mobile numbering plan (ITU-T E.214)
  • All other values are spare or reserved.
Nature of Address Sets the nature of address of the global title. Specify a value in the range 0 to 127:
  • 0 — Unknown
  • 1 — Subscriber
  • 3 — National
  • 4 — International
  • All other values are spare or reserved.
LDAP Callout Action Properties describes the properties, in addition to general call out properties, for configuring LDAP call out actions.
Table 3. LDAP Callout Action Properties
Property Description
Call Out Type Select the ldap_v3 call out type.
Query Source The subscriber ID type to use in the query. For example, for queries based on the subscriber's IMSI (International Mobile Subscriber Identity) number, select IMSI. Select one of:
  • Called Station ID
  • Calling Station ID
  • Access Number
  • IMSI
  • Subscriber Name
  • Subscriber ID
  • Other
Note: When Other is selected, the value in the MtxDiamRoMsg OtherSubscriberQuerySource field is used for the source Subscriber ID. You can set the OtherSubscriberQuerySource field value in the following ways:
  • Using a data modify action in the same profile.
  • Using selective updates.
  • Using a system attribute.
  • Through a normalizer's result information.
If OtherSubscriberQuerySource is not set then the service logic raises an error.
Destination Server A string that identifies the destination server to use for the LDAP request from a list of available LDAP servers. This populates the LdapRequest.DestinationServer field in the MtxCallOutRequestData MDC).
Configure the destination server only to send LDAP requests to a specific URL. The destination server string must be mapped to the IP for the LDAP server in the gateway configuration section in the ldap_gateway.yaml file. For example, the following extract defines destination server mapping for a FINANCE destination server and a GENERAL destination server: 
gateway:
  destinationServerMap:
    - paramMdc: FINANCE
      paramLdap: ldap://129.1.1.1:10389
    - paramMdc: GENERAL
      paramLdap: ldap://129.1.1.2:10389
Note: You do not need to specify the destination server if you are using only one LDAP server for LDAP requests or if LDAP requests can be sent to any of the available LDAP servers.
Request String A string that identifies the LDAP request to use. This populates the LdapRequest.Request.RequestString field in the MtxCallOutRequestData MDC.
The request string is used to communicate with a custom Java plug-in containing business logic for constructing different LDAP requests and formatting LDAP responses.
Note: Do not specify a request string if your LDAP requests are handled by the ldap.search_filter field in the ldap-gateway.yaml file.
Custom Query Data Type The MtxLdapRequestExtensionData MDC type or one of its descendants.

Sets the MDC type used in the MtxCallOutRequestData.LdapRequest.Request field. The descriptor index of the selected MDC sets the MtxCallOutRequestData.LdapRequest.request.ExtensionKey field.
Timeout In Milliseconds (Optional) The number of milliseconds that the query waits for a response before timing out. Set to 0 (zero) to force a TIMEOUT result for the callout with no attempt being made to make the callout. This triggers a follow on call to the PreRating profile generator, allowing the results of other callouts in the profile to be considered for selecting and configuring the next callout profile.

If not set, then the default timeout value defined in system configuration is used.