Chapter 8. Command Line

8.1. Usage
8.2. Burst Reports
8.3. Merge Reports
8.4. Poll Folder for Incoming Reports
8.5. Quality Assurance

DocumentBurster has a command line interface and can be integrated and executed from existing legacy software systems. All the features of the program are available through command line.

Important

Before running DocumentBurster in command line, the software should be properly configured.

For more details about configuring DocumentBurster please read Section 1.3, ?Configuration?

Following is the DocumentBurster command line usage

A. Windows

Following is the syntax for running the program

documentburster.bat –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>]

For example the command

documentburster.bat –f samples/Payslips.pdf

will burst the Payslips.pdf file located in the samples folder using the default config/burst/settings.xml configuration file.

B. Unix/Linux

Following is the syntax for running the shell script

./documentburster.sh –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>]

For example the command

./documentburster.sh –f samples/Payslips.pdf

will burst the Payslips.pdf file located in the samples folder using the default config/burst/settings.xml configuration file.

A. Windows

Following is the syntax for running the program

documentburster.bat –m <"pathOfTheFileToMerge1|...|pathOfTheFileToMergeN"> [-o <mergedFileName>] [-b]

For example the command

documentburster.bat –m "samples/Invoices-Oct.pdf|samples/Invoices-Nov.pdf|samples/Invoices-Dec.pdf" -o Invoices-1st-Quarter.pdf -b

will first concatenate the files Invoices-Oct.pdf, Invoices-Nov.pdf and Invoices-Dec.pdf (-m) into a file called Invoices-1st-Quarter.pdf (-o) and will burst the merged file (-b).

B. Unix/Linux

Following is the syntax for running the program

./documentburster.sh –m <"pathOfTheFileToMerge1|...|pathOfTheFileToMergeN"> [-o <mergedFileName>] [-b]

A. Windows

Following is the syntax for running the program

documentburster.bat –p <pathOfTheFolderToPoll>

For example the command

documentburster.bat –p poll

will start polling the folder poll for incoming reports to process.

B. Unix/Linux

Following is the syntax for running the shell script

./documentburster.sh –p <pathOfTheFolderToPoll>

For example the command

./documentburster.sh –p poll

will start polling the folder poll for incoming reports to process.

A. Windows

1. Following is the syntax for testing all the burst tokens

documentburster.bat –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>] -ta

For example the command

documentburster.bat –f samples/Payslips.pdf -ta

will test all the burst tokens which are found in the Payslips.pdf file located in the samples folder using the default config/burst/settings.xml configuration file.

2. Following is the syntax for testing a comma separated list of tokens

documentburster.bat –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>] -tl <"token1,token2,...tokenN">

For example the command

documentburster.bat –f samples/Payslips.pdf -tl "clyde.grew@northridgehealth.org,alfreda.waldback@northridgehealth.org"

will test the tokens clyde.grew@northridgehealth.org and alfreda.waldback@northridgehealth.org which are found in the Payslips.pdf file located in the samples folder using the default config/burst/settings.xml configuration file.

3. Following is the syntax for testing random tokens

documentburster.bat –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>] -tr <N>

For example the command

documentburster.bat –f samples/Payslips.pdf -tr 2

will test two random tokens which are found in the Payslips.pdf file located in the samples folder using the default config/burst/settings.xml configuration file.

B. Unix/Linux

1. Following is the syntax for testing all the burst tokens

./documentburster.sh –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>] -ta

2. Following is the syntax for testing a comma separated list of tokens

./documentburster.sh –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>] -tl <"token1,token2,...tokenN">

3. Following is the syntax for testing random tokens

./documentburster.sh –f <pathOfTheFileToBurst> [-c <pathOfTheConfigurationFileToUse>] -tr <N>