Suspense Management Utilities

load_edr_field_mapping

Use this utility to load event record field mapping into the /edr_field_mapping object in the BRM database. See Integrating Event Record Field Mapping

Location

BRM_home/bin

Syntax

load_edr_field_mapping [-d] [-v] [-t] [-h] XML_file

Parameters

-d

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.

-v

Displays detailed information as the utility runs.

-t

Validates the XML file. Your event record field mapping XML file must conform to the XML schema rules in the BRM_home/xsd/edr_field_mapping.xsd file.

-h

Shows the help on the utility.

XML_file

The name and location of the event record field mapping configuration file, which maps the event record field name to an ID number. The default edr_field_mapping.xml file is in BRM_home/sys/data/config directory.

If you copy the edr_field_mapping.xml file to the same directory from which you run the load_edr_field_mapping 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 edr_field_mapping.xml file is located, you must include the entire path for the file.

load_pin_suspense_editable_flds

Use this utility to load editable fields into the /config/suspense_editable_flds object in the BRM database. You define editable fields in the pin_suspense_editable_flds file in BRM_home/sys/data/config.

For more information, see "Specifying Editable Fields in Suspense Manager Center".

Caution:

The load_pin_suspense_editable_flds utility overwrites existing /config/suspense_editable_flds objects. If you are updating editable fields, you cannot load new editable fields only. You must load complete sets of editable fields each time you run the utility.

Note:

To connect to the BRM database, the load_pin_suspense_editable_flds utility needs a configuration file in the directory from which you run the utility. See Connecting BRM Utilities in BRM System Administrator's Guide.

Location

BRM_home/bin

Syntax

load_pin_suspense_editable_flds [-d] [-v] [pin_suspense_editable_flds_file]

Parameters

-d

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.

-v

Displays detailed information as the utility runs.

pin_suspense_editable_flds_file

The name and location of the file that defines the list of editable fields used by Suspense Management Center. The default pin_suspense_editable_flds file is in BRM_home/sys/data/config.

If you copy the pin_suspense_editable_flds file to the same directory from which you run the load_pin_suspense_editable_flds 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_suspense_editable_flds file is located, you must include the entire path for the file.

Results

The load_pin_suspense_editable_flds utility notifies you when it successfully creates the /config/suspense_editable_flds object. Otherwise, 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 network elements were loaded, display the /config/suspense_editable_flds object by using Object Browser or the robj command with the testnap utility. See "Reading Objects" and "Using testnap to Modify /config Objects" in BRM Developer's Guide.

Note:

You must restart Suspense Management Center to make new editable fields available.

load_pin_suspense_override_reason

Use this utility to load override reasons into the /config/suspense_override_codes object in the BRM database. You define override reasons in the pin_suspense_override_reason file in BRM_home/sys/data/config. See Overriding Suspense Handling Rules.

Caution:

The load_pin_suspense_override_reason utility overwrites existing suspense override reasons. You must load complete sets of override reasons each time you run the utility.

Note:

To connect to the BRM database, the load_pin_suspense_override_reason 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.

Location

BRM_home/bin

Syntax

load_pin_suspense_override_reason [-d] [-v] pin_suspense_override_reason_file

Parameters

-d

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.

-v

Displays detailed information as the utility runs.

pin_suspense_override_reason_file

The name and location of the file that defines the override reasons. The default pin_suspense_override_reason file is in BRM_home/sys/data/config.

If you copy the pin_suspense_override_reason file to the same directory from which you run the load_pin_suspense_override_reason 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_suspense_override_reason file is located, you must include the entire path for the file.

Results

The load_pin_suspense_override_reason utility notifies you when it successfully creates the /config/suspense_override_codes object. Otherwise, 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 network elements were loaded, display the /config/suspense_override_codes object by using Object Browser or the robj command with the testnap utility. See "Reading Objects" and "Using testnap to Modify /config Objects" in BRM Developer's Guide.

Note:

You must restart Suspense Management Center to enable it to use the new suspense override reasons.

load_pin_suspense_params

Use this utility to load system-level configuration information for Suspense Manager into the /config/suspense_params object in the BRM database. You define the system parameters for Suspense Manager, such as the number of records to process in each opcode call, in the pin_suspense_params file in the BRM_home/sys/data/config directory.

Caution:

The load_pin_suspense_params utility overwrites existing Suspense Manager system parameters. You must load complete sets of parameters each time you run the utility.

Note:

To connect to the BRM database, the load_pin_suspense_params 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.

Location

BRM_home/bin

Syntax

load_pin_suspense_params [-d] [-v] filename

Parameters

-d: 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.
-v: Displays detailed information as the utility runs.
filename: The name of the text file containing the configuration parameters for suspense management. The default file name is pin_suspense_params.

