XML Publisher

1

PS Technical Training

Feb 2, 2009

By

Mritunjay & Gajalakshmi

PeopleSoft XML Publisher

2


Agenda

• Definition• Installation and Settings• Report Creation Steps• PS Query Based Report• Rowset Based Report• Migrating between Instances • Trouble Shooting• Samples

3


Definition

XML Publisher /Oracle Business Intelligence Publisher / BI Publisher / XMLP

It is a template-based reporting tool that leverages standard technologies for data extraction and display

It segregates the Data Logic from the Presentation Layout during development of the reports and combines them at run time

End users with minimal training are able to design templates and reports based on generally designed data sources, thus greatly reducing the cost of ownership.

4


Prerequisites

1. PeopleTools2. Java Runtime Environment (JRE) 1.4. and Microsof .Net 2.03. Microsoft Word 2000 (or later versions)

5


Installation

1. From the left navigation bar in PeopleSoft Applications, select XML Publisher> Setup > Design Helper to download the Template Builder.

2. Download the Template Builder by clicking the Plug-in link. You can save the download anywhere (for example, in c:\temp).

6


Installation cntd.,

3. Double-click setup.exe to start the installation process. A set of installation wizard pages guide you through the installation process.

4. After XML Publisher Desktop is installed, open Microsoft Word. Notice a menu item named Template Builder in the menu bar and a new toolbar.

7


Settings

XML Publisher Global Engine Settings

1.Define XML Publisher settings.

The xdo.cfg file is primarily used for:Setting a temporary directory.Setting properties for PDF, RTF, and HTML output files.Setting PDF security properties.Setting font locations and substitutions.Setting translation properties.

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.

8


Setting contd.,

2.Set up XML Publisher permissions.PTPT2600 - XMLP Report Developer - Report developersPTPT2500 - XMLP Power User - Power usersNow the user can have access to all components to the XML Publisher menu.

3.Set Up Report Manager:Activating Domain: PeopleTools-> Integration Tools-> Configuration-> Quick ConfigurationService Operations PeopleTools->Integration Tools-> Integration Setup-> Service Operations PSRF_FOLDER_CREATE PSRF_REPORT_CREATE PSRF_REPORT_DATE_CHANGE PSRF_REPORT_DELETEThe Default Service Operation Version must be ACTIVE.

9


Report Data Sources

• Source Types:PeopleSoft Query Rowset object XMLDoc object XML files.

•For improved performance, Rowset and XMLDoc data sources should only be used for small low volume reportsModerate to large reports should use XML files as their data sources.

•XML data can be generated using PS/Query, SQR, Application Engine, PeopleCode, FileLayout etc., and use XML File as a data source for all other means of data generation.

•Internally all data source types will be converted to xml files before passing them to the core formatting engine

10


Report Generation

Steps to be Followed:

Create Data Source

Create xml and xsd files

Crete template file – For RTF File•Open Word Document•Go to Add Ins Tab•Load XML• Using Insert Tab, Create Table• Save as .rtf file.

Create Report Definition

Run the report definition

11


Flow Diagram

12


PS Query Report

Steps for Query report Generation:

•Create PS Query

• Create a Data Source which is of type PS Query

• Generate the xml and schema file in Data source definition page.

• Create template (.rtf file)

• Create Report definition

• Run the report using Query Report Scheduler

• View results using Query Report Viewer

13


Data Source Creation

14


DS Contd.,

15


Report Definition

16


Report Definition contd.,

17


Report Definition

18


Report Definition

19


Creation of .rtf file

Refer the below attached for creating .rtf file

Microsoft Office Word Document

20


View Report (PS Query)

21


Rowset Based Report

• Generate XML and XSD Files

• Create Data Source as type “Rowset”

• Create Template

• Create Report Definition

• Create Application Engine Program

• Create Process Definition

• Run the Report

• View Report in Report Manager

22


Rowset Rpt – Data Source

23


Report Defn

24


Application Engine Program

For Creating XML and XSD Files:

import PSXP_XMLGEN:*;

Local Rowset &rs;Component string &mySchema, &myXMLFile;Local File &f1, &f2;

/*Create Rowset*/&rs = CreateRowset(Record.DEPT_TBL);

/*Fill Rowset*/&rs.Fill("WHERE FILL.SETID = 'AUS01'");

/*Create Schema*/&rds = create PSXP_XMLGEN:RowSetDS(); /*package method*/&mySchema = &rds.getXSDSchema(&rs);&f1 = GetFile("c:\temp\DEPT_XSD.xsd", "W", %FilePath_Absolute);&f1.WriteLine(&mySchema);&f1.Close();

/*Create Sample XML File*/&myXMLFile = &rds.getXMLData(&rs, "C:\temp\DEPT_XSD.xsd");&f2 = GetFile("c:\temp\DEPT_XML.xml", "W", %FilePath_Absolute);&f2.WriteLine(&myXMLFile);&f2.Close();

25


Application Engine Program

For Generating Report Output

import PSXP_RPTDEFNMANAGER:*;import PSXP_XMLGEN:*;

