Bursting Options

People Soft - People Tools

XML PUBLISHER
 Bursting Options
XML PUBLISHER INTRODUCTION

ü Oracle has developed a standalone Java-based reporting technology

called XML Publisher (XMLP) that streamlines report and form
People Soft - People Tools

generation.

ü Oracle's XML Publisher product is the separation of the data extraction

process from the report layout.

ü XML Publisher provides the ability to design and create report layout
templates with the more common desktop applications of Microsoft
Word and Adobe Acrobat, and renders XML data based on those
templates.

ü With a single template, it can generate reports in many formats (PDF,

RTF, Excel, HTML, and so on) in many languages. This approach to
reporting can dramatically reduce report maintenance, enabling power
business users to adjust report templates without involvement of IT
resources.
 Bursting Options
XML Publisher Concept
People Soft - People Tools
 Bursting Options
XML Publisher Phases

XML Publisher implementation can be divided into the following phases:

People Soft - People Tools

üSet up XML Publisher.

üCreate and register data sources.

ü
üCreate and upload report templates.

üDefine XML Publisher reports.

üRun, locate and view XML Publisher reports.

 Bursting Options
Prepare to use XML Publisher

Defining XML Publisher Global Engine Settings :

People Soft - People Tools

ü XML Publisher Global Engine 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.
 Bursting Options
Prepare to use XML Publisher

The default xdo.cfg file contains the following settings:

<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">
People Soft - People Tools

<properties>
<!-- System level properties -->
<property name="xslt-xdoparser">true</property>
<property name=“xslt- scalable">true</property>
<property name="system-temp-dir">CACHE</property>
<property name="system-cachepage-size">50</property>
<!-- PDF compression -->
<property name=“pdf-compression">true</property>
<!-- PDF Security -->
<property name=“pdf-security">true</property>
<property name=“pdf-open-password">user</property>
<property name=“pdf-permissions-password">owner</property>
</properties>
</config>
 Bursting Options
Prepare to use XML Publisher

ü You can also specify an application server or process scheduler domain-

specific xdo.cfg file. To do this, you need to change the application
People Soft - People Tools

server or process scheduler configuration file to update theJavaVM

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/P8488041directory.

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
where P8488041 is the Application Server domain name.
 Bursting Options
Assigning XMLP Permissions to Users

üXML Publisher menu access is permission list driven and depends on

permission list and role assignment. PeopleTools delivers permission list
security and roles for XML Publisher report developers and XML
People Soft - People Tools

Publisher power users.

üPermission list PTPT2600 is intended for report developers. Users
assigned a role with this permission list have access to all XML Publisher
components, including set up capability on the advanced feature Report
Definition Bursting page.
üPermission list PTPT2500 is intended for power users and provides
access to Query data sources for ad hoc reporting through Query Report
Viewer and Query Report Scheduler. This permission list also provides
access to report definitions and to the Content Library, though access to
the report definition bursting information is view only.
üUsers assigned to other permission lists and roles, such as permission
list PTPT1000, may only have access to the XML Publisher Report
Repository.
 Bursting Options
Data Source Registration

üPs Query:
üSelect Reporting Tools, XML Publisher,Data source,Data source type.
People Soft - People Tools

ü Xml file,Schema file can be Regenerated by using Regenerate Option

 Bursting Options
Data Source Registration

ü Xml file:
üSelect Reporting Tools, XML Publisher,Data source,Data source type.
People Soft - People Tools

ü Upload Xml file and Schema file.

ü The above Data source Registration is same for Xml Doc and Rowset.
 Bursting Options
Creating an RTF Template

Introduction

XML Publisher’s RTF Template Parser converts documents saved as the

People Soft - People Tools

RTF file type to XSL-FO. You can therefore create report designs using many of
your standard word processing application’s design features and XML Publisher
will recognize and maintain the design.

During design time, you add data fields and other markup to your template
using XML Publisher’s simplified tags for XSL expressions. These tags associate
the XML report data to your report layout. XML Publisher also supports the use of
pure XSL elements in the template.

XML Publisher supports other advanced reporting features such as

conditional formatting, dynamic data columns, running totals, and charts.
 Bursting Options
Creating an RTF Template

Supported Modes

XML Publisher supports two methods for creating RTF templates:

