BIP 1- Oracle BI Publisher Using Data Template Training Doc

Oracle BI Publisher using Data Template

Agenda Agenda

1. BI Publisher Introduction Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1 Process Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2 2 .Creating Data Template and RTF Designing the Data Template . . . . . . . . . . . . . . . . . . . . . . . 2-1 Concurrent Job Registration Process . . . . . . .. . . . . . . . . . . 2-2 Code Promotion Process. . . . . . . . . . . . . . . . . .. . . . . . . . . . 2-3 3. Advance Concept Designing Bursting Control . . . . . . . . . . . . .. . . . . . . . . . . . . 3-1 Designing eTest Template . . . . . . . . . . . . .. . . . . . . . . . . . . . 3-2 4. Designing the Template Layout Bar Code Setup . . . . . . . . . . . . . . . . . . . .. . . . . . . . . . . . . . 4-1 Display Images and Charts at runtime . . . . . . . . . . . . . . . . 4-2 Xml Publisher Additional Features . . . . . . . . . . . . .. . . . . . 4-3

5. Installing Oracle BI / XML Publisher Desktop – Detailed . . .. . 5.1

Slide Title

Oracle BI Publisher (formerly XML Publisher) is a reporting solution that allows users

to create, manage and deliver reports and documents easier and faster than

traditional reporting tools.

Oracle BI Publisher report formats can be designed using Microsoft Word or Adobe

Acrobat, the tools that are easy to use and broadly adopted

The XML Publisher(XMLP / BI Publisher ) requires a Template layout and Data XML

to generate the report in PDF, EXCEL, RTF or HTML format .The Data XML can be

generated from Oracle Report, OA Framework and Data Template.

Oracle BI Publisher can be used as standalone application or fully integrated into

other Oracle applications

By Using Data Template you can develop BI Publisher reports in Oracle EBS,

without having to develop an RDF report. You can specify an SQL Statement in an

XML file, and results of that SQL Statement are published as XMLP Output

4

XML Publisher Data Template Architecture

The Data engine execute the Data template to generate the Data XML file . The Data XML file is then merged with the Template layout by the XMLP engine to generate the XMLP Report.

The data template is the XML document whose elements communicate the following information to the data engine.

Data Query : The SQL query with bind parameter specifying the data to be fetched.

Bind Parameters : Definition of each bind parameter defined in the query.

Data Structure : Definition of the Output XML Structure.

Data Triggers : Triggers that should be executed before or after the data query execution. Triggers are used to either do initialization or do some post query operation.

www.hcl.com

Benefits of Oracle BI Publisher» Document Management Solution well integrated with Oracle Applications.» A solution which authors, manages and delivers the Business documents.» Meets the Business Requirements like corporate identity.» Removes the Complexity» Reduces Maintenance Cost» Reduces Total Cost» One Template -> Multiple Outputs -> PDF,HTML,EXCEL,RTF» Business Consultants can use familiar desktop tools like Word, PDF, etc.» Extract one time ->-> Publish multiple times The Reporting Business needs could be as varied as» Financial Reports» Business Reports» Invoices» Purchase Orders» Sales Orders» Contracts» Government Forms» Tax Forms» Marketing Materials

www.hcl.com

www.hcl.com

www.hcl.com

9

Create a New Report - Overview

The Following are the steps involved to Build new report

Step 1: Design the Data Template XML File.

Step 2: Create the Data Definition in XML Publisher and associate it with

Data Template

Step 3: Define a Concurrent Program to generate the Data XML File.

Step 4: Define the RTF Template using the Generated Data XML.

Step 5: Registering the Template with XML Publisher

Step 6: Execute the concurrent program to generate the PDF report.

www.hcl.com

www.hcl.com

Element Attributes/Description

DataTemplate (Required) • Name (Required)• Description• version (Required)• Default Package - the PL/SQL package name to resolve any lexicalreferences, group filters, or data triggers defined in the template.• DataSourceRef - (Required) the default data source reference for theentire data template.

Properties Consists of one or more <property> elements to support the XML outputand Data Engine specific properties.

Property Attributes:• name (Required) - the property name.• value - valid values for this property.

www.hcl.com

Parameter Attributes:• name (Required) - the parameter name that will be referenced in thetemplate.• DataType - valid values are: "character", "date", "number"• DefaultValue - value to use for the parameter if none supplied from the data• Include_in_output - whether this parameter should appear in the XML output or not. The valid values are "true" and "false".

DataQuery (Required) Consists of one or more <sqlstatement> or <xml>elements.

sqlstatement (Required) Attributes:• name (Required) - the unique query identifier. Note that this nameidentifier will be the same across the data template. Enter the query inside the CDATA section.

