64 pin.conf Reference

Learn how to use pin.conf settings to configure Oracle Communications Billing and Revenue Management (BRM).

Use pin.conf files to configure connections between system components, and to configure business logic operations, such as how billing works.

The pin.conf files are text files, and can be edited by using any text editor. Each entry in a pin.conf file includes instructions on how to configure it.

Note the following points when editing pin.conf files:

  • pin.conf files are usually stored in the same directory as the utility or component that uses them. For example, the pin.conf file that you edit to configure a CM is stored in BRM_home/sys/cm.This file is frequently referred to as "the CM pin.conf file."

    In some cases, a pin.conf file might be stored in a directory that is not the same as the directory that contains the utility. In that case, you need to run the utility from the directory that contains the pin.conf file.

  • You can remove or comment out entries in a pin.conf file. In that case, the default value is used. If an entry is not in the file, you can add it.

Topics in this document:

See also "Business Parameter Reference".

Account Creation pin.conf Entries

Table 64-1 lists the account creation pin.conf entries.

Table 64-1 Account Creation pin.conf Entries

Name Program Description pin.conf File Implementation

allow_active_service_with_inactive_account

fm_cust

Specifies whether services can be activated (during a SET_STATUS operation) if the account or bill unit is inactive.

CM

Cached by the Connection Manager (CM). Restart the CM after changing this entry.

config_dir

fm_cust_pol

Specifies the location of the ISP configuration data, which is stored in the default.config file. Used by the PCM_OP_CUST_POL_GET_CONFIG policy opcode.

CM

The new value becomes effective immediately and applies to the next account created. The CM does not need to be restarted.

country

fm_cust_pol

Specifies the default country for new accounts (default is USA).

CM

The new value becomes effective immediately and applies to the next account created. The CM does not need to be restarted.

currency

fm_cust_pol

Specifies the default currency for new accounts.

CM

The new value becomes effective immediately and applies to the next account created. The CM does not need to be restarted.

domain

fm_cust_pol

Specifies the email domain assigned to customers during account creation.

CM

The new value becomes effective immediately and applies to the next account created. The CM does not need to be restarted.

new_account_welcome_msg

fm_cust_pol

Specifies whether the system should send the default welcome message on account creation.

CM

The new value becomes effective immediately and applies to the next account created. The CM does not need to be restarted.

welcome_dir

fm_cust_pol

Specifies the location of the welcome message sent to customers after account creation.

CM

The new value becomes effective immediately and applies to the next account created. The CM does not need to be restarted.

Accounts Receivable pin.conf Entries

Table 64-2 lists the Accounts Receivable pin.conf entries.

Table 64-2 Accounts Receivable pin.conf Entries

Name Program Description pin.conf File Implementation

calc_cycle_from_cycle_start_t

fm_bill

Specifies whether to calculate charge offer fees based on the charge offer's purchase date (PIN_FLD_CYCLE_START_T).

See "Calculating Cycle Fees for Backdating" in BRM Configuring and Running Billing.

CM

This value is read by the utility when it runs. You do not need to restart the CM.

item_search_batch

fm_bill

Specifies the number of items returned by a step search.

CM

This value is read by the utility when it runs. You do not need to restart the CM.

overdue_tolerance

fm_bill

Specifies how BRM treats amounts applied to the item when they are less than the amount due as a result of euro and Economic and Monetary Union (EMU) conversions.

See "Rounding Errors for Overpayments and Underpayments" in BRM Managing Customers.

CM

This value is read by the utility when it runs. You do not need to restart the CM.

underdue_tolerance

fm_bill

Specifies how BRM treats amounts applied to the item when they are more than the amount due as a result of euro and EMU conversions.

See "Rounding Errors for Overpayments and Underpayments" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

Billing pin.conf Entries

Table 64-3 lists the Billing pin.conf entries.

Table 64-3 Billing pin.conf Entries

Name Program Description pin.conf File Implementation

advance_bill_cycle

fm_bill

Sets the first billing date to be the day after account creation.

See "Setting the First Billing Cycle to the Day after Account Creation" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

attach_item_to_event

fm_act

Specifies how BRM assigns event and service combinations to bill items.

See "About Using Event and Service Combinations to Assign Bill Items" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

billing_segment_config_refresh_delay

