CAMEL Gateway General Configuration

You use configuration parameters in create_config.py to define general configuration for MATRIXX CAMEL Gateway.

Sample CAMEL Gateway General Configuration

CAMEL Gateway General Configuration describes the create_config.py parameters necessary for configuring general CAMEL Gateway behavior and shows example values for each parameter.
Table 1. CAMEL Gateway General Configuration
Parameter Description Example Value
Enable Per-Engine Routing Answer y to enable CAMEL Gateway to Network Enabler routing configuration per engine. When set to y, you must answer configuration questions for links, routes, and policy per engine. When set to n (default), CCF uses the same CAMEL Gateway to Network Enabler routing for all engines.

create_config.info question: Do you want to configure per-engine routing (y/n)?

n
SCCP Subsystem Numbers Comma separated list of SCCP Subsystem Numbers (SSNs) to activate at start-up for SSN routing.

create_config.info question: What are the SSNs to activate?

146
Number of Links The number of links from each processing server to Network Enablers. If you enter 0 (zero), the processing servers auto-configure one link to each Network Enabler and you are not required to answer questions on CAMEL Gateway link configuration.

create_config.info question: How many links do you want?

0
Maximum Transaction Rate — For incoming voice transactions The maximum number of incoming CAP voice call related transactions that CCF can process per second, depending on the system size, and taking into account any allowable server failures. (A CAP transaction is a single incoming CAP message and response.) If the transaction rate exceeds this value, the system is considered overloaded, and CCF rejects TCAP BEGIN messages until the transaction rate decreases to below this value and the system is no longer considered overloaded. TCAP CONTINUE and TCAP END messages are still processed.

create_config.info question: How many CAP Transactions per second is this system sized for?

1000
SMS Message Rate — For immediate charging. The expected number of incoming CAP InitialDP SMS messages per second using immediate charging, depending on system size, and taking into account any allowable processing server failures. For example, the system uses SMS Message Rate to determine the number of TCAP transaction objects and for setting internal queue sizes. It is also used to perform overload protection. Do not specify a message rate that exceeds the level for the size of the system.

create_config.info question: How many CAP SMS per second, using immediate charging, is this system sized for?

0
SMS Message Rate — Using unit reservation charging. The expected number of incoming CAP InitialDP SMS messages per second using unit reservation charging, depending on system size, and taking into account any allowable processing server failures. The system uses the specified value to perform overload protection. Do not specify a message rate that exceeds the level for the system size.

create_config.info question: How many CAP SMS per second, using unit reservation, is this system sized for?

500
CAP Transaction Average The average number of CAP transactions expected per call for all call types. (A CAP transaction is a single incoming CAP message and response.) This value, specified as an integer or a floating point value, determines the maximum number of voice calls allowed in progress on the system at one time.

If reauthorization is enabled, then an additional transaction is required.

create_config.info question: Camel Gateway:What is the average number of CAP transactions per call?

2
Call Hold Time The average number of seconds duration for a call (for all call types). The minimum value is 0.

create_config.info question: Camel Gateway:What is the average call hold time in seconds?

60
MAP Call Outs Per Second The maximum number of outgoing MAP call out requests a processing server can send per second, depending on system size, and taking into account any allowable server failures. Specify a value that includes all MAP call outs (for both voice calls and data sessions). By default, one MAP call out per CAP voice call is assumed. Enter 0 (zero) if no MAP call outs are required.
Note: Sizing calculations use this value.

create_config.info question:Camel Gateway:How many MAP call outs per second will there be?

2750
MAP callout Response Time The average time allowed, in milliseconds, for a response to a MAP callout request, for any callout type. This question is asked only if MAP Call Outs Per Second is set to a value that is greater than 0.

create_config.info question:Camel Gateway:What is the average response time for MAP call outs in milliseconds?

1000
USSD Queries Per Second The maximum number of incoming USSD queries that a processing server can handle per second, depending on system size, and taking into account any allowable server failures. Specify a value that includes all USSD requests (including any that are a result of call back). Include any USSD notifications that are a result of USSD queries in the USSD Notifications Per Second value.
Note: Sizing calculations use this value.

