Adding URL-based reports

You can add customized reports that users can display in the Operations view.

Before you begin

Obtain the URL of the report that you want to add.

If Cognos® has been installed into the solution, to obtain a URL for a Cognos report, do the following steps:
  1. In the Cognos Connection console, locate the report that you want to display.
  2. In the actions column for the report, click Set properties.
  3. On the General tab, click View the search path, ID and URL.
  4. Note the value of the Default Action URL.
  5. Edit the AnalyticServerDispatchUrl system property, and copy the host name and the port number from the Value field.
  6. In the default action URL that you noted, replace the host name and the port number with the host name and the port number that you copied from the AnalyticServerDispatchUrl system property.
  7. Ensure that the edited default action URL uses the HTTPS protocol.
  8. To hide the Cognos header and toolbar in the report, append the following value to the URL: &cv.header=false&cv.toolbar=false

Procedure

To add a customized report, edit the ReportViewConfig system property with the details.

Example

The following sample value for the ReportViewConfig system property is given only for demonstration. This sample value adds two example Cognos reports by adding their URLs:
[{"id" : "report1", "name" : {"group":"Report","key":"reportname1"}, 
"url":"https://host:port/ServletGateway/servlet/Gateway?
b_action=cognosViewer&ui.action=run
&ui.object=%2fcontent%2fpackage%5b%40name%3d%27IOC%27%5d%2freport%5b%40name%3d%27ReportA%27%5d
&ui.name=ReportA&run.outputFormat=&run.prompt=true" },
{"id" : "report2", "name" : {"group":"Report","key":"reportname2"},
"url":"https://host:port/ServletGateway/servlet/Gateway?
b_action=cognosViewer&ui.action=run
&ui.object=%2fcontent%2fpackage%5b%40name%3d%27IOC%27%5d%2freport%5b%40name%3d%27ReportB%27%5d
&ui.name=ReportB&run.outputFormat=&run.prompt=true"}]
Where:
  • The value of id must be unique.
  • The value of name is the translatable name of the report or chart.
    By changing their locale, users can view the report name in multiple languages. To insert a globalization value for the report name into the I18N_RESOURCE table in the IOC database, enter the following command. At a minimum, replace the values for KEY and VALUE:
    INSERT INTO IOC.I18N_RESOURCE ("GROUP", "LOCALE", "KEY", "VALUE")
     VALUES ('CustomReport', 'default', 'insert_key_here', 'insert_translatable_name_here');
    Where:
    • The value of LOCALE indicates the locale that the value is for.
    • The value of KEY is a unique name for the translated string.
    • The value of VALUE is the translated string for the report name.
  • The value of url is the URL for the report or chart.
  • The value of pdfUrl is an optional URL value for a PDF version of the report.
    Note: For Cognos reports, you can generate a PDF version of the report through the URL. In the value for url, replace run.outputFormat= with run.outputFormat=PDF.

What to do next

To view the report in the Operations view, on the taskbar, select the My View > Show Reports check box on the taskbar.