Category | Utility | Description | Source |
System Administration |
BRM Administration | pin_ctl | This is the primary utility for controlling BRM components. It can be used to start, stop, and restart various BRM processes like the Connection Manager (CM), Data Manager (DM), and other services. | system-administrators-guide.pdf |
Database Management | partition_utils | Manages database partitions. This is especially useful for systems with large datasets, enabling you to create, drop, and manage partitions to optimize database performance. | system-administrators-guide.pdf |
| partitioning.pl | A Perl script used to define and manage partitioning schemes for BRM database tables. It works in conjunction with the partition_utils utility. | system-administrators-guide.pdf |
| purge_audit_tables.pl | Purges archived audit data from the BRM database. This helps manage database size and maintain performance by removing older audit records. | system-administrators-guide.pdf |
| pin_db_alert.pl | Monitors the BRM database for specific conditions and triggers alerts based on pre-defined rules. This is useful for proactively identifying potential issues and maintaining database health. | system-administrators-guide.pdf |
Account Maintenance | pin_del_closed_accts | Removes closed accounts from the BRM database. This is a maintenance task to purge inactive accounts and manage database size. | system-administrators-guide.pdf |
| pin_sub_balance_cleanup | Cleans up subscription balance information in the database. This is important for maintaining accurate account balance information and reporting. | system-administrators-guide.pdf |
| pin_unlock_service | Unlocks services that are in a locked state due to errors or specific system conditions. This is helpful for restoring service functionality and troubleshooting account-related issues. | system-administrators-guide.pdf |
Security | pin_create_server_cert | Creates a self-signed certificate that can be used for secure communication between BRM components. This is important for securing data transmission and protecting sensitive information. | system-administrators-guide.pdf |
Data Migration |
Legacy System Migration | pin_cmt | The core utility for migrating data from legacy systems to the BRM database. It handles data transformation and loading, supporting a wide range of data types and objects, including accounts, services, and billing information. | migrating-accounts-brm-database.pdf |
Account Schema Migration | pin_amt | The primary MTA (Multithreaded Application) for managing account migrations between database schemas within a BRM system. This is crucial for managing multi-schema deployments and moving accounts between different schemas. | moving-accounts-database-schemas.pdf |
| pin_amt_test | A testing tool used to validate the account search criteria defined in the AMM configuration file. This helps ensure that migrations are performed accurately and without unintended consequences. | moving-accounts-database-schemas.pdf |
Configuration and Loading |
Configuration Data | load_config | Loads configuration data into the BRM database from XML files. This utility is used to populate various configuration objects, such as business parameters, service definitions, and pricing rules. | developers-guide_v15.pdf |
| load_config_dist | Specifically designed for multi-schema BRM deployments. It loads configuration data that needs to be consistent across all schemas in the system. | system-administrators-guide.pdf |
| load_pin_uniqueness | Loads data into the /uniqueness object, which is used to manage unique identifiers within the BRM system, especially important in multi-schema environments. | system-administrators-guide.pdf |
| pin_config_distribution | Manages configuration data distribution across multiple database schemas. This is essential for ensuring consistency in configuration settings in multi-schema BRM deployments. | system-administrators-guide.pdf |
| pin_config_editor | Provides a graphical interface for editing BRM configuration files. It allows users to easily view and modify configuration settings, which can be helpful during development and testing. | developers-guide_v15.pdf |
Business Operations Center | pin_job_executor | The core utility for executing jobs defined within the Business Operations Center. This utility interacts with the Business Operations Center's scheduling and monitoring functionalities to perform various operational tasks, including billing, payment processing, and data synchronization. | system-administrators-guide.pdf |
Development and Testing |
Testing Opcodes and Flists | testnap | A powerful utility for developers to test BRM opcodes and manipulate flists (field lists). It provides a command-line interface for executing opcodes, inspecting flist structures, and interacting with the BRM database. | developers-guide_v15.pdf |
| pin_adu_validate | A specialized utility for validating account dump files. These files are used to extract and analyze account data, and this utility helps ensure data integrity and consistency. | developers-guide_v15.pdf |
| pin_bus_params | Used to manage BRM business parameters. These parameters control various aspects of system behavior, and this utility allows you to set, retrieve, and modify their values. | developers-guide_v15.pdf |
| pin_crypt_app | Handles encryption and decryption operations. This is important for protecting sensitive data within the BRM system, such as passwords and credit card information. | developers-guide_v15.pdf |
Storable Class and Field Definitions | pin_deploy | Used to manage storable class and field definitions in the BRM database. It allows you to export, import, and modify these definitions, which are essential for defining the data structures used by BRM. | developers-guide_v15.pdf |
| pin_uei_deploy | Specifically designed for managing User Exit Interface (UEI) definitions. UEIs are used to extend BRM functionality, and this utility helps deploy custom UEI implementations. | developers-guide_v15.pdf |
Virtual Time Management | pin_virtual_time | Manipulates the virtual time used by the BRM system for testing and simulation purposes. This allows you to simulate different time scenarios without affecting the actual system time. | developers-guide_v15.pdf |
| pin_virtual_gen | Generates virtual time events. This is used in conjunction with pin_virtual_time to simulate events occurring at specific virtual time points for testing purposes. | system-administrators-guide.pdf |
Specific Functionalities |
Billing | pin_bill_accts | The core utility for executing the billing process. It triggers the generation of bills for accounts based on defined billing cycles and rules. | configuring-and-running-billing.pdf |
| pin_cycle_fees | Handles the application of recurring charges, also known as cycle fees, to accounts. This utility ensures that periodic fees are charged correctly. | configuring-and-running-billing.pdf |
| pin_make_corrective_bills | Generates corrective bills, which are used to adjust billing errors or make changes to previously generated bills. | configuring-and-running-billing.pdf |
| pin_rollover | Manages rollover functionality, which allows unused balances or allowances from previous billing cycles to be carried over to subsequent cycles. | configuring-and-running-billing.pdf |
| pin_trial_bill_accts | Used to generate trial bills for testing and validation purposes. Trial bills allow you to simulate the billing process without impacting actual customer accounts. | configuring-and-running-billing.pdf |
| pin_trial_bill_purge | Purges trial bills generated during testing. This is a cleanup task to remove simulated billing data from the system. | configuring-and-running-billing.pdf |
Invoicing | pin_inv_accts | This utility triggers the invoice generation process. It processes billing data and creates invoices for accounts. | designing-and-generating-invoices.pdf |
| pin_inv_doc_gen | Generates invoice documents in various formats, such as PDF or XML. This utility is responsible for formatting the invoice content and producing the final output. | designing-and-generating-invoices.pdf |
| pin_inv_export | Exports invoice data to external systems or formats. This allows integration with external invoicing platforms or custom invoice processing workflows. | designing-and-generating-invoices.pdf |
| pin_inv_send | Handles the delivery of invoices to customers. This utility can be configured to send invoices via email, print them, or deliver them through other channels. | designing-and-generating-invoices.pdf |
| pin_upd_assoc_bus_profile | Updates the associated business profiles used for invoicing. This is used to manage the mapping between accounts and their corresponding business profiles, which determines how invoices are generated and formatted. | designing-and-generating-invoices.pdf |
Collections | pin_collections_send_dunning | Sends dunning notices to customers with overdue payments. Dunning notices are used to remind customers about outstanding balances and encourage timely payments. | collections-manager.pdf |
| pin_load_template | Loads dunning letter templates into the BRM database. This utility allows you to customize dunning letter content and formatting to meet specific business requirements. | collections-manager.pdf |
AR (Payments, Refunds and Adjustments) | pin_apply_bulk_adjustment | Applies bulk adjustments to accounts, such as credits or debits. This is useful for making mass adjustments to accounts for promotions or corrections. | managing-accounts-receivable.pdf |
| pin_mass_refund | Processes mass refunds, which involve refunding multiple accounts simultaneously. This is helpful for handling scenarios like service outages or billing errors affecting a large number of customers. | managing-accounts-receivable.pdf |
| pin_refund | Processes individual refunds. This utility handles the reversal of charges and the issuance of refunds to customers. | managing-accounts-receivable.pdf |
| pin_roll_up_ar_items | Rolls up accounts receivable items. This involves consolidating multiple A/R items into a single entry, which can simplify accounting and reporting processes. | managing-accounts-receiva ble.pdf |
Comments
Post a Comment