create_config.info question:Camel Gateway:How many incoming USSD queries per second will there be?

0
USSD Notifications Per Second The maximum number of outgoing USSD notifications that a processing server can send per second (taking into account any failures), depending on system size. Include additional notifications due to USSD queries, but do not include responses to USSD queries.
Note: Sizing calculations use this value.

create_config.info question:Camel Gateway:How many outgoing USSD notifications per second will there be?

0
CAP4 Call Backs Per Second The maximum number of outgoing CAP4 call backs that a processing server can send per second (taking into account any failures), depending on system size. Specify a value that includes call backs triggered by any source. Callbacks triggered by USSD must also be included in the USSD Queries Per Second value.
Note: Sizing calculations use this value.

create_config.info question:Camel Gateway:How many CAPv4 call backs per second will there be?

0
Maximum Reorigination Call Rate
The expected maximum call rate, per second, for the Temporary Service Access Number (TSAN) reorigination service for reoriginated CAP1 calls.
Note: TSANs are telephony numbers that are predefined by the operator and used by the CCF TSAN reorigination service to reoriginate CAP1 calls using CAP2, CAP3, or CAP4. For more information, see the discussion of CAP1 reorigination using TSANs in MATRIXX Call Control Framework Integration.

To use the TSAN reorigination service and enable additional TSAN reorigination service configuration options, specify a positive nonzero value. For information about the additional options, see the discussion about TSAN reorigination service configuration properties.

create_config.info question: Camel Gateway:What is the rate of reorigination calls per second for the TSAN service?

0
Maximum Number of Correlation IDs The maximum number of correlation ID objects to allow in the database per sub-domain.

create_config.info question: What is the maximum number of correlation ID objects per sub-domain?

10000
Maximum USSD Message Length Sets the maximum number of octets that an Unstructured Supplementary Service Data (USSD) notification message can have. If the USSD notification is longer than the configured maximum, it is truncated.
Note: You define USSD notifications in USSD notification templates. For more information about defining notification templates, see MATRIXX Notification Framework in MATRIXX Integration.

create_config.info question: What is the maximum number of USSD octets to allow in a USSD message?

160
USSD Query Service Codes The list of operator defined service codes for USSD queries. Enter a comma separated list of up to 20 numbers.
Note: In the USSD string, the service code prefixes the ID of the item to query. For example, a subscriber could enter *123*12 on their handset, where 123 is the service code for USSD balance queries and 12 identifies the balance to query.

create_config.info question: Enter a list of USSD query service codes?

121,123
USSD Query Service Subscriber Source For USSD queries, specifies the list of subscriber sources to search for in the incoming Process-UnstructuredSS-Request message. The first source found in the list determines the primary subscriber to associate the call with. Enter a comma separated list of subscriber sources in search order priority. Valid values are:
  • UssdParameterMsisdn
  • MapOpenMsisdn
  • MapOpenImsi
Note: The MapOpenMsisdn or MapOpenImsi is derived from the MAP-OPEN destinationReference parameter.

create_config.info question: What subscriber sources are required for the USSD query service?

MapOpen Imsi
USSD Query Service Rule Set The name of the rule set that the USSD query service uses for number normalization or denormalization. To use the default rule set, enter default.

create_config.info question: What rule set should be used for number normalization for the USSD query service?

default
Overload Behavior The action to take when CAMEL Gateway is overloaded and a TCAP BEGIN message is received. Valid values are:
  • abort — Send a TCAP ABORT response message.
  • error — Send a CAP Return Error response.
  • ignore — Ignore the call.

create_config.info question: Camel Gateway:What behavior is required under overload?

abort
Advanced Options Advanced configuration options are disabled by default. Answer y to enable additional configuration options to:
  • Force rating of failed and non-chargeable calls and SMS.
  • Concatenate the local area code (LAC) and call ID.
  • Arm EDPs as interrupted instead of notifyAndContinue.
  • Send ReleaseCall instead of Continue on receipt of an EventReportBCSM(request) for which eventTypeBCSM is not o/tAnswer for calls using the CAP2 or CAP3 protocols.
  • Store the application context and call reference for a call or SMS attempt to custom MDC fields.
  • Use alternative message sequences.

