Create an LDAP Callout Action

Create an LDAP callout action to define callout request parameters for querying subscriber information held on an LDAP server.

About this task

Perform this task to define how to handle queries to an external database using the LDAP protocol. For information about defining request parameters for queries using the Mobile Application Part (MAP) protocol, see the discussion about creating a MAP callout action.

Procedure

  1. In PreRating, on the Call Out Actions tab, click New Call Out Action.
  2. In Create New PreRating Call Out Action:
    1. In Name, enter a unique name.
      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
    2. (Optional) In Description, enter descriptive information about the item.
    3. (Optional) In External ID, enter any alphanumeric character to serve as a unique ID on this pricing object. The external ID can be used for any reason that is meaningful to your implementation of MATRIXX Engine. External IDs are saved to the pricing configuration file and loaded into the Pricing database.
    4. Click Create.
  3. In Start Date/Time, use the date picker to select the date on which the object becomes active in the Pricing database and is first available for use, or enter the date in the format YYYY-MM-DD. Optionally, enter a time for when the object becomes active. The default start date/time is 2000–01–01 00:00:00. If applicable, the range in which the start date/time must fall is listed. For example:
    • Select a date on or before 2021–12–01.
    • Select a date on or after 2020–01–27.
    • Select a date between 2000–01–02 and 2021–10–04.
    Note: If you are creating a new revision of this object, the start date/time must be after the start date/time of the preceding revision and before the start date/time of the next revision. If you are making a copy of this object, the start date/time is not copied. The new object is the first revision, so it has the default start date/time of 2000–01–01 00:00:00.
  4. In Query Frequency select 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.
  5. (Set only if Query Frequency is set to Based on Age) In Age In Seconds specify the minimum number of seconds between queries.
  6. In Call Out Type, select ldap_v3.
  7. In Query Source, select 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.
  8. In Destination Server, enter 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.
    For information about the ldap_gateway.yaml file, see the discussion about the LDAP gateway properties in MATRIXX Call Control Framework Integration.
  9. In Request String, enter the 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.
  10. In Custom Query Data Type, select 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.
  11. (Optional) In Timeout In Milliseconds specify the number of milliseconds that the query waits for a response before timing out.
  12. Click Save.
  13. (Optional) Click New Revision to create a new revision of this PreRating call out action.