scheduleReportInSession Method suspendSchedule Method suspendScheduleInSession Method

ScheduleService 3-17 Table 3–38 Parameters for suspendScheduleInSession Method Parameter Description String jobInstanceID The ID assigned to the instance of the job to be suspended. The jobInstanceID is a string of integers. 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. 3-18 Developers Guide for Oracle Business Intelligence Publisher 4 ReportService 4-1 4 ReportService This chapter provides details on the ReportService methods that you can use to interact with the BI Publisher Report object. This includes methods for designing and defining reports, report templates, run-time operations, and parameters. This chapter contains the following sections: ■ Section 4.1, createReport Method ■ Section 4.2, createReportInSession Method ■ Section 4.3, downloadReportDataChunk Method ■ Section 4.4, downloadReportDataChunkInSession Method ■ Section 4.5, getReportDefinition Method ■ Section 4.6, getReportDefinitionInSession Method ■ Section 4.7, getReportParameters Method ■ Section 4.8, getReportParametersInSession Method ■ Section 4.9, getReportSampleData Method ■ Section 4.10, getReportSampleDataInSession Method ■ Section 4.11, getTemplate Method ■ Section 4.12, getTemplateInSession Method ■ Section 4.13, getTemplateParameters Method ■ Section 4.14, getTemplateParameterInSession Method ■ Section 4.15, getXDOSchema Method ■ Section 4.16, getXDOSchemaInSession Method ■ Section 4.17, removeTemplateForReport Method ■ Section 4.18, removeTemplateForReportInSession Method ■ Section 4.19, runReport Method ■ Section 4.20, runReportInSession Method ■ Section 4.21, updateReportDefinition Method Note: For information on debugging applications built with BI Publisher Web services, see Section 1.3, Debugging Web Service Applications. 4-2 Developers Guide for Oracle Business Intelligence Publisher ■ Section 4.22, updateReportDefinitionInSession Method ■ Section 4.23, updateTemplateForReport Method ■ Section 4.24, updateTemplateForReportInSession Method ■ Section 4.25, updateXLIFFForReport Method ■ Section 4.26, updateXLIFFForReportInSession Method ■ Section 4.27, uploadReportDataChunk Method ■ Section 4.28, uploadReportDataChunkInSession Method ■ Section 4.29, uploadTemplateForReport Method ■ Section 4.30, uploadTemplateForReportInSession Method ■ Section 4.31, uploadXLIFFForReport Method ■ Section 4.32, uploadXLIFFForReportInSession Method

4.1 createReport Method

Use the createReport method to create a report in the BI Publisher catalog. The method enables you to set the path to the data model and supply template files and translation XLIFF files to the report definition. Signature String createReportString reportName, String folderAbsolutePathURL, String dataModelURL, String templateFileName, byte[] templateData, String XLIFFFileName, byte[] XLIFFData, boolean updateFlag, String userID, String password; Table 4–1 Parameters for createReport 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 userID Specifies the BI Publisher user name. String password Specifies the password for the user name. ReportService 4-3

4.2 createReportInSession Method