ReportService 4-3
4.2 createReportInSession Method
Use the createReport method to create a report in the BI Publisher catalog based on the bipSessionToken of a given user.
For more information about in-session methods, see Section 1.2, About In-Session
Methods.
Signature String createReportString reportName, String folderAbsolutePathURL, String
dataModelURL, String templateFileName, byte[] templateData, String XLIFFFileName, byte[] XLIFFData, boolean updateFlag, String bipSessionToken;
4.3 downloadReportDataChunk Method
Use downloadReportDataChunk method to download very large documents, so that 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.
See Section 2.3.44, ReportDataChunk.
Signature ReportDataChunk downloadReportDataChunkString fileID, int beginIdx, int size;
Table 4–2 Parameters for createReportInSession Method
Parameter Description
String reportName The report name to create with the suffix .xdo. For
example, myreport.xdo. String folderAbsolutePathURL
The path to the folder in which to place the created report. For example: xmlpReportsfinancials
String dataModelURL The path to the data model that will be used as the data
source for this report. For example: xmlpReportsfinancialsData Modelsmy data
model.xdm
String templateFileName The file name of the template to add the report definition.
byte[] templateData, The template file.
String XLIFFFileName The file name of the XLIFF file.
byte[] XLIFFData The XLIFF file.
boolean updateFlag If true, overwrites existing report. If false, throws error
if the report exists. 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–3 Parameters for downloadReportDataChunk Method
Parameter Description
String fileID fileID is returned inside
ReportResponse , which is
returned when calling runReport 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
Kategori