80 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.
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.
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 80-1 lists the DAT_AccountBatch registry entries.
Table 80-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 |
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 |
No |
Connections |
Specifies the number of connections to the database. This value must be at least the number of threads plus 1. Default = 5 |
No |
EnrichRatingProductOnly |
If set to True, only the purchased charge offers whose service ID matches the service ID in the EDR being rated are added to the EDR. If set to False, the purchased charge offers 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. |
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. |
No |
IntegrateConnection |
Specifies the connection to the Pipeline Manager database. |
Yes |
Listener |
Specifies the connection to the DAT_Listener module. |
Yes |
LoadAccountForSharingOnly |
Specifies whether Pipeline Manager can load serviceless accounts that are owners of resource sharing groups. Default = False |
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 |
Yes |
LogEvents |
Specifies whether received events should be written to a log file. Use this entry to troubleshoot Pipeline Manager event handling. Default = False |
No |
LoginLocks |
Use this entry to tune performance by managing thread contention. Default = 10 |
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. |
Yes |
PortalConfigDataModule |
Specifies the connection to the DAT_PortalConfig module. This enables DAT_AccountBatch to retrieve business parameter settings from the DAT_PortalConfig module. |
Yes |
ProfilesNotLoadedIntoEdr |
When you have accounts that own or share a large number of ERA profiles, use this registry entry to specify the profiles to be filtered. When a CDR is rated, if the value in the EDR field matches a value in one or more of the specified ERA profiles, the ISC_ProfileLabel iScript loads only the ERA labels into the EDR container. See "Improving Pipeline Rating Performance for Events with ERAs". |
No |
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 charge offers for the account are added to the EDR. If set to False, only those purchased charge offers 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 charge offers. During EDR processing, the list of plan IDs for an account is returned to the FCT_Account module. |
No |
ReadSystemProductFromMain |
If set to True, the module retrieves the latest system charge offers from the main tables and uses the start and end dates to validate when the charge offer is in effect. If set to False (the default), the module retrieves the system charge offer information from the audit tables and uses the purchase creation date to validate when the charge offer 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 |
No |
ServiceLocks |
Tunes performance by managing thread contention. Default = 10 |
No |
ThreadAccountHashMapSize |
Controls the size of the temporary hash map built by each thread for accounts. Important:
|
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. 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. 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. 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. |
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 |
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. Important: If the UseAsRouter registry entry is set to True, this registry entry is not used. |
No |
TimesTenEnabled |
Set this to False. |
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. Important: If set to True, the following registry entries are not used:
|
No |
UseLatestProductAndDiscount |
If set to True, the module retrieves the latest purchased charge offer and discount offer information from the main tables and uses the start and end dates to validate when the charge offer is in effect. If set to False (the default), the module retrieves the purchased charge offer and discount offer information from the audit tables and uses the purchase creation date to validate when the charge offer is in effect. 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 charge offer is selected only if an event occurs after the charge offer's created time (PIN_FLD_CREATED_T) and between its start and end times. If set to False, charge offer validity is checked based only on the start and end times (PIN_FLD_START_T and PIN_FLD_END_T) of the charge offer. 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 80-2 lists the DAT_AccountBatch Semaphore file entries.
Table 80-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. |
PrintData |
Reports the account data for all accounts. |
PrintDataLogin |
Reports the account data for a single account identified by the BRM login ID (usually the phone number). |
PrintDataSamples |
Reports the account data for a specified number of accounts, chosen randomly. |
PrintAmtData |
Prints in-memory data about the Account Migration Manager (AMM) to the specified log file. |
PrintAmtJobData |
Prints in-memory data about one account migration job to the specified log file. |
RejectClosedAccounts |
Rejects CDRs with a timestamp later than the account's closed date. |
Reload |
Reloads data from the Pipeline Manager database. |
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.
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:
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 80-3 lists the DAT_BalanceBatch registry entries.
Table 80-3 DAT_BalanceBatch Registry Entries
Entry | Description | Mandatory |
---|---|---|
AccountDataModule |
Specifies the connection to the DAT_AccountBatch module. |
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. |
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 payload configuration file (payloadconfig_ifw_sync.xml). See "Configuring Custom Business Events for Pipeline Discounting". |
No |
DiscountDataModule |
Specifies the connection to the DAT_Discount module. |
Yes |
InfranetConnection |
Specifies the database connection to the BRM database. |
Yes |
IntegrateConnection |
Specifies the database connection to the Pipeline Manager database. |
Yes |
ListenerDataModule |
Specifies the connection to the DAT_Listener module. |
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 |
No |
LogEvents |
Specifies whether received events should be written to a log file. Use this entry to troubleshoot Pipeline Manager event handling. Default = False |
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. |
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 noncurrency sub-balances at Pipeline Manager startup. Default = True |
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 |
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 |
No |
UseFlexibleConsumptionRule |
Specifies whether to use the resource consumption rules defined at the package 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 |
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 80-4 lists the DAT_BalanceBatch Semaphore file entries.
Table 80-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. |
ReloadCreditThresholdParam |
Reloads the value from the CreditThresholdChecking business parameter. |
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:
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.
DAT_Calendar
The DAT_Calendar module provides special day calendar data for the FCT_MainRating module.
Dependencies
Requires a connection to the Database Connect (DBC) module. See "Database Connect (DBC)".
Registry Entries
Table 80-5 lists the DAT_Calendar registry entries.
Table 80-5 DAT_Calendar Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the database connection to the Pipeline Manager database. |
Yes |
Sample Registry Entry
Calendar { ModuleName = DAT_Calendar Module { DataConnection = ifw.DataPool.Login } }
Semaphore File Entries
Table 80-6 lists the DAT_Calendar Semaphore file entries.
Table 80-6 DAT_Calendar Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
Events
Table 80-7 lists the DAT_Calendar events.
Table 80-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 |
DAT_ConnectionMonitor
This module creates and monitors the idle timeout period for each connection and maintains the state for each client.
Registry Entries
Table 80-8 lists the DAT_ConnectionMonitor registry entries.
Table 80-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 } }
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 80-9 lists the DAT_ConnectionPool registry entries.
Table 80-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:
|
No |
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 # Default is false SSLEnabled = TRUE # For logging login flist # Default is false Logging = True SocketTimeOut = 30000 } CM2 { Host = CM2_host Port = CM2_port LoginName = root.0.0.0.1 LoginPassword = password # Default is false SSLEnabled = True # For logging login flist # Default is false Logging = True SocketTimeOut = 30000 } } } }
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.
Registry Entries
Table 80-10 lists the DAT_Currency registry entries.
Table 80-10 DAT_Currency Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the database connection to the Pipeline Manager database. |
Yes |
InfranetConnection |
Specifies the database connection to the BRM database. |
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 80-11 lists the DAT_Currency Semaphore file entries.
Table 80-11 DAT_Currency Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
DAT_Dayrate
The DAT_Dayrate module provides special day rate data for the FCT_Dayrate module.
Registry Entries
Table 80-12 lists the DAT_Dayrate registry entries.
Table 80-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. |
Yes |
Sample Registry Entry
Dayrate { ModuleName = DAT_Dayrate Module { DataConnection = ifw.DataPool.Login Buffer = 5000 } }
Semaphore File Entries
Table 80-13 lists the DAT_Dayrate Semaphore file entries.
Table 80-13 DAT_Dayrate Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
Events
Table 80-14 lists the DAT_Dayrate events.
Table 80-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 |
DAT_Discount
The DAT_Discount module provides discount 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 80-15 lists the DAT_Discount registry entries.
Table 80-15 DAT_Discount Registry Entries
Entry | Description | Mandatory |
---|---|---|
AccountDataModule |
Specifies the connection to the DAT_AccountRealtime or DAT_AccountBatch module. |
Yes |
InfranetConnection |
Specifies the database connection to the BRM database. |
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. |
Yes |
PortalConfigDataModule |
Specifies the connection to the DAT_PortalConfig module. This enables DAT_Discount to retrieve business parameter settings from the DAT_PortalConfig module. |
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 80-16 lists the DAT_Discount Semaphore file entries.
Table 80-16 DAT_Discount Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. Note: Discounting data is reloaded only when the discount configuration contains a new noncurrency resource. |
ReloadEvalScripts |
Reloads and recompiles the iScript files specified in the EvalScriptFiles registry entry. |
DiscountModel |
The discounts 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.
Note: You cannot specify multiple discount codes. You can specify only a single code or ALL. |
DataFileName |
Where discount information should be written. This entry is used for troubleshooting purposes and must be used in conjunction with the DiscountModel semaphore.
|
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 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 with the code DM10%off to the terminal:
ifw.DataPool.DiscountModelDataModule.Module.DiscountCode = DM10%OFF ifw.DataPool.DiscountModelDataModule.Module.DataFileName {}
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
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.
Registry Entries
Table 80-17 lists the DAT_ExchangeRate registry entries.
Table 80-17 DAT_ExchangeRate Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the database connection to the Pipeline Manager database. |
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 80-18 lists the DAT_ExchangeRate Semaphore file entries.
Table 80-18 DAT_ExchangeRate Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
Events
Table 80-19 lists the DAT_ExchangeRate events.
Table 80-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.
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.
Registry Entries
Table 80-20 lists the DAT_InterConnect registry entries.
Table 80-20 DAT_InterConnect Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the database connection to the Pipeline Manager database. |
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 80-21 lists the DAT_InterConnect Semaphore file entries.
Table 80-21 DAT_InterConnect Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
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
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
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.
Registry Entries
Table 80-22 lists the DAT_ItemAssign registry entries.
Table 80-22 DAT_ItemAssign Registry Entries
Entry | Description | Mandatory |
---|---|---|
AccountDataModule |
Specifies the connection to the DAT_AccountBatch module. |
Yes |
InfranetConnection |
Specifies the connection to the BRM database. |
Yes |
ItemPoidReservedRangeUnitSize |
Specifies the maximum number of POIDs to be reserved. Default =10000 |
No |
Sample Registry Entry
Flexible item assignment data module ItemAssignDataModule { ModuleName = DAT_ItemAssign Module { InfranetConnection = ifw.DataPool.LoginInfranet AccountDataModule = ifw.DataPool.CustomerData ItemPoidReservedUnitSize = 10000 } }
Semaphore File Entries
Table 80-23 lists the DAT_ItemAssign Semaphore file entries.
Table 80-23 DAT_ItemAssign Semaphore File Entries
Entry | Description |
---|---|
PrintData |
Generates a log file that contains the item tag-to-type mapping information. |
Reload |
Reloads data from the Pipeline Manager database. |
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.
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.
Dependencies
Requires a connection to the database containing the Oracle Advanced Queuing (AQ) database 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 80-24 lists the DAT_Listener registry entries.
Table 80-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. |
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. |
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. |
No |
InfranetConnection |
Specifies the connection to a database with the Oracle Advanced Queuing (AQ) database 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.
Note:
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 80-25 lists the DAT_Listener registry entries for interleaved processing.
Table 80-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 80-26 lists the DAT_Listener Semaphore file entries.
Table 80-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 AQ database queue. |
Disconnect{} |
Disconnects the DAT_Listener module event dequeuing threads from the AQ database queue. The module checks the dequeuing threads before disconnecting them:
|
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. |
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. 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 pricing from DAT_ModelSelector. See "FCT_MainRating".
-
FCT_DiscountAnalysis gets the discount from DAT_ModelSelector. See "FCT_DiscountAnalysis".
Dependencies
Requires a connection to the Database Connect (DBC) module. See "Database Connect (DBC)".
The module uses event notification to refresh customized charge offer data. You must configure a connection to DAT_Listener if you plan to use this feature. See "DAT_Listener".
Registry Entries
Table 80-27 lists the DAT_ModelSelector registry entries.
Table 80-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 |
Yes |
ListenerDataModule |
Specifies the connection to the DAT_Listener module. |
No |
Sample Registry Entry
ModelSelectorDataModule { ModuleName = DAT_ModelSelector Module { ListenerDataModule = ifw.DataPool.Listener IntegrateConnection = ifw.DataPool.Login LogEvents = True }
Semaphore File Entries
Table 80-28 lists the DAT_ModelSelector Semaphore file entries.
Table 80-28 DAT_ModelSelector Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
DiscountModel |
The discounts 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.
Note: You cannot specify multiple discount codes. You can specify only a single code or ALL. |
DataFileName |
Where discount information should be written. This entry is used for troubleshooting purposes and must be used in conjunction with the DiscountModel semaphore.
|
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.
-
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.
-
IFW_SELECTOR_RULE. This table stores information for each model selector rule, including the code, name, and rule links.
-
IFW_SELECTOR_RULE_LNK. This table maps a model selector rule to its detail or block.
-
IFW_SELECTOR_DETAIL. This table stores each model selector's rule details; the EDR field and value.
-
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.
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.
See the following documents:
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 80-29 lists the DAT_NOSP registry entries.
Table 80-29 DAT_NOSP Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the database connection to the Pipeline Manager database. |
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:
|
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 80-30 lists the DAT_NOSP Semaphore file entries.
Table 80-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. |
Sample Semaphore File Entry for the File Interface
ifw.DataPool.NOSP.Module.FileName = ./cfg/NOSP_Config2.dat
DAT_NumberPortability
The DAT_NumberPortability module provides number portability data to the FCT_NumberPortability module.
Registry Entries
Table 80-31 lists the DAT_NumberPortability registry entries.
Table 80-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. |
Yes |
FileName |
Specifies the name of the number portability file. |
Yes |
InternationalAccessCode |
Specifies the international access code. This is needed for normalization of CLIs. Default = 00 |
No |
InternationalAccessCodeSign |
Specifies the international access code sign. This is needed for normalization of CLIs. Default = + |
No |
NationalAccessCode |
Specifies the national access code, for example 0 for Germany. This is needed for normalization of CLIs. |
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.
Default = 0 |
No |
Sample Registry Entry
NumberPortabilityData { ModuleName = DAT_NumberPortability Module { FileName = ./data/primary_np.data CountryCode = 49 NationalAccessCode = 0 SearchMethod = 0 } }
Semaphore File Entries
Table 80-32 lists the DAT_NumberPortability Semaphore file entries.
Table 80-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. 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
Events
Table 80-33 lists the DAT_NumberPortability Events.
Table 80-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.
Dependencies
This module requires a connection to the Database Connect (DBC) module. See "Database Connect (DBC)".
Note:
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 80-34 lists the DAT_PortalConfig registry entries.
Table 80-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 80-35 lists the DAT_PortalConfig Semaphore file entries.
Table 80-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. |
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. |
CBPReload |
Reloads /config/business_params data. |
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 80-36 lists the DAT_PortalConfig events.
Table 80-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 |
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:
Dependencies
If data is stored in the database, the DAT_PrefixDesc module requires a connection to the Pipeline Manager database.
Registry Entries
Table 80-37 lists the DAT_PrefixDesc registry entries.
Table 80-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. |
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:
|
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 80-38 lists the DAT_PrefixDesc Semaphore file entries.
Table 80-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. |
Events
Table 80-39 lists the DAT_PrefixDesc events.
Table 80-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 |
DAT_PriceModel
The DAT_PriceModel module provides pricing data for the FCT_MainRating module.
See the following documents:
Dependencies
Requires a connection to the Pipeline Manager database.
This module uses event notification to refresh customized charge offer 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 pricing. If you do not use tailor-made charge offers, and intend to skip lock on pricing, configure a connection to the DAT_PortalConfig module.
Registry Entries
Table 80-40 lists the DAT_PriceModel registry entries.
Table 80-40 DAT_PriceModel Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the connection to the Pipeline Manager database. |
Yes |
Listener |
Specifies the connection to the DAT_Listener module. |
No |
LogEvents |
Specifies whether notification events received by the module are written to the process log file. Default = False |
No |
PortalConfigDataModule |
Specifies the connection to the DAT_PortalConfig module and enables DAT_PriceModel to retrieve business parameter settings from the DAT_PortalConfig module. |
No |
Sample Registry Entry
PriceModel { ModuleName = DAT_PriceModel Module { DataConnection = ifw.DataPool.Login Listener = ifw.DataPool.Listener } }
Semaphore File Entries
Table 80-41 lists the DAT_PriceModel Semaphore file entries.
Table 80-41 DAT_PriceModel Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads the data from the database. |
PrintAllPriceModels |
Prints all pricings in the configuration. |
PrintOnePriceModel <PriceModel ID> |
Prints the pricing ID. |
PrintRangeOfPriceModels <PriceModel fromID> <PriceModel toID> |
Prints all the pricings where ID is in the range. |
Events
Table 80-42 lists the DAT_PriceModel events.
Table 80-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 pricing data.
-
IFW_PRICEMDL_STEP. This table stores pricing step data.
-
IFW_RESOURCE. This table stores resource configuration data.
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 charge data for the FCT_MainRating module.
Dependencies
Requires a connection to the Pipeline Manager database.
This module uses event notification to refresh customized charge offer 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 charges. If you do not use tailor-made charge offers, and intend to skip lock on charges, configure a connection to the DAT_PortalConfig module.
Registry Entries
Table 80-43 lists the DAT_Rateplan registry entries.
Table 80-43 DAT_Rateplan Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the connection to the Pipeline Manager database. |
Yes |
Listener |
Specifies the connection to the DAT_Listener module. |
No |
LogEvents |
Specifies whether notification events received by the module are written to the process log file. Default = False |
No |
PortalConfigDataModule |
Specifies the connection to the DAT_PortalConfig module and enables DAT_RatePlan to retrieve business parameter settings from the DAT_PortalConfig module. |
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 80-44 lists the DAT_Rateplan Semaphore file entries.
Table 80-44 DAT_Rateplan Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads the rating configuration data. |
PrintAllRateplans |
Prints all charges in the configuration. |
PrintOneRateplan <RatePlan ID> |
Prints the charge ID. |
PrintRangeOfRateplans <RatePlan fromID> <RatePlan toID> |
Prints all the charges where ID is in the range. |
Events
Table 80-45 lists the DAT_Rateplan events.
Table 80-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 charge data from the following database tables:
-
IFW_RATEPLAN
-
IFW_RATEPLAN_VER
-
IFW_RATEPLAN_CNF
The DAT_Rateplan module uses RUM data from the following database tables:
-
IFW_RUM
-
IFW_RUMGROUP
-
IFW_RUMGROUP_LNK
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.
Registry Entries
Table 80-46 lists the DAT_Recycle registry entries.
Table 80-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. |
Yes |
LogEvents |
Specifies whether notification events received by the module are written to the process log file. Default = False |
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 } }
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 80-47 lists the DAT_ResubmitBatch registry entries.
Table 80-47 DAT_ResubmitBatch Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies the connection to the Pipeline Manager database. |
Yes |
Listener |
Specifies the connection to the DAT_Listener module. |
Yes |
LogEvents |
Logs each request received from the listener when true. Default = True |
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 } }
DAT_ScenarioReader
The DAT_ScenarioReader module provides aggregation scenario data for the FCT_AggreGate module.
See the following documents:
Registry Entries
Table 80-48 lists the DAT_ScenarioReader registry entries.
Table 80-48 DAT_ScenarioReader Registry Entries
Entry | Description | Mandatory |
---|---|---|
Calendar |
Specifies the calendar that is used for special day evaluation. Default = No calendar |
No |
DataCollection |
Specifies a connection to the Pipeline Manager database. |
Yes |
Sample Registry Entry
ScenarioReader { ModuleName = DAT_ScenarioReader Module { DataConnection = ifw.DataPool.Database Calendar = 2 } }
Semaphore File Entries
Table 80-49 lists the DAT_ScenarioReader Semaphore file entries.
Table 80-49 DAT_ScenarioReader Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads aggregation scenarios. |
Messages and Requests
Table 80-50 lists the DAT_ScenarioReader messages and requests.
Table 80-50 DAT_ScenarioReader Messages and Requests
Message/Request | Description | Sending/Receiving |
---|---|---|
REQ_EVENTHANDLER_NAME |
Get the Event Handler. |
Send to controller. |
Events
Table 80-51 lists the DAT_ScenarioReader events.
Table 80-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.
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.
Registry Entries
Table 80-52 lists the DAT_TimeModel registry entries.
Table 80-52 DAT_TimeModel Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies a connection to the Pipeline Manager database. |
Yes |
Sample Registry Entry
TimeModel { ModuleName = DAT_TimeModel Module { DataConnection = ifw.DataPool.Login } }
Semaphore File Entries
Table 80-53 lists the DAT_TimeModel Semaphore file entries.
Table 80-53 DAT_TimeModel Semaphore File Entries
Entry | Description |
---|---|
Reload |
Reloads data from the Pipeline Manager database. |
Events
Table 80-54 lists the DAT_TimeModel events.
Table 80-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
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.
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".
Dependencies
If the usage scenario mapping is stored in the database, this module requires a connection to the Pipeline Manager database.
Registry Entries
Table 80-55 lists the DAT_USC_Map registry entries.
Table 80-55 DAT_USC_Map Registry Entries
Entry | Description | Mandatory |
---|---|---|
DataConnection |
Specifies a connection to the Pipeline Manager database. |
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. 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. |
No |
NumberOfThreads |
Specifies the number of threads to use when loading and saving the precompiled mapping data. Default = 1 |
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). |
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 80-56 lists the DAT_USC_Map Semaphore file entries.
Table 80-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. |
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 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.
Registry Entries
Table 80-57 lists the DAT_Zone registry entries.
Table 80-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. |
Yes, if the module gets data from the database. |
DistCalcMode |
Specifies the mode for calculating the distance between two area codes:
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. |
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. |
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:
You can use this entry in a semaphore file. |
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 80-58 lists the DAT_Zone Semaphore file entries.
Table 80-58 DAT_Zone Semaphore File Entries
Entry | Description |
---|---|
DistCalcMode |
Specifies the mode for calculating the distance between two area codes:
|
FileName |
Specifies the path and file name for the zone model master file, 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. |
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. |
ZoneModels |
Specifies the source of the zone model codes:
|
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 80-59 lists the DAT_Zone events.
Table 80-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
Note:
For information on compare patterns used in database values, see "About Using Regular Expressions when Specifying the Data to Extract".