fm_cust

Specifies how often data in the cached /config/billing_segment object is automatically refreshed from the database.

See "Updating Billing Segments" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

custom_bill_no

fm_bill

Specifies the accounting cycle (first or last) in which to assign a bill number to a bill in a multi-month billing cycle.

See "Specifying When to Apply Custom Bill Numbers" in BRM Configuring and Running Billing.

CM

Billing utilities

Cached by the CM. Restart the CM after changing this entry.

cycle_delay_use_special_days

fm_bill

Sets the delayed cycle start date to the 1st of the following month for all bundles purchased on the 29th, 30th, or 31st.

See "Setting Delayed Cycle Start Dates to the 29th, 30th, or 31st" in BRM Configuring and Running Billing.

CM

Billing utilities

Cached by the CM. Restart the CM after changing this entry.

deadlock_retry_count

fm_bill_accts

Specifies the number of retries to attempt when a deadlock occurs during a billing run.

See "Specifying the Number of Retries in Case of a Deadlock".

pin_billd

This entry is read by the utility when it runs. You do not need to restart the CM.

delay_cycle_fees

fm_bill

In systems set up for delayed billing, specifies when to apply cycle forward fees and cycle rollovers (during partial billing or final billing).

See "Specifying When to Apply Cycle Forward Fees and Cycle Rollovers" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

delta_step

pin_billd

Reduces contention at the database level during billing.

See "Rearranging Accounts to Improve Billing Performance".

pin_billd

This entry is read by the utility when it runs. You do not need to restart the CM.

enable_30_day_proration

fm_bill

Allows you to base monthly proration on 30-day months rather than the actual number of days in a billing cycle. This is often needed when working in parallel with older legacy billing systems.

See "About 30-Day-Based Proration" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

enforce_billing

pin_bill_accts

Enforces partial billing from the billing application inside the billing delay interval.

See "Enforcing Partial Billing in the Billing Delay Interval" in BRM Configuring and Running Billing.

pin_billd

This entry is read by the utility when it runs. You do not need to restart the CM.

group_by_account

pin_deferred_act

Specifies to use one thread to process scheduled actions for one account.

See "Ensuring the Sequence of Scheduled Actions".

pin_billd

This entry is read by the utility when it runs. You do not need to restart the CM.

keep_cancelled_products_or__discounts

fm_subscription_pol

Specifies whether to keep canceled charge offers and discount offers.

See "Providing Discounts to Closed Accounts" in BRM Configuring and Running Billing.

CM

The new value becomes effective immediately. You do not need to restart the CM.

open_item_actg_include_prev_total

fm_bill

Includes previous bill totals in the pending receivable value calculated during billing for accounts that use open item accounting.

See "Including Previous Balances in the Current Amount Due in Open Item Accounting" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry

purchase_fees_backcharge

fm_bill

Specifies which cycle (current or next) to apply the deferred purchase fees to during billing when the deferred time coincides with the billing time.

See "Specifying Which Billing Cycle to Assign to Deferred Purchase Fees" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry

rating_longcycle_roundup_flag

fm_rate

Enables rounding up for the long cycle.

CM

Cached by the CM. Restart the CM after changing this entry.

timestamp_rounding

fm_bill

Rounds timestamp to midnight.

See "About Time-Stamp Rounding" in BRM Configuring and Running Billing.

See also "About Sub-Balances" in PDC Creating Product Offerings.

CM

Cached by the CM. Restart the CM after changing this entry.

unset_error_status

pin_bill_accts

Sets billing status in a bill unit when billing errors occur.

See "Setting the Bill Unit Status When Billing Errors Occur" in BRM Configuring and Running Billing.

pin_billd

This entry is read by the utility when it runs. You do not need to restart the CM.

use_number_of_days_in_month

fm_bill

Specifies how to calculate proration when a cycle charge offer is purchased or canceled.

See "Calculating Prorated Cycle Fees" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

Collections pin.conf Entries

Table 64-4 lists the Collections pin.conf entries.

Table 64-4 Collections pin.conf Entries

Name Program Description pin.conf File Implementation

account_search_batch

fm_collections

Specifies the number of bill units to retrieve in collections step searches.

See "Setting the Number of Bill Units Retrieved during Step Searches" in BRM Collections Manager.