create_config.info question: Camel Gateway:Do you wish to configure advanced options (y/n)?

n
Custom MDC Name The name of the custom MDC that inherits fields from MtxDiamRoMsg and that you want to customize to include parameters relevant for rating CAP and TCAP services. Enter a blank response or none if a custom MDC is not required.

create_config.info question: Camel Gateway:Which custom MDC should be used for rating CAMEL Messages?

If you define selective updates to occur after rating but before CCF sends TCAP messages to the network, then specify MtxTcapMsg when you answer the following question:

SelectiveUpdate:ChargingServer:ToTransactionServer: Element 1:What is the container's name?MtxTcapMsg

Note: MtxTcapMsg includes the private MDC or MtxDiamRoMsg in the field named RatingMsg. You specify selective updates for RatingMsg fields in the following way:

main:RatingMsg.field_name

For example:
SelectiveUpdate:ChargingServer:
ToTransactionServer:Element 1:SelectionKey 1:
What is the field's name? main:RatingMsg.Result
See the discussion about configuring selective updates in MATRIXX Installation and Upgrade for more information.
none
Zero Rating Custom Field Advanced configuration option to force zero rating for failed and non-chargeable voice calls and SMS per voice charging or SMS service. The service determines how to apply rating based on the value in a field named ZeroCharge in the custom MDC for rating CAP and TCAP services.

This configuration becomes available only when you specify the name of the private MDC to use in Private MDC Name and answer y to the following question:

Do you wish to configure advanced options (y/n)?

To use the ZeroCharge field, answer y (yes) to the following question:

create_config.info question: Camel Gateway: Do you want to use the ZeroCharge field in the private TCAP/CAP MDC to indicate forced zero quantity rating?

For failed and non-chargeable voice calls and SMS, when the ZeroCharge value is set to:
  • 0 — The service sends Accounting:stop(0) or Accounting:single_event(0) to MATRIXX Engine and typical charging rules are applied.
  • 1 — The service sends Accounting:stop(1) or Accounting:single_event(1) to MATRIXX Engine, a MEF is generated but no charging is applied.
Note: You must set up rating so that no charge is applied when the value of ZeroCharge is not 0 (zero). For information about rating set up, see MATRIXX Pricing and Rating.
n
LAC and Call ID Custom Field Advanced configuration option to concatenate the Local Area Code (LAC) and Cell ID parameter values. CAMEL Gateway stores the concatenated value in a field named LacAndCi in the custom MDC for rating CAP and TCAP services. The concatenated value can be used by MATRIXX Engine during call rating. It has the following format: LAC|Cell_ID.

This configuration becomes available only when you specify the name of the private MDC to use in Private MDC Name and answer y to the following question:

Note: You must add a string field named "LacAndCi" in the custom MDC.

Do you wish to configure advanced options (y/n)?

To use the LacAndCi field, answer y (yes) to the following question: create_config.info question: Camel Gateway: Do you want to use the LacAndCi field in the private TCAP/CAP MDC to store a combined LAC+CI value?

n
Store Application Context This configuration becomes available only when you specify the name of the private MDC to use in Private MDC Name and answer y to the following question:

Do you wish to configure advanced options (y/n)?

Stores the application context from a TCAP BEGIN(IDP or IDPSMS) message to a field named ApplicationContext in the private MDC for rating TCAP and CAP services.
Note: You must add a string field named "ApplicationContext" in the custom MDC, with a maximum length of 50 characters.

To use the ApplicationContext field, answer y to the following create_config.info question.

Do you want to use the ApplicationContext field in the private TCAP/CAP MDC to store the application context from TCAP BEGIN(IDP or IDPSMS)(y/n)?

n
Store Call Reference Number This configuration becomes available only when you specify the name of the private MDC to use in Private MDC Name and answer y to the following question:

Do you wish to configure advanced options (y/n)?

