https://www.ibm.com/support/knowledgecenter/en/SSEP7J_11.0.0/com.ibm.swg.ba.cognos.wig_cr.doc/c_wig_cr_create_custom_url.html

Applies to version 11.0.5 and subsequent versions unless specifically overridden

You can create URLs that open or run IBM® Cognos® Analytics content objects, such as reports, dashboards, stories, and data modules. This feature extends the Share command that creates a URL to display Cognos Analytics content objects to provide more control over the actions that are taken when the content object is displayed or run.

The Share command that is described in Sharing and embedding content provides a simple way to create a URL that opens and runs Cognos Analyticscontent objects. You can create these URLs if you require more control over the actions invoked by them.

Applies to version 11.0.6 and subsequent versions unless specifically overridden The following report types are supported in custom URLs: standard reports, report views, active reports, data sets, Query Studio reports, Analysis Studio reports, and their saved outputs.

Applies to version 11.0.6 and subsequent versions unless specifically overridden If the content object is a report that has saved output, the saved output is displayed if it exists. Otherwise, the report is run. If the content object is saved output, it is displayed. An error message is displayed if the saved output has been deleted.

Applies to version 11.0.7 and subsequent versions unless specifically overridden Ability to specify login parameters in the URL.

Syntax

Applies to version 11.0.6 and subsequent versions unless specifically overridden The syntax of the custom URLs takes one of the following two forms.

http://<servername>:<port>/bi/?pathRef=<path>&<option1>=<value1>&<option2>=<value2>...
http://<servername>:<port>/bi/?objRef=<id>&<option1>=<value1>&<option2>=<value2>...

pathRef or objRef identify the content object to use.

pathRefSpecifies the location of the object. This value does not change if the version of Cognos Analytics is changed or if the object is exported or imported in a deployment.The easiest way to determine the value of pathRef is to create a URL by using the Share command. This URL contains the value of pathRef.objRefSpecifies the id of the object. This value does not change if the content object is moved to a different location in My content or Team content.The value of objRef is the ID value in the properties pane of the object.

A number of optional options can be appended to the URL. The following two options can be used in any perspective.

ui_appbarSpecifies whether to display the Application bar (true) or not (false). The default value is true.ui_navbarSpecifies whether to display the Navigation bar (true) or not (false). The default value is true.

The following options can be used if the content object is a report..

actionSpecifies run to run a report or edit to author a report. edit can only be used in the authoring perspective. The default value is run.formatWhen running a report, specifies the output format. The possible values are HTML and PDF. In the classicviewer perspective, the following values are also supported: xlsxData, CSV, spreadsheetML, layoutDataXML, XLWA, rawXML, XHTML, singleXLS, and HTMLFragment. The default value is HTML.To use the classicviewer perspective, the option perspective=classicviewer must be included in the URL. For example, http://:/bi/?perspective=classicviewer&pathRef=&=&=...a11yWhen running a report, specifies whether to include accessibility features (true) or not (false). The default value is false.bidiWhen running a report, specifies whether to enable bidirectional support (true) or not (false). The default value is false.promptWhen running a report, specifies whether to show the prompt page (true) or not (false). The default value is false.p_When running a report, specifies the value to use for the prompt named ..promptParametersWhen running a report, specifies prompt parameters as a JavaScript Object Notation (JSON) object. You to pass more complex prompts to use when you run a report. For more information, see promptParameters option syntax.

The easiest way to create a custom URL is to use the Share command for the content object that you want to create a custom URL for, and then to modify the options in this URL.
Custom URLs can be long and your Cognos Analytics server environment might impose a length limit on the query portion of the URL You can work around this limitation by using the URL fragment identifier (#) in the URL. Here are some examples.
- http://<servername>:<port>/bi/#pathRef=<path>&<option1>=<value1>&<option2>=<value2>...
- http://<servername>:<port>/bi/?pathRef=<path>&<option1>=<value1>#<option2>=<value2>...
You can also use the HTTP POST method to send the options to the Cognos Analytics server.
If your Cognos Analytics server requires user authentication, a sign-in view is displayed when you run a custom URL in a web browser. For information on some ways to handle the authentication issue, see Sharing and embedding content.
If you use a custom URL in an HTML item in a report, replace instances of & with &.

promptParameters option syntax
You can use the promptParameters option to pass complex prompt values for use when you run a report. The prompt values are contained in a JavaScript Object Notation (JSON) object.

Parent topic:

Managing content

Browser not supported