DataTrigger Attributes:• name (Required) - the event name to fire this trigger• source (Required) - the PL/SQL <package name>.<function name>

DataStructure (Required for multiple queries) Defines the structure of the output XML.Consists of <group> and <element>elements to specify the structure. Thissection is optional for single queries; if not specified, the data engine willgenerate flat XML.

Group Consists of one or more <element> elements and sub <group> elements.Attributes:• name (Required) - the XML tag name to be assigned to the group.• source (Required) - the unique query identifier for the correspondingsqlstatement from which the group's elements will be derived.• groupFilter - the filter to apply to the output data group set. Define the filter as: <package name>.<function name>.

element (Required) Attributes:• name - the tag name to assign to the element in the XML data output.• value (Required) - the column name for the SQL statement. Note that for aggregations in which the column name is in another group, the value must be defined as <group name>.<column/alias name>.• function - supported functions are: SUM(), COUNT(), AVG(), MIN(), MAX()

www.hcl.com

XML Document

Sample Source for Data Template

Sample Report 1

XML Document Rich Text Format C:\Documents and Settings\bharathkumar_k

Sample Report with Data Link & Lexical Parameter

XML Document Rich Text FormatC:\Documents and

Settings\bharathkumar_k

15

Installation Details

Define Concurrent Program & Executable

Register Data Definition & Attached Data Template

Register Layout Template & Attached the RTF Template

Add Program to Request Group

Run the Report:

www.hcl.com

Executable XML Publisher Data Temple Executable Short Name XDODTEXEApplication XML PublisherDescriptionExecution Method Java Concurrent Program

Execution File name

Step1 :Define Concurrent Program & Executable•Executable Definition• (Application Administrator -> Applications -> Define Executable)This is Standard Executable, No need to create any executable for Data template mode report

www.hcl.com

Program SSI AP Check Register Report

Enabled Yes

Short Name XXSSIAPCHKR

Application XX_CUSTOM

Description SSI AP Check Register Report

Executable

Name XDODTEXE

•Concurrent Program • (Application Administrator -> Applications -> Define Concurrent Program )

www.hcl.com

www.hcl.com

Name SSI AP Check Register ReportCode XXSSIAPCHKRApplication XX_CUSTOMStart Date 17-Jul-2008Files XML SchemaData Template XXSSIAPCHKR.xmlPreview DataBursting Control File

Step 2 : Register Data Definition

•Data Definition• (Resp: XML Publisher Administrator Home Data Definitions Create Data Definition)

www.hcl.com

www.hcl.com

Name SSI AP Check Register ReportCode XXSSIAPCHKRApplication XX_CUSTOMData Definition SSI AP Check Register ReportType RTFStart Date 17-March-2008End DateDefault File Language English Subtemplate No

File XXSSIAPCHKR.rtf

Step 3 : Register Layout Template

•Template Definition •(Resp: XML Publisher Administrator Home Template Create Template)

www.hcl.com

www.hcl.com

Request Group ALL REPORTS

Application Payables

Step 4 : Add Program to Request Group

•Request Group “ALL REPORTS” and the Application is “Payables”•(Application Administrator -> Request Group)

www.hcl.com

Step 5 : Run the Report: User Selects the Report From a List and Enters Parameters

www.hcl.com

26

Code Promotion Steps

Step 1 : Download LDT File For Concurrent & Data Template

-- Concurrent Programs Download :

FNDLOAD apps/X5aLI6mf 0 Y DOWNLOAD $FND_TOP/patch/115/import/afcpprog.lct LDF_FILE_NAME_CP.ldt

PROGRAM CONCURRENT_PROGRAM_NAME= <Program Name>

--XML Publisher Download

FNDLOAD apps/X5aLI6mf 0 Y DOWNLOAD $XDO_TOP/patch/115/import/xdotmpl.lct LDF_FILE_NAME _DD.ldt

XDO_DS_DEFINITIONS APPLICATION_SHORT_NAME= <APP_SHORT_CODE> DATA_SOURCE_CODE=

<DATA_TEMPLATE_CODE> TMPL_APP_SHORT_NAME= <APP_SHORT_CODE> TEMPLATE_CODE= <

TEMPLATE_CODE>

Step 2 : Place All LDT File , Data Definition File , Data Template(RTF) file in relevant Path .

Step 3 : Upload LDT File For Concurrent Program , Data Definition, Data Template & RTF Template

-- Concurrent Programs Upload:-

FNDLOAD apps/B2bOB4td O Y UPLOAD $FND_TOP/patch/115/import/afcpprog.lct LDF_FILE_NAME_CP.ldt

Upload XML LDT:-

FNDLOAD apps/<pwd> 0 Y UPLOAD $XDO_TOP/patch/115/import/xdotmpl.lct LDF_FILE_NAME _DD.ldt