People Soft - People Tools

ü Basic RTF Method

Use any word processing application that supports RTF version 1.6 writer (or
later) to design a template using XML Publisher’s simplified syntax.
ü Form Field Method
Using Microsoft Word’s form field feature allows you to place the syntax in hidden
form fields, rather than directly into the design of your template. XML Publisher
supports Microsoft Word 2000 (or later) with Microsoft Windows version 2000 (or
later).
Note: If you use XSL or XSL:FO code rather than the simplified syntax, you must
use the form field method.
 Bursting Options
Creating an RTF Template

Overview

Creating an RTF template file consists of two basic steps:

People Soft - People Tools

üDesign your template layout.

Use the formatting features of your word processing application and save
the file as RTF.

üMark up your template layout.

Insert the XML Publisher simplified tags.
 Bursting Options
Creating an RTF Template

Using the XML Publisher Template Builder

The Template Builder is an extension to Microsoft Word that simplifies the

People Soft - People Tools

development of RTF templates. Use it in conjunction with this manual to increase

your productivity.
The Template Builder is tightly integrated with Microsoft Word and allows you to
perform the following functions:
üInsert data fields
üInsert data-driven tables
üInsert data-driven forms
üInsert data-driven chart
üPreview your template with sample XML data
üBrowse and update the content of form fields
üExtract boilerplate text into an XLIFF translation file
and test
translations.
 Bursting Options
Creating an RTF Template

Identifying Placeholders and Groups

RTF template content and layout must correspond to the content and
People Soft - People Tools

hierarchy of The input XML file. Each data field in your template must map to an
element in the XML file. Each group of repeating elements in RTF template must
correspond to a parent-child relationship in the XML file.
To map the data fields you define placeholders. To designate the repeating
elements, you define groups.
Note: XML Publisher supports regrouping of data if your report requires grouping that
does not follow the hierarchy of your incoming XML data.
 Bursting Options
Creating an RTF Template

Designing the Template Layout

Use your word processing application’s formatting features to create the design.
People Soft - People Tools

For example:
üSelect the size, font, and alignment of text
üInsert bullets and numbering
üDraw borders around paragraphs
üInclude a watermark
üInclude images (jpg, gif, or png)
üUse table auto formatting
üInsert a header and footer.
 Bursting Options
Creating New template

ü üGo to Programs open Micro soft word and go to file open new template.
ü In that we have five options
People Soft - People Tools

1.Data
2.Insert
ü 3.Preview
ü 4.Tools
ü 5.Help
üü Load your Xml data, Xml schema file into Data option.
ü
ü Go to Insert option you can insert all fields which is there in xml file.
ü
üü you can add Header and Footer for your template.
ü
üü Go to Preview Option You can select RTF format.
üü
ü Save the template .
 Bursting Options
Sample template

ü üHeader Section:
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Sample Template

ü üFooter Section:
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Template Defination

ü
ü Upload the template file.
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Creating Report Definition

üüSelect Reporting Tools, XML Publisher,Report Definition.

People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Setting output options

ü
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Setting Security options

ü
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Bursting Options

ü
ü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.
People Soft - People Tools

ü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 vendor purchase orders or customer
üü
üinvoices. With bursting, you can generate individual report files resulting in
üseparate secured output. For example, generating a file for each vendor,
customer or employee.
ü
üü
Bursting can only be defined when the report’s data source has an
üassociated schema file. Numerous bursting instructions depend upon
üthe data coming from the application as defined by the schema tags.
ü
 Bursting Options

üWhen users are assigned a role with PTPT2600 permission list, they have access to
setup entries on the Bursting page.
People Soft - People Tools

üThere is also a view only permission list (PTPT2500) option for XML Publisher power
users that provides view-only access to the bursting information.

üThe bursting page appears for the power user only when there are existing bursting
instructions for the report.
 Bursting Options
Bursting Options

ü
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü The report generates multiple files at runtime with a separate report
ü instance file generated each time a unique value appears for the Burst by data
tag. This feature dynamically drives the template assignment at runtime based
upon the data value of a designated schema tag. You can assign a language
code to apply a specific template translation as well.
 Bursting Options

