openDocument Parameter Overview

This section provides a brief overview of openDocument and includes a list of available parameters. Details about the available parameters, their specific uses, and relevant examples are also provided.

Note.pngThe 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.

Table 26-3: Platform Parameters

Parameter Description
iDocID Document identifier
sDocName Document name.
sIDType Crystal object type.
sKind The file type of target Desktop Intelligence document.
sPath The name of the folder and subfolder containing the target document.
sType The file type of target document or report.
token A valid logon token for the current CMS session.

Table 26-4: Input Parameters

Parameter Description
IsC Specifies a contextual prompt if there is an ambiguity during SQL generation (Business Objects and Web Intelligence documents only).
IsM[NAME] Specifies multiple values for a prompt, [NAME] is the text of the prompt.
IsR[NAME] Specifies a range of values f or a prompt, [NAME] is the texts of the prompt.
IsS[NAME] Specifies a value for a single prompt. [NAME] is the text of the prompt.
sInstance Indicates which specific instance of the target report to open.
sPartContext In Crystal Reports, a report part is associated to a data context.
sRefresh Indicates whether a refresh should be forces when the target document or report is opened.
sReportMode For Crystal targets only, indicates whether the link should open the full target report or just the report part specified in sReportPart.
sReportName Indicates which report to open if target document is multi-report.
sReportPart Indicates which specific part of the target report to open.

Table 26-5 Output Parameters

Parameter Description

NAII

Forces the display of the prompt selection page.
sOutputFormat Indicates the format in which the target document is opened.
sViewer Indicates the selected report viewer (CR & CA only)
sWindow Indicates whether the target report will open in the current browser window or whether a new window will be launched.