XML Publisher (Peoplesoft)

THESE eKIT MATERIALS ARE FOR YOUR USE IN THIS CLASSROOM ONLY.
COPYING eKIT MATERIALS FROM THIS COMPUTER IS STRICTLY PROHIBITED
1.0
D65529
D61562GC10
February 2010
Student Guide
Rel 8.50 Ed1
Enterprise PeopleTools
XML Publisher for PeopleSoft
Oracle University and Businessmind Colombia SA use only

THESE eKIT MATERIALS ARE FOR YOUR USE IN THIS CLASSROOM ONLY. COPYING eKIT MATERIALS FROM THIS COMPUTER IS STRICTLY PROHIBITED
Copyright © 2009, Oracle and/or its affiliates. All rights reserved.

This document contains proprietary information and is protected by copyright and other intellectual property laws. You may copy and
print this document solely for your own use in an Oracle training course. The document may not be modified or altered in any way.
Except where your use constitutes "fair use" under copyright law, you may not use, share, download, upload, copy, print, display,
perform, reproduce, publish, license, post, transmit, or distribute this document in whole or in part without the express authorization of
Oracle.
The information contained in this document is subject to change without notice. If you find any problems in the document, please report
them in writing to: Oracle University, 500 Oracle Parkway, Redwood Shores, California 94065 USA. This document is not warranted to
be error-free.
If this documentation is delivered to the United States Government or anyone using the documentation on behalf of the United States
Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS
The U.S. Government's rights to use, modify, reproduce, release, perform, display, or disclose these training materials are restricted by
the terms of the applicable Oracle license agreement and/or the applicable U.S. Government contract.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
Contents
Lesson 1
Course Overview ............................................................................................................................................. 1
Agenda ............................................................................................................................................................... 2

Lesson 2
Technology Overview ...................................................................................................................................... 5
Describing XML Publisher ............................................................................................................................... 6
Describing XML Publisher Phases .................................................................................................................. 11
Describing Optional Features .......................................................................................................................... 13
Describing Sources of Information about XML Publisher for PeopleSoft Enterprise in PeopleBooks .......... 15
Lesson 3
Setting Up XML Publisher ........................................................................................................................... 19
Defining Properties and Fonts ......................................................................................................................... 20
Setting Up XML Publisher Permissions ......................................................................................................... 26
Setting Up Report Manager ............................................................................................................................. 30
Defining Report Categories ............................................................................................................................. 33
Downloading Design Plug-ins ......................................................................................................................... 35
Activity 1: Setting Up XML Publisher ............................................................................................................ 37
Lesson 4
Creating and Registering Data Sources ...................................................................................................... 43
Describing Data Sources ................................................................................................................................. 44
Creating Query-Based Data Sources ............................................................................................................... 47
Activity 2: Creating Query Data Source ......................................................................................................... 52
Creating XML File Data Source ..................................................................................................................... 58
Registering XML File Data Sources ............................................................................................................... 60
Activity 3: Registering XML File Data Source ............................................................................................... 62
Lesson 5
Creating Templates ....................................................................................................................................... 67
Describing Template Types ............................................................................................................................. 68
Creating RTF Templates ................................................................................................................................. 70
Activity 4: Creating RTF Template ................................................................................................................. 78
Using Table Wizard ......................................................................................................................................... 83
Activity 5: Designing RTF Template with a Table ......................................................................................... 86
iii
Contents
Working with PDF Templates ......................................................................................................................... 91
Lesson 6
Defining XML Publisher Reports ................................................................................................................ 95
Creating a Report Definitions .......................................................................................................................... 96
Associating Templates .................................................................................................................................. 100
Defining Report Output ................................................................................................................................. 103
Setting Report Properties ............................................................................................................................... 106
Setting Report Viewing Security ................................................................................................................... 107

Activity 6: Creating Report Definitions ........................................................................................................ 109
Creating a Report Definition Based on PDF Template ................................................................................. 114
Activity 7: Creating Report Definition Using PDF Template ....................................................................... 119
Bursting Reports ............................................................................................................................................ 125
Activity 8: Adding Bursting .......................................................................................................................... 132
Lesson 7
Running and Viewing Query-Based XML Publisher Reports ................................................................ 139
Running Reports in Query Report Viewer .................................................................................................... 140
Scheduling PS Query Reports ....................................................................................................................... 142
Locating and Viewing XML Publisher Reports ............................................................................................ 149
Activity 9: Running Query Reports ............................................................................................................... 155
Using Reporting Console .............................................................................................................................. 161
Activity 10: Setting Up and Using Reporting Console ................................................................................. 167
Lesson 8
Implementing Sub-Templates and Template Translations ..................................................................... 175
Creating Reusable Sub-Template Definitions ............................................................................................... 176
Activity 11: Adding a Sub-Template ............................................................................................................ 181
Using Content Library ................................................................................................................................... 185
Activity 12: Registering Sub-Template ......................................................................................................... 187
Maintaining Template Translations ............................................................................................................... 192
Activity 13: Using Translations .................................................................................................................... 199
Lesson 9
Using Additional RTF Techniques ............................................................................................................ 207
Using Connected Query Data Source ............................................................................................................ 208
Activity 14: Creating a Template Using Connected Query Data Source ...................................................... 216
Using Time Zones ......................................................................................................................................... 223
Activity 15: Creating a Report with Time Zones .......................................................................................... 227
Using Drilling URL Query ............................................................................................................................ 233
Activity 16: Creating an XML Publisher Report with a Query Drilling URL .............................................. 236
iv
Contents
Lesson 10
Running Reports Using PeopleCode .......................................................................................................... 245
Running Reports Using PeopleCode ............................................................................................................. 246
Activity 17: Running Reports from PeopleCode .......................................................................................... 258
Running Reports from Application Engine ................................................................................................... 263
Activity 18: Creating Application Engine Program ...................................................................................... 270
Creating Application Engine to Create File and Run Report ........................................................................ 276
Activity 19: Running XMLP Report from Application Engine .................................................................... 281

Lesson 11
Course Review ............................................................................................................................................. 289
Describing XML Publisher ........................................................................................................................... 290
Setting Up XML Publisher for PeopleSoft Applications .............................................................................. 291
Creating and Registering Data Sources ......................................................................................................... 292
Creating Templates ........................................................................................................................................ 293
Defining XML Publisher Reports ................................................................................................................. 294
Running and Viewing XML Publisher Reports ............................................................................................ 295
Appendix A
Supplemental Information .......................................................................................................................... 297
Contents ......................................................................................................................................................... 297
XMLP Tables ................................................................................................................................................ 297
Migrating XMLP Definitions ........................................................................................................................ 299
Cleaning Up XML Publisher Metadata ......................................................................................................... 300
v

Lesson 1
Course Overview
Note. The appearance of the page shots in the guide may not always match the training environment. This is

due to updates that have been applied to the training environment after the course guide was released. The
functionality of the software has not changed.
Objectives
By the end of this course, you will be able to:
• Describe XML Publisher.
• Set up XML Publisher for PeopleSoft applications.
• Create and register data sources.
• Create templates.
• Define XML Publisher reports.
• Run and view XML Publisher reports.
Slide 3
1
Course Overview Lesson 1
Agenda
Day One
On day one, we will provide an overview of XML Publisher and discuss these topics:
• Setting up XML Publisher for PeopleSoft applications
• Creating and registering data sources

• Creating templates
• Defining XML Publisher reports
• Running and viewing Query-based XML Publisher reports
Slide 4
2
Lesson 1 Course Overview
Agenda (continued)
Day 2
On day two, we discuss these topics:
• Running and viewing Query-based XML Publisher reports (continued)
• Implementing sub-templates and template translations

• Using additional RTF techniques
• Running reports using PeopleCode
Slide 5
3

Lesson 2
Technology Overview
Objectives

By the end of this lesson, you will be able to:
• Describe the XML Publisher phases.
• Describe optional features.
• Describe sources of information about XML Publisher.
Slide 7
5
Technology Overview Lesson 2
Describing XML Publisher
XML Publisher
XML Publisher (XMLP):
• Is a standalone Java-based reporting technology that streamlines report and form generation.
• Provides the ability to design and create report layouts in Microsoft Word and Adobe Acrobat.

• Handles translation as separate template files.
• Provides a choice of output formats.
Slide 8
Student Notes
Benefits of XML Publisher

XML Publisher extends the value of PeopleSoft Enterprise applications by:
• Allowing business users to rapidly create rich production reports.
• Empowering business users to leverage application data to create correspondence using desktop tools.
• Enabling government form templates to be downloaded and published with application data.
6
Lesson 2 Technology Overview
Describing XML Publisher (continued)
XML Publisher Overview

A primary feature of Oracle's XML Publisher product is the separation of the data extraction process from the
report layout:

Slide 9
Student Notes
XML Publisher Overview

XML Publisher for PeopleSoft Enterprise is a template-based reporting solution that separates the data
extraction process from the report layout and allows the reuse of extracted application data into multiple
report layouts. The XMLP engine combines the xml data with the template.
Data Logic
Power users can create data using PS Query and Connected Queries, all other types of data extraction logic
should be handled and maintained by development teams. The only requirement for the data is that is must be
well formed XML.
Layout Template
XML Publisher provides the ability to design and create report layout templates using common desktop
applications 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 Information Technology resources.
7
Translation
For RTF templates, a template translation feature is available. The Template Translation feature is based upon
standard Localization Interchange File Format (XLIFF) .xlf file processing. Each report template or sub-
template file can have related translation XLIFF files. These XLIFF files include translation units for each
content element to be translated.
8
Reporting Tools
PeopleSoft offers a wide-variety of reporting tools, which tool you use depends on the data and format. This
table lists some considerations:
Reporting Tools When to consider XML Publisher instead:

Crystal Reports Close to XML Publisher in functionality.
Consider XML Publisher for new reports.
nVision Consider XML Publisher instead of nVision tabular layouts.

Excel is supported as output type.
SQR Using Application Engine for data logic and XML Publisher for publishing,
you can take advantage of bursting capabilities.
Slide 10
Student Notes
Reporting Options
XML Publisher provides an additional reporting tool option for PeopleSoft Enterprise users. This does not
mean that existing reports need to be rewritten, but that you should use XML Publisher for new custom
reports to take advantage of the flexibility and reduced maintenance, as well as the bursting capabilities.
Some examples of when to use XML Publisher include:
• General Ledger - an alternative to Crystal for reports containing chartfields, no customization is required
after chart of accounts configuration.
• Billing - provides a third print option for invoices.
• CRM - provides improvements to correspondence management.
• HCM - Government forms, paychecks, offer letter generation.
9
XML Publisher Components

This diagram illustrates the XMLP components within the PeopleSoft system:

Slide 11
Student Notes
XML Publisher 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 PeopleSoft Pure Internet Architecture pages and are available for advanced report developers to use
for custom applications and batch processes.
10
Describing XML Publisher Phases
Phases
XML Publisher implementation can be divided into the following phases:

Slide 12
Student Notes
Phase 1: Set Up XML Publisher

1. Define XML Publisher settings.
2. Set up XML Publisher permissions.
3. Set up Report Manager.
4. Define report categories.
5. Download design plug-ins to facilitate the offline template design activities.
Phase 2: Create and Register Data Sources

1. Identify or create the source of your report data.
2. Register sample data files.
11
Phase 3: Create Report Templates

1. Use well- known technologies and tools like Microsoft Word and Adobe Acrobat to develop and maintain
report templates, based on sample data files.
2. (Optional) Create and maintain reusable sub-template definitions.
3. (Optional) Register translation XLIFF files for report templates and Content Library sub-templates.
Phase 4: Define XML Publisher Reports

1. Select data source.
2. Upload report template.
3. Add additional features such as bursting and translations.
Phase 5: Run and View XML Publisher Reports

1. Schedule other XML Publisher reports.
2. View Query-based XML Publisher reports online real-time.
3. View other XML Publisher reports online real-time.
4. Locate XML Publisher reports enhanced search criteria.
5. View XML Publisher reports in the Report Manager.
12
Describing Optional Features
Bursting
Bursting can be used for security and for distribution. This is an example of distributing paychecks by
employee or department:

Slide 13
Student Notes
Bursting
Bursting is an optional advanced feature that is only available when reports are run through Process Scheduler
and is not intended for real-time online viewing. It is typically used when you are repeating the generation of
a templated report layout many times for multiple like sets of data. For example, generating a batch run on
paychecks. With bursting, you can generate individual report files resulting in separate secured output. For
example, generating a file for each employee and department.
13
Describing Optional Features (continued)
Translations
Translation files allow you to use the same RTF template and translate the data based on specified criteria:

Slide 14
Student Notes
Template Translation
The Template Translation feature is based upon standard Localization Interchange File Format (XLIFF) .xlf
file processing. Each report template or sub-template file can have related translation XLIFF files. These
XLIFF files include translation units for each content element to be translated. The translatable units include
all the fixed verbiage of the template excluding any values supplied by the data source.
14
Describing Sources of Information about XML Publisher for

PeopleSoft Enterprise in PeopleBooks
Development Information
Use the Enterprise PeopleTools 8.50 PeopleBook: XML Publisher for PeopleSoft Enterprise to find
development information, including:

• Setting up XML Publisher.
• Creating and registering data sources.
• Creating report templates.
• Defining XML Publisher reports.
• Running and viewing XML Publisher reports.
Slide 15
Student Notes
This table lists the locations of additional information in the Enterprise PeopleTools 8.50 PeopleBook: XML
Publisher for PeopleSoft Enterprise:
15
Location Type of Information
Getting Started with XML This chapter provides an overview of XML Publisher and discusses XML
Publisher Publisher phases.
Setting Up XML Publisher This chapter discusses how to:

• Prepare to use XML Publisher.
• Set up XML Publisher.
Creating and Registering Data This chapter discusses how to:

Sources
• Create data sources.
• Register data sources.
Creating Report Templates This chapter discusses how to:

• Select report template type.
• Use RTF templates.
• Use PDF templates.
Defining Report Definitions This chapter discusses how to:

• Create report definitions.
• Use the Content Library to maintain sub-templates.
• Maintain template translations.
Running and Viewing XML This chapter discusses how to:

Publisher Reports
• Run XML Publisher PeopleSoft Query reports.
• Run reports using PeopleCode.
• Run reports in Process Scheduler.
• Locate and view XML Publisher reports.
You can access related material by clicking the Help link in the top-right corner of the application page. This
link automatically takes you to the relevant information in the appropriate PeopleBook.
16
Describing Sources of Information about XML Publisher for

PeopleSoft Enterprise in PeopleBooks (continued)
Use the Oracle Business Intelligence Publisher User's Guide, Release 10.1.3.2 to find information including:
• Setting runtime properties.

• Creating RTF templates.
• Creating PDF template.
Slide 16
Student Notes
Additional Resources
This table describes the additional PeopleBooks that contain information about PeopleSoft Application
Designer and application development using PeopleTools:
17
Location Type of Information
Setting Runtime Properties This chapter includes information on how to set properties in a configuration
file and a list of properties.
Creating RTF Templates This chapter includes information for creating your RTF templates,
including:
• Designing the template layout
• Adding markup to the template layout
• Defining headers and footers

• Images and charts
• Supported native formatting features
• Template features
• Conditional formatting
Creating PDF Templates This chapter includes information for creating your PDF templates,
including:
• Designing the layout
• Adding markup to the layout
• Adding page numbers and page breaks
• Performing calculations
18
Lesson 3
Setting Up XML Publisher
Objectives

• Define properties and fonts.
• Set up XML Publisher permissions.
• Set Up Report Manager.
• Define report categories.
• Download design plug-ins.
Slide 18
19
Setting Up XML Publisher Lesson 3
Defining Properties and Fonts
XML Publisher Properties

There are two types of properties used in XML Publisher:
• System Properties

System level properties are set in the xdo.cfg file.
• Non-system Properties
Non-system or functional properties are set in PeopleSoft Pure Internet Architecture or through PeopleCode
(setRuntimeProperties).
Slide 19
Student Notes
Property Definition Levels

There are four levels where properties are defined, this table lists the levels:
Level Description Location
System properties and fonts System properties and fonts xdo.cfg file
Global properties Global properties are shared by all Reporting Tools, XML Publisher,
reports and override the xdo engine Setup, Global Properties
default property values.
Report properties Properties are defined in the report Reporting Tools, XML Publisher,
definition and override global Report Definition, Properties
properties for a single report.
Runtime properties Override report properties. Runtime properties are set at runtime
through
ReportDefn.SetRuntimeProperties
PeopleCode API
20
Lesson 3 Setting Up XML Publisher
Defining Properties and Fonts (continued)
Setting System Level Properties

System level properties are set in the xdo.cfg file. System level properties include:
• xslt-parser
• xslt-scalable

• system-cachepage-size
• system-temp-dir
• fonts
Slide 20
Student Notes
Configuration File xdo.cfg

XML Publisher system properties settings are defined in the xdo.cfg file. The default xdo.cfg file is located in
the $PSHOME/appserver directory, which is shared by all application server and process scheduler domains
by default.
Setting System Temp Directory

By default, the system-temp-dir property is not set. This property must be set to point to a temp folder on the
server. Note that temporary files created in that directory could grow very large in size depending on the size
of your reports, so you need to choose your system-temp-dir for optimum system performance.
Note. If this property is not set, a warning will be displayed in the log: WARNING: 'system-temp-dir' property
is not defined in xdo.cfg and the default directory that will be used is the domain/files/xmlp directory. Consult
your system administrator for the right location.
Example xdo.cfg file:
21
<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">
<properties>

<property name="xslt-xdoparser">true</property>
<property name="xslt-scalable">true</property>
<property name="system-cachepage-size">50</property>
<property name="system-temp-dir"></property>
</properties>





</config>
Application Server or Process Scheduler Domain-Specific xdo.cfg File

To specify an application server or process scheduler domain-specific xdo.cfg file, you need to change the
application server or process scheduler configuration file to update the JavaVM Options -Dxdo ConfigFile
setting.
For example, to specify a separate xdo.cfg file for application server domain P8488041, change the
[PS_HOME]/appserv/P8488041/psappsrv.cfg file as indicated below and put the new xdo.cfg into the
[PS_HOME]/appserv/P8488041 directory.
Original line in psappsrv.cfg:

JavaVM Options=-Xrs -Dxdo.ConfigFile=%PS_HOME%/appserv/xdo.cfg
New line in psappsrv.cfg:

JavaVM Options=-Xrs -Dxdo.ConfigFile==%PS_HOME%/appserv/P8488041/xdo.cfg
22
Copying Fonts
XMLP Core engine uses default fonts when the corresponding fonts are not available on the system for a
particular report template. The engine looks for these fonts under PS_HOME\JRE\lib\fonts folder.
The default fonts are included in BI Publisher Desktop and need to be copied to the JRE directory. The fonts

are located under the Desktop Publisher installation folder, the default is:
C:\Program Files\Oracle\BI Publisher\BI Publisher Desktop\Template
Builder for Word\fonts
Slide 21
Student Notes
Copying Fonts
The following files need to be copied to the PS_HOME/JRE/LIB folder:
• ALBANWTJ.ttf
• ALBANWTK.ttf
• ALBANWTS.ttf
• ALBANWTT.ttf
• ALBANYWT.ttf
23
Global Properties
The following property groups are available:
• PDF Output
• FO Processing

• HTML Output
• PDF Security
• PDF Template
• RTF Output
• RTF Template
Slide 22
Student Notes
Page Used to Set Global Properties
Page Name Navigation
Global Properties Reporting Tools, XML Publisher, Setup, Global Properties
See Oracle Business Intelligence Publisher User's Guide, Setting Runtime Properties
24
Editing PDF Output

