Go to main content
1/17
Contents
Title and Copyright Information
Preface
Audience
Documentation Accessibility
Related Documentation and Other Resources
Related Documentation and Other Resources
Conventions
Part I Oracle BI Publisher Web Services
1
Introduction to the BI Publisher Web Services
1.1
About BI Publisher Web Services
1.2
Accessing the WSDLs
1.3
About In-Session Methods
1.4
Debugging Web Service Applications
2
Data Types in Oracle BI Publisher Web Services
2.1
Base Data Types
2.2
XML-to-Java Data Type Mappings
2.3
Complex Data Types
2.3.1
ArrayOf_xsd_string
2.3.2
ArrayOfEMailDeliveryOption
2.3.3
ArrayOfFaxDeliveryOption
2.3.4
ArrayOfFTPDeliveryOption
2.3.5
ArrayOfItemData
2.3.6
ArrayOfJobInfo
2.3.7
ArrayOfJobOutput
2.3.8
ArrayOfJobOutputDelivery
2.3.9
ArrayOfLocalDeliveryOption
2.3.10
ArrayOfMetaData
2.3.11
ArrayOfParamNameValue
2.3.12
ArrayOfPrintDeliveryOption
2.3.13
ArrayOfString
2.3.14
ArrayOfTemplateFormatLabelValue
2.3.15
ArrayOfTemplateFormatLabelValues
2.3.16
ArrayOfWebDAVDeliveryOption
2.3.17
BIPDataSource
2.3.18
CatalogContents
2.3.19
CatalogObjectInfo
2.3.20
DeliveryChannels
2.3.21
DeliveryRequest
2.3.22
DeliveryServiceDefinition
2.3.23
EMailDeliveryOption
2.3.24
FaxDeliveryOption
2.3.25
FileDataSource
2.3.26
FTPDeliveryOption
2.3.27
ItemData
2.3.28
JDBCDataSource
2.3.29
JobDetail
2.3.30
JobFilterProperties
2.3.31
JobInfo
2.3.32
JobInfoList
2.3.33
JobOutput
2.3.34
JobOutputDelivery
2.3.35
JobOutputDeliverysList
2.3.36
JobOutputsList
2.3.37
JobStatus
2.3.38
LocalDeliveryOption
2.3.39
MetaData
2.3.40
MetaDataList
2.3.41
ParamNameValue
2.3.42
ParamNameValues
2.3.43
PrintDeliveryOption
2.3.44
ReportDataChunk
2.3.45
ReportDefinition
2.3.46
ReportRequest
2.3.46.1
Values for attributeFormat
2.3.47
ReportResponse
2.3.48
ScheduleRequest
2.3.49
TemplateFormatLabelValue
2.3.50
TemplateFormatsLabelValues
2.3.51
WebDAVDeliveryOption
3
ScheduleService
3.1
cancelSchedule() Method
3.2
cancelScheduleInSession() Method
3.3
deleteJobHistory() Method
3.4
deleteJobHistoryInSession() Method
3.5
deleteSchedule() Method
3.6
deleteScheduleInSession() Method
3.7
deliveryService() Method
3.8
deliveryServiceInSession() Method
3.9
downloadDocumentData() Method
3.10
downloadDocumentDataInSession() Method
3.11
downloadXMLData() Method
3.12
downloadXMLDataInSession() Method
3.13
getAllScheduledReport() Method
3.14
getAllScheduledReportHistory() Method
3.15
getAllScheduledReportHistoryInSession() Method
3.16
getAllScheduledReportInSession() Method
3.17
getDeliveryServiceDefinition() Method
3.18
getDeliveryServiceDefinitionInSession() Method
3.19
getDocumentData() Method
3.20
getDocumentDataInSession() Method
3.21
getScheduledJobInfo() Method
3.22
getScheduledJobInfoInSession() Method
3.23
getScheduledReportDeliveryInfo() Method
3.24
getScheduledReportDeliveryInfoInSession() Method
3.25
getScheduledReportOutputInfo() Method
3.26
getScheduledReportOutputInfoInSession() Method
3.27
getXMLData() Method
3.28
getXMLDataInSession() Method
3.29
purgeJobHistory() Method
3.30
purgeJobHistoryInSession() Method
3.31
resendScheduledReport() Method
3.32
resendScheduledReportInSession() Method
3.33
resumeSchedule() Method
3.34
resumeScheduleInSession() Method
3.35
scheduleReport() Method
3.36
scheduleReportInSession() Method
3.37
suspendSchedule() Method
3.38
suspendScheduleInSession() Method
4
ReportService
4.1
createReport() Method
4.2
createReportInSession() Method
4.3
downloadReportDataChunk() Method
4.4
downloadReportDataChunkInSession() Method
4.5
getReportDefinition() Method
4.6
getReportDefinitionInSession() Method
4.7
getReportParameters() Method
4.8
getReportParametersInSession() Method
4.9
getReportSampleData() Method
4.10
getReportSampleDataInSession() Method
4.11
getTemplate() Method
4.12
getTemplateInSession() Method
4.13
getTemplateParameters() Method
4.14
getTemplateParameterInSession() Method
4.15
getXDOSchema() Method
4.16
getXDOSchemaInSession() Method
4.17
removeTemplateForReport() Method
4.18
removeTemplateForReportInSession() Method
4.19
runReport() Method
4.20
runReportInSession() Method
4.21
updateReportDefinition() Method
4.22
updateReportDefinitionInSession() Method
4.23
updateTemplateForReport() Method
4.24
updateTemplateForReportInSession() Method
4.25
updateXLIFFForReport() Method
4.26
updateXLIFFForReportInSession() Method
4.27
uploadReportDataChunk() Method
4.28
uploadReportDataChunkInSession() Method
4.29
uploadTemplateForReport() Method
4.30
uploadTemplateForReportInSession() Method
4.31
uploadXLIFFForReport() Method
4.32
uploadXLIFFForReportInSession() Method
5
SecurityService
5.1
assignRolesToUser() Method
5.2
createRole() Method
5.3
createUser() Method
5.4
deleteRole() Method
5.5
deleteUser() Method
5.6
getBIPHTTPSessionInterval() Method
5.7
getObjectSecurityXML() Method
5.8
getSecurityModel() Method
5.9
hasObjectAccess() Method
5.10
hasObjectAccessInSession() Method
5.11
impersonate() Method
5.12
isUserExists() Method
5.13
login() Method
5.14
logout() Method
5.15
notifyBIEEPreferencesUpdated() Method
5.16
notifyBIEEPreferencesUpdatedWithString() Method
5.17
removeRolesFromUser() Method
5.18
updateRole() Method
5.19
updateUser() Method
5.20
validateLogin() Method
6
CatalogService
6.1
copyObject() Method
6.2
copyObjectInSession() Method
6.3
createFolder() Method
6.4
createFolderInSession() Method
6.5
createObject() Method
6.6
createObjectInSession() Method
6.7
deleteObject() Method
6.8
deleteObjectInSession() Method
6.9
downloadObject() Method
6.10
downloadObjectInSession() Method
6.11
downloadXLIFF() Method
6.12
downloadXLIFFInSession() Method
6.13
getFolderContents() Method
6.14
getFolderContentsInSession() Method
6.15
getObject() Method
6.16
getObjectInfo() Method
6.17
getObjectInfoInSession() Method
6.18
getObjectInSession() Method
6.19
objectExist() Method
6.20
objectExistInSession() Method
6.21
renameObject() Method
6.22
renameObjectInSession() Method
6.23
updateObject() Method
6.24
updateObjectInSession() Method
6.25
uploadObject() Method
6.26
uploadObjectInSession() Method
6.27
uploadXLIFF() Method
6.28
uploadXLIFFInSession() Method
Part II Oracle BI Publisher Java APIs
7
Using the BI Publisher Java APIs
7.1
BI Publisher Core APIs
7.2
Prerequisites
7.3
Obtaining the Libraries
7.4
PDF Form Processing Engine
7.4.1
Overview of the PDF Form Processing Engine
7.4.2
Merging a PDF Template with XML Data
7.4.3
Merging XML Data with a PDF Template Using Input/Output File Name
7.4.4
Merging XML Data with a PDF Template Using Input/Output Streams
7.4.5
Merging an XML Data String with a PDF Template
7.4.6
Retrieving a List of Field Names
7.4.7
Generating XFDF Data
7.4.8
Converting XML Data into XFDF Format Using XSLT
7.5
RTF Processor Engine
7.5.1
Pairing with XLIFF FIle
7.5.2
Generating XSL
7.5.2.1
Generating XSL with Input/Output File Names
7.5.2.2
Generating XSL with Input/Output Stream
7.6
FO Processor Engine
7.6.1
Major Features of the FO Processor
7.6.1.1
Bidirectional Text
7.6.1.2
Font Fallback Mechanism
7.6.1.3
Variable Header and Footer
7.6.1.4
Horizontal Table Break
7.6.2
Generating Output from an XML File and an XSL File
7.6.3
Generating Output Using File Names
7.6.4
Generating Output Using Streams
7.6.5
Generating Output from an Array of XSL Templates and XML Data
7.6.6
Using the XSL-FO Utility
7.6.6.1
Creating XSL-FO from an XML File and an XSL File
7.6.6.2
Creating XSL-FO from Two XML Files and Two XSL files
7.6.6.3
Merging Two XSL-FO Files
7.6.6.4
Generating Output from an FO File
7.6.6.5
Generating Output Using File Names
7.6.6.6
Generating Output Using Streams
7.6.6.7
Generating Output with an Array of FO Data
7.7
PDF Document Merger
7.7.1
Merging PDF Documents
7.7.1.1
Merging PDF Documents with Input/Output File Names
7.7.1.2
Merging PDF Documents with Input/Output Streams
7.7.1.3
Merging with Background to Place Page Numbering
7.7.1.4
Adding Page Numbers to Merged Documents
7.7.2
Setting a Text or Image Watermark
7.7.2.1
Setting a Text Watermark
7.7.2.2
Setting Image Watermark
7.8
PDF Bookbinder Processor
7.8.1
Usage
7.8.2
XML Control File
7.8.3
Command Line Options
7.8.4
API Method Call
7.9
PDF Digital Signature Engine
7.9.1
Overview of the PDF Digital Signature Engine
7.9.2
Signing PDF Documents
7.9.3
Delivering Signed PDF Documents
7.9.4
Verifying Signed PDF Documents
7.10
eText Processor
7.10.1
Converting RTF eText Templates to XSL
7.10.2
Producing Text Output for EDI and EFT Transmissions
7.10.3
Getting Sequence Numbers
7.11
Document Processor Engine
7.11.1
Hierarchy and Elements of the Document Processor XML File
7.11.2
XML File Samples
7.11.2.1
Defining two data sets
7.11.2.2
Defining multiple templates and data
7.11.2.3
Retrieving templates over HTTP
7.11.2.4
Retrieving data over HTTP
7.11.2.5
Generating more than one output
7.11.2.6
Defining page numbers
7.11.3
Invoke Processors
7.11.3.1
Invoking Processors with Input File Name
7.11.3.2
Invoking Processors with InputStream
7.12
BI Publisher Properties
7.12.1
Setting Properties
7.12.1.1
Passing Properties to the FO Engine
7.12.1.2
Passing a Configuration File to the FO Processor
7.12.1.3
Passing Properties to the Document Processor
7.13
Advanced Barcode Formatting
8
Using the Delivery Manager Java APIs
8.1
Using the Delivery Manager
8.2
Delivering Documents by E-Mail
8.2.1
Defining Multiple Recipients
8.2.2
Attaching Multiple Documents to One Request
8.2.3
Attaching HTML Documents
8.2.4
Displaying Attachments at the Top of E-Mail
8.2.5
Using a String Object as the E-Mail Body
8.2.6
Using an HTML Document as the E-Mail Body
8.2.7
Providing User Name and Password for Authentication
8.3
Delivering Your Document to a Printer
8.3.1
Printing over an HTTP Proxy Server
8.4
Delivering Your Document to a Local Printer
8.5
Delivering Your Documents to a Fax Server
8.6
Delivering Your Documents to a RightFax Server
8.7
Delivering Your Documents to a WebDAV Server
8.8
Delivering Your Document over the File Transfer Protocol (FTP)
8.9
Delivering Your Documents over Secure FTP
8.9.1
Authentication Modes
8.10
Delivering Your Documents over Hypertext Transfer Protocol (HTTP)
8.11
Delivering Documents over AS2
8.11.1
Delivery Receipt
8.11.2
Synchrony
8.11.3
Document Signing
8.11.4
Document Encryption
8.12
Delivering Documents Using an External Command
8.13
Delivering Documents to the Local File System
8.14
Direct and Buffering Modes
8.14.1
Direct Mode
8.14.2
Buffering Mode
8.15
Asynchronous Delivery Requests
8.16
Document Filter Support
8.16.1
PDF-to-PostScript Conversion Filter
8.17
Date Expression Support
8.18
Internationalization Support
8.18.1
SMTP
8.18.2
IPP
8.18.3
WebDAV
8.18.4
FTP
8.18.5
HTTP
8.19
Setting Global Properties
8.20
Adding a Custom Delivery Channel
8.20.1
Define Delivery Properties
8.20.2
Implement DeliveryRequest Interface
8.20.3
Implement DeliveryRequestHandler Interface
8.20.4
Implement DeliveryRequestFactory Interface
8.20.5
Register your custom DeliveryRequestFactory to DeliveryManager
8.21
Configuration File Support
8.21.1
Defining Multiple Servers for a Delivery Channel
8.21.2
Specifying a Default Server for a Delivery Channel
8.21.3
Supported Configuration File Properties and Elements
Part III Other Topics
9
Making a View Object Available to BI Publisher as a Data Source
9.1
Prerequisites
9.2
Configuring the Application Module
9.3
Updating web.xml
9.4
Updating weblogic.xml
9.5
Deploying the Application Module
9.6
Updating the providers.xml File
10
Setting Up After-Report Triggers
10.1
Overview of After-Report Triggers
10.1.1
Limitations
10.1.2
Process Overview for Adding After-Report Triggers to Reports
10.2
Setting Up After-Report Triggers
10.2.1
Registering the HTTP Servlet
10.2.2
Sample Program
11
Adding Extensions to the Layout Editor
11.1
Using Layout Editor Plug-in Extensions
11.2
Implementing Plug-ins
11.3
Coding the Custom Plug-in
11.3.1
Plug-in Structure
11.3.2
JavaScript APIs That Can Be Used in Custom Plug-ins
11.3.2.1
handleClickEvent Method
11.3.2.2
getPixelValue Method
11.4
Property Support
11.4.1
Predefined Properties
11.5
Samples
11.5.1
Example of Static Plug-in: Company Logo
11.5.2
Example Plug-in to Insert YouTube Video
11.6
Creating a Data Field Plug-in
Scripting on this page enhances content navigation, but does not change the content in any way.