OpenDocument syntax
OpenDocument syntax
3.1 Basic URL syntax
The basic syntax for an OpenDocument URL is as follows: http://<servername>:<port>/BOE/OpenDocument/opendoc/openDocument.jsp?<parameter1>&<parameter2>&...&<parameterN>
Note:
Variables are denoted with angle brackets. You must substitute the proper value for these variables.
For example, you must use the name of your BI platform server where OpenDocument is hosted in place of <servername> and you must use the correct port number in place of <port> to access the
OpenDocument web application.
3.2 URL syntax considerations
Accessing documents
You must include the iDocID or sDocName parameter in your OpenDocument URL to specify the document to be viewed. Since there may be multiple documents in the Central Management Server
(CMS) with the same name, and documents can be moved or renamed, it is recommended that you use iDocID to ensure uniqueness.
Joining parameters
Join parameters with the ampersand (&). Do not place spaces around the ampersand. For example: sType=wid&sDocName=Sales2003
The ampersand is always required between parameters.
Spaces and special characters in parameter values
Because some browsers cannot interpret spaces, the parameters of the link cannot contain spaces or other special characters that require URL encoding. To avoid the misinterpretation of special characters, you can define a URL-encoded string in the source database to replace the special character with an escape sequence. This will allow the database to ignore the special character and correctly interpret the parameter value. Note that certain RDBMS have functions that allow you to replace one special character with another.
11 2012-04-17
OpenDocument syntax
By creating an escape sequence for the plus sign (+), you can instruct the database to interpret the plus sign as a space. In this case, a document title Sales Report for 2003 would be specified in the
DocName parameter as: &sDocName=Sales+Report+for+2003&
This syntax prevents the database from misinterpreting the spaces in the title.
In addition, values for serialized sessions (using the serSes parameter) and logon tokens (using the token parameter) must be URL-encoded by your application before being passed to the OpenDocument
URL string.
Trailing spaces in parameter values
Trim trailing spaces at the end of parameter values and prompt names. Do not replace them with a plus sign (+). The viewer may not know whether to interpret the plus sign (+) as part of the prompt name or as a space. For example, if the prompt name displays:
Select a City:_
(where _ represents a space), enter the following text in the link: lsSSelect+a+City:=Paris where the spaces within the prompt name are replaced with the plus sign, and the trailing space is trimmed off.
Capitalization
All of the OpenDocument parameters and parameter values are case sensitive.
URL length limit
OpenDocument may add characters to your URL when it redirects to the requested document; however, encoded URLs cannot exceed the maximum character limit for the supported browsers. For example, certain versions of Internet Explorer limit the URL length to 2083 characters. Therefore, know the browser character limit to ensure your URL will be within the maximum limit.
Parameter values in links to sub-reports
You cannot pass parameter values to a sub-report of a target Crystal report.
Opening a new window
To force OpenDocument HTML links to open a new browser window, use the HTML anchor's target attribute or an equivalent. For example:
<a href="http://<servername>:<port>/BOE/OpenDocument/opendoc/<platformSpecific>?iDocID=Aa6GrrM79cRAmaOSMGoad
KI&sIDType=CUID" target="_blank">hyperlink text</a>
12 2012-04-17
