API Programming Guide › How to Embed CA User Activity Reporting Module in a Web Portal

How to Embed CA User Activity Reporting Module in a Web Portal

You can embed CA User Activity Reporting Module queries or reports in a web portal, allowing you to display the content you want. The process is as follows:

1. Identify the CA User Activity Reporting Module content you want to display, and construct the API call to identify and return it.
2. Embedding the selected content in the web portal.

More information:

Query and Report Viewer Calls

Identifying Content

Embed Content in a Liferay Portal

Identifying Content

Begin the process of embedding CA User Activity Reporting Module content by deciding what content you want to display. Review the CA User Activity Reporting Module interface to find the report or query that contains the information that meets your needs.

To display CA User Activity Reporting Module queries or reports in a web portal, use the getQueryViewer or getReportViewer calls to display interactive reports and queries with most of the functionality available from within the CA User Activity Reporting Module interface.

You can also use the runQuery report to return XML content, and display it by applying a style sheet. The display is non-interactive, and allows you to display the data without using Flash.

This example calls the System All Events Detail report, using getQueryViewer to show an Event Viewer table of all events. The API call syntax for this report is as follows:

https://ELMSERVER:5250/spin/calmapi/getObject.csp?type=getQueryViewer&objectId=Subscription/panels/System_All_Events_Detail&username=xxx&password=xxx

• To use the call in your environment, replace the "ELMSERVER" portion of the URL with the hostname or IP address of the server where the data you want is stored.
• This example authenticates using a CA User Activity Reporting Module user name and password: "&username=xxx&password=xxx". Using this authentication method is recommended for embedding CA User Activity Reporting Module content. Replace the 'xxx' with an appropriate CA User Activity Reporting Module username and password. If you do not want the username and password to be visible in the URL, you can set them as hidden values, if your web portal allows.

You can test the final syntax by entering the URL you have built in a browser and confirming that the report or query you want appears.

More information:

getQueryViewer

getReportViewer

runQuery

Query and Report Viewer Calls

API Authentication

Embed Content in a Liferay Portal

After you have an API call that returns the query or report you want, embed it in your web portal, using an iFrame or portlet to contain and display the CA User Activity Reporting Module content.

This example uses the Liferay Portal, and assumes that you have created a portal, using Liferay installation and configuration instructions. Your own web portal may have similar controls. Consult your web portal documentation for creating iFrames or portlets.

To embed content in a Liferay Portal

1. Create a page, or open a page you want to modify in Liferay
2. Click the tools icon in the top right of the page, next to the Welcome message.
3. Select Add Application from the menu.

   The Add Application dialog appears, displaying application categories

4. Expand the Sample category, and click Add next to the iFrame application.

   A new iFrame portlet appears in the page.

5. Click the configuration link in the portlet, and add enter the API call text in the Source URL field.
6. Click Save.

   The content you selected appears in the iFrame.

7. Configure other iFrames, or publish the web portal according to Liferay documentation.