Setting Up Dunning Letters

About Setting Up Dunning Letters

To set up Collections Manager to generate dunning letters, you must run Email Data Manager (DM) and load your dunning letter templates.

You can customize dunning letter data before it is stored in the BRM database. For example, you can enrich the standard data with additional information, such as the date on which the account will be inactivated. To do so, customize the PCM_OP_COLLECTIONS_POL_PREP_DUNNING_DATA opcode. See BRM Opcode Guide.

PCM_OP_COLLECTIONS_POL_PREP_DUNNING_DATA enables customization of dunning letter data before it is stored in the database. You can modify the type of data gathered by customizing the opcode. For example, you can enrich the standard data with additional information, such as the date on which the account will be inactivated.

Loading Dunning Letter Templates

You load dunning letter templates by using the pin_load_template utility. These dunning letter templates are used in Collections Configuration to set the dunning letters action and the invoice reminders action.

Dunning letter templates are XSL documents that provide the basic content of the letter, leaving placeholders for specific information such as the customer's name, overdue balance, and so on. You can design and load multiple dunning letter templates for different scenarios and situations.

Collections Manager includes two sample dunning letter templates: dunning_first.xsl and dunning_last.xsl. Both templates are stored in BRM_home/sys/data/config/stylesheets. You can use a third-party XSL editor to modify these templates or to create your own templates.

After creating your template, load it into the BRM database by using the pin_load_template utility. Templates are available in Collections Configuration immediately after you load them. See "Defining Collections Actions".

To load a dunning letter template:

Go to a directory that contains a valid configuration (pin.conf) file.

Note:
A configuration file is installed automatically in BRM_home/apps/pin_collections.

The pin_load_template utility uses information in the configuration file to connect to the BRM database. See "Connecting BRM Utilities" in BRM System Administrator's Guide.
Load the XSL template by entering the following command:
```
pin_load_template -brand brand_POID - name template_name -type dunning -locale locale_name -template file_name -usexsl 
```
where:
- brand_POID is the Portal object ID (POID) of the root account.
- template_name is the name of the template as it should appear in Collections Configuration.
- locale_name is the BRM locale of the template. See "Locale Names" in BRM Developer's Guide.
- file_name is the name and full path of the template file.

For example, the following command loads the dunning_first.xsl template for the root account:

pin_load_template -brand "0.0.0.1/account 1" -type dunning -locale en_US -template BRM_home/config/dunning_first.xsl -name DunningTemplate -usexsl

Setting Dunning Letter Delivery Preferences for Noninvoice Bill Units

You specify how to deliver dunning letters to noninvoice bill units by using the pin_collections configuration file (BRM_home/apps/pin_collections/pin.conf).

For noninvoice bill units, you can set the following delivery options:

Whether to deliver the dunning letter as hardcopy or by email.
For email delivery, whether to send the dunning letter as part of the message body or as an attachment.
For dunning letters sent as email attachments, the file path to use for providing customized content in the email body.

Setting the Delivery Option

By default, dunning letters are printed and sent as hardcopy.

To set the delivery option for dunning letters:

Open the BRM_home/apps/pin_collections/pin.conf file in a text editor.
Change the value of the delivery_preference entry:
- To deliver dunning letters as hardcopy, enter a nonzero value. This is the default.
- To deliver dunning letters by email, enter 0.
  
  For example:
```
- pin_collections_send_dunning delivery_preference 0
```
Save and close the file.

Setting the Email Delivery Preference

By default, dunning letters are delivered in the body of the email.

To set the email delivery preference for dunning letters:

Open the BRM_home/apps/pin_collections/pin.conf file in a text editor.
Change the value of the email_option entry:
- To deliver dunning letters as email attachments, enter 1.
- To deliver dunning letters in the email body, enter 0. This is the default.
  
  For example:
```
- pin_collections_send_dunning email_option 0
```
Save and close the file.

Specifying a File for the Email Body

When you send dunning letters as email attachments, you can include customized information in the email body. You specify the path to a text file for the content of the message.

To specify the path to the message content:

Open the BRM_home/apps/pin_collections/pin.conf file in a text editor.
Set the path in the email_body entry:
```
- pin_collections_send_dunning email_body Path
```
For example, the following entry specifies the path to the letter file:
```
- pin_collections_send_dunning email_body ./letter
```
Note:

This option takes effect only if email_option is set to 1.
Save and close the file.