IBM Support

Using Parameterized URL's in Cognos Analytics for legacy components

Question & Answer


Question

Just like Cognos 10, you can use parametrerized URLs on the legacy components in Cognos Analytics.

Answer


Creating these URL's are almost exactly the same as creating them in previous versions except the gateway portion of the URL is different.

In Cognos 10, the gateway section would is: websever/ibmcognos/cgi-bin/cognosisapi.dll
In Cognos Analytics, it looks like this: webserver/ibmcognos/bi/v1/disp or dispatcher:9300/bi/v1/disp

The rest of the URL is constructed exactly the same as Cognos 10.

For example, to open Query Studio in Cognos 10, the url would look something like this
websever/ibmcognos/cgi-bin/cognosisapi.dll?b_action=xts.run&m=portal/launch.xts&ui.tool=QueryStudio&ui.object=/content&ui.action=new

In Cognos Analytics the URL will look like this
webserver/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.tool=QueryStudio&ui.object=/content&ui.action=new

You can this URL for the following legacy components:

  • Query Studio
  • Analysis Studio
  • Event Studio
  • PowerPlay Studio

The following are a few examples of the URL actions
Query Studio
Open Query Studio and prompt for package
http://localhost/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.tool=QueryStudio&ui.object=/content&ui.action=new
Starting Query Studio to a specific package
http://localhost/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.tool=QueryStudio&ui.object=/content/folder[@name='Samples__LG_DQ']/folder[@name='Models']/package[@name='GO Data Warehouse (analysis)']&ui.action=new
Starting Query Studio to a specific report
http://localhost/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.tool=QueryStudio&ui.object=/content/folder[@name='Samples_LG_DQ']/folder[@name='Models']/package[@name='GO Data Warehouse (analysis)']/folder[@name='Query Studio Report Samples']/query[@name='Return Quantity by Product Line_DQ']&ui.action=edit

Analysis Studio
Open Analysis Studio and prompt for package
http://localhost/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos/bi/v1/disp&ui.tool=AnalysisStudio&ui.action=new
Starting Analysis Studio to a specific package
http://localhost/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos/bi/v1/disp&ui.tool=AnalysisStudio&ui.object=/content/folder[@name='Samples_PowerCube']/folder[@name='Cubes']/package[@name='Sales and Marketing(cube)']/folder[@name='Analysis Studio Report Samples']&ui.action=new
Viewing an analysis report in Analysis Studio
http://localhost/ibmcognos/bi/v1/disp?b_action=xts.run&m=portal/launch.xts&ui.gateway=http://localhost/ibmcognos/bi/v1/disp&ui.tool=AnalysisStudio&ui.tool=AnalysisStudio&ui.object=/content/folder[@name='Samples_PowerCube']/folder[@name='Cubes']/package[@name='Sales and Marketing (cube)']/folder[@name='Analysis Studio Report Samples']/analysis[@name='Custom Rank Sample']&ui.action=edit

PowerPlay Studio
Starting PowerPlay Studio to a specific cube package
http://localhost/ibmcognos/bi/v1/disp?b_action=powerPlayService&ui.action=new&ui.object=/content/folder[@name='Samples_PowerCube']/folder[@name='Cubes']/package[@name='Great Outdoors Sales (cube)']
Viewing a report in PowerPlay Studio
http://localhost/ibmcognos/bi/v1/disp?b_action=powerPlayService&TARGET=/content/folder[@name='Samples']/folder[@name='Cubes']/package[@name='Sales and Marketing (cube)']/folder[@name='PowerPlay Studio Report Samples']/powerPlay8Report[@name='Revenue by Order Method']&FORMAT=HTML


Information on how to create URL's for Reports, Modules, Dashboards and Stories go to Creating Custom URL's in Cognos Analytics

More information on how to construct a parameterized URL's for the legacy studios, refer to Chapter 20. Performing tasks in IBM Cognos BI using URLs in the Cognos 10.2.2 SDK Guide

[{"Product":{"code":"SSTSF6","label":"IBM Cognos Analytics"},"Business Unit":{"code":"BU059","label":"IBM Software w\/o TPS"},"Component":"Not Applicable","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"11.0","Edition":"","Line of Business":{"code":"LOB10","label":"Data and AI"}}]

Document Information

Modified date:
15 June 2018

UID

swg21997563

Page Feedback