PeopleTools 8.52: BI Publisher For PeopleSoft

2y ago
16 Views
2 Downloads
755.12 KB
108 Pages
Last View : 13d ago
Last Download : 2m ago
Upload by : Shaun Edmunds
Transcription

Oracle's PeopleTools PeopleBookPeopleTools 8.52: BI Publisher forPeopleSoftOctober 2011

PeopleTools 8.52: BI Publisher for PeopleSoftSKU pt8.52txml-b1011Copyright 1988, 2011, Oracle and/or its affiliates. All rights reserved.Trademark NoticeOracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of theirrespective owners.License Restrictions Warranty/Consequential Damages DisclaimerThis software and related documentation are provided under a license agreement containing restrictions on use anddisclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement orallowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit,perform, publish or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilationof this software, unless required by law for interoperability, is prohibited.Warranty DisclaimerThe information contained herein is subject to change without notice and is not warranted to be error-free. If you findany errors, please report them to us in writing.Restricted Rights NoticeIf this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S.Government, the following notice is applicable:U.S. GOVERNMENT RIGHTSPrograms, software, databases, and related documentation and technical data delivered to U.S. Governmentcustomers are "commercial computer software" or "commercial technical data" pursuant to the applicableFederal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication,disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in theapplicable Government contract, and, to the extent applicable by the terms of the Government contract, theadditional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007).Oracle USA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.Hazardous Applications NoticeThis software is developed for general use in a variety of information management applications. It is not developed orintended for use in any inherently dangerous applications, including applications which may create a risk of personalinjury. If you use this software in dangerous applications, then you shall be responsible to take all appropriate fail-safe,backup, redundancy and other measures to ensure the safe use of this software. Oracle Corporation and its affiliatesdisclaim any liability for any damages caused by use of this software in dangerous applications.Third Party Content, Products, and Services DisclaimerThis software and documentation may provide access to or information on content, products and services from thirdparties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kindwith respect to third party content, products and services. Oracle Corporation and its affiliates will not be responsible forany loss, costs, or damages incurred due to your access to or use of third party content, products or services.

ContentsPrefaceBI Publisher for PeopleSoft Enterprise Preface . viiBI Publisher for PeopleSoft Enterprise . viiPeopleBooks and the PeopleSoft Online Library . viiChapter 1Getting Started with BI Publisher . 1BI Publisher Overview . 1BI Publisher Phases . 3Chapter 2Setting Up BI Publisher . 7Understanding BI Publisher Set Up . 7Defining System Properties and Fonts . 8Understanding xdo.cfg File . 9Setting System Temp Directory . 9Setting Application Server or Process Scheduler Domain-Specific xdo.cfg File . 9Copying Fonts . 10Setting Up BI Publisher . 10Pages Used to Set Up BI Publisher . 10Setting Up Report Categories . 11Defining Global Properties . 12Working with Template Design Helpers . 15Assigning BIP Permissions to Users . 15Chapter 3Creating and Registering Data Sources . 17Creating Data Sources . 17Understanding Data Generation . 17Creating Schema and Sample Data . 17Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.iii

ContentsRegistering Data Sources .Understanding Data Source Registration .Page Used to Register Data Sources .Registering Data Sources .21212122Chapter 4Creating Report Templates . 25Understanding Report Template Types .Using RTF Templates .Creating RTF Templates .Incorporating Sub-Templates .Including Images .Changing Default Template Font .Using Drilling URL in RTF Template .Incorporating Data Created with Rich Text Editor (RTE) into Template .Using PDF Templates .Working with PDF Templates .Creating PDF Templates .Mapping Data Tags .252727282930313333333435Chapter 5Defining Report Definitions . 39Creating Report Definitions .Understanding Report Definitions .Pages Used to Create Report Definitions .Defining Reports .Associating Templates .Using Data Transform .Determining When to Use PDF Mapping versus Data Transform .Setting Output Options .Setting Report Properties .Setting Security Options .Setting Bursting Options .Assigning Report Viewers at Runtime .Maintaining Sub-Templates .Understanding Sub-Templates .Page Used to Maintain Sub-Templates .Maintaining Sub-Templates .Maintaining Template Translations .Understanding Template Translations .iv393940404348535457585963656566666868Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.