ü A template ID should be selected for each data value that requires a special template.
ü At runtime, the process looks for the specified template and language.
People Soft - People Tools

 If the language does not exist, then the base untranslated template is applied.
 If a data value is encountered that is not assigned on the report definition, then the
 template ID entered on the run control is assigned.
 If no Template ID selection is captured at runtime, then the default template of the
 report definition is applied.

•
 Bursting Options
People Soft - People Tools

Bursting security can be utilized to supplement or replace the basic report

viewer security by role or user ID. 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.
 Bursting Options

ü The report designer must provide the record name of the security join
table and
designate the common fields to join with the bursting field.
People Soft - People Tools

ü The system performs the join and determine who can view the report
instances. This matching allows the Report Manager’s posting process to
dynamically identify the user IDs or roles that are assigned viewing rights for
each report instance.
ü
ü At least one type of security should be completed either on the Security
page or on the Bursting page.
ü
ü Set security in both places to secure bursted files differently from securing
the report definition.
ü
ü If security on the Bursting page is blank, then the security set on the
Report Definition Security page applies.
ü
ü If the Security page is also blank, then the report requestor gets put in as
the viewer by default and all the bursted report files are accessible only by the
report requestor.
ü Security can be assigned from all three places, if desired.
 Bursting Options
Running Xml Publisher

ü
Reports can be generated by using Xml Publisher in three ways :

ü Query Report viewer

People Soft - People Tools

ü Process scheduler
ü ü Peoplecode
ü
ü By Using Query report viewer we can run only one datasource
ü üPs Query
ü
ü By using Process scheduler and Peoplecode we can run all types of datasources
ü
ü üPs Query
ü üXml File
ü üXml Doc
üRowset
 Bursting Options
Running Ps Query using Query Report Scheduler

ü
üSelect Reporting Tools, XML Publisher, Query Report Scheduler.
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Running Ps Query using Query Report Scheduler

ü üCheck your process in Process Monitor.

People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü

ü Report can be viewed in Report Manager.

 Bursting Options
Running Ps Query By using Peoplecode

ü ü
import PSXP_RPTDEFNMANAGER:*;
/* get report definition object */
&oRptDefn = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);
People Soft - People Tools

&oRptDefn.Get();
ü /* fill query runtime prompt record */
ü &rcdQryPrompts = %RptDefn.GetPSQueryPromptRecord();
ü If Not &rcdQryPrompts = Null Then
&oRptDefn.SetPSQueryPromptRecord(&rcdQryPrompts);
ü End-If;
ü /*generate report*/
ü &oRptDefn.ProcessReport (&sTmpltID, &sLangCd, &AsOfDate,
ü &sOutFormat);
ü /*publish report */
ü &oRptDefn.Publish(&sPrcsServerName,"",&sFolder, &prcsInstId);
ü
 Bursting Options
Running Ps Query By using Peoplecode

ü Import the appropriate application class.

üBecause the above program generates and publishs a report, you need to import the
report manager definition class.
import PSXP_RPTDEFNMANAGER:*;
People Soft - People Tools

ü 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 = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);
&oRptDefn.Get();
ü
ü
ü ü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 (&sTmpltID, &sLangCd, &AsOfDate,
ü
&sOutFormat);
ü
ü Publish the report.
After you've generated the report, you may want to publish it to another location.
&oRptDefn.Publish(&sPrcsServerName,"",&sFolder, &prcsInstId);
 Bursting Options
Running XMLFile By using Peoplecode

ü ü
import PSXP_RPTDEFNMANAGER:*;
/* get report definition object */
People Soft - People Tools

&oRptDefn = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);

&oRptDefn.Get();
ü /* pass XMLFile to the report definition */
ü &oRptDefn.SetRuntimeDataXMLFile(&sXMLFilePath);
ü /*generate report*/
ü &oRptDefn.ProcessReport (&sTmpltID, &sLangCd, &AsOfDate,
ü &sOutFormat);
/*publish report */
ü
&oRptDefn.PrintOutput(&sDestinationPath);
ü
ü
ü
ü
 Bursting Options
Running XML File By using Peoplecode

ü Import the appropriate application class.

üBecause the above program generates and publishs a report, you need to import the
report manager definition class.
import PSXP_RPTDEFNMANAGER:*;
People Soft - People Tools