In previous releases the ability to edit PDF output was defined on the Report Definition Output page using the
PDF report output may be edited check box. Starting with PeopleTools 8.50, the set properties pdf-no-
changing-the-docment and pdf-security are set either on the Global Properties page for all reports or on the
Report Properties page for a specific report.
To allow editing of PDF reports, the properties for the property group PDF Security should be set as follows:
Property Value

pdf-security True
pdf-encryption-level 0
pdf-no-changing-the-document False
25
Setting Up XML Publisher Permissions
XML Publisher Permissions

This table lists the PeopleTools delivered permission lists and roles for XML Publisher:
Permission List Role Intended for:

PTPT2600 XMLP Report Developer Report developers
PTPT2500 XMLP Power User Power user
Slide 23
Student Notes
Page Used to Define Component Permissions
Component Permissions PeopleTools, Security, Permission Lists & Roles, Permission Lists, PTPT2600,
Pages, Edit Components
Use this page to review the permission list components:
26

The permission list PTPT2500 does not include permission to the following components:
• Data source
• Report category
• Template translations
Page Used to Define Permission Lists Assigned to a Role
Permission Lists PeopleTools, Security, Permissions & Roles, Roles, XMLP Report Developer,
Permission Lists
Use this page to review the permission lists for a role:
Page Used to Assign a Role to a User Profile
Roles PeopleTools, Security, User Profiles, User Profiles, PTXMLP, Roles
Use this page to assign a role to a user profile:
27
28
Lesson 3

Setting Up XML Publisher Permissions (continued)
XML Publisher Security

XML Publisher security can be separated into three categories:
• Defining reports.
• Editing and viewing report definitions.

• Running and viewing reports.
Slide 24
Student Notes
Defining Reports
When defining Query-based reports, Query security determines which queries you have access to and can
select from to create your XML Publisher report definitions.
Editing and Viewing Report Definitions

Security for editing and viewing report definitions is controlled by the Report Category ID attribute, which is
set on the Reporting Tools, XML Publisher, Setup, Report Category page.
Running and Viewing Reports

Application security and Process Scheduler security determine who can run reports. XML Publisher does not
provide additional security beyond what Oracle currently provides. That means that the component security
of the data extraction program drives access control to the associated reports. For processes, process security
prevails and for queries, query security prevails. When you are running a Query-based report, the requester's
row-level security to the underlying data source always applies.
Query-based reports viewed online in real time from the Query Report Viewer respect query access groups
for the user's primary permission list. For non-Query-based reports viewed online in real time, security is
controlled by the application.
When you are viewing a report that was run through either the Query Report Scheduler or the Process
Scheduler, security is controlled by both the Distribution ID field on the Report Definition, Security page and,
when the Allow viewer ID assignment at report runtime check box is selected, by those IDs selected at
runtime on the Process Scheduler Request, Distribution Detail page. Additional viewing security can also be
defined for bursted reports on the Report Definition, Bursting page.
29
Setting Up Report Manager
Report Manager
Report Manager provides several different methods of viewing reports, based on the level of access granted.
Folders are provided to assist in organizing reports and reducing the size of the report lists.

Slide 25
Student Notes
Page Used to Create Report Folders
Report Folder Administration PeopleTools, Process Scheduler, System Settings, Report Folder Administration
Use the Report Folders Administration page to create folders for organizing reports in Report Manager.
30
Setting Up Report Manager (continued)
Distributing Reports
The Distribution Agent determines the report folder in which the report is viewed in Report Manager using
the following rules:

Slide 26
Student Notes
Distribution
The Distribution Agent determines the report folder in which the report is viewed in Report Manager using
the following rules:
• The report folder was specified when the request was scheduled, either through the Process Request Dialog
page or the PeopleCode Process Request class.
• If the report folder was not specified when the process request was scheduled, the Distribution Agent
verifies whether a folder was set in the process definition.
• If the report folder was not specified when the process request was scheduled or in the process definition,
the Distribution Agent assigns the default folder that is specified in the Report Folder Administration page.
31
Setting Up Report Manager (continued)
Report Manager Roles

This table lists the roles for Report Manager:
Roles User can:

ReportDistAdmin Can access and update any report including:
• Change the distribution list by adding or deleting a user or role ID.
• Delete a report from Report Manager.
• Alter the report's expiration date.
ReportSuperUser Can update only reports they are authorized to view including:
• Delete the report entry
• Update the distribution list or expiration date of report entries.
Slide 27
Student Notes
Report Manager Administration

The difference between the administrator (ReportDistAdmin) and super user (ReportSuperUser) roles is that
the administrator role can access and update any report in the Report Manager. The super user role can update
only reports that they are authorized to view.
32
Defining Report Categories
Report Category
Report Category is a required attribute on all report definitions and Content Library sub-templates. By
assigning a report category, you are actually applying row level security to edit and view the report definition.

Slide 28
Student Notes
Page Used to Set Up Report Categories
Report Category Reporting Tools, XML Publisher, Setup, Report Category
Use this page to set up report categories:
33
34
Lesson 3

Downloading Design Plug-ins
Plug-in for Microsoft Word

Template Builder is a Microsoft Word plug-in used to:
• Facilitate creating RTF templates offline in Word by loading sample data.
• Facilitate the insertion of application data tag placeholders into your templates.

• Preview your template offline during the design process, using sample data.
Slide 29
Student Notes
Template Builder
PeopleTools 8.50 is delivered with BI Publisher Desktop that includes Template Builder 10.1.3.4.1.
You can also available as a free download from Oracle Technical Network (OTN).
See http://www.oracle.com/technology/software/products/publishing/index.html
Design Helper
Design Helper Reporting Tools, XML Publisher, Setup, Design Helper
Use this page to download the plug-in for Microsoft Word:
Downing Loading and Setting Up Template Designer

When you select the Plug-in for Microsoft Word, you can either save or open the xmlp_desktop.zip file.
After unzipping the xmlp_desktop.zip file, select BIPublisherDesktop.exe.
The Setup wizard will guide you through the installation.
35
36
Microsoft Word Example

Microsoft Word will include the toolbar for Template Builder:
Lesson 3

Activity 1: Setting Up XML Publisher

In this activity, you will review the activity overview and:
• Set up a report folder.
• Set up a report category.
• Install Template Builder.

Slide 30
37
Activity Overview
In this activity, your will set up your system for XML Publisher. Perform the following tasks:
• Set up a report folder.
Set up a new report folder STUDENT to use as the default in this course.
• Set up a report category.
Set up a new report category XMLP_TRAINING and give access to the role PSU Technical Student.

• Install Template Builder.
Note. Use the T1B85001 database with PTXMLP for the user name and password in this activity.
38
Activity Detailed Steps

Perform the detailed steps to complete the activity.
Setting up a Report Folder

To set up a report folder:
1. Double-click the PSU Training- B Database icon on the desktop and sign on with User Id PTXMLP and
password PTXMLP.

2. Select PeopleTools, Process Scheduler, System Settings, Report Folders Administration.
3. Select the + icon to add a new row.
4. Enter the following information:
Page Element Value or Status
Folder Name STUDENT
Description Student Reports
5. Select TRAINING as the default folder.
6. Save the page.
Setting up a Report Category

To set up a report category:
1. Select Reporting Tools, XML Publisher, Setup, Report Category.
2. Select Add a New Value.
3. Enter XMLP_TRAINING for the Report Category ID and click Add.
Description XMLP Training
Object Owner ID PeopleSoft University
ID Type Role
Security ID PSU XMLP Training
5. Click Save.
39
Installing Template Builder

To install Template Builder:
1. Select Reporting Tools, XML Publisher, Setup, Design Helper.
2. Click the Plug-in for Microsoft Word (requires 2000 or later) link.
3. Click Save.
4. Select C:\Labs\XMLP for the location and click Save.

5. When the download is complete, navigate to C:\Labs\XMLP in Windows Explorer.
6. Right-click on xmlp_desktop.zip and select 7–Zip, Extract Here.
7. Navigate to C:\Labs\XMLP\XMLP_DESKTOP and double-click BIPublisherDesktop.exe.
8. Select English for the language and click Next.
9. Click Next on the Welcome menu.
10. Click Next on the Choose Destination Location window.
Install will begin.
11. Click Finish on the InstallShield Wizard Complete window.
12. Select Start, Programs, Oracle BI Publisher Desktop, BI Publisher User Guide.
Note. If prompted to enter your initials, click OK.
13. Review the table of contents.
14. Close Adobe Acrobat.
15. Select Start, Programs, Oracle BI Publisher Desktop, Template Builder for Word Tutorial.
16. Review the tutorial and close Microsoft Word.
Results
The Template Builder toolbar will appear in Word, with the tutorial:
40
THESE eKIT MATERIALS ARE FOR YOUR USE IN THIS CLASSROOM ONLY. COPYING eKIT MATERIALS FROM THIS COMPUTER IS STRICTLY PROHIBITED Lesson 3
This concludes the activity. Please do not continue.

41
Review
In this lesson, you learned that:
• You can customize the behavior of XML Publisher by setting properties.
• Two roles are delivered for XML Publisher, XMLP Report Developer and XMLP Power User.
• Report Manager is used to organize reports on folders.

• Report categories are used to supply low-level security for reports.
• The design plug-in facilitates creating RTF templates offline in Microsoft Word.
Slide 31
Student Notes
This table lists additional resources that provide more details about the topics that we discussed in this lesson:
Topic Cross-Reference
Defining XML Publisher Settings Oracle XML Publisher Core Components Guide, "Setting
Runtime Properties"
Defining XML Publisher Settings Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
for PeopleSoft Enterprise,"Setting Up XML Publisher"
Setting Up XML Publisher Permissions Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
for PeopleSoft Enterprise,"Understanding XML
Publisher"
Setting Up Report Manager Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft

Process Scheduler,"Using Report Manager"
Defining Report Categories Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

Downloading Design Plug-ins Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

42
Lesson 4
Creating and Registering Data Sources
Objectives

• Describe data sources.
• Create query-based data sources.
• Create XML file data source.
• Register XML file data sources.
Slide 33
43
Creating and Registering Data Sources Lesson 4
Describing Data Sources
Data Sources
XML Publisher supports the following data sources:
• PeopleSoft Query
• Connected Query

• XML file
Slide 34
Student Notes
Understanding Data Sources

This table provides guidelines on which type of data source to use:
Data Source Type Guideline
PS Query Reporting queries are essentially the same as user queries, except that they are
designed to be used by another reporting tool.
XML File The Extended Markup Language (XML) is a method for putting structured data in a
text file. Like HTML, XML uses tags, that is, text delimited by brackets (< and >).
However, HTML specifies what each tag is, and how it's supposed to be displayed
in a browser. XML uses tags only to delimit data. The interpretation of that data is
entirely up to the application.
Connected Query Connected Query processing creates a hierarchical output where a single row of
data from parent query results in a set of rows in a child query. This data is
processed row by row and produces structured data.
44
Lesson 4 Creating and Registering Data Sources
Describing Data Sources (continued)
Data Generation
XML data can be generated using any means including PS/Query, Connected Query, SQR, Application
Engine, PeopleCode, File Layout and so forth.

Slide 35
Student Notes
Data Extraction
XMLP can register PS/Query,Connected Query and XML file as a data source, but XML data can be
generated using any means including PS/Query, SQR, Application Engine, PeopleCode, File Layout and so
forth. If you are not using PS/Query or Connected Query, you can use XML File as a data source for all other
means of data generation.
45
Describing Data Sources (continued)
XML File
This diagram illustrates that internally PS/Query and Connected Query data sources will be converted to
XML files before passing them to the core formatting engine.

Slide 36
Student Notes
Performance Enhancements
In PeopleTools 8.50, the XML data generation for query-based data sources is done in C++ which provides
better performance and less memory usage.
Considerations
Consider these points when determining which type of data source to use:
• XML file is the preferred data source type for large reports.
• Consider defining bursting fields in your XML data.
• Design your data source XML structure to be as close as possible to the actual report template structure.
46
Creating Query-Based Data Sources
PS Query and Connected Query

Query-based data sources and sample data files are automatically generated:

Slide 37
Student Notes
PS Query Data Source

Any user query or connected query can be used as a data source, however you may want to create queries
specifically for reporting. You can use Public or Private queries.
Query-based data sources provide the following benefits:
• Metadata-driven, easiest to maintain.
• Empower business users for self-service.
• Query security is enforced when the report is run.
• A sample XML file and schema are automatically generated.
47
Creating Query-Based Data Sources (continued)
PS Query Data Source

Use the Register Data Source page with PS Query data source to:
• Generate the sample data file.
• Download the sample data file to facilitate RTF template creation.

For PS Query or Connected Query, you can upload a sample data file if you would prefer to use a sample data
file with more realistic data.
Slide 38
Student Notes
Page Used to Register a Query Data Source
Data Source Reporting Tools, XML Publisher, Data Source, Add a New Value
Use this page to generate or upload a sample data file:
Note. When creating a report definition, you can select a PeopleSoft Query data source that has not yet been
registered and that data source is registered automatically once the report definition is saved.
48
Generate Sample Data File

This is an example of a generated PS Query sample data file:

Note. XMLP Power Users do not have access to the Data Source component. In order to save a sample data
file, they will use the Report Definition page. XMLP Report Developers can save the sample data file by
selecting the appropriate save option from their browser.
49
Creating Query-Based Data Sources (continued)
Connected Query Data File

To run a connected query to a file:
1. Select Reporting Tools, Connected Query, Schedule Connected Query.

2. Add a new Run Control.
3. Select the Connected Query and enter any prompts if applicable.
4. Click Run.
5. Select Output Type of File.
6. Enter the Output Destination.
Slide 39
Student Notes
Creating Connected Query Data File

On the Process Scheduler Request page, select File for the output type.
You can use this file as a sample data file to create an RTF template for your report.
CDATA
Files created using Connected Query, will include a CDATA (Character Data) section.
Using CDATA sections in xml documents serves the purpose of avoiding XML parsing while processing
XML data. CDATA is used in Connected Query and XMLP to allow data to contain illegal (from the XML
prospective) characters. Illegal characters may be non-English alphabet characters as well as non Alpha
characters like %, ', & , and so forth.
50
51
Activity 2: Creating Query Data Source

In this activity, you will review the activity overview and create a new query to use with XML Publisher.
1. Create a new query to use with XML Publisher
2. Register a PS/Query data source.
3. Register a Connected Query data source.

4. Create a Connected Query data source sample file.
Slide 40
52
Activity Overview
In this activity, you will:
1. Create a new public query for course listings, name the query XMLP_COURSE_LIST.
Use the following information to create the query:
Definitions Names

Record PSU_COURSE_TBL
Fields COURSE
DESCR
COURSE_TPE
LENGTH_DAYS
TRAINING_UNITS
ONSITE
APP_REL
TOOLS_REL
Labels A.COURSE - RFT Long

A.DESCR - RFT Long
A.COURSE_TYPE - long for translate values
2. Register the query XMLP_COURSE_LIST as a data source, generate, view, and save the sample file.
3. Register the Connected Query ENROLLMENT_BY_BU as a data source, generate and view the sample
data file.
4. Create a Connected Query data source sample file by running the ENROLLMENT_BY_BU with the
parameters listed below to the file C:\Labs\XMLP\Files\cq_enroll_sample.xml.
Unit NAM01
Start Date 01/01/2010
Note. Use PTXMLP for the user name and password in this activity.
53

Creating a New Query

To create a new query:
1. Select Reporting Tools, Query, Query Manager.

2. Click Create New Query link.
3. Select PSU_COURSE_TBL for the record.
4. Click Add Record.
5. Click OK for Effective-Dated criteria.
6. Select the following fields:
• COURSE
• DESCR
• COURSE_TYPE
• LENGTH_DAYS
• TRAINING_UNITS
• ONSITE
• APP_REL
• TOOLS_REL
7. Click the Fields tab.
8. Click Edit for A.COURSE.
9. Select RFT Long and click OK.
10. Click Edit for A.DESCR.
11. Select RFT Long and click OK.
12. Click Edit for A.COURSE_TYPE.
13. Select Long for the Translate Values and click OK.
14. Click the Save button.
54
Query XMLP_COURSE_LIST
Description Course Listing
Owner Public
16. Click OK.

17. Select the Run tab.
Results
The query is displayed:
Saving a PS/Query Data Source Sample Data File

To save a PS/Query data source sample data file:
1. Select Reporting Tools, XML Publisher, Data Source.
3. Enter the following:
Data Source Type PS Query
Data Source ID XMLP_COURSE_LIST
4. Click Add.
5. Enter Course Listing for the description.
6. Click Generate link for Sample Data File.
55
7. Click the link that contains the generated file.
8. View the file and select File, Save As.
9. Save the file to C:\Labs\XMLP\DataSource\XMLP_COURSE_LIST.xml.
10. Close the window.
11. Click Save.
Registering a Connected Query Data Source

To upload and register a Connected Query data source:
Data Source Type Connected Query
Data Source ID XMLP_ENROLL_BY_BU
4. Click Add.
5. Enter Enrollment for the description.
6. Click Generate link for Sample Data File.
7. Click the link that contains the generated file.
8. View the file and then close the window.
9. Click Save.
Create Connected Query Data Source Sample File

To Create Connected Query data source sample file:
1. Select Reporting Tools, Connected Query, Schedule Connected Query.
2. Click the Add a New Value tab and enter CQ_ENROLL.
3. Click Add.
4. Select Connected Query XMLP_ENROLL_BY_BU.
56
5. Enter the following prompt values:
Unit NAM01
6. Click OK and then click Run.
7. Change Type to File.

8. Enter C:\Labs\XMLP\DataSource\cq_enroll_sample.xml in the Output Destination.
9. Click OK.
10. Click the Process Monitor link and check the progress of the process.
11. When the Status is success, open the file C:\Labs\XMLP\DataSource\cq_enroll_sample.xml.
Results
The file was created.
57
Creating XML File Data Source
XML File
XML files can be generated using various means.

Slide 41
Student Notes
Sample Data File

The resulting XML File has the following format:
<?xml version="1.0"?>
<root>
<ITEMS>
<ITEM_CD>PSU001</ITEM_CD>
<DESCR>Laptop Computer</DESCR>
<PRICE>500.00</PRICE>
</ITEMS>
<ITEMS>
<ITEM_CD>PSU033</ITEM_CD>
<DESCR>Marker - Orange</DESCR>
<PRICE>2.95</PRICE>
</ITEMS>
</root>
Well-formed XML
The XML File can be any well-formed XML file, such that:
• An XML document must have one root element
58
• An element must have matching start and end tags names, unless they are empty elements
• Elements can be nested, but can not overlap
• All attributes values must be quoted
• Attribute names must be unique in the start tag of an element
• Comments and processing instructions do not appear inside tags
• The < or & special characters cannot appear in the character data of an element or attribute value
59
Registering XML File Data Sources
Data Source Registration

Registering the data source, involves uploading the sample data file to the PeopleSoft database:

Slide 42
Student Notes
Sample Data File

The sample data file is an XML file with sample data that is used for data mapping, template preview, and
determining burst fields. Preview action is available within a desktop template designer or from within the
report definition page. For PS Query and Connected Query data source types the sample data file can be
system-generated or uploaded. For XML file data source type, the sample data file must be uploaded.
Note. Prior to PeopleTools 8.50, the sample data field was only used for data mapping and preview.
Page Used to Register XML File Data Sources
Data Source Reporting Tools, XML Publisher, Data Source, Add a New Value
Use this page to register an XML file data source:
60
61
Activity 3: Registering XML File Data Source