ContentsPages Used to Maintain Template Translations . 68Searching Template Translations . 69Maintaining Template Translations . 70Chapter 6Running, Locating, and Viewing BI Publisher Reports . 73Running BI Publisher PeopleSoft Query Reports .Pages Used to Run BI Publisher PeopleSoft Query Reports .Running Reports in Query Report Viewer .Scheduling Reports in Query Report Scheduler .Running Reports in Process Scheduler .Using the Process Scheduler Request Page .Creating the Run Control Page .Creating a Process Definition .Monitoring Requests .Running Reports Using PeopleCode .Understanding PeopleCode BI Publisher Classes .Running Reports Using PeopleCode .Choosing a Template .Passing Parameters .Bursting Reports .Customizing Printed Report Output .Distributing Reports .Searching for Reports .Using Time Zones in BI Publisher Reports .Locating and Viewing BI Publisher Reports .Pages Used to Locate and View BI Publisher Reports .Searching the BI Publisher Report Repository er 7Creating Reports that include Rich Text Editor Data . 87Understanding Rich Text Editor Data in BI Reporting .Configuring RTE on Page for BI Reporting .Creating Template that Includes Rich Text Editor Data .Using Query or Connected Query as a Data Source .Using XML File as a Data Source .Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.8788899192v

ContentsAppendix ASecuring BI Publisher . 95BI Publisher Security . 95Appendix BMigrating BIP Definitions . 97BIP Definitions Overview .Migrating BIP Definitions .Migrating BI Publisher-Translated Languages .Cleaning Up BI Publisher Metadata .97979898Index . 99viCopyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.

BI Publisher for PeopleSoft EnterprisePrefaceThis preface discusses BI Publisher for PeopleSoft Enterprise.BI Publisher for PeopleSoft EnterpriseBusiness Intelligence (BI) Publisher for PeopleSoft Enterprise is a template-based reporting solution thatseparates the data extraction process from the report layout and allows the reuse of extracted application datainto multiple report layouts. BI Publisher uses select features from Oracle Business Intelligence Publisher (BIPublisher) that have been integrated into PeopleTools.PeopleBooks and the PeopleSoft Online LibraryA companion PeopleBook called PeopleBooks and the PeopleSoft Online Library contains generalinformation, including: Understanding the PeopleSoft online library and related documentation. How to send PeopleSoft documentation comments and suggestions to Oracle. How to access hosted PeopleBooks, downloadable HTML PeopleBooks, and downloadable PDFPeopleBooks as well as documentation updates. Understanding PeopleBook structure. Typographical conventions and visual cues used in PeopleBooks. ISO country codes and currency codes. PeopleBooks that are common across multiple applications. Common elements used in PeopleBooks. Navigating the PeopleBooks interface and searching the PeopleSoft online library. Displaying and printing screen shots and graphics in PeopleBooks. How to manage the locally installed PeopleSoft online library, including web site folders. Understanding documentation integration and how to integrate customized documentation into the library. Application abbreviations found in application fields.You can find PeopleBooks and the PeopleSoft Online Library in the online PeopleBooks Library for yourPeopleTools release.Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.vii

Chapter 1Getting Started with BI PublisherThis chapter provides an overview of BI Publisher and discusses BI Publisher phases.BI Publisher OverviewOracle Business Intelligence Publisher (BI Publisher, formerly XML Publisher) is an enterprise reportingsolution that streamlines report and form generation. A primary feature of Oracle's BI Publisher product is theseparation of the data extraction process from the report layout. BI Publisher enables you to design and createreport 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 manyformats (PDF, RTF, Excel, HTML, and so on) in many languages. This approach to reporting candramatically reduce report maintenance, enabling power business users to adjust report templates withoutinvolvement of IT resources.The following diagram illustrates the concept of BI Publisher.BI Publisher conceptSelect features of Oracle's BI Publisher product have been integrated into and enhanced for use withPeopleTools. This diagram illustrates PeopleSoft applications integration with BI Publisher:Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.1

Getting Started with BI PublisherChapter 1Integration with BI PublisherPeopleSoft BI Publisher has a direct Java integration to the XDO Engine and XDO Parser. The BI PublisherDesktop requires installation and can be downloaded from a PeopleSoft Pure Internet Architecture page.Note. Not all BI Publisher features are available through the PeopleSoft implementation.PeopleSoft Query as well as any PeopleTools based applications providing XML data are available to BIPublisher as a data source. BI Publisher for PeopleSoft Enterprise provides an environment for managingtemplates, data sources, reports, translations, and content components. It also offers an electronic burstingcapability to produce reports according to a user-defined criteria and secure the reports using an application'ssecurity join table. A set of PeopleCode BI Publisher classes for runtime report generation is also provided.This diagram illustrates the BI components within the PeopleSoft system.2Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.

