PeopleSoft XML Publisher

Feb 2, 2009 By Mritunjay & Gajalakshmi
PS Technical Training


‡ ‡ ‡ ‡ ‡ ‡ ‡ ‡

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

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.

PS Technical Training

Java Runtime Environment (JRE) 1. PeopleTools 2.4. Microsoft Word 2000 (or later versions) 4 PS Technical Training . and Microsof .0 3.Prerequisites 1.Net 2.

5 PS Technical Training . You can save the download anywhere (for example. From the left navigation bar in PeopleSoft Applications.Installation 1. Download the Template Builder by clicking the Plug-in link. select XML Publisher> Setup > Design Helper to download the Template Builder. 2. in c:\temp).

A set of installation wizard pages guide you through the installation process. After XML Publisher Desktop is installed.exe to start the installation process. 4.. Notice a menu item named Template Builder in the menu bar and a new toolbar. open Microsoft Word. 3. Double-click setup.Installation cntd. 6 PS Technical Training .

Setting translation properties.cfg file is located in the $PSHOME/appserver directory. Setting font locations and substitutions. Setting properties for PDF.Settings XML Publisher Global Engine Settings 1. and HTML output files. Setting PDF security properties. The default xdo.cfg file is primarily used for: Setting a temporary directory. which is shared by all application server and process scheduler domains by default.Define XML Publisher settings. The xdo. 7 PS Technical Training . RTF.

3.Power users Now the user can have access to all components to the XML Publisher menu. PTPT2600 . 2. 8 PS Technical Training .XMLP Power User .XMLP Report Developer .Report developers PTPT2500 .Set up XML Publisher permissions.Setting contd.Set Up Report Manager: Activating Domain: PeopleTools-> Integration Tools-> Configuration-> Quick Configuration Service Operations PeopleTools->Integration Tools-> Integration Setup-> Service Operations PSRF_FOLDER_CREATE PSRF_REPORT_CREATE PSRF_REPORT_DATE_CHANGE PSRF_REPORT_DELETE The Default Service Operation Version must be ACTIVE..

‡Internally all data source types will be converted to xml files before passing them to the core formatting engine 9 PS Technical Training .Report Data Sources ‡ Source Types: PeopleSoft Query  Rowset object  XMLDoc object  XML files. Application Engine. ‡For improved performance. ‡XML data can be generated using PS/Query. PeopleCode.. and use XML File as a data source for all other means of data generation. SQR. FileLayout etc. Rowset and XMLDoc data sources should only be used for small low volume reports Moderate to large reports should use XML files as their data sources.

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 10 PS Technical Training .

Flow Diagram 11 PS Technical Training .

