XML Publisher for PeopleSoft Enterprise
Objective
Increase awareness of additional reporting tools in PeopleSoft
Demonstrate the ease of creation and Maintenance of reports created in XML Publisher
Detail additional enhancements not available in standard query and Crystal Reports
XML Publisher overview.What is it and Where is it?How does it compare with SQR, Crystal?How is it structured?
Basic Reporting. How to create XMLP Report using RTF
Template? How to create XMLP Report using PDF
Template?Administration
Global engine settings.Security.
Advanced ReportingUsing People Code XML Publisher
Classes.Using other data sources (Rowset, XML
File, XML Doc)ToolKit Report Explanation
Agenda
XML PublisherReleased in PeopleTools 8.48. Standalone Java based technology that
streamlines report generation.Template based reporting tool, separating
data extraction from report layout. Can create report templates using Windows
applications like Microsoft Word, Adobe Acrobat.
Generate multiple reports in many formats like PDF,RTF,HTML and EXCEL etc.
Data Source
Report Layout
XML PublisherReportOutput
Overview
Data source or data extraction is separated from Report Layout which provides the ability to use Windows based applications for defining report template.
XML Publisher - Comparison
Criteria XMLP SQR CrystalCompatibility Unix, NT Unix, NT NT Data Source Query, Rowset,
XML file, XML doc
Code Query
Report Design Word, PDF files Code Crystal file Report Definition Database SQR File Crystal file Report Formatting Easy Hard Medium Report Output Pdf, Rtf,
Html.XLS Pdf, Html, Lis, Spf
Pdf, Rtf, Html.XLS
Structure of XML Publisher
There are different phases in developing a XML Publisher report:Setting Up XML Publisher.Creating and registering data sources.Creating Report templates.Defining Report definitions.Running the XML Publisher reports.
XML Publisher overview.What is it and Where is it?How does it compare with SQR, Crystal?How is it structured?
Basic Reporting. How to create XMLP Report using RTF Template? How to create XMLP Report using PDF Template?
AdministrationGlobal engine settings.Security.
Advanced ReportingUsing PeopleCode XML Publisher Classes.Using other data sources (Rowset, XML Doc, XML File)
Agenda
Creating an XMLP Report Using Query Steps involved in creating a XML Publisher
report using PS Query:Create a query. Create a data source.Create a report template.Create a report definition.Running, viewing and testing the report.
Creating a Query
Navigation: Reporting Tools > Query > Query Manager
Create a new query using Query Manager and use it as a PS Query data source.
Creating a Data Source
Navigation: Reporting Tools > XML Publisher > Data Source
Creating a Data Source
Creating a Data Source
Click on the ERP_EMPLOYEES_DS.XML and save it for the next step. The file will be used to create a RTF report template.
Navigation: Reporting Tools >XML Publisher > Setup, Design Helper
Setup Design Helper
Design Helper is used by the developer to create report templates.
The plug-in provided is for Microsoft Word to do offline RTF template design.
For PDF templates a Javascript is embedded into the template itself after uploading it to PeopleTools.
Creating a Report Template
The plug-in that was installed in the previous step creates a new tool bar menu in Microsoft Word.
The new tool bar can be used to create RTF templates to be used in creating report definitions.
Creating a Report Template
Click on Load XML Data
Select the file that was saved after creating a data source
Creating a Report Template
Click on the file that was saved after creating the data source and select Open. The message “Data loaded successfully” appears. Now the report template can be created by inserting data field tags.
Creating a Report Template
Design your template in RTF format and insert the data field tags into the template.
Click on “Insert\Field” to insert the data field tags.
Creating a Report Template
The Field creator dialog box will appear.
Place your cursor where you want to insert your data field tag.
Click on the field in the list shown and click “Insert” to insert the tag.
Repeat the procedure for all the fields you want to insert in your template.
Creating a Report Template
Data field tags can be edited using Field browser dialog box.Tags are also used to perform looping in a report.Looping tags are created automatically when we use
“Table/Form” tool.
Creating a Report Template
Preview the report by clicking “Preview” on Microsoft Word Template Builder tool bar menu and select the format. The Preview uses only sample data.
Creating a Report Definition
Navigation: Reporting Tools > XML Publisher > Report Definition
Creating a Report Definition - Definition
Creating a Report Definition - Template
At least one template should be associated with a report definition for it to be saved.
Only one default template is allowed but a report definition can have multiple report templates.
Creating a Report Definition - Output
The output options will determine what output type and output format prompts will be available on Process Scheduler Request page and Query Report Viewer for query based reports.
Creating a Report Definition - Security
The Security page is used to set up who can view web-posted output in the Report Manager repository and through the XML Publisher Report Repository Search page.
Creating a Report Definition - Bursting
Used for generation of a templated report layout many times for multiple like sets of data.
Different templates can be assigned based on the data value of “Burst by” field.
Running, Viewing Reports
Query report viewer is used to view query based reports.Navigation: Reporting Tools > XML Publisher > Query
Report Viewer.Query Report scheduler needs to be used for reports with
bursting as the reports are generated based on a field value.Navigation: Reporting Tools > XML Publisher > Query
Report Scheduler.
Running\Viewing Reports - Query Report Scheduler
Running, Viewing Reports - Report Manager
Report manager gives the list of reports generated and posted in the report repository.
Click on the link to view the report or go to the report repository to view it.
Navigation: Reporting Tools > Report Manager
XML Publisher overview.What is it and Where is it?How does it compare with SQR, Crystal?How is it structured?
Basic Reporting. How to create XMLP Report using RTF Template? How to create XMLP Report using PDF Template?
AdministrationGlobal engine settings.Security.
Advanced ReportingUsing PeopleCode XML Publisher Classes.Using other data sources (Rowset, XML Doc, XML File)
Agenda
Creating a XML Publisher Report - PDF Template
•XML Publisher supports Adobe Acrobat 5.0 (PDF specification version 1.4) only.
•Make sure you save your file as Adobe Acrobat 5.0 compatible or compatibility issues will be created while creating a report definition.
•If you are using Adobe Acrobat Professional 6.0 (or later), use the Reduce File Size Option (from the Document menu) to save your file as Adobe Acrobat 5.0 compatible.
•Form fields need to be created that will display data from the input XML file.
•Use the Forms toolbar to create placeholders using the Text field tool as shown.
•A pop-up is generated after you create the placeholder.
Creating a XML Publisher Report - PDF Template
Creating XML Publisher Report – PDF Template
Enter a name for the placeholder in Text field property. Enter either the XML source field name or a different name.
Placeholder name should not contain “.” character. If different names are used, map the template field to the
data source field during report definition creation. If same name is used no mapping is required.
Creating XML Publisher Report - PDF Template
Create placeholders for all the fields and name them accordingly.
Save the file which will be used as a template in creating the report definition.
Creating XML Publisher Report - PDF Template
Create a report definition using PS query as the data source. Same data source that was used for RTF template is used here.
Template type is PDF and rest of the report properties are same as for RTF template.
Creating XML Publisher Report - PDF Template
Two files that need to be uploaded in Template files section where as for RTF template, only the RTF template needs to be uploaded.
Upload the PDF template file that was created by Clicking on “Upload” button.
Click “Generate”.Save the PDF file
generated for mapping.
Creating XML Publisher Report - PDF Template
Creating XML Publisher Report - PDF Template
A Java script window is embedded into template file.
Click on the field and a pop-up appears with all fields in the data source,
Map the field by selecting the field on the java script window and Click “Select”.
Creating XML Publisher Report - PDF Template
Map all the fields by clicking on each field and mapping it to the respective fields in Java script window.
Save the file which has to be uploaded in Template files section as “Map file”.
Save the Report definition after the map file is uploaded.
Creating XML Publisher Report - PDF Template
Running, Viewing Reports
•Use the Query report viewer to view the report.
•Click on the “View Report” link to view the report in PDF format.
•Report definitions with PDF template can have reports only in PDF format generated.
Agenda
XML Publisher overview.What is it and Where is it?How does it compare with SQR, Crystal?How is it structured?
Basic Reporting. How to create XMLP Report using RTF Template? How to create XMLP Report using PDF Template?
AdministrationGlobal engine settings.Security.
Advanced ReportingUsing PeopleCode XML Publisher Classes.Using other data sources (Rowset, XML Doc, XML File)
Administration – Global Engine Settings
XML Publisher Global engine settings are defined in xdo.cfg file.
File is located in $PSHOME/ appserver directory and it defines the location of the CACHE directory. By default system-temp-dir property is set to CACHE.
Default template font at design time can be set in this file.
XML Publisher - Security
XML Publisher access is controlled by permission lists and role assignment.
XMLP Report Developer role (PTPT 2600) is for report developers. Users assigned to this role have access to all XML Publisher components including the bursting setup in Report definition.
XMLP Power User role (PTPT 2500) is for power users and gives access to query data sources and ad hoc reporting capabilities.
XML Publisher - Security
XML Publisher Security involves three categories:Defining Reports: Query security determines which
queries the users have access to use and create reports. Report category defines who can view and edit XML Publisher report definitions.
Running Reports: Application security and Process Scheduler security determine who can run reports. XML Publisher does not provide additional security beyond what PeopleSoft currently provides.
Viewing Reports: Security for viewing the reports is controlled by both the Distribution ID field on the Report Definition, Security page. Additional viewing security can also be defined for bursted reports on the Report Definition, Bursting page using views.
Navigation: Reporting Tools > XML Publisher > Setup > Report Category
XML Publisher - Security
Report category is required attribute on all report definitions and it applies row level security to the data on those components.
Agenda
XML Publisher overview.What is it and Where is it?How does it compare with SQR, Crystal?How is it structured?
Basic Reporting. How to create XMLP Report using RTF Template? How to create XMLP Report using PDF Template?
AdministrationGlobal engine settings.Security.
Advanced ReportingUsing PeopleCode XML Publisher Classes.Using other data sources (Rowset, XML Doc, XML File)
Creating XML Publisher Report - Rowset Data Source
The files required for Data source registration were generated using Application Engine.
Methods in PSXP_XMLGEN application package can be used to generate the XML and XSD files.
Creating XML Publisher Report - Rowset Data Source
Files generated using the Application Engine should be uploaded in the data source.
Creating XML Publisher Report - Rowset Data Source
Creating XML Publisher Report - Rowset Data Source
Creating XML Publisher Report - Rowset Data Source
•After creating the report definition, report can be generated using online PeopleCode or application engine process.
Creating a XML Publisher Report - Rowset Data Source
Creating a XML Publisher Report - Rowset Data Source
Creating a XML Publisher Report - Rowset Data Source
Create a application engine process to run the report.Navigation: PeopleTools > Process Scheduler > Processes
• Run the report using the Request AE tool.
Navigation: PeopleTools > Application Engine > Request AE
Creating a XML Publisher Report - Rowset Data Source
Creating a XML Publisher Report - Rowset Data Source
Check the process monitor to see whether the requested application engine has successfully run or not.Navigation: PeopleTools > Process Scheduler > Process
Monitor
Creating XML Publisher Report - Rowset Data Source
Report manager gives the list of reports generated and posted in the report repository.
Click on the link to view the report or go to the report repository to view it.
Navigation: Reporting Tools > Report Manager.
Creating a XML Publisher Report – XML File Data Source
Creating a XML Publisher Report – XML File Data Source
Sample data file was created using combination of Application engine and File layout.
File was uploaded into XML File type data source.
• A report definition was created using the XML File data source.
• A RTF template was created and assigned to this definition.
Creating a XML Publisher Report – XML File Data Source
Creating a XML Publisher Report – XML File Data Source
Creating a XML Publisher Report – XML File Data Source
Create a application engine process to run the report.Run the report using the Request AE tool.Check the process monitor to see whether the
requested application engine has successfully run or not.
Check the Report Manager and click on the report to view it.
Toolkit ReportToolkit Report. XML file based report. Create the Data sourceCreate the TemplateCreate a Driving program which is
Application Engine Program to do all the validations.
Publish report output through XMLPUse bursting feature to break the Report on
State.
XML Publisher overview.What is it and Where is it?How does it compare with SQR, Crystal?How is it structured?
Basic Reporting. How to create XMLP Report using RTF Template? How to create XMLP Report using PDF Template?
AdministrationGlobal engine settings.Security.
Advanced Reporting
Using PeopleCode XML Publisher Classes.
Using other data sources ( Rowset, XML Doc, XML File).
Agenda
Questions ?