Chapter 1Getting Started with BI PublisherBI ComponentsOracle provides a set of PeopleSoft Pure Internet Architecture pages for defining data sources, reportdefinitions, templates, and translations and for running and viewing reports. Oracle also provides a set ofPeopleCode application program interfaces (APIs) that wrap the Oracle XDO engine APIs. These APIs areused by the BI Publisher PeopleSoft Pure Internet Architecture pages and are available for advanced reportdevelopers to use for custom applications and batch processes.BI Publisher PhasesBI Publisher implementation includes the following phases: Set up BI Publisher. Create and register data sources. Create and upload report templates. Define BI Publisher reports. Run, locate, and view BI Publisher reports.Set Up BI PublisherTo prepare your system for using BI Publisher, perform the following steps:Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.3

Getting Started with BI PublisherChapter 1StepReference1. Define BI Publisher settings.See Chapter 2, "Setting Up BI Publisher," page 7.2. Set up BI Publisher permission list security.See Chapter 2, "Setting Up BI Publisher," Assigning BIPPermissions to Users, page 15.3. Set up Report Manager.See PeopleTools 8.52: PeopleSoft Process Scheduler,"Using Report Manager."4. Define report categories, including Report DefinitionEditor security.See Chapter 2, "Setting Up BI Publisher," Setting UpReport Categories, page 11.5. Download design plug-ins to facilitate the offlinetemplate design activities.See Chapter 2, "Setting Up BI Publisher," Working withTemplate Design Helpers, page 15.Create and Register Data SourcesTo create and register data sources, perform the following steps:StepReference1. Identify or create the source of your report data.See PeopleTools 8.52: PeopleSoft Query, "Creating andRunning Simple Queries" and Chapter 3, "Creating andRegistering Data Sources," Creating Data Sources, page17.Data sources can be PS Query, Connected Queries, orXML files.Note. Rowset and XML Doc object data sources havebeen deprecated. Rowset and XML Doc object datasources created in previous releases will continue to besupported.To generate XML files from XML Doc or rowsets, referto PeopleCode API documentation.See PeopleTools 8.52: PeopleCode API Reference, "BIPublisher Classes."2. Register schema and sample data files for BI Publisherdata sources.See Chapter 3, "Creating and Registering Data Sources,"Registering Data Sources, page 21.For PS Query, you can automatically generate schema fileand sample data.Note. Schema is no longer used for bursting starting inPeopleTools 8.50. It is still available for backwardscompatibility. Schema is also used with XSLT Mapper fordata transforms.Create and Upload Report TemplatesTo create and upload templates, perform the following steps:4Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.

Chapter 1Getting Started with BI PublisherStepReference1. Create and upload schema and sample data.See Chapter 3, "Creating and Registering Data Sources,"Creating Data Sources, page 17.2. Download sample data from the appropriate data source See Chapter 5, "Defining Report Definitions," Definingto facilitate template design.Reports, page 40.3. Use either Microsoft Word or Adobe Acrobat todevelop and maintain custom report formats.See Chapter 4, "Creating Report Templates,"Understanding Report Template Types, page 25.4. (Optional) Create and maintain reusable sub-templatedefinitions.See Chapter 5, "Defining Report Definitions,"Maintaining Sub-Templates, page 65.5. (Optional) Register translation XLIFF files for reporttemplates and Content Library sub-templates.See Chapter 5, "Defining Report Definitions,"Maintaining Template Translations, page 68.Define BI Publisher ReportsTo create and maintain report definitions, perform the following step:StepReference1. Define reports by associating data sources with layouttemplate files.See Chapter 5, "Defining Report Definitions," DefiningReports, page 40.Run, Locate, and View BI Publisher ReportsYou can run BI Publisher reports online or in batch through the Process Scheduler. For query-based reports,pages are available for running the reports both online and in batch. To run BI Publisher reports, perform thefollowing steps:StepReference1. Schedule Query-based BI Publisher reports.See Chapter 6, "Running, Locating, and Viewing BIPublisher Reports," Scheduling Reports in Query ReportScheduler, page 75.2. Schedule other BI Publisher reports.See Chapter 6, "Running, Locating, and Viewing BIPublisher Reports," Running Reports Using PeopleCode,page 79.Note. You will need to create an application engineprogram using BI PeopleCode APIs.3. View Query-based BI Publisher reports online in realtime.See Chapter 6, "Running, Locating, and Viewing BIPublisher Reports," Running Reports in Query ReportViewer, page 74.4. View other BI Publisher reports online in real time.See Chapter 6, "Running, Locating, and Viewing BIPublisher Reports," Running Reports Using PeopleCode,page 79.Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.5

Getting Started with BI Publisher6Chapter 1StepReference5. Locate BI Publisher reports using enhanced searchcriteria.See Chapter 6, "Running, Locating, and Viewing BIPublisher Reports," Searching the BI Publisher ReportRepository, page 83 and PeopleTools 8.52: PeopleCodeAPI Reference, "BI Publisher Classes," Search OperatorValues.6. View BI Publisher reports in the Report Manager.See PeopleTools 8.52: PeopleSoft Process Scheduler,"Using Report Manager," Viewing Reports.Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.