CM

Cached by the CM. Restart the CM after changing this entry.

collections_action_dependency

fm_collect

Creates dependencies between collections actions in a collections scenario.

See "Creating Dependencies between Collections Actions in a Scenario" in BRM Collections Manager.

CM

Cached by the CM. Restart the CM after changing this entry.

email_body

pin_collections_send_dunning

pin_inv_send

Specifies the path to a text file containing a customized message.

See "Specifying a File for the Email Body" in BRM Collections Manager.

pin_collections

pin_inv

The new value is effective immediately. You do not need to restart the CM.

execute_all_actions

fm_collections

Specifies whether to run all actions, including actions due before the date on which pin_collections_process is run for the first time, or only to run actions due after the date on which pin_collections_process is run for the first time.

See "Performing Scheduled Collections Actions after Reinstalling Collections Manager" in BRM Collections Manager.

CM

The new value is effective immediately. You do not need to restart the CM.

minimum_due

pin_collections_process

Specifies the minimum overdue balance that a bill unit must have to qualify for collections.

See "Setting the Minimum Overdue Balance to Process" in BRM Collections Manager.

pin_collections

The new value is effective immediately. You do not need to restart the CM.

Customer Management pin.conf Entries

Table 64-5 lists the Customer Management pin.conf entries.

Table 64-5 Customer Management pin.conf Entries

Name Program Description pin.conf File Implementation

cycle_arrear_proration

fm_rate

Specifies when to prorate cycle arrears fees, at purchase or at cancellation.

See "Proration for Special Cases" in BRM Configuring and Running Billing.

CM

Cached by the CM. Restart the CM after changing this entry.

em_db

fm_delivery

Specifies the Email Data Manager database number.

See "Configuring the Email Data Manager" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

intro_dir

fm_cust_pol

Specifies the location of the introductory message that allows a customer to confirm account creation.

CM

The new value is effective immediately. You do not need to restart the CM.

Discounting pin.conf Entries

Table 64-6 lists the Discounting pin.conf entries.

Table 64-6 Discounting pin.conf Entries

Name Program Description pin.conf File Implementation

rollover_zeroout_discounts

fm_rate

Zeroes-out the positive bucket.

See "Configuring the Start and End Times for Discount Sharing" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

General Ledger pin.conf Entries

Table 64-7 lists the General Ledger pin.conf entries.

Table 64-7 General Ledger pin.conf Entries

Name Program Description pin.conf File Implementation

gl_segment

fm_cust_pol

Specifies the default G/L segment for an account during account creation.

See "Changing the Default G/L Segment" in BRM Collecting General Ledger Data.

CM

The new value is effective immediately. You do not need to restart the CM.

transaction_grouping

pin_ledger_report

Specifies how many A/R accounts to group in a single transaction for ledger_report to run.

See "Setting the Number of Paying Accounts per G/L Report" in BRM Collecting General Ledger Data.

pin_billd

The new value is effective immediately. You do not need to restart the CM.

Invoicing pin.conf Entries

Table 64-8 lists the Invoicing pin.conf entries.

Table 64-8 Invoicing pin.conf Entries

Name Program Description pin.conf File Implementation

database

pin_inv_accts

pin_inv_export

pin_inv_send

pin_inv_upgrade

Specifies the database schema to which the following utilities should connect:

  • pin_inv_accts

  • pin_inv_export

  • pin_inv_send

  • pin_inv_upgrade

See "Configuring the Invoice pin.conf for Multiple Database Schemas" in BRM Designing and Generating Invoices.

pin_inv

The new value is effective immediately. You do not need to restart the CM.

export_dir

pin_inv_export

Specifies the path to the invoice directory.

See "Exporting Invoices" in BRM Designing and Generating Invoices.

pin_inv

The new value is effective immediately. You do not need to restart the CM.

from

pin_inv_send

Specifies the e-mail address of the sender.

See "pin_inv_send" in BRM Designing and Generating Invoices.

pin_inv

The new value is effective immediately. You do not need to restart the CM.

html_template

pin_inv_pol

Specifies the HTML template file to use to generate invoices.

CM

The new value is effective immediately. You do not need to restart the CM.

invoice_db

pin_inv_export

pin_inv_send

Specifies the database number for the schema.

