Oracle® Business Intelligence Web Services Guide > Description of Structures in Oracle BI Web Services >

ReportParams Structure


Use this structure to replace existing filters and variables in a report. This structure is common to all services in Oracle BI Web Services. Table 20 lists the fields in this structure.

Table 20. ReportParams Structure Fields
Fields
Description

String[] filterExpressions

Specifies an array of Oracle BI Web Services filter expressions in the form Object[] filter_expression, filter_expression ...

Variable[] variables

Specifies an array of variable values to be set before method execution. This structure is used in the executeXMLQuery() Method, the cancelQuery() Method, and the generateReportSQL() Method.

NameValuePair[] nameValues

Should be set to NULL. This field is for internal use only.

TemplateInfo[] templateInfos

Should be set to NULL. This field is for internal use only.

Table 21 shows how filter expressions are applied to a report.

Table 21. How Filter Expressions Are Applied to a Report in Oracle BI Web Services
Step
Internal Processing

1

Obtains XML representations of the report and each filter expression.

2

For each expression element, locates the child node of the type sqlExpression (the type is determined by the value of the xsi:type attribute), and references its inner text.

3

In the report XML, locates all nodes that also have a child node of type sqlExpression where the inner text matches that located in the preceding step.

4

Replaces all nodes found in Step 3 with the expression from Step 2.

Table 22 shows how variables are applied to a report.

Table 22. How Variables Are Applied to a Report in Oracle BI Web Services
Step
Internal Processing

1

Obtains XML representations of the report.

2

For each variable, locates all nodes in the report XML that have a type of variable, attribute scope equal to report, and inner text that matches the variable name.

3

Replaces each node located in Step 2 with the new variable value.

Oracle® Business Intelligence Web Services Guide Copyright © 2007, Oracle. All rights reserved.