4-6 Developers Guide for Oracle Business Intelligence Publisher
4.8 getReportParametersInSession Method
Use the getReportParameters method to get an array of report parameters and their default values based on the bipSessionToken of a given user. With the list of
parameters, you can set parameter values before running or scheduling a report.
See Section 2.3.42, ParamNameValues.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature ParamNameValues getReportParametersInSessionReportRequest reportRequest,
String bipSessionToken;
4.9 getReportSampleData Method
Use the getReportSampleData method to retrieve the sample data file stored with the report data model.
Signature byte[] getReportSampleDataString reportAbsolutePath, String userID, String
password;
4.10 getReportSampleDataInSession Method
Use the getReportSampleDataInSession method to retrieve the sample data file stored with the report data model based on the bipSessionToken of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature byte[] getReportSampleDataString reportAbsolutePath, String bipSessionToken;
Table 4–8 Parameters for getReportParametersInSession Method
Parameter Description
ReportRequest reportRequest See
Section 2.3.46, ReportRequest. String bipSessionToken
The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the
user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore
the BI Publisher server session to perform needed operation.
Table 4–9 Parameters for getReportSampleData Method
Parameter Description
String reportAbsolutePath The path to the report for which to retrieve the report data
model sample data. For example: HR ManagerEmployee ReportsEmployee Listing.xdo
String userID Specifies the BI Publisher user name.
String password Specifies the password for the user name.
ReportService 4-7
4.11 getTemplate Method
Use getTemplate method to retrieve a template from a report definition in the BI Publisher catalog.
Signature byte[] getTemplateString reportAbsolutePath, String templateID, String locale, String
userID, String password;
4.12 getTemplateInSession Method
Use getTemplateInSession method to retrieve a template from a report definition in the BI Publisher catalog based on the bipTokenSession of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature byte[] getTemplateInSessionString reportAbsolutePath, String templateID, String
locale, String bipSessionToken;
Table 4–10 Parameters for getReportSampleDataInSession Method
Parameter Description
String reportAbsolutePath The path to the report for which to retrieve the report data
model sample data. For example: HR ManagerEmployee ReportsEmployee Listing.xdo
String bipSessionToken The proprietary token string generated for the user by the
BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI
Publisher server can validate this token string and restore the BI Publisher server session to perform needed
operation.
Table 4–11 Parameters for getTemplate Method
Parameter Description
String reportAbsolutePath The path to the report to which the template is associated.
For example: HR ManagerEmployee ReportsEmployee Listing.xdo
String templateID The ID of the template for example, Chart Layout.
String locale The locale of the template to retrieve for example, en_US.
String userID Specifies the BI Publisher user name.
String password Specifies the password for the user name.
Table 4–12 Parameters for getTemplateInSession Method
Parameter Description
String reportAbsolutePath The path to the report to which the template is associated.
For example: HR ManagerEmployee ReportsEmployee Listing.xdo
String templateID The ID of the template for example, Chart Layout.
String locale The locale of the template to retrieve for example, en_US.
Kategori