Chapter 4. Configuration Templates

4.1. Process PDF Reports Using a Custom Configuration File
4.2. Process Excel Reports Using a Custom Configuration File
4.3. Add, Edit and Delete Configuration Templates
4.3.1. Create Similar Configuration Templates

If required, DocumentBurster has support to use a different set of configuration settings for each separate report type. For example, using this capability, it is possible to use a different email subject, text or burst file name for invoices report type and a different email subject, text or burst file name when processing payslips report type.

By default, if no custom configuration file is provided, DocumentBurster will process all the reports using the default configuration settings which are saved in ./config/burst/settings.xml configuration file. This should be fine in most of the situations, however there are cases when it is required to process a different report type using its own set of configuration settings.

Use case example

The requirement is to burst and email to customers several different types of financial documents, specifically

Each of the above report types should be delivered to customers using an email subject and text which is specific to the report type which is being distributed (i.e. invoices, statements or dunning letters).

The requirement can be achieved by defining

DocumentBurster will process and email each different report type by using its own distinct set of configuration settings.

While bursting a PDF report, DocumentBurster checks the first page of the report for a custom defined configuration file by looking for a pattern like

<config>path-to-the-custom-settings-file.xml</config>

For example, in order to process invoices report using a custom configuration file, the first page of the input invoices.pdf report should contain something similar with

<config>./config/burst/invoices.xml</config>

While bursting an Excel report, DocumentBurster checks for a custom configuration file defined in configFile column from burst metadata sheet. If no custom configuration file is found then DocumentBurster will burst the report using the default ./config/burst/settings.xml configuration file.

Following is how an Excel reports should be configured in order to achieve the above (i.e. invoices, statements and dunning letters) requirement.

In burst sheet, invoices.xls Excel report should have the custom configFile defined like that

In burst sheet, statements.xls Excel report should have the custom configFile defined like that

In burst sheet, dunning-letters.xls Excel report should have the custom configFile defined like that

In DocumentBurster main window select Actions , Configuration Templates

Each configuration template is saved in a different configuration file. For example, Invoices configuration template might be saved in a ./config/burst/invoices.xml file while Statements configuration template might be saved in a ./config/burst/statements.xml file.

Once the configuration templates are created they will become available to be used throughout the DocumentBurster GUI.