www.hcl.com

Upload Data Template:

java oracle.apps.xdo.oa.util.XDOLoader UPLOAD -DB_USERNAME apps -DB_PASSWORD <PASSWORD> -JDBC_CONNECTION HOST:PORT:DB -LOB_TYPE DATA_TEMPLATE -APPS_SHORT_NAME <APP_SHORT_CODE> -LOB_CODE <DATA_TEMPLATE_CODE> -LANGUAGE en -TERRITORY US -XDO_FILE_TYPE XML-DATA-TEMPLATE -FILE_CONTENT_TYPE ’text/xml’ -FILE_NAME XXSSI_PP_NEEDS_RRT.xml -CUSTOM_MODE FORCE -LOG_FILE XXSSI_PP_NEEDS_RRT_XML.log

Upload RTF Template:

java oracle.apps.xdo.oa.util.XDOLoader UPLOAD -DB_USERNAME apps -DB_PASSWORD <PASSWORD> -JDBC_CONNECTION HOST:PORT:DB -LOB_TYPE TEMPLATE -APPS_SHORT_NAME <APP_SHORT_CODE> -LOB_CODE < TEMPLATE_CODE> -LANGUAGE en -TERRITORY US -XDO_FILE_TYPE RTF -FILE_CONTENT_TYPE ’application/rtf’ -FILE_NAME XXSSI_PP_NEEDS_RRT.rtf -CUSTOM_MODE FORCE -LOG_FILE XXSSI_PP_NEEDS_RRT.log

Sample Migration script

C:\Documents and Settings\bharathkumar_k

28

Exploring BI Publisher Bursting functionality

www.hcl.com

www.hcl.com

www.hcl.com

Sample Code

XML Document XML Document Rich Text Format

34

Etext Template:

An eText template is an RTF-based template that is used to generate text output for Electronic Funds Transfer

(EFT) and Electronic Data Interchange (EDI). At runtime, XML Publisher applies this template to an input XML

data file to create an output text file that can be transmitted to a bank or other customer. Because the output is

intended for electronic communication, the eText templates must follow very specific format instructions for exact

placement of data.Slide Text 2

Note: An EFT is an electronic transmission of financial data and payments to banks in a specific fixed-position

format flat file (text).

Structure of eText Templates:

There are two types of eText templates: fixed-position based (EFT templates) and delimiter-based (EDI

templates). The templates are composed of a series of tables. The tables define layout and setup commands and

data field definitions. The required data description columns for the two types of templates vary, but the

commands and functions available are the same. A table can contain just commands, or it can contain commands

and data fields.

The following graphic shows a sample from an EFT template to display the general structure of command and

data rows

www.hcl.com

www.hcl.com

www.hcl.com

Sample Sources:

XML Document Rich Text Format Rich Text FormatXML Document

Example display Images At runtime

Microsoft Office Word 97 - 2003 Document

Configure Document to setup Barcode Printing


Xml Publisher Additional Features


38

Installing Oracle BI / XML Publisher Desktop – Detailed

Getting Oracle BI Publisher Desktop: The current version of Oracle BI Publisher Desktop is

available on Oracle Technology Network (OTN) at:

http://www.oracle.com/technology/software/products/publishing/index.html

From this site, download Oracle XML Publisher Desktop 5.6.2 for Microsoft Windows. To use

Oracle BI Publisher Desktop, you must meet the following requirements:

• Microsoft Windows 2003 or later

• Microsoft Word 2003 or later

• Java Runtime Environment (JRE) 1.4 or later

Getting Oracle BI Publisher Desktop for E-Business Suite: The current version of Oracle BI

Publisher Desktop is available on MetaLink in patch 5027437.

http://updates.oracle.com/download/5027437.html

Always check MetaLink to see that you obtain the most current version. Versions are likely to

change.

www.hcl.com

Installing Oracle BI Publisher Desktop: To install Oracle BI Publisher Desktop, perform the following basic steps:• Download the patch.• Unzip the patch.• Run setup.exe included with the patch.• Follow the onscreen instructions.

Downloading and Unzipping the Patch: • Download Oracle BI Publisher Desktop from OTN or MetaLink.• The patch will download as:– XMLP_Desktop.zip (OTN)– p5027437_11i_MSWIN.zip (MetaLink)• Unzip that patch into the directory of your choice.• It will create a directory named as:– XMLP_Desktop (OTN)– XMLP_Desktop_R562 (MetaLink)

Running the Installer • CD (Change Directory) into the directory that was created when you unzipped your patch.• Run the installer … setup.exe.• Follow the onscreen directions.

www.hcl.com

Q & A

www.hcl.com

Thank You !