In this activity, you will review the activity overview and register an XML file data source.
Slide 43
62
Activity Overview
In this activity, you will create a new data source named CUSTOMER_DS. The sample data file is located in
C:\Labs\DataSource\cust_sample_data.xml.
63

Registering an XML File Data Source

To register an XML file data source:

Data Source Type XML File
Data Source ID CUSTOMER_DS
4. Click Add.
5. Enter Customer Information for the description.
6. Click the Upload link for Sample Data File.
7. Browse to find C:\Labs\XMLP\DataSource\cust_sample_data.xml.
8. Click Upload.
9. Click the link that contains the uploaded file.
10. View the file and then close the window.
11. Click Save.
Results
Sample data file:
64

65
Review
• Data sources can be PeopleSoft queries, Connected Queries, or XML files.
• Any PS Query or Connected Query can be used as a data source, but you may want to create specific
reporting queries.

• For XML file you must create a sample data file.
• A data source registers the sample data design file.
Slide 44
Student Notes
Describing Data Sources Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

for PeopleSoft Enterprise"Creating and Registering Data
Sources"
Creating Query Data Sources Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
Sources"
Registering Data Sources Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

Sources"
66
Lesson 5
Creating Templates
Objectives

• Describe template types.
• Create RTF template.
• Use Table Wizard.
• Work with PDF templates.
Slide 46
67
Creating Templates Lesson 5
Describing Template Types
Template Types
The following template types are supported:
• RTF (Rich Text Format)
• PDF

• eText
• XSL
PeopleSoft supplies design helpers for RTF and PDF templates.
Slide 47
Student Notes
Template Design
Template design involves the construction of a report's layout in a template file and is dependent upon what
the core Oracle XML Publisher engines accept for processing.
Note. Sample report templates are bundled with the BI Publisher Desktop, and available in <Installation
Directory>\BI Publisher Desktop\samples.
RTF
Reports are fully rendered reports, which means, the actual PDF output is generated at runtime.
Report designers have full control on output formatting and can incorporate charts, dynamic tables,
conditional formatting and so forth.
PDF
Reports are pre-rendered PDF forms that are simply filled with data at runtime.
The mapping between xml data source elements and PDF form fields is implemented using a simple
algorithm that does not support nested structures such as multi-value fields. This limitation is mainly because
of the static nature of PDF forms.
PDF templates are suitable when you have existing PDF forms that you need to use to generate reports, such
as government forms.
Generally faster than RTF templates since there is no runtime rendering involved.
68
Lesson 5 Creating Templates
eText
eText templates are RTF-based templates that are used to generate flat file text output that can be transmitted
to a bank or other customer for Electronic Funds Transfer (EFT) or Electronic Data Interchange (EDI).
Because the output is intended for electronic communication, these templates must follow specific format
instructions for data placement.
Note. XML file is the recommended data source for eText templates because the requirements for eText
templates are very specific. XML produced by PS Query data sources lacks the required structure for eText
templates and is therefore not available.

XSL
For more complex design requirements, a number of XSL and XSL-FO elements are supported for use with
your XSL templates.
69
Creating RTF Templates
Using Microsoft Word

The Template Designer plug-in is used in Microsoft Word to assist in creating RTF templates.
This diagram shows the plug-in menu:

Slide 48
Student Notes
RTF Document
Template Builder is used to load sample XML sample data into your Word document. Once the sample data
is loaded, you can insert form fields into your document.
The sample data file provides the tags necessary to map fields into your document.
The Word document is saved as RTF.
Note. For PS/Query data sources, you will need to download the sample data file to a file you can access from
Microsoft Word.
70
Creating RTF Templates (continued)
Downloading PS Query Sample File

Use the following steps to create an RTF template for a PS Query sample file:
1. Select Reporting Tools, XML Publisher, Report Definition.

2. Select the Add a New Value.
3. Enter a Report Name.
4. Enter the PS Query Name.
5. Click Add.
6. Click the Sample Data link.
7. Save the sample XML file to a local drive.
Slide 49
Student Notes
Download Sample Data

Use the Report definition page to download the sample data for a Query-based report.
71
72
Creating Templates
Lesson 5

Loading Sample Data in Template
To load the sample XML data:
1. In Microsoft Word, select Data, Load XML Data.

2. Select the XML sample data file.
3. You will receive a message that the data was successfully loaded.
4. Click OK.
Slide 50
Student Notes
Loading Sample XML Data

When the sample data has been loaded, you will not see the data displayed until you select one of the Insert
options.
73
Inserting Fields
To insert fields into the Word document:
1. Select Insert, Field.

2. Position the cursor where you want to insert the field.
3. Select the field in the Field dialog box and either:
• Click Insert.
• Double-click the field in the dialog box.

4. Select another data field or close the dialog by clicking the Close button
Slide 51
Student Notes
Inserting Fields
Starting with Template Builder for Word 10.1.3.3.0, you can also just drag the field from the dialog and drop
it into the Word document.
Note. The sample data file is not required to add form fields, you can manually add form fields. Template
Builder with the sample data file simplifies this process. The sample data file is required to preview the report
with sample data offline in Microsoft Word.
Field Dialog Box

The Field Dialog box contains the field names from the sample XML file:
74

When you select a field name, an example value of data for this field is displayed.
The following options are also available:
Option Description
Find For a large XML with a complicated structure, you can use the Find
functionality to find a specific field.
Force Left-to-right direction This is used only for languages that print right-to-left, such as Arabic or
Hebrew.
In these languages you still want to force left-to-right printing in fields such as
phone numbers, addresses, postal codes or bank account numbers.
Calculation You can select one of the aggregation functions for the data fields.
These functions (except) count only have an effect if there is more than one of
the data fields in the context where the function is used.
Example: Template
This is an example of a template with data fields inserted:
75
76
Creating Templates
Lesson 5

Previewing Data
You can preview the report in:
• PDF
• HTML

• Excel
• RTF
Slide 52
Student Notes
Preview
The preview merges the sample data to display a sample report:
77
Activity 4: Creating RTF Template

• Download the sample data file.
• Create a RTF Template.
• Preview the report.

Slide 53
78
Activity Overview
In this activity, you will create a report template for student confirmation letters. You have a query
XMLP_STU_LETTER that selects students whose confirmation letters have not been sent. This query joins
several tables to contain all of the information about the course enrollment and location.
The fields for the query are shown here:
79

Downloading the Sample Data File

To download the sample data file:

2. Select the Add a New Value.
Report Name STU_LETTER
Data Source ID XMLP_STU_LETTER
4. Click Add.
5. Click the Sample Data link.
6. Click Save.
7. Save the file to C:\Labs\XMLP\DataSource\XMLP_STU_LETTER.XML.
Creating the RTF Template

To create the RTF template:
1. Double-click the Microsoft Word icon on the desktop to open Microsoft Word.
2. Select File, Open, C:\Labs\XMLP\Templates\confirmation_letter.rtf.
3. From the Template Builder toolbar, select Data, Load XML Data.
Note. You could also select Oracle BI Publisher, Data, Load Sample XML Data.
4. Select C:\Labs\XMLP\DataSource\XMLP_STU_LETTER.XML.
5. Click Open.
6. Click OK on the data successfully loaded message.
7. Highlight the <student name> placeholder and select Insert, Field from the Template Builder toolbar.
8. Select the Student Name field from the dialog box and click Insert.
80
9. Replace the following placeholders with the fields indicated in this table:
Placeholder Field
<course description> Course Descr
<start date> Start Date
<training location> Location
<street1> Street1

<street 2> Street2
<city> City
<state> State
<zip> Zip
10. Click Close in the Field dialog box.
Results
Your template will have all the fields inserted:
Previewing the Sample Data

To preview the sample data:
1. Select File, Save.
2. From the Template Builder toolbar, select Preview, HTML.
81
82
Creating Templates
Results
Note. Close the template.

The sample data is inserted into the template:
Lesson 5

Using Table Wizard
Table Wizard Dialog Box

The Table Wizard dialog box allows you to:
• Create a simple or nested table with a variable number of rows.
• Associate a group of data elements, such as complex invoice or a purchase order line, with a form in the

document that will be repeated for each occurrence of the data element.
• Group or re-group data.
Slide 54
Student Notes
Insert Table/Form Wizard

The Insert Table/Form Wizard allows you to easily create standard reports.
Step 1: Select Report Format

You start by selecting the basic report format. This diagram shows the possible layouts for the basic report
format:
83
Step 2: Select Report Data

An XML document can maintain many different datasets. For example, a purchase order XML document
may contain header level information, lines, shipments and contacts. In this step, you select the data group
that contains the data you would like to see in your report. Depending on the sample data for this report, you
may only have one choice.
Step 3: Select Data Fields

Select the data fields that will be shown in your report:

Step 4: Group Report
In this step, you can group the report by selected data fields.
For each grouping level you can specify one of two layout options: Group Left or Group Above:
84

Step 5: Sort Report
In this step, you can sort the data in the table by up to 4 different fields. Select a field and then define the
sorting order (ascending or descending), and select the correct data type for the field.
Step 6: Headers/Labels
Finally, you can change the default labels / column headers. Click Finish to create the layout and customize it
in Microsoft Word.
85
Activity 5: Designing RTF Template with a Table

• Create a new RTF template.
• Modify the template.
• Preview the template.

Slide 55
86
Activity Overview
In this activity, you will create an RTF template for the course listing using the Table Wizard.
This is an example of the HTML Preview for the template:
87

Create New RTF Template

To create a new RTF template:
1. In Microsoft Word, select File, New, Blank Document and click OK.

2. From the Template Builder toolbar, select Data, Load XML Data,
C:\Labs\XMLP\DataSource\XMLP_COURSE_LIST.xml.
3. Click OK.
4. From the Template Builder toolbar, select Insert, Table Wizard.
5. Table is the default, so click Next.
6. Query/row is your only choice, so click Next.
7. Click the >> button to insert all fields.
8. Highlight @rownumber and click < to remove the field.
9. Click Next.
10. Select Course Type for the Group by and click Next.
11. Select Course for the Sort By and click Next.
12. Change the headings as indicated in this table:
Field Label
Course Code
Descr Course
Length Days Days
Training Units Units
13. Click Finish.
15. Change the Save as Type to Rich Text Format (*.rtf).
16. Save the file as C:\Labs\XMLP\Templates\Course Listing.rtf.
Results
The grouping will be displayed:
88

Modifying Template
To modify the template:
1. Add a title Course Listing at the top of the page.
2. Add another row and type Total number of Courses:.
3. From the Template Builder toolbar, select Insert, Field and select Course.
4. Select count for the calculation and click Insert.
5. Click Close on the Field dialog box.
6. Resize the columns in the table.
Previewing the Template

To preview the template:
1. From the Template Builder toolbar, select Preview, HTML.
10 rows will be displayed.
2. Close the preview window.
3. From the Template Builder toolbar, select Data, Load XML data.
4. Select C:\Labs\XMLP\DataSource\XMLP_COURSE_LIST_DATA.xml.
89
5. Click OK when data is loaded.
6. From the Template Builder toolbar, select Preview, PDF.
Results
The new sample data is inserted in the template:

90
Working with PDF Templates
Designing PDF Templates

The source of the PDF document does not matter, Possible design options are:
• Design the layout of your template using any application that generates documents that can be converted to
PDF.

• Scan a paper document to use as a template.
• Download a PDF document from a third-party Web site.
Slide 56
Student Notes
Adding Markup to the Template Layout

After you have converted your document to PDF, you define form fields that will display the data from the
XML input file. These form fields are placeholders for the data.
When you draw the form fields in Adobe Acrobat, you are drawing them on top of the layout that you
designed. There is not a relationship between the design elements on your template and the form fields. You
therefore must place the fields exactly where you want the data to display on the template.
To create a text place holder in Adobe Acrobat Professional 8.0:
1. Select the Text Field Tool from the Forms Toolbar.
2. Draw a form field box in the position on the template where you want the field to display. Drawing the
field opens the Text Field Properties dialog box.
3. On the General tab, enter a name for the placeholder in the Name field.
The name can be the XML source field name or a different unique name.
You can use the Text Field Properties dialog box to set other attributes for the placeholder. For example,
enforce maximum character size, set field data type, data type validation, visibility, and formatting.
4. If the field is not placed exactly where desired, drag the field for exact placement.
Example: Form Fields on PDF Template:

This is an example of a PDF Template with placeholders:
91
92
Creating Templates
Lesson 5

Working with PDF Templates (continued)
PDF Templates
The following guidelines need to be adhered to when working with PDF templates whether or not you are
mapping PDF template fields and tags:
• The PDF document must allow editing.

• Files must be Adobe Acrobat 5.0 compatible.
• Files must have form fields for the placement of application data, with each field tag being unique.
• Files should not have embedded javascript.
Slide 57
Student Notes
PDF Templates
PDF templates do not require a plug-in for offline template design. A mapping feature for XML data element
tags is enabled when the PDF template file is uploaded into the Reporting Tools, XML Publisher, Report
Definition, Template page. The XML Publisher PDF mapping functionality allows you to match existing
form fields in a PDF template with sample data field tags.
If you are not using a third party PDF template, you don't need to map data tags if you create PDF template
field names and XML data tags that are the same to begin with. You can also change the PDF template field
names to match your XML data tags.
Guidelines
This table provides instructions for adhering to the guidelines:
Guideline To adhere to guideline
Allow Editing Check the Security setting in the File, Document Properties, Summary page
Adobe Acrobat 5.0 If you are using a later version of Adobe Acrobat, go to File, Reduce File Size and select
compatible the Make Compatible with: Acrobat 5.0 and later option.
Form fields and unique If no form fields exist, use the Adobe Professional version to add field tags. If there are
names duplicate tags or non-unique tags in forms obtained from third parties, use Adobe
Professional to update the tags.
Embedded javascript XML Publisher removes embedded javascript during the course of the Map Enablement
function when the Generate button on the Reporting Tools, XML Publisher, Report
Definition, Template page is selected.
93
Review
• XML Publisher supports RTF, PDF, eText and XSL templates.
• The Template Builder plug-in is used to create RTF templates.
• The Table/Form wizard allows you to easily create standard reports.

• PDF templates contain form fields that will display the data from the XML input file.
Slide 58
Student Notes
Describing Template Types Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

for PeopleSoft Enterprise,"Creating Report Templates"
Creating RTF Templates Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

for PeopleSoft Enterprise,"Using RTF Templates"
Designing RTF Templates Oracle Business Intelligence Publisher User's Guide

Release 10.1.3.2,"Creating RTF Templates"
Working with PDF Templates Oracle Business Intelligence Publisher User's Guide
Release 10.1.3.2, "Creating PDF Templates"
94
Lesson 6
Defining XML Publisher Reports
Objectives

• Create a report definition.
• Associate a template.
• Define output options.
• Define report properties.
• Define report viewing security.
• Create a report definition based on a PDF template.
• Burst reports.
Slide 60
95
Defining XML Publisher Reports Lesson 6
Creating a Report Definitions
Report Definitions
Report definitions are used to:
• Associate a data source with a template.

• Define report properties.
• Grant security to view report.
• Define bursting options.
Slide 61
Student Notes
Report Definition
The report definition is made up of five pages:
Page Description
Definition When you create a new report definition, you will specify the data source and report name.
The report properties define the report status, report category and template type.
Template A report may include multiple templates. A template is used to associate different layout
formats as required by different countries/regions or as required by different channels (web
posting, printer, fax, and so on).
Output The defined output options from the report definition are reflected on the output type and
format prompts on the Process Scheduler request page when the application process that runs
the report is assigned the process type of XML Publisher.
Properties Report properties can be set to control formatting of the report.
Security Report definition security settings determine who can view the report once it has been run.
Bursting With the advanced bursting feature, report generation results in separate output files when
bursted reports are run through Process Scheduler.
96
Lesson 6 Defining XML Publisher Reports
Creating a Report Definitions (continued)
Creating a New Report Definition

In order to create a report you need to define:
• Data Source

For query-based reports, the data source does not need to be defined in advance, when you save the report
definition the data source is automatically defined.
• Template
Slide 62
Student Notes
Pages Used to Define Report Definitions
Report Definition Add Reporting Tools, Report Definition, Add New Value
Report Definition Enter the report name and data source and click Add
Use this page to add a new report definition:
Note. For XML Publisher power users, the data source type is PSQuery only and the drop-down list box is
disabled.
Note. XML Publisher power users can start to define a report in order to download the sample data files to
create their templates.
When you click Add, the definition page is displayed:
97
98
Report Properties
This table lists the report properties:
Lesson 6

Field Description
Report Description Descriptive text that provides more detail about the report.
Report Status Active reports must have at least one active template.
Only active reports can be selected at runtime and run to success.
Report Category This is a grouping mechanism for reports that provides row level security for
editing report definitions per the rights defined on the report category setup table.
Object Owner ID The default value that appears here is based on the Object Owner ID set in the

Report Category component.
Template Type Only one template type is allowed per report. The type cannot be altered once the
first template file has been uploaded and saved.
Retention Days The value entered here overrides the system setting for retaining reports.
Only XML Publisher report developers with permission list PTPT2600 can set this
value.
Download These links appear if the related files exist on the registered data source.
For query data sources, both links always appear whether the data source is
registered or not, because these files are system generated.
99
Associating Templates
Associating Templates
A report may have multiple templates.
A template is used to associate different layout formats as required by different countries/regions or as

required by different channels (web posting, printer, fax and so on).

Slide 63
Student Notes
Page Used to Define Template for Report Definition
Template Reporting Tools, Report Definition, Template
Use this page to define the templates for your report:
Templates
This table lists the template fields:
100
Field Description
Template ID The default template ID is a system-generated ID based on the report name.

This ID can be edited when a template is first added to the report definition, but it must
be unique across all templates in the system, not just within the current report definition.
Language Code The default value reflects the default template language.
Default Template Only one template can be selected as the default template.
The first template added to the report definition is automatically selected as the default.
This selection can be changed as necessary.

Default templates are automatically used at runtime if no other value is supplied.
Channel The Channel attribute supports the need to identify different layout formats as required
by the various distribution mechanisms.
For example, a printout may require a different template layout than an email or a web
posting.
Leaving the channel blank would indicate that this particular template does not have a
format that is specifically suited to just one channel.
These values are for information only and do not trigger a particular Process Scheduler
distribution mechanism.
Developers can drive a template choice based on channel through the PeopleCode XML
Publisher classes.
Adding Template Files

Each template layout is associated with one or more effective-dated versions of the template. For example,
you may have a new government form for each year. This table lists the Template Files fields:
101
Field Description
Effective Date The default date for a newly added template file is the current system date.
The user can change the data per standard effective dating logic with Update,
Update/Display, and Correction modes.
Status Statuses are In Progress, Active, or Inactive for the template file.
This field indicates the usability of the template file.
Runtime template file selection logic uses this field in conjunction with the Effective Date
field to determine which template file should be used at runtime.

At least one file must be active to save a report definition.
Upload Click this button to attach a template file to the template.

The file extension is checked against the template type value on the Definition page and a
warning is issued if there isn't a match.
Once the report definition is saved, this button becomes disabled. To reupload a new
version of the template, you must delete and re-add it.
Download Click this button to download the template file to your local computer for updating the
field or tag assignments.
Preview Click this button to preview the report using the current template file based upon the
sample data file that was registered with the data source.
The preview button is not enabled when there is no sample data file registered with the
data source.
Use Alt. XML (Use Select to use an alternate XML file for previewing. When you click the Preview button, a
alternate XML) dialog box appears, where you can select the file.
102
Defining Report Output
Output
Use the Output page to specify:
• Which output formats will be available to the user when the report is run.
• The default output to be displayed at runtime on the prompt or run control page.

