getBqyDocument()

Used to retrieve a document from the repository, create the DOM, and provide access to the nodes and properties of the Interactive Reporting document.

Example using getBqyDocument():

var domBqy = env.getBqyDocument(filBqy, bqOpenMode, bqStrategy)

Parameter

Description

filBqy

Represents the Interactive Reporting document, generally retrieved using the retrieveFile method of the repository artifact

bqOpenMode

Defines the way the file is opened. For example, using bqReadOnlyDom the file is read-only, or using bqReadWriteDom the file has read/write properties. For scripts running in Release 9.3.1 or later this parameter is ignored because the Rhino engine loads nodes only if scripts attempt to reference them or the properties below them (see following table).

bqStrategy

Determines, as an efficiency measure, how much of the DOM is built. For scripts running in Release 9.3.1 or later this parameter is ignored because the Rhino engine loads nodes only if scripts attempt to reference them or the properties below them (see following table).

Property

Description

bqDashboardReportStrategy

Loads only dashboards and reports

bqDatamodelUpgradeStrategy

Loads only data models and queries

bqJavaScriptUpdateStrategy

Loads only dashboards

bqTopLevelSectionsStrategy

Loads all sections and the section level properties

null

Loads the whole document