Administering Document Builder

You can monitor the state of Document Builder. Pay attention to system health, job details, runtime variables, and email notifications of document generation.
Note: Admin privileges are required to administer Document Builder. You must have the pub_admin role assigned to yourself.
  1. To administer the application, click your user name in the product banner.
  2. Select Administer from the drop-down menu.
  3. You can now monitor system health, see the document generation jobs in progress, and assign environment variables.

System Health

On this page you can see information about memory usage, database used, the number of total documents generated, the document generation node URLs, and whether the system is up and running. You can click the links in the Total Jobs or Failed Jobs column to see the job details.

System Health page

Job Details

On this page you can view the document generation jobs that are currently in progress and the duration of the generation. See Managing document generation jobs

Runtime Variables

On this page you can set runtime and environment variables. Variables are categorized into groups. You can expand and collapse the groups to see the default values of the variables.
runtime variable groups
For example:
  • Administrators can set the Asset Default Privacy for the assets being generated. Assets are private by default and can be set to public if required.
  • Select the Asset migration enabled check box to enable migration of assets from the 1.x Remote services to Document Builder. After you enable this setting, the Migrate Assets button appears in the product banner for administrators.
  • In the Document Builder base URL field, you can set the address of the rpeng server, for example http://<server>:<port>/rpeng. This field is required for scheduling document generation jobs and for email notifications.
  • In the Document generation URL field (optional), you can set the URL for the document generation node. If this field is empty, Document Builder will try to use the document generation service from http(s)://<server>:<port>/rpeng, using the same server and port as the rpeng application.
  • In the Job details refresh threshold field, specify how often to refresh the job status on both tabs of the Running Jobs page. To disable the auto-refresh, enter a value of 0 or leave it blank.
  • In the Release license idle time field, specify the time after which the license will be released. The default time is 1800 seconds (30 minutes) and the minimum value is 120 seconds.
  • In the Long Running Jobs Threshold field, specify how long a job can run before it appears in the Long Running Jobs tab of the Running Jobs page.
  • In the Maximum asset size allowed field, specify the maximum size of assets for example templates, scripts, or style sheets, that report designers or admins can upload.
  • You can configure settings for email notifications. Users must still enable email notification from the User > Settings menu.
  • In the PUB Document Life Limit field, you can set how long you want the generated documents to be available. The default setting is 100 days. Any document older than this limit will be deleted.
To return to the main menu, click the IBM Document Builder link in the product banner.
Note: The settings defined on this page override any Java or system properties that are already defined. The order of precedence is :
  1. Runtime Variables admin page in the Document Builder
  2. Java properties
  3. System properties

Load balancing

In the Document generation URL field, you can specify a semicolon-separated (;) list of document generation node URLs. In the Load balancing algorithm field, select a load balancing algorithm:
  • Weighted Round Robin (default): If you select this algorithm, you can also specify weights for the node URLs, for example,http://myMachine1:8080/dgaas=1;http://myMachine2:8080/dgaas=2;http://myMachine3:8080/dgaas=3. A node with no specified weight is assigned a default weight of 1. Nodes with higher weights receive more requests than those with lower weights. However, the nodes continue to receive requests in a round robin sequence. For example, consider three servers named A, B, and C with assigned weights of 1, 2, and 3. The sequence in which the servers handle every 6 (1+2+3) incoming document generation requests is ABCBCC. The nodes with weight 2 and 3 end up getting more requests. Configure Base URL properties
  • Least Jobs : If you select this algorithm, the node in the list that handles the least number of document generation requests at the time of the request handles the new document generation request.
  • Dynamic Weights : If you select this algorithm, each document generation node is assigned a score based on the node attributes such as available memory, CPU usage, concurrent document generation limit, or availability. When there is an incoming document generation request, the node with the highest score is selected to generate the document. The values of these node attributes are updated at regular intervals as well as the assigned scores.
In the View Job Details window the document generation URL is listed for each job so that you can see which node the job used.

Defining email notification settings for document generation results

On the Runtime Variables page, define the following settings in the Mailsection:

  1. Send Test Mail: To test whether email notification settings are working correctly, administrators can send a test email. Click the Send Test Mail button in the upper right. In the Send Test Mail window, enter a recipient email address and click Send Test Mail . A test email is sent immediately. You can only send one email at a time.
  2. Mail from: The email address of the account that you are using to send the email.
  3. Mail Password
  4. Mail SMTP port: The SMTP port used to send and receive email messages, for example 587.
  5. Mail SMTP server: The SMTP mail server, for example smtp.gmail.com.
  6. Mail template body: The body of the mail. This template uses the following escape strings:
    • {DOCUMENT_LIST}: replaced with the Mail template result
    • {RPE_URL}: the URL of the service
    • {REPORT_NAME} : the name of the report
    • {JOB_STATUS} : the status of the job
  7. Mail template result: The results of the document generation. This template uses the following escape strings:
    • {DOCUMENT_TYPE}: the type of the output
    • {DOCUMENT_HREF}: the link to the document
  8. Mail username
  9. Debug Mail API: Enables Java Mail API debug log printing to help investigate issues with email notification. Logs are available at the following locations:
    • WebSphere Application Server: WebSphere\AppServer\profiles\AppServerName\logs\server1\SystemOut.txt
    • WebSphere Liberty: IBM\PUB\server\logs\console.log
  10. Use STARTTLS: Enables Transport Layer Security (TLS) so Document Builder can use TLS to communicate with a Simple Mail Transfer Protocol (SMTP) server.

The escape strings are replaced with the appropriate content. You can edit the HTML templates provided in the Mail template body and Mail template result.


Feedback