This chapter lists the Pipeline Manager modules.
For information about pipeline rating, see "About Pipeline Rating".
For information about placement of modules in a pipeline, see "Function Module Dependencies".
Table 35-1 lists the Pipeline Manager modules with descriptions.
Table 35-1 Pipeline Manager Modules
Module | Description |
---|---|
Controls and monitors the pipeline framework. See "About the Controller" in BRM Concepts. |
|
Provides database connections for other modules. |
|
Provides customer data from the BRM database. See:
|
|
Provides data to a real-time discounting pipeline. |
|
Maintains balance information in the Pipeline Manager memory. |
|
Retrieves current balance information from the BRM database and supplies the data to the real-time discounting pipeline. |
|
Provides holiday calendar data for the FCT_MainRating module. See "Rating by Date and Time with Pipeline Manager" in BRM Setting Up Pricing and Rating. |
|
Converts currency symbols to numeric values. See "Setting up Pipeline Manager Resources" in BRM Setting Up Pricing and Rating. |
|
Provides special day rate data for the FCT_Dayrate module. See "About Special Day Rates" in BRM Setting Up Pricing and Rating. |
|
Provides data for the FCT_Discount module and the FCT_DiscountAnalysis module. |
|
Provides currency exchange rate data for the FCT_ExchangeRate module. See "Defining Currency Exchange Rates" in BRM Setting Up Pricing and Rating. |
|
Provides network configuration data for the FCT_CarrierIcRating module. See "Configuring DAT_InterConnect" in BRM Configuring Roaming in Pipeline Manager. |
|
Returns the item POID for an item tag to the FCT_ItemAssign and FCT_Billing Record modules. See "Creating Custom Bill Items" in BRM Configuring and Running Billing. |
|
Listens to business events from BRM and provides data to the DAT_AccountBatch and DAT_Discount modules. See "Installing and Configuring the Account Synchronization DM" in BRM Installation Guide. |
|
Provides model selector rules to other modules. See "Configuring Pipeline Rating" and "Configuring Discounting Modules and Components". |
|
Provides data for mapping network source and destinations to new values for the FCT_NOSP module, used for multi-segment rating. See the following documents: |
|
Provides number portability data to the FCT_NumberPortability module. |
|
Provides data for mapping phone number prefixes to descriptions, used by the FCT_PrefixDesc module. |
|
Provides price model data for the FCT_MainRating module. |
|
Provides rate plan data for the FCT_MainRating module. |
|
Used by standard recycling and Suspense Manager EDR to recycle EDRS. |
|
Provides aggregation scenario data for the FCT_AggreGate module. |
|
Provides time model, time zone, and day code data for the FCT_Mainrating module. See "Rating by Date and Time with Pipeline Manager" in BRM Setting Up Pricing and Rating. |
|
Provides usage scenario (USC) mapping data. It retrieves USC mapping data from the Pipeline Manager database or an ASCII file for the FCT_USC_Map module. See "Setting Up Usage Scenario Mapping" in BRM Setting Up Pricing and Rating. |
|
Provides zone data for the FCT_MainRating module. See "Setting Up Zones for Batch Pipeline Rating" in BRM Setting Up Pricing and Rating. |
|
Generates and allocates memory to EDR Containers. See "About the EDR Factory" in BRM Concepts. |
|
Starts external programs. See "Using Events to Start External Programs" in BRM System Administrator's Guide. |
|
Handles pipeline input from a database. See "Configuring EDR Input Processing". Configure this module as a submodule of the INP_GenericStream module. See INP_GenericStream. |
|
Performs file handling for pipeline input from files. See "Configuring EDR Input Processing". Configure this module as a submodule of the INP_GenericStream module. See INP_GenericStream. |
|
Handles files for the OUT_Generic_Stream and OUT_Reject modules. |
|
Parses CDR files from a single input directory to multiple pipelines. See "Connecting a Module to a Database" in BRM System Administrator's Guide. |
|
Adds customer data to an EDR. See "Adding Customer Balance Impact Data to EDRs" in BRM Setting Up Pricing and Rating. |
|
For a multischema system, finds the database schema for the customer and routes the EDRs to the appropriate pipeline. See "Using Pipeline Manager with Multiple Database Schemas". |
|
Performs aggregation of data in EDR containers. |
|
Before zoning: Maps the access point name (APN) to a physical PDP address. After zoning: Enhances zone values to support enhanced zoning functionality. See "Setting Up APN Mapping" in BRM Setting Up Pricing and Rating. |
|
Reads the discount packets added by DAT_Discount, adds the discounting sub-balance impact to the EDR, and updates the in-memory balance. See "About Discounts". |
|
Consolidates balance impact data into an associated BRM billing record and one or more balance impact packets. This data is loaded into the BRM database by RE Loader. |
|
Assembles EDRs that have been split into multiple EDRs. See "Assembling EDRs". |
|
Adds roaming data to EDRs for rating by the FCT_PreRating and FCT_MainRating modules. See "About Linking Rate Plans to Network Operators and IC Products" in BRM Configuring Roaming in Pipeline Manager. |
|
The FCT_CiberOcc module creates a CIBER record for other charges and credits (OCC record), type 50 or 52. See "About Settling Roaming Charges" in BRM Configuring Roaming in Pipeline Manager. |
|
Maps multiple numbers to a single number for billing. |
|
Performs credit limit checking to determine whether the event owner has enough resources for the requested service. See "About Credit Limit Checks in the Real-Time Discounting Pipeline" in BRM Telco Integration. |
|
Supplies the rate plan for the FCT_MainRating module. |
|
Calculates charges for special day rates, for example, a discount for calls made on January 1. See "About Special Day Rates" in BRM Setting Up Pricing and Rating. |
|
Discards or skips EDRs based on configurable EDR properties.
In both the cases the state of the EDR becomes invalid. |
|
Performs discounting functions. |
|
Performs discounting analysis functions. |
|
Identifies dropped calls and continuation calls. See "About Finding Dropped Calls and Continuation Calls" in BRM Telco Integration. |
|
Checks for duplicate EDRs. See "Handling Duplicate EDRs". |
|
Specifies different output streams for EDRs based on rules. For example:
|
|
Converts the currency used for rating to the home (system) currency, and the customer's billing currency. See "Defining Currency Exchange Rates" in BRM Setting Up Pricing and Rating. |
|
Determines whether an EDR is eligible for the system products and system discounts contained in a filter set, and if it is, adds those system products and discounts to a customer's list of purchased products. See "About Using Filter Sets to Apply System Products and Discounts". |
|
Rates all EDRs with a default set of rate plans. |
|
Evaluates iRules. Those rules can be used for mapping functions for EDR data fields, splitting EDR containers to different output streams, and so forth. See "About Configuring iRules" in BRM System Administrator's Guide. |
|
Runs iScripts. The scripts are run in the order specified in the registry. See "About Configuring iScripts" in BRM System Administrator's Guide. |
|
Retrieves an item POID for an item tag from the DAT_ItemAssign module and populates the EDR container with the item POID. See DAT_ItemAssign. |
|
Performs the main Pipeline Manager rating functionality. See "About Main Rating". |
|
Performs zoning for multi-segment zoning. See "Setting Up Multi-Segment Zoning" in BRM Setting Up Pricing and Rating. |
|
Maps network source and destination to new values. |
|
Specifies the new network operator for an existing phone number. |
|
Maps phone number prefixes to destination descriptions. |
|
Calculates zones and creates impact categories. See "Setting Up Prerating" in BRM Setting Up Pricing and Rating. |
|
Used for pipeline-only implementations. Gets the file of rejected EDRs from the reject stream output directory. The module puts the reject EDR file into the pipeline input directory for recycling. It uses the same input folder as the incoming CDR files. |
|
When used as part of BRM standard recycling, this module adds suspense-related information to EDRs. When used with Suspense Manager, this module also configures the queryable fields for EDRs suspended in a specific pipeline. |
|
Adjusts the charge for an EDR after rating has been performed. See "About Rate Adjustment" in BRM Setting Up Pricing and Rating. |
|
Used for pipeline-only implementations. Runs at the end of the pipeline It does either of the following:
|
|
The FCT_Reject module analyzes the errors in an EDR and, if necessary, moves the EDR to a reject file. |
|
Performs rounding for rating and discounting. See "About Resource Rounding" in BRM Setting Up Pricing and Rating. |
|
Performs rate service class (RSC) mapping. |
|
Assigns a segment to an EDR based on the source network instead of customer information. |
|
Finds the segment using the source network information instead of using the customer information. See "Setting Up Multi-Segment Zoning" in BRM Setting Up Pricing and Rating. |
|
Maps external service codes to internal service codes. See "Mapping Service Codes and Service Classes" in BRM Setting Up Pricing and Rating. |
|
Flags social numbers for special processing. |
|
When used as part of BRM standard recycling, routes failed EDRs to appropriate output streams depending on their processing status (normal, recycling, or test recycling) and suspense status (succeeded or suspended). When used with Brand Manager, also determines the brand for each suspended call. When used with Suspense Manager, also adds the suspense reason and subreason codes to EDRs. |
|
Sends EDRs to the billing-trigger output stream to trigger immediate billing for the associated accounts. It also sets a billing-trigger error code used to route the EDRs to the suspense output stream, and the Trigger_Billing recycle key used to retrieve the suspended EDRs for recycling. See "Setting Up Pipeline-Triggered Billing" in BRM Configuring and Running Billing. |
|
Converts the unit of measurement (UoM) of an incoming EDR to a UoM needed for rating a particular service. See "Converting Units of Measurement" in BRM Setting Up Pricing and Rating. |
|
The FCT_UsageClassMap module maps external codes for secondary services, such as call forwarding, to internal usage classes. See "Mapping Usage Classes" in BRM Setting Up Pricing and Rating. |
|
The FCT_USC_Map module performs usage scenario mapping. See "Setting Up Usage Scenario Mapping" in BRM Setting Up Pricing and Rating. |
|
The FCT_Zone module computes zones when you use Pipeline Manager only for zoning. See "About Setting Up Zones" in BRM Setting Up Pricing and Rating. |
|
Provides the input interface to the pipeline. |
|
Converts data in an flist to the EDR container format. |
|
Used by standard recycling and Suspense Manager in the pre-recycling pipeline. It reads suspended usage records from the BRM database, restores original EDRs, applies edits to them, and pushes EDRs into the pre-recycling pipeline. |
|
Sends EDRs to separate output streams based on service codes. |
|
Flags all EDRs that satisfy the criteria for least cost rating. |
|
Used in the pre-recycling pipeline to send EDRs to different output streams depending on their original pipeline names. The EDRs are then routed to their original pipelines for recycling. |
|
Flags all EDRs that satisfy the criteria for a promotional savings calculation. |
|
Assigns usage types to EDRs. See "Mapping Usage Types" in BRM Setting Up Pricing and Rating. |
|
Prepares EDRs for rerating in the back-out pipeline. Important: This is a deprecated module but remains in BRM for backward compatibility. See "About Rerating Pipeline-Rated Events" in BRM Setting Up Pricing and Rating. |
|
Used by the backout pipeline for back-out-only rerating. It determines if the EDRs are flagged for back-out-only rerating and sends the EDRs to different output streams based on the event types. See "About Configuring the Backout Pipeline for Back-Out-Only Rerating" in BRM Setting Up Pricing and Rating. |
|
ISC_CiberInputValidation |
Performs record-level validations of CIBER records. See "About Validating Roaming Usage Data" in BRM Configuring Roaming in Pipeline Manager. |
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. See "About Settling Roaming Charges" in BRM Configuring Roaming in Pipeline Manager. |
|
Sets a reason code in the CIBER extension block for records that are rejected. |
|
Populates standard values to fields in output TAP file based on its corresponding value in the EDR container. |
|
Retrieves the CAMEL flag information for a roaming partner. This iScript is used by roaming outcollect processing. |
|
Performs one of the following:
See "About Least Cost Rating" and "About Calculating the Promotional Savings". |
|
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. |
|
Collects the validation errors in the EDRs and creates error records in the Pipeline Manager database. This iScript is used during roaming incollect processing by the NRTRDE (Near Real-Time Roaming Data Exchange) processing pipeline. See the description for detecting roaming fraud using NRTRDE in BRM Configuring Roaming in Pipeline Manager. |
|
Duplicates and routes EDRs to the corresponding roaming partner NRTRDE output streams based on the roaming partner's NRTRDE flag. This iScript is used by roaming outcollect processing. See the description for detecting roaming fraud using NRTRDE in BRM Configuring Roaming in Pipeline Manager. |
|
Validates the information in the header record of the TD35 file based on the TD35 specifications. This iScript is used during roaming incollect processing by the NRTRDE processing pipeline. See the description for detecting roaming fraud using NRTRDE in BRM Configuring Roaming in Pipeline Manager. |
|
Creates two output CDRs from a single input EDR. |
|
Populates the RATE_TAG field with the value of the NRTRDE flag in the balance impact. This iScript is used by the outcollect settlement pipelines. |
|
Analyzes friends and family extended rating attributes (ERAs) during pipeline rating. See "Pipeline Rating for Friends and Family ERAs" in BRM Setting Up Pricing and Rating. |
|
Analyzes ERAs during pipeline rating to determine whether the ERA profiles specified in the ProfileName registry entry match the EDR field value. |
|
Adds all the retail and wholesale charges and puts them in DETAIL.RETAIL_CHARGED_AMOUNT_VALUE and DETAIL.WHOLESALE_CHARGED_AMOUNT_VALUE fields. See "Billing Consolidation with CIBER Roaming and Revenue Assurance". |
|
Populates and validates the batch related fields for the EDR container. |
|
Sets the EDR status to Success, Suspense, Duplicate, Discard, or Skipped for each EDR. |
|
Sets the Output Stream to TelOut, SMSOut, GPRSOut, RejectOut, or DuplicateOut for each EDR. |
|
Collects the previous and current charged and discount amount for a configured Resource ID. |
|
Sets the Revenue Stream to Retail, Wholesale, Roaming, or Unknown for each EDR. |
|
Finds the service type and updates the DETAIL.INTERN_SERVICE_CODE EDR field with the customized service code value for each EDR. |
|
Validates that the fields present in the detail record of the EDR container contain valid data. |
|
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. |
|
Applies a flat tax to pipeline-rated events. See "About Pipeline Taxation" in BRM Calculating Taxes. |
|
Logs error messages. See "About Pipeline Manager Transactions" in BRM System Administrator's Guide. |
|
Monitors Pipeline Manager system memory during startup and while it is processing files. See "Monitoring Pipeline Manager Memory Usage" in BRM System Administrator's Guide. |
|
The NET_EM module hosts a BRM External Module (EM). This allows the NET_EM module to use the BRM API opcodes to transfer data between real-time rating and Pipeline Manager. |
|
Sends output to the database. |
|
Removes EDRs that are not needed by Pipeline Manager. See "Configuring Output of Discarded EDRs". All registry entries and error messages are handled by the Output Collection module. See Output Collection. For more information, see "Discarding and Skipping EDRs". |
|
Handles the output stream for rated EDRs. See "Configuring EDR Output Processing". When you configure the OUT_GenericStream module, you configure the EXT_OutFileManager module to specify file management options. See EXT_OutFileManager. |
|
The OUT_Realtime module converts data in the pipeline EDR output to flist format. |
|
Writes rejected EDRs to an output stream. The written record is exactly the same as the original input record. See "Configuring Output for Rejected or Duplicate EDRs". All registry entries and error messages are handled by the Output Collection module. See Output Collection. For more information, see the following documents: |
|
Checks for duplicate CDR input files and adds tracking numbers to output streams. See "Configuring Sequence Checking" in BRM System Administrator's Guide. |
|
Manages incoming input streams for its associated pipeline. |
|
Manages the output streams for its associated pipeline. |
|
Handles output streams. |
|
Manages all processes in its associated pipeline. See Pipeline Controller. |
|
Coordinates the state of all transactional modules and components in a pipeline. See "About Pipeline Manager Transactions" in BRM System Administrator's Guide. |
|
Generates transaction IDs for all pipelines. See "Configuring the Transaction ID Controller" in BRM System Administrator's Guide. |
|
Stores transaction IDs in a Pipeline Manager database table. See "Configuring the Transaction ID Controller" in BRM System Administrator's Guide. |
|
Stores transaction IDs in a file. See "Configuring the Transaction ID Controller" in BRM System Administrator's Guide. |