cognosLaunch Method

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="CognosGateway/cognoslaunch.js">
</script>

CognosGateway is the main IBM® Cognos® Business Intelligence 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.

Mandatory cognosLaunch Parameters

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")
  • "ui.gateway"

    This is the mandatory argument value that specifies the IBM Cognos BI gateway.

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

  • "ui.tool"

    This is the mandatory argument value that specifies the IBM Cognos BI component.

  • ui.action

    Specifies the action to take. Acceptable values for the Studio components are new and edit. The default is new. Acceptable values for IBM Cognos Viewer are run and view. The default is view.

    You cannot use this parameter with Metric Studio.