downloadReportDataChunkInSession Method getReportDefinition Method

ReportService 4-5

4.6 getReportDefinitionInSession Method

Use the getReportDefinitionInSession method to get information about a report using the bipSessionToken of a given user. This method returns report details such as the default template, output type, and a list of template IDs. With the list of template IDs, you can generate a report with a template other than the default. See Section 2.3.45, ReportDefinition. For more information about in-session methods, see Section 1.2, About In-Session Methods. Signature ReportDefinition getReportDefinitionInSessionString reportAbsolutePath, String bipSessionToken;

4.7 getReportParameters Method

Use the getReportParameters method to get an array of report parameters and their default values. With the list of parameters, you can set parameter values before running or scheduling a report. See Section 2.3.42, ParamNameValues. Signature ParamNameValues getReportParametersReportRequest reportRequest, String userID, String password; String password Specifies the password for the user name. Table 4–6 Parameters for getReportDefinitionInSession Method Parameter Description String reportAbsolutePath The path to the report for which to retrieve the report definition. 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–7 Parameters for getReportParameters Method Parameter Description ReportRequest reportRequest See Section 2.3.46, ReportRequest. String userID Specifies the BI Publisher user name. String password Specifies the password for the user name. Table 4–5 Cont. Parameters for getReportDefinition Method Parameter Description 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.