Results

The load_pin_suspense_params utility notifies you when it successfully creates the /config/suspense_params object. Otherwise, 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 data was loaded, display the /config/suspense_params object by using Object Browser or the robj command with the testnap utility. See "Reading Objects" and "Using testnap to Modify /config Objects" in BRM Developer's Guide.

load_pin_suspense_reason_code

Use this utility to load suspense reasons and subreasons into the /config/suspense_reason_code object in the BRM database. You define suspense reasons and subreasons in the pin_suspense_reason_code file in BRM_home/sys/data/config/suspense_reason_code.

For more information, see "Changing the List of Suspense Reasons and Subreasons".

Caution:

The load_pin_suspense_reason_code utility overwrites existing suspense reason and subreason codes. If you are updating suspense reason and subreason codes, you cannot load new codes only. You must load complete sets of codes each time you run the utility.

Note:

To connect to the BRM database, the load_pin_suspense_reason_code 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.

Location

BRM_home/bin

Syntax

load_pin_suspense_reason_code [-d] [-v] pin_suspense_reason_code_file

Parameters

-d

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.

-v

Displays detailed information as the utility runs.

pin_suspense_reason_code_file

The name and location of the file that defines suspense reasons and subreasons. The default pin_suspense_reason_code file is in BRM_home/sys/data/config.

If you copy the pin_suspense_reason_code file to the same directory from which you run the load_pin_suspense_reason_code 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_suspense_reason_code file is located, you must include the entire path for the file.

Results

The load_pin_suspense_reason_code utility notifies you when it successfully creates the /config/suspense_reason_code object. Otherwise, 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 network elements were loaded, display the /config/suspense_reason_code object by using Object Browser or the robj command with the testnap utility. See "Reading Objects" and "Using testnap to Modify /config Objects" in BRM Developer's Guide.

Note:

If you are changing the suspense reason or subreason codes, you must also modify the suspense_reason_code.en_US file and run the load_localized_strings utility. See "Configuring Suspense and Recycle on the BRM Server".

load_pin_batch_suspense_override_reason

Use the load_pin_batch_suspense_override_reason utility to load batch suspense override-able reason codes into the /config/batch_suspense_override_reason object in the BRM database. You define batch suspense override reason codes in the pin_batch_suspense_override_reason file in BRM_home/sys/data/config. By default, no reason can be overridden, so the file is a placeholder.

Caution:

The load_pin_batch_suspense_override_reason utility overwrites the existing /config/batch_suspense_override_reason object in the BRM database. If you are updating the /config/batch_suspense_override_reason object, you must load complete sets of batch suspense override-able reasons each time.

Note:

To connect to the BRM database, the utility needs the Connection Manager (CM) to be up and running.

Location

BRM_home/bin

Syntax

load_pin_batch_suspense_override_reason [-d] [-v] pin_batch_suspense_override_reason_file

Parameters

-d

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.

-v

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_batch_suspense_override_reason any_other_parameter -v > filename.log.

pin_batch_suspense_override_reason_file

The name and location of the file that defines batch suspense override-able reason codes. The default pin_batch_suspense_override_reason file is in BRM_home/sys/data/config.

If you do not run the utility from the directory in which the file is located, you must include the complete path to the file.

Tip:

If you copy the pin_batch_suspense_override_reason file to the directory from which you run the load_pin_batch_suspense_override_reason utility, you don't have to specify the path or file name. The file must be named pin_batch_suspense_override_reason.

Results

If the utility does not notify you that it was successful, look in the default.pinlog file to find any 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 override reason codes were loaded, display the /config/batch_suspense_override_reason object by using Object Browser or the robj command with the testnap utility. See "Reading Objects" and "Using testnap to Modify /config Objects" in BRM Developer's Guide.

The following is an example of a pin_batch_suspense_override_reason file, which would be an input for this utility and could be compared to the output:

# Override Suspense Reason000010000200003

load_pin_batch_suspense_reason_code

Use the load_pin_batch_suspense_reason_code utility to load batch suspense reason codes into the /config/batch_suspense_reason_code object in the BRM database. You define batch suspense reasons in the pin_batch_suspense_reason_code file in BRM_home/sys/data/config. BRM uses suspense reason codes to load suspense reasons into a batch suspense record when a call details record (CDR) file is suspended.

Caution:

The load_pin_batch_suspense_reason_code utility overwrites the existing /config/batch_suspense_reason_code object in the BRM database. If you are updating load batch suspense reason codes, you cannot load new batch suspense reason codes only. Therefore, you must load a complete set of load batch suspense reason codes each time you run the utility.

Note:

The load_pin_batch_suspense_reason_code utility must be connected to a running CM to load batch suspense reason codes into the Infranet database.