ü 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 = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);
ü
&oRptDefn.Get();
ü üPass XMLFile to the report definition .
ü&oRptDefn.SetRuntimeDataXMLFile(&sXMLFilePath);
üUse the SetRuntimeDataXMLFile method to specify an existing file as the
üdata source for the report.
ü ü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 (&sTmpltID, &sLangCd, &AsOfDate,
&sOutFormat);
ü Publish the report.
After you've generated the report, you may want to publish it to another location.
&oRptDefn.PrintOutput(&sDestinationPath);
 Bursting Options
Running XML Doc By using Peoplecode

ü import PSXP_RPTDEFNMANAGER:*;
Local XmlDoc &xmlDoc;
Local PSXP_RPTDEFNMANAGER:ReportDefn &rptDefn;
Local boolean &ret;
People Soft - People Tools

&xmlDoc = CreateXmlDoc("");
ü &ret = &xmlDoc.ParseXmlFromURL("C:\report\PHONELIST.xml");
ü /* get report definition object */
&oRptDefn = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);
ü &oRptDefn.Get();
ü /* Attach XML Doc to the report definition */
ü &oRptDefn.SetRuntimeDataXMLDoc(&xmlDoc);.
ü /*generate report*/
ü &oRptDefn.ProcessReport (&sTmpltID, &sLangCd, &AsOfDate,
ü &sOutFormat);
ü /*publish report */
&oRptDefn.PrintOutput(&sDestinationPath);
ü
 Bursting Options
Running XML Doc By using Peoplecode

ü Import the appropriate application class.

üBecause the above program generates and publishs a report, you need to import the
report manager definition class.
import PSXP_RPTDEFNMANAGER:*;
People Soft - People Tools

ü 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 = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);
ü
&oRptDefn.Get();
ü üAttach XML Doc to the report definition .
ü&oRptDefn.SetRuntimeDataXMLDoc(&xmlDoc);
üUse the SetRuntimeDataXMLDoc method to specify an existing XmlDoc object as
üthe data source for the report .
ü 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 (&sTmpltID, &sLangCd, &AsOfDate,
&sOutFormat);
ü Publish the report.
After you've generated the report, you may want to publish it to another location.
&oRptDefn.PrintOutput(&sDestinationPath);
 Bursting Options
Running Rowset By using Peoplecode

ü import PSXP_RPTDEFNMANAGER:*;
Local PSXP_RPTDEFNMANAGER:ReportDefn &oRptDefn;
Local Rowset &oRowSet;
/* get report definition object */
People Soft - People Tools

&oRptDefn = createPSXP_RPTDEFNMANAGER:ReportDefn (&sRptDefn);

ü &oRptDefn.Get();
ü &oRowSet =CreateRowset(Record.Recordname);
ü /* Attach Rowset to the report definition */
&oRptDefn.SetRuntimeDataRowset(&oRowSet);
ü /*generate report*/
ü &oRptDefn.ProcessReport (&sTmpltID, &sLangCd, &AsOfDate,
ü &sOutFormat);
ü /*publish report */
ü &oRptDefn.PrintOutput(&sDestinationPath);
ü
ü
 Bursting Options
Running Rowset By using Peoplecode

ü Import the appropriate application class.

üBecause the above program generates and publishs a report, you need to import the
report manager definition class.
import PSXP_RPTDEFNMANAGER:*;
People Soft - People Tools

ü 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 (&sRptDefn);
ü
&oRptDefn.Get();
ü üAttach Rowset to the report definition .
ü&oRptDefn.SetRuntimeDataRowset(&oRowSet);
üUse the SetRuntimeDataRowset method to specify an existing rowset object as the
üdata source for the report.
ü ü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 (&sTmpltID, &sLangCd, &AsOfDate,
&sOutFormat);
ü Publish the report.
After you've generated the report, you may want to publish it to another location.
&oRptDefn.PrintOutput(&sDestinationPath);
 Bursting Options
Viewing Report

ü
üSelect Reporting Tools,Report manager.
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options
Viewing Report

ü
People Soft - People Tools

ü
ü
ü
ü
ü
ü
ü
ü
ü
ü
 Bursting Options

ü
People Soft - People Tools

ü
ü
ü
ü Thank You
ü
ü
ü
ü
ü
ü