Stores the call reference number from an IDP or IDPSMS message to a field named CallReferenceNumber in the private MDC for rating TCAP and CAP services.
Note: You must add a field named "CallReferenceNumber" in the custom MDC. The CallReferenceNumber field must be one of the following types:
  • String, maximum length 21 characters.
  • Unsigned integer 64.
It must match the format specified for Call Reference Number Format.
To use the CallReferenceNumber field, answer y to the following create_config.info question.

Do you want to use the CallReferenceNumber field in the private TCAP/CAP MDC to store the call reference number from TCAP BEGIN(IDP or IDPSMS)(y/n)?

n
Call Reference Number Format This configuration becomes available only when you specify the name of the private MDC to use in Private MDC Name and answer y to the following question:

Do you wish to configure advanced options (y/n)?

Sets the format to use for the CallReferenceNumber field in the private TCAP/CAP MDC. Valid values are:
  • 1: integer
  • 2: decimal_digit_string
  • 3: hex_digit_string
  • 4: bcd_digit_string
Note: If the Call Reference Number Format is integer, then the CallReferenceNumber MDC field must be an unsigned integer 64 field, otherwise it must be a string field.

What format should be used for the CallReferenceNumber field in the private TCAP/CAP MDC?

1 (Integer)
Allow TCAP END with Components (Voice) Answer y to configure CCF to send TCAP END with components, for example: TCAP END(ReleaseCall) or TCAP END(Continue), in the final message of a voice TCAP transaction. This is the default behavior.

Answer n, if you want CCF to always send TCAP CONTINUE with components and then assume a pre-arranged end.

create_config.info question: Allow Camel Gateway to send TCAP END with components in the final message of a voice TCAP transaction (y/n)?

y
Allow TCAP END With Components (SMS) Answer y to allow CCF to send TCAP END with components, for example: TCAP END(ReleaseSMS or ContinueSMS), in the final message of an SMS TCAP transaction. This is the default behavior

Answer n if you want CCF to always send TCAP CONTINUE with components and then assume a pre-arranged end.

create_config.info question: Camel Gateway:Allow Camel Gateway to send TCAP END with components in the final message of an SMS TCAP transaction (y/n)?

y
Country Code The default ISO country phone code for the operator. Enter the phone number digits for the country or 'none'. For example:
  • 1 for United States
  • 44 for United Kingdom

create_config.info question: Camel Gateway:What country code should be used?

1
National Number Prefix
The default prefix to use for dialed national numbers. Enter the phone number digits or none; for example:
  • none for national calls from United States.
  • 0 for national calls from United Kingdom.

create_config.info question:

none
International Number Prefix
The default prefix to use for dialed international numbers. Enter the phone number digits or 'none'; for example:
  • 011 for international calls from United States.
  • 00 for international calls from United Kingdom.

create_config.info question: What is the default phone number prefix for internationally dialled numbers?

011

Example CAMEL Gateway General Configuration

The following example create_config.info section shows CAMEL Gateway general configuration based on the example values in CAMEL Gateway General Configuration.
What are the SSNs to activate?146
How many links do you want?0
How many CAP Transactions per second is this system sized for?1000
How many CAP Transactions per second is this system sized for?0
How many CAP SMS per second, using immediate charging, is this system sized for?500
What is the average number of CAP transactions per call?2
What is the average call hold time in seconds?60
What is the rate of reorigination calls per second for the TSAN service?0
How many MAP call outs per second will there be?2750
What is the average response time for MAP call outs in milliseconds?1000
How many incoming USSD queries per second will there be?0
How many outgoing USSD notifications per second will there be?0
How many CAPv4 call backs per second will there be?0
What behavior is required under overload?abort
Do you wish to configure advanced options (y/n)?n
Which custom MDC should be used for rating CAMEL Messages?none
Allow Camel Gateway to send TCAP END with components in the final message of a voice TCAP transaction (y/n)?
Allow Camel Gateway to send TCAP END with components in the final message of an SMS TCAP transaction (y/n)?
What country code should be used?1
What is the default phone number prefix for national numbers?none
What is the default phone number prefix for internationally dialled numbers?011