rtf file) ‡ Create Report definition ‡ Run the report using Query Report Scheduler ‡ View results using Query Report Viewer 12 PS Technical Training .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 (.

Data Source Creation 13 PS Technical Training .

14 PS Technical Training .DS Contd..

Report Definition 15 PS Technical Training .

. 16 PS Technical Training .Report Definition contd.

Report Definition 17 PS Technical Training .

Report Definition 18 PS Technical Training .

Creation of .rtf file Refer the below attached for creating .rtf file Microsoft Office Word Document 19 PS Technical Training .

View Report (PS Query) 20 PS Technical Training .

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 21 PS Technical Training .

Rowset Rpt ± Data Source 22 PS Technical Training .

Report Defn 23 PS Technical Training .

Component string &mySchema. &f2. /*package method*/ &mySchema = &rds.xml".DEPT_TBL). &f2. "W".Close().WriteLine(&myXMLFile). /*Create Schema*/ &rds = create PSXP_XMLGEN:RowSetDS(). &f1.xsd"). Local File &f1.Fill("WHERE FILL. 24 PS Technical Training . &f1.Application Engine Program For Creating XML and XSD Files: import PSXP_XMLGEN:*. /*Fill Rowset*/ &rs.Close().SETID = 'AUS01'"). /*Create Sample XML File*/ &myXMLFile = &rds. /*Create Rowset*/ &rs = CreateRowset(Record. &myXMLFile. "W". &f2 = GetFile("c:\temp\DEPT_XML. "C:\temp\DEPT_XSD. Local Rowset &rs.xsd". %FilePath_Absolute).getXSDSchema(&rs).WriteLine(&mySchema). %FilePath_Absolute).getXMLData(&rs. &f2. &f1 = GetFile("c:\temp\DEPT_XSD.

SetRuntimeDataRowset(&rs). /*Create Rowset*/ &rs = CreateRowset(Record. &rptDefn. CT_XMLROW_AET. import PSXP_XMLGEN:*. &rptDefn. Local string &folderName = "General". Local string &rptDefnId = "CT_XMLROW".ProcessReport(&sTemplateId. &rptDefn.Application Engine Program For Generating Report Output import PSXP_RPTDEFNMANAGER:*. %Date.Publish("". Local PSXP_RPTDEFNMANAGER:ReportDefn &rptDefn. "".SETID = 'AUS01'"). &outputfmt). PS Technical Training 25 . Local Rowset &rs. "XMLP". Local string &LanguageCode = "ENG". Local string &outputfmt = "HTM". Local string &sTemplateId = "CT_XMLROW_1".Fill("WHERE FILL. /*Fill Rowset*/ &rs.PROCESS_INSTANCE).Get(). &LanguageCode. &rptDefn = create PSXP_RPTDEFNMANAGER:ReportDefn(&rptDefnId). &rptDefn.DEPT_TBL).

View Report 26 PS Technical Training .

Sample .Report Output Click Here to view the output HTML Document 27 PS Technical Training .

Select both Related Definitions (XMLP File Defn. When migrating an XMLP report. Records used in Rowset. Create a new project 3. PS1). 4. Select Report Defn Id and press Insert button. XMLP Templates Defn) 5. 2. Report Definition with ALL RELATED OBJECTS being highlighted in Object selection dialog 28 PS Technical Training . PeopleSoft Objects used for data collection ( Query. File Layout.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. Data Source b. etc) c. please include the following into your project: a. Insert XML Report Definition wanted. Open Application Designer on the first environment (ex.

5. 7. 2. PS2). Open Application Designer on the second environment (ex. Press Copy button How to import a Project from a file? 1. Open the imported project and verify all the definitions imported. 29 PS Technical Training .XMLP File Defn objects 6. Press the Copy button 6. Select the new project created above. Press Select button after the selection of the project. Go to the Tools menu > Copy Project option > From File option 3. Go to the Tools menu > Copy Project option > To File option 8.Go to the Upgrade tab and see all the definitions inserted. 4.

cfg 2) Application Engine Process Type definition CWD field value may be Null or %%DBBIN%% 30 PS Technical Training ..cfg 2) Application Engine Process Type definition CWD field value must be Null ‡When PSAESRV is used. two configuration changes are required: 1) psprcs./.cfg parameter JavaVM Options = -Dxdo. configurations required: 1) psprcs. ‡When PSAE is used.ConfigFile=%PS_HOME%/appserv/xdo.cfg parameter JavaVM Options = Dxdo.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. rather than the PSAESRV..ConfigFile=./xdo.

‡-. import *.dat.dms (example pt848tls.64) ‡ Re-run the original DMS statements in pt<ver>tls.populate initial list of supported output types SET LOG PT<ver>TLS_PSXPTMPLOUTFMT. ‡-.dat.Trouble Shooting Case 2: Field is Required: PSXPRPTFMT_VW . 31 PS Technical Training . set input PSXPTMPLOUTFMT.log.PT_TEMPLATE_TYPE (124.populate initial list of allowed template file formats SET LOG PT<ver>TLS_PSXPTMPLTYPE. import *. delete from PSXPTMPLOUTFMT. delete from PSXPTMPLTYPE. set input PSXPTMPLTYPE.dms) to put the data in their target environments.log.

32 PS Technical Training . For example: property name="system-temp-dir">c:\temp</property>. The relative path specified will work if the Current Working Directory specified is blank into the Process Type definition for App Engine .RTF and not for HTM and XLS. due to not using PSAESRV service under the appserver domain. Restart both application server and process scheduler.Trouble Shooting Case 3: Error generating report output In this case there could be two reasons why the relative "CACHE" directory does not work. 2) It does exist under the PS_SERVDIR directory. 1) It doesn't exist under the PS_SERVDIR directory.cfg file. 2. In the xdo.under %PSHOME%\appserv. If psaesrv service is not started. The system-temp-dir property is used only for PDF. or 1. then: 1. there is a setting called system-temp-dir (<property name="system-temp-dir">CACHE</property>).

(You can also use absolute path %PS_HOME%/APPSERV/xdo. Please also try to stop both application server and process scheduler. (2. Using absolute pathes is more reliable option. clear CACHE and start both of them.cfg. 33 PS Technical Training ./.ConfigFile=.jar and axdoparser.cfg and psprcs.) A reconfigure of the appserver and process scheduler domains using psadmin is required for changes to take effect.Trouble Shooting Case 4: Java VM library jvm not found.cfg.jar to the beginning of this string value and bounce your domains.. Please check if 'Add to CLASSPATH' key is populated in AppServer and/or PRCS configuration files. You can add xdo56./xdo.717) You should check both psappsrv.cfg entries JavaVM Options=-Dxdo..

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 34 PS Technical Training .

Samples ? 35 PS Technical Training .

Q&A 36 PS Technical Training .

Thank You ! 37 PS Technical Training .

Sign up to vote on this title
UsefulNot useful