See "Configuring BRM to Use a Separate Invoice Database Schema" in BRM Designing and Generating Invoices.

pin_inv

The new value is effective immediately. You do not need to restart the CM.

invoice_dir

fm_bill

Specifies the directory where invoices are stored.

See "Exporting Invoices" in BRM Designing and Generating Invoices.

CM

The new value is effective immediately. You do not need to restart the CM.

invoice_fmt

pin_inv_export

pin_inv_send

Specifies the invoice format.

See "Exporting Invoices" in BRM Designing and Generating Invoices.

pin_inv

The new value is effective immediately. You do not need to restart the CM.

inv_perf_features

fm_inv

Improves performance by removing unnecessary details from your invoices.

CM

Cached by the CM. Restart the CM after changing this entry.

sender

fm_cust_pol

pin_inv_send

Specifies the name of the e-mail sender.

See "pin_inv_send" in BRM Designing and Generating Invoices.

CM

pin_inv

The new value is effective immediately. You do not need to restart the CM.

service_centric_invoice

fm_inv_pol

Enables service-centric invoicing.

CM

Cached by the CM. Restart the CM after changing this entry.

show_rerate_details

fm_inv_pol

Specifies whether to display shadow adjustment details on invoices.

See "Including Shadow Event Adjustment Details in Invoices" in BRM Designing and Generating Invoices.

CM

Cached by the CM. Restart the CM after changing this entry.

subject

pin_inv_send

Specifies the subject of the e-mail.

See "pin_inv_send" in BRM Designing and Generating Invoices.

pin_inv

The new value is effective immediately. You do not need to restart the CM.

Payments pin.conf Entries

Table 64-9 lists the Payments pin.conf entries.

Table 64-9 Payments pin.conf Entries

Name Program Description pin.conf File Implementation

cc_validate

fm_pymt_pol

Specifies whether to validate a customer's credit card information during account creation.

See "Validating Credit Cards at Account Creation" in BRM Managing Customers.

CM

The new value is effective immediately. You do not need to restart the CM.

config_payment

fm_pymt

Specifies the database and POID of the /config/payment object. Change this value if you create a custom /config/payment object.

CM

The new value is effective immediately. You do not need to restart the CM.

dd_validate

fm_pymt_pol

Specifies whether to validate a customer's direct debit (debit card) information during account creation.

CM

The new value is effective immediately. You do not need to restart the CM.

merchant

fm_cust_pol

Specifies the merchant to receive money collected during credit-card processing.

See "Specifying Merchant IDs and Merchant Numbers" in BRM Configuring and Collecting Payments.

CM

Cached by the CM. Restart the CM after changing this entry.

minimum

pin_billd

Specifies the minimum balance for retrieving accounts for credit card collection.

Use this entry to set a minimum threshold for the amount due on an account when searching for accounts for collection.

See "Specifying the Minimum Payment to Collect" in BRM Configuring and Running Billing.

pin_billd

The new value becomes effective immediately. You do not need to restart the CM.

validate_acct

fm_pymt_pol

Allows use of the customer's credit card on an account different from the root account.

See "Specifying the Account That Records Credit Card Validations" in BRM Managing Customers.

CM

The new value is effective immediately. You do not need to restart the CM.

Pricing and Rating pin.conf Entries

Table 64-10 lists the Pricing and Rating pin.conf entries.

Table 64-10 Pricing and Rating pin.conf Entries

Name Program Description pin.conf File Implementation

delay

pin_rerate

Specifies the delay for rerating jobs.

pin_rerate

The new value is effective immediately. You do not need to restart the CM.

fm_offer_profile_cache

cm_cache

Specifies the attributes of the CM cache for offer profiles.

Note: This entry is mandatory for policy-driven charging.

See "Improving Performance for Loading Large Product Offerings".

CM

Cached by the CM. Restart the CM after changing this entry.

fm_price_cache_beid

cm_cache

Specifies attributes of the CM cache for the size of balance element IDs (BEID).

See "Improving Performance for Loading Large Product Offerings".

CM

The new value is effective immediately. You do not need to restart the CM.

fm_price_prod_provisioning_cache

cm_cache

Specifies the attributes of the CM cache for the size of charge offer provisioning tags.

See "Improving Performance for Loading Large Product Offerings".

CM

