53 System Administration pin.conf Reference

Learn how system administrators use pin.conf settings to improve the performance of Oracle Communications Billing and Revenue Management (BRM).

Topics in this document:

Connection Manager (CM) pin.conf Entries

Table 53-1 lists the CM pin.conf entries.

Table 53-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.

fm_offer_profile_cache

cm_cache

Loads all offer_profile objects at initialization of fm_offer_profile library.

cm_logfile

cm

Specifies the full path to the log file used by the CM.

cm_logformat

cm

Specifies which PINLOG format to use.

See "Setting the CM Log Time Resolution".

cm_max_connects

cm

Specifies the maximum number of client connections to the CM.

See "Specifying the Number of Connections to CMs".

cm_name

cm

Specifies the name of the computer where the CM runs.

See "About Connecting BRM Components".

cm_opcode_stats

cm

Specifies whether to collect statistics about CM opcode performance.

See "Getting Quality of Service Statistics".

cm_ports

cm

Specifies the port number of the computer where the CM runs.

See "About Connecting BRM Components".

cm_timeout

cm

Specifies the time-out value for receiving the next opcode request from an application.

See "Setting the CM Time Interval between Opcode Requests".

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.

dm_pointer

cm

Specifies where to find one or more DMs for the BRM database.

See "Setting Data Manager Attributes".

dm_port

dm

Specifies the port number of the computer where the CM runs.

See "About Connecting BRM Components".

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".

enable_preferences_enrichment

fm_publish

Specifies whether to enrich business events with your customers' preferences before they are sent to an external notification application.

See "Enabling Notification Enrichment" in BRM Managing Customers.

fetch_size

pin_billd

pin_mta

Specifies the number of records to retrieve from the database in a batch and cache in system memory for processing by the utility.

See "Tuning the Account Cache Size for Billing Utilities (fetch_size)" and "Tuning the Account Cache Size for Invoice Utilities (fetch_size)".

group_children_fetch

fm_bill

Used to perform a step search for child accounts in groups when the parent group contains many members. See "Filtering Search Results".

group_members_fetch

fm_bill

Used to perform a step search for members of the group sharing object when the parent group contains many members. See "Filtering Search Results".

ip

N/A

Specifies the IP address of the devices managed by IP Address Manager.

item_fetch_size

fm_bill

Used to perform a step search for items. See "Filtering Search Results".

login_audit

cm

Creates the session event's object for each client application.

See "Turning Off Session-Event Logging".

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".

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.

See "Setting the Default Password Expiry Duration".

prefs_enabled_publisher_list

fm_publish

Specifies whether to enrich business events with your customers' preferences before they are sent to specific publishers.

See "Enabling Notification Enrichment" in BRM Managing Customers.

prefs_phone_no_location

fm_publish

Specifies where BRM can find a customer's MSIDN number.

See "Enabling Notification Enrichment" in BRM Managing Customers.

primary_database

N/A

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.

rps_no_reorder

fm_price

Specifies whether to reorder rate plan selectors before committing them to the database.

  • 1: Leaves rate plan selectors in the order in which they appear in Pricing Center or the PCM_OP_PRICE_SET_PRICE_LIST opcode.

  • 0: Specifies to reorder rate plan selectors before committing them to the database. This increases performance and reduces the buffer size. This is the default.

sample_handler_logfile

N/A

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.

Data Manager (DM) pin.conf Entries

Table 53-2 lists the DM pin.conf entries.

Table 53-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 for Oracle ZT PKI Encryption" in BRM Developer's Guide.

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_bigsize

dm

Specifies the size of the DM shared memory.

See "Setting DM Shared Memory Size".

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 backend to start before the DM times out.

See "Setting How Long the DM Waits for the Background Startup Process to Complete".

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.

See "Configuring DM Front Ends and Back Ends".

dm_n_fe

dm

Specifies the number of front ends the program creates and uses.

See "Configuring DM Front Ends and Back Ends".

dm_port

dm

Specifies the port number for this DM.

dm_restart_children

dm

Specifies whether to replace child processes.

See "Replacing Failed DM 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.

See "Setting DM Shared Memory Size".

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 not to try running the SQL statement if the error occurs.

See "Problem: ORA-01502: Index 'PINPAP.I_EVENT_ITEM_OBJ__ID' or Partition of Such Index Is in Unusable State".

dm_trans_be_max

dm

Specifies the maximum number of back ends that can be used for processing transactions.

See "Configuring DM Front Ends and Back Ends".

dm_trans_timeout

dm

Specifies the time-out value for receiving the next opcode request from an application.

See "Setting the DM Time Interval between Opcode Requests".

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.

See "Connecting a Data Manager to the BRM Database".

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.

See "Connecting a Data Manager to the BRM Database".

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 for Oracle ZT PKI Encryption" in BRM Developer's Guide.

stmt_cache_entries

dm

Specifies the maximum number of Oracle statement handles to cache to improve performance.

See "How to Use the Statement-Handle Cache".

EAI Manager pin.conf Entries

Table 53-3 lists the EAI Manager pin.conf entries.

Table 53-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_ip

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_header_send_host_name

dm

Specifies that 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 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 the 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 the 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.

enable_publish

fm_publish

Enables publishing of business events by using the 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.

Multithreaded Application (MTA) Framework pin.conf Entries

Table 53-4 lists the MTA Framework pin.conf entries.

Table 53-4 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.

See "Turning Off the Checking of Logons and Passwords".

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.

enable_system_ara

pin_mta

Enables revenue assurance activities for your custom MTA application. This application can be run as part of a custom job in Business Operations Center.

See "Enabling Your Custom Applications to Generate Revenue Assurance Data" in BRM Collecting Revenue Assurance Data.

fetch_size

pin_mta

Specifies the number of records to retrieve from the database in a batch and cache in system memory for processing by the utility.

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.

login_pw

nap

Specifies the login password.

login_type

nap

Specifies whether a login name and password are required.

loglevel

pin_mta

Specifies how much information is recorded in the log specified by the logfile parameter in the pin.conf file.

See "Setting the Reporting Level for Logging Messages".

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.

per_step

pin_mta

Specifies how much data to store in dm_oracle when the utility is performing a step search.

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 there is an error in any of the threads.

userid

N/A

Specifies the CM for logging into the Data Manager.