This is an attempt to provide an overview of openDocument in SAP Business Objects XI 3.1 . OpenDocument is used to open the report without locating the report. So if the openDocument URL is placed on a page, then user can click on it and can directly open the report. Following are the simple examples of openDocument URL:
http://servername:8080/OpenDocument/opendoc/openDocument.jsp?sType=wid&sDocName=report1
http:// servername:8080/OpenDocument/opendoc/openDocument.jsp?sType=wid&iDocID=1579
Above URL are just sample URL and will not work in your environment unlsess you replace the servername, port , iDocID. Following are the more explanations about the same.
In both the examples, I am opening a web Intelligence report named “report1”. In the first example I have used the report name and in the second example I am using the ID of the report “report1”. Ampersand (&) is used to join the parameters (sType, iDocID are the parameters used in this example). In this example, 8080 is the tomcat port. To prepare a openDocument URL in your environment you need to replace the following values wrt to your environment,
servername: BOE server name. If you have done the BOE installation in a distributed environment then provide the machine name in which your web application server is installed.
web application server port: in the above sample URL, replace 8080 with your web application server port.
sType: File type of the target document or report (please refer the below table)
iDocID: iDocID of the document. Report name can also be used instead of iDocID (as mentioned in the first example)
How to find the iDocID of a report?
Login to CMC -> Navigate to the report -> right click and open properties page. In the page you can find the label- ID, CUID. Value of ID is used as iDocID in the openDocument.
Following are the list of few important parameters and its descriptions:
Parameter | Description | Values |
sDocName | Name of the document | Name of the document |
iDocID | Document ID | Document ID |
sType | The file type of target document or report | Example- .rpt, .wid (.rpt is used for crystal report and . wid is used for web Intelligence) |
sRefresh | whether to refresh the report on open | Y , N |
sWindow | whether the target report will open in the current browser window or whether a new window will be launched | Same , New |
lsS[NAME] | Specifies a value for a single prompt. [NAME] is the text of the prompt. | Hard coded value |
lsM[NAME] | Specifies a range of values for a prompt. [NAME] is the text of the prompt. | Hard coded value separated by semicolon |
sInstance | Indicates which specific instance of the target report to open. | 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) |
sReportPart | Indicates which specific part of the target report to open. | Name of the report part. |
