Embedding document-style report generation in OpenSocial containers such as dashboards
You can use Publishing Document Builder to embed document-style report generation capabilities in Open Social containers, such as dashboards for IBM Engineering Lifecycle Management (ELM).
Before you begin
- Ensure that Publishing Document Builder is running in HTTPS mode. See Enabling HTTPS mode.
- The administrator might need to set the CORS_DOMAINS (Cross_Origin Resource Sharing) property on
the Publishing Document
Builder
server to allow XHR requests from the ELM server.
This property is not required if the ELM
application and Publishing Document
Builder are
co-hosted on the same server, for example
CORS_DOMAINS=https://elm_server:port. To set the CORS_DOMAINS property:- For IBM
WebSphere® Application
Server full
profile: Go to and add the ELM server
and port.
- For IBM WebSphere Application Server Liberty: See Configuring Cross Origin Resource Sharing on a Liberty server.
- For IBM
WebSphere® Application
Server full
profile: Go to and add the ELM server
and port.
About this task
Publishing Document Builder provides an example widget that can access the latest version of a report. After you add the widget to an OpenSocial container, you can generate the document-style report from the embedded widget. You can create any number of widgets by using the REST APIs. The following steps use an ELM dashboard as the container.
Procedure
- You can find the sample widget at http://rpe_server:port/rpeng/widgets/singlereport.xml.
- Go to your Open Social container.
-
From the dashboard, click the Add Widget tab.
-
Click Add OpenSocial Gadget.
- Enter the URL to the sample widget from step 1.
- Click Add widget.
- Save your changes. The widget is added to your dashboard.
- In the widget menu, click Settings.
- 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 document-style reports to be shared, the document-style reports are visible to anyone with access to the server.
-
Log in to Publishing Document
Builder in the
widget.
- Click Refresh in the widget.
- Click Generate Document.
After the document-style report is generated, you can download the document-style reports and logs.