It is also the output format that the system uses if no other value is fed into the XML Publisher engine.
• The output location (any, file, printer, email or web).
• Customized File name to use for the report.
Slide 64
Student Notes
Output Page
Use this page to set the output options:
Output Format Options

Based on the template type, the output options are as follows:
103
Template Type Output Options
RTF pdf, .html, .rtf, .xls (html)
PDF .pdf
Etext .txt
XSL pdf, .html, .rtf, .xls (html)
Note. The XML Publisher report definition output options are reflected in the output type and output format

prompts on the Process Scheduler Request page only when the application process that runs the report is
assigned the process type of XML Publisher.
Output Location
Select one of the following locations:
Location Description
Any Any indicates that the user can select the output location
at runtime
Email Email indicates that the output goes to email.

Note. The users defined in the distribution list must have
a valid email address defined in the user profile. If Allow
viewer assignment at report runtime is selected, you can
enter additional email addresses at runtime.
File File writes the output to the file that you indicate in the
Output Destination field.
Printer Printer indicates that the output goes directly to a printer.

Specify the printer destination for the output in the Printer
field. This field is available only when the output location
that you select is Printer.
Printer is a valid selection only when PDF output format
is enabled.
Web Web indicates that the output goes to a web report

repository that is accessible by the Report Manager.
104
Defining Report Output (continued)
File Names
You can specify a file name template that gets translated at runtime to a physical file name. This field accepts
a combination of output variables and plain text. Output variables are enclosed within percent signs (%) and
used as part of the descriptive report name on report search page. The following variables are supported.

• %ASD% inserts the as of date.
• %RID% inserts the report ID.
• %BTV% inserts the burst field value.
• %field% where field is the name of a field from the XML data that lies below the first repeating field. For
example, if you want the employee ID value to appear in the file name, you would use %EMPLID%.
Slide 65
Student Notes
File Names in Non-Bursted Reports

If you leave the File Name field blank, the system uses the report ID as the file name.
This table lists some alternate file names and the resulting report name for the report definition CRS_BY_BU:
File Name Report Name
blank CRS_BY_BU - CRS_BY_BU.HTM
Course Listing CRS_BY_BU - COURSE LISTING.HTM
Course Listing %ASD% CRS_BY_BU - COURSE LISTING 2009-11-28.HTM
File Names in Bursted reports

All burst key candidates on the bursting page are eligible. For example, if you have a report CERTIFICATE
that is burst by STUDENT_ID, you can use the file name to provide more details:
File Name Report Name
blank CERTIFICATE[2916]-CERTIFICATE.HTM
LOCATION %TRAINING_LOC% %END_DT% CERTIFICATE[2916]-LOCATION BOSTON 2009–03–

13.HTM
%STUDENT_NAME% CERTIFICATE[2916]-LEE,JAMES.HTM
105
Setting Report Properties
Report Properties
Properties defined in the report definition will override the global properties for this report.

Slide 66
Student Notes
Report Properties Page

Use this page to specify report properties:
106
Setting Report Viewing Security
Security Page
Use the Security page to:
• Indicate whether the report requestor can add to the standard Distribute To values on the Process Scheduler
Request, Distribution Detail page.

• Define the roles or users who can:
• View web-posted output in the Report Manager repository.
• View the report from XMLP Report Search page.
Slide 67
Student Notes
Security Page
Use this page to set viewer security:
Security for Viewing Non-Bursted Reports

This table describes how viewers are selected for non-bursted reports based on the report definition security
settings.
107
Allow viewer ID assignment at

Report Viewers Assigned report runtime Viewers
Yes No Reports are distributed to all roles and

users defined on the security page.
Runtime overrides are not allowed.
Yes Yes Reports distributed to all users and

roles defined on the security page.
Runtime overrides are allowed.
No Yes Distribution list is assigned at runtime

on the Process Scheduler distribution
detail page. By default the requester is
added.
No No No reports posted to Report

Repository. Runtime overrides are not
allowed.
108
Activity 6: Creating Report Definitions

• Create a report definition for student letter.
• Create a report definition of course listing.
Slide 68
109
Activity Overview
In this activity, you will create a two report definitions, one to print student confirmation letters and one to
print course listings by course type.
You created the templates for these reports in the last lesson.
110

Creating Report Definition for Student Letters

To define the report definition for student letters:

Report Name STU_LETTER
Data Source ID XMLP_STU_LETTER
4. Click Add.
Report Description Student Confirmation Letter
Report Status Active
Report Category ID XMLP_TRAINING
Template Type RTF
6. Access the Template page.
Description Student Letter
Effective Date 01/01/2007
8. Click the Upload button and select C:\Labs\XMLP\Templates\confirmation_letter.rtf and click Upload.
9. Click the Preview button.
111
11. Change the Status to Active.
12. Select the Output page and review the output options.
13. Select the Properties page and review the properties.
14. Select the Security page.

Allow viewer ID assignment at report runtime Selected
ID Type Role
Distribution ID All Pages
16. Save the page.
Creating Report Definition for Course Listing

To define the report definition for course listing:
Report Name COURSE_LIST
Data Source ID XMLP_COURSE_LIST
4. Click Add.
Report Description Course Listing
Template Type RTF
112
Description Course Listing
8. Click the Upload button and select C:\Labs\XMLP\Templates\Course Listing.rtf and click Upload.

11. Select the Use Alt XML check box.
12. Click the Preview button and use the Browse button to select C:\Labs\XMLP\Data
Source\COURSE_LIST_DATA.xml and click Upload.
13. Review the report, then close the preview window.
ID Type Role
17. Save the page.
113
Creating a Report Definition Based on PDF Template
Mapping PDF Templates

Mappings are required for PDF template where the form field use different XML data element tags than your
data source.
The name for the PDF map file should distinguish it from the template file:

• Template file XRFWIN.pdf
• Map file XRFWIN-m.pdf
• Full Path Mapping file XRFWIN-mfp.pdf.
Slide 69
Student Notes
Page Used to Generate Map File
Template 1. Reporting Tools, XML Publisher, Report Definition.

2. Select a report definition that uses a PDF template.
3. Access the template tab.
Use this page to generate a map file:
114

Note. PDF file security has to allow altering and saving for the mapping to be completed. This depends on the
version of Adobe with which you are working.
Field Description
Generate Click this button to generate the PDF map file.

Sample data is placed into the PDF template file uploaded above to enable you to access
the data tags for performing visual mapping offline within the Adobe application.
Upload Click this button to upload the PDF map file once the tags have been mapped.
Download Click this button to download the PDF map file to your local computer for updating the
field or tag assignments.
115
Creating a Report Definition Based on PDF Template (continued)
Full Path Mapping

Full path mapping can be used when XML data tags are repeated at different levels in your XML data.

Slide 70
Student Notes
Full Path Mapping

The PeopleSoft implementation for PDF mapping supports full path mapping. Full path mapping is not
supported in the BIP Server. Full path mapping can be used when you have no control on the structure and
names of your XML data tags. For you to use full path mapping, the data source definition must include
sample XML with no schema.
When you select to generate the mapping file, the sample data is placed into the PDF template file to enable
you to access the data tags for performing visual mapping offline within the Adobe application:
116
Note. Full path mapping is available only for PeopleTools 8.50 and later. It is not backward compatible.
117
Creating a Report Definition Based on PDF Template (continued)
Processing PDF Templates

The Oracle BI Publisher Core Engine adheres to the following rules when processing PDF templates:
• The search for the tag that matches the field name starts at the end of the XML file.
• The first match of the tag is used for the field value.

• If the tag is not found, the Oracle BI Publisher Core Engine looks at the map file (if provided).
This means that even if the form is mapped, when a tag is in the XML data that matches the PDF template
form field tag, it has priority over the map for placing the data.
Slide 71
Student Notes
Example: Map File

When you access the generated mapping file and click on a form field, an Adobe Acrobat Products dialog box
will appear that contains the field names from the sample data file. After selecting the appropriate tags for all
your form fields, you can save the mapping file and upload it to the PeopleSoft database.
Note. PDF file security has to allow altering and saving for the mapping to be completed. This depends on the
version of Adobe with which you are working.
118
Activity 7: Creating Report Definition Using PDF Template

• Create a report definition for a PDF template.
• Add additional templates.
Slide 72
119
Activity Overview
In this activity, you will create a report definition CERTIFICATE1 using the following:
Field Value
Data Source PS Query - XMLP_STU_CERTIFICATE
Report Category TRAINING

Template Type PDF
Template File Certicicate1.pdf
Map File Certificate1–m.pdf
Security Role: All Pages
120

Creating Report Definition for a PDF Template

To create report definition for a PDF template:

Report Name CERTIFICATE1
Data Source ID XMLP_STU_CERTIFICATE
4. Click Add.
Report Description Student Certificate
Template Type PDF
6. Access the Template page and enter the following information:
Description Student Certificate
7. Click the Upload button and select C:\Labs\XMLP\Templates\certificate1.pdf and click Upload.
Your template is displayed without any data.
121
10. Click the Generate button and then click Open.
Note. You should see gray boxes in the form fields, if they are not displayed, click the Highlight Fields
button displayed in the upper right.
11. Click on the first field.
The Java Script window will open with the tags available in the sample data file for the data source.
12. Select STUDENT_NAME and click Select.
13. Click Close

Note. A message is displayed that you cannot save form information. In the classroom, you only have the
Acrobat Reader, therefore, you will not be able to save the mapping.
14. Click Close on the dialog box.
15. Select File, Exit.
Completing Report Definition

To complete the report definition:
1. Click the Upload button for the Map file.
2. Use the Browse button to select C:\Labs\XMLP\Templates\certificate1–m.pdf.
3. Click Upload.
The sample data is now displayed in the template.
7. Select the Security page and enter the following information:
ID Type Role
8. Save the page.
Adding Additional Templates

To add additional templates:
122
1. Select the Template page.
2. Click the + icon for the Template to add another template.
Template ID CERTIFICATE1_FR
Description Certificat

Language Code French
Status Active
4. Click the Upload button and select C:\Labs\XMLP\Templates\Certificate1_French.pdf and click Upload.
Template ID CERTIFICATE1_ES
Description Certificado
Language Code Spanish
Status Active
7. Click the Upload button and select C:\Labs\XMLP\Templates\Certificate1_Spanish.pdf and click Upload.
123
Template ID CERTIFICATE1_NL
Description Cursuscertificaat
Language Code Dutch

Status Active
10. Click the Upload button and select C:\Labs\XMLP\Templates\Certificate1_Dutch.pdf and click Upload.
11. Save the page.
Results
Four templates exist for this report definition:
124
Bursting Reports
Bursting
When you generate a bursted report, separate document files are created for each unique data value for a
specified field tag in the data source.

Slide 73
Student Notes
Bursting
Bursting is an optional advanced feature that is only available when reports are run through Process Scheduler
and is not intended for real-time online viewing. It is typically used when you are repeating the generation of
a templated report layout many times for multiple like sets of data.
For example, the diagram above shows a batch run of courses for a specified date. With bursting, you can
generate individual report files resulting in separate secured output for each business unit.
Note. Only users assigned the role XMLP Report Developer can define bursting. Users with the role XMLP
Power User will only see the bursting page when there are existing bursting instructions for the report.
125
Bursting Reports (continued)
Bursting Features
Bursting provides multiple optional features:
• Data tag to burst by.
• Template or translation for each burst file assigned at runtime.

• Report file security assigned at runtime per application's existing row level security.
• Search key data values stored at runtime for more intelligent search.
Slide 74
126
Student Notes
Page Used to Define Bursting
Bursting Reporting Tools, XML Publisher, Report Definition, Bursting
Enforce Unique Value

Select this check box to indicate that the Burst by field contains unique values. If a non unique value is found,
the report will not be published and an error will be logged. It is recommended to use unique bursting values.
If this check box is cleared, bursted files with the same Burst by field will be combined in one report.
Note. Prior to PeopleTools 8.50, uniqueness was not enforced and therefore by default this check box is
cleared.
127
Burst By
In order to enable bursting, you need to identify a Burst By field.
The report's data source must have an associated sample data file. The sample data file is used to:
• Identify the highest level repeating group (node) in the XML source.

• Identify node tags.
Slide 75
Student Notes
Setting Up Bursting
In this sample data file generated for the query CRS_BY_BU, Business Unit will be used as the burst by
field, however you could burst by any of the tags at the same level:
One report will be generated for each business unit.
128
Template
This feature dynamically drives the template assignment at runtime based upon the data value of a designated
sample data tag.
Field Description

Template controlled by Indicate the field with the template translation preference.
Data Value Enter a row for each data value that requires a specific template or template translation.
Template ID A template ID should be selected for each data value that requires a special template.
Language (Optional) Select a language code for the desired translation of the template then the
specified data value is found in the XML data.
Slide 76
Student Notes
Translation
You can assign a language code to apply a specific template translation as well. This means that the various
bursted report occurrences in one batch run can each have an appropriately assigned template and translation.
For example, you can print Canadian paychecks in English or French depending upon the employee's
preference.
129
Optional Security for Bursting

When a report is set up to be bursted, the report designer can also designate how the generated documents are
secured when they are posted to the Report Manager.

Slide 77
Student Notes
Security for Bursting (Optional)

The system automatically limits access to each report instance based on the Burst by field. For example, if the
report is burst by employee ID, only the users designated with access to each employee ID are able to view
the output file.
The report designer must provide the record name of the security join table and designate the common fields
to join with the bursting field. The system performs the join and determine who can view the report instances.
At runtime, this information is used to determine who can view each bursted report instance. Bursting
security can be utilized to supplement or replace the basic report viewer security by role or user ID.
Otherwise, the system limits access to each report instance based on preexisting system security definitions.
130
Search Keys
Delivered search keys include:
• Burst By
• Report Definition Name

• Generated On Date
Additional search keys may be defined to provide even more specific granularity.
Slide 78
Student Notes
Search Keys (Optional)

At report runtime, the report posting program uses this information to store the key names defined here along
with the specific data values for each burst report. From the XML Publisher Report Search page, users can
utilize these configurable search fields to locate a specific report occurrence. For example, if the pay advice
report runs regularly and posts numerous report files for self-service access and as an employee you want to
locate a particular dated advise, you would not want to browse through all the advise files to locate the one
you really want to see. By adding a data value in the data source for "pay period" and assigning that field as a
bursting search key, the employee is then able to enter a date when searching their pay advises.
131
Activity 8: Adding Bursting

• Add bursting to report definition CERTIFICATE1.
• Add bursting to report definition STU_LETTER.
• Add bursting to report definition CRS_BY_BU.

Slide 79
132
Activity Overview
In this activity, you will add bursting for CERTIFICATE1, STU_LETTER, and CRS_BY_BU report
definitions.
133

Adding Bursting to Report Definition CERTIFICATE1

To add bursting to report definition CERTIFICATE1:

2. Select CERTIFICATE1.
3. Access the Bursting page.
Burst By STUDENT_NAME
Enforce Unique Burst Value Selected
Template controlled by TRAINING_LOC
5. Insert rows for the following locations:
Data Value Template ID Language
Amsterdam CERTIFICATE1_NL Dutch
Mexico CERTIFICATE1_ES Spanish
Paris CERTIFICATE1_FR French
6. Enter TRAINING_LOC in the Search Field.
7. Select the Output page.
8. Enter %TRAINING_LOC% in the File Name.
9. Click Save.
Results
The report will use different templates based on data value and language:
134

Adding Bursting to Report Definition STU_LETTER
To add bursting to report definition STU_LETTER:
2. Select STU_LETTER.
4. Enter STUDENT_ID in the Burst By field.
5. Enter STUDENT_NAME in the Search Field.
6. Click the + icon to add another search field.
7. Enter TRAINING_LOC.
8. Select the Output page.
9. Enter %STUDENT_NAME%in the File Name.
10. Click Save.
135
Adding Bursting to Report Definition CRS_BY_BU

To add bursting to report definition CRS_BY_BU:
2. Select CRS_BY_BU.
4. Enter BUSINESS_UNIT in the Burst By field.

5. Enter TRAINING_LOC in the Search Field.
6. Click Save.
136
Review
• In order to create a report definition, the data source and template must exist.
• The report definition specifies which template to use when the report is run.
• The output options specify the report formats and locations that can be used for the report at runtime.

• Report properties can be defined for each report.
• The report security determines who can view the report.
• Map files are used with PDF templates to map the XML sample data file to the PDF template.
• Bursting is typically used when you are repeating the generation of a templated report layout many times
for multiple like sets of data.
Slide 80
Student Notes
Describing Report Definitions Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

for PeopleSoft Enterprise,"Defining Report Definitions"
Creating a Report Definition Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

137

Lesson 7
Running and Viewing Query-Based XML

Publisher Reports

Objectives
• Run reports in Query Report Viewer.
• Schedule PS Query reports.
• Change distribution options.
• Locate and view XML Publisher reports.
• Use Reporting Console.
Slide 82
139
Running and Viewing Query-Based XML Publisher Reports Lesson 7
Running Reports in Query Report Viewer
Query Report Viewer

XML Publisher reports that have a data source of PS Query can be selected and viewed using the Query
Report Viewer.
Existing Query security applies so that each user has access to run only the reports to which he or she has

qualified Query access to the data source.
Slide 83
Student Notes
Page Used to View Query Report
Query Report Viewer Reporting Tools, XML Publisher, Query Report Viewer
Use this page to view a Query report:
Note. Bursted reports are listed, but they aren't executable from the Query Report Viewer component.
140
Lesson 7 Running and Viewing Query-Based XML Publisher Reports
You can select the report format, if more than one format is available in the report definition and click View
Report to view the report. When they exist, the Query's runtime parameters are presented.
A new window opens displaying the report results according to the runtime inputs. You can save the report
results locally by using the browser's Save functionality.
141
Scheduling PS Query Reports
Query Report Scheduler

Query Report Scheduler uses the existing Process Scheduler functionality to:
• Select runtime parameters for query-based reports.
• Monitor the report process request.

• Post and secure the results to the Report Manager, a printer, or the Process Scheduler file directory.
Slide 84
Student Notes
Page Used to Schedule Query Report
Query Report Scheduler Reporting Tools, XML Publisher, Query Report Scheduler
Use this page to schedule a Query report:
When you click Run, the Process Scheduler Request page appears:
142
The Process Scheduler Request page enables you to specify variables, such as where a process runs and in

what format the process output is generated.
The values for output type and output format appear by default per the report definition and can be changed if
the report definition allows it.
143
Scheduling PS Query Reports (continued)
Changing Distribution Options

You must specify an output type of Web or Email for the distribution list to be accepted when the process
instance is created .
Based on the output format and location specified on the Output page of the report definition, you can click

the Distribution link on the Process Request page and modify or add:
• Folder name where the report will be stored.
• Retention days for this instance of the report.
• Email information
• Report distribution.
Slide 85
Student Notes
Distribution Detail
Distribution options are also active allowing updates to viewers, again only as allowed in the report
definition.
144
Running and Viewing Query-Based XML Publisher Reports
145
Scheduling PS Query Reports (continued)
Emailing XML Publisher Reports

To email XML Publisher reports:
• Select the output type Email.
• Select the output format.

