37 Pipeline Manager Data Modules

This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) Pipeline Manager data modules.

DAT_AccountBatch

DAT_AccountBatch retrieves account data from the BRM database for the "DAT_ItemAssign", "FCT_Account", and "FCT_AccountRouter" modules.

See "Adding Customer Balance Impact Data to EDRs" in BRM Setting Up Pricing and Rating and "Using Pipeline Manager with Multiple Database Schemas".

This module also maintains a list of the accounts that are being rerated by the pin_rerate utility. This information is used by the batch rating pipeline to suspend incoming call detail records (CDRs) for those accounts while rerating is in progress. See "About Comprehensive Rerating Using pin_rerate" in BRM Setting Up Pricing and Rating.

Dependencies

This module requires connections to the following:

• BRM database.

• Pipeline Manager database.

• DAT_Listener module. See "DAT_Listener".

• DAT_PortalConfig module. See "DAT_PortalConfig".

Registry Entries

Table 37-1 lists the DAT_AccountBatch registry entries.

Table 37-1 DAT_AccountBatch Registry Entries

Entry	Description	Mandatory
AcceptLoginSearchFailure	If set to True, when a customer login number is not found in memory, the EDR will be accepted, the pipeline will continue processing the EDR, and a warning will be reported in the stream log. If set to False (the default), when a customer login number is not found in memory, the EDR will be set as invalid and rejected and a major error will be reported. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
AccountLocks	Use this entry to tune performance by managing thread contention. Default = 10 See "Locking Objects during DAT_AccountBatch Processing" in BRM System Administrator's Guide.	No
AddAliasList	Specifies whether all alias names and logins are added to the EDR. Default = False Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
ClosedAccountDelay	Specifies to not load closed accounts. Also specifies the number of days prior to the current date for which closed accounts are not loaded. For example, if ClosedAccountDelay is set to 10 and the current date it June 20, accounts that were closed prior to June 10 are not loaded into memory. Default = 0 See "Specifying To Not Load Closed Accounts" in BRM Setting Up Pricing and Rating.	No
Connections	Specifies the number of connections to the database. This value must be at least the number of threads plus 1. Default = 5 See "Configuring Threads for DAT_BalanceBatch Connections" in BRM System Administrator's Guide.	No
EnrichRatingProductOnly	If set to True, only the purchased products whose service ID matches the service ID in the EDR being rated are added to the EDR. If set to False, the purchased products whose service type matches the service type in the EDR being rated are added to the EDR. Note: This entry is present for backward compatibility.	No
InfranetConnection	Specifies the connection to the BRM database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
InitialLoading	Specifies whether the initial loading of service and account data is performed. Otherwise, loading occurs while processing. Login objects are always loaded. Setting this entry to False enables the system to start faster. Default = True Important: If the UseAsRouter registry entry is set to True, this registry entry is not used. See "Specifying Whether To Load All Account Data" in BRM Setting Up Pricing and Rating.	No
IntegrateConnection	Specifies the connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
Listener	Specifies the connection to the DAT_Listener module. See "Configuring the DAT_Listener module" in BRM Installation Guide and "DAT_Listener".	Yes
LoadAccountForSharingOnly	Specifies whether Pipeline Manager can load serviceless accounts that are owners of resource sharing groups. Default = False See "About Serviceless Accounts as Charge Sharing Owners" in BRM Managing Accounts Receivable.	No
LoadLogins	Specifies whether the login is loaded in case of an existing alias list. When set to True, logins are loaded from both the PIN_FLD_LOGIN field and the PIN_FLD_ALIAS_LIST array. When set to False, logins are only loaded from the PIN_FLD_ALIAS_LIST array. Default = False when UseAsRouter is disabled. When UseAsRouter is enabled, then LoadLogins is always True.	No
LoadPercentage	Indicates the percentage of account POIDs to store locally when determining the account blocks for which each thread is responsible. Values must be greater than 0.000000 and less than or equal to 100.0. Default = 10.0 See "Configuring Threads for DAT_BalanceBatch Connections" in BRM System Administrator's Guide.	Yes
LogEvents	Specifies whether received events should be written to a log file. Use this entry to troubleshoot Pipeline Manager event handling. Default = False See "Using Events to Start External Programs" in BRM System Administrator's Guide.	No
LoginLocks	Use this entry to tune performance by managing thread contention. Default = 10 See "Locking Objects during DAT_AccountBatch Processing" in BRM System Administrator's Guide.	No
PerThreadJobsCount	Specifies the number of jobs per thread. Important: Setting the number of jobs per thread to a large number can decrease performance because of the system overhead associated with creating too many jobs. (Typically, three to eight jobs per thread is optimal). If you want to adjust the number of accounts or balances per job, increase or decrease the number of threads. See "Improving DAT_AccountBatch and DAT_BalanceBatch Load Balancing" in BRM System Administrator's Guide.	Yes
PortalConfigDataModule	Specifies the connection to the DAT_PortalConfig module. This enables DAT_AccountBatch to retrieve business parameter settings from the DAT_PortalConfig module. See "Using Business Parameter Settings From The BRM Database" in BRM System Administrator's Guide.	Yes
ReadAccountBalances	Specifies whether to load account resource data. The data includes resource IDs, such as 840. If enabled, the RESOURCE_LIST field in the CUSTOMER_DATA block is populated with the resource IDs for that account. Default = False Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
ReadAllProducts	If set to True, all the purchased products for the account are added to the EDR. If set to False, only those purchased products matching the service types and event types of the CDR processed are added to the EDR.	No
ReadPlans	If set to True, the module loads plan IDs into memory when loading purchased products. During EDR processing, the list of plan IDs for an account is returned to the FCT_Account module. See "Setting Up Exclusion Rules for Usage Discounts".	No
ReadSystemProductFromMain	If set to True, the module retrieves the latest system products from the main tables and uses the start and end dates to validate when the product is in effect. If set to False (the default), the module retrieves the system product information from the audit tables and uses the purchase creation date to validate when the product is in effect. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
RejectClosedAccounts	Specifies whether to reject CDRs for accounts that are closed. If set to True, all closed account information is loaded from the database. Any CDR with a timestamp later than the account's closed date is rejected. Default = False	No
RowFetchSize	Specifies the number of rows of data to retrieve from the BRM database. Use this entry for performance tuning. Default = 1000 See "Specifying How Much Account Data To Retrieve On Startup" in BRM Setting Up Pricing and Rating.	No
ServiceLocks	Tunes performance by managing thread contention. Default = 10 See "Locking Objects during DAT_AccountBatch Processing" in BRM System Administrator's Guide.	No
ThreadAccountHashMapSize	Controls the size of the temporary hash map built by each thread for accounts. See "Setting the Hash Map Size for Threads" in BRM System Administrator's Guide. Important: Changing the default system-calculated values for this entry is not recommended. If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
ThreadGroupSharingChargesHashMapSize	Controls the size of the temporary hash map built by each thread for loading charge share group data. The system-calculated default value might not be appropriate. See "Setting the Hash Map Size for Threads" in BRM System Administrator's Guide. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
ThreadGroupSharingDiscountsHashMapSize	Controls the size of the temporary hash map built by each thread for loading discount sharing group data. The system-calculated default value might not be appropriate. See "Setting the Hash Map Size for Threads" in BRM System Administrator's Guide. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
ThreadGroupSharingMonitorsHashMapSize	Controls the size of a temporary hash map constructed for GroupSharingProfile object storage during multi-thread DAT_Account initialization. Default = (TotalAccounts / NumThreads) * 0.10. The default value for this entry is appropriate in most cases. However, the value should be increased if you exceed an average of 4 GroupSharingMonitors for every 10 accounts.	No
ThreadGroupSharingProfilesHashMapSizes	Controls the size of the temporary hash map built by each thread for loading profile sharing group data. The system-calculated default value might not be appropriate. See "Setting the Hash Map Size for Threads" in BRM System Administrator's Guide. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
ThreadLoginHashMapSize	Controls the size of the temporary hash map built by each thread for loading logins. The system-calculated default value is appropriate for most BRM implementations. See "Setting the Hash Map Size for Threads" in BRM System Administrator's Guide.	No
Threads	Specifies the number of threads. Set this value to at least the number of CPUs in the system. Increasing the number of threads increases performance, up to a point. Specifying too many threads decreases performance. Default = 4 See "Configuring Threads for DAT_BalanceBatch Connections" in BRM System Administrator's Guide.	Yes
ThreadServiceHashMapSize	Controls the size of the temporary hash map built by each thread for loading services. The system-calculated default value is appropriate for most BRM implementations. See "Setting the Hash Map Size for Threads" in BRM System Administrator's Guide. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
TimesTenEnabled	Specifies whether your BRM system uses IMDB Cache. Set this to True if your BRM system uses IMDB Cache DM. Set this to False if your BRM system uses Oracle DM.	No
UseAsRouter	If set to True, the module is used by the FCT_AccountRouter module to route EDRs to separate Pipeline Manager instances. See "Using Pipeline Manager with Multiple Database Schemas" and "FCT_AccountRouter". If set to False (the default), the module is used by the FCT_Account module. See "Adding Customer Balance Impact Data to EDRs" in BRM Setting Up Pricing and Rating. Important: If set to True, the following registry entries are not used: AcceptLoginSearchFailure AddAliasList InitialLoading ReadAccountBalances ReadSystemProductFromMain ThreadAccountHashMapSize ThreadGroupSharingChargesHashMapSize ThreadGroupSharingDiscountsHashMapSize ThreadGroupSharingProfilesHashMapSizes ThreadServiceHashMapSize UseProductCreatedTime UseLatestProductAndDiscount	No
UseLatestProductAndDiscount	If set to True, the module retrieves the latest purchased product and discount information from the main tables and uses the start and end dates to validate when the product is in effect. If set to False (the default), the module retrieves the purchased product and discount information from the audit tables and uses the purchase creation date to validate when the product is in effect. See "Configuring Account Product Validity Checking for Backdated Events" in BRM Setting Up Pricing and Rating. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
UseProductCreatedTime	If set to True (the default), the product is selected only if an event occurs after the product's created time (PIN_FLD_CREATED_T) and between its start and end times. If set to False, product validity is checked based only on the start and end times (PIN_FLD_START_T and PIN_FLD_END_T) of the product. See "Configuring Product Validity Checking" in BRM Setting Up Pricing and Rating. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used.	No
UseProfileEffectiveTime	If set to True (the default), the module uses EFFECTIVE_T to determine the validity of the profile objects. If set to False, the module uses CREATED_T to determine the validity of the profile objects.	No

Sample Registry Entry

CustomerData
  {
    ModuleName = DAT_AccountBatch
    Module
    {
      IntegrateConnection  = ifw.DataPool.Login
      InfranetConnection   = ifw.DataPool.LoginInfranet
      LogEvents            = True
      Listener             = ifw.DataPool.Listener
      TimesTenEnabled      = False
      ReadAccountBalances  = True
      Threads              = 4
      Connections          =  5
      LoadPercentage       = 10.0
    }
  }

Semaphore File Entries

Table 37-2 lists the DAT_AccountBatch Semaphore file entries.

Table 37-2 DAT_AccountBatch Semaphore File Entries

