Allison the administrator: Embedding document generation in dashboards

Allison the administrator can embed document generation capabilities into OpenSocial containers such as CLM dashboards.

Before you begin

  • Ensure that Document Builder is running in HTTPS mode. See Enabling HTTPS mode.
  • Allison might have to set the CORS_DOMAINS property on the server where Document Builder is installed, to allow XHR requests from the Rational® solution for CLM server. This is not required if the CLM application and Document Builder are co-hosted, for example
     CORS_DOMAINS=https:\\clm_server:port

About this task

Allison's project manager tracks project status on a CLM dashboard and wants to generate documents right from the dashboard without having to launch the Rational Publishing Engine Document Builder. Alison can add a sample widget from the Rational Publishing Engine Document Builder to the dashboard so that her project manager can generate this document regularly.

Procedure

  1. Allison finds the sample widget at https://rpe_server:port/rpeng/widgets/singlereport.xml and examines the XML file.
    XML for example widget
  2. Allison opens the CLM dashboard for her project.
  3. From the dashboard, click the Add Widget tab.Add widget
  4. Click Add OpenSocial Gadget.
    Add OpenSocial widget
  5. Allison enters the URL to the sample widget from step 1 and clicks Add widget.
    RPE Document Generation settings
  6. Allison closes the widget catalog and saves the dashboard. The widget appears on her project dashboard.
    Log into Rational Publishing Engine
  7. In the widget menu, click Settings.
    Settings menu
  8. Allison enters the report link, for example https://rpe.myserver.net/rpeng/api/jobresults/58101. She sets the Shared field to false, otherwise the generated documents are visible to anyone with access to the server.
  9. Allison logs into Rational Publishing Engine in the widget.
  10. She clicks Refresh in the widget.
  11. She clicks Generate Document.
    Generate document button
  12. The document is generated successfully and Allison clicks the link to download the documents.
    Download link

Feedback