• Click the Distribution link to add or modify recipients, as well as updating the email subject and message.
Email recipients must be authorized to view the content of the email and their email addresses must be
entered in their security user profiles.
Slide 86
Student Notes
Email
The format of the report in an email is dependant on the report format selected:
• For type Email with a format of PDF, you will receive an email with the PDF report as an attachment.
146
• For type Email with a format of HTM, you will receive an email with a link to the report as an attachment.
Note. The .png attachment is the Oracle logo that is on the report header.
The report will display without the logo:
147
• For type Web with a format of HTM, you will receive two emails, one with a link to the log and one with a
link to the report. This is an example of the email with a link to the report:
The link will take you to the Report Index page.
148
Locating and Viewing XML Publisher Reports
XML Publisher Report Repository

The XMLP Report Search page allows you to filter criteria by:
• Report definition ID
• Folder

• Date created
• Range of process instances
• Created in the last number of days, hours, or minutes
Slide 87
Student Notes
Page Used to Access the XML Publisher Report Repository
XMLP Report Search Reporting Tools, XML Publisher, XMLP Report Search
Use this page to search for XMLP reports in the report repository:
149

You can use additional Search keys defined in the report definition to narrow down the search:
Click the report link to view a specific report and then click the file name for the specific report:
150
151
Locating and Viewing XML Publisher Reports (continued)
Report Manager
In Report Manager, you can search for reports by:
• Folder
• Range of process instances

• Report name
• Date created
• Created in the last number of days, hours, or minutes
Slide 88
Student Notes
Page Used to Access Report Manager
Report Manager Reporting Tools, Report Manager
Use this page to find a report in the report repository:
152
Locating and Viewing XML Publisher Reports (continued)
Report Administration
Any user who maintains the content of Report Manager must be assigned a Report Manager administrator
role in PeopleSoft Security. With this administrator role, the user can:
• Change the distribution list by adding or deleting a user or role ID.

• Delete a report from Report Manager.
• Alter the report's expiration date.
Slide 89
Student Notes
Super User
A super user role is also available that allows you to delete and update all report output in Report Manager.
Super users are allowed to delete the report entry and update the distribution list or expiration date of report
entries.
The difference between the administrator (ReportDistAdmin) and super user (ReportSuperUser) roles is that
the administrator role can access and update any report in the Report Manager. The super user role can update
only reports that they are authorized to view.
153
Page Used to Administer Reports
Report Administration Reporting Tools, Report Manager, Administration tab
154
Activity 9: Running Query Reports

• View reports in the Query Report Viewer.
• Schedule Query reports.
• Search for reports.

• View reports in Report Manager.
• Email Course Listing report.
Slide 90
155
Activity Overview
1. View the COURSE_LIST report.
2. Schedule CERTIFICATE1 reports to run for the following course sessions:
Course Session number

1001 401 (Teaneck)
1001 404 (France)
3. Schedule STU_LETTER to run.
4. Use XML Report Search to view the reports that you ran.
5. Use Report Manager to view the reports that you ran.
6. Email a PDF of the Course Listing report to PTRPTG.
This table lists the email addresses configured in the training environment:
User ID Email Address
PTXMLP win2k3ent_wf1@win2k3ent.us.oracle.com
PTRPTG win2k3ent_wf2@win2k3ent.us.oracle.com
XMLP1 win2k3ent_wf3@win2k3ent.us.oracle.com
156

Viewing Reports in the Query Report Viewer

To view reports in the Query Report Viewer:
1. Select Reporting Tools, XML Publisher, Query Report Viewer.

2. Click Search to list your reports.
3. Select View Report for COURSE_LIST.
4. Close the report window.
Results
The report is displayed:
Scheduling Query Reports

To schedule Query reports:
1. Select Reporting Tools, XML Publisher, Query Report Scheduler.
2. Select Add a New Value
3. Enter CERTIFICATE1 in the Run Control ID.
4. Click Add.
157
5. Enter CERTIFICATE1 in the Report Name.
6. Enter 1001 for the Course and 401 for the Session.
7. Click OK.
8. Click the Run button and then click OK.
9. Select the Update Parameters link.
10. Enter 1001 for the Course and 404 for the Session and click OK.

14. Enter Letter in the Run Control ID.
15. Click Add.
16. Enter STU_LETTER in the Report Name.
17. Click the Run button.
18. Click the Distribution link.
19. Select Folder Student Reports and click OK.
20. Click OK.
Searching for Reports

To search for reports:
1. Select Reporting Tools, XML Publisher, XML Report Search.
2. Click Search.
All of your reports are listed.
3. Enter CERTIFICATE1 in the Report Definition ID.
4. Click the arrow to expand the View Reports Using Search Keys.
5. Select TRAINING_LOC for the prompt and Paris for the data value.
6. Click Search.
Results
You will only see the certificates for Paris:
158

Viewing Reports in Report Manager
To view reports in Report Manager:
1. Select Reporting Tools, Report Manager.
2. Enter Student Reports for the Folder and click Refresh.
All your student letters will be displayed.
3. Click on the Administration tab.
4. Click on the link STU_LETTER[2441]-Kovar,Joleen.htm.
Report is displayed.
6. Click Save.
Emailing Course Listing Report

To email Course Listing report:
159
3. Enter CourseList in the Run Control ID and click Add..
4. Enter COURSE_LIST in the Report Name.
5. Click Run.
6. Change the Type to Email.
7. Change the Format to PDF.
8. Click the Distribution link.
9. Type Attached is the course listing you requested. in the Message Text.

10. Delete the existing row in the Distribute To section.
11. Enter ID Type User and Distribute To PTRPTG.
12. Click OK.
13. Click OK to run the report.
Viewing the Email

To view the email:
1. On the desktop, double-click the Outlook Express icon.
2. Click on the link for 1 unread Mail Message.
3. Double-click the pdf and select Open to view the report.
4. Close the Report window.
Results
The email with the report as an attachment.
160
Using Reporting Console
Reporting Console
The Reporting Console provides a single interface for a user to manage and schedule reports. From the
Reporting Console users can:
• Run a report.

• Schedule a report.
• Organize Reports.
Slide 91
Student Notes
Setting Up the Reporting Console

The Reporting Console is set up for each individual user. The first time a user accesses the Reporting
Console, a link is displayed to set up reporting preferences. The user can also change preferences at any time
using the Preference link.
To set up the Reporting Console:
1. Select Reporting Tools, Reporting Console.
161
2. Click the Click here to setup display preferences link.

3. Set your preferences and click OK.
Note. Preferences can be changed at any time using the Preferences link.
Set the preferences for your display.
Section Description
Default Folder The default folder section allows you to determine which
folders to display and the order or the folders.
Process Link Display Option Use this section to customize the display for My
Favorites.
Display Options for My Process Requests Use this section to customize the display for My Process
Requests.
Display Options for My Reports Display Options for My Reports.
Show Instances for These settings apply to folders where report or process
instances are displayed.
Process Request Notification Select this check box to receive a pop up confirmation
message when a process is submitted.
162
Using Reporting Console (continued)
Adding My Favorites
Within the My Folders folder, users can build their own hierarchy of sub-folders to organize, access and
monitor frequently accessed processes.
• Folders are used for organizing the processes and bookmarks are used to edit or run processes or jobs.

• Process bookmarks are used to run the process or job.
Note. The system will automatically add the appropriate links based on your permission to the process or
job.
Slide 92
Student Notes
Adding Folders
To add a folder:
1. From the Reporting Console home click the Add link for My Favorites.
2. Select the Folder radio button.
3. Enter the new folder name and click OK.
Adding Process Bookmarks

To add a process:
1. From the Reporting Console home click the Add link for next to the folder where you want to add the
process bookmark.
2. Select the Process Bookmarks radio button.
3. Select the Process Type/Name radio button.
4. Select the Process Type.
5. Enter or select the Process Name.
6. Click the Search button and the Process List appears.
7. Select the check box for each process to bookmark.
8. Click Bookmark Selected.
163
Adding Bookmarks for PSQuery, Connected Query, XMLP Query-Based Reports or nVision
Report Request
To add a process bookmark for a PSQuery, Connected Query, XMLP Query-Based Reports or nVision
Report Request:
3. Select the radio button for the type of report (PeopleSoft Query , Connected Query, Query-Based XMLP
Reports or nVision Report Request).

The Process Type and Process name will be displayed in read-only format for the selected process type:
4. Use the Find link in the process list grid to further refine your search criteria.
5. Select the check box for each process to bookmark.
164
Using Reporting Console (continued)
XML Publisher Processes

In order to run a process or job from the Reporting Console, you must:
1. Enable generic prompting.

2. Set the process security level.
3. Identify runtime parameters.
Slide 93
Student Notes
Page Used to Set Runtime Parameters
Runtime Parameters PeopleTools, Process Scheduler, Processes

Open the process.
Select the Runtime Parameters tab
Select the Enable Generic Prompting check box to allow users to run this process from the Reporting
Console.
Allow Access By User With
You need to specify whether full process security or process group security should be applied when the
process is run from the Reporting Console or a web service.
165
Full Process Security Indicates that the process security defined on the Process Definition Options page
will be used to determine which users can schedule this process from the
Reporting Console. The user must have permission to at least one of the
Components, as well as be a member of at least one of the Process Groups listed
on the Process Definition Options page.
Process Security Group Indicates that the user must be a member of at least one of the Process Groups
listed on the Process Definition Options page to schedule this process from the
Reporting Console.
Runtime Parameters

Application run control records are used to retrieve the parameter values at execution time. In order to run the
process from the Reporting Console, the user must be able to enter the runtime parameters necessary for the
process with the correct application run control record. This also allows the user to retrieve saved parameter
values from an application run control record.
166
Activity 10: Setting Up and Using Reporting Console

1. Set up the Reporting Console.
2. Add My Favorites folders and process bookmarks.
3. Run reports from the Reporting Console.

Slide 94
167
Activity Overview
1. Set up Reporting Console with the following:
Section Description
Default Folder Display all folders.

Process Link Display Option Use Name and Description
Display Options for My Process Requests Display all processes for User PTXMLP.
Display Options for My Reports Display all Posted reports.
Show Instances for Show instances for the last 2 days, with a total of 5
instances.
Process Request Notification Select to receive a pop up confirmation message when a

process is submitted.
2.
Note. Use the T1B85001 database with the user name and password PTXMLP in this activity.
168

Setting Up the Reporting Console

To set up the Reporting Console:

2. Select the Click here to setup display preferences link.
This link is only displayed for the initial setup, after that use the Preferences link.
3. Select the Name and Description radio button.
4. In the Show Instances for section, select Last, 2, Days.
5. Enter 5 for the Display Latest.
6. Select Enabled.
7. Click OK.
Results
Your preferences:
169

Adding My Favorites Folders and Process Bookmarks
To add My Favorites folders and process bookmarks:
2. Select the Folder radio button.
3. Enter the Course Reports and click OK.
4. Expand the My Favorites folder.
5. Click the Add link for Course Reports folder
7. Select the radio button for Query-Based XMLP Reports.
8. Select CRS_BY_BU.
Results
The folder and Process will appear:
170

Running Reports from the Reporting Console.
To run reports from the Reporting Console:
1. Expand the My Favorites Folder.
2. Expand the Course Report Folder.
3. Click Run for CRS_BY_BU.
4. Enter 12–01–2009 for the START_DATE and click OK.
5. Click Schedule.
6. Enter Dec1 in the Save Parameters and click OK.
7. Click OK.
8. Click OK when the dialog box will appears confirming the process was submitted.
9. Expand the My Processes folder.
If the Status of the process instance is Processing, close the My Processes folder and then open it again.
Note. When the status is Success, the report is posted.
10. Expand the My Reports folder and click on the report link to view the report.
Results
When the process completes, you will see the instance in My Processes, My Reports and My Favorites.
171
172

Lesson 7

Review
• XML Publisher reports that have a data source of PS Query can be selected and viewed using the Query
Report Viewer.
• The Query Report scheduler page can be used to schedule XML Publisher Reports with a data source of PS
Query.

• You can view XML Publisher reports using XMLP Report Search or Report Manager.
• The Reporting Console provides a single interface for a user to manage and schedule reports.
Slide 95
Student Notes
Running Reports in Query Report Viewer Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
for PeopleSoft Enterprise,"Running Reports in Query
Report Viewer"
Scheduling PS Query Reports Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

for PeopleSoft Enterprise,"Scheduling Reports in Query
Report Scheduler"
173

Lesson 8
Implementing Sub-Templates and

Template Translations

Objectives
• Create reusable sub-template definitions.
• Use the content library.
• Maintain template translations.
Slide 97
175
Implementing Sub-Templates and Template Translations Lesson 8
Creating Reusable Sub-Template Definitions
Sub-Templates
Sub-templates can be created that contain formatting and data fields that are used in multiple templates.
Within a single sub-template file, multiple sub-template components can be available.
Start and end template indicators must exist to distinguish those various components.

<?template:component_name?>
<?end template?>
where component_name is the name you assign sub-template.
Slide 98
Student Notes
Sample Sub-Template
This is a sample sub-template:
176
Lesson 8 Implementing Sub-Templates and Template Translations
Creating Reusable Sub-Template Definitions (continued)
Importing Sub-Templates
This diagram illustrates how a sub-template is imported into a template using the content library:

Slide 99
Student Notes
Importing Sub-Templates
To import a sub-template file that is stored in the Content Library, the following syntax must be placed at the
top of the primary template file:
<?import:psxmlp://sub-template_NAME?>
where sub-template_NAME is the registered sub-template ID in the Content Library, for example:
<?import:psxmlp://STDHEADER?>
This syntax must be in Normal text.
You then need to call the specific template defined in the sub-template, using the following syntax:
<?call-template:address:?>
Example: Importing Sub-Template

This is an example of a template that imports a sub-template:
177
Previewing Template with a Sub-Template

In order to preview the sub-template in Word, use the following syntax for the import:
<?import:file:C:///Template_Directory/subtemplate_file.rtf?>
Notice the triple slashes and the use of the actual file name instead of template ID.
Note. When your design is complete, you can change the import statement back to make the sub-template
available to the main template in PeopleTools environment.
178
Creating Reusable Sub-Template Definitions (continued)
Passing Parameters
It may be necessary to pass runtime parameters into the XML Publisher core engine. Numbers and text are
sent as strings with single quotes.
By default, PeopleTools( through the ReportDefn class ProcessReport method) always passes the following

parameters/tags:
• <?$ReportID?>
• <?$ReportTitle?>
• <?$RunDate?>
• <?$ReportID?>
• <?$RunTime?>
Slide 100
Student Notes
Example Sub-Template:
The PeopleSoft-delivered XML Publisher report XRFWIN demonstrates the usage of these values in a report
calling a sub-template for a header.
This is an example of the sub-template:
Before inserting these parameters into the template (or sub-template), the following declaration must be
entered under a form field at the top of the report's primary template; one for each parameter called:
<xsl:param name="ReportID" xdofo:ctx="begin"/>
<xsl:param name="ReportTitle" xdofo:ctx="begin"/>
<xsl:param name="RunDate" xdofo:ctx="begin"/>
<xsl:param name="RunTime" xdofo:ctx="begin"/>
This is an example of the report template. The declaration is defined in the Help Text:
179
180
Implementing Sub-Templates and Template Translations
Lesson 8

Activity 11: Adding a Sub-Template

• Create a sub-template.
• Preview the template with a sub-template.
• Import a sub-template.

Slide 101
181
Activity Overview
In this activity, you will create a sub-template for Course Enrollments and save it to C:\Labs\XMLP as
es_enrollments. The template will include an image that is located in C:\Labs\XMLP|Misc\people_image.jpg.

Add the sub-template to your confirmation template and save the template as es_confirmation_letter.rtf.
Preview the template and then change the import statement to work with the PeopleSoft application.
182

Creating a Sub-Template
To create a sub-template:
1. In Microsoft Word, select File, New, Blank Document.

2. Type <?template:es_header?> and Enter.
3. Select Insert, Picture, From File, C:\Labs\XMLP\Misc\people_image.jpg and click Insert.
4. Expand the image to make it a little larger.
5. On the line below the picture, type Education Services and Enter.
6. Type Course Enrollment and Enter.
7. Type <?end template?>.
8. Save the template as C:\Labs\XMLP\es_enrollment.rtf.
Note. Remember to change the save as file type to Rich Text Format (*.rtf).
Results
The completed sub-template:
Previewing the Template with Sub-Template

To import the sub-template:
1. Open the template C:\Labs\XMLP\Templates\confirmation_letter.rtf.
2. Select Data, Load XML Data.
3. Select C:\Labs\XMLP\DataSource\XMLP_STU_LETTER.xml and click Open, then OK.
183
4. Select File, Save As and enter es_confirmation_letter for the file name.
5. At the top of the document type <?import:file:C:///Labs/XMLP/es_enrollment.rtf?> and Enter.
6. Type <?call-template:es_header?>.
7. Select Preview, HTML.
Results
The sub-template is displayed in the template:.

Importing the Sub-Template
To import the sub-template:
2. Change the first line to <?import:psxmlp://ESHEADER?>.
You will create the sub-template ESHEADER in the content library in the next activity.
Results
The import statement is saved in the template:
184
Using Content Library
Content Library
The Content Library is a component provided for the registration of reusable sub-template files.
For sub-templates:
• The metadata is similar to that of primary template files.

• Security is applied through Report Categories.
• Power users are able to browse, view, and download sub-template files but not add them.
Slide 102
Student Notes
Page Used to Maintain Sub-Template
Content Library Reporting Tools, XML Publisher, Content Library
Use this page to create and maintain sub-templates:
185
View Sub-Template
This is an example of a sub-template for a report header:
Sub-Templates

The sub-template files are independently stored and are not registered in association with a data source or
primary template. This being the case, if any form fields exist inside the sub-template, the report in which the
sub-template is placed must have a related data source that supplies those fields or the data must be passed in
as runtime parameters.
Sub-template names are not exposed to the end user at either report design time or runtime. The complete
template (primary and sub-templates) is systematically assembled by the XML Publisher engine during report
generation. The same occurs during online previewing as long as the sub-template file exists.
Note. There is no method for viewing which report templates include which sub-templates. This means that
users must be careful about changing, deleting, or inactivating sub-templates.
186
Activity 12: Registering Sub-Template

• Register a sub-template.
• Add new template to report definition.
• Schedule the report.

Slide 103
187
Activity Overview
In activity 11 "Adding a Sub-Template", you created the sub-template es_enrollment and used the sub-
template in your confirmation letter template named es_confirmation_letter.rtf.
In activity 6 "Creating Report Definitions", you created the report definition STU_LETTER. When you
created this definition, you used the confirmation letter template that did not contain the header.
In this activity, you will add the es_header to the content library and then update your report definition
STU_LETTER to use the template es_confirmation_letter.rtf. as the active template.

188

Registering Sub-Templates
To register a sub-template:
1. Select Reporting Tools, XML Publisher, Content Library.

3. Enter ESHEADER in the Sub-Template ID.
4. Click Add.
Description Education Services Header
Language English
Sub-Template Type RTF
6. Click the Upload button.
7. Select C:\Labs\XMLP\es_enrollment.rtf and click Upload.
8. Click View and select Open to view the sub-template.
9. Close the sub-template window.
11. Click Save.
Adding New Template to Report Definition

To add new template to report definition:
2. Select STU_LETTER.
4. Click the + icon in the Template section.
189
5. Enter Student Letter with header for the description.
6. Select the Default Template check box.
7. Enter 01/01/2007 for the Effective Date.
8. Click the Upload button and select C:\Labs\XMLP\Templates\es_confirmation_letter.rtf
9. Click Upload.
10. Click Preview.

