82 Pipeline Manager iScripts
This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) Pipeline Manager iScripts.
ISC_AddCBD
The ISC_AddCBD iScript prepares EDRs for rerating in the backout pipeline.
Note:
The ISC_AddCBD iScript is a deprecated module but remains in BRM for backward compatibility.
Dependencies
This module runs in its own backout pipeline for rerating.
For more information, see "Function Module Dependencies".
Sample Registry
AddCBD { ModuleName = FCT_IScript Module { Active = TRUE Source = FILE Scripts { AddCBD { FileName = ./iScriptLib/iScriptLib_Standard/ISC_AddCBD.isc } } }
Modified Output Container Fields
The ISC_AddCBD iScript creates one associated charge breakdown record of type 981 with charge packets of type 680.
EDR Container Fields
Table 82-1 lists the ISC_AddCBD EDR container fields.
Table 82-1 ISC_AddCBD EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_PIN.ACCOUNT_POID |
String |
Read |
Contains the BRM account POID. |
DETAIL.ASS_PIN.BP.PIN_INFO_STRING |
String |
Read |
Contains the string that stores aggregated balance packet information. |
DETAIL.ASS_PIN.BP.PIN_AMOUNT |
Decimal |
Read/Write |
Contains the monetary balance impact. |
DETAIL.ASS_PIN.BP.PIN_DISCOUNT |
Decimal |
Read/Write |
Contains the discount value |
DETAIL.ASS_CBD.ACCOUNT_CODE |
String |
Write |
Contains the account code related to charge packet being constructed. |
DETAIL.ASS_CBD.RECORD_TYPE |
String |
Write |
Contains the record type of charge packet. |
DETAIL.ASS_CBD.CP |
Data Block |
Write |
Charge packet data block. |
DETAIL.DISCOUNT_KEY |
String |
Write |
Contains the discount key. |
DETAIL.ASS_CBD.CP.DP |
Data Block |
Write |
Charge breakdown discount packet data block. |
ISC_ApplyTax
The ISC_ApplyTax iScript is used in the reprice pipeline during Incollect processing. This iScript retrieves the taxation flag value for the specific network operator from the in-memory cache. If the taxation flag is set to on, the tax amount is passed to the subscriber; otherwise, the tax amount is ignored.
Dependencies
This iScript requires the DAT_InterConnect module and the iScript extension IXT_OpFlag, which provide network operator configuration information that is accessed by ISC_ApplyTax.
For more information, see "Function Module Dependencies".
Sample Registry
ApplyTaxIScript { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { ApplyTaxIScript { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_ApplyTax.isc } } } }
EDR Container Fields
Table 82-2 lists the ISC_ApplyTax EDR container fields.
Table 82-2 ISC_ApplyTax EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_VALUE |
Decimal |
Read/Write |
Contains the charge amount value. |
DETAIL.ASS_ROAMING_EXT.SENDER |
String |
Read |
Contains the sender PLMN of the Transferred Account Procedure (TAP) file. |
ISC_BACKOUTTypeSplitting
The ISC_BACKOUTTypeSplitting iScript is used by the backout pipeline for backout-only rerating. It determines if the EDRs are flagged for backout-only rerating and sends the EDRs to different output streams based on the event types.
ISC_CiberInputValidation
The ISC_CiberInputValidation iScript performs record-level validations of CIBER records.
Dependencies
Because erroneous CIBER records can be discarded, this module must run before the FCT_Discard module.
For more information, see "Function Module Dependencies".
ISC_CiberOutputMapping
The ISC_CiberOutputMapping iScript adds charge data to the ASSOCIATED_CIBER_EXTENSION block of the EDR. If the EDR does not contain an ASSOCIATED_CIBER_EXTENSION block, this iScript adds one.
Dependencies
This module must run after the FCT_MainRating module and the ISC_PostRating iScript.
For more information, see "Function Module Dependencies".
Sample Registry
ISC_CiberOutputMapping { ModuleName = FCT_IScript Module { Active = TRUE Source = FILE Scripts { CiberOutputMapping { AirRum = AIR TollRum = TOL OCCRum = OCC FileName = ./iScriptLib/iScriptLib_Standard/ISC_CiberOutputMapping.isc } } } }
EDR Container Fields
Table 82-3 lists the ISC_CiberOutputMapping EDR container fields.
Table 82-3 ISC_CiberOutputMapping EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_CURRENCY |
String |
Read |
Specifies the currency type. |
CURRENCY_TYPE |
String |
Write |
Specifies the currency type. |
DETAIL.ASS_CBD.CP.RUM |
String |
Read |
Checked to see if the EDR contains a toll charge. |
TOLL_NETWORK_CARRIER_ID |
String |
Write |
If the EDR contains a toll charge, this is set to 99001, otherwise it is set to 00000. |
AIR_CHARGE Set only for CIBER record type 22 (specified in DETAIL.ASS_CIBER_EXT.CIBER_RECORD_TYPE). |
String |
Write |
If the value of AIR_CHARGABLE_TIME in the CIBER extension block is 0, AIR_CHARGE is also set to 0. Otherwise, it is set to the sum of the DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_VALUE in each charge packet for which all of the following statements are true:
Note: If the value of DETAIL.ASS_CIBER_EXT.SPECIAL_FEATURES_USED in the CIBER extension block is F, then AIR_CHARGE is always set to 0.0. The Special Features Used value is set in the CIBER input grammar. |
AIR_RATE_PERIOD Set only for CIBER record type 22 (specified in DETAIL.ASS_CIBER_EXT.CIBER_RECORD_TYPE). |
String |
Write |
If the value of AIR_CHARGE is 0, this field is set to 00. Otherwise, this field is set to 01. Note: If the value of DETAIL.ASS_CIBER_EXT.SPECIAL_FEATURES_USED in the CIBER extension block is F, then AIR_CHARGE is always set to 0.0, and therefore AIR_RATE_PERIOD is set to 00. The value of AIR_RATE_PERIOD is generally derived from the time interval code in the charge packet where RUM equals the value of the AirRum registry parameter. The time interval code is part of the time model that you define. Therefore, the fields used to derive the CIBER extension AIR_RATE_PERIOD field is specific to your customization. |
AIR_MULTIRATE_PERIOD Set only for CIBER record type 22 (specified in DETAIL.ASS_CIBER_EXT.CIBER_RECORD_TYPE). |
N/A |
Write |
If the value of AIR_CHARGE is 0, this field is set to 0. Otherwise, this field is set to 1. Note: If the value of DETAIL.ASS_CIBER_EXT.SPECIAL_FEATURES_USED in the CIBER extension block is F, then AIR_CHARGE is always set to 0.0, and therefore AIR_MULTIRATE_PERIOD is set to 0. The value of AIR_MULTIRATE_PERIOD is generally derived from the time interval code in the charge packet where RUM equals the value of the AirRum registry parameter. The time interval code is part of the time model that you define. Therefore, the fields used to derive the CIBER extension AIR_RATE_PERIOD field is specific to your customization. |
TOLL_CHARGE Set only for CIBER record type 22 (specified in DETAIL.ASS_CIBER_EXT.CIBER_RECORD_TYPE). |
N/A |
Write |
If the value of AIR_CHARGABLE_TIME in the CIBER extension block is 0, TOLL_CHARGE is also set to 0. Otherwise, it is set to the sum of the DETAIL.ASS_CBD.CHARGED_AMOUNT_VALUE in each charge packet for which all of the following statements are true:
|
TOLL_RATE_PERIOD (for CIBER record type 22 only) |
N/A |
Write |
If the value of TOLL_CHARGE is 0, this field is set to 00. Otherwise, this field is set to 01. The value of TOLL_RATE_PERIOD is generally derived from the time interval code in the charge packet where RUM equals the value of the TollRum registry parameter. The time interval code is part of the time model that you define. Therefore, the fields used to derive the CIBER extension TOLL_RATE_PERIOD field are specific to your customization. |
TOLL_MULTIRATE_PERIOD (for CIBER record type 22 only) |
N/A |
Write |
If the value of TOLL_CHARGE is 0, this field is set to 0. Otherwise, this field is set to 1. The value of TOLL_MULTIRATE_PERIOD is generally derived from the time interval code in the charge packet where RUM equals the value of the TollRum registry parameter. The time interval code is part of the time model that you define. Therefore, the fields used to derive the CIBER extension TOLL_MULTIRATE_PERIOD field are specific to your customization. |
TOLL_RATE_PERIOD and TOLL_MULTIRATE_PERIOD (for CIBER record type 32 and 42 only) Sets these Charge NO 1 related fields:
|
N/A |
Write |
Charge NO 1 is set to the value of DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_VALUE. The values for the other Charge NO 1 related fields are based on the CIBER record type: Record type 32:
Record type 42:
|
ISC_CiberRejectReason
The ISC_CiberRejectReason iScript sets a reason code in the CIBER extension block for records that are rejected for one of the following reasons:
-
They are duplicates.
-
There is no roaming agreement with the network operator.
ISC_ConsolidatedCP
The ISC_ConsolidatedCP iScript is used in the Incollect settlement pipeline and the Outcollect settlement pipeline. This iScript removes all non '00' impact category charge packets.
The TAP input grammar creates individual charge packets as well as consolidated charge packets. However, the FCT_BillingRecord module considers all charge packets for creating balance packets. For this reason, the individual charge packets (non '00' impact category charge packets) are removed and only consolidated charge packets are considered so that the balance amounts in the balance packets are correct.
This iScript also assigns the G/L ID to each consolidated charge packet based on the GL_CODE registry entry.
Registry Parameters
Table 82-4 lists the ISC_ConsolidatedCP registry parameter.
Table 82-4 ISC_ConsolidatedCP Registry Parameter
Registry Parameter | Description | Mandatory |
---|---|---|
GL_CODE |
Specifies the G/L ID used for tracking the balance impacts of roaming usage events. |
Yes |
Sample Registry
ConsolidatedCP { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { ConsolidatedCPIScript { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_ConsolidatedCP.isc GL_CODE = 1514 } } } }
EDR Container Fields
Table 82-5 lists the ISC_ConsolidatedCP EDR container fields.
Table 82-5 ISC_ConsolidatedCP EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.CP.IMPACT_CATEGORY |
String |
Read |
Contains the impact category of the charge packet. |
DETAIL.ASS_CBD.CP.RUM_ID |
Long |
Write |
Contains the RUM ID. |
DETAIL.ASS_CBD.CP.USAGE_GL_ACCOUNT_CODE |
String |
Write |
Contains the G/L account. |
DETAIL.ASS_CBD.TP.RELATED_CHARGE_INFO_ID |
Integer |
Write |
Contains the corresponding charge packet index. |
ISC_DupRAPRecords
The ISC_DupRAPRecords iScript is used in the RAP processing pipeline. It duplicates severe and fatal TAP records so that the records can be routed to multiple output streams.
Registry Parameters
Table 82-6 lists the ISC_DupRAPRecords registry parameter.
Table 82-6 ISC_DupRAPRecords Registry Parameter
Registry Parameter | Description | Mandatory |
---|---|---|
NULLStream |
Specifies the DevNull output stream. See "OUT_DevNull". |
Yes |
Sample Registry
DupRAPRecords { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { DupRAPRecords { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_DupRAPRecords.isc NULLStream = DevNull } } } }
EDR Container Fields
Table 82-7 lists the ISC_DupRAPRecords EDR container fields.
Table 82-7 ISC_DupRAPRecords EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ERROR_REJECT_TYPE |
String |
Write |
FCT_Reject uses this to reject the detail to a stream other than the standard reject stream. |
DETAIL.ASS_ROAMING_EXT.RAP_RECORD_TYPE |
String |
Read |
RAP record type. |
ISC_EDRToTAPOUTMap
The ISC_EDRToTAPOUTMap iScript is used to populate standard values to fields in the output TAP file based on its corresponding value in the EDR container. This is because for some fields EDR might have different internal representations and the TAP specification may ask for different representation for the same fields.
This iScript has to be customized by the user for mapping fields and specifying what is the internal EDR representation for the TAP fields specified value given in the standards document.
Note:
The ISC_EDRToTAPOUTMap iScript is a deprecated module but remains in BRM for backward compatibility.
Sample Registry
ISC_EDRToTAPOUTMap { ModuleName = FCT_IScript Module { Active = TRUE Source = FILE Scripts { EDRToTAPOUTMap { FileName = ./iScriptLib/iScriptLib_Standard/ISC_EDRToTAPOUTMap.isc } } } }
EDR Container Fields
Table 82-8 lists the ISC_EDRToTAPOUTMap EDR container fields.
Table 82-8 ISC_EDRToTAPOUTMap EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.CP.DAY_CODE |
String |
Read / Write |
External Day Code as estimated and used by the rating process. Sample mapping given in the script: (Can be customized as per user's requirement) WEEKDAY => N WEEKEND => P ALLDAYS => I |
DETAIL.ASS_CBD.CP.TIME_INTERVAL_CODE |
String |
Read / Write |
External Time Interval Code as estimated and used by the rating process. Sample mapping given in the script (Can be customized as per user's requirement): 20012 - O 20021 - I 20031 - P 20032 - O 20033 - O 20001 - P 0002 - S 20003 - S 20004 - S 20011 - P |
DETAIL.ASS_CBD.CP.RUM |
String |
Read / Write |
Classifies the charging part of a call in an intercarrier relationship, for interconnection or roaming. Sample mapping given in the script (Can be customized as per user's requirement): DUR - D SND - V REC - W EVT - E AIR - D OCC - F |
ISC_FirstProductRealtime
This iScript sets the validity period of charge offers that start on first usage when they are used for the first time to rate an event in the real-time rerating pipeline.
Note:
To process first-usage events in the batch rating pipeline, use the FCT_FirstUsageNotify module.
Dependencies
Place this iScript in the real-time rerating pipeline before the FCT_DiscountAnalysis module.
For more information, see "Function Module Dependencies".
Sample Registry
FirstProductRealtime { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { FirstProductRealtime { FileName = ./iScriptLib/iScriptLib_Standard/ISC_FirstProductRealtime.isc } } } }
EDR Container Fields
Table 82-9 lists the ISC_FirstProductRealtime EDR container fields.
Table 82-9 ISC_FirstProductRealtime EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.CUST_A.INTERN_FOUND_PP_INDEX |
Decimal |
Read |
Contains an index of the customer's purchased charge offers that were used for rating. |
DETAIL.CUST_A.PRODUCT.FIRST_USAGE_INDICATOR |
Decimal |
Read |
Specifies whether the charge offer is configured to start when first used and the first-usage validity period status. |
DETAIL.CUST_A.ACCOUNT_PARENT_ID |
String |
Read |
Specifies the customer account POID. |
DETAIL.CUST_A.PRODUCT.OFFERING_POID |
String |
Read |
Specifies the account's charge offer POID. |
DETAIL.CUST_A.PRODUCT.SERVICE_ID |
String |
Read |
Specifies the charge offer's service POID. |
DETAIL.CUST_A.PRODUCT.SERVICE_TYPE |
String |
Read |
Specifies the charge offer's service type. |
DETAIL.CHARGING_START_TIMESTAMP |
Date |
Read |
Specifies the EDR's start timestamp. |
DETAIL.EVENT_ID |
Decimal |
Read |
Specifies the event POID. |
DETAIL.EVENT_TYPE |
String |
Read |
Specifies the event type. |
DETAIL.UTC_TIME_OFFSET |
String |
Read |
Specifies the UTC time offset. |
DETAIL.REFRESH_BALANCE |
Decimal |
Write |
Specifies whether the account's charge offer validity period has been updated in the BRM database. If set, the discount module retrieves the updated balance information before evaluating discounts for the event. |
ISC_GetCamelFlag
The ISC_GetCamelFlag iScript is used in the roaming outcollect processing to retrieve the CAMEL flag information for a roaming partner. The CAMEL flag information is used during EDR processing.
Dependencies
The ISC_GetCamelFlag iScript must run before the FCT_PreRating module in the outcollect rating pipeline.
For more information, see "Function Module Dependencies".
ISC_GetResourceBalance
The ISC_GetResourceBalance iScript is used to get the memory balance of a balance element. This iScript returns either the balance amount or '0' if the balance retrieval is successfull. If a failure occurs, it returns '-1'.
The iScript should be in the same function pool and added after FCT_ApplyBalance in the batch pipeline.
ISC_LeastCost
The ISC_LeastCost iScript performs the following:
-
Calculates and finds the lowest charge for an EDR. See "About Least Cost Rating".
-
Calculates the total savings between the charge for a promotional charge offer and the charge for the lowest priority (base) charge offer. See "About Calculating the Promotional Savings".
Dependencies
This module must run after FCT_CustomerRating.
For more information, see "Function Module Dependencies".
Registry Parameters
Table 82-10 lists the ISC_LeastCost registry parameters.
Table 82-10 ISC_LeastCost Registry Parameters
Registry Parameter | Description | Mandatory |
---|---|---|
Resource |
Specifies the balance element type that this module uses to calculate any savings amount. |
Yes |
Resource_ID |
Specifies the balance element IDs used to identify the balance element used when calculating the savings amount. |
Yes |
Sample Registry
FCT_LeastCostRating { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { myScript { FileName = ./ISC_LeastCost.isc Resource = "Saving Charge Resource" Resource_ID = "1000100" } } } }
EDR Container Fields
Table 82-11 lists the ISC_LeastCost EDR container fields.
Table 82-11 ISC_LeastCost EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_VALUE |
Integer |
Read/write |
The amount charged to the customer. |
DETAIL.ASS_CBD.DP.AMOUNT |
Integer |
Read |
The amount of discount between the amount charged to the customer, and a greater amount that could have been charged. |
DETAIL.ASS_CBD.CP.RATEPLAN_CODE |
String |
Read |
The code identifying the least cost rating charge. |
DETAIL.CUST_A.PRODUCT.RATEPLAN_NAME |
String |
Read |
A description of the least cost rating charge code. |
DETAIL.CUST_A.PRODUCT_PRIORITY |
String |
Read |
Contains a list of the priorities for all charge offers that are associated with the same service and event. |
DETAIL.CUST_A.INTERN_RATING_PRODUCTS |
String |
Write |
Contains the charge offer rating indexes. This is a comma-separated list of all rating charge offers' indexes associated with the same service and event, and their priorities. |
DETAIL.ASS_CBD.CP.RESOURCE |
String |
Write |
The balance element to impact for reporting promotional savings. |
DETAIL.ASS_CBD.CP.RESOURCE_ID |
Integer |
Write |
The ID of the balance element to impact for promotional savings. |
DETAIL.ASS_CBD.CP.RESOURCE_TYPE |
Integer |
Write |
The savings charge packet to impact. This is 992 by default. |
ISC_MapNetworkOperatorInfo
The ISC_MapNetworkOperatorInfo iScript maps the DETAIL.SOURCE_NETWORK field to the PIN_FLD_ORIGIN_NETWORK field and the DETAIL.DESTINATION_NETWORK field to the PIN_FLD_DESTINATION_NETWORK field of the opcode input block for the corresponding event.
ISC_Migration
Use the ISC_Migration iScript during account migration to automatically flag EDRs for suspension. The FCT_Suspense module can then route the EDRs to a separate suspense output stream.
ISC_MiscOutcollect
The ISC_MiscOutcollect iScript is used in the Outcollect rating pipeline. This module adds BASIC_SERVICE and SUPPLEMENTARY_SERVICE blocks to the EDR container for GSM services. This is done to ensure that the TAP file generated by the pipeline contains all the required information.
For GPRS services, this module adjusts the record number field in the GPRS extension block to 0.
It also modifies the RUM field of the charge packets as follows:
-
DUR is replaced by D.
-
SND is replaced by V.
-
REC is replaced by W.
Sample Registry
MiscAddInfo { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { MiscAddInfoIScript { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_MiscOutCollect.isc } } } }
EDR Container Fields
Table 82-12 lists the ISC_MiscOutcollect EDR container fields.
Table 82-12 ISC_MiscOutcollect EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_GSMW_EXT.BS_PACKET.RECORD_TYPE |
String |
Write |
Contains the record type field. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.RECORD_NUMBER |
Integer |
Write |
Contains the record number field. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.CHAIN_REFERENCE |
String |
Write |
Contains the call reference. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.LONG_DURATION_INDICATOR |
String |
Write |
Contains whether the call is a long duration or not. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.BASIC_SERVICE |
String |
Write |
Contains the basic service of the call. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.QOS_REQUESTED |
String |
Write |
Contains the QOS requested. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.QOS_USED |
String |
Write |
Contains the QOS used. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.CHARGING_START_TIMESTAMP |
Date |
Write |
Contains the call start time. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.CHARGING_END_TIMESTAMP |
Date |
Write |
Contains the call end time. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.WHOLESALE_CHARGED_AMOUNT_VALUE |
Decimal |
Write |
Contains the total charged amount value of the call. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.WHOLESALE_CHARGED_TAX_RATE |
Decimal |
Write |
Contains the tax rate. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.SPEECH_VERSION_REQUESTED |
String |
Write |
Contains the speech version requested. |
DETAIL.ASS_GSMW_EXT.BS_PACKET.SPEECH_VERSION_USED, |
String |
Write |
Contains the speech version used. |
DETAIL.ASS_GSMW_EXT.SS_PACKET.RECORD_TYPE |
String |
Write |
Contains the record type. |
DETAIL.ASS_GSMW_EXT.SS_PACKET.RECORD_NUMBER |
Integer |
Write |
Contains the record number. |
DETAIL.ASS_GSMW_EXT.SS_PACKET.SS_EVENT |
String |
Write |
Contains the event type. |
DETAIL.ASS_GSMW_EXT.SS_PACKET.ACTION_CODE |
String |
Write |
Contains the connect type. |
DETAIL.ASS_CBD.CP.RUM |
String |
Read/Write |
Contains the ratable unit of measurement. |
DETAIL.ASS_GPRS_EXT.RECORD_NUMBER |
Integer |
Write |
Contains the record number. |
ISC_Monitoring
The ISC_Monitoring iScript records latencies for authentication, authorization, and accounting requests.
Dependencies
The ISC_Monitoring iScript depends on the ISC_StartTime iScript.
For more information, see "Function Module Dependencies".
Registry Parameters
Table 82-13 lists the ISC_Monitoring registry parameters.
Table 82-13 ISC_Monitoring Registry Parameters
Registry Parameter | Description | Mandatory |
---|---|---|
FileName |
Specifies the location of the ISC_Monitoring iScript. |
Yes |
recordsPerFile |
Specifies the number of records per event log file. |
Yes |
recordsPerWrite |
Specifies the number of records per write operation. |
Yes |
eventLogDir |
Specifies the directory for the event log file. |
Yes |
Sample Registry
MonitoringPlugIn { ModuleName = FCT_IScript Module { Active = True Source = FILE Scripts { ReadIScript { FileName = ./iScriptLib/AAA/ISC_Monitoring.isc recordsPerFile = 1000 # number of records per event log file recordsPerWrite = 10 # number of records per write operation eventLogDir = ./log/dump # directory for series of event log file } } } }
EDR Container Fields
Table 82-14 lists the ISC_Monitoring EDR container fields.
Table 82-14 ISC_Monitoring EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.MILLISEC_TIME |
Integer |
Read |
Specifies the latency time in milliseconds. |
DETAIL.OPCODE_NUM |
Integer |
Read |
Number of the BRM opcode that performs the requested action. |
ISC_NRTRDE_ErrorReport
The ISC_NRTRDE_ErrorReport iScript is used during roaming incollect processing by the NRTRDE processing pipeline. This iScript collects the validation errors in the EDRs and creates error records in the Pipeline Manager database. It also collects NRTRDE file processing information and creates file processing records in the Pipeline Manager database. Information stored in the validation and file processing records in the database are used for generating NRTRDE reports.
Dependencies
The ISC_NRTRDE_ErrorReport iScript must run after the ISC_NrtrdeHeaderValidation iScript.
For more information, see "Function Module Dependencies".
Registry Parameters
The registry parameter is FileName. It is mandatory. FileName specifies the location of the iScript. The default location is:
./iScriptLib/iScriptLib_Roaming/ISC_NRTRDE_ErrorReport.isc
ISC_NRTRDE_EventSplit
The ISC_NRTRDE_EventSplit iScript is used by roaming outcollect processing to duplicate and route EDRs to the corresponding roaming partner's NRTRDE output streams based on the roaming partner's NRTRDE flag.
Dependencies
The ISC_NRTRDE_EventSplit iScript must run after the FCT_EnhancedSplitting module in the outcollect rating pipeline.
For more information, see "Function Module Dependencies".
Registry Parameters
Table 82-15 lists the ISC_NRTRDE_EventSplit registry parameters.
Table 82-15 ISC_NRTRDE_EventSplit Registry Parameters
Registry Parameter | Description | Mandatory |
---|---|---|
FileName |
Specifies the location of the ISC_NRTRDE_EventSplit iScript. The default location is: ./iScriptLib/iScriptLib_Roaming/ISC_NRTRDE_EventSplit.isc |
Yes |
NRTRDE_STREAM_PATTERN |
Specifies the name of the NRTRDE stream pattern. This parameter appends the PLMN to the NRTRDE stream pattern to retrieve the output stream name. |
Yes |
ISC_NrtrdeHeaderValidation_v2_01
The ISC_NrtrdeHeaderValidation_v2_01 iScript is used during roaming incollect processing by the NRTRDE processing pipeline. This iScript validates the information in the header record of the TD35 file based on the TD35 specifications.
Dependencies
The ISC_NrtrdeHeaderValidation_v2_01 iScript must run before any other modules in the NRTRDE processing pipeline.
For more information, see "Function Module Dependencies".
Registry Parameters
The registry parameter is FileName. It is mandatory. FileName specifies the location of the iScript. The default location is:
./iScriptLib/iScriptLib_Tap3Validation/ISC_NrtrdeHeaderValidation_v2_01.isc
ISC_ObjectCacheTypeOutputSplitter
Use the ISC_ObjectCacheTypeOutputSplitter iScript to enter a value in an EDR to create two identical output files from a single input EDR and write them to separate output streams.
Dependencies
To use this iScript, you must have object cache residency distinction enabled in your system.
Requires a connection to the DAT_BalanceBatch module.
For more information, see "Function Module Dependencies".
ISC_OverrideRateTag
The ISC_OverrideRateTag iScript is used in the outcollect settlement pipelines to populate the RATE_TAG field with the value of the NRTRDE flag in the balance impact.
The value of the RATE_TAG field is used by high-usage reports to filter out NRTRDE operator data from the report.
Dependencies
The ISC_OverrideRateTag iScript must run after the FCT_BillingRecord module in the outcollect settlement pipeline.
For more information, see "Function Module Dependencies".
ISC_OverrideSuspenseParams
The ISC_OverrideSuspenseParams iScript overrides some fields in the Suspense Extension block of the EDR container that is set by Suspense Manager.
During Outcollect processing, this iScript in the RAP Processing pipeline overrides the PIPELINE_NAME suspense field. For severe TAP records, PIPELINE_NAME is set to the name of the outcollect rating pipeline. For fatal TAP records, PIPELINE_NAME is set to the Suspense Batch output stream.
Registry Parameters
Table 82-16 lists the ISC_OverrideSuspenseParams registry parameters.
Table 82-16 ISC_OverrideSuspenseParams Registry Parameters
Registry Parameter | Description | Mandatory |
---|---|---|
TAPFilePrefix |
Specifies the prefix of the TAP file.
|
Yes |
TAPOutCollectPipeline |
Specifies the name of the outcollect rating pipeline. |
Yes |
TAPCorrectionPipeline |
Specifies the path of the directory from which the original TAP file was sent to the network operator. |
Yes |
TAPSentArchivePath |
Specifies the path of the directory from which the original TAP file was sent to the network operator. |
Yes |
SBRStream |
Specifies the output stream that generates the suspense batch file. |
Yes |
Sample Registry
OverrideSuspenseParams { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { OverrideSuspenseParams { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_OverrideSuspenseParams.isc TAPFilePrefix = CD TAPOutCollectPipeline = TAPOutCollectPipeline TAPCorrectionPipeline = TAPCorrectionPipeline #the following path must be absolute TAPSentArchivePath = ./data/outcollect/tapout/sent SBRStream = SBROutput } } } }
EDR Container Fields
Table 82-17 lists the ISC_OverrideSuspenseParams EDR container fields.
Table 82-17 ISC_OverrideSuspenseParams EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_ROAMING_EXT.TAP_FILE_SEQ_NO |
Integer |
Read |
Sequence number of the TAP file. |
DETAIL.ASS_ROAMING_EXT.RAP_RECORD_TYPE |
String |
Read |
RAP record type. |
DETAIL.BATCH_ID |
String |
Write |
Records the TAP batch ID. |
DETAIL.ORIGINAL_BATCH_ID |
String |
Write |
Records the TAP batch ID. |
DETAIL.ASS_SUSPENSE_EXT.SUSPENDED_FROM_BATCH_ID |
String |
Write |
Records the TAP batch ID. |
DETAIL.ASS_SUSPENSE_EXT.SOURCE_FILENAME |
String |
Write |
Records the TAP file name. |
DETAIL.ASS_SUSPENSE_EXT.PIPELINE_NAME |
String |
Write |
For a severe error, records the TAP outcollect rating pipeline name. For a fatal error, records the TAP correction pipeline name. |
DETAIL.ASS_SUSPENSE_EXT.RECYCLE_KEY |
String |
Write |
Records the RAP file sequence number. |
DETAIL.ASS_ROAMING_EXT.TAP_FILE_PATH |
String |
Write |
The path of the directory from which the original TAP file was sent to the network operator (Only for fatal errors). |
DETAIL.ASS_ROAMING_EXT.SUSPENSION_TIME |
Date |
Write |
(Only for fatal errors) Suspension time of the TAP file. |
ISC_PopulateOpcodeandUtilBlock_Diameter
The ISC_PopulateOpcodeandUtilBlock_Diameter iScript adds an opcode block in the EDR. In the Dispatcher pipeline, the EDR is duplicated to handle failover. The ISC_PopulateOpcodeandUtilBlock_Diameter iScript improves the performance by reducing the time taken to duplicate the EDR. Also, it provides the flexibility of performing minor validations. This iScript populates the opcode block and other relevant fields like OPCODE_NODE and OPCODE_NUMBER, which are required by the TimeoutRouter pipeline.
Dependencies
This iScript must be called before calling FCT_Opcode.
For more information, see "Function Module Dependencies".
ISC_PostRating
The ISC_PostRating iScript adds all the retail and wholesale charges and puts them in the DETAIL.RETAIL_CHARGED_AMOUNT_VALUE and DETAIL.WHOLESALE_CHARGED_AMOUNT_VALUE fields.
See "Billing Consolidation with CIBER Roaming and Revenue Assurance".
Dependencies
This module must run:
-
After rating modules FCT_CustomerRating, FCT_PreRating, and FCT_MainRating
or
-
After the FCT_ExchangeRate module
For more information, see "Function Module Dependencies".
Sample Registry
PostRating { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { PostRating { FileName = ./ISC_PostRating.isc RetailRecordType = 981 RetailResource = DEM RetailPricemodelType = S RetailCurrencyType = R WholesaleRecordType = 990 WholesaleResource = DEM WholesalePricemodelType = S WholesaleCurrencyType = R } } } }
EDR Container Fields
Table 82-18 lists the ISC_PostRating input EDR container fields.
Table 82-18 ISC_PostRating Input EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.RECORD_TYPE |
String |
N/A |
Contains the charge breakdown record type (retail or wholesale). |
DETAIL.ASS_CBD.CP.RESOURCE |
String |
N/A |
Contains the charge breakdown balance element type. |
DETAIL.ASS_CBD.CP.PRICEMODEL_TYPE |
String |
N/A |
Contains the charge breakdown pricing. |
DETAIL.ASS_CBD.CP.CHARGED_CURRENCY_TYPE |
String |
N/A |
Contains the charge breakdown currency type for charged amount. |
DETAIL.ASS_CBD.CP.IMPACT_CATEGORY |
String |
N/A |
Contains the charge breakdown impact category. |
DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_CURRENCY |
String |
N/A |
Contains the charge breakdown currency type for charged amount. |
DETAIL.ASS_CBD.CP.CHARGED_TAX_TREATMENT |
String |
N/A |
Contains the charge breakdown tax treatment type. |
DETAIL.ASS_CBD.CP.CHARGED_AMOUNT_VALUE |
Decimal |
N/A |
Contains the charge breakdown charged amount. |
Table 82-19 lists the ISC_PostRating output EDR container fields.
Table 82-19 ISC_PostRating Output EDR Container Fields
Alias field name Default field name | Type | Access | Description |
---|---|---|---|
DETAIL.RETAIL_IMPACT_CATEGORY |
String |
N/A |
Contains the retail impact category. |
DETAIL.RETAIL_CHARGED_AMOUNT_VALUE |
Decimal |
N/A |
Contains the retail charged amount value. |
DETAIL.RETAIL_CHARGED_AMOUNT_CURRENCY |
String |
N/A |
Contains the retail charged amount currency. |
DETAIL.RETAIL_CHARGED_TAX_TREATMENT |
String |
N/A |
Contains the retail charged amount tax treatment. |
DETAIL.WHOLESALE_IMPACT_CATEGORY |
String |
N/A |
Contains the wholesale impact category. |
DETAIL.WHOLESALE_CHARGED_AMOUNT_VALUE |
Decimal |
N/A |
Contains the wholesale charged amount value. |
DETAIL.WHOLESALE_CHARGED_AMOUNT_CURRENCY |
String |
N/A |
Contains the wholesale charged amount currency. |
DETAIL.WHOLESALE_CHARGED_TAX_TREATMENT |
String |
N/A |
Contains the wholesale charged amount tax treatment. |
ISC_ProfileAnalyzer
For each EDR, the ISC_ProfileAnalyzer iScript compares the telephone numbers or other relevant data in EDRs with the ERAs that the customer's service owns. ISC_ProfileAnalyzer stores each ERA label that matches the relevant EDR container field.
The iScript adds the label names to the EDR container field DETAIL.PROFILE_LABEL_LIST. If there are multiple names, the names are separated by a comma by default. You can change the separator character in the registry. If a label name contains a comma, you need to change the separator character.
Dependencies
ISC_ProfileAnalyzer depends on the ERA values populated by FCT_Account. It must be run after FCT_Account and before any rating modules in the pipeline.
For more information, see "Function Module Dependencies".
Sample Registry
ProfileAnalyzer { ModuleName = FCT_IScript Module { Active = True Source = FILE Scripts { ProfileAnalyzer { ServiceType = TEL ProfileName = FRIENDS_FAMILY LabelSeparator = , FileName = ./iScriptLib/iScriptLib_Standard/ISC_ProfileAnalyzer.isc } } } }
EDR Container Fields
The ISC_ProfileAnalyzer iScript uses the EDR container fields listed in Table 82-20:
Table 82-20 ISC_ProfileAnalyzer EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
PROFILE_LABEL_LIST DETAIL. PROFILE_LABEL_LIST |
String |
Write |
Contains unique profile labels when the profile attributes match an EDR container field used for comparison to find F&F list. |
DETAIL.CUST_A.PRODUCT. ERA.LABEL |
String |
Read |
Contains a label associated with the service: for example, MYFAMILY. |
DETAIL.CUST_A.SHARED_PROFILE_LIST. ERA.LABEL |
String |
Read |
Contains a label associated with the service profile from a shared profile. |
ERA.PROFILE |
String |
Read |
Contains the profile name: for example, "Friends&Family." |
CUST_A. SHARED_PROFILE_LIST |
Block |
Read |
Contain the profiles that the service owns or shares as a member of a profile sharing group. |
CUST_B.SHARED_PROFILE_LIST |
Block |
Read |
Contain the profiles that the service owns or shares as a member of a profile sharing group. |
CUST_A. SHARED_PROFILE_LIST .ERA |
Block |
Read |
Contains shared ERA information. |
CUST_B.SHARED_PROFILE_LIST.ERA |
Block |
Read |
N/A |
ERA.NAME |
String |
Read |
Contains the profile attribute name. |
ERA.VALUE |
String |
Read |
Contains the profile attribute value. |
ISC_ProfileLabel
The ISC_ProfileLabel iScript is used when rating CDRs based on ERAs. It determines whether the ERA profiles specified in the ProfileName registry entry match the EDR field value and populates the DETAIL.PROFILE_LABEL_LIST field with the ERA labels of the matching ERAs, and the DETAIL.USAGE_TYPE field with appropriate usage type for the ERA.
Dependencies
The ISC_ProfileLabel iScript must run after the FCT_Account module and before any rating modules.
Requires a connection to DAT_AccountBatch. This iScript works only in batch rating.
For more information, see "Function Module Dependencies".
Registry Parameters
Table 82-21 lists the ISC_ProfileLabel registry parameters.
Table 82-21 ISC_ProfileLabel Registry Parameters
Registry Parameter | Description | Mandatory |
---|---|---|
ProfileName |
Specifies the name of the ERA profile to analyze. |
Yes |
LabelSeparator |
ERA labels in the DETAIL.PROFILE_LABEL_LIST EDR field are separated using this delimiter. The default is a comma (,). |
No |
FileName |
Specifies the location of the ISC_ProfileLabel iScript. The default location is ./iScriptLib/iScriptLib_Standard/ISC_ProfileLabel.isc. |
Yes |
Sample Registry
ProfileLabel { ModuleName = FCT_IScript Module { Active = True Source = FILE Scripts { ProfileLabel { ProfileName = FRIENDS_FAMILY LabelSeparator = , FileName = ./iScriptLib/iScriptLib_Standard/ISC_ProfileLabel.isc } } } }
EDR Container Fields
Table 82-22 list the ISC_ProfileLabel EDR container fields.
Table 82-22 ISC_ProfileLabel EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
CUST_A_INTERN_PP_INDEX DETAIL.CUST_A.INTERN_FOUND_PP_INDEX |
Integer |
Read |
Contains an index of the customer's purchased charge offers identified by the FCT_Account module. |
CUST_A.ACCOUNT_PARENT_ID DETAIL.CUST_A.ACCOUNT_PARENT_ID |
String |
Read |
Account ID of the service for which usage is getting rated. |
CUST_A.PRODUCT.SERVICE_ID DETAIL.CUST_A.PRODUCT.SERVICE_ID |
String |
Read |
Service ID for which usage is getting rated. |
B_NUMBER DETAIL.B_NUMBER |
String |
Read |
Called number of the event. |
BDR_CHARGING_START_TIMESTAMP DETAIL.CHARGING_START_TIMESTAMP |
Date |
Read |
Contains the event's starting timestamp. The timezone information of this timestamp is stored in the BDR_UTC_TIME_OFFSET field. |
BDR_UTC_TIME_OFFSET DETAIL.UTC_TIME_OFFSET |
String |
Read |
Contains the UTC time offset that normalizes the charging start timestamp to the UTC tim zone. All validity timestamps in the BRM customer data are stored in normalized UTC time. The format is +/– HHMM. |
PROFILE_LABEL_LIST DETAIL.PROFILE_LABEL_LIST |
String |
Write |
Contains ERA labels that contain a value that matches the EDR field value. |
USAGE_TYPE DETAIL.USAGE_TYPE |
String |
Write |
Contains the usage type for the ERA. |
ISC_RAP_0105_InMap
The ISC_RAP_0105_InMap iScript copies TAP data from staging fields in the EDR container to business fields in the EDR container. This iScript is used during roaming outcollect processing.
Dependencies
This should be the first module in the FunctionPool.
For more information, see "Function Module Dependencies".
ISC_RemoveASSCBD
The ISC_RemoveASSCBD iScript is used in the Outcollect rating pipeline to remove associated charge breakdown packets associated with RAP records that are recycled to the pipeline during RAP file processing.
Sample Registry
RemoveASSCBD { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { RemoveASSCBDIScript { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_RemoveASSCBD.isc } } } }
EDR Container Fields
Table 82-23 lists the ISC_RemoveASSCBD EDR container fields.
Table 82-23 ISC_RemoveASSCBD EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_CBD.RECORD_NUMBER |
Integer |
Read/Write |
Contains the record number. |
ISC_RollbackSettlement
During roaming incollect and outcollect settlement processing, the ISC_RollbackSettlement iScript checks for errors in the EDR. When there is an error, it notifies the Transaction Manager to roll back the transactions in the settlement pipeline. The Transaction Manager then notifies the FCT_BatchSuspense module to suspend the entire input file.
ISC_SetAndValidateBatchInfo
The ISC_SetAndValidateBatchInfo iScript populates and validates the batch related fields for the EDR container.
The iScript validates the HEADER.BATCH_ID. If it does not exist, the entire batch is rejected. If it exists, then it copies the HEADER.BATCH_ID to DETAIL.BATCH_ID.
If DETAIL.EVENT_ID is missing in an EDR, the EDR is rejected.
Dependencies
This iScript must be placed at the beginning of the pipeline so that the batch ID is inserted before any further processing of the mediation batches. It should be used only if you do not use Suspense Manager.
For more information, see "Function Module Dependencies".
Registry Entries
Table 82-24 lists the ISC_SetAndValidateBatchInfo registry entries.
Table 82-24 ISC_SetAndValidateBatchInfo Registry Entries
Entry | Description | Mandatory |
---|---|---|
ValidateOriginalBatchId |
|
Yes |
KeepBatchIds |
|
Yes |
Sample Registry
SetAndValidateBatchInfo {  ModuleName = FCT_IScript    Module   {    Active = True    Source = FILE        Scripts   {    SetAndValidateBatchInfo    {     FileName = ./iScriptLib/iScriptLib_Standard/ISC_SetAndValidateBatchInfo.isc     ValidateOriginalBatchId = TRUE     KeepBatchIds = TRUE     }    }   } }
ISC_SetEDRStatus
The ISC_SetEDRStatus iScript sets the EDR status to Success, Suspense, Duplicate, Discard, or Skipped for each EDR.
Dependencies
This iScript must be used before FCT_AggreGate and before the scenario that collects audit data grouped on the EDRStatus field.
For more information, see "Function Module Dependencies".
ISC_SetOutputStream
The ISC_SetOutputStream iScript sets the Output Stream to TelOut, SMSOut, GPRSOut, RejectOut, or DuplicateOut for each EDR.
Dependencies
This iScript must be used after FCT_Reject, because it is dependent on the fields set in FCT_Reject, and before the scenario that collects audit data grouped on the OutputStream field.
For more information, see "Function Module Dependencies".
ISC_SetRevenueFigures
The ISC_SetRevenueFigures iScript collects the previous and current charged and discount amount for a configured balance element ID.
Dependencies
This iScript must run after rating and discounting and before FCT_AggreGate.
For more information, see "Function Module Dependencies".
Registry Parameters
Table 82-25 lists the ISC_SetRevenueFigures registry parameter.
Table 82-25 ISC_SetRevenueFigures Registry Parameter
Registry Parameter | Description | Mandatory |
---|---|---|
ResourceId |
Specifies the balance element for which you want to calculate the discount value. |
Yes |
Sample Registry
SetRevenueFigures {  ModuleName = FCT_IScript  Module  {   Active = True   Source = FILE   Scripts  {    SetRevenueFigures    {    FileName = ./iScriptLib/iScriptLib_Standard/ISC_SetRevenueFigures.isc    ResourceId = 978    }   }  } }
ISC_SetRevenueStream
The ISC_SetRevenueStream iScript sets the Revenue Stream to Retail, Wholesale, Roaming, or Unknown for each EDR.
Dependencies
This iScript must be used before FCT_AggreGate and after post rating (after the EDRs are rated).
For more information, see "Function Module Dependencies".
ISC_SetSvcCodeRTZoning
For each EDR, the ISC_SetSvcCodeRTZoning iScript finds the service type and updates DETAIL.INTERN_SERVICE_CODE EDR field with the customized service code value.
Sample Registry
SetSvcCodeRTZoning { ModuleName = FCT_IScript Module { Active = True Source = FILE Scripts { SetSvcCodeRTZoning { FileName = ./iScriptLib/iScriptLib_Standard/ISC_SetSvcCodeRTZoning.isc } } } }
EDR Container Fields
Table 82-26 lists the ISC_SetSvcCodeRTZoning EDR container fields.
Table 82-26 ISC_SetSvcCodeRTZoning EDR Container Field
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.INTERN_SERVICE_CODE |
String |
Write |
Contains the service type of the current EDR. |
ISC_StartTime
The ISC_StartTime iScript is used to request the start time.
Sample Registry
StartTime { ModuleName = FCT_IScript Module { Active = True Source = FILE Scripts { StartTime { FileName = ./iScriptLib/iScriptLib_Standard/ISC_StartTime.isc } } } }
EDR Container Fields
Table 82-27 lists the ISC_StartTime EDR container fields.
Table 82-27 ISC_StartTime EDR Container Field
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.MILLISEC_TIME |
Integer |
Read |
Specifies the latency time in milliseconds. |
ISC_TapDetailValidation_v3_12
The ISC_TapDetailValidation_v3_12 iScript validates that the fields present in the detail record of the EDR container contain valid data.
Note:
The ISC_TapDetailValidation_v3_12 iScript is a deprecated module but remains in BRM for backward compatibility.
You run the ISC_TapDetailValidation_v3_12 iScript when incoming files that you receive from your roaming partner use the TAP format. When processing the incoming TAP files, BRM converts input data from TAP fields into corresponding fields of the EDR container description file.
Dependencies
Because an erroneous TAP record can be discarded before the record is split into multiple records, this module must run before the FCT_Discard and ISC_TapSplitting modules.
For more information, see "Function Module Dependencies".
Sample Registry
ISC_TapDetailValidation_v3_12 { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { TapDetailValidation_v3_12 { FileName = ./iScriptLib/iScriptLib/ISC_TapDetailValidation_v3_12.isc } } } }
EDR Container Fields
Table 82-28 lists the ISC_TapDetailValidation_v3_12 EDR container fields.
Table 82-28 ISC_TapDetailValidation_v3_12 EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
SERVER_TYPE_OF_NUMBER DETAIL.ASS_CAMEL_EXT.SERVER_ TYPE_OF_NUMBER |
Integer |
Read |
CAMEL Invocation Fee TD57 item. Performs number-normalization. |
CHARGEABLE_QUANTITY_VALUE DETAIL.ASS_CBD.CP.CHARGEABLE_ QUANTITY_VALUE |
Decimal |
Read |
Chargeable Units TD57 item. Indicates the number of chargeable units. The value should be equal to or greater than zero. |
IMPACT_CATEGORY DETAIL.ASS_CBD.CP.IMPACT_CATEGORY |
String |
Read |
Charge Type TD57 item. Identifies the type of charge. Possible values:
|
TAX_TYPE DETAIL.ASS_CBD.TP.TAX_TYPE |
String |
Read |
Tax Type TD57 item. Indicates the type of tax. Possible values:
|
VOLUME_RECEIVED DETAIL.VOLUME_RECEIVED |
Decimal |
Read |
Data Volume Incoming TD57 item. Identifies the number of incoming octets (bytes) within an occurrence of GPRS Service Used or Content Service Used. The value should be equal to or greater than zero. |
VOLUME_SENT DETAIL.VOLUME_SENT |
Decimal |
Read |
Data Volume Outgoing TD57 item. Identifies the number of outgoing octets (bytes) within an occurrence of GPRS Service Used or Content Service Used. The value should be equal to or greater than zero. |
WHOLESALE_IMPACT_CATEGORY DETAIL.WHOLESALE_IMPACT_CATEGORY |
String |
Read |
Charge Type TD57 item. Identifies the wholesale type of charge. |
ISC_TapHeaderTrailerValidation_v3_12
The ISC_TapHeaderTrailerValidation_v3_12 iScript validates that fields present in the header and trailer records of the EDR contain valid data.
Note:
The ISC_TapHeaderTrailerValidation_v3_12 iScript is a deprecated module but remains in BRM for backward compatibility.
You run the ISC_TapHeaderTrailerValidation_v3_12 iScript when incoming files that you receive from your roaming partner use the TAP format. When processing the incoming TAP files, BRM converts input data from TAP fields into corresponding fields of the EDR container description file.
Dependencies
Because an erroneous TAP record can be discarded before the record is split into multiple records, this module must run before the FCT_Discard and ISC_TapSplitting modules.
For more information, see "Function Module Dependencies".
Sample Registry
ISC_TapHeaderTrailerValidation_v3_12 { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { TapHeaderTrailerValidation_v3_12 { FileName = ./iScriptLib/iScriptLib/ISC_TapHeaderTrailerValidation_v3_12.isc } } } }
EDR Container Fields
Table 82-29 lists the ISC_TapHeaderTrailerValidation_v3_12 EDR container fields.
Table 82-29 ISC_TapHeaderTrailerValidation_v3_12 EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
CHARGE_REFUND_INDICATOR DETAIL.ASS_CONT_EXT.SERVICE_USED_ LIST.CHARGE_REFUND_INDICATOR |
Integer |
Read |
Charge Refund Indicator TD57 item. Indicates that Content Transaction is a refund. When present, changes the signs of any revenue within Content Service Used. Value: 1 Refund |
TOTAL_CHARGE_REFUND TRAILER.TOTAL_CHARGE_VALUE_ LIST.TOTAL_CHARGE_REFUND |
String |
Read |
Total Charge Refund TD57 item. Specifies the sum of all the charges associated with Charge Type when Charge Type represents a refund. The value must be greater than zero. |
TOTAL_NUMBER_OF_RECORDS TRAILER.TOTAL_NUMBER_OF_RECORDS |
Integer |
Read |
Specifies the total number of Basic Records in the file, excluding header and trailer. Used as a check value to determine that all records have been correctly transmitted or used. |
ISC_TapSplitting
The ISC_TapSplitting iScript splits mobile originating and terminating EDRs when the CDR contains more than one basic service. ISC_TapSplitting creates a new EDR for each additional basic service.
For information about splitting MOC and MTC records, see "Generating Multiple TAP MOC and MTC Records".
Dependencies
Must run after the following modules:
-
FCT_DuplicateCheck
-
FCT_Discard
For more information, see "Function Module Dependencies".
ISC_TaxCalc
The ISC_TaxCalc iScript applies a flat tax to pipeline-rated events.
Dependencies
Run this module after the FCT_MainRating module, but before the FCT_BillingRecord module.
For more information, see "Function Module Dependencies".
Registry Parameters
Table 82-30 lists the ISC_TaxCalc registry parameters.
Table 82-30 ISC_TaxCalc Registry Parameters
Registry Parameter | Description | Mandatory |
---|---|---|
FlatTaxRate |
Specifies the default flat tax percentage. Pipeline Manager applies this tax rate when an event does not match any criteria in the taxcodes_map file. For example, set FlatTaxRate to 5 to apply a 5% tax on the charged amount. |
Yes |
TaxCode |
Specifies the default tax code. Pipeline Manager uses this tax code when an event does not match any criteria in the taxcodes_map file. |
Yes |
TaxCodeMapFilePath |
Specifies the path to the taxcodes_map file. If the parameter is missing, the module retrieves tax code map data from the /config/taxcodes_map object. |
No |
TaxType |
Specifies the default tax type. Pipeline Manager applies this tax type when an event does not match any criteria in the taxcodes_map file. |
Yes |
Sample Registry
TaxPlugin
{
ModuleName = FCT_IScript
Module
{
Active = True
Source = File
Scripts
{
Tax
FlatTaxRate = 5
TaxCode = FLAT
TaxType = 16
TaxCodeMapFilePath = BRM_home/sys/cm/taxcodes_map
Filename = ./iScriptLib/ISC_TaxationLib/ISC_TaxCalc.isc
}
}
}
Semaphore File Entries
Table 82-31 lists the ISC_TaxCalc Semaphore file entries.
Table 82-31 ISC_TaxCalc Semaphore File Entries
Entry | Description |
---|---|
TaxCodeMapReload |
Reloads the tax code map data to pipeline memory. |
TaxCodeMapPrintData |
Prints the tax code map data to the console. |
TaxCodeMapPrintData =filename | Prints the tax code map data into a log file, where filename is the name of the log file. |
ISC_TAP_0312_Include
The ISC_TAP_0312_Include iScript copies TAP data from staging fields in the EDR container to business fields in the EDR container.
This iScript is part of the following iScripts:
Sample Registry
BusinessMapping { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { BusinessMapping { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_TAP_0312_Include.isc } } } }
EDR Container Fields
Table 82-32 lists the ISC_TAP_0312_Include EDR container fields.
Table 82-32 ISC_TAP_0312_Include EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.ASS_LTE_EXT.REQUESTEDNUMBER |
String |
Read |
Contains the number (TEL URI of the original destination) to which the customer requested to be connected. |
DETAIL.ASS_LTE_EXT.REQUESTEDPUBLICUSERID |
String |
Read |
Contains the public user ID (SIP URI of the original destination) to which the customer requested to be connected. |
ISC_TAP_0312_InMap
The ISC_TAP_0312_InMap iScript copies TAP data from staging fields in the EDR container to business fields in the EDR container.
Registry Entries
Table 82-33 lists the ISC_TAP_0312_inMap registry entries.
Table 82-33 ISC_TAP_0312_InMap Registry Entries
Entry | Description | Mandatory |
---|---|---|
Active |
Specifies if the module is active or inactive: True = Active False = Inactive |
Yes |
Source |
Specifies the source of the iScripts:
|
Yes |
FileName |
Specifies the location of the iScript. The default location is ./iScriptLib/iScriptLib_Roaming/ISC_TAP_0312_InMap.isc. |
Yes |
ISC_TAP_0312_Validations
The ISC_TAP_0312_Validations iScript validates TAP input data.
Registry Entries
Table 82-34 lists the ISC_TAP_0312_Validations registry entries.
Table 82-34 ISC_TAP_0312_Validations Registry Entries
Entry | Description | Mandatory |
---|---|---|
Active |
Specifies if the module is active or inactive. True = Active False = Inactive |
Yes |
Source |
Specifies the source of the iScripts.
|
Yes |
FileName |
Specifies the location of the iScript. The default location is ./iScriptLib/iScriptLib_Roaming/ISC_TAP_0312_Validations.isc. |
Yes |
ISC_UsageClassSetting
The ISC_UsageClassSetting iScript is used in the Incollect and Outcollect settlement pipelines to populate the DETAIL.USAGE_CLASS field with the value of DETAIL.CONNECT_TYPE in the EDR container, which specifies the type of call. The value of DETAIL.USAGE_CLASS is stored in the event_dlay_sess_tlcs table and is later used by high-usage reports to determine premium calls.
Sample Registry
UsageClassMap { ModuleName = FCT_IScript Module { Active = True Source = File Scripts { UsageClassSettingIScript { FileName = ./iScriptLib/iScriptLib_Roaming/ISC_UsageClassSetting.isc } } } }
EDR Container Fields
Table 82-35 lists the ISC_UsageClassSetting EDR container fields.
Table 82-35 ISC_UsageClassSetting EDR Container Fields
Alias field nameDefault field name | Type | Access | Description |
---|---|---|---|
DETAIL.USAGE_CLASS |
String |
Write |
Internal usage class. |
DETAIL.CONNECT_TYPE |
String |
Read |
Contains the connect type of the call. |
UpdateTapInfo_StopRapout
The UpdateTapInfo_StopRapout iScript updates the database with information on the Stop Return RAP file sent to the Visited Public Mobile Network (VPMN) operator.
UpdateTapInfo_Tapin
The UpdateTapInfo_Tapin iScript updates the information in the database on incoming TAP files for use in generating Stop Return RAP files.
Dependencies
This iScript should be configured before the FCT_Reject module, and after any iScripts that populate the mandatory fields in the header of an EDR.
For more information, see "Function Module Dependencies".