This chapter provides reference information for Oracle Communications Billing and Revenue Management (BRM) customer management utilities.
Loads notification XML file from Pipeline Manager into the BRM database. This allows BRM to notify customers when their balance has reached a threshold value during the batch rating process. For more information, see "About Credit Limit and Threshold Checking during Batch Rating".
You must configure the Batch Controller to execute this utility. See "Configuring Batch Controller to Run load_notification_event".
Note:
To connect to the BRM database, this utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Sets the log level to debug and outputs debug information into the log file for this process. If not set, only error-level information is output.
Displays information about failed or successful processing as the utility runs.
Displays syntax and parameters for this utility.
The name and location of the XML file to load into the BRM database. This must be the last parameter listed on the command line.
This utility notifies you when it successfully loads the XML file.
If the utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started or in a directory specified in the configuration file.
Use this utility to load business profiles and validation templates into the BRM database.
You enter this information in the business profile configuration file (BRM_Home/sys/data/config/pin_business_profile.xml).
For more information, see the following topics:
Editing the Business Profile Configuration File
Note:
This utility supports branding.Important:
To connect to the BRM database, this utility needs a configuration file in the directory from which you run the utility. For more information on creating configuration files for BRM utilities, see "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Creates a log file for debugging purposes. Use this parameter for debugging when the utility seemed to run without error but the data was not loaded into the database.
Displays syntax and parameters for this utility.
Retrieves the business profile and validation template data from the BRM database and saves it in an XML file.
Runs the utility in test mode to validate the XML file against its schema definition (see "Validating Your Business Profile Configuration File Edits"). This option does not create, modify, or delete any business profile or validation template objects in your BRM database.
Tip:
To avoid load errors based on XML content problems, run the utility with this option before loading data into the database.Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used in conjunction with other parameters and commands. It is not position dependent. For example, you can enter -v at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:load_pin_business_profile other_parameters –v > filename.log
The name and location of the business profile configuration file. The default file is BRM_Home/sys/data/config/pin_business_profile.xml, but the utility can take any XML file name as a parameter as long as the file's contents conform to the appropriate schema definition. See "Validating Your Business Profile Configuration File Edits".
If you copy filename to the same directory from which you run the load utility, specify only the file name. If you run the command in a different directory from where filename is located, you must include the entire path for the file.
In addition, filename must be in the same directory as the default BRM_Home/sys/data/config/business_configuration.xsd file.
This utility notifies you only if it encounters errors. Look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.
To verify that the business profile and validation template information was loaded, display the /config/business_profile and /config/template subclass objects by using one of the following features:
Object Browser
robj command with the testnap utility
For more information on reading an object and writing its contents to a file, see "Reading an Object and Writing its Contents to a File" in BRM Developer's Guide.
Important:
You must stop and restart the Connection Manager (CM) to make new business profile and validation template data available. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.Use this utility to load your customer segment definitions into the BRM database. You define customer segments in the BRM_Home/sys/data/config/pin_customer_segment.xml file.
For more information on customer segments, see "Creating and Managing Customer Segments".
Note:
You cannot load separate /config/customer_segment objects for each brand. All brands use the same object.Caution:
When you run the load_pin_customer_segment utility, it overwrites the existing customer segments in the database. If you are updating your customer segments, you cannot load new segments only. You must load complete sets of customer segments each time you run the load_pin_customer_segment utility.Important:
To connect to the BRM database, the load_pin_customer_segment utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Runs the utility in test mode to validate the XML file format against the XSD file, and does not load the data or overwrite any existing data. Use this option before loading data into the /config object.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used in conjunction with other parameters and commands. It is not position dependent. For example, you can enter -v at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:load_pin_customer_segment other_parameters –v > filename.log
Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no errors, but the data has not been loaded into the database.
Displays help information for using this utility.
The name and location of the XML file that stores localized strings for customer segments. The XML file is referenced by the pin_business_configuration.xsd file; therefore these files must be located in the same directory. The default customer segment file is in BRM_Home/sys/data/config.
If you copy the pin_customer_segment.xml file and the pin_business_configuration.xsd file to the same directory from which you run the load_pin_customer_segment utility, you do not have to specify either the path or the file name.
If you run the command in a different directory from where the pin_customer_segment.xml file is located, you must include the entire path for the file.
The load_pin_customer_segment utility notifies you when it successfully creates the /config/customer_segment object.
If the load_pin_customer_segment utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
To verify that the customer segments were loaded, you can display the /config/customer_segment object by using the Object Browser, or use the robj command with the testnap utility. See "Reading an Object and Writing its Contents to a File" in BRM Developer's Guide.
Important:
You must restart the Connection Manager to start recording your customer login failure preferences. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.Use this utility to add an event notification list to your BRM database. See "Loading the Event Notification List" in BRM Developer's Guide.
For general information about event notification, see "Using Event Notification" in BRM Developer's Guide.
Note:
You cannot load separate /config/notify objects for each brand. All brands use the same object.Caution:
If your database already contains an event notification list when you run this utility, the utility replaces the list in the database with the list in the configuration file that you load. If you use event notification for multiple features, you must merge the old list with the new list before running this utility. Otherwise, you will lose existing event notification functionality. See "Merging Event Notification Lists" in BRM Developer's Guide.Important:
To connect to the BRM database, this utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Specifies debug mode. The utility logs messages to the default.pinlog file in the current directory or in a directory specified in the utility configuration file. Use this parameter for troubleshooting when the utility runs with no errors but the notification file is not loaded into the database.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used in conjunction with other parameters and commands. It is not position dependent. For example, you can enter -v at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:load_pin_notify other_parameters –v > filename.log
Displays the syntax and parameters for this utility.
The name and location of the configuration file that contains the event notification list you want to load into your database. The default event notification configuration file, pin_notify, is in BRM_Home/sys/data/config.
For more information, see "Merging Event Notification Lists" in BRM Developer's Guide.
Tip:
If you copy the pin_notify_file to the same directory from which you run load_pin_notify, you do not have to specify the path or the file name.This utility notifies you when it successfully creates the /config/notify storable object.
If the utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started or in a directory specified in the configuration file.
Important:
You must restart the Connection Manager to make new events and the corresponding opcodes available. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.Use this utility to load your preferences for recording customer login failures into the BRM database. You define preferences for recording customer login failures in the BRM_Home/sys/data/config/pin_verify file.
For more information on monitoring customer login failures, see "Tracking Customer Authentication and Authorization Records".
Note:
You cannot load separate /config/verify objects for each brand. All brands use the same object.Caution:
When you run this utility, it overwrites the existing preferences for recording customer login failures. If you are updating your preferences, you cannot load new preferences only. You must load complete sets of preferences each time you run the utility.Important:
To connect to the BRM database, this utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.The name and location of the file that contains preferences for recording login failures. The default pin_verify file is in BRM_Home/sys/data/config.
Tip:
If you copy the edited pin_verify file to the same directory from which you run the load_pin_verify utility, you do not have to specify the path or the file name.The load_pin_verify utility notifies you when it successfully creates the /config/verify object.
If the load_pin_verify utility does not notify you that it was successful, look in the utility log file (default.pinlog) to find any errors. The log file is either in the directory from which the utility was started, or in a directory specified in the configuration file.
Important:
You must restart the Connection Manager to start recording your customer login failure preferences. See "Starting and Stopping the BRM System" in BRM System Administrator's Guide.Use this utility to load custom deal and plan transition types into the BRM database. You define custom transition types in the BRM_Home/sys/data/pricing/example/pin_transition_type file.
For more information, see "Creating Custom Transition Types for Deals and Plans".
Note:
You cannot load separate /config/transition_type objects for each brand. All brands use the same object.Caution:
When you run load_transition_type, it overwrites the existing /config/transition_type object. If you are updating your transition types, you cannot load new transition types only. You must load complete sets of transition types each time you run the utility.Important:
To connect to the BRM database, this utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.Displays information about successful or failed processing as the utility runs.
Creates a log file for debugging purposes. Use this parameter for debugging when the utility appears to have run with no errors, but the data has not been loaded into the database.
The name and location of the file that contains your custom transition types. By default, the utility uses pin_transition_type.
If you run the command in a different directory from where the pin_transition_type file is located, you must include the entire path for the file.
This utility notifies you only if it encounters errors. Look in the default.pinlog file for errors. This file is either in the directory from which the utility was started or in a directory specified in the utility configuration file.
To verify that the transition types were loaded, you can display the /config/transition_type object by using Object Browser, or use the robj command with the testnap utility. See "Reading an Object and Writing its Contents to a File" in BRM Developer's Guide.
Use this utility to purge the Audit Accounts Product table of data that is older than a specified time period. When you modify a product in Customer Center, BRM records the details of the product modifications in the AUDIT_ACCOUTNTS_PRODUCT_T table. BRM stores audit data when a customer purchases an item product and modifies or cancels an existing subscription product.
Note:
To connect to the BRM database, the pin_product_clear utility needs a configuration file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.BRM_Home/bin
The pin.conf file for this utility is located in BRM_Home/apps/pinapps/pin_rerate. Run pin_product_clear from this directory.
Deletes all the records from the Audit Accounts Product table that are older than the number of days specified by days.
Deletes all records from the Audit Account Product table that are dated prior to the midnight of the date you have specified.
Displays information about successful or failed processing as the utility runs.
Note:
This parameter is always used in conjunction with other parameters and commands. It is not position dependent. For example, you can enter -verbose at the beginning or end of a command to initiate the verbose parameter. To redirect the output to a log file, use the following syntax with the verbose parameter. Replace filename.log with the name of the log file:pin_product_clear other_parameters –v > filename.log
Tests the utility, but does not affect the Audit Accounts Product table.
Displays the syntax and parameters for this utility.
Use this utility to perform bulk service state transitions based on the state expiration time (PIN_FLD_SERVICE_STATE_EXPIRATION_T field) in /service objects. A system administrator schedules the utility to run at a specified time each day. The utility finds services whose state expires on the current date and changes their state based on the applicable state transition.
Important:
If you use custom service life cycles, Oracle recommends that you run the utility daily.In the /config/lifecycle_states object associated with a service, the default next state is the state in the PIN_FLD_TRANSITIONS array whose PIN_FLD_DEFAULT_FLAG field is set to 1. If this flag is not set to 1 in any of the transitions configured for a state, this utility does not change the service's state.
To get the applicable state transition, this utility calls the PCM_OP_CUST_GET_LIFECYCLE_STATES opcode.
To perform the state transition, this utility calls the PCM_OP_CUST_UPDATE_SERVICES opcode.
See "Managing Service Life Cycles" for more information on changing states in custom service life cycles.
Note:
To connect to the BRM database, this utility needs a configuration (pin.conf) file in the directory from which you run the utility. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.BRM_Home/bin
The configuration file for this utility is located in the BRM_Home/apps/pin_state_change directory. Run pin_state_change from that directory.
Displays the syntax and parameters for this utility.
Performs state transitions for services in this state only. Use the name of a state defined in the <NAME> element in a config_lifecycle_states.xml file.
Performs state transitions for this service type only. Use the name of a BRM service type (/service/*) that uses a custom life cycle.
Displays information about successful or failed processing as the utility runs.
The log file specified in the utility's configuration (pin.conf) file records the following:
The number of services for which this utility called the PCM_OP_CUST_UPDATE_SERVICES opcode to make a state change
The number of state changes that were successful
For more information on why any failures occurred, see the log for PCM_OP_CUST_UPDATE_SERVICES.
Use this utility to unlock a locked CSR account. This utility also resets the CSR account password to a temporary one. The system administrator needs to provide the temporary password while unlocking the locked CSR account. For more information, see "Unlocking a Locked CSR Account" in BRM System Administrator's Guide.
Important:
The pin_unlock_service utility needs a configuration (pin.conf) file in the same directory from which you run the utility. The pin.conf file required for running this utility is located in the BRM_Home/apps/pin_unlock_service directory. See "Creating Configuration Files for BRM Utilities" in BRM System Administrator's Guide.
Make sure that the account in the pin.conf file is not locked.
This utility accepts parameters through command prompts only. After each entry, press the Enter key to confirm your selection. For more information, see "Unlocking a Locked CSR Account" in BRM System Administrator's Guide.