Location

BRM_home/bin

Syntax

load_pin_batch_suspense_reason_code [-d] [-v] pin_batch_suspense_reason_code_file

Parameters

-d

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.

-v

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_batch_suspense_reason_code any_other_parameter -v > filename.log.

pin_batch_suspense_reason_code_file

The name and location of the file that defines the batch suspense reason codes. The default pin_batch_suspense_reason_code file is in BRM_home/sys/data/config.

If you do not run the utility from the directory in which the file is located, you must include the complete path to the file.

Tip:

If you copy the pin_batch_suspense_reason_code file to the directory from which you run the load_pin_batch_suspense_reason_code utility, you do not have to specify the path or file name. The file must be named pin_batch_suspense_reason_code.

Results

The load_pin_batch_suspense_reason_code utility notifies you when it successfully creates the /config/batch_suspense_reason_code object. Otherwise, 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 elements were loaded, display the /config/batch_suspense_reason_code object by using Object Browser or the robj command with the testnap utility. See "Reading Objects" and "Using testnap to Modify /config Objects" in BRM Developer's Guide.

The following example shows sample entries from the /config/batch_suspense_reason_code object:

PIN_FLD_POID                      POID [0] 0.0.0.1 /config/batch_suspense_reason_code 93712 00 PIN_FLD_CREATED_T               TSTAMP [0] (1153474255) 21/07/2006 15:00:55:000 PM0 PIN_FLD_MOD_T                   TSTAMP [0] (1153474255) 21/07/2006 15:00:55:000 PM0 PIN_FLD_READ_ACCESS                STR [0] "G"0 PIN_FLD_WRITE_ACCESS               STR [0] "S"0 PIN_FLD_ACCOUNT_OBJ               POID [0] 0.0.0.1 /account 1 00 PIN_FLD_DESCR                      STR [0] ""0 PIN_FLD_HOSTNAME                   STR [0] "-"0 PIN_FLD_NAME                       STR [0] "batch_suspense_reason_code"0 PIN_FLD_OP_CORRELATION_ID          STR [0] "2:CT1255:UnknownProgramName:0:AWT-EventQueue-0:3:1153836497:0:root.0.0.0.1::user1:123456789"0 PIN_FLD_PROGRAM_NAME               STR [0] "load_pin_batch_suspense_reason_code"0 PIN_FLD_VALUE                      STR [0] ""0 PIN_FLD_VERSION                    STR [0] "1"0 PIN_FLD_SUSPENSE_REASONS         ARRAY [0] allocated 1, used 11     PIN_FLD_SUSPENSE_REASON       ENUM [0] 00 PIN_FLD_SUSPENSE_REASONS         ARRAY [471] allocated 1, used 11     PIN_FLD_SUSPENSE_REASON       ENUM [0] 10 PIN_FLD_SUSPENSE_REASONS         ARRAY [119] allocated 1, used 11     PIN_FLD_SUSPENSE_REASON       ENUM [0] 20 PIN_FLD_SUSPENSE_REASONS         ARRAY [120] allocated 1, used 11 
   PIN_FLD_SUSPENSE_REASON       ENUM [0] 20 PIN_FLD_SUSPENSE_REASONS         ARRAY [126] allocated 1, used 11     PIN_FLD_SUSPENSE_REASON       ENUM [0] 20 PIN_FLD_SUSPENSE_REASONS         ARRAY [127] allocated 1, used 1|1     PIN_FLD_SUSPENSE_REASON       ENUM [0] 20 PIN_FLD_SUSPENSE_REASONS         ARRAY [147] allocated 1, used 11     PIN_FLD_SUSPENSE_REASON       ENUM [0] 20 PIN_FLD_SUSPENSE_REASONS         ARRAY [148] allocated 1, used 11     PIN_FLD_SUSPENSE_REASON       ENUM [0] 2

pin_recycle

Use this utility to search for failed records in the BRM database, and either queue the records for recycling or delete them. See "About Suspending and Recycling Event Records."

Location

BRM_home/bin

Syntax

pin_recycle [ -f CDR_file] [ -k recycle_key ] [ -d | -D| -r reason_code| -t ]

Parameters

-f CDR_file

Queues all the failed records that arrived in a single file.

-k recycle_key

Searches for and queues records for rating that contain:

The recycle_key, an application-specific string that is added to each record as it is suspended.
A status of suspended.

-d

Searches for and deletes all records with a status of succeeded or written off.

-D

Searches for and deletes all records with a status of succeeded, written off, or suspended.

-r reason_code

Searches for and recycles all records that have the specified reason code.

-t

Specifies a test recycle. In test mode, pin_recycle creates a report about the processing, but does not make any changes to the database.

Results

This utility logs messages to stdout.