Getting Started with XML Publisher

This chapter provides an overview of XML Publisher and discusses XML Publisher phases.

Click to jump to parent topicXML Publisher Overview

Oracle Business Intelligence Publisher (BI Publisher, formerly XML Publisher) is an enterprise reporting solution that streamlines report and form generation. A primary feature of Oracle's BI Publisher product is the separation of the data extraction process from the report layout. BI Publisher enables you to design and create report layout templates with the more common desktop applications of Microsoft Word and Adobe Acrobat, and renders XML data based on those templates. With a single template, it can generate reports in many formats (PDF, RTF, Excel, HTML, and so on) in many languages. This approach to reporting can dramatically reduce report maintenance, enabling power business users to adjust report templates without involvement of IT resources.

The following diagram illustrates the concept of BI Publisher.

BI Publisher concept

Select features of Oracle's BI Publisher product have been integrated into and enhanced for use with PeopleTools. Within PeopleSoft applications, this is referred to as XML Publisher (XMLP). This diagram illustrates PeopleSoft applications integration with BI Publisher:

BI Publisher integration with PeopleSoft applications

PeopleSoft XML Publisher has a direct Java integration to the XDO Engine and XDO Parser. The BI Publisher Desktop requires installation and can be downloaded from a PeopleSoft Pure Internet Architecture page.

Note. Not all BI Publisher features are available through the PeopleSoft implementation.

PeopleSoft Query as well as any PeopleTools based applications providing XML data are available to BI Publisher as a data source. XML Publisher for PeopleSoft Enterprise provides an environment for managing templates, data sources, reports, translations, and content components. It also offers an electronic bursting capability to produce reports according to a user-defined criteria and secure the reports using an application’s security join table. A set of PeopleCode XML Publisher classes for runtime report generation is also provided.

This diagram illustrates the XMLP components within the PeopleSoft system.

PeopleSoft XMLP components

Oracle provides a set of PeopleSoft Pure Internet Architecture pages for defining data sources, report definitions, templates, and translations and for running and viewing reports. Oracle also provides a set of PeopleCode application program interfaces (APIs) that wrap the Oracle XDO engine APIs. These APIs are used by the BI Publisher PeopleSoft Pure Internet Architecture pages and are available for advanced report developers to use for custom applications and batch processes.

Click to jump to parent topicXML Publisher Phases

XML Publisher implementation includes the following phases:

Set Up XML Publisher

To prepare your system for using XML Publisher, perform the following steps:

Step

Reference

1. Define XML Publisher settings.

See Setting Up XML Publisher.

2. Set up XML Publisher permission list security.

See Assigning XMLP Permissions to Users.

3. Set up Report Manager.

See Using Report Manager.

4. Define report categories, including Report Definition Editor security.

See Setting Up Report Categories.

5. Download design plug-ins to facilitate the offline template design activities.

See Working with Template Design Helpers.

Create and Register Data Sources

To create and register data sources, perform the following steps:

Step

Reference

1. Identify or create the source of your report data.

Data sources can be PS Query, Connected Queries, or XML files.

Note. Rowset and XML Doc object data sources have been deprecated. Rowset and XML Doc object data sources created in previous releases will continue to be supported.

To generate XML files from XML Doc or rowsets, refer to PeopleCode API documentation.

See XML Publisher Classes.

See Creating and Running Simple Queries, Creating Data Sources.

2. Register schema and sample data files for XML Publisher data sources.

For PS Query, you can automatically generate schema file and sample data.

Note. Schema is no longer used for bursting starting in PeopleTools 8.50. It is still available for backwards compatibility.

See Registering Data Sources.

Create and Upload Report Templates

To create and upload templates, perform the following steps:

Step

Reference

1. Create and upload schema and sample data.

See Creating Data Sources.

2. Download sample data from the appropriate data source to facilitate template design.

See Defining Reports.

3. Use either Microsoft Word or Adobe Acrobat to develop and maintain custom report formats.

See Understanding Report Template Types.

4. (Optional) Create and maintain reusable sub-template definitions.

See Maintaining Sub-Templates.

5. (Optional) Register translation XLIFF files for report templates and Content Library sub-templates.

See Maintaining Template Translations.

Define XML Publisher Reports

To create and maintain report definitions, perform the following step:

Step

Reference

1. Define reports by associating data sources with layout template files.

See Defining Reports.

Run, Locate, and View XML Publisher Reports

You can run XML Publisher reports online or in batch through the Process Scheduler. For query-based reports, pages are available for running the reports both online and in batch. To run XML Publisher reports, perform the following steps:

Step

Reference

1. Schedule Query-based XML Publisher reports.

See Scheduling Reports in Query Report Scheduler.

2. Schedule other XML Publisher reports.

Note. You will need to create an application engine program using XMLP PeopleCode APIs.

See Running Reports Using PeopleCode.

3. View Query-based XML Publisher reports online in real time.

See Running Reports in Query Report Viewer.

4. View other XML Publisher reports online in real time.

See Running Reports Using PeopleCode.

5. Locate XML Publisher reports using enhanced search criteria.

See Searching the XML Publisher Report Repository, Search Operator Values.

6. View XML Publisher reports in the Report Manager.

See Viewing Reports.