The new value is effective immediately. You do not need to restart the CM.

log_refresh_product

fm_rate

Specifies whether to log product offering changes. You can use the log entries to generate notifications about such changes.

See "Logging Changes to Product Offerings" in PDC Creating Product Offerings.

CM

Cached by the CM. Restart the CM after changing this entry.

rating_max_scale

fm_rate

Specifies the precision level of decimal values.

See "Changing the Precision of Rounded and Calculated Values".

CM

Cached by the CM. Restart the CM after changing this entry.

rating_quantity_rounding_scale

fm_rate

Specifies the precision of rounded values.

See "Changing the Precision of Rounded and Calculated Values".

CM

Cached by the CM. Restart the CM after changing this entry.

rating_timezone

fm_rate

Specifies the server time zone.

CM

Cached by the CM. Restart the CM after changing this entry.

refresh_product_interval

fm_rate

Specifies the interval in which product offerings are refreshed in cache memory.

See "Setting the Interval for Checking for Product Offering Changes".

CM

Cached by the CM. Restart the CM after changing this entry.

timezone_file

fm_rate

Specifies the location of the timezones.txt file.

CM

Cached by the CM. Restart the CM after changing this entry.

update_interval

fm_zonemap_pol

Specifies an interval for revising the value map.

See "Setting the Interval for Checking for Product Offering Changes".

CM

Cached by the CM. Restart the CM after changing this entry.

validate_deal_dependencies

fm_utils

Specifies whether to validate the bundle prerequisites and mutually exclusive relations.

See "Configuring Bundle Dependencies" in BRM Managing Customers.

CM

The new value is effective immediately. You do not need to restart the CM.

Revenue Assurance pin.conf Entries

Table 64-11 lists the Revenue Assurance pin.conf entries.

Table 64-11 Revenue Assurance pin.conf Entries

Name Program Description pin.conf File Implementation

writeoff_control_point_id

fm_process_audit

Changes the control point ID.

See "Renaming the Control Point for Collecting Data from Usage Write-Offs" in BRM Collecting Revenue Assurance Data.

CM

Cached by the CM. Restart the CM after changing this entry.

Service Lifecycle Management pin.conf Entries

Table 64-12 lists the Service Lifecycle Management pin.conf entries.

Table 64-12 Service Lifecycle Management pin.conf Entries

Name Program Description pin.conf File Implementation

fm_bill_template_cache

cm_cache

Specifies attributes of the template cache. This cache is used by the Service Lifecycle Management feature.

See "Managing Custom Service Life Cycles" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

fm_bill_utils_business_profile_cache

cm_cache

Specifies attributes of the business_profile cache. This cache is used by the Service Lifecycle Management feature.

See "Managing Custom Service Life Cycles" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

fm_cust_lifecycle_config_cache

cm_cache

Specifies attributes of the lifecycle cache. This cache is used by the Service Lifecycle Management feature.

See "Managing Custom Service Life Cycles" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

fm_cust_statemap_config_cache

cm_cache

Specifies attributes of the statemap cache. This cache is used by the Service Lifecycle Management feature.

See "Managing Custom Service Life Cycles" in BRM Managing Customers.

CM

Cached by the CM. Restart the CM after changing this entry.

Services Framework pin.conf Entries

Table 64-13 lists the Services Framework pin.conf entries.

Table 64-13 Service Framework pin.conf Entries.

Name Program Description pin.conf File Implementation

agent_return

fm_tcf

Specifies the provisioning status when provisioning is simulated.

CM

Restart the CM after changing this entry.

commit_at_prep

dm_provision

Specifies whether to send the payload to the agent at PREP_COMMIT time and not to send anything at COMMIT time.

dm_prov_telco

This entry is read by the utility when it runs. You do not need to restart the CM.

connect_retries

dm_provision

Specifies the number of times dm_provision attempts to connect to the Infranet agent on connection failure.

See "Configuring the Provisioning Data Manager" in BRM Telco Integration.

dm_prov_telco

This entry is read by the utility when it runs. You do not need to restart the CM.

connect_retry_interval

dm_provision

Specifies how many seconds to wait before retrying to connect to the Infranet agent on connection failure.

See "Configuring the Provisioning Data Manager" in BRM Telco Integration.

dm_prov_telco

