Structuring an OpenDocument URL

The next sections explain how to use the openDocument function, and how to construct the URL.

 

An openDocument URL is generally structured as follows:

 

image35.jpg

 

The exact syntax of the <platformSpecific> parameter depends on your implementation:

·            For Java implementations, use openDocument.jsp in place of the <platformSpecific> parameter.

·            For .NET implementations, use opendocument.aspx in place of the <platformSpecific> parameter.

The URL is constructed using the parameters listed in openDocument parameter overview

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 URLEncoded 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.

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.

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.

For details on prompt parameters of the link, refer to openDocument parameter overview.

Capitalization

All of the openDocument parameters are case sensitive.

Link length limit

The encoded URL cannot exceed 2083 total characters.

Parameter values in links to sub-reports

You cannot pass parameter values to a sub-report of a target Crystal report.