Local Rowset &rs;Local string &rptDefnId = "CT_XMLROW";Local string &LanguageCode = "ENG";Local string &outputfmt = "HTM";Local string &sTemplateId = "CT_XMLROW_1";Local string &folderName = "General";Local PSXP_RPTDEFNMANAGER:ReportDefn &rptDefn;

&rptDefn = create PSXP_RPTDEFNMANAGER:ReportDefn(&rptDefnId);&rptDefn.Get();

/*Create Rowset*/&rs = CreateRowset(Record.DEPT_TBL);

/*Fill Rowset*/&rs.Fill("WHERE FILL.SETID = 'AUS01'");

&rptDefn.SetRuntimeDataRowset(&rs);

&rptDefn.ProcessReport(&sTemplateId, &LanguageCode, %Date, &outputfmt);

&rptDefn.Publish("", "", "XMLP", CT_XMLROW_AET.PROCESS_INSTANCE);

26


View Report

27


Sample - Report Output

Click Here to view the output

HTML Document

28


XMLP File Defn objects

Steps to migrate XMLP File Defn objects from one environment to another:

How to export a Project to a file?1. Open Application Designer on the first environment (ex. PS1).2. Create a new project 3. Insert XML Report Definition wanted.4.Select both Related Definitions (XMLP File Defn, XMLP Templates Defn)5. Select Report Defn Id and press Insert button.

When migrating an XMLP report, please include the following into your project: a. Data Source b. PeopleSoft Objects used for data collection ( Query, File Layout, Records used in Rowset, etc) c. Report Definition with ALL RELATED OBJECTS being highlighted in Object selection dialog

29


XMLP File Defn objects

6.Go to the Upgrade tab and see all the definitions inserted.7. Go to the Tools menu > Copy Project option > To File option8. Press Copy button

How to import a Project from a file?1. Open Application Designer on the second environment (ex. PS2).2. Go to the Tools menu > Copy Project option > From File option3. Select the new project created above.4. Press Select button after the selection of the project.5. Press the Copy button6. Open the imported project and verify all the definitions imported.

30


Trouble Shooting

Case 1: The system cannot find the path specified

•Check the process scheduler is using PSAESRV Application Engine servers and see what is configured for the JavaVM Options parameter.

•When PSAE is used, rather than the PSAESRV, two configuration changes are required: 1) psprcs.cfg parameter JavaVM Options = -Dxdo.ConfigFile=%PS_HOME%/appserv/xdo.cfg2) Application Engine Process Type definition CWD field value must be Null

•When PSAESRV is used, configurations required:1) psprcs.cfg parameter JavaVM Options = -Dxdo.ConfigFile=../../xdo.cfg2) Application Engine Process Type definition CWD field value may be Null or %%DBBIN%%

31


Trouble Shooting

Case 2: Field is Required: PSXPRPTFMT_VW - PT_TEMPLATE_TYPE (124,64)

• Re-run the original DMS statements in pt<ver>tls.dms (example pt848tls.dms) to put the data in their target environments.

•-- populate initial list of allowed template file formatsSET LOG PT<ver>TLS_PSXPTMPLTYPE.log;set input PSXPTMPLTYPE.dat;delete from PSXPTMPLTYPE;import *;

•-- populate initial list of supported output typesSET LOG PT<ver>TLS_PSXPTMPLOUTFMT.log;set input PSXPTMPLOUTFMT.dat;delete from PSXPTMPLOUTFMT;import *;

32


Trouble Shooting

Case 3: Error generating report output

In this case there could be two reasons why the relative "CACHE" directory does not work.1)It doesn't exist under the PS_SERVDIR directory.2)It does exist under the PS_SERVDIR directory, due to not using PSAESRV service under the appserver domain.

If psaesrv service is not started, then:1.The relative path specified will work if the Current Working Directory specified is blank into the Process Type definition for App Engine . or 1. In the xdo.cfg file,under %PSHOME%\appserv, there is a setting called system-temp-dir (<property name="system-temp-dir">CACHE</property>). The system-temp-dir property is used only for PDF,RTF and not for HTMand XLS. For example: property name="system-temp-dir">c:\temp</property>.

2. Restart both application server and process scheduler.

33


Trouble Shooting

Case 4: Java VM library jvm not found. (2,717)

You should check both psappsrv.cfg and psprcs.cfg entries JavaVM Options=-Dxdo.ConfigFile=../../xdo.cfg.

(You can also use absolute path %PS_HOME%/APPSERV/xdo.cfg. Using absolute pathes is more reliable option.)

A reconfigure of the appserver and process scheduler domains using psadmin is required for changes to take effect.

Please check if 'Add to CLASSPATH' key is populated in AppServer and/or PRCS configuration files. You can add xdo56.jar and axdoparser.jar to the beginning of this string value and bounce your domains.

Please also try to stop both application server and process scheduler, clear CACHE and start both of them.

34


Trouble Shooting

Case 5: Error : Field Does Not Exist

Solutions:

• Check AET State Record is attached with AE

• Check the Table is built

• Check the particular field exists in the record

•Check for Naming mistakes

35


Samples ?

36


Q & A

37


Thank You !

XML Publisher

Documents

report view report

report rowset

ps technical training

ps technical training

xml data

report manager

query report generation

minimal training