This entry is read by the utility when it runs. You do not need to restart the CM.

prov_db

fm_tcf

Specifies the number of the database to which provisioning connects to send the service order.

See "Connecting the Connection Manager to the Provisioning Data Manager" in BRM Telco Integration.

CM

Cached by the CM. Restart the CM after changing this entry.

prov_ptr

dm_provision

Specifies where to find the Provisioning Data Manager.

See "Configuring the Provisioning Data Manager" in BRM Telco Integration.

CM

Cached by the CM. Restart the CM after changing this entry.

prov_timeout

dm_provision

Specifies the length of time to wait to receive a complete response from the provisioning agent.

See the instructions in the pin.conf file.

dm_prov_telco

This entry is read by the utility when it runs. You do not need to restart the CM.

provisioning_enabled

fm_tcf

Enables charge offer provisioning.

CM

Cached by the CM. Restart the CM after changing this entry.

simulate_agent

fm_tcf

Creates a response and updates the service order.

CM

The new value is effective immediately. You do not need to restart the CM.

Tax Calculation pin.conf Entries

Table 64-14 lists the Tax Calculation pin.conf entries.

Table 64-14 Tax Calculation pin.conf Entries

Name Program Description pin.conf File Implementation

commtax_series

dm_vertex

Specifies the Vertex tax package that BRM uses to calculate telecommunications taxes.

See "Configuring the Vertex DM for Communications Tax Q Series" in BRM Calculating Taxes.

dm_vertex

Restart the Data Manager (DM) after changing this entry.

commtax_config_path

dm_vertex

Specifies the location of Communications Tax Q Series configuration file (ctqcfg.xml).

See "Configuring the Vertex DM for Communications Tax Q Series" in BRM Calculating Taxes.

dm_vertex

Valid only when commtax_series is set to 6. Restart the DM after changing this entry.

commtax_config_name

dm_vertex

Specifies the Communications Tax Q Series configuration name.

See "Configuring the Vertex DM for Communications Tax Q Series" in BRM Calculating Taxes.

dm_vertex

Valid only when commtax_series is set to 6. Restart the DM after changing this entry.

include_zero_tax

fm_rate

Specifies whether to include zero tax amounts in the tax jurisdictions for the event's balance impacts.

See "Reporting Zero Tax Amounts" in BRM Calculating Taxes.

CM

Cached by the CM. Restart the CM after changing this entry.

provider_loc

fm_rate_pol

Specifies the city, state, ZIP code, and country where services are provided for taxation.

CM

The new value becomes effective immediately and all subsequent tax calculations use the new address. You do not need to restart the CM.

quantum_logfile

dm_vertex

Specifies the QSUT API to log debug information (into the specified file name) about the current transaction to be processed for tax calculation.

See "Setting Up Tax Calculation for Vertex" in BRM Calculating Taxes.

dm_vertex

The new value becomes effective immediately. You do not need to restart the CM.

quantumdb_passwd

dm_vertex

Specifies the Oracle user password.

See "Configuring Vertex Manager" in BRM Calculating Taxes.

dm_vertex

Restart the DM after changing this entry.

quantumdb_register

dm_vertex

Specifies whether to log an audit trail of invoices in the Quantum Register database.

See "Setting Up Tax Calculation for Vertex" in BRM Calculating Taxes.

dm_vertex

Restart the DM after changing this entry.

quantumdb_server

dm_vertex

Specifies the name of the database server than contains the Quantum tables.

See "Configuring Vertex Manager" in BRM Calculating Taxes.

dm_vertex

Restart the DM after changing this entry.

quantumdb_source

dm_vertex

Specifies the schema where the STQ tables reside. For Indexed Sequential Access Method (ISAM) databases, specifies the ISAM data file directory.

See "Configuring Vertex Manager" in BRM Calculating Taxes.

dm_vertex

Restart the DM after changing this entry.

quantumdb_user

dm_vertex

Specifies the name of the Oracle user.

See "Configuring Vertex Manager" in BRM Calculating Taxes.

dm_vertex

Restart the DM after changing this entry.

tax_now

fm_ar

Specifies when tax is calculated for account-level adjustments (at the end of billing or at the time of adjustment).

CM

The new value is effective immediately. You do not need to restart the CM.

tax_return_juris

fm_rate

