Chapter 5. Variables

5.1. Example - Configure an Unique Output Folder
5.2. Built-In Variables
5.2.1. Sample - Payslips.pdf
5.3. User-Defined Variables
5.3.1. Sample Invoices-Oct.pdf - Customizable Burst File Name
5.3.2. Excel User-Defined Variables

DocumentBurster variables are pieces of information from the input report, evaluated and processed individually for each output report.

Variables can be used to define dynamic configurations as well as data to be included in the delivery of documents. For example, using an email message template together with variables it is possible to define a personalized email subject/message for each individual recipient.

Variables can be used to define custom dynamic values for the following configurations

Using variables, the values of the above configurations can be dynamically populated at run-time with information coming from the report which is being burst.

While it is possible to define static values for the output folders, it is not advisable. In order to avoid the output reports to get overridden from one burst session to another, with the help of variables, it is better to define dynamic time-stamp based output folder configurations.

Following are few situations in which variables will help

Using variables, with unique time-stamp based values generated at run-time, it is possible to overcome the above described problems by defining unique output folder names per each different burst session.

Output Folder, Backup Folder and Quarantine Folder configurations are all defined using the same pattern $input_document_name$/$now; format=""$

When bursting the input sample document Payslips.pdf, by default, the output files are being generated in a folder similar with Payslips.pdf/2010.10.28_19.13.13 - $input_document_name$/$now; format=""$.

Built-In vs. User-Defined Variables

DocumentBurster has two types of variables

Built-in variables can be the name of the report to burst, the date (in various formats) when the bursting is happening or the current burst token.

Following built-in variables are available to be used within DocumentBurster

Using built-in variables it is possible to build an advanced foldering and archiving solution for the output reports.

Following different foldering options are possible. Combinations of the following are also possible

  • Generate one different output folder per each input report

  • Generate one different output folder per each different burst token

  • Date related options - generate one output folder per year, financial quarter, month, week in month, day in week and up to the level of hours, minutes and seconds.

User defined variables can be any text from the report which is being burst or distributed.

User variables might be used for sending emails with a personalized subject and a personalized message text or for generating dynamic file names and folder names for the output burst reports.

DocumentBurster has support for up to 10 (ten) user defined variables $var0$, $var1$, $var2$, $var3$, $var4$, $var5$, $var6$, $var7$, $var8$ and $var9$. While the variable names are not impressive they are for sure handy to use.

The values for the user defined variables are being populated with text content from the report which is being burst. Usually the variables will have different values for each different burst token (or for each different recipient).

In order to populate the user defined variables with values, DocumentBurster engine is looking inside the report for patterns like the following

DocumentBurster engine supports up to 10 (ten) different variables, so the last variable will look like <9> any text which should be assigned as a value to the 10th variable </9>.

User defined variables can be used to dynamically generate any of the following Burst File Name, Output Folder, Backup Folder, Quarantine Folder, Upload(FTP, File Share, etc.) commands and URLs, Email To, CC and BCC fields, Email Subject, Email Message Text, From Name, From Email Address, Host, User Name, User Password and Email Server Port.