Embedding document generation in OpenSocial containers

You can embed document generation capabilities in Open Social containers, such as Rational® solution for Collaborative Lifecycle Management dashboards.

Before you begin

  • Ensure that Document Builder is running in HTTPS mode. See Enabling HTTPS mode.
  • The administrator might have to set the CORS_DOMAINS property on the rpeng server 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

Document Builder provides an example widget that can access the latest version of a report. Once you add the widget to an OpenSocial container, you can generate the document from the embedded widget. You can create additional widgets using the REST APIs. Any number of widgets can be added. The following steps use a CLM dashboard as the container.

Procedure

  1. You can find the sample widget at http://rpe_server:port/widgets/singlereport.xml.
  2. Go to your Open Social container.
  3. From the dashboard, click the Add Widget tab.Add widget
  4. Click Add OpenSocial Gadget.
    Add OpenSocial widget
  5. Enter the URL to the sample widget from step 1.
  6. Click Add widget.
    RPE Document Generation settings
  7. Save your changes.
    The widget is added to your dashboard.
  8. In the widget menu, click Settings.
  9. In the Report field, enter the link to the report. See Sharing resources through unique URLs to get the link. Specify whether the report is shared. If you want the documents to be shared, the documents are visible to anyone with access to the server.
  10. Log into Rational Publishing Engine in the widget.
    Log into Rational Publishing Engine
  11. Click Refresh in the widget.
  12. Click Generate Document.
    After the document is generated, you can download the documents and logs.
    Generated documents