Specifies whether to summarize taxes by jurisdiction or to itemize taxes.

CM

Cached by the CM. Restart the CM after changing this entry.

tax_return_loglevel

fm_rate

Specifies how to log messages returned from the taxation DM.

CM

Cached by the CM. Restart the CM after changing this entry.

tax_reversal_with_tax

fm_ar

Specifies whether to apply a tax reversal for an adjustment, dispute, or settlement

CM

The new value is effective immediately. You do not need to restart the CM.

tax_supplier_map

fm_rate

Specifies the location of the tax_supplier_map file.

CM

Billing utilities

Restart the CM after changing this entry.

tax_valid

fm_cust_pol

Specifies how to validate the state and zip code of the billing address during account creation.

CM

The new value is effective immediately. You do not need to restart the CM.

taxation_switch

fm_bill

Enables taxation.

See "Enabling and Disabling Taxation Globally" in BRM Calculating Taxes.

CM

Cached by the CM. Restart the CM after changing this entry.

taxcodes_map

fm_rate

Specifies the location of the taxcodes_map file.

CM

Billing utilities

Cached by the CM. Restart the CM after changing this entry.

vertex_db

fm_rate

Specifies the database number of the Vertex database.

See "Specifying Vertex DM Connection Entries in CM Configuration File" in BRM Calculating Taxes.

CM

The new value is effective immediately. You do not need to restart the CM.

CM System Administration pin.conf Entries

Table 64-15 lists the CM system administration pin.conf entries.

Table 64-15 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".

pcp_validate_string_fields_as_utf8

cm

Disables the UTF8 validation process in BRM.

See "Problem: PIN_ERR_BAD_UTF8 Error".

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 on the Primary Installation Machine" 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.

See "Maintaining the Order of Rate Plan Selectors" in BRM Setting Up Pipeline Pricing.

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.

DM System Administration pin.conf Entries

Table 64-16 lists the DM system administration pin.conf entries.

Table 64-16 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_shared_poid_cache

dm

Specifies whether to cache a shared POID pool for all Oracle DM back ends. The default value is 1 (enabled).

For more information, see "Disabling POID Caching".

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

pcp_validate_string_fields_as_utf8

dm

Disables the UTF8 validation process in BRM.

See "Problem: PIN_ERR_BAD_UTF8 Error".

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

Enterprise Application Integration (EAI) Manager pin.conf Entries

Table 64-17 lists the EAI Manager pin.conf entries.

Table 64-17 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 64-18 lists the MTA Framework pin.conf entries.

Table 64-18 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_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.

log_rotate_by_size_megabytes

See "C-Based Applications and Utilities that Support Log Rotation" for more information on the program list.

Specifies the size-based log rotation in megabytes. The value is an integer. See "Rotating Log Files for C/C++Based Applications" for more information.

log_rotate_by_days_at_time

See "C-Based Applications and Utilities that Support Log Rotation" for the list of applications.

Specifies the number of days and time for time-based rotation, in the format frequency HH:MM, where frequency is an integer indicating the number of days, HH is an integer between 0 and 23 indicating the hour at which the rotation should take place, and MM is an integer between 0 and 59 indicating the minute at which the rotation should take place.

See "Rotating Log Files for C/C++Based Applications" for more information.

log_rotate_backup_dir

See "C-Based Applications and Utilities that Support Log Rotation" for the list of applications.

Specifies the location in which the backup files will be stored during the log rotation cycle.

You need to enter the full directory path.

See "Rotating Log Files for C/C++Based Applications" for more information.

log_rotate_file_name_format

See "C-Based Applications and Utilities that Support Log Rotation" for the list of applications.

Specifies the time format for the log rotation in the format format append, where format is a format specifier compatible with strftime() and append is either 1 indicating that the system should append the end time to the file name, or 0 indicating the system should not append it.

Note: The append parameter is considered only when day-based rotation is enabled.

See "Rotating Log Files for C/C++Based Applications" for more information.

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.

Utility pin.conf Entries

Table 64-19 lists the utility pin.conf entries.

Table 64-19 Utility pin.conf Entries

Name Program Description

pcp_validate_string_fields_as_utf8

testnap

Disables the UTF8 validation process in BRM.

See "Problem: PIN_ERR_BAD_UTF8 Error".