13. Click Save.
Schedule and View the Report

To schedule the report:
2. Select Run Control ID Letter.
3. Select STU_LETTER_2 for the Template ID.
5. Click the Go to XMLP Report Search link.
6. Enter STU_LETTER in the Report Definition ID.
7. Expand the View Reports Using Search Keys section.
8. Select STUDENT_NAME for search and type Owen for the value.
9. Click Search.
Note. It make take a few minutes to run.
10. Click the XMLP link for STU_LETTER [2652] - OWEN,ELLEN.HTM and then the Owen,Ellen.htm
link.
Results
The report contains the header:
190

191
Maintaining Template Translations
Translations
The Template Translation feature is based upon standard Localization Interchange File Format (XLIFF) .xlf
file processing.

Slide 104
Student Notes
Template Translations
Each report template or sub-template file can have related translation XLIFF files. These XLIFF files include
translation units for each content element to be translated. The translatable units include all the fixed verbiage
of the template excluding any values supplied by the data source. The Template Translations page includes an
action button that generates a translatable file that must then be manually edited with the appropriately
translated values. Once the translation exercise is complete, the XLIFF file is uploaded and integrated into the
XML Publisher translation system.
Note. A template must exist before it can be translated.

Template translations are not available for template types other than RTF. For a PDF report, there must be
multiple PDF templates registered to the report, one for each locale or language as required.
192
Maintaining Template Translations (continued)
Translations Component
The Template Translation component interfaces with both report definition templates and Content Library
sub-templates.
Template translation files can be created only when a report's template type is RTF.

Template Translation is a separate component with no row level security, as the target user is different from
the report developer, requestors, or viewers.
Slide 105
Student Notes
Page Used to Define Translations
Template Transactions Reporting Tools, XML Publisher, Translations and select the report or sub-template
to translate.
Use this page to generate and define a translation:
Generating Translation Files

To generate and upload a translation file:
193
1. Click the Generate Translatable File button to generate an .xlf file, which includes all translatable units
extracted from the selected (sub)template file's fixed text.
2. Save the file locally.
3. Manually translate the file and save it.
4. Use the Upload link to Upload the file.
5. Save the page.
Maintaining Translation Files

Use the Advanced Search page to find existing translations:
194
Translatable Files
The generated translatable XLIFF file includes the template's static headings and body text that require
translation into another language.
At the top of the file, the <source-language> tag indicates the base language value. The <target-language> tag

must be updated to the language you are translating into as shown here:
<?xml version="1.0" encoding="utf-8" ?>
- <xliff version="1.0">
- <file source-language="EN" target-language="FR" datatype="XDO"
original="orphen.rtf" product-version="orphen.xlf" product name="">
<header />
Slide 106
Student Notes
Translatable Files
Initially the <source-language> and <target-language> values are the same. Prior to uploading the translated
file into the database, the <target-language> tag must be edited to the translated language code. The value
must a be the two character ISO language code.
For example, fr equals French, jp equals Japanese, and so on. The file won't load if the file type isn't .xlf or if
the <source-language> equals the <target-language>, and an error message is presented.
In the <body> section of the file, each <trans-unit id> tag contains both a <source> tag and a <target> tag.
The <source> tag contains the text in the base language. The corresponding <target> tag contains the translate
fixed text.
There is no naming restriction on XLIFF files, however, it is advised to keep them close to the template file
name and include the language. For example, for a French translation of the XRFWIN template, you could
use XRFWIN_FR.xlf.
Below is an example of a translated XLIFF file:
195
<?xml version="1.0" encoding="utf-8" ?>
- <xliff version="1.0">
- <file source-language="en-US" target-language="fr-FR" datatype="XDO"
original="orphen.rtf" product-version="orphen.xlf" product name="">
<header />
- <body>
- <trans-unit id="" maxbytes="4000" maxwidth="15"
size-unit="char" translate="yes">
<source>Total</source>
<target>Totale</target>

<note>Text located: body/table</note>
</trans-unit>
- <trans-unit id="" maxbytes="4000" maxwidth="22"
size-unit="char" translate="yes">
<source>Seq Name/</source>
<target>Nom de Seq/</target>
<note>Text located: body/table/table header</note>
</trans-unit>
196
Implementing Translations
Template application criteria determines which template is used for a report:

Slide 107
Student Notes
Page Used to Define Template and Language for Translations
Bursting Reporting Tools, XML Publisher, Report Definition, Bursting
Use this page to define template and language for translations:
197
198
Lesson 8

Activity 13: Using Translations

• Create a translation file.
• Update Report Definition for translations.
Slide 108
199
Activity Overview
In this activity, you will create a translation file for the Student Certificate to Dutch. The target language is
NL. The translations are listed in this table:
Source Target
Training Certification Cursuscertificaat
Certificate of Completion Bewijs van deelname

This is to certify that Hiermee wordt verklaard dat
Has successfully completed de volgende cursus succesvol heeft afgerond
On [&1] in the [&2] facility op [&1] te
Instructor Instructeur
200

Creating a Translation File

To create a translation file:
1. Select Reporting Tools, XML Publisher, Translations.

2. Click Search.
3. Select Effective Date 1900–01–01 for Report Name CERTIFICATE.
4. Click Generate Translatable File.
5. Select Save.
6. Save the file as C:\Labs\XMLP\certificate_dutch.xlf.
7. Use Notepad to open the file C:\Labs\XMLP\certificate_dutch.xlf.
Start, Programs, Accessories, Notepad
8. Change the target language to NL.

<file source-language="EN" target-language="NL"
9. Update the target information as follows:
Source Target
Training Certification Cursuscertificaat
Certificate of Completion Bewijs van deelname
This is to certify that Hiermee wordt verklaard dat
Has successfully completed de volgende cursus succesvol heeft afgerond
On [&1] in the [&2] facility op [&1] te
Instructor Instructeur
201
10. Select file Save As and enter:
File Name C:\Labs\XMLP\certificate_dutch.xlf
Save as type All files
Encoding UTF-8
11. On the Template Translation page, click the Upload button and select

C:\Labs\XMLP\certificate_dutch.xlf.
12. Click Open and then Upload.
13. Click Preview.
Results
The Dutch translation will be displayed:
Adding Additional Translations

To add additional translations:
1. Close the Preview window.
2. Select the + icon to add a new translation file.
3. Click the Upload button and select C:\Labs\XMLP\Translations\certificate1_french.xlf.
4. Select the + icon to add a new translation file.
5. Click the Upload button and select C:\Labs\XMLP\Translations\certificate1_spanish.xlf.
202
6. Save the page.
Results
Certificate has three translation files:

Updating Report Definition for Translation
To update report definition for translations:
2. Select CERTIFICATE.
Burst By A.STUDENT_ID
Template controlled by TRAINING_LOC
203
5. Insert rows for the following locations:
Data Value Template ID Language
Amsterdam CERTIFICATE_1 Dutch
Mexico CERTIFICATE_1 Spanish
Netherlands Training Center CERTIFICATE_1 Dutch
Paris CERTIFICATE_1 French

Spain CERTIFICATE_1 Spanish
6. Click Save
Results
The template application criteria is displayed:
Scheduling the Report

2. Select Run Control ID CERTIFICATE.
204
3. Click the Update Parameters link and select:
Course 1001
Session 405
4. Click OK.
5. Click Run and the click OK.

7. Enter CERTIFICATE in the Report Definition ID and click Search.
8. Click the XMLP link for CERTIFICATE [2162] - 2162.HTM.
9. Click the 2162.htm link.
Results
The certificate is translated to Dutch.
205
Review
• Sub-templates can be created that contain formatting and data fields that are used in multiple templates.
• The content library stores sub-templates.
• Translations are only used with RTF templates and are implemented using XLIFF files.

Slide 109
Student Notes
Creating Reusable Sub-Template Definitions Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
for PeopleSoft Enterprise,"Using RTF Templates"
Using the Content Library Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
Maintaining Template Translations Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

206
Lesson 9
Using Additional RTF Techniques
Objectives

• Use Connected Query data source.
• Use time zones.
• Use drilling URL query.
Slide 111
207
Using Additional RTF Techniques Lesson 9
Using Connected Query Data Source
Knowing Your Data Source

In order to create a template, you must understand your data. XML files and Connected Query data sources
can contain multiple levels, whereas PS Query will create one flat file.

Slide 112
Student Notes
Structured XML
A simple query (including a query with multiple joins) creates a tabular plain layout. To have a hierarchical
output, you need to use multiple grouping conditions that involve complicated logic and is not always straight
forward. Connected Query processing creates a hierarchical output where a single row of data from parent
query results in a set of rows in a child query. This data is processed row by row and produces structured
data. It has similarity with SQR and Application Engine nested loops processing.
Instead of using Application Engine or SQR to collect data for file processing by XML Publisher, use
Connected Query as the data collection tool because no conditional logic is involved in this process.
However, use SQR for processes with high volume of data or when high performance is required.
Crystal reports can include the main reports and a set of sub-reports that could be combined in the same
template. Using Connected Query, you can replace a Crystal reports having main reports and sub-reports with
XML Publisher reports.
Connected Query Example

Connected query can be used to create a data source with multiple levels and relationships. This is an
example of a Connected Query for Customer Training:
208
Lesson 9 Using Additional RTF Techniques

This connected query contains the following:
Query Description
XMLP_CUSTOMER Customer Information, such as Name, address and so

forth. The query prompts for Customer ID, each report
created based on this query will have only one customer.
XMLP_STUDENTS Student information, such as name, customer, emphasis

and so forth. This query is mapped to
XMLP_CUSTOMER, based on CUSTOMER_ID, so it
will produce all students for the selected customer.
XMLP_STUDENT_COURSES This query list all courses completed for a student. This
query is mapped to XMLP_STUDENTS based on
STUDENT_ID, so it will produce all of the completed
courses for a specific student.
209
Using Connected Query Data Source (continued)
Create Template
Using a Connected Query data source, you can create a report template containing multiple sections.

Slide 113
Student Notes
Customer Training Report Template

This is an example of the Customer Training Report based on the connected query sample data file:
210
This is the completed report for customer SKU.

211
212
Lesson 9

Using Connected Query Data Source (continued)
Table/Form
The Table/Form window allows you to format your template by selecting nodes, styles, grouping and so on in
one window.

Slide 114
Student Notes
Example: Table/Form Dialog Box

The Insert Table/Form window shows you two pane views. The left pane shows the data source structure,
while the right pane shows the elements that will be copied to the template when you click the OK button.
This dialog box is based on drag&drop:
First you select the fields that you want to insert in the template and then you define how to format them.
Drag an XML element from the left Data Source pane to the right Template pane to select it. If the XML
element has children, you will see a pop-up menu with the following options:
Template pane to select it. If the XML element has children, you will see a pop-up menu with the following
options:
• Drop Single Node
• Drop All Nodes
• Cancel
Select Drop Single Node if you want to move only the selected node or Drop All if you want to move the
node and it's children.
213
If you drag an additional data field from the left Data Source pane to the right Template pane, it is either
inserted at the same level or below the node as a child where you release the node. The Insert Position box
determines which way the node is inserted.
If you use the left mouse button for the drag and drop, the node and all it's children are copied. If you use the
right mouse for dragging and dropping, a dialog box gives you the option to copy either only the selected
node or the selected node and all children.
Example: Table/Form
This is an example of a template for Purchase Orders:

When you click OK, the fields are added to your word document.
214
You can then format your RTF template using these fields.
215
Activity 14: Creating a Template Using Connected Query

Data Source
1. Create template using Table/Form.
2. Preview the template

3. Create the report definition.
4. Run the report.
Slide 115
216
Activity Overview
In this activity, you will create a report template for Enrollments by Business Unit.
This is an example of a completed template:

217

Create a Template Using Table/Form

To create a template using Table/Form:
1. In Microsoft Word, create a new blank document (File, New, Blank document.)

2. Select Data, Load XML Data.
3. Select C:\Labs\XMLP\DataSource\cq_enroll_sample.xml and click Open.
4. Click OK in the dialog box confirming the data source was loaded.
5. Use style Heading 1 and type Student Enrollment.
6. On the next line, use style Heading 1 and type Business Unit:
7. Select Insert, Field and double-click on A.BUSINESS_UNIT.
8. Move to the next line and select Insert, Table/Form.
9. Drag Crs Session by Bu from the Data Source column to the Template column.
10. Select Drop All Nodes.
11. Click on Crs Session by Bu and change properties (3rd column on page) to:
Style Free Form
Grouping A.TRAINING_LOC
12. In the template column delete A.business_unit.
13. Click on Stu Enrollment and change properties (3rd column on page) to:
Style Free Form
Sort By B.STUDENT_NAME
14. In the template column delete A.student Id, A.course, A.session Nbr, B.customer Id.
Results
This is an example of the Insert Table/Form dialog box.
218

Previewing the Template
To preview the template:
1. Click OK to insert the table/form.
2. Using style Heading 1 type Training Location: before the inserted field A.TRAINING_LOC.
3. Change the column headings in the table as follows:
Heading Change To
A.course Code
B.descr Course
A.session Nbr Session
A.start Date Start Date
Stu Enrollment Students
4. Format the template to size the columns
5. Change the style for B.STUDENT_NAME to Normal.
6. Save the template as C:\Labs\XMLP\Templates\Student_Enrollment.rft.
7. Click Preview, HTML.
Results
The report preview is displayed.
219

Creating the Report Definition
To create the report definition:
2. Click the Add a New Value link.
Report Name STU_ENROLL
Data Source ID XMLP_ENROLL_BY_BU
4. Click Add.
Report Description Student Enrollment by BU
Template Type RTF
220
Description Enrollment
8. Click the Upload button and select C:\Labs\XMLP\Templates\Student_enrollment.rtf and click Upload.

ID Type Role
14. Save the page.
Running the Report

To run the report:
3. Enter enroll for the Run Control ID and click Add.
221
4. Select the following:
Report Name STU_ENROLL
Unit NAM02

5. Click OK.
6. Click Run and then click OK.
7. Click on the Report Manager link and access the Administration tab.
8. Click on the report link for STU_ENROLL-STU_ENROLL.htm.
Results
The report is displayed.
222
Using Time Zones
Personalized Time Zones

To display personalized time zones in an XML Publisher report the following conditions must exist:
• The report template must be either RTF or XSL.
• The datetime element in the XML file must include the UTC offset, for example, 2008-07-28T09:00:00-

0700.
• The time zone must have a valid 3 character time zone code, for example PST or EST.
• The datetime field in the template should be formatted using an Oracle abstract format mask that displays
the time zone.
Slide 116
Student Notes
Page Used to Set Time Zone Personalization
Regional Settings My Personalizations, Regional Settings, Local Time Zone
223
Using Time Zones (continued)
Oracle Abstract Format Mask

To use the Microsoft format mask or the Oracle format mask, the date from the XML data source must be in
canonical format. This format is:
YYYY-MM-DDThh:mm:ss+HH:MM

The data after the "T" is optional, therefore the following date: 2009-01-01 can be formatted using either date
formatting option. Note that if you do not include the time zone offset, the time will be formatted to the UTC
time.
A Query data source includes the UTC offset for datetime fields.
Slide 117
Student Notes
Canonical Format
In the canonical format:
• YYYY is the year
• MM is the month
• DD is the day
• T is the separator between the date and time component
• hh is the hour in 24-hour format
• mm is the minutes
• ss is the seconds
• +HH:MM is the time zone offset from Universal Time (UTC), or Greenwich Mean Time
224
Using Time Zones (continued)
Form Field
In your template document, use the form field to define the mask for your date time field. Specify the abstract
mask using the following syntax:
<?format-date:fieldname;'MASK'?>

where fieldname is the XML element tag and MASK is the Oracle abstract format mask name.
For example:
<?format-date:hiredate;'SHORT'?>
<?format-date:hiredate;'LONG_TIME_TZ'?>
Slide 118
Student Notes
DateTime Masks
The following table lists the abstract format masks and the sample output that would be generated for US
locale:
Mask Output for US Locale
SHORT 12/31/2009
MEDIUM Dec. 31, 2009
LONG Thursday, December 31, 2009
SHORT_TIME 12/31/2009 6:15PM
MEDIUM_TIME Dec. 31, 2009 6:15 PM
LONG_TIME Thursday, December 31, 2009 6:15 PM
SHORT_TIME_TZ 12/31/2009 6:15 PM GMT
MEDIUM_TIME_TZ Dec. 31, 2009 6:15 PM GMT
LONG_TIME_TZ Thursday, December 31, 2009 6:15 PM GMT
Adding the Mask

Add the mask in the form field help text.
225

To add the mask:
1. Insert the date time field into your document.
2. Right-click on the date time field and select Properties.
3. Click the Advanced tab.
4. Enter the mask syntax.
5. Click OK.
226
Activity 15: Creating a Report with Time Zones

1. Set time zone personalization.
2. Update template for time zone.

4. Run the report.
Slide 119
227
Activity Overview
In the Training database, there is a test page to set up Live Virtual Class sessions. Depending on your
location, the start time will vary based on time zone. You need to create a report that reflects the time zone
you are using when you run the report.
You will perform the following tasks:
• Set time zone personalization.
The base time zone on the Training database is PST. You will add personalization to use EST.

• Update template for time zone.
The template has already been created, you just need to add time zone formatting. The template
LVCSchedule.rtf is in C:\Labs\XMLP\Templates.
• Create report definition.
Use information in this table to create the report definition:
Page Element Value
Report Name LVC_COURSES
Data Source PS Query XMLP_LVC_COURSES
Report Category XMLP_TRAINING
Security Role ALLPAGES
• Run the report.

The template has already been created, you just need to add time zone formatting.
228

Setting Time Zone Personalization

To Set time zone personalization:
1. Select XML Publisher Training, LVC Sessions.

2. Select Course 1001.
Session 1 displays the time as PST, which is the base time zone for the database.
3. Select My Personalizations.
4. Click the Personalize User Options button for Regional Settings.
5. Select Eastern Time (US) for the Local Time Zone.
6. Select Yes for the Use Local Timezone.
7. Click OK.
8. Select XML Publisher Training, LVC Sessions.
9. Select Course 1001.
Results
The data time now displays your personalization:
Updating Template for Time Zone

To Update template for time zone:
1. In Microsoft Word, open the template C:\Labs\XMLP\Templates\LVCSchedule.rtf.
229
2. Right-click on the field LVC_DATE and select Properties.
Note. You could also right-click and select BI Publisher, Properties. If the Form Field Help Text dialog
box is not displayed, click the Add Help Text button.
3. Change the code to use the Oracle Abstract Mask SHORT_TIME_TZ.

<?format-date:LVC_DATE;'SHORT_TIME_TZ'?>
4. Click OK.
5. Save the template.

Report Name LVC_SESSIONS
Data Source ID XMLP_LVC_SESSIONS
4. Click Add.
Report Description LVC Courses
Template Type RTF
230
Description LVC Courses
8. Click the Upload button and select C:\Labs\XMLP\Templates\LVCSchedule.rtf and click Upload.

ID Type Role
14. Save the page.
Running the Report

To run the report:
2. Enter LVC and click Search.
3. Click the View Report link.
Results
The report shows Eastern Standard Time.
231

Testing Another Time Zone
To test another time zone:
1. Select My Personalizations.
2. Click the Personalize User Options button for Regional Settings.
3. Select Central Time (US) for the Local Time Zone.
4. Click OK.
6. Enter LVC and click Search.
7. Click the View Report link.
232
Using Drilling URL Query
Drilling URL Query

