Starting IBM Cognos Viewer

You can use a URL to quickly open a specified report in IBM® Cognos® Viewer.

Use the following parameters to start IBM Cognos Viewer with the parameterized URL method:

http://localhost/cgi-bin/cognos.cgi?b_action=cognosViewer&ui.
object=/content/folder[@name='Samples']/folder[@name='Cubes']/package
[@name='Salesand Marketing (cube)']/folder
[@name='Report Studio Report Samples']/report
[@name='Actualvs. Planned Revenue']&ui.action=run

Use the following parameters to start IBM Cognos Viewer with the cognosLaunch method:

cognosLaunch('ui.gateway','http://localhost/ibmcognos/cgi-bin/cognos.cgi','ui.
tool','CognosViewer')

For a complete list of the IBM Cognos Viewer parameters, see the topics on URL API reference in the IBM Cognos Software Development Kit Developer Guide.

The following parameters are optional for IBM Cognos Viewer:

run.outputFormat
Specifies the output format. Acceptable values are CSV, HTML, PDF, XHTML, XLWA, and XML. The default value is HTML.

To run reports in the CVS, PDF, or XML output formats, you require the generate output capability for the specific format. URLs that hard code a format in a run request can result in an error if the user is restricted from generating output in that format. For more information, see Report formats.

Note: To protect IBM Cognos BI and your servers, the IBM Cognos Application Firewall (CAF) rejects URL-based requests for output in XLS format.
run.outputLocale
Specifies the output language. Acceptable values are expressed as a hyphenated language-region pair, in accordance with the RFC3066 standard. The default value is en-us.
run.prompt
Specifies whether the report service issues prompts, so you can enter report option values. Acceptable values are true and false. The default value is true.
run.xslURL
Specifies the location of an XSL stylesheet that can be applied to the report, thereby rendering it in the requested format. An acceptable value is a URI.

When referencing the XSL file, ensure that the specified file is valid, and exists on the application server in the templates/rsvp/xsl directory. Referencing an invalid stylesheet terminates the process.
run.outputEncapsulation
Specifies how output documents in the response are encapsulated. Acceptable values are HTML, URL, URLQueryString, none.
asynch.attachmentEncoding
Specifies how attachments to the response are encoded. Acceptable values are base64, MIME, MIMECompressed. The default value is base64.
asynch.primaryWaitThreshold
Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. Acceptable values are any integer. Use a value of 0 to make the client wait indefinitely. The default value is 7.
asynch.secondaryWaitThreshold
Specifies the maximum amount of time, in seconds, that the server can use to process the request before sending a response to the client. Acceptable values are any integer. Use a value of 0 to make the client wait indefinitely. The default value is 30.
ui.object
Specifies the path of the target object. Acceptable values are the Content Manager search path or store ID. For more information, see Using Search Paths and Page IDs.
ui.folder
Specifies the target folder. Acceptable values are the Content Manager search path or store ID. For more information, see Using Search Paths and Page IDs.
ui.backURL
Specifies the URI to open after you close the selected component.

IBM Cognos Application Firewall validation is enforced on URLs that contain this parameter. For more information see, URL Validation.