Navigate from Xcelsius to a Web Intelligence Document and pass parameters

Dashboards are used to visualize KPI’s on a high level (aggregated data). End users will need to use detail information for analyzing red traffic lights in the dashboards. This kind of information will be provided by Web Intelligence documents, Crystal Reports or BEx Queries. This document describes a way to jump from an Xcelsius dashboard to a Web Intelligence Document or a Crystal Report. Also is explained how to pass selections in the Xcelsius dashboard to the detailed report.

Dashboards are used to visualize KPI’s on a high level (aggregated data). End users will need to use detail information for analyzing red traffic lights in the dashboards. This kind of information will be provided by Web Intelligence documents, Crystal Reports or BEx Queries. This document describes a way to jump from an Xcelsius dashboard to a Web Intelligence Document or a Crystal Report. Also is explained how to pass selections in the Xcelsius dashboard to the detailed report.

When you are opening your Xcelsius from InfoView and want to use jump functionality to a Web Intelligence document you can use the out-of-the-box JSP called openDocument. The same JSP can be used to open a Crystal Report as well.

To open a Web Intelligence document you can use the following URL in your dashboard. All you need to change is the part [CUID] to the CUID of your Web Intelligence Document.

[notification type=”notification_info_tiny”]../../../OpenDocument/opendoc/openDocument.jsp?iDocID=[CUID]span>&sIDType=CUID&sType=wid&sWindow=New&isApplication=true[/notification]

If you want to create a link to a Crystal Report document, you can use the URL below:

[notification type=”notification_info_tiny”]../../../OpenDocument/opendoc/openDocument.jsp?iDocID=[CUID]span>&sIDType=CUID&sType=rpt&sWindow=New&isApplication=true[/notification]

Note that those links are using the CUID of the target documents in the URL. However it is also possible to use the InfoObjectID, it is not recommend to use this type of ID. Reason for this is that this ID can be different across your system landscape. Instead of using the iDocID it is also possible to use the document name of the target.

The following table contains the different parameters that can be set via the openDocument JSP (source is documentation of Business Objects):

Parameter Name Description Mandatory Example
iDocID Document identifier Yes, but can be replaced by sDocName Document identifier (InfoObjectID)
sIDType Central Management Server (CMS) object identifier type Yes, if the default document identifier (InfoObjectID) is not used
  • CUID
  • GUID
  • RUID
  • InfoObjectID (default)
sType The file type of the target document or report Yes, but ignored for agnostic documents (xls, doc, txt, etc.)
  • wid
  • rpt
  • car
sPath
  • The name of the Enterprise XI folder and subfolder that contains the target document
  • This parameter is used in conjunction with sDocName
No Enterprise XI folder and/or subfolder: [folder],[subfolder]
sDocName
  • The name of the document without extension
  • This parameter is used in conjunction with sPath
No myDocument
sRepo Repository name (or Domain name),defaults to “Document” No sRepo=Document (no longer used)
sRepoType
  • Repository type (“corporate”, “personal”, “inbox”, “crystal”, or “URL”)
  • Defaults to “crystal”