Entry	Description
LogEvents	Specifies whether events should be stored in a log file. You can also use this entry in the startup registry. See "Using Events to Start External Programs" in BRM System Administrator's Guide.
PrintData	Reports the account data for all accounts. See "Getting Information about Loading Accounts" in BRM Setting Up Pricing and Rating.
PrintDataLogin	Reports the account data for a single account identified by the BRM login ID (usually the phone number). See "Getting Information about Loading Accounts" in BRM Setting Up Pricing and Rating.
PrintDataSamples	Reports the account data for a specified number of accounts, chosen randomly. See "Getting Information about Loading Accounts" in BRM Setting Up Pricing and Rating.
PrintAmtData	Prints in-memory data about the Account Migration Manager (AMM) to the specified log file. See "Migrating Accounts with the Pipeline Manager Running" in BRM System Administrator's Guide.
PrintAmtJobData	Prints in-memory data about one account migration job to the specified log file. See "Migrating Accounts with the Pipeline Manager Running" in BRM System Administrator's Guide.
RejectClosedAccounts	Rejects CDRs with a timestamp later than the account's closed date.
Reload	Reloads data from the Pipeline Manager database. See "Reloading Data into a Pipeline Manager Module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.CustomerData.Module.Reload {}

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

Database Tables

The DAT_AccountBatch module uses the following database tables:

• IFW_CURRENCY

• IFW_REF_MAP

• IFW_SERVICE

For information about the fields in these database tables, see the documentation in Pipeline_Home/database. Pipeline_Home is the directory where you installed Pipeline Manager.

DAT_AccountRealtime

The DAT_AccountRealtime module provides customer data from the BRM database in a real-time discounting pipeline.

Note:

Unlike the DAT_AccountBatch module, the DAT_AccountRealtime module does not load account data in memory when you start Pipeline Manager. Instead, it gets account data in real time from the BRM database by using the NET_EM module.

The DAT_AccountRealtime module gets data for the FCT_Discount module. For information about the FCT_Discount module, see "FCT_Discount".

Dependencies

The DAT_AccountRealtime requires the NET_EM module. It makes a connection to the NET_EM module automatically; you don't need to configure the connection.

Registry Entries

There are no registry entries for the DAT_AccountRealtime module. You only need to enter the module in the registry DataPool section.

Sample Registry Entry

CustomerData
  {
    ModuleName = Dat_AccountRealtime
    Module
    {
      #
    }
  }

Semaphore File Entries

DAT_AccountRealtime does not support semaphore updates.

DAT_BalanceBatch

The DAT_BalanceBatch module maintains balance information in the Pipeline Manager memory. It uses Account Synchronization to retrieve balance information from the BRM database. Data is stored in memory only, not in the database or in a file.

When reading balances and sub-balances from the database, the DAT_BalanceBatch module ignores balance monitor impacts.

See the following documents:

• Configuring Discounting Modules and Components

• FCT_Discount

Dependencies

Requires the following connections:

• Pipeline Manager database.

• BRM database.

• DAT_AccountBatch module. See "DAT_AccountBatch".

• DAT_Listener module. See "DAT_Listener".

• DAT_Discount module. See "DAT_Discount".

• DAT_PortalConfig module. See "DAT_PortalConfig".

Registry Entries

Table 37-3 lists the DAT_BalanceBatch registry entries.

Table 37-3 DAT_BalanceBatch Registry Entries

Entry	Description	Mandatory
AccountDataModule	Specifies the connection to the DAT_AccountBatch module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_AccountBatch".	Yes
BalanceDirectory	Specifies the directory that contains data and transaction files.	No
BalanceLocks	Specifies the number of locks that can be acquired during processing. Must be a positive integer. Default = 100 Important: Setting this value too low may decrease pipeline throughput performance.	No
BalanceLockStatusLog	Specifies that when an event transaction is locked by an EDR transaction, it is logged to the process logger. Default = False	No
BalancesPerThreadJobsCount	Specifies the number of jobs per thread. Important: Setting the number of jobs per thread to a large number can decrease performance because of the system overhead associated with creating too many jobs. (Typically, three to eight jobs per thread is optimal). If you want to adjust the number of accounts or balances per job, you can do this by increasing or decreasing the number of threads. See "Improving DAT_AccountBatch and DAT_BalanceBatch Load Balancing" in BRM System Administrator's Guide.	Yes
BalanceTrace	Specifies whether to generate a balance trace file. True indicates that a balance trace file is generated. False indicates that a balance trace file is not generated. Default = False	No
CustomEvents	Lists custom business events that include balance data needed by Pipeline Manager. Custom events are defined in the Account Synchronization DM payload configuration file (payloadconfig_ifw_sync.xml). See "Configuring Custom Business Events For Pipeline Discounting" and "About Publishing Additional Business Events" in BRM Developer's Guide.	No
DiscountDataModule	Specifies the connection to the DAT_Discount module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Discount".	Yes
InfranetConnection	Specifies the database connection to the BRM database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
IntegrateConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
ListenerDataModule	Specifies the connection to the DAT_Listener module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Listener".	Yes
LoadPercentage	Specifies how much data to load from the BRM database before the process log outputs status information. For example, to output status after every 10% of the data is loaded, enter 10. Default = 10 See "Configuring Threads For DAT_BalanceBatch Connections" in BRM System Administrator's Guide.	No
LogEvents	Specifies whether received events should be written to a log file. Use this entry to troubleshoot Pipeline Manager event handling. Default = False See "Using Events to Start External Programs" in BRM System Administrator's Guide.	No
LogTransactions	Specifies if the balances affected during the CDR processing are logged. Default = False	No
PortalConfigDataModule	Specifies the connection to the DAT_PortalConfig module. This enables DAT_BalanceBatch to retrieve business parameter settings from the DAT_PortalConfig module. See "Using Business Parameter Settings From The BRM Database" in BRM System Administrator's Guide.	Yes
RowFetchSize	Specifies the number of rows of balance data to load from the BRM database for each database retrieving. Default = 50	No
SelectiveSubBalLoad	Specifies whether to selectively load non-currency sub-balances at Pipeline Manager startup. Default = True See "Specifying Which Non-Currency Sub-Balances to Load at Startup" in BRM Setting Up Pricing and Rating.	No
Synchronized	Specifies whether to allow the first transaction to process and to make other transactions wait in the queue. Default = False	No
ThreadHashMapSize	Specifies the size of the hash map in each thread used for loading balance data from the BRM database. Default = 1024 See "Configuring Single-Threaded or Multithreaded Operation" in BRM System Administrator's Guide.	No
Threads	Specifies the number of threads for loading the balance data from the BRM database. The number of threads must be smaller than or equal to the number of connections. Default = 4 See "Configuring Single-Threaded or Multithreaded Operation" in BRM System Administrator's Guide.	No
UseFlexibleConsumptionRule	Specifies whether to use the resource consumption rules defined at the plan level. True: Uses the consumption rules defined for each resource in a balance group. If a consumption rule is not defined, this module uses the rules defined in the /config/beid object. If a consumption rule isn't defined in a balance group or the /config/beid object, this module uses the rule defined in the multi_bal instance of the /config/business_params object. False: Uses the system-wide consumption rule defined in the multi_bal instance of the /config/business_params object only. Default = True See "How Batch Rating Applies Consumption Rules" in BRM Setting Up Pricing and Rating.	No
VirtualTime	Specifies whether this module uses system time or virtual time. Default = False Set to True only if you are performing tests and have used the pin_virtual_time utility to set a virtual time. If you set this entry to True, make sure you copy the pin.conf file from the BRM_Home/sys/test directory to the Pipeline_Home directory. BRM_Home is the directory where you installed BRM components. The pin.conf file contains this entry: - - pin_virtual_time pin_virtual_time_file	No

Sample Registry Entry

BalanceDataModule
  {
    ModuleName = DAT_BalanceBatch
    Module
    {
      IntegrateConnection = ifw.DataPool.Login
      InfranetConnection  = ifw.DataPool.LoginInfranet
      AccountDataModule   = ifw.DataPool.CustomerData 
      ListenerDataModule  = ifw.DataPool.Listener
      DiscountDataModule  = ifw.DataPool.DiscountData
      BalanceDirectory    = ./samples/wireless/data/balance
      UseFlexibleConsumptionRule = True
      CustomEvents
      {
        CycleRollover20days
      }
    }
  } 

Semaphore File Entries

Table 37-4 lists the DAT_BalanceBatch Semaphore file entries.

Table 37-4 DAT_BalanceBatch Semaphore File Entries

Entry	Description
BalanceGroupId	Specifies the ID field of the balance group POID entry. The balance data referenced by BalanceGroupId is written into the file specified by the DataFileName entry.
DataFileName	Specifies the file name that contains balance data. If the BalanceGroupId entry is not present, DAT_BalanceBatch writes all balance data in memory into the file.
LogEvents	Specifies whether events should be stored in a log file. You can also use this entry in the startup registry. See "Using Events to Start External Programs" in BRM System Administrator's Guide.
ReloadCreditThresholdParam	Reloads the value from the CreditThresholdChecking business parameter. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.BalanceDataModule.Module.DataFileName = balData.txt
ifw.DataPool.BalanceDataModule.Module.BalanceGroupId = 70015
ifw.DataPool.BalanceDataModule.Module.LogEvents = True
ifw.DataPool.BalanceDataModule.Module.ReloadCreditThresholdParam{}

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

DAT_BalanceRealtime

The DAT_BalanceRealtime module runs in a real-time discounting pipeline. It retrieves the current balance from the BRM database and supplies the data for real-time discounting.

Note:

Unlike the DAT_BalanceBatch module, the DAT_BalanceRealtime module does not load balance data in memory when you start Pipeline Manager. Instead, it gets balance data in real time from the BRM database by using the NET_EM module.

See the following documents:

• Configuring a Real-Time Discounting Pipeline

• FCT_Discount

Dependencies

The DAT_BalanceRealtime module requires the NET_EM module. It makes a connection to the NET_EM module automatically; you don't need to configure the connection.

Registry Entries

There are no registry entries for the DAT_BalanceRealtime module. You only need to enter the module in the registry DataPool section.

Sample Registry Entry

BalanceDataModule
  {
    ModuleName = DAT_BalanceRealtime
    Module
    {
      #
    }
  }

Semaphore File Entries

DAT_BalanceRealtime does not support semaphore updates.

DAT_Calendar

The DAT_Calendar module provides holiday calendar data for the FCT_MainRating module.

See the following documents:

• "Rating by date and time with Pipeline Manager" in BRM Setting Up Pricing and Rating

• FCT_MainRating

Dependencies

Requires a connection to the Database Connect (DBC) module. See "Database Connect (DBC)".

Registry Entries

Table 37-5 lists the DAT_Calendar registry entries.

Table 37-5 DAT_Calendar Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes

Sample Registry Entry

Calendar 
{ 
  ModuleName = DAT_Calendar 
  Module 
  { 
    DataConnection = ifw.DataPool.Login
  } 
}

Semaphore File Entries

Table 37-6 lists the DAT_Calendar Semaphore file entries.

Table 37-6 DAT_Calendar Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.CalendarDataModule.Module.Reload {}

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Events

Table 37-7 lists the DAT_Calendar events.

Table 37-7 DAT_Calendar Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Data reload was successful.	DAT_Calendar	None
EVT_RELOAD_FAILED	Data reload failed.	DAT_Calendar	None

Database Tables

The DAT_Calendar module uses the following database tables:

• IFW_CALENDAR

• IFW_HOLIDAY

