There are two methods to start IBM Cognos components: parameterized URL and cognosLaunch. Both methods perform the same function and use the same parameters. You can use either method to perform any UI task.
The parameterized URL method performs tasks or starts specific components using parameters typed in the Web browser address bar. Using both get and post methods, the launch.xts or cc.xts parameter starts the specified IBM Cognos 8 component.
This method requires that the parameters use the following format:
&ArgumentName=ArgumentValue
The ArgumentName parameter specifies the type, and the ArgumentValue parameter specifies the value of the called arguments. All names and values must be character strings.
This method is easier to begin using than the cognosLaunch method because it does not require advance preparation. However, the longer URL-encoded entries are restrained by browser character limits.
You can use these commands to browse content in IBM Cognos Connection or view pages in Cognos Viewer.
If you are using the parameterized URL method to start any component, you must use the following parameters with this syntax:
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/launch.xts
followed by the specific component parameters you want to use.
If you want to start Cognos Viewer using the parameterized URL method, use the following parameters with this syntax:
http://localhost/cgi-bin/cognos.cgi?b_action=cognosViewer
If you want to start IBM Cognos Connection using the parameterized URL method, use the following URL:
http://localhost/cgi-bin/cognos.cgi?b_action=xts.run&m=portal/cc.xts
The mandatory building blocks for parameterized URL commands are as follows:
This is the mandatory argument value that specifies the IBM Cognos 8 gateway. The gateway name in this example is http://server/cognos8/cgi-bin/cognos.cgi?
IBM Cognos Application Firewall validation is enforced on URLs that contain this parameter. For more information see, URL Validation
Identifies the action. To specify Cognos Viewer, use b_action=cognosViewer. For more information see, Starting Cognos Viewer.
Identifies the IBM Cognos 8 component interface that displays the result. To start IBM Cognos Connection, use m=portal/cc.xts
The cognosLaunch method uses a JavaScript function to perform tasks and start components. To use the launch utility in a Web page, you must first include the following statement in the HTML file from which you start the specific component:
<script language="JavaScript" src="Cognos8Gateway/cognoslaunch.js"> </script>
Cognos8Gateway is the main IBM Cognos 8 gateway defined in IBM Cognos Configuration.
This statement enables the page to open a specified report in the chosen IBM Cognos component using the cognosLaunch JavaScript parameters.
This method requires that the parameters use the following format:
"Argument Name","Argument Value"
The Argument Name parameter specifies the type, and the Argument Value parameter specifies the value of the called arguments. All names and values must be character strings.
The cognosLaunch method uses a simpler construction than the parameterized URL method, but requires an enabled starting page.
If you are using the cognosLaunch method to start any component, use the following parameters with this syntax:
cognosLaunch("ui.gateway"," gateway ","ui.tool","
component")This is the mandatory argument value that specifies the IBM Cognos 8 gateway.
IBM Cognos Application Firewall validation is enforced on URLs that contain this parameter. For more information see, URL Validation
This is the mandatory argument value that specifies the IBM Cognos 8 component.
In addition to the mandatory parameters required by each IBM Cognos 8 component, you can use the following optional parameters, unless otherwise specified:
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.
This parameter is mandatory for Event Studio, Analysis Studio, and Metric Studio.
Specifies the action to take. Acceptable values for the Studio components are new and edit. The default is new. Acceptable values for Cognos Viewer are run and view. The default is view.
This parameter is mandatory for Event Studio and Query Studio. You cannot use this parameter with Metric Studio.
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.
You cannot use this parameter with Analysis Studio.
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
Use this parameter when the report that you want to drill through contains a prompt. This parameter specifies the values that fulfill that prompt, and display the requested data. The acceptable value is a Web64-encoded XML string. This string must include the name of the prompt parameter you want to fulfill, and its values. Using the example in Start Parameters, if you wanted to start Cognos Viewer to run the Target report and get information specific to Italy, you would append the URL with the ui.drillThroughTargetParameterValues argument name, followed by this argument value:
<parameterValues SOAP-ENC:arrayType=\"bus:parameterValue[]\" xsi:type=\"SOAP-ENC:Array\"><item xsi:type=\"bus:parameterValue\"><name xsi:type=\"xs:string\">Country</name><value SOAP-ENC:arrayType=\"bus:parmValueItem[]\" xsi:type=\"SOAP-ENC:Array\"><item xsi:type=\"bus:simpleParmValueItem\"><use xsi:type=\"xs:string\">Italy</use></item></value></item></parameterValues>
You cannot use this parameter with Event Studio or Metric Studio.