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
./config/burst/invoices.xml
./config/burst/statements.xml
./config/burst/dunning-letters.xml.
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>
The same result can be achieved by using the shorter (while being less expressive) pattern
<c>path-to-the-custom-settings.xml</c>,
for example <c>./config/burst/invoices.xml</c>
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 ,
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.
Copy Initial Values From - When creating a new configuration template it is required to provide the path to an existing and valid configuration file from which the initial configuration values will be copied. Once the new configuration template is created you might modify only the few settings which should be different between configuration templates (e.g. email subject, email message, etc.). Most of the other settings will usually remain the same (e.g. email server connection settings) between different configuration templates.
Default Value
-
./config/burst/default/defaults.xml
Once the configuration templates are created they will become available to be used throughout the DocumentBurster™ GUI.