';

Home PeopleCode & PeopleTools o Application Class Basics o Dynamic Hyperlink & Hover Text o Email Using Application Package o File Attachments o PeopleTools Tables (Where the MetaData is Stored) o Populate & Sort the DropDown Box o Print a PeopleSoft Page with JavaScript o XML Publisher (BI Publisher) XML Publisher Basics Using PS Query View XML Publisher in Query Report Viewer XML Publisher in PeopleCode SQL Examples o Alter Session o Append Text to a LONG Field o CASE Statements o DB Link o GROUP BY o Hints o Oracle Lock Who/What? o OUTER JOIN and a Sub Query o Project Items List via SQL o Public Synonyms o Retrieve Only First x Rows o Running Total Column o Sub Query Returns Multiple Rows o Useful Oracle System Tables Contact

Search this w GO

You are here: Home / PeopleCode & PeopleTools / XML Publisher (BI Publisher) / XML Publisher Basics Using PS Query

XML Publisher Basics Using PS Query

In order to shorten the text in this illustration, the breadcrumbs to the various locations will only be listed in the top menu bar of the image and will not be listed separately for every step.

Create Your Query

1. Create a query to use as the XML Publisher data source.

2. Assign any security necessary for the PeopleSoft user to run the query.

Set up the Report Category and Data Source

1. Create a new Report Category ID. Press the Add button.

2. Enter a description, object owner, and the Users and/or Roles able to use this Report Category. Press the Save button.

3. Create a new Data Source. Select PS Query as the Source Type and then find the query that you just created to use as the Data Source ID. Press the Add button.

4. Enter a description and an object owner ID. Then press Save.

5. In the Related Files grid, press on the Generate hyperlink for the first row (Sample Data File).

6. An XML file is created. You will need this file in order to create a Microsoft Word template. Right click over this link and save the file to your hard drive for future use (verify the file extension is .xml).

7. In the Related Files grid, press on the Generate hyperlink for the second row (Schema File).

8. An XML schema file is created. You will need this file in order to create a Microsoft Word

template. Right click over this link and save the file to your hard drive for future use (verify the file extension is .xsd). 9. Save the Page.

Install the XML Publisher / BI Publisher plug-in for Microsoft Word

1. If you have not already installed the XML Publisher plug-in for Microsoft Word on your computer, you will need to do so now. 2. The file is on your application server, and you may download it by browsing to the location below:

3. Save the file to your hard drive. 4. Run the setup exe that is found in the zip file you just downloaded. 5. After the install completes, open MS Word. - Oracle XML/BI Publisher in Office 2007

- Oracle XML/BI Publisher in Office 2003

Review Existing RTF templates

Download RTF Templates

1. You can view existing RTF templates to use one as a starting point for your custom template or review the various XML tags on delivered templates. 2. Browse to the Report Definition page and find all definitions that have a Data Source Type of PS Query.

3. After selecting a Report Definition, you will need to download the Data Schema and the Sample Data on the Definition tab. Right click the Data Schema hyperlink and save the file to your hard drive. Right click over the Sample Data hyperlink and save the file to your hard drive. Failing to save the schema will prevent you from viewing the XML tags in the RTF template properly in MS Word.

4. Now go to the Template tab to download the RTF file. Download the Template File by rightclicking on the file name (in this example, LTRACQxml.rtf).

5. Repeat this process for as many RTF files you wish to preview. 6. You can now sign off of the PeopleSoft session since you will be working in MS Word.
Viewing the RTF Example in MS Word

1. Open the example RTF Report you downloaded.

2. In this example RTF, you can see that every time the HRS_PERSON_ID changes, a new letter (page) will be created. This is one of many tags that you are able to insert into the RTF to control the look, grouping, etc. of the document. 3. By double clicking on this field you are presented with the special tag properties.

4. Press on the Word Properties push button to change field properties.

5. For this quick example, I will now create a new file called MY_DEMO_XMLP.rtf (close your example file). 6. Now add in additional fields or text as desired. For this illustration, I will insert a table to display the other fields of the query in a table format using the Table Wizard.

7. Insert a format of Table. (Next)

8. The Data Set is automatically populated. (Next)

9. Select the fields that you desire to show in the table, or that you want to group the results by. (Next)

10. If you would like to group your result set, then select the field you will be grouping on. You can also select whether to break after each group or not to break after the change in the group. If you break, you have the option of creating a section break or a page break. (Next)

11. If the query is not sorting the results, or the results are in a different order than you would like to display, then you can change the order here. (Next)

12. If the field labels that are shown are different than you would like to show on the column headers, change their names here. (Next)

13. The Table Wizard then places the result of your choices into the document.

14. Now you can preview the document to see how it will look. Press on the HTML option to view the results.

15. In this example, the Department code did not change with the sample data that was in the data file, so only one grid table is created.

16. Close the HTML output window. 17. Make sure to save the template as RTF if you have not done so already.

Create the XML Report Definition

1. Follow the breadcrumbs to add a new XML Report Definition. Select Add a New Value. Create a unique Report Name, select a source type of PS Query, and then select your Query name that you created at the beginning. (Add)

2. Provide a Report Description, select the Report Category ID that you created in step Set up the Report Category and Data Source, select an owner ID, and select the Template Type as RTF.

3. Click on the Template tab. Enter a description and an Effective Date. Since this is the first template for this Template ID, you must switch the Status to Active or you will be unable to save the Report Definition.

4. Upload the RTF template that you created by pressing on the Upload push button. Press the Browse push button to search for the correct RTF file using the windows dialog box. Then press the Upload push button.

5. Template file is now shown as uploaded.

6. Go to the Output tab. Deselect all format types except PDF.

7. Go to the Security Tab and add in Users and/or Roles that should be able to run this report.

8. Press the Save push button now to create the Report Definition.

9. You need to switch the Report Status from In Progress to Active in order to use this new Report Definition.