This chapter lists the pin.conf settings used by system administrators in Oracle Communications Billing and Revenue Management (BRM).
See also "business_params Reference" and "Business Logic pin.conf Reference".
Table 44-1 lists the CM pin.conf entries.
Table 44-1 CM pin.conf Entries
| Name | Program | Description |
|---|---|---|
|
cm_cache_space |
cm |
(Optional) Reserves the cache memory for all the Facilities Modules. The default is 6291456. The value is always in multiples of 1024. |
|
cm_data_dictionary_cache |
cm_cache |
Increases the size of the CM cache for the data dictionary. See "Increasing the Size of the CM Cache for the Data Dictionary" in BRM Developer's Guide. |
|
cm_data_file |
cm |
Specifies the name and location of the shared memory file that caches global information for the CM. See the instructions in the CM pin.conf file. |
|
cm_logfile |
cm |
Specifies the full path to the log file used by the CM. |
|
cm_logformat |
cm |
Specifies which PINLOG format to use. |
|
cm_max_connects |
cm |
Specifies the maximum number of client connections to the CM. |
|
cm_name |
cm |
Specifies the name of the computer where the CM runs. |
|
cm_opcode_stats |
cm |
Specifies whether to collect statistics about CM opcode performance. |
|
cm_ports |
cm |
Specifies the port number of the computer where the CM runs. |
|
cm_timeout |
cm |
Specifies the time-out value for receiving the next opcode request from an application. |
|
creation_logging |
fm_cust |
Determines whether to log nondollar events. See "Logging Noncurrency Events" and "Improving Connection Manager Performance". |
|
dm_attributes |
cm |
Specifies attributes associated with a particular database. See "Activating Branded Service Management" in BRM Managing Customers and "Setting Data Manager Attributes". |
|
dm_pointer |
cm |
Specifies where to find one or more DMs for the BRM database. |
|
dm_port |
dm |
Specifies the port number of the computer where the CM runs. |
|
em_group |
cm |
Configures the CM to send requests to the NET_EM module. See "Configuring the CM to Send Real-Time Requests to the NET_EM Module". |
|
em_pointer |
cm |
Specifies where to find EMs that provide other opcodes to the CM. See "Configuring the CM to Send Real-Time Requests to the NET_EM Module". |
|
enable_pcm_op_call_stack |
dm |
Specifies whether PCM_OP_CALL_STACK is printed in the cm.pinlog file after each opcode from a nap (Network Application Program) is completed. See "Recording Opcode Calls in the CM Log File" and "Getting Opcode Statistics from IMDB Cache DM". |
|
fetch_size |
pin_billd pin_mta |
Specifies the number of objects received from the database in a block and cached in system memory for processing. See "Tuning the Account Cache Size for Billing Utilities (fetch_size)" and "Tuning the Account Cache Size for Invoice Utilities (fetch_size)". |
|
fm_offer_profile_cache |
cm_cache |
Loads all offer_profile objects at initialization of fm_offer_profile library. |
|
fm_utils_content_srvc_profile_cache |
cm_cache |
Specifies attributes of the content service profile cache. See "Setting Up Content Manager" in BRM Content Manager. |
|
group_children_fetch |
fm_bill |
Performs a step search for child accounts in groups when the parent group contains many members. |
|
group_members_fetch |
fm_bill |
Performs a step search for members of the group sharing object when the parent group contains many members. |
|
ip |
Specifies the IP address of the devices managed by IP Address Manager. See "Using the IP Address Manager APIs" in BRM Telco Integration. |
|
|
item_fetch_size |
fm_bill |
Performs a step search for items. |
|
login_audit |
cm |
Creates the session event's storable object for each client application. |
|
max_pcm_op_call_stack_entries |
dm |
Specifies the number of entries allocated for PCM_OP_CALL_STACK. See "Recording Opcode Calls in the CM Log File" and "Getting Opcode Statistics from IMDB Cache DM". |
|
monitor |
pin_mta |
Specifies the path and name of a shared memory map file used by the pin_mta_monitor utility. |
|
passwd_age |
cm |
Specifies the number of days after which the password expires. |
|
pin_fld_mask_file |
cm |
Specifies the location of file used to control masking of sensitive data in flists returned from the CM. See "About Securing Sensitive Customer Data with Masking" in BRM Managing Customers for more information. |
|
primary_database |
Specifies the primary database schema. See the instructions in the pin.conf file. |
|
|
primary_db |
cm |
Specifies the primary database schema. See "Running pin_multidb.pl -i" in BRM Installation Guide. |
|
sample_handler_logfile |
Specifies the full path to the log file for the Batch Controller. See "Configuring the Batch Controller" and "Customizing SampleHandler". |
|
|
support_multiple_so |
fm_tcf |
Specifies whether Services Framework provisioning can make in-flight changes to service orders. See "Enabling In-Flight Changes to Service Orders" in BRM Telco Integration. |
Table 44-2 lists the DM pin.conf entries.
Table 44-2 DM pin.conf Entries
| Name | Program | Description |
|---|---|---|
|
config_dir |
fm_cust_pol |
Specifies the location of the ISP configuration data. Used by the PCM_OP_CUST_POL_GET_CONFIG policy opcode. See "Sending Account Information to Your Application When an Account Is Created" in BRM Managing Customers. |
|
crypt |
NA |
Associates a four-byte tag with an encryption algorithm and secret key combination. See "Configuring the Data Manager (DM) for AES Encryption" in BRM Developer's Guide. |
|
dm_bigsize |
dm |
Specifies the size of the DM shared memory. |
|
dm_debug |
dm |
Specifies the debugging information to send to the log file. See the instructions in the pin.conf file. |
|
dm_in_batch_size |
dm |
Specifies the number of objects to retrieve from subtables (arrays or substructs) in a search query. See the instructions in the pin.conf file. |
|
dm_init_be_timeout |
dm |
Specifies the amount of time, in seconds, for the first DM back end to start before the DM times out. See "Setting How Long the DM Waits for the Background Startup Process to Finish". |
|
dm_logfile |
dm |
Specifies the full path to the log file used by the CM. |
|
dm_max_per_fe |
dm |
Specifies the maximum number of connections for each front end. See the instructions in the pin.conf file. |
|
dm_mr_enable |
dm |
Specifies to use database cursors to fetch multiple rows. See "Configuring Oracle Databases" in BRM Installation Guides. |
|
dm_n_be |
dm |
Specifies the number of back ends the program creates and uses. |
|
dm_n_fe |
dm |
Specifies the number of front ends the program creates and uses. |
|
dm_n_op_fifo |
dm |
Specifies the number of pipelines that can be used by the back-end processes. See "Configuring Multiple Pipelines in the DM to Improve Performance". |
|
dm_port |
dm |
Specifies the port number for this DM. |
|
dm_restart_children |
dm |
Specifies whether to replace child processes. |
|
dm_restart_delay |
dm |
Specifies the interval delay when DM back ends are spawned and respawned. See "Customizing BRM Multithreaded Client Applications" and "Configuring Your Multithreaded Application" in BRM Developer's Guide. |
|
dm_sequence_cache_size |
dm |
(Optional) Specifies the number of Portal object IDs (POIDs) to be cached when each instance of a DM is started. The default is 1000. The POIDs are cached in the memory when the DM is started. Whenever a database object is created, the DM uses the POIDs instead of accessing the database each time. |
|
dm_shmsize |
dm |
Specifies the size of the shared-memory segment shared between the front and back ends for this BRM process. |
|
dm_sql_retry |
dm |
Specifies the number of times an SQL statement is retried if the ORA-01502: index 'PINPAP.I_EVENT_ITEM_OBJ__ID' or partition of such index is in unusable state error occurs. Note: This is not a mandatory parameter in the pin.conf file. The default behavior is to not try running the SQL statement if the error occurs. |
|
dm_trans_be_max |
dm |
Specifies the maximum number of back ends that can be used for processing transactions. |
|
dm_trans_timeout |
dm |
Specifies the time-out value for receiving the next opcode request from an application. |
|
dd_write_enable_fields |
dm |
Specifies whether this DM can create fields in the data dictionary. See "Modifying the pin.conf File to Enable Changes" in BRM Developer's Guide. |
|
dd_write_enable_objects |
dm |
Specifies whether this DM can edit, create, and delete custom storable classes in the data dictionary. See "Modifying the pin.conf File to Enable Changes" in BRM Developer's Guide. |
|
dd_write_enable_portal_objects |
dm |
Specifies whether this DM can delete predefined BRM storable classes and add and delete fields in one of those classes. See "Modifying the pin.conf File to Enable Changes" in BRM Developer's Guide. |
|
dd_write_enable_types |
dm |
Specifies whether this DM can edit, create, and delete custom object type names in the data dictionary. |
|
dm_xa_trans_timeout_in_secs |
dm |
Specifies how long, in seconds, an extended architecture (XA) transaction remains in an active state. By default, successfully prepared XA transactions expire in BRM if a commit request is not received within one hour after the transaction opens. This timeout is used only if the application server XA transaction timeout is not specified. The minimum value is 10, and the maximum value is 5184000 (60 days). The default is 3600 (1 hour). See "Changing the XA Transaction Timeout Period" in BRM JCA Resource Adapter. |
|
extra_search |
dm |
Specifies whether to perform an extra search count (*) on subtables for optimal memory allocation. See "Optimizing Memory Allocation during Database Searches". |
|
sm_database |
dm |
Specifies the database alias name. |
|
sm_id |
dm |
Specifies the database user name that the DM uses to log in to the BRM database. This entry is set when you install BRM, but it can be changed. |
|
sm_oracle_ddl |
dm |
Specifies whether to use Data Definition Language (DDL) when object types are updated in the data dictionary tables. See "Using DDL When Updating the Data Dictionary Tables" in BRM Developer's Guide. |
|
sm_pw |
dm |
Specifies the password for the user specified in the sm_id entry. See "Configuring the Data Manager (DM) for AES Encryption" in BRM Developer's Guide. |
|
stmt_cache_entries |
dm |
Specifies the maximum number of SQL statement handles to cache to improve performance. |
Table 44-3 lists the EAI Manager pin.conf entries.
Table 44-3 EAI Manager pin.conf Entries
| Name | Program | Description |
|---|---|---|
|
dm_http_100_continue |
dm |
Specifies whether the DM waits for and reads a 100 Continue response. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
dm_http_agent |
dm |
Specifies a pointer to the HTTP agent. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
dm_http_delim_crlf |
dm |
Specifies the HTTP server-dependent delimiter used in the header. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
dm_http_error_opt |
dm |
Specifies the error handling option:
See ”Configuring EAI Manager to Publish to an HTTP Port” in BRM Developer's Guide. |
|
dm_http_header_attrs |
dm |
Specifies the custom header attributes to post, in the following format: attr_name1=attr_value1;attr_name2=attr_value2; The maximum number of attributes allowed is 10. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
dm_http_header_send_host_name |
dm |
Specifies that the DM will send the host name as part of the header. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
dm_http_read_success |
dm |
Specifies whether the DM waits for and reads a 20x success response. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
dm_http_url |
dm |
(Optional) Specifies the complete URL of the HTTP server. See "Configuring EAI Manager to Publish to an HTTP Port" in BRM Developer's Guide. |
|
eai_pointer |
cm |
Specifies where to find the EM that provides the opcode for EAI Manager. See "Configuring the EAI DM" in BRM Developer's Guide. |
|
em_eai_group |
cm |
Specifies the member opcode in a group provided by EAI Manager. |
|
em_group |
cm |
Specifies a member opcode in a group of opcodes provided by an EM. See "Configuring the Connection Manager for EAI" in BRM Developer's Guide. |
|
em_pointer |
cm |
Specifies where to find EMs that provide other opcodes to the CM. See "Configuring the CM to Send Real-Time Requests to the NET_EM Module". |
|
enable_publish |
fm_publish |
Enables publishing of business events by using EAI Manager. See "Configuring the Connection Manager for EAI" in BRM Developer's Guide. |
|
plugin_name |
dm |
Specifies a pointer to a shared library that contains the code that implements the required interfaces of dm_eai as defined in dm_eai_plugin.h. See "Configuring the EAI DM" in BRM Developer's Guide. |
Table 44-4 lists the IMDB Cache DM pin.conf entries.
Table 44-4 IMDB Cache DM pin.conf Entries
| Name | Program | Description |
|---|---|---|
|
dm_n_be |
dm |
Specifies the number of back ends this DM creates and uses. |
|
dm_restart_children |
dm |
Specifies whether to replace child processes. |
|
dm_trans_consistency_enabled |
dm |
Enables the transaction consistency feature. |
|
dm_trans_timeout_in_secs |
dm |
Specifies how long, in seconds, a global transaction should remain in an active state after the application handling the transaction fails. Base the time on how long your system would take to recover from a failure or a node switchover. The minimum value is 10, and the maximum value is 5184000 (60 days). The default is 3600 (one hour). See "Specifying How Long to Keep Transactions Active after an Error". |
|
tt_unionsearch_enabled |
dm |
Specifies whether the union search feature is enabled. |
|
tt_unionsearch_poll_timeout |
dm |
Specifies the amount of time to wait, in milliseconds, before stopping the search procedure. See "Specifying the Timeout Value for Batch Polling Operations". |
Table 44-5 lists the MTA Framework pin.conf entries.
Table 44-5 MTA Framework pin.conf Entries
| Name | Program | Description |
|---|---|---|
|
children |
pin_inv_accts pin_inv_export pin_inv_send pin_inv_upgrade pin_mta |
Specifies the number of worker threads spawned to perform the specified work. See "Tuning the Number of Children for Billing Utilities" and "Setting the Number of Children for Invoice Utilities". |
|
cm_login_module |
cm |
Specifies the protocol for verifying applications that try to log in to the CM. |
|
enable_ara |
pin_mta |
Enables revenue assurance activities through the various MTA applications (for example, pin_bill_accts, pin_cycle_fees, pin_collect, and pin_inv_accts). See "Configuring BRM Billing to Collect Revenue Assurance Data" in BRM Collecting Revenue Assurance Data. |
|
fetch_size |
pin_mta |
Specifies the number of objects received from the database in a block and cached in system memory for processing. See "Tuning the Account Cache Size for Billing Utilities (fetch_size)". |
|
hotlist |
pin_mta |
Specifies the path and file name of the hotlist file. |
|
logfile |
pin_mta |
Specifies the name and location of the log file to record debug, warning, and error messages of running MTA-based applications. See "About the BRM MTA Framework" in BRM Developer's Guide. |
|
login_name |
nap |
Specifies the user login name. See "Configuring System Passwords" in BRM Developer's Guide and "Login Information for Optional Service Integration Components". |
|
login_pw |
nap |
Specifies the login password. See "Configuring System Passwords" in BRM Developer's Guide and "Login Information for Optional Service Integration Components". |
|
login_type |
nap |
Specifies whether a login name and password are required. See "Configuring System Passwords" in BRM Developer's Guide and "Login Information for Optional Service Integration Components". |
|
loglevel |
pin_mta |
Specifies how much information is recorded in the log specified by the logfile parameter in the pin.conf file. |
|
loop_forever |
pin_mta |
Specifies whether the iterative step search for account information in the BRM database continues in a loop when the number of objects returned by a search step is 0:
Use the loop_forever entry if the application times out before a search is complete. The default is 0. |
|
max_errs |
pin_mta |
Specifies the maximum number of errors allowed in the application. |
|
max_time |
pin_mta |
Specifies the maximum time, measured from application start time, for job processing before the application exits. |
|
multi_db |
pin_mta |
Specifies whether the application works with a BRM multischema system. See "Using Multithreaded Applications with Multiple Database Schemas" in BRM Developer's Guide. |
|
per_batch |
pin_mta |
Specifies the number of account objects processed by each worker thread in batch mode. See "Tuning the Batch Size for Billing Utilities (per_batch)". |
|
per_step |
pin_mta |
Specifies the number of account objects returned by each search step. See "Setting the Batch Size for Invoice Utilities (per_step)". |
|
respawn_threads |
pin_mta |
Specifies whether to respawn worker threads if they exit because of an error. |
|
retry_mta_srch |
pin_mta |
Retries MTA searches when an insufficient memory error occurred. |
|
return_worker_error |
pin_mta |
Specifies whether to return an error code when an error occurs in any of the threads. |
|
sleep_interval |
pin_mta |
Specifies the time in seconds before the iterative step search for account information in the BRM database is resumed within a loop. The default is 60. |
|
userid |
cm |
Specifies the CM for logging into the DM. |