Drilling URLs are supported in XML Publisher reports with a data source of PS Query or Connected Query.

Slide 120
Student Notes
Drilling URLs in XML Publisher Reports

When you click the drilling URL in the report depending on the drilling URL type, one of the following
occurs:
• For Query URL, the Query results are displayed.
• For Component URL, the appropriate PeopleSoft page is opened.
• For External URL, the external page is opened.
233
Using Drilling URL Query (continued)
Steps to Use Drilling Query in XML Publisher Report

To use a drilling URL in a XML Publisher report:
1. Create the query with the drilling URL defined as a field.

2. Create an RTF template.
3. In the RTF template map one or more fields to the fields that contain drilling URL
4. Create a hyperlink containing the drilling URL.
Slide 121
Student Notes
Creating Hyperlink
To create the hyperlink:
1. Highlight the field where you want to place the drilling URL
2. Select Insert (from the Word menu), Hyperlink or use Ctrl+K.
234
3. In the Insert Hyperlink dialog box, enter the URL link in Address field
Each URL link should be defined as {URL_FIELD}, where URL_FIELD is the unique field name for the
expression that contains a specific drilling URL.

4. Use the Target Frame push button to select how this URL link will be opened, either in the same window
or in the new window
235
Activity 16: Creating an XML Publisher Report with a Query

Drilling URL
1. Review the Query.
2. Modify the report template for a drilling URL.

4. Run the Report.
Slide 122
236
Activity Overview
1. Open and run the query XMLP_COURSE_TYPE_DRILL in Query Manager.
2. Modify the report template C:\Labs\XMLP\Templates\Course Listing by Type.rtf to use the drilling URL.
3. Create a report definition COURSE_TYPE using the query XMLP_COURSE_TYPE_DRILL as the data
source and C:\Labs\XMLP\Templates\Course Listing by Type.rtf for the template.

4. View the report for course type Human Resources.
5. Schedule the report for course type Financials.
237

Reviewing the Query

To review the query:
1. Select Reporting Tools, Query, Query Manager.

2. Enter XMLP_COURSE_TYPE_DRILL and click Search.
3. Select the Edit link.
4. Select the Run tab.
5. Select Human Resources and click OK.
6. Click on the Drilling URL column for course 1003.
Close the browser window after reviewing the output.
Results
The URL opens another query displaying the course sessions for the selected course.
Modifying the Report Template for a Drilling URL

To modify the report template for a drilling URL:
1. In Microsoft Word, select File, Open and select C:\Labs\XMLP\Templates\Course Listing by Type.rtf.
2. Select Data, Load XML Data and select

C:\Labs\XMLP\DataSource\XMLP_COURSE_TYPE_DRILL.xml
3. Highlight the placeholder for COURSE in the COURSE column.
238
4. Right-click and select Hyperlink.
5. In the Address edit box of the Insert Hyperlink dialog box, type {EXPR7_7}.
6. Click the Target Frame button.
7. Select New Window and click OK.
8. Click OK on the Insert Hyperlink dialog box.
9. Save the template.
Results

The Course contains a hyperlink:

Report Name COURSE_TYPE
Data Source ID XMLP_COURSE_TYPE_DRILL
4. Click Add.
239
Report Description Drill on Course
Template Type RTF

Description Drilling
8. Click the Upload button and select C:\Labs\XMLP\Templates\Course Listing by Type.rtf and click
Upload.
Note. The hyperlink does not work in Preview.
ID Type Role
14. Save the page.
Viewing the Report

To view the report:
240
2. Enter COURSE and click Search.
3. Select the View Report link for COURSE_TYPE.
4. Select Human Resources for the Type and click OK.
5. Click on the link for course 1003.
6. Close the reports after viewing them.
Results
The query will open in a new window.

Scheduling the Report
3. Enter drill in the Run Control ID.
4. Click Add.
5. Select COURSE_TYPE for the Report Name.
6. Select Financials for the type and click OK.
9. Click Search.
Note. It make take a few minutes to run.
10. Click the XMLP link for the COURSE_TYPE report and then the COURSE_TYPE.htm link.
11. Click the link for 1005 in the course column.
241
242
Results
The query will open in a new window.

Lesson 9

Review
• Connected Query data source can be used to create complex reports.
• Time zones can be used in XML Publisher reports using the Oracle abstract format mask.
• Drilling URLs can be used in XML Publisher reports using hyperlinks.

Slide 123
Student Notes
Use Time Zones Enterprise PeopleTools 8.50 PeopleBook: Global

Technology, "Setting and Maintaining Time Zones"
Use Connected Query Enterprise PeopleTools 8.50 PeopleBook: PeopleSoft

Query, "Using Connected Query"
Use Drilling URL Enterprise PeopleTools 8.50 PeopleBook: XML Publisher

for PeopleSoft Enterprise, "Creating Report Templates,
"Using Drilling URL in RTF Template"
243

Lesson 10
Running Reports Using PeopleCode
Objectives

• Run reports using PeopleCode.
• Run reports from application engine.
• Create an application engine program to create the XML file and run the report.
Slide 125
245
Running Reports Using PeopleCode Lesson 10
XML Publisher Classes

The following is the general flow of the XML Publisher classes, how and when they're used in the publishing
process.

Slide 126
Student Notes
Classes
XML Publisher prepares the report data from the data source: a PS Query, a connected query, or an XML file.
Then, XML Publisher uses the PSXP_RPTDEFNMANAGER report definition classes to generate and route
the report. Optionally, XML Publisher uses the PSXP_REPORTMGR search classes to search for a report in
the reports repository.
The XML Publisher classes enable you to access the runtime portions of the XML publishing process
programmatically, that is, after the templates and reports have been created.
The XML Publisher classes reference includes the public subset of XML Publisher classes divided into the
following sections:
• Report manager definition classes
• Report manager search classes
246
Lesson 10 Running Reports Using PeopleCode
• XML Publisher engine classes
Note. For most reports, you do not need to use the XML Publisher engine classes. In addition, you may or
may not use the report manager search classes after a report is published.
247
Running Reports Using PeopleCode (continued)
Import Classes
For importing the XML Publisher classes, PeopleSoft recommends that you import all the classes in the
application package.
Class Category Application Package Name

Report Manager definition classes PSXP_RPTDEFNMANAGER
Report search manager classes PSXP_REPORTMGR
XML Publisher engine classes PSXP_ENGINE
Slide 127
Student Notes
Importing Classes
The XML Publisher classes are not built-in classes, like rowset, field, record, and so on. They are application
classes. Before you can use these classes in your PeopleCode program, you must import them to your
program.
An import statement names either all the classes in a package or one particular application class.
Your import statements should look like the following:

import PSXP_RPTDEFNMANAGER:*;
import PSXP_REPORTMGR:*;
import PSXP_ENGINE:*;
Using the asterisks after the package name makes all the application classes directly contained in the named
package available. Application classes contained in subpackages of the named package are not made
available.
248
Publishing a Report
To generate and publish a report, the PeopleCode will:
1. Import the appropriate application class.

2. Initialize variables.
3. Instantiate the report definition object and initialize it.
4. Specify the data for the report.
5. Process the report.
6. Publish the report.
Slide 128
Student Notes
Sample PeopleCode to Publish a Report

This is an example of PeopleCode to publish a report using XML file as a data source:
1. Import the appropriate application class.
Because this program generates and publishes a report, you need to import the report manager definition
class.
2. Initialize variables.
The variable declaration strings not only specify values for the variables, but give them type and scope as
well. This can be very useful when debugging.
Local string &RptDefnId = "CUST_RPT";
Local PSXP_RPTDEFNMANAGER:ReportDefn &oRptDefn;
Local File &MYFILE;
Local Rowset &MYFILEROWSET;
Local string &LanguageCode = "ENG";
Local string &Outputformat = "HTM";
Local string &ReportPath = GetEnv("PS_SERVDIR") | "filesreports";
Local string &FolderName = "General";
Local string &ServerName = "PSNT";
Local string &file = "C:\temp\CUSTXML_FILE2.XML";
249
3. Instantiate the report definition object and initialize it.
After you instantiate a report definition object, you must initialize it and populate it using the Get method.
&oRptDefn = create PSXP_RPTDEFNMANAGER:ReportDefn(&RptDefnId);
&oRptDefn.Get();
4. Specify the data for the report.
This report uses an XML file for the data source, so you must specify the location of the XML file for the
report before you process it. , 0
&oRptDefn.SetRuntimeDataXMLFile(&file);

5. Process the report.
You must process the report, generate a version of it for the report repository, before you can distribute
the report.
&oRptDefn.ProcessReport("", &LanguageCode, %Date, &Outputformat);
6. Publish the report.
After you've generated the report, you may want to publish it to another location.
&oRptDefn.Publish(&ServerName, &ReportPath, &FolderName, 0);
250
Set Runtime Data Methods

Report definitions that use a data source other than a PeopleSoft query must set the data source before
generating the report using the ProcessReport method.

Slide 129
Student Notes
SetPSQueryPromptRecord
Use the SetPSQueryPromptRecord method to specify an already instantiated record object that contains the
prompt values for the query to be used to populate the report.
You must use this method before using the ProcessReport method.
Syntax
SetPSQueryPromptRecord(&Record)
Example
/* fill prompt */
&rcdQryPrompts = &oRptDefn.GetPSQueryPromptRecord();
If Not &rcdQryPrompts = Null Then
If Not Prompt(&oRptDefn.GetPSQueryPromptRecord().Name, "",
&rcdQryPrompts) Then
Exit;
End-If;
&oRptDefn.SetPSQueryPromptRecord(&rcdQryPrompts);
End-If;
251
SetRuntimeDataXMLFile
Use the SetRuntimeDataXMLFile method to specify an existing file as the data source for the report.
Forward or back slashes are used in the path according to the operating system of the application server or
process scheduler server. That is, on Unix servers, the directory separator is a forward slash, while a
Windows server use a path with back slashes.
Syntax
SetRuntimeDataXMLFile(FilePath)

Example
252
ProcessReport
Use the ProcessReport method to generate a report and store the information.
Syntax
ProcessReport(TemplateId, LanguageCD, AsOfDate, OutputFormat)

For XML file, you must specify that data source using SetRuntimeDataXMLFile before you process the
report.
Slide 130
Student Notes
ProcessReport
After you use the ProcessReport method, you can use the Publish method to post the report, the
DisplayOutput method to display the report in a browser window, or the PrintOutput method to print the
report.
For example, to process a report in htm format use:

&oRptDefn.ProcessReport("", STATE_REC_AET.LANGUAGE_CD, %Date, "HTM");
You can use quotes to take the default value from the report definition.
253
Publish
Use the Publish method to publish the current report definition
Syntax
Publish(ServerName, ReportPath, FolderName, ProcessInstanceId)

You must have successfully completed a call to the ProcessReport method before you can use this method,
either directly or by using one of the XML Publisher engine classes.
Slide 131
Student Notes
Publish
This is an example of publishing a report using the variables defined in the PeopleCode:
/* Publish report */
&oRptDefn.Publish(&ServerName, &ReportPath, &FolderName, 0);
Output Destination
If the output destination is file, then specify the file path.
/* specify output destination when output type is file */
If %OutDestType = 2 Then /* file */
&oRptDefn.OutDestination = %FilePath;
End-If;
Use the PrintOutput method to print the report definition object executing the method:
If %OutDestType = 3 Then /* Printer */
&oRptDefn.PrintOutput(%FilePath);
End-If;
End-If;
Output Destination Type

This table lists the values for OUTDESTTYPE:
254
7
6
5
4
3
2
1
0
Value
File
Any
Web
Type
None
Email
Printer
Default
Window
255
Displaying a Report
You can display a report online using the DisplayOutput method.
Use the CommitWork method to commit prior to issuing the DisplayOutput.

Slide 132
Student Notes
Example: Displaying the Output for XML Publisher Report

This is an example of PeopleCode to display an XML Publisher report using XML file:
256
/************************************************************/
/* Create a report to display online */
/************************************************************/
Local string &RptDefnId = "CUST_RPT";
Local File &MYFILE;
Local Rowset &MYFILEROWSET;
Local Record &recl;
Local string &file = "C:tempCUSTXML_FILE2.XML";

/*delete the file */
&MYFILE = GetFile("&file", "W", %FilePath_Absolute);
If &MYFILE.IsOpen Then
&MYFILE.Delete();
&MYFILE.Close();
End-If;
/** Create and instance of the File - this will be opened in Write mode
with an absolute path. Then associate it with the appropriate File
Layout */
&MYFILE = GetFile(&file, "W", %FilePath_Absolute);
If &MYFILE.IsOpen Then
If &MYFILE.SetFileLayout(FileLayout.CUST_XML_FILE2) Then
&MYFILEROWSET = &MYFILE.CreateRowset();
&MYFILEROWSET = GetLevel0();
&MYFILE.WriteRowset(&MYFILEROWSET, True);
Else
WinMessage("write failed");
End-If;
&MYFILE.Close();
End-If;
/* create report definition */
&oRptDefn = create PSXP_RPTDEFNMANAGER:ReportDefn(&RptDefnId);
&oRptDefn.Get();
/* process report */
&oRptDefn.ProcessReport("", "", %Date, "");
CommitWork();
&oRptDefn.DisplayOutput();
257
Activity 17: Running Reports from PeopleCode

• Define customer report.
• Complete the PeopleCode.
• Run XMLP reports from a page.

Slide 133
258
Activity Overview
In this activity, you will create a new report definition for customer information, then modify the existing
PeopleCode to display your from a page and to publish the report and lastly run the reports.
Customer Report
Use the following information to create the report:
Page Element Value/Source

Report Name CUSTOMER
Template Type RTF
Template location C:\Labs\XMLP\Templates\customer_rpt.rtf
Completing the PeopleCode
The PeopleCode to run these reports is located on the record PSU_CUST_TBL on the CUST_BUTTON
(code to display report) and REPORT (code to publish report) fields. You will need to update this code with
your new report name.
Running the Reports
Push buttons have been added to the customer page to view and run these reports. Navigate to XML Publisher
Training, Customers.
259

Defining Customer Report

To define the customer rowset report:

2. Select Add a New Value and enter:
Report Name CUSTOMER
3. Click Add.
Report Description Customer information
Template Type RTF
Description Customer Information
7. Click the Upload button and select C:\Labs\XMLP\Templates\customer_rpt.rtf and click Upload.
260
ID Type Role

14. Save the page.
Completing the PeopleCode

To complete the PeopleCode:
1. On the desktop, double-click on the PeopleTools 8.5 folder.
2. Double-click on Application Designer.
3. In Application Designer, select File, Open, Record, PSU_CUST_TBL.
4. Select View, PeopleCode Display.
5. Double-click on the FieldChange column for CUST_BUTTON.
6. Replace <REPORT_NAME> with CUSTOMER, the name of the report you just created.
This code will display the report.
8. Close the PeopleCode Editor.
9. Double-click on the FieldChange column for REPORT.
10. Replace <REPORT_NAME> with CUSTOMER , the name of the report you just created.
This code will run the report and place it in the report repository.
12. Close the PeopleCode Editor.
Running XMLP Reports From a Page

To run an XMLP reports from a page:
1. Select XML Publisher Training, Customers.
2. Select customer AAB.
261
3. Click the Publish Report button.
4. Click OK when you receive a message that the report was published to the report repository.
5. Click the Display Report button.
Results
The Report is displayed online:

262
Running Reports from Application Engine
Application Engine Program

To create an application engine program to run an XMLP Publisher report:
1. Create the run control page and component.

2. Create the state record to retrieve the parameters for the application engine program,
3. Create an application engine program.
4. Create a process definition using type XML Publisher.
Slide 134
Student Notes
Run Control Record

Depending on your report, you may or may not need to define input parameters.
No Input Parameters
If the report does not contain any input parameters, you can use the standard run control record
PRCSRUNCTRL.
Input Parameters
If the report contains input parameters, you need to create a new run control record to include your
parameters. You can open PRCSRUNCNTL and Save as a new record, then add your additional fields.
263

Run Control Page
The run control page should contain sub-record and any parameters from your run control record:
State Record
The state record for the program needs to include the parameters necessary to run the report.
264
Running Reports from Application Engine (continued)
Application Engine Program

Using the same XML Publisher PeopleCode classes, you can create an application engine program to run
XML Publisher reports. The application engine program will have a minimum of 2 steps:
1. Retrieve the run control parameters.

2. Execute the report.
The XML Publisher report name, Process Scheduler process name, and the Application Engine process name
must all be the same.
Slide 135
Student Notes
Example: Application Engine Program to Run XML Publisher Report

This is an example of an application engine program to publish a report that does not contain any parameters:
Step: RunCtrl - SQL
The run control step is used to populate the state record (in this case PT_XRFWIN_AET) with the run control
ID, user and language.
%Select(PT_XRFWIN_AET.OPRID, PT_XRFWIN_AET.RUN_CNTL_ID,
PT_XRFWIN_AET.LANGUAGE_CD)
SELECT OPRID
, RUN_CNTL_ID
, LANGUAGE_CD
FROM %Table(PRCSRUNCNTL)
WHERE OPRID = %OperatorId
AND RUN_CNTL_ID = %RunControl
Step ExecRpt - PeopleCode
This step contains the PeopleCode to run the report.
265
/* XML Publisher sample report using query data source */
/* create report definition */
&oRptDefn = create PSXP_RPTDEFNMANAGER:ReportDefn("XRFWIN");
&oRptDefn.Get();
/* specify output destination when output type is file */
If %OutDestType = 2 Then /* file */
&oRptDefn.OutDestination = %FilePath;

End-If;
/* process report */
&oRptDefn.ProcessReport("", PT_XRFWIN_AET.LANGUAGE_CD, %Date,
&oRptDefn.GetOutDestFormatString(%OutDestFormat));
/* send output to destination */
If %OutDestType = 6 Then /* Web */
&oRptDefn.Publish("", "", "", PT_XRFWIN_AET.PROCESS_INSTANCE);
Else
If %OutDestType = 3 Then /* Printer */
&oRptDefn.PrintOutput(%FilePath);
End-If;
End-If;
266
Process Definition
After creating the application engine program, you will need to set up the process definition and where you
want to run the report.

Slide 136
Student Notes
Setting Up Process Definition

To run the application engine program through the Process Scheduler, you will need to:
• Create a new Run Control page and component or associate the application engine program with an existing
Run Control component.
• Create a Process Definition with the same name as the application engine program and using type XML
Publisher
267
Pages Used to Define a Process Definition
Process Definition Options PeopleTools, Process Scheduler, Process Definition

Access the Process Definition Options tab

The Process Definition for this report defines the run control component and process group:
268
Populating Parameters for Query-Based Reports

If you create an application engine program to run a query-based XML Publisher report with parameters, you
will need to retrieve the values fro the run control record. Use the following methods:
• GetPSQueryPromptRecord()