To enter data in these tables, use Pricing Center. See "Creating Holiday Calendars" in BRM Setting Up Pricing and Rating.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

DAT_ConnectionMonitor

This module creates and monitors the idle timeout period for each connection and maintains the state for each client.

Registry Entries

Table 37-8 lists the DAT_ConnectionMonitor registry entries.

Table 37-8 DAT_ConnectionMonitor Registry Entries

Entry	Description	Mandatory
KeepAliveInterval	The idle timeout value in milliseconds, which specifies how long to wait for a message from the client before sending a Device Watchdog Request (DWR) message to the client. Default is 30000.	Yes
KeepAliveQueue	Specifies the pipeline queue to which the dummy EDR for the DWR message is sent.	Yes
ShutdownInterval	The idle timeout value in milliseconds, which specifies how long to wait before shutting down after sending a Disconnect-Peer-Request (DPR) message to the client. Default is 1000.	No
Threads	Number of threads in the pool. Default is 1.	Yes

Sample Registry Entry

ConnectionMonitor
{
  ModuleName = DAT_ConnectionMonitor
  Module
  {
    Threads = 1
    KeepAliveInterval = 30000
    ShutdownInterval = 1000
    KeepAliveQueue = ifw.IPCQueues.INOutputQueue
    
  }
}

Semaphore File Entries

DAT_ConnectionMonitor does not support semaphore updates.

DAT_ConnectionPool

DAT_ConnectionPool module has a set of configured Connection Manager (CM) connections, which the "FCT_Opcode" module uses to connect to the CM and call the appropriate opcode.

For each CM, the DAT_ConnectionPool module maintains a queue for spare connections, determined by the size of the queue.

The DAT_ConnectionPool module balances the load by distributing the required load among the pipelines using the FCT_Opcode module and when there is a CM failure, redistributes the load among the active CMs.

Note:

If a connection fails, the processing pipeline connects to the spare connection of the CM to which it initially connected; if the CM is down, it tries to use a connection from a different CM queue.

If an idle processing pipeline is connected to an inactive CM, The DAT_ConnectionPool module sets the connection status to inactive and updates the pipeline recycle flag, so that when the pipeline starts processing a request it can connect to an active CM.

The DAT_ConnectionPool module initializes the Global Data Dictionary (GDD) during startup by accessing the database.

Note:

If CMs are not available, it uses a file containing the data dictionary flist to initialize the GDD.

Registry Entries

Table 37-9 lists the DAT_ConnectionPool registry entries.

Table 37-9 DAT_ConnectionPool Registry Entries

Entry	Description	Mandatory
InfranetDataDictionaryFileName	The file containing the data dictionary. If a CM is not available, DAT_ConnectionPool uses this file to start and initialize the GDD. If you don't specify a file name, the DAT_ConnectionPool uses the default file, ./gddDataFile.dat, where it stored the data dictionary flists at the initial startup.	No
IdleConnectionBuffer	Size of the queue for spare connections.	Yes
FullQueueTimeout	The interval, in seconds, in which the worker thread pings the queue to check if there is space available in the queue for a connection, when the queue is full. Default is 10 seconds.	No
EmptyQueueTimeout	The interval, in seconds, in which the pipeline thread pings the queue to check if there is a connection available in the queue, when the queue is empty. It can happen during startup of the pipeline or when the CM connection is not working as expected, for example, the CM times out. Default is 1 second.	No
InfranetPool	Specifies the CMs in the connection pool. For each CM in the pool, define the following entries: Host name (Host = CM1_host) Port number (Port =CM1_port) Login name and password for logging into BRM (LoginName = root.0.0.0.1 and LoginPassword =password) Whether to log debug messages (Logging = False. Values are True and False. The default is False.) CM response timeout in milliseconds (SocketTimeOut = 30000.)	Yes

Sample Registry Entry