Chapter 2Setting Up BI PublisherThis chapter provides an overview of BI Publisher Set Up and discusses how to: Define system properties and fonts. Set up BI Publisher. Assign BI permissions to users.Understanding BI Publisher Set UpBefore using BI Publisher, there are some set up tasks necessary to set up the environment and facilitatetemplate design. This table lists the categories for the set up tasks:Set UpDescriptionPropertiesProperties for BI Publisher can be set at four levels.System and global properties should be configured as partof the initial set up for BI Publisher.SecuritySecurity is defined for creating and editing reportdefinitions.Template DesignTemplate Builder is an extension to Microsoft Word thatsimplifies the development of RTF templates. TemplateBuilder can be downloaded from PeopleSoft Pure InternetArchitecture page or Oracle Technical Network (OTN).BI Publisher PropertiesThere are two types of properties used in BI Publisher:Copyright 1988, 2011, Oracle and/or its affiliates. All Rights Reserved.7

Setting Up BI PublisherSystem PropertiesNon-system PropertiesChapter 2System level properties are set in the xdo.cfg file. System level propertiesinclude: xslt-parser xslt-scalable system-cachepage-size system-temp-dir fontsNon-system or functional properties are set in PeopleSoft Pure InternetArchitecture.Property Definition LevelsThere are four levels where properties are defined, this table lists the levels:LevelDescriptionLocationSystem properties and fontsSystem properties and fonts.xdo.cfg fileGlobal propertiesGlobal properties are shared by allreports and override the xdo enginedefault property values.Reporting Tools, BI Publisher, Setup,Global PropertiesReport propertiesProperties are defined in the reportdefinition and override globalproperties for a single report.Reporting Tools, BI Publisher, ReportDefinition, PropertiesOverride report properties.Runtime properties are set at eCode API.Runtime propertiesSee Chapter 5, "Defining ReportDefinitions," Setting ReportProperties, page 57.Defining System Properties and FontsThis section provides an overview of the xdo.cfg file and discusses how to:8 Set system temp directory. Set Application Server or Process Scheduler domain-specific xdo.cfg file.

separation of the data extraction process from the report layout. BI Publisher enables you 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

Related Documents:

Starting with the release of PeopleTools 8.58, PeopleTools can now use Excel Spreadsheets as BI Publisher templates. Before this release, if we wanted to create a spreadsheet using BI Publisher, the fastest way was to use an RTF template with a table and force the output to Excel through the report

The following diagram illustrates the concept of BI Publisher. BI Publisher concept Select features of Oracle's BI Publisher product have been integrated into and enhanced for use with PeopleTools. Within PeopleSoft applications, this is referred to as XML Publisher (XMLP). This diagram illustrates PeopleSoft applications integration with BI .

Before you begin, review the following information to organize your upgrade process: Review the PeopleSoft PeopleTools release. Make sure to download the most recent version of the PeopleSoft PeopleTools upgrade documentation. Go to My Oracle Support and search for the PeopleSoft PeopleTools upgrade documentation for your release.

Oracle's PeopleTools PeopleBook PeopleTools 8.52: PeopleSoft Applications User's Guide October 2011

PeopleSoft Campus Solutions 9.0 PeopleTools 8.52, BI Publisher 10.1.3.4.1 . BI Publisher Tutorial - Lesson 1.docx Page 1 of 33 . . BI Publisher Tutorial - Lesson 1.docx Page 4 of 33 To the right is a checkbox labeled Private Data Source. This will be checked if you saved the

PeopleTools 8.52, BI Publisher 10.1.3.4.1 . BI Publisher Tutorial - Lesson 2.docx Page 3 of 20 . Outline of Major Steps Using Real Data The steps for working with real data rather than sample data are in the following order. You'll see that the step to register the Data Source with BI Publisher occurs after the Template is

Publisher 2007 Tutor 9 Accessing your template: 1. Open Publisher (Start Menu Programs Microsoft Publisher). 2. Click on the “Templates” button. 3. This will open a dialog box. Select your template and click on the “Open” button. 4. When the template is open in Publisher, you will n

Publisher: American Chiropractic Magazine Inc. 3401 Lake Avenue Fort Wayne IN 46805 USA Publisher ID: ACPIM Publisher: American College of Physicians American Society of Internal Medicine- 190N Independence Mall West Philadelphia PA 19106-1572 USA Publisher ID: ACR Publisher: American