createReportInSession Method downloadReportDataChunk Method

4-4 Developers Guide for Oracle Business Intelligence Publisher

4.4 downloadReportDataChunkInSession Method

Use downloadReportDataChunk method to download very large documents using the bipSessionToken of a given user. The caller calls this method multiple times until all document content is downloaded. Each call to this method downloads one chunk of the document, where the beginIdx parameter refers to the file download starting point. For more information about in-session methods, see Section 1.2, About In-Session Methods. Signature ReportDataChunk downloadReportDataChunkInSessionString fileID, int beginIdx, int size, String bipSessionToken;

4.5 getReportDefinition Method

Use the getReportDefinition method to get information about a report, 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. Signature ReportDefinition getReportDefinitionString reportAbsolutePath, String userID, String password; int beginIdx The starting point of the index default is 1. int size The size of the file to download in kilobytes. Table 4–4 Parameters for downloadReportDataChunkInSession Method Parameter Description String fileID fileID is returned inside ReportRequest , which is returned when calling runReport Method . int beginIdx The starting point of the index default is 1. int size The size of the file to download in kilobytes. 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–5 Parameters for getReportDefinition 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 userID Specifies the BI Publisher user name. Table 4–3 Cont. Parameters for downloadReportDataChunk Method Parameter Description 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