DataPool
{

   CMConnectionPool
  {
    ModuleName = DAT_ConnectionPool
    Module
    {
      InfranetDataDictionaryFileName = File_with_DD_objects
      IdleConnectionBuffer 
      {
        Size = 2
       }
      FullQueueTimeout = number_of_seconds 
      EmptyQueueTimeout = number_of_seconds 
      InfranetPool
     {
       CM1
         {
           Host = CM1_host
           Port = CM1_port
           LoginName = root.0.0.0.1
           LoginPassword = password
           Logging = True 
           SocketTimeOut = 30000
         }
      CM2
         {
           Host = CM2_host
           Port = CM2_port
           LoginName = root.0.0.0.1
           LoginPassword = password
           Logging = True
           SocketTimeOut = 30000
          }
      }
   }
}

Semaphore File Entries

DAT_ConnectionPool does not support semaphore updates.

DAT_Currency

The DAT_Currency module converts currency symbols to numeric values and retreives resource rounding rules, using data from /config/beid objects in the BRM database. See "Setting up Pipeline Manager Resources" in BRM Setting Up Pricing and Rating.

Dependencies

Requires a connection to the BRM database.

Registry Entries

Table 37-10 lists the DAT_Currency registry entries.

Table 37-10 DAT_Currency Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
InfranetConnection	Specifies the database connection to the BRM database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
ReuseOnFailure	Specifies whether the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.	No

Sample Registry Entry

DAT_Currency
{
  ModuleName = DAT_Currency
  Module 
  {
    ReuseOnFailure = TRUE
    InfranetConnection  = ifw.DataPool.LoginInfranet
    DataConnection = ifw.DataPool.Login
  }
}

Semaphore File Entries

Table 37-11 lists the DAT_Currency Semaphore file entries.

Table 37-11 DAT_Currency Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.CurrencyDataModule.Module.Reload ()

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

DAT_Dayrate

The DAT_Dayrate module provides special day rate data for the FCT_Dayrate module.

See the following documents:

• "About Special Day Rates" in BRM Setting Up Pricing and Rating

• FCT_Dayrate

Dependencies

Requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-12 lists the DAT_Dayrate registry entries.

Table 37-12 DAT_Dayrate Registry Entries

Entry	Description	Mandatory
Buffer	Specifies the size of the internal data buffer.	Yes
DataConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes

Sample Registry Entry

Dayrate 
{ 
  ModuleName = DAT_Dayrate 
  Module 
  { 
    DataConnection = ifw.DataPool.Login
    Buffer = 5000 
  } 
}

Semaphore File Entries

Table 37-13 lists the DAT_Dayrate Semaphore file entries.

Table 37-13 DAT_Dayrate Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading Data into a Pipeline Manager Module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.DayRateDataModule.Module.Reload {}

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

Events

Table 37-14 lists the DAT_Dayrate events.

Table 37-14 DAT_Dayrate Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Data reload was successful.	DAT_Dayrate	None
EVT_RELOAD_FAILED	Data reload failed.	DAT_Dayrate	None

Database Tables

The DAT_Dayrate module uses the following database tables:

• IFW_SPECIALDAYRATE

• IFW_SPECIALDAY_LNK

To enter data in these tables, use Pricing Center. See "Setting Up Global Special Day Rates" in BRM Setting Up Pricing and Rating.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

DAT_Discount

The DAT_Discount module provides discount model data for the FCT_Discount module. See "FCT_Discount".

Dependencies

Requires a connection to:

• The Pipeline Manager database.

• The BRM database.

• The DAT_AccountRealtime or DAT_AccountBatch module.

• The DAT_ModelSelector module.

• The DAT_PortalConfig module.

Registry Entries

Table 37-15 lists the DAT_Discount registry entries.

Table 37-15 DAT_Discount Registry Entries

Entry	Description	Mandatory
AccountDataModule	Specifies the connection to the DAT_AccountRealtime or DAT_AccountBatch module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide.	Yes
InfranetConnection	Specifies the database connection to the BRM database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
EvalScriptFiles	Specify name-value pairs for one or more iScript files. The name is a unique string used to identify the script if there is an error. The value is the relative or absolute path of the file. The iScript files specified in this entry contain functions that can be referenced via EVAL tokens in discount expressions. Any number of files can be specified.	No
IntegrateConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
PortalConfigDataModule	Specifies the connection to the DAT_PortalConfig module. This enables DAT_Discount to retrieve business parameter settings from the DAT_PortalConfig module. See "Using Business Parameter Settings From The BRM Database" in BRM System Administrator's Guide.	Yes

Sample Registry Entry

ifw
{ ....
  DataPool
  { ....
    DiscountModelDataModule
    {
      ModuleName = DAT_Discount
      Module
      {
        IntegrateConnection = ifw.DataPool.Login
        InfranetConnection = ifw.DataPool.LoginInfranet
        AccountDataModule = ifw.DataPool.CustomerData
        #Customizable iScript files supporting EVAL function
        EvalScriptFiles
        {
           scriptFile1 = ../iScriptLib/iScriptLib_Samples/ISC_GetMostCalledInfo.isc
           scriptFile2 = ../iScriptLib/iScriptLib_Samples/ISC_GetLastSixMonthCharge.isc 
        }
      }
    }
  }
}

Semaphore File Entries

Table 37-16 lists the DAT_Discount Semaphore file entries.

Table 37-16 DAT_Discount Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide. Note: Discounting data is reloaded only when the discount configuration contains a new non-currency resource.
ReloadEvalScripts	Reloads and recompiles the iScript files specified in the EvalScriptFiles registry entry.
DiscountModel	The discount models whose data you want written to the output. This entry is used for troubleshooting purposes and must be used in conjunction with the DataFileName semaphore. ALL: Writes all discount codes (such as model codes, rule codes, step codes, and so on) and related configuration information for all discount models in your system. Discount_model_code: Writes the discount codes and related configuration information associated with the specified discount model code (as entered in Pricing Center). Note: You cannot specify multiple discount model codes. You can specify only a single code or ALL.
DataFileName	Where discount model information should be written. This entry is used for troubleshooting purposes and must be used in conjunction with the DiscountModel semaphore. To write the information to a file, specify a file name. By default, the file is created in the Pipeline_Home directory. To write the information to the terminal, leave the value of this entry blank.

Sample Semaphore File Entry

• To reload data from the database and to reload and recompile iScript files:

ifw.DataPool.DiscountModelDataModule.Module.Reload {}
ifw.DataPool.DiscountModelDataModule.Module.ReloadEvalScripts=True

• To write all discount model configuration information to a file named DiscountConfig.log:

ifw.DataPool.DiscountModelDataModule.Module.DiscountCode = ALL
ifw.DataPool.DiscountModelDataModule.Module.DataFileName = DiscountConfig.log

• To write the configuration information for a discount model with the code DM10%off to the terminal:

ifw.DataPool.DiscountModelDataModule.Module.DiscountCode = DM10%OFF
ifw.DataPool.DiscountModelDataModule.Module.DataFileName {}

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Database Tables

The DAT_Discount module uses the following database tables:

• IFW_DISCOUNTMODEL

• IFW_DSCMDL_VER

• IFW_DSCMDL_CNF

• IFW_DSCTRIGGER

• IFW_DSCCONDITION

• IFW_DISCOUNTMASTER

• IFW_DISCOUNTDETAIL

• IFW_DISCOUNTRULE

• IFW_DISCOUNTSTEP

• IFW_DSCBALIMPACT

To enter data in these tables, use Pricing Center. See "Grouping Discount Components into Discount Models".

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_ExchangeRate

The DAT_ExchangeRate module provides currency exchange rate data for the FCT_ExchangeRate module.

See the following documents:

• "Defining Currency Exchange Rates" in BRM Setting Up Pricing and Rating

• FCT_ExchangeRate

Dependencies

Requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-17 lists the DAT_ExchangeRate registry entries.

Table 37-17 DAT_ExchangeRate Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.	No

Sample Registry Entry

ExchangeRateData
{
    ModuleName = DAT_ExchangeRate
    Module
    {
      DataConnection = ifw.DataPool.Login
      ReuseOnFailure = True
    }
}

Semaphore File Entries

Table 37-18 lists the DAT_ExchangeRate Semaphore file entries.

Table 37-18 DAT_ExchangeRate Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.ExchangeRateDataModule.Module.Reload {}

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Events

Table 37-19 lists the DAT_ExchangeRate events.

Table 37-19 DAT_ExchangeRate Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Data reload was successful.	DAT_ExchangeRate	None
EVT_RELOAD_FAILED	Data reload failed.	DAT_ExchangeRate	None

Database Tables

The DAT_ExchangeRate module uses the IFW_EXCHANGE_RATE database table. To enter data in this table, use Pricing Center. See "Defining Currency Exchange Rates" in BRM Setting Up Pricing and Rating.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_InterConnect

The DAT_InterConnect module caches InterConnect and roaming related configuration data. This information is used by FCT_CarrierIcRating module.

Note:

Use the OpFlagExt iScript extension in iScripts to call this module directly to obtain the network operator taxation value flag.

See the following documents:

• "About Rating Roaming Events" in BRM Configuring Roaming in Pipeline Manager

• "About Processing Home Subscribers' Roaming Usage" in BRM Configuring Roaming in Pipeline Manager

• FCT_CarrierIcRating

Dependencies

Requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-20 lists the DAT_InterConnect registry entries.

Table 37-20 DAT_InterConnect Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
LoadPoiAreas	If True, load data from the IFW_POIAREA_LNK table for reseller interconnection network models.	No
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.	Yes

Sample Registry Entry

InterConnect 
{ 
  ModuleName = DAT_InterConnect
  Module
  {
    DataConnection = ifw.DataPool.Login
    ReuseOnFailure = False
  }
}

Semaphore File Entries

Table 37-21 lists the DAT_InterConnect Semaphore file entries.

Table 37-21 DAT_InterConnect Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.
LoadPoiAreas	Specifies if the module should load data from the IFW_POIAREA_LNK table for reseller interconnection network models.
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.

Sample Semaphore File Entry

ifw.DataPool.InterConnect.Module.Reload {}
ifw.DataPool.InterConnectDataModule.Module.ReuseOnFailure = True
ifw.DataPool.InterConnectDataModule.Module.LoadPoiAreas = True

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Database Tables

The DAT_InterConnect module uses the following database tables:

• IFW_NETWORKOPER

• IFW_NETWORKMODEL

• IFW_ICPRODUCT

• IFW_ICPRODUCT_RATE

• IFW_ICPRODUCT_GRP

• IFW_ICPRODUCT_CNF

Data for interconnect rating is stored in the following tables:

• IFW_SWITCH

• IFW_POI

• IFW_TRUNK

• IFW_TRUNK_CNF

• IFW_POIAREA_LNK

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

To enter data in these tables, use Pricing Center.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_ItemAssign

The DAT_ItemAssign module returns the item POID for an item tag to the FCT_ItemAssign and FCT_Billing Record modules. See:

• "Setting Up Batch Rating To Assign Items Based On Event Attributes" in BRM Configuring and Running Billing

• "Creating Custom Bill Items" in BRM Configuring and Running Billing

• FCT_Reject.

Dependencies

Requires a connection to the BRM database and the following modules:

• DAT_AccountBatch

• DAT_PortalConfig

Registry Entries

Table 37-22 lists the DAT_ItemAssign registry entries.

Table 37-22 DAT_ItemAssign Registry Entries

Entry	Description	Mandatory
AccountDataModule	Specifies the connection to the DAT_AccountBatch module. See "Connecting a Pipeline Manager Module to Another Module" in BRM System Administrator's Guide and "DAT_AccountBatch".	Yes
InfranetConnection	Specifies the connection to the BRM database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
ItemPoidReservedRangeUnitSize	Specifies the maximum number of POIDs to be reserved. Default =10000	No
PortalConfigDataModule	Specifies the connection to the DAT_PortalConfig module. This enables the DAT_ItemAssign module to retrieve business parameter settings from the DAT_PortalConfig module. See "Using Business Parameter Settings from the BRM Database" in BRM System Administrator's Guide.	Yes

Sample Registry Entry

Flexible item assignment data module

ItemAssignDataModule
{
  ModuleName = DAT_ItemAssign
  Module
  {
   InfranetConnection = ifw.DataPool.LoginInfranet
   AccountDataModule = ifw.DataPool.CustomerData
   ItemPoidReservedUnitSize = 10000
   PortalConfigDataModule = ifw.DataPool.PortalConfigDataModule
  }
}

Semaphore File Entries

Table 37-23 lists the DAT_ItemAssign Semaphore file entries.

Table 37-23 DAT_ItemAssign Semaphore File Entries

Entry	Description
PrintData	Generates a log file that contains the item tag-to-type mapping information. See "Verifying Item-Tag-to-Item-Type Mapping" in BRM Configuring and Running Billing.
Reload	Reloads data from the Pipeline Manager database. See "Reloading Data into a Pipeline Manager Module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.ItemAssignDataModule.Module.PrintData=TagTypeMap.txt
ifw.dataPool.ItemAssignDataModule.Module.Reload {}

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

DAT_Listener

The DAT_Listener module dequeues business events from a database queue and then sends the data to the DAT_AccountBatch and DAT_Discount modules.

The DAT_Listener module also posts acknowledgment events to the acknowledgment queue in response to business events sent by pin_rerate. See "About comprehensive rerating using pin_rerate" in BRM Setting Up Pricing and Rating.

DAT_Listener module controls whether the Pipeline Manager processes business events or CDRs by interleaving the two processes. You can configure the DAT_Listener module for concurrent or interleaved processing. See "Configuring Interleaved Processing" in BRM Installation Guide.

See the following documents:

• "About Sending Account Data to Pipeline Manager" in BRM Installation Guide

• DAT_AccountBatch

• DAT_Discount

Dependencies

Requires a connection to the database containing the account synchronization queue.

The Listener section of the registry file must be listed after the Pipeline Manager and BRM database connection sections. Otherwise, the Pipeline Manager fails to start.

Registry Entries

Table 37-24 lists the DAT_Listener registry entries.

Table 37-24 DAT_Listener Registry Entries

Entry	Description	Mandatory
AckQueueNameAMM	Specifies the name of the acknowledgment queue for posting AMM-related acknowledgment events.	Yes This entry is mandatory for AMM operations. For more information, see "About Notifying AMM About EDR Processing" in BRM System Administrator's Guide.
AckQueueName	Specifies the name of the acknowledgment queue for posting rerating related acknowledgment events. Default = RERATING_ACK_QUEUE	Yes This entry is mandatory for rerating using pin_rerate. See "About comprehensive rerating using pin_rerate" in BRM Setting Up Pricing and Rating.
BatchSize	The maximum number of events to be dequeued in each dequeuing operation. Default = 10	No
EventsPath	Specifies the directory location of the file that stores the event information retrieved by DAT_Listener if the LogEvents entry is set to True. Default location is the directory where the ifw is launched.	No
EventsPrefix	Specifies the prefix of the name of the file that stores the event information retrieved by DAT_Listener if the LogEvents entry is set to True. Default =listenerLog	No
EventThreadAllocation	Defines the number of threads (in addition to one default thread) to use for dequeuing specific business events. For example: EventThreadAllocation { RecycleRequest = 1 OpenNewActgCycle = 2 } uses 4 threads: one for RecycleRequest business events, two for OpenNewActgCycle business events, and one default thread for dequeuing all other types of business events. For more information, see "About Using Multiple Threads to Dequeue Events" in BRM Installation Guide.	No
InfranetConnection	Specifies the connection to a database with the account synchronization queue. Default = ifw.DataPool.LoginInfranet	Yes
LogEvents	Specifies whether received events should be written to a log file. Default = False	No
NumOfRetries	Specifies the number of times the DAT_Listener module retries to connect to the database queue. Default = 10	No
QueueLibrary	Specifies whether the DAT_Listener module is configured for Oracle AQ. Set QueueLibrary to OracleQueue.	Yes
QueueName	Specifies the name of the database queue from which the DAT_Listener module retrieves events. Default = IFW_SYNC_QUEUE	Yes
RetryInterval	Specifies the time in seconds that the DAT_Listener module waits before trying to reconnect to the database specified in InfranetConnection. Default = 5	No

Registry Entries for Interleaved Processing

The following are registry entries used for interleaved processing.

Important:

The default values for interleaved processing are also the minimum required values. If you specify a value less than the default for any entry, that value is ignored and the minimum default value is used.

Table 37-25 lists the DAT_Listener registry entries for interleaved processing.

Table 37-25 DAT_Listener Registry Entries for Interleaved Processing

Entry	Description	Mandatory
CheckInterval	Specifies (in seconds) how frequently the DAT_Listener module checks the number of events waiting in the queue. If this entry is not present, the default frequency check is used. Important: This entry takes precedence over MaxNumEvents, MinNumEvents, MaxEventProcessTime, and MaxCDRProcessTime. For example, if MaxEventProcessTime is set to 3600 seconds, and CheckInterval is set to 7200 seconds, events are processed for 7200 seconds. Default = 60	No
EnableInterLeaving Statistics	Specifies whether to log only interleaving statistical data. If set to False, all processing messages are logged. Default = False	No
InterleavingReqd	Specifies whether interleaved processing is enabled: True = Enabled False = Not enabled When set to False or not specified, interleaved processing is not performed; CDRs and events are processed simultaneously. Default = False	No
MaxCDRProcessTime	Specifies the maximum number of seconds that CDRs are processed. When the pipeline has been processing CDRs for this amount of time, the DAT_Listener module stops CDR processing and starts business event processing regardless of how many business events are in the queue. Default and minimum allowed = 300	If MaxEventProcessTime is specified and InterleavingReqd is set to TRUE, yes. Otherwise, no.
MaxEventProcessTime	Specifies the maximum number of seconds that business events are processed. When the pipeline has been processing business events for this amount of time, the DAT_Listener module stops business event processing and starts CDR processing regardless of how many business events are in the queue. Default and minimum allowed = 60	If MaxCDRProcessTime is specified and InterleavingReqd is set to TRUE, yes. Otherwise, no.
MaxNumEvents	Specifies the maximum number of business events allowed in the queue. When the number of events in the queue reaches or exceeds this amount, DAT_Listener stops pipeline CDR processing and starts business event processing. Default and minimum allowed = 900	Yes, if InterleavingReqd is set to True. Otherwise, no. Requires that you also specify MinNumEvents and MaxNumEvents is greater than MinNumEvents.
MinNumEvents	Specifies the minimum number of business events allowed in the queue. When the number of events in the queue reaches or drops below this amount, the DAT_Listener stops business event processing and starts CDR processing. Default and minimum allowed = 300	Yes, if InterleavingReqd is set to True. Otherwise, no.
ProcessAllEvents	Specifies whether to process all business events in the queue when Pipeline Manager is started: True = Processes all business events in the queue before activating interleaved processing. False = Interleaved processing is activated at startup. Business events are processed according to the interleaving settings. If set to True at startup, after processing all business events, this entry is reset to False. To process all business events at startup, you must reset this entry to True each time you restart Pipeline Manager. Default = False	No

Sample Registry Entry

Listener 
{ 
    ModuleName = DAT_Listener 
    Module 
    { 
       InfranetConnection = ifw.DataPool.LoginInfranet
       QueueLibrary = OracleQueue
       QueueName = IFW_SYNC_QUEUE
       NumOfRetries = 1
       RetryInterval = 5 
       LogEvents = TRUE

       InterleavingReqd = true
       MaxNumEvents = 900
       MinNumEvents = 300
       CheckInterval = 60
       EnableInterLeavingStatistics = false
       ProcessAllEvents = true
       MaxEventProcessTime = 60
       MaxCDRProcessTime = 300
    } 
} 

Semaphore File Entries

Table 37-26 lists the DAT_Listener Semaphore file entries.

Table 37-26 DAT_Listener Semaphore File Entries

Entry	Description
AckQueueNameAMM	Specifies the name of the acknowledgment queue for posting AMM-related acknowledgment events. To add or modify this entry without having to stop the pipeline, use the Disconnect semaphore to disconnect the Listener before setting it. After specifying the queue name, use the Connect semaphore to reconnect the Listener to the pipeline for the new value to take effect.
CheckInterval	Specifies (in seconds) how frequently the DAT_Listener module checks the number of events waiting in the queue. If this entry is not present, the default frequency check is used.
Connect{}	Reconnects the DAT_Listener module event dequeuing threads to the Account Synchronization queue.
Disconnect{}	Disconnects the DAT_Listener module event dequeuing threads from the Account Synchronization queue. The module checks the dequeuing threads before disconnecting them: If a thread is in the middle of processing an event, the module waits until the pipeline finishes processing events, and then suspends and disconnects the thread from the queuing database. If a thread is not in the middle of processing an event, the module suspends and disconnects the thread from the queuing database.
EnableDequeueStatistics	Specifies whether to log dequeue statistics in the process log. TRUE = Log dequeue statistics FALSE = Do not log dequeue statistics (Default) Note: When set to TRUE, the size of the process log increases. Additionally, there may be a performance impact due to file input and output processing. Use this entry for diagnostic purposes only and should not be used otherwise.
EnableInterLeavingStatistics	Specifies whether to log only interleaving statistical data. If set to False, all processing messages are logged.
LogEvents	Specifies whether received events should be written to a log file. Default = False
MaxCDRProcessTime	Specifies the maximum number of seconds that CDRs are processed. When the pipeline has been processing CDRs for this amount of time, the DAT_Listener module stops CDR processing and starts business event processing regardless of how many business events are in the queue. Required when MaxEventProcessTime is specified. Requires that you also specify MaxNumEvents, MinNumEvents, and MaxEventProcessTime.
MaxEventProcessTime	Specifies the maximum number of seconds that business events are processed. When the pipeline has been processing business events for this amount of time, the DAT_Listener module stops business event processing and starts CDR processing regardless of how many business events are in the queue. Required when MaxCDRProcessTime is specified. Requires that you also specify MaxNumEvents, MinNumEvents, and MaxCDRProcessTime.
MaxNumEvents	Specifies the maximum number of business events allowed in the queue. When the number of events in the queue reaches this amount, the DAT_Listener module stops pipeline CDR processing and starts business event processing. Required when MinNumEvents, MaxEventProcessTime, or MaxCDRProcessTime is specified. Requires that you also specify MinNumEvents.
MinNumEvents	Specifies the minimum number of business events allowed in the queue. When the number of events in the queue reaches this amount, the DAT_Listener module stops business event processing and starts CDR processing. Required when MaxNumEvents, MaxEventProcessTime, or MaxCDRProcessTime is specified. Requires that you also specify MaxNumEvents.

Sample Semaphore File Entry

ifw.DataPool.Listener.Module.CheckInterval=180
ifw.DataPool.Listener.Module.EnableInterLeavingStatistics=true
ifw.DataPool.Listener.Module.Disconnect{}
ifw.DataPool.Listener.Module.Connect{}

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

DAT_ModelSelector

When a model selector is used to rate or discount an EDR, the DAT_ModelSelector module evaluates the model selector rules to determine the correct price or discount model. The rules are evaluated in the order they are ranked in the model selector.

The following rating and discounting modules get the model information from DAT_ModelSelector:

• FCT_MainRating gets the price model from DAT_ModelSelector. See "FCT_MainRating".

• FCT_DiscountAnalysis gets the discount model from DAT_ModelSelector. See "FCT_DiscountAnalysis".

See the following documents:

• "About Price Model Selectors" in BRM Setting Up Pricing and Rating

• About Discount Model Selectors

Dependencies

Requires a connection to the Database Connect (DBC) module. See "Database Connect (DBC)".

The module uses event notification to refresh customized product data. You must configure a connection to DAT_Listener if you plan to use this feature. See "DAT_Listener".

Registry Entries

Table 37-27 lists the DAT_ModelSelector registry entries.

Table 37-27 DAT_ModelSelector Registry Entries

Entry	Description	Mandatory
IntegrateConnection	Specifies the connection to the Pipeline Manager database. This typically points to the login registry section. For example: IntegrateConnection = ifw.DataPool.Login See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
ListenerDataModule	Specifies the connection to the DAT_Listener module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Listener".	No

Sample Registry Entry

ModelSelectorDataModule
    {
      ModuleName = DAT_ModelSelector
      Module
      {
     ListenerDataModule  = ifw.DataPool.Listener
        IntegrateConnection = ifw.DataPool.Login
        LogEvents           = True
      }

Semaphore File Entries

Table 37-28 lists the DAT_ModelSelector Semaphore file entries.

Table 37-28 DAT_ModelSelector Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.
DiscountModel	The discount models whose data you want written to the output. This entry is used for troubleshooting purposes and must be used in conjunction with the DataFileName semaphore. ALL: Writes all discount codes (such as model codes, rule codes, step codes, and so on) and related configuration information for all discount models in your system. Discount_model_code: Writes the discount codes and related configuration information associated with the specified discount model code (as entered in Pricing Center). Note: You cannot specify multiple discount model codes. You can specify only a single code or ALL.
DataFileName	Where discount model information should be written. This entry is used for troubleshooting purposes and must be used in conjunction with the DiscountModel semaphore. To write the information to a file, specify a file name. By default, the file is created in the Pipeline_Home directory. To write the information to the terminal, leave the value of this entry blank.

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry

To reload data from the database and to reload and recompile iScript files:

ifw.DataPool.ModelSelectorDataModule.Module.Reload {}

To write all model selector configuration information to a file named ModelSelectorConfig.log:

ifw.DataPool.ModelSelectorDataModule.Module.ModelSelectorCode = ALL

ifw.DataPool.ModelSelectorDataModule.Module.DataFileName = ModelSelectorConfig.log

To write the configuration information for a model selector with the code DMS10%off to the terminal:

ifw.DataPool.ModelSelectorDataModule.Module.ModelSelectorCode = DMS10%off
ifw.DataPool.ModelSelectorDataModule.Module.DataFileName {} 

Database Tables

The DAT_ModelSelector module uses the following database tables:

• IFW_MODEL_SELECTOR. This table stores all model selector information in the Pipeline Manager database. It has a type field to indicate whether a model selector is for discounting or rating.

  To enter data in this table, use Pricing Center. See "About Price Model Selectors" in BRM Setting Up Pricing and Rating and "About Discount Model Selectors".

• IFW_SELECTOR_RULESET. This table maps model selector rules to specific model selectors. Rules associated with a model selector are ranked in order of priority. To enter data in this table, use Pricing Center. See "About Price Model Selectors" in BRM Setting Up Pricing and Rating and "About Discount Model Selectors".

• IFW_SELECTOR_RULE. This table stores information for each model selector rule, including the code, name, and rule links. To enter data in this table, use Pricing Center. See "About Price Model Selectors" in BRM Setting Up Pricing and Rating and "About Discount Model Selectors".

• IFW_SELECTOR_RULE_LNK. This table maps a model selector rule to its detail or block. To enter data in this table, use Pricing Center. See "About Price Model Selectors" in BRM Setting Up Pricing and Rating and "About Discount Model Selectors".

• IFW_SELECTOR_DETAIL. This table stores each model selector's rule details; the EDR field and value. To enter data in this table, use Pricing Center. See "About Price Model Selectors" in BRM Setting Up Pricing and Rating and "About Discount Model Selectors".

• IFW_SELECTOR_BLOCK. This table stores block information for a model selector rule. This table is for future use.

• IFW_SELECTOR_BLOCK_LNK. This table maps a block to a selector detail or to another block. This table is for future use.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_NOSP

The DAT_NOSP module 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:

• Identifying the Network Operator/Service Provider

• About Multi-Segment Rating

• FCT_NOSP

Dependencies

DAT_NOSP module supports both file and database option.

If configured to get data from the database, the DAT_NOSP module requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-29 lists the DAT_NOSP registry entries.

Table 37-29 DAT_NOSP Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the database connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes, if the data is stored in the database. Otherwise is not used.
FileName	Specifies the path and file name of the initialization file. See "Creating an NO/SP Data File". You can use this entry in a semaphore file.	Yes, if the data is stored in a file. Otherwise is not used.
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.	Yes
Source	Specifies where the data is stored: File Database	Yes

Sample Registry Entry for the Database Interface

NospData
{
  ModuleName = DAT_NOSP
  Module
  {
    Source = Database
    DataConnection = ifw.DataPool.Login
    ReuseOnFailure = FALSE
  }
}

Sample Registry Entry for the File Interface

NOSP 
{ 
  ModuleName = DAT_NOSP 
  Module 
  { 
    ReuseOnFailure = FALSE 
    Source = File 
    FileName = ./cfg/NOSP_Config1.dat 
  } 
}

Format of the file:

RANK;OLD_SOURCE;OLD_DESTINATION;A_PREFIX;NEW_SOURCE;NEW_DESTINATION;

For example,

ALL_RATE;1;ABC;BCD;0987;XYZ;YZA;

Semaphore File Entries

Table 37-30 lists the DAT_NOSP Semaphore file entries.

Table 37-30 DAT_NOSP Semaphore File Entries

Entry	Description
FileName	Specifies the path and file name of the initialization file.
Reload	Reloads data from the Pipeline Manager database. Only used if data is stored in the database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry for the Database Interface

ifw.DataPool.NOSP.Module.Reload {}

Sample Semaphore File Entry for the File Interface

ifw.DataPool.NOSP.Module.FileName = ./cfg/NOSP_Config2.dat

Database Tables

The DAT_NOSP module uses the following tables:

• IFW_NOSP

• IFW_GROUP

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

DAT_NumberPortability

The DAT_NumberPortability module provides number portability data to the FCT_NumberPortability module.

See the following documents:

• "Managing number portability" in BRM Telco Integration

• FCT_NumberPortability

Registry Entries

Table 37-31 lists the DAT_NumberPortability registry entries.

Table 37-31 DAT_NumberPortability Registry Entries

Entry	Description	Mandatory
CountryCode	Specifies the country code, for example 49 for Germany. This is needed for normalization of CLIs. See "Configuring Normalization for Number Portability".	Yes
FileName	Specifies the name of the number portability file. See "Creating a Number Portability Data File".	Yes
InternationalAccessCode	Specifies the international access code. This is needed for normalization of CLIs. Default = 00 See "Configuring Normalization for Number Portability".	No
InternationalAccessCodeSign	Specifies the international access code sign. This is needed for normalization of CLIs. Default = + See "Configuring Normalization for Number Portability".	No
NationalAccessCode	Specifies the national access code, for example 0 for Germany. This is needed for normalization of CLIs. See "Configuring Normalization for Number Portability".	Yes
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.	No
SearchMethod	Specifies which search method to use. 0 specifies to use best match. 1 specifies to use exact match. 2 specifies to use first prefix match. Default = 0 See "Configuring Number Portability Search".	No

Sample Registry Entry

NumberPortabilityData
{ 
  ModuleName = DAT_NumberPortability
  Module
  {
    FileName = ./data/primary_np.data
    CountryCode = 49 
    NationalAccessCode = 0
    SearchMethod = 0
  }
}

Semaphore File Entries

Table 37-32 lists the DAT_NumberPortability Semaphore file entries.

Table 37-32 DAT_NumberPortability Semaphore File Entries

Entry	Description
AdditionalNumPortData	Specifies the name of the ASCII file that contains the newly ported numbers to reload. Important: This parameter must not be used with the Reload semaphore entry. Otherwise, an error message is logged and nothing is updated.
PrintData	Specifies the name of the ASCII file in which to print all newly ported numbers. Important: If this entry is specified with the Reload or AdditionalNumPortData semaphore entries, the PrintData entry is processed last.
Reload	Reloads data from the number portability data file. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide. Important: You cannot use this entry at the same time as the AdditionalNumPortData semaphore entry.

Sample Semaphore File Entry

ifw.DataPool.NumberPortability.Module.Reload {}
ifw.DataPool.NumberPortability.Module.AdditionalNumPortData=./data/primary_np.data
ifw.DataPool.NumberPortability.Module.PrintData=./data/records.nport.dump

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Events

Table 37-33 lists the DAT_NumberPortability Events.

Table 37-33 DAT_NumberPortability Events

Event Name	Trigger	Sender	Parameter
EVT_ADD_NUM_PORT_DATA_SUCCESSFUL	Adding new number Portability data succeeded.	DAT_NumberPortability	None
EVT_ADD_NUM_PORT_DATA_FAILED	Adding new number portability data failed.	DAT_NumberPortability	None

DAT_PortalConfig

The DAT_PortalConfig module loads data from the /config/event_order_criteria, /config/business_params, and /config/credit_profile objects in the BRM database.

For more information, see the following:

• "About Automatic Rerating of Out-Of-Order Events" in BRM Setting Up Pricing and Rating

• "Using Business Parameter Settings From The BRM Database" in BRM System Administrator's Guide

• "About credit limit and threshold checking during batch rating" in BRM Managing Customers

Dependencies

This module requires a connection to the Database Connect (DBC) module. See "Database Connect (DBC)".

Important:

Due to the dependency of other data modules on DAT_PortalConfig, the DAT_PortalConfig registry entries must appear before all other data module entries in the registry file.

Registry Entries

Table 37-34 lists the DAT_PortalConfig registry entries.

Table 37-34 DAT_PortalConfig Registry Entries

Entry	Description	Mandatory
InfranetConnection	Specifies the connection to the DBC module.	Yes

Sample Registry Entry

PortalConfigDataModule 
{ 
  ModuleName       = DAT_PortalConfig
  Module 
  { 
    InfranetConnection = ifw.DataPool.LoginInfranet
  } 
}

Semaphore File Entries

Table 37-35 lists the DAT_PortalConfig Semaphore file entries.

Table 37-35 DAT_PortalConfig Semaphore File Entries

Entry	Description
CBPPrintData	Prints the /config/business_params data stored in the DAT_PortalConfig module's memory. If a filename is not provided, the module dumps the data into a file named DefaultCBPDataFile_Timestamp.lst. See "Printing business parameter settings stored in DAT_PortalConfig memory" in BRM System Administrator's Guide.
CreditProfilePrintData	Prints the /config/credit_profile data stored in the DAT_PortalConfig module's memory. If a filename is not provided, the module dumps the data into a file named DefaultConfigCreditProfileDataFile_Timestamp.lst. See "Printing business parameter settings stored in DAT_PortalConfig memory" in BRM System Administrator's Guide.
CBPReload	Reloads /config/business_params data. See "Refreshing business parameter settings stored in DAT_PortalConfig memory" in BRM System Administrator's Guide.
CreditProfileReload	Reloads /config/credit_profile data.
PrintData	Prints all the data stored in the DAT_PortalConfig module's memory. If a filename is not provided, the module dumps the data to the standard output console.
OODReload	Reloads /config/event_order_criteria data.
OODPrintData	Prints the /config/event_order_criteria data stored in the DAT_PortalConfig module's memory. If a filename is not provided, the module dumps the data into a file named DefaultOODDataFile_Timestamp.lst.

Sample Semaphore File Entry

ifw.DataPool.PortalConfigDataModule.Module.CreditProfile.Reload{}
ifw.DataPool.PortalConfigDataModule.Module.Reload{}
ifw.DataPool.PortalConfig.Module.CBPPrintData=BRM/config/prntCBPdata
ifw.DataPool.PortalConfig.Module.OODPrintData=BRM/config/prntOODdata

Events

Table 37-36 lists the DAT_PortalConfig events.

Table 37-36 DAT_PortalConfig Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Reload was successful.	DAT_PortalConfig	None
EVT_RELOAD_FAILED	Reload failed.	DAT_PortalConfig	None

Database Tables

The DAT_PortalConfig module uses the following database tables:

• CONFIG_T

• CONFIG_EVENT_ORDER_CRITERIA_T

DAT_PrefixDesc

The DAT_PrefixDesc module provides data for mapping phone number prefixes to descriptions, used by the FCT_PrefixDesc module.

See the following documents:

• Creating Call Destination Descriptions

• FCT_PrefixDesc

Dependencies

If data is stored in the database, the DAT_PrefixDesc module requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-37 lists the DAT_PrefixDesc registry entries.

Table 37-37 DAT_PrefixDesc Registry Entries

Entry	Description	Mandatory
CLIBase	Specifies if the zone tree values should be hexadecimal or decimal. You can use this entry in a semaphore file.	Yes
DataConnection	Specifies the connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes, if the data is stored in the database. Otherwise is not used.
PrefixDesc.File	Specifies the file prefix for the files that contain prefix descriptions. See "Creating a Prefix/Description Data File". You can use this entry in a semaphore file.	Yes, if the data is stored in a file. Otherwise is not used.
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails. If True, the old data is used. If the entry is not used, the default is False.	Yes
Source	Specifies where the module gets data: File Database	Yes

Sample Registry Entry for the Database Interface

PrefixDescDataModule
{
  ModuleName = DAT_PrefixDesc
  Module
  {
    Source = Database
    DataConnection = ifw.DataPool.Login
    ReuseOnFailure = false
    CLIBase = 10
  }
}

Sample Registry Entry for the File Interface

PrefixDescData
{
  ModuleName = DAT_PrefixDesc
  Module
  {
    Source = File
    ReuseOnFailure = false
    CLIBase = 10
    PrefixDesc
    {
      File = ../daten/forgn_names.dat
      File = ../daten/onkz_names.dat
    }
  }
}

Semaphore File Entries

Table 37-38 lists the DAT_PrefixDesc Semaphore file entries.

Table 37-38 DAT_PrefixDesc Semaphore File Entries

Entry	Description
CLIBase	Specifies if the zone tree values should be hexadecimal or decimal. Valid values are 10(DEC) and 16(HEX).
PrefixDesc.File	Specifies the file prefix for the files that contain prefix descriptions.
Reload	Reloads the data. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.PrefixDescDataModule.Module.Reload {}

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Events

Table 37-39 lists the DAT_PrefixDesc events.

Table 37-39 DAT_PrefixDesc Events

Event name	Trigger	Sender	Parameter
EVT_RELOAD_FAILED	Update semaphore	DAT_PrefixDesc	None
EVT_RELOAD_SUCCESSFUL	Update semaphore	DAT_PrefixDesc	None

Database Tables

The DAT_PrefixDesc module uses the IFW_DESTINDESC database table.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

To enter data in this table, use Pricing Center. See "Creating Call Destination Descriptions".

DAT_PriceModel

The DAT_PriceModel module provides price model data for the FCT_MainRating module.

See the following documents:

• About Pipeline Rating

• FCT_MainRating

Dependencies

Requires a connection to the Pipeline Manager database.

This module uses event notification to refresh customized product data. You must configure a connection to "DAT_Listener" if you plan to use this feature.

This module uses the TailormadeProductsSearch business parameter to skip lock on a price model. If you do not use tailor-made products, and intend to skip lock on a price model, configure a connection to the DAT_PortalConfig module.

Registry Entries

Table 37-40 lists the DAT_PriceModel registry entries.

Table 37-40 DAT_PriceModel Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
Listener	Specifies the connection to the DAT_Listener module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Listener".	No
LogEvents	Specifies whether notification events received by the module are written to the process log file. Default = False See "Troubleshooting event handling" in BRM System Administrator's Guide.	No
PortalConfigDataModule	Specifies the connection to the DAT_PortalConfig module and enables DAT_PriceModel to retrieve business parameter settings from the DAT_PortalConfig module. See "Using Business Parameter Settings from the BRM Database" in BRM System Administrator's Guide.	No

Sample Registry Entry

PriceModel 
{ 
  ModuleName = DAT_PriceModel 
  Module 
  { 
    DataConnection = ifw.DataPool.Login
    Listener = ifw.DataPool.Listener
  } 
}

Semaphore File Entries

Table 37-41 lists the DAT_PriceModel Semaphore file entries.

Table 37-41 DAT_PriceModel Semaphore File Entries

Entry	Description
Reload	Reloads the data from the database. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.
PrintAllPriceModels	Prints all price models in the configuration.
PrintOnePriceModel <PriceModel ID>	Prints the price model ID.
PrintRangeOfPriceModels <PriceModel fromID> <PriceModel toID>	Prints all the price models where ID is in the range.

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.PriceDataModule.Module.Reload {}

Events

Table 37-42 lists the DAT_PriceModel events.

Table 37-42 DAT_PriceModel Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Reload was successful.	DAT_PriceModel	None
EVT_RELOAD_FAILED	Reload failed.	DAT_PriceModel	None

Database Tables

The DAT_PriceModel module uses the following database tables:

• IFW_PRICEMODEL. This table stores price model data. To enter data in this table, use Pricing Center. See "Creating pipeline rate plans and price models" in BRM Setting Up Pricing and Rating.

• IFW_PRICEMDL_STEP. This table stores price model step data. To enter data in this table, use Pricing Center.

• IFW_RESOURCE. This table stores resource configuration data. To enter data in this table, use Pricing Center.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_Rateplan

The DAT_Rateplan module provides rate plan data for the FCT_MainRating module.

See the following documents:

• About Configuring Pipeline Rating

• FCT_MainRating

Dependencies

Requires a connection to the Pipeline Manager database.

This module uses event notification to refresh customized product data. You must configure a connection to "DAT_Listener" if you plan to use this feature.

This module uses the TailormadeProductsSearch business parameter to skip lock on rate plans. If you do not use tailor-made products, and intend to skip lock on rate plans, configure a connection to the DAT_PortalConfig module.

Registry Entries

Table 37-43 lists the DAT_Rateplan registry entries.

Table 37-43 DAT_Rateplan Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
Listener	Specifies the connection to the DAT_Listener module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Listener".	No
LogEvents	Specifies whether notification events received by the module are written to the process log file. Default = False See "Troubleshooting event handling" in BRM System Administrator's Guide.	No
PortalConfigDataModule	Specifies the connection to the DAT_PortalConfig module and enables DAT_RatePlan to retrieve business parameter settings from the DAT_PortalConfig module. See "Using Business Parameter Settings from the BRM Database" in BRM System Administrator's Guide.	No
RowFetchSize	Specifies the number of rows of data to retrieve from the BRM database. Default = 1000	RowFetchSize

Sample Registry Entry

Rateplan 
{ 
  ModuleName = DAT_Rateplan
  Module 
  { 
    DataConnection = ifw.DataPool.Login
    Listener = ifw.DataPool.Listener
  } 
}

Semaphore File Entries

Table 37-44 lists the DAT_Rateplan Semaphore file entries.

Table 37-44 DAT_Rateplan Semaphore File Entries

Entry	Description
Reload	Reloads the rating configuration data. See "Reloading data into a Pipeline Manager module" in BRM System Administrator's Guide.
PrintAllRateplans	Prints all rate plans in the configuration.
PrintOneRateplan <RatePlan ID>	Prints the rate plan ID.
PrintRangeOfRateplans <RatePlan fromID> <RatePlan toID>	Prints all the rate plans where ID is in the range.

For more information, see "Semaphore file syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.RateplanDataModule.Module.Reload {}

Events

Table 37-45 lists the DAT_Rateplan events.

Table 37-45 DAT_Rateplan Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Reload was successful.	DAT_Rateplan	None
EVT_RELOAD_FAILED	Reload failed.	DAT_Rateplan	None

Database Tables

The DAT_Rateplan module uses rate plan data from the following database tables:

• IFW_RATEPLAN

• IFW_RATEPLAN_VER

• IFW_RATEPLAN_CNF

To enter data in these tables, use Pricing Center. See "About pipeline rate plans" in BRM Setting Up Pricing and Rating.

The DAT_Rateplan module uses RUM data from the following database tables:

• IFW_RUM

• IFW_RUMGROUP

• IFW_RUMGROUP_LNK

To enter data in these tables, use Pricing Center. See "About Defining Ratable Usage Metrics (RUMs)" in BRM Setting Up Pricing and Rating.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_Recycle

The DAT_Recycle module is used by standard recycling and Suspense Manager EDR to recycle EDRs. It connects to the DAT_Listener module and waits for business events that call for EDRs to be recycled.

This module creates a parameter file that allows the "EXT_InEasyDB" module to read suspended usage records associated with a recycle job. It also provides an interface for the "INP_Recycle" module to provide status updates about the EDR stream.

Dependencies

Requires a connection to the "DAT_Listener" module.

Registry Entries

Table 37-46 lists the DAT_Recycle registry entries.

Table 37-46 DAT_Recycle Registry Entries

Entry	Description	Mandatory
ControlPath	Specifies the path for SQL, parameter, job and restart files. ./database/Oracle/Scripts/Suspense	Yes
Listener	Specifies the connection to the DAT_Listener module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Listener".	Yes
LogEvents	Specifies whether notification events received by the module are written to the process log file. Default = False See "Troubleshooting Event Handling" in BRM System Administrator's Guide.	Yes
ParameterFile	Specifies the name of the parameter file which contains optional key/value entries.	Yes
ProcessCount	Specifies the threshold job count in the QueueFileName file. When the threshold is reached, the DAT_Recycle cleans up the queue. If not specified, the default value is 50.	No
QueueFileName	Specifies the name of the file that stores recycle job IDs to be processed.	Yes
QueueFilePath	The path to the queue file specified for QueueFileName.	Yes

Sample Registry Entry

#-----------------------------------------------------------
# Recycling Data
#-----------------------------------------------------------
RecyclingData
{
  ModuleName               = DAT_Recycle
  Module
  {
    Listener = ifw.DataPool.Listener
    LogEvents = True
    ControlPath = ./database/Oracle/Scripts/Suspense
    ParameterFile = parameter.isc
    QueueFileName = RecycleJobIds_wireless.dat
    QueueFilePath = ./data
    ProcessCount = 50
  }
}

Semaphore File Entries

DAT_Recycle does not support semaphore updates.

DAT_ResubmitBatch

The DAT_ResubmitBatch module supports batch suspension and resubmission.

DAT_ResubmitBatch subscribes to "DAT_Listener" for ResubmitBatchRequest event. Upon receiving this, it gets information for all the batches corresponding to this ResubmitBatchRequest from the BRM database. It then moves all these batches to their respective pipeline input directories.

A ResubmitBatchRequest is propagated to the ifw through ifw_sync when a user resubmits a suspended batch with the SMC. During resubmission, a notification event (/event/notification/suspense/batch_resubmit) is generated with the admin action job id. This notification event is propagated to the ifw through ifw_sync in form of ResubmitBatchRequest.

Dependencies

This module requires connections to the following:

• BRM database.

• Pipeline Manager database.

• DAT_Listener module. See "DAT_Listener".

Registry Entries

Table 37-47 lists the DAT_ResubmitBatch registry entries.

Table 37-47 DAT_ResubmitBatch Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies the connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes
Listener	Specifies the connection to the DAT_Listener module. See "Connecting A Pipeline Manager Module To Another Module" in BRM System Administrator's Guide and "DAT_Listener".	Yes
LogEvents	Logs each request received from the listener when true. Default = True See "Troubleshooting Event Handling" in BRM System Administrator's Guide.	No
QueueFileName	Name of file for file based queue. For example: QueueFileName = ResubmitJobIds.dat	No
QueueFilePath	Path of file for file based queue	No
QueueFileCleanupThreshold	For already processed events cleanup.	No
PipelineCategory	The Pipeline Category for the records. The module should only process records of its own pipeline category For example: PipelineCategory= CDRPipeline	Yes
TempDirectoryPath	Temporary directory path, used as a staging directory for resubmitted batches. It should not be used for any other purpose. For example: TempDirectoryPath = ./data/tmp	No

Sample Registry Entry

ResubmitBatch
  {
    ModuleName = DAT_AccountBatch
    Module
    {
      DataConnection       = ifw.DataPool.LoginInfranet
      Listener             = ifw.DataPool.Listener
      LogEvents            = True
      QueueFileName        = ResubmitJobIds.dat
      QueueFilePath        = ./dataQueue
      FileCleanupThreshold = 50
      PipelineCategory     = CDRPipeline
      TmpDirectoryPath     = ./data/tmp
    }
  }

Semaphore File Entries

DAT_ResubmitBatch does not support semaphore updates.

DAT_ScenarioReader

The DAT_ScenarioReader module provides aggregation scenario data for the FCT_AggreGate module.

See the following documents:

• Setting Up Pipeline Aggregation

• FCT_AggreGate

Dependencies

Requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-48 lists the DAT_ScenarioReader registry entries.

Table 37-48 DAT_ScenarioReader Registry Entries

Entry	Description	Mandatory
Calendar	Specifies the calendar that is used for holiday evaluation. Default = No calendar	No
DataCollection	Specifies a connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes

Sample Registry Entry

ScenarioReader
{
  ModuleName = DAT_ScenarioReader
  Module
  {
    DataConnection = ifw.DataPool.Database
    Calendar = 2
  }
} 

Semaphore File Entries

Table 37-49 lists the DAT_ScenarioReader Semaphore file entries.

Table 37-49 DAT_ScenarioReader Semaphore File Entries

Entry	Description
Reload	Reloads aggregation scenarios. See "Reloading Data into a Pipeline Manager Module" in BRM System Administrator's Guide.

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.ScenarioReader.Module.Reload {}

Messages and Requests

Table 37-50 lists the DAT_ScenarioReader messages and requests.

Table 37-50 DAT_ScenarioReader Messages and Requests

Message/Request	Description	Sending/Receiving
REQ_EVENTHANDLER_NAME	Get the Event Handler.	Send to controller.

Events

Table 37-51 lists the DAT_ScenarioReader events.

Table 37-51 DAT_ScenarioReader Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Data reload was successful.	DAT_ScenarioReader	None
EVT_RELOAD_FAILED	Data reload failed.	DAT_ScenarioReader	None

Database Tables

The DAT_ScenarioReader module uses the following database tables:

• IFW_SCENARIO. This table stores the aggregation scenario parameters. Some values can be overwritten by using the FCT_AggreGate registry.

• IFW_EDRC_FIELD. This table defines the EDR container fields for the aggregation scenarios. Each scenario uses exactly one EDR container description.

• IFW_CONDITION. This table stores the conditions that exclude an EDR or parts of an EDR from the aggregation process.

• IFW_GROUPING. This tables stores the scenario groupings that group aggregated results into subgroups. You can summarize the values within a grouping into subclasses.

• IFW_AGGREGATION. This tables stores aggregation functions and specifies how to handle the results.

• IFW_GROUPING_CNF. This table links data classes to a grouping.

• IFW_CLASS. This table defines the grouping classes. Each class consists of several class items.

• IFW_CLASSITEM. This table defines class items. All grouping values matching a class item are summarized and the class item code is added to the result.

• IFW_CLASS_LNK. This table links items and classes.

• IFW_CLASSCON. This table defines the class conditions. They determine which class to use when more than one class is associated to a grouping. A class condition specifies the dependency between a class from one grouping and a class item from another grouping.

• IFW_CLASSCON_LNK. This table links class conditions to one or more class items.

To enter data in these tables, use Pricing Center.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_TimeModel

The DAT_TimeModel module provides time model, time zone, and day code data for the FCT_Mainrating module.

See the following documents:

• "Rating By Date and Time with Pipeline Manager" in BRM Setting Up Pricing and Rating

• FCT_MainRating

Dependencies

Requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-52 lists the DAT_TimeModel registry entries.

Table 37-52 DAT_TimeModel Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies a connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes

Sample Registry Entry

TimeModel 
{ 
  ModuleName = DAT_TimeModel 
  Module 
  { 
    DataConnection = ifw.DataPool.Login
  } 
}

Semaphore File Entries

Table 37-53 lists the DAT_TimeModel Semaphore file entries.

Table 37-53 DAT_TimeModel Semaphore File Entries

Entry	Description
Reload	Reloads data from the Pipeline Manager database. See "Reloading Data into a Pipeline Manager Module" in BRM System Administrator's Guide.

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.TimeDataModule.Module.Reload {}

Events

Table 37-54 lists the DAT_TimeModel events.

Table 37-54 DAT_TimeModel Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Data reload was successful.	DAT_TimeModel	None
EVT_RELOAD_FAILED	Data reload failed.	DAT_TimeModel	None

Database Tables

The DAT_TimeModel module uses the following database tables:

• IFW_TIMEMODEL

• IFW_TIMEMODEL_LNK

• IFW_DAYCODE

• IFW_TIMEINTERVAL

• IFW_TIMEZONE

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

To enter data in these tables, use Pricing Center.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_USC_Map

The DAT_USC_Map module provides usage scenario mapping data. See "Setting Up Usage Scenario Mapping" in BRM Setting Up Pricing and Rating.

The DAT_USC_Map module retrieves mapping data from an ASCII file or from the Pipeline Manager database. This data is used by the FCT_USC_Map module to perform usage scenario mapping. See "FCT_USC_Map".

You define usage scenario mapping rules in Pricing Center.

Dependencies

If the usage scenario mapping is stored in the database, this module requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-55 lists the DAT_USC_Map registry entries.

Table 37-55 DAT_USC_Map Registry Entries

Entry	Description	Mandatory
DataConnection	Specifies a connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes, if the data is stored in the database. Otherwise not used.
LoadZoneDescription	Specifies whether to load the zone description into memory. Default = False	No
LoadZoneEntryName	Specifies whether to load the zone name into memory. Default = False	Yes
OptimizeFor	Specifies whether mapping should be optimized for Speed (the default) or Memory.	No
Source	Specifies where the USC mapping data is stored. The possible values are a File or Database.	Yes
USCMapFile	If Source = File, specifies file name and path that contains the USC mapping data. See "Creating a Usage Scenario Map File" in BRM Setting Up Pricing and Rating. You can use this entry in a semaphore file.	Yes, if the data is stored in a file. Otherwise not used.
PreCompiledDataDir	Compiles USC mapping data and saves the data to the specified directory. Default = ./compiled_usc_data Files are stored in the format USCzoneModelName.pc. Make sure that the directory exists under the specified path. The compiled files are created in the first run of the pipeline. Before each subsequent run, they are validated and recompiled if necessary. See "Precompiling Usage Scenario Mapping Data" in BRM System Administrator's Guide.	No
NumberOfThreads	Specifies the number of threads to use when loading and saving the precompiled mapping data. Default = 1 See "Increasing the Number of Threads Used to Load Mapping Data" in BRM System Administrator's Guide.	No
UscGroups	Specifies the USC groups for which to load rules. Enclose the values in curly braces. For example: UscGroups {TEL TEL_ROAMING TEL_INTL} The default is to load all USC groups in the system. Use the semaphore when mapping rules are stored in the database (Source = Database). See "Filtering the Mapping Data to Compile and Load" in BRM System Administrator's Guide.	No

Sample Registry Entry

USCDataModule
{
  ModuleName = DAT_USC_Map
  Module
  {
     Source               = DataBase
     DataConnection       = ifw.DataPool.Login
     LoadZoneDescription  = False
     LoadZoneEntryName    = False
     OptimizeFor          = MEMORY
     PreCompiledDataDir   = ./compiled_usc_data
     NumberOfThreads      = 5
     UscGroups            = {TEL TEL_ROAMING}
   }
}

Semaphore File Entries

Table 37-56 lists the DAT_USC_Map Semaphore file entries.

Table 37-56 DAT_USC_Map Semaphore File Entries

Entry	Description
LoadZoneDescription	Specifies whether to load the zone description into memory. Default = False
LoadZoneEntryName	Specifies whether to load the zone name into memory. Valid values are True and False.
PrintAllUscMapData	Prints all the USC map data.
PrintUscMapDataForZoneModel	Prints the data for a given zone model ID.
PreCompiledDataDir	Compiles USC mapping data and saves the data to the specified directory. Default = ./compiled_usc_data Files are stored in the format USCzoneModelName.pc. Make sure that the directory exists under the specified path. The compiled files are created in the first run of the pipeline. Before each subsequent run, they are validated and recompiled if necessary.
NumberOfThreads	Specifies the number of threads to use when loading and saving the precompiled mapping data. Default = 1
UscGroups	Specifies the USC groups for which to load rules. If not set, all USC groups are loaded.
Reload	Command used to reload data into memory from the database.
USCMapFile	If Source = File, specifies file name and path that contains the USC mapping data.

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry

ifw.DataPool.USCDataModule.Module.UscGroups {TEL TEL_ROAMING}
ifw.DataPool.USCDataModule.Module.Reload {}

Database Tables

If the mapping data is stored in the Pipeline Manager database, The DAT_USC_Map module uses the IFW_USC_MAP database table. This table stores mapping rules for usage scenario maps.

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

DAT_Zone

The DAT_Zone module provides zone data for the FCT_MainRating and the FCT_Zone modules. This module stores the real-time service class to Pipeline Manager service code mapping information in memory. When it processes realtime data, it returns the service code for a given service class.

See the following documents:

• "Setting up Zones for Batch Pipeline Rating" in BRM Setting Up Pricing and Rating

• "Setting up Zones by using Pricing Center" in BRM Setting Up Pricing and Rating.

Dependencies

Requires a connection to the Pipeline Manager database.

Registry Entries

Table 37-57 lists the DAT_Zone registry entries.

Table 37-57 DAT_Zone Registry Entries

Entry	Description	Mandatory
CliMode	Specifies if the zoning tree should be created in decimal (DEC) or hexadecimal (HEX) mode. Default = DEC	No
DataConnection	Specifies a connection to the Pipeline Manager database. See "Connecting a Module to a Database" in BRM System Administrator's Guide.	Yes, if the module gets data from the database.
DistCalcMode	Specifies the mode for calculating the distance between two area codes: DISC. The configured coordinates are Cartesian coordinates. The distance is calculated using the Pythagorean theorem. GLOBE. The coordinates are global. The distance is calculated using slower goniometric functions. You can use this entry in a semaphore file. Default = DISC	No
FileName	Specifies the path and file name for the zone model master file, if the module gets data from a file. You can use this entry in a semaphore file. See "Creating Zone Data Files" in BRM Setting Up Pricing and Rating.	Yes, if the module gets data from a file
GeoFileName	Specifies the path and file name for the area code coordinate link file, if the module gets data from a file. You can use this entry in a semaphore file. See "Creating Zone Data Files" in BRM Setting Up Pricing and Rating.	Yes, if the module gets data from a file
LoadZoneDescription	Specifies whether to load the zone descriptions into memory. Default = False You can use this entry in a semaphore file.	No
LoadZoneEntryName	Specifies whether to load the zone names into memory. Default = False You can use this entry in a semaphore file.	No
MaxAge	Specifies the maximum age of zone entries. If the value is 0 or null, all zone entries are loaded. You can use this entry in a semaphore file. Default = 0	No
RealTime	Specifies whether the module should process real-time events. If True, the module processes real-time events, if False, the module processes batch events.	Yes
ReuseOnFailure	Specifies if the module should continue to use the old data if the Reload command fails: True = use the old data. False = do not use the old data. Default = False	Yes
Source	Specifies whether the module gets data from a file or the database.	Yes
ZoneModels	Specifies the source of the zone model codes: If the source is a file, contains a list of zone model codes with the corresponding path and file name for the configuration file. If the source is the database, contains a list of zone model codes that shall be used. You can use this entry in a semaphore file. See "Creating Zone Data Files" in BRM Setting Up Pricing and Rating.	No, if the module gets data from the database.

Sample Registry for the Database Interface

Module 
{ 
  ReuseOnFailure = FALSE 
  MaxAge = 0 
  Source = Database 
  DataConnection = ifw.DataPool.Login
  LoadZoneDescription = False
  LoadZoneDescription = False
  ZoneModels 
  { 
    BASIC 
    PROFI 
    SPECIAL 
  } 
}

Sample Registry for the File Interface

Standard zone:

Module 
{ 
   ReuseOnFailure = FALSE 
   MaxAge = 90 
   Source = File 
   FileName = ./cfg/ZoneModelConfig.dat 
   ZoneModels 
   { 
      ZM_ADD = /data9/INTEGRATE/TEST/config/ZM_ADD.dat 
   } 
} 

Geographical zone:

Module 
{ 
   ReuseOnFailure = FALSE 
   MaxAge = 90 
   Source = File 
   FileName = ./cfg/ZoneModelConfig.dat 
   GeoFileName = ./cfg/GeoAreaLink.dat 
   ZoneModels 
   { 
      ZM_GEO = /data9/INTEGRATE/TEST/config/ZM_GEO.dat 
   } 
} 

Sample Registry for Real-Time Zoning

Module
{
  ReuseOnFailure = FALSE
  Source = DataBase
  MaxAge = 0
  DistCalcMode = DISC
  DataConnection = ifw.DataPool.Login
  LoadZoneDescription = False
  LoadZoneEntryName = False
  RealTime = True
  ZoneModels
  {

  }
}

Semaphore File Entries

Table 37-58 lists the DAT_Zone Semaphore file entries.

Table 37-58 DAT_Zone Semaphore File Entries

Entry	Description
DistCalcMode	Specifies the mode for calculating the distance between two area codes: DISC. The configured coordinates are cartesian coordinates. The distance is calculated using the Pythagorean theorem. GLOBE. The coordinates are global. The distance is calculated using slower goniometric functions.
FileName	Specifies the path and file name for the zone model master file, if the module gets data from a file. See "Creating Zone Data Files" in BRM Setting Up Pricing and Rating.
GeoFileName	Specifies the path and file name for the area code coordinate link file, if the module gets data from a file. See "Creating Zone Data Files" in BRM Setting Up Pricing and Rating.
LoadZoneDescription	Specifies whether to load the zone descriptions into memory. Note: When this entry is updated through a semaphore, the reload semaphore must also be passed to reload the zone descriptions.
LoadZoneEntryName	Specifies whether to load the zone names into memory. Note: When this entry is updated through a semaphore, the reload semaphore must also be passed to reload the zone names.
MaxAge	Specifies the maximum age of zone entries. If the value is 0 or null, all zone entries are loaded.
Reload	Reloads the zoning data. See "Reloading Data into a Pipeline Manager Module" in BRM System Administrator's Guide.
ZoneModels	Specifies the source of the zone model codes: If the source is a file, contains a list of zone model codes with the corresponding path and file name for the configuration file. If the source is the database, contains a list of zone model codes that shall be used. See "Creating Zone Data Files" in BRM Setting Up Pricing and Rating.

For more information, see "Semaphore File Syntax" in BRM System Administrator's Guide.

Sample Semaphore File Entry for the Database Interface

ifw.DataPool.ZoneDataModule.Module.ZoneModels.BASIC.Reload {} 
ifw.DataPool.ZoneDataModule.Module.ZoneModels.SPECIAL.Reload {} 

Sample Semaphore File Entry for the File Interface

ifw.DataPool.ZoneDataModule.Module.ZoneModels.
ZM_ADD = /data9/INTEGRATE/test/config/ZM_ADD-new.dat 

ifw.DataPool.ZoneDataModule.Module.ZoneModels.
ZM_MOBILE = /data9/INTEGRATE/test/config/ZM_MOBILE-new.dat

Events

Table 37-59 lists the DAT_Zone events.

Table 37-59 DAT_Zone Events

Event Name	Trigger	Sender	Parameter
EVT_RELOAD_SUCCESSFUL	Data reload was successful.	DAT_Zone	None
EVT_RELOAD_FAILED	Data reload failed.	DAT_Zone	None

Database Tables

The DAT_Zone module uses data from the following database tables:

• IFW_ZONEMODEL

• IFW_IMPACT_CAT

• IFE_STANDARD_ZONE

• IFW_GEO_MODEL

• IFW_GEO_ZONE

• IFW_GEOAREA_LNK

For information about the fields in database tables, see the documentation in Pipeline_Home/database.

Note:

For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".

To enter data in these tables, use Pricing Center. See "Setting up Zone Models" in BRM Setting Up Pricing and Rating.