No RepoType=crystal
sReportName Indicates which report to open if target document contains multi-report (the active report is opened by default No Report name for Web Intelligence documents, sub-report for Crystal Reports, pages for OLAP Intelligence reports.
sReportPart Indicates which specific part of the target Crystal report to open No Name of the report part
sPartContext In Crystal reports, a report part is associated to a data context. Yes, if a value is specified for sReportPart Data context of the report part
sReportMode For Crystal report targets only, indicates whether the link should open the full target report or just the report part specified in sReportPart No, default is Full (only applies if a value is specified for sReportPart)
  • Full
  • Part
sRefresh
  • Indicates whether a refresh should be forced when the target document or report is opened
  • Indicates whether a refresh should be forced when the target document or report is opened
No
  • Y (refresh the document)
  • N (note that the refresh on open feature overrides this value)
sInstance Indicates which specific instance of the target report to open No
  • User (Link to latest instance owned by current user)
  • Last (Link to latest instance for report)
  • Param (Link to latest instance of report with matching parameter values)
sOutputFormat Indicates the format in which the target document is displayed No. Default is HTML
  • H (HTML)
  • P (PDF)
  • E (Excel)

Crystal reports only

  • W (Word)
sViewer Indicates the selected report viewer (CR & CA only) CAUTION: This parameter can conflict with sOutputFormat and should not be combined No
  • CR & CA

html (HTML)

  • CR only

interactive (dHTML)

sWindow Indicates whether the target report will open in the current browser instance or launch a new one No
  • Same
  • New
NAII Avoid the display of the valorized prompts, just display the prompts that have no lsS, lsM or LsR No
  • Y (all prompts whose values are passed with lsS, lsM or lsR are pre-selected)
  • N (displays only the prompts whose values passed with lsS, lsM or lsR
Examples

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=342

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=AWimiw9StnhGm993evk.Amc&sIDType=CUID

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=342& sType=wid

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=343& sType=rpt

../../../OpenDocument/opendoc/openDocument.jsp?sPath=[reports]&sDocName=Charting&sType=rpt

../../../OpenDocument/opendoc/openDocument.jsp?sPath=[reports],[finance]&sDocName=Summary&sType=rpt

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=342&sType=wid&sReportName=Report2

../../../OpenDocument/opendoc/openDocument.jsp?sType=rpt&sDocName=World+Sales+Report&sReportPart=Text2;Graph1&sPartContext=/Country[England]&sReportMode=Part

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=342&sType=wid&sRefresh=Y

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=347&sType=wid&sOutputFormat=P

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=861&sType=rpt&sOutputFormat=W

../../../OpenDocument/opendoc/openDocument.jsp?sType=rpt&iDocID=860&sRefresh=Y&sViewer=interactive

Variables

To pass the selections from the Xcelsius dashboard to the target report additional information about the prompts (=variables) used in the target reports is required:

Parameter Name Description Mandatory Example
lsS[NAME]
  • Specifies a value for a single prompt
  • [NAME] is the text of the prompt
No A single prompt value
lsM[NAME]
  • Specifies multiple values for a prompt
  • [NAME] is the text of the prompt
No
  • Multiple prompt values separated by a comma for CR & OLAP
  • Separated by a semicolon for Webi
  • If the target is a Crystal report, each value must be enclosed in square brackets. If the target is a Crystal Analysis report, use the MDX WITH clause.
lsR[NAME] Specifies a range of values for a prompt. [NAME] is the text of the prompt. No
  • A range of values for the prompt, separated by a double period (..)
  • If the target is a Crystal report, the range must be enclosed in square brackets and/or parentheses (use a square bracket next to a value to include it in the range, and parentheses to exclude it)
  • If the target is a OLAP report, use the MDX WITH clause
lsC Specifies a contextual prompt if there is an ambiguity during SQL generation (BusinessObjects and Web Intelligence documents only) No A prompt value that resolves the ambiguity in the SQL generation

 

Examples

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=342& sType=wid&sRefresh=Y&lsSProductName=Cycle

../../../OpenDocument/opendoc/openDocument.jsp?sType=rpt&iDocID=858&sRefresh=Y&lsSparamString=h& lsSparamNumber=1&
lsSparamCurrency=121&
lsSparamDate=Date(2003,6,11)& lsSparamDateTime=DateTime(2003,6,11,14,38,37)&
lsSparamBoolean=false&
lsSparamTime=Time(12,39,2)&
lsSparamStringDR=a&
lsSparamDateDR=Date(2003,6,1)

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=345& sType=wid&sRefresh=Y&lsMProductName=Cycle;Car

../../../OpenDocument/opendoc/openDocument.jsp?sType=rpt&iDocID=859&sRefresh=Y&lsMparamStringDR=[c],[d]& lsMparamNumberDR=[3],[4]&
lsMparamDateDR=[Date(2003,6,3)],[Date(2003,6,4)]& lsMparamDateTimeDR=[DateTime(2003,6,1,3,1,1)],[DateTime(2003,6,1,4,1,1)]

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=345& sType=wid&sRefresh=Y&lsMProductName=Cycle,Car

../../../OpenDocument/opendoc/openDocument.jsp?sType=rpt&iDocID=860&lsRparamStringDR=[h..i]
&lsRparamNumberDR=[7..8]&
lsRparamCurrencyDR=[3..4]&
lsRparamDateDR=[Date(2003,6,7)..Date(2003,6,8)]&
lsRparamDateTimeDR=[DateTime(2003,6,1,7,1,1)..DateTime(2003,6,1,8,1,1)]& lsRparamTimeDR=[Time(1,1,7)..Time(1,1,8)]& lsRparamUnbound1=(..6)&
lsRparamUnbound2=[6..)&
lsRparamStringR=[a..d]&
lsRparamNumberR=[1..3]&
lsRparamCurrencyR=[1..3]&
lsRparamDateR=[Date(2003,6,1)..Date(2003,6,3)]&
lsRparamDateTimeR=[DateTime(2003,6,1,1,1,1)..DateTime(2003,6,1,3,1,1)]&
lsRparamTimeR=[Time(1,1,1)..Time(3,1,1)]

../../../OpenDocument/opendoc/openDocument.jsp?iDocID=346&sType=wid&sRefresh=Y&lsC=Reservations

Additional information
This article belongs to
Author
  • Ivo Moor