Chapter 9.  DocumentBurster™ Server

9.1. Installation
9.1.1. Prerequisites
9.1.2. Download DocumentBurster Server
9.2. Start and Stop
9.2.1. Server
9.2.2. Web Console
9.3. Web Console
9.3.1. User Authentication
9.3.2. Submit Bursting Jobs
9.3.3. Screenshots
9.4. Run DocumentBurster at System Startup
9.4.1. Windows Services
9.4.2. Windows Scheduling
9.5. Scheduling
9.5.1. Configuration

DocumentBurster™ Server can be deployed as a central system to provide report bursting and report distribution services to multiple people or software applications from your organization.

DocumentBurster™ Server has all the capabilities of DocumentBurster and some additional advanced features like

In addition, if required, DocumentBurster™ Server is a powerful platform which has the foundation to add and tailor other additional report distribution features which an organization might need, for example

For evaluation purposes, DocumentBurster™ Server can be downloaded from this link - https://s3.amazonaws.com/documentburster/newest/documentburster-server.zip .

Extract the zip archive to a drive like C:/

Once the zip file is extracted, a new directory will be available (e.g. - C:/DocumentBurster-5.2.8) which will contain the following two sub-directories

  • server - contains the binaries and the scripts for starting and stopping the report bursting server
  • web-console - binaries and scripts for the DocumentBurster™ Web Console

1. Configuration

DocumentBurster™ Server is configured using the same GUI interface ( DocumentBurster.exe ) like DocumentBurster™ . DocumentBurster configuration was described in detail in Section 1.3, ?Configuration? .

2. Starting and Stopping

  • Starting - once configured, the server can be started using server/startServer.bat (Windows) or server/startServer.sh (Linux) scripts.
  • Stopping - server/shutServer.bat (Windows) or server/shutServer.sh (Linux) scripts should be used to stop the server.

3. Automatic Polling

Once started the server is automatically checking for new reports to process in the server/poll directory. Any report which is dropped to server/poll folder is automatically picked up and processed by DocumentBurster™ Server.

DocumentBurster™ Server is coming with a web based interface which can be accessed from any major web browser (e.g. Mozilla Firefox, Internet Explorer, Google Chrome, etc.). The web interface can be used for triggering new ad hoc jobs, scheduling jobs for later execution or for viewing the status, history and detailed logs of the previously submitted jobs.

The web console needs the server to be started, so make sure it is so. After the server is started, in the folder where the software was extracted, please execute web-console/startConsole script to get the console started. After few seconds the application can be accessed by typing following URL in the browser

http://machine-name:8080/burst

for example

http://localhost:8080/burst

Being a server application, DocumentBurster can be configured to run in the background as long as the operating system is running.

Following paragraphs will detail how to configure DocumentBurster to run automatically when the system is starting. The screenshots are taken from Windows 7 and the same can be similarly achieved on any other Windows distribution.

DocumentBurster software can start when the Microsoft Windows operating systems is booted, either

The above options are two different ways for solving similar requirements. You are free to choose the option which is best fitting your needs.

Following is how to configure each option in detail.

Both the server and the web console components can be separately configured to be executed as Windows services.

The server is the mandatory component which is doing the report processing while the web console will be started as a web GUI interface for posting the reports to the server.

DocumentBurster™ Web Console depends on the server to be started and, as a result, the DocumentBurster™ Web Console Windows service will be automatically configured to depend on the DocumentBurster™ Server Windows service.

DocumentBurster™ Server can handle scheduled report bursting and report distribution jobs. By default the software can handle jobs scheduled for nightly (midnight) execution. If this is what it is required, then it is nothing more to be configured in regards with scheduling. On the other hand, it is possible to customize the scheduling - familiarity with other cron like schedulers will help in understanding better the scheduling mechanism implemented in DocumentBurster™ . Yearly, monthly, weekly, daily, hourly or any other custom report bursting schedule jobs are all possible to define.

While for executing ad hoc, immediate report bursting jobs, DocumentBurster™ Server is checking the server/poll folder, scheduled reports should be placed in the server/input-files/scheduled directory. DocumentBurster will properly trigger the report bursting and report distribution jobs to happen at the correct date and time, depending on how the scheduling is configured.