Administering Document Builder

You can monitor the state of Rational® Publishing Engine Document Builder.
Note: Admin privileges are required to administer Document Builder. You must have the rpe_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, and the number of total documents generated.

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. For example:
  • 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.
  • Select the ASSET_SHARING_ENABLED check box to enable sharing of resources between users. Templates and style sheets are shared between report designers, and reports and documents are shared with both report designers and end users.
  • In the 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 DGAAS_URL field (optional), you can set the URL for the document generation service. 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 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.
  • You can configure settings for email notifications. Users must still enable email notification from the User > Settings menu.
  • In the RPE_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.
  • You can define which users have the report designer role.
To return to the main menu, click the IBM Rational Publishing Engine 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

Defining email notification settings

On the Runtime Variables page, define the following settings:

  1. BASE_URL: The address of the rpeng server, for example http://<server>:<port>/rpeng. This URL is used in the email notification to form the links to the generated documents, for example http://<server>:<port>/rpeng/results/123. Users can click the links in the email to download the generated documents.
  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. MAIL_TEMPLATE_BODY 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. MAIL_TEMPLATE_RESULT uses the following escape strings:
    • {DOCUMENT_TYPE}: the type of the output
    • {DOCUMENT_HREF}: the link to the document
  8. MAIL_USERNAME

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