OpenDocument parameters

There are two implementations of the openDocument function. The exact syntax of the <platformSpecific> parameter depends on your implementation:

For Java implementations, use desktoplaunch/opendoc/openDocument.jsp in place of the <platformSpecific> parameter.
For .NET implementations, use InfoView/scripts/opendocument.aspx in place of the <platformSpecific> parameter.

The first parameter of the link

http://<webserver>/businessobjects/enterprise11/<platformSpecific>?

The first parameter, as displayed in the example above, must precede all other parameters. After this information, the parameters can appear in any order.

The parameters of the function are displayed in the following table. The mandatory column indicates whether the parameter is required in the link.

Note: The document containing the openDocument link is called the parent document, and it resides on the parent system. The document to which the link points is called the target document, and it resides on the target system.

Parameter syntax	Description of parameter	Mandatory?	Values accepted for parameter

`sPath`	The name of the Crystal folder and subfolder containing the target document.	Yes if `sDocName` is specified and is not unique.	Crystal folder and/or subfolder: `[folder],[subfolder]`
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports],[Sub+Folder] For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sType`	The file type of target document or report.	Yes	wid rpt car
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sDocName`	Document name.	One of `sDocName` or `iDocID` is mandatory.	Document name.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2005 For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`iDocID`	Document identifier.	One of `sDocName` or `iDocID` is mandatory.	Document identifier.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010 For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter. Replace 2010 with the document ID. Tip: To obtain the document ID, navigate to the document in InfoView, hover your mouse over the document name hyperlink, and look for the ID number in the browser's status bar. You can also obtain the document ID from the Central Management Console.
`sIDType`	Crystal object type.	Yes if the target is a Crystal report or OLAP Intelligence report (`sType=rpt or =car`) in an Object Package (otherwise, use `sPath` and `sDocName`)	`CUID` `GUID` `RUID` `ParentID` `InfoObjectID` (default)
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sIDType=InfoObject For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sReportName`	Indicates which report to open if target document is multi-report.	No (default is the first report)	Report name for Web Intelligence documents, sub-report for Crystal Reports, pages for OLAP Intelligence reports.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=Sales+in+2003&sReportName=First+Report+Tab For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sOutputFormat`	Indicates the format in which the target document is opened.	No (default is HTML if the parameter is not specified in the link)	`H` (HTML) `P` (PDF) `E` (Excel) `W` (Word)
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sOutputFormat=E For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sReportPart`	Indicates which specific part of the target report to open.	No	Name of the report part.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sReportPart=Part1 For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`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.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2005&sReportPart=Part1&sPartContext=0-4-0 For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sInstance`	Indicates which specific instance of the target report to open.	No (use with `sDocName` and `lsS[NAME]`)	`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)
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sReportPart=Part1&sInstance=User For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sReportMode`	For Crystal 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`
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sPath=[Sales+Reports]&sDocName=Sales+in+2003&sReportPart=Part1&sReportMode=Part For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sRefresh`	Indicates whether a refresh should be forced when the target document or report is opened.	No	`Y` (forces the document's refresh) `N` (note that the refresh on open feature overrides this value)
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&sRefresh=Y For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`sWindow`	Indicates whether the target report will open in the current browser window or whether a new window will be launched.	No	`Same` (current browser window) `New` (new browser window is launched)
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&sWindow=New For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`lsS[NAME]`	Specifies a value for a single prompt. `[NAME]` is the text of the prompt.	No	A single prompt value.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&lsSSelect+a+City=Paris For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`lsM[NAME]`	Specifies multiple values for a prompt. `[NAME]` is the text of the prompt.	No	Multiple prompt values, separated by a comma. If the target is a Crystal report, each value must be enclosed in square brackets. If the target is a OLAP Intelligence report, use the MDX WITH clause (refer to Specifying prompts for OLAP Intelligence report targets).
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=rpt&sDocName=SalesReport&lsMSelect+Cities=[Paris],[London] For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`lsR[NAME]`	Specifies a range of values for a prompt. `[NAME]` is the text of the prompt. Note: Not supported by OLAP Intelligence	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 Intelligence report, use the MDX WITH clause (refer to Specifying prompts for OLAP Intelligence report targets).
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=rpt&sDocName=SalesReport&lsRTime+Period:=[2000..2004) For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`lsC`	Specifies a contextual prompt if there is an ambiguity during SQL generation (Business Objects and Web Intelligence documents only). Note: Not supported by OLAP Intelligence	No	A prompt value that resolves the ambiguity in the SQL generation.
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&lsC=Sales For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.
`NAII`	Forces the display of the prompt selection page. Note: Not supported by OLAP Intelligence	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`)
Example: http://<webserver>/businessobjects/enterprise11/<platformSpecific>?sType=wid&sDocName=SalesReport&iDocID=2010&NAII=Y For Java implementations, use `desktoplaunch/opendoc/openDocument.jsp` in place of the <platformSpecific> parameter. For .NET implementations, use `InfoView/scripts/opendocument.aspx` in place of the <platformSpecific> parameter.