Use the GetPSQueryPromptRecord method to return the runtime prompts of a query as a record object.
• SetPSQueryPromptRecord(&Record)
Use the SetPSQueryPromptRecord method to specify an already instantiated record object that contains the
prompt values for the query to be used to populate the report.
Slide 137
Student Notes
Fill
This snippet of sample code is used to populate the query prompt values:
/* fill prompt */
&rcdQryPrompts = &oRptDefn.GetPSQueryPromptRecord();
If Not &rcdQryPrompts = Null Then
&rcdQryRunParms = CreateRecord(Record.PSU_RUN_CRS_BU);
&sqlSelectQryParms = CreateSQL("%Selectall(:1) WHERE OPRID = :2 AND
RUN_CNTL_ID = :3");
&sqlSelectQryParms.Execute(&rcdQryRunParms, %OperatorId,
PSU_CRS_AET.RUN_CNTL_ID);

While &sqlSelectQryParms.Fetch(&rcdQryRunParms)
For &i = 1 To &rcdQryPrompts.FieldCount
&FieldValue = &rcdQryPrompts.GetField(&i).Name;
&rcdQryPrompts.GetField(@("Field." | &FieldValue)).Value =
&rcdQryRunParms.GetField(@("Field." | &FieldValue)).Value;
End-For;
End-While;
&sqlSelectQryParms.Close();
&oRptDefn.SetPSQueryPromptRecord(&rcdQryPrompts);
End-If;
SQLExec("SELECT START_DATE FROM <RUN_CONTROL_TABLE> WHERE OPRID = :1 AND
RUN_CNTL_ID = :2", %OperatorId, PSU_CRS_AET.RUN_CNTL_ID, &type);
269
Activity 18: Creating Application Engine Program

1. Modify application engine program.
2. Create the process definition.
3. Schedule the report.

4. Optionally add the report to the Reporting Console.
Slide 138
270
Activity Overview
1. Modify application engine program to run Customer Training report. This table lists the details for the
application engine program:
Definition Name
Application Engine Program COURSE_TYPE

State record COURSE_TYPE_AET
Run Control table PS_PSU_RUN_COURSE
Report Name COURSE_TYPE
2. Create the process definition.
Definition Name
Process Category Default
Component RUN_COURSE_TYPE
Process Group TLSALL
3. Run the report.
271

Modifying Application Engine Program

To modify application engine program:
1. In Application Designer, select File, Open, Application Engine, COURSE_TYPE.

2. Expand the MAIN section.
3. Double-click on the PeopleCode Step/Action.
4. Replace <REPORT_NAME> with COURSE_TYPE.
5. Replace <RUN_CONTROL_TABLE> with PS_PSU_RUN_COURSE.
Creating the Process Definition

To create the process definition:
1. Sign on to the browser.
2. Select PeopleTools, Process Scheduler, Processes.
3. Click the Add a New Value tab and enter:
Process Type XML Publisher
Process Name COURSE_TYPE
4. Click Add.
5. Enter Default for Process Category.
6. Select the Process Definition Options tab and enter:
Component RUN_COURSE_TYPE
Process Group TLSALL
7. Click Save.
272
Results
The process definition is type XML Publisher and the options determine the component and process group.

Running the Report
To Run the report:
1. Select XML Publisher Training, Run XMLP Reports, Run Course Type Report.
2. Select Add a New Value tab and enter Run Control ID Type.
3. Click Add and select Course Type Financials.
4. Click Run and then click OK.
5. Click the Report Manager link.
6. Access the Administration page.
7. Click Refresh until the report appears.
Adding the XML Publisher Report to Reporting Console (Optional)

To add the XML Publisher Report to Reporting Console:
2. Expand My Favorites.
3. Click the Add link for the Course Reports folder.
273
Process Bookmarks Selected
Process Type/Name Selected
Process Type XML Publisher
Process Name COURSE_TYPE

5. Click Search and select COURSE_TYPE.
Results
The process is added to My Favorites, however you can not run the report.
Enabling Generic Prompting (Optional)

To enable generic prompting:
1. Click the Edit link for the COURSE_TYPE bookmark.
2. Select Enable Generic Prompting.
3. Enter the Runtime parameters:
Record (Table) Name PSU_RUN_COURSE
Record.Field COURSE_TYPE
274
4. Click the Select Label link in the Display Label column.
Label Type RFT Long
Field Label ID COURSE_TYPE
5. Click OK.
Results

You can now run the process from the Reporting Console.
275
Creating Application Engine to Create File and Run Report
File Layout
File layouts can be used to output data to an XML file.
To create a file layout for xml output:

1. Create a new file layout.
2. Insert the records or segments.
3. Select File, Definition Properties, Use tab.
4. Select XML for the file output and enter the File Definition Tag.
5. For records and fields, you can change the tags if desired.
6. Save the file layout.
Slide 139
Student Notes
Sample File Layout

Create the file layout to include the records and/or segments required. This is an example of a multi-level file
layout:
276
File Layout Properties

Select XML for the file layout format and indicate the File Definition Tag for the XML file root:
277
Creating Application Engine to Create File and Run Report

(continued)
Using File Layout for XML Publisher Report

The application engine program can create the XML file and then publish an XMLP report using that data
source:

Slide 140
278
Student Notes
Example: PeopleCode to Write to File

/*******************************************************************/
/* Method: Write XML File for multi-level file */
/* Description: Create XMLFile for Student 2001 */
/*******************************************************************/
Local File &MYFILE;

Local Rowset &rowsetl, &rowset2;
Local Record &recl, &rec2;
Local SQL &SQL1, &SQL2;
Local string &Student = "2001";
/********** Create an Instance of the records ***************/
&recl = CreateRecord(Record.PSU_STUDENT_TBL);
&rec2 = CreateRecord(Record.PSU_STUDENT_EXP);
/********** Create an Instance of the rowsets ***************/
&rowset1 = CreateRowset(Record.PSU_STUDENT_TBL,
CreateRowset(Record.PSU_STUDENT_EXP));
&rowset2 = &rowset1.GetRow(1).GetRowset(1);
/** Create an instance of the File - this will be opened in Write mode
with an absolute path. Then associate it with the appropriate File Layout
*/
&MYFILE = GetFile("C:LabsxmlpSTUDENT_EXP.xml", "W", %FilePath_Absolute);
&MYFILE.SetFileLayout(FileLayout.STUDENT_XML);
/* Create SQL object to retrieve the values from the rowset */
&SQL1 = CreateSQL("%selectall(:1)where STUDENT_ID = :2 ", &recl,
&Student);
&SQL2 = CreateSQL("%selectall(:1)where STUDENT_ID = :2 ", &rec2,
&Student);
/* Loop through the rowset to get the values and write the rowset to
file */
While &SQL1.Fetch(&recl)
/*copy record to rowset */
&recl.CopyFieldsTo(&rowset1.GetRow(1).PSU_STUDENT_TBL);
&I = 1;
/* Fetch data from PSU_STUDENT_EXP */
While &SQL2.Fetch(&rec2)
/* Copy record to the rowset */
&rec2.CopyFieldsTo(&rowset2.GetRow(&I).PSU_STUDENT_EXP);
&rowset2.InsertRow(&I);
&I = &I + 1;
End-While;
&MYFILE.WriteRowset(&rowset1);
End-While;
279
/* Close the file */
&MYFILE.Close();
Creating an Application Engine Export Program

Use these steps to create an export application engine program:
1. In PeopleSoft Application Designer, select File, New, Application Engine.
2. Select Insert, Action.
3. Save the program.

4. Change the action type to PeopleCode.
5. Enter the PeopleCode to export the file.
6. Save the program.
7. Run the program.
280
Activity 19: Running XMLP Report from Application Engine

• Create a new data source.
• Create a new template.
• Define the Student Experience report.

• Modify the application engine program.
• Run XMLP report from an application engine program.
Slide 141
281
Activity Overview
In this activity, you have been asked to create a new report that lists student experience by student. You will
need to create the data source, create the template, define the report and modify the application engine
program to publish the report.
Some of the development has already been completed for you:
• The application engine program STUDENT_EXP will write an XML file, based on the Student Id provided
on the run control page.

The XML is written to C:\Labs\XMLP. Use the XML File for your data source.
Once you have created your data source, template and report definition, you can add a step to this
application engine program to publish the report.
• To access the run control page for this program, select XMLP Training, Run Student Report.
282

Creating a New Data Source

To create a new data source:
1. Select XML Publisher Training, Run XMLP Reports, Run Student Report.

3. Enter Student and click Add.
4. Enter 2001 for the Student ID.
5. Click Run.
6. Click OK.
7. Click the Process Monitor link.
8. Click the Refresh button.
9. Verify that the Run Status is Success and Distribution Status is Posted.
12. Select XML File for the Data Source Type.
13. Enter STUDENT_EXP for the Data Source ID and click Add.
14. Enter Student Experience for the Description.
15. Click the Upload link for Sample Data File.
16. Browse to find C:\Labs\XMLP\STUDENT_EXP.xml.
17. Click Upload.
18. Click Save.
Creating a New Template

To create a new template:
1. In Microsoft Word, select File, New, Blank Document.
2. Select Data, Load XML Data, C:\Labs\XMLP\STUDENT_EXP.xml.
3. Design your new report.
283
4. Save the template as C:\Labs\XMLP\Templates\student_exp.rtf.
Note. The data source contains two rowsets, when you use the table/form wizard make sure you select the
correct rowset in the Grouping Field.
Suggested Layout
This is a suggested layout for the template:

Defining Student Experience Report
To define the Student Experience report:
2. Select Add a New Value and enter:
Report Name STUDENT_EXP
Data Source ID STUDENT_EXP
3. Click Add.
284
Report Description Student Experience
Template Type RTF

Description Student Experience
7. Click the Upload button and select C:\Labs\XMLP\Templates\student_exp.rtf and click Upload.
ID Type Role
14. Save the page.
Modifying the Application Engine Program

To modify the application engine program:
1. In Application Designer, select File, Open, Application Engine, XMLP_STU_EXP.
285
2. Expand the section MAIN.
3. Click on the step XMLOut and select Insert, Step/Action.
4. Change the step name to ExecRpt.
5. Change the Action to PeopleCode.
6. Double-click the action and enter the PeopleCode to publish the STUDENT_EXP report.
Note. A copy of the PeopleCode is located in C:\Labs\XMLP\Misc\publish_stu_exp.txt.

8. Close the Application Engine program.
Running XMLP report from an Application Engine Program

To run XMLP report from an Application Engine program:
1. Select XML Publisher Training, Run XMLP Reports, Run Student Report.
2. Select Run Control Id Student.
3. Select Student ID 2113.
4. Click Run.
5. Click OK.
6. Click the Process Monitor link.
7. Click the Refresh button.
8. Verify that the Run Status is Success.
9. Select Reporting Tools, XML Publisher, XMLP Report Search.
10. Enter STUDENT_EXP for the Report Definition ID and click Search.
11. Click on the link for your report.
286
Review
• The XML Publisher classes enable you to access the runtime portions of the XML publishing process
programmatically, that is, after the templates and reports have been created.
• The XML Publisher classes can be used in application engine programs to publish XML Publisher reports.

• Your application engine program can produce the XML file and then run the report.
Slide 142
Student Notes
Run reports using PeopleCode Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
for PeopleSoft Enterprise, "Running Reports Using
PeopleCode"
Run reports from Application Engine Enterprise PeopleTools 8.50 PeopleBook: XML Publisher
for PeopleSoft Enterprise, "Running Reports in Process
Scheduler"
287

Lesson 11
Course Review
Objectives

In this course you learned how to:
• Set up XML Publisher for PeopleSoft applications.
• Create and register data sources.
• Create templates.
• Define XML Publisher reports.
• Run and view XML Publisher reports.
Slide 144
289
Course Review Lesson 11
Describing XML Publisher
XML Publisher
XML Publisher is a template-based reporting solution that separates the data extraction process from the
report layout:

Slide 145
290
Lesson 11 Course Review
Setting Up XML Publisher for PeopleSoft Applications
XML Publisher Set Up

Set up includes:
• Configuring xdo.cfg file.
• Assigning XML Publisher permissions to users.

• Setting up Report Manager.
• Defining report categories.
• Downloading design plug-in.
Slide 146
291
Data Sources
XML data can be generated using any means including PS Query, SQR, Application Engine, PeopleCode,
File Layout and so forth.
For PS Query, the system will generate the sample data and schema.

Benefits of data source registration include the ability to:
• Reuse the data source with multiple report definitions.
• Perform iterative template development.
• Preview the template.
Slide 147
292
Creating Templates
Template Design
Template design involves the construction of a report's layout in a template file.
For RTF templates, the design plug-in facilitates mapping the sample data file fields into the report template.
For PDF templates, you can generate a mapping file that associates existing from fields with the appropriate

data fields in the sample data file.
Slide 148
293
XML Publisher Report Definitions

Report definitions are used to:
• Associate a data source with a template.

• Grant security to view report.
• Define bursting options.
Slide 149
294
Running and Viewing XML Publisher Reports
Running and Viewing Reports

Depending on the report type, the options available for running reports include:
• Query Report View
• Query Report Scheduler

• Online PeopleCode
• Batch PeopleCode
Reports stored in folders can be viewed using:
• Report Manager
• XMLP Report Search
Slide 150
295

Appendix A
Supplemental Information

Contents
This appendix includes:
• XMLP Tables
• Migrating XMLP definitions
• Cleaning up XML Publisher metadata
XMLP Tables
This table lists the tables used for XML Publisher:
297
Supplemental Information Appendix A
Table Description
PSXPDATASRC XMLP Data Source Definition
PSXPDATASRCDEL XMLP Data Source Delete
PSXPDATASRCLNG XMLP Data Source Definition Language
PSXPRPTCAT XMLP Report Category
PSXPRPTCATAUTH XMLP Report Authorization

PSXPRPTCATLNG XMLP Report Category Language
PSXPRPTDEFN XMLP Report Definition
PSXPRPTDEFNDEL XMLP Report delete
PSXPRPTDEFNLNG XMLP Report Definition Language
PSXPRPTOUTFMT XMLP Report Output Format
PSXPRPTSCOPEFLD XMLP Report Scope Definition
298
Appendix A Supplemental Information
Table Description
PSXPRPTSRCHKEYS XMLP Report Definition Search keys
PSXPRPTTMPL XMLP Report Template relation
PSXPRPTTMPLCTRL XMLP Report Template Control table
PSXPRPTVIEWER XMLP Report Viewer table
PSXPSCHEMAFLMN XMLP Schema table

PSXPSMPLDTMN XMLP Sample Data table
PSXPTMPLDEFN XMLP Template Definition
PSXPTMPLDEFNDEL XMLP Template Definition delete
PSXPTMPLDEFNLNG XMLP Template Definition Languages
PSXPTMPLFILEDEF XMLP Template File Definition
PSXPTMPLOUTFMT XMLP Template Output format definition
PSXPTMPLTRINFO XMLP Template Translation information
PSXPTMPLTYPE XMLP Template Type Definition
PSXPTMPLTYPELNG XMLP Template Type Definition Language
PSXP_FILEURL XMLP File URL
PSXP_FLURL_ARCH XMLP File URL
PSXP_RATTR_ARCH Report Attributes archive
PSXP_RATTR_TBL Report Attributes table
Migrating XMLP Definitions

The following definition types can be added to projects in Application Designer:
• XMLP Data Src Defn.
• XMLP File Defn.
• XMLP Report Defn.
• XMLP Template Defn.
299
Supplemental Information Appendix A
To insert XMLP definitions into a project in Application Designer, select Insert, Definitions into project. It is
important to select all related definitions.
Definition Related Definitions
XMLP Report Defn XMLP File Defn

XMLP Template Defn
XMLP Template Defn XMLP File Defn
XMLP template translation uses related XLIFF files (one for each language) that contain not only specific

translation pair but the whole template definition. This is a standard for using XLIFF translation
methodology. Since the translation is tied to the template definition, the translation file (XMLP Template
Defn) as well as the specific XLIFF files (XMLP File Defn) should be included in the project.
Cleaning Up XML Publisher Metadata

To insure the integrity of the XML Publisher files run the application engine program PSXPCLEAN.
This application engine program will:
• Find unreferenced objects in PSFILEDEFN.
• Find template definitions and template translations for which file objects are missing.
• Find inconsistencies between PSFILEDEFN and PSFILEDATA.

This application engine program is delivered in Report and Delete mode. To run the program in Report Only
mode, open PSXPCLEAN in Application Designer and uncomment the following statement in
PSXPCLEAN:Main:Start PeopleCode action:
rem PSXPFILECLN_AET.REPORT_ONLY_FLAG = "Y"
PSXPCLEAN could be scheduled and run via PeopleTools, Process Scheduler, System Process Request page.
This program should be run on a regular basis to keep template metadata consistent.
Note. This program is delivered with PeopleTools 8.49 and above. This program also works for PeopleTools
8.48 and is available on Customer Connection.
300

XML Publisher (Peoplesoft)

Hochgeladen von

Dokumentinformationen

Copyright

Dieses Dokument teilen

Dokument teilen oder einbetten

Freigabeoptionen

Stufen Sie dieses Dokument als nützlich ein?

Sind diese Inhalte unangemessen?

Copyright:

XML Publisher (Peoplesoft)

Hochgeladen von

Copyright:

THESE eKIT MATERIALS ARE FOR YOUR USE IN THIS CLASSROOM ONLY.

COPYING eKIT MATERIALS FROM THIS COMPUTER IS STRICTLY PROHIBITED

Oracle University and Businessmind Colombia SA use only

Copyright © 2009, Oracle and/or its affiliates. All rights reserved.

Oracle University and Businessmind Colombia SA use only

Oracle University and Businessmind Colombia SA use only

Oracle University and Businessmind Colombia SA use only

Oracle University and Businessmind Colombia SA use only

Oracle University and Businessmind Colombia SA use only

Oracle University and Businessmind Colombia SA use only

• Describe XML Publisher.

• Set up XML Publisher for PeopleSoft applications.

• Create and register data sources.

• Define XML Publisher reports.

• Run and view XML Publisher reports.

• Setting up XML Publisher for PeopleSoft applications

• Creating and registering data sources

Oracle University and Businessmind Colombia SA use only

• Defining XML Publisher reports

• Running and viewing Query-based XML Publisher reports

• Running and viewing Query-based XML Publisher reports (continued)

• Implementing sub-templates and template translations

Oracle University and Businessmind Colombia SA use only

• Running reports using PeopleCode

Oracle University and Businessmind Colombia SA use only

Oracle University and Businessmind Colombia SA use only

• Describe XML Publisher.

• Describe the XML Publisher phases.

• Describe optional features.

• Describe sources of information about XML Publisher.

Describing XML Publisher

Oracle University and Businessmind Colombia SA use only

• Provides a choice of output formats.

Benefits of XML Publisher

• Allowing business users to rapidly create rich production reports.

Describing XML Publisher (continued)

XML Publisher Overview

Oracle University and Businessmind Colombia SA use only

XML Publisher Overview

Oracle University and Businessmind Colombia SA use only

Describing XML Publisher (continued)

Reporting Tools When to consider XML Publisher instead:

Oracle University and Businessmind Colombia SA use only

nVision Consider XML Publisher instead of nVision tabular layouts.

Some examples of when to use XML Publisher include:

• Billing - provides a third print option for invoices.

• CRM - provides improvements to correspondence management.

• HCM - Government forms, paychecks, offer letter generation.

Describing XML Publisher (continued)

XML Publisher Components

Oracle University and Businessmind Colombia SA use only

XML Publisher Components

Describing XML Publisher Phases

Oracle University and Businessmind Colombia SA use only

Phase 1: Set Up XML Publisher

2. Set up XML Publisher permissions.

3. Set up Report Manager.

4. Define report categories.

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

Phase 2: Create and Register Data Sources

2. Register sample data files.

Phase 3: Create Report Templates

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

Phase 4: Define XML Publisher Reports

Oracle University and Businessmind Colombia SA use only

2. Upload report template.

3. Add additional features such as bursting and translations.