basic tutorial xml publisher insieme

www.insiemeit.es

User Manual:Basic Tutorial of XML Publisher in Oracle EBS 12.0.6

April 2009

www.insiemeit.es

2

Index

Oracle XML Publisher

Introduction to Oracle E-Business Suite Concurrent Request

How XML Publisher works (General View)

Introduction to XML

Getting templates information from MS Access (2003…)

Creating Templates with MS Word (2003…)

XML Publisher implemented in Oracle E-Business Suite 12.0.6

Data Definition

Template

Report with XML Publisher

Notes

www.insiemeit.es

3


The XML Publisher (XMLP / BI Publisher ) is a new feature that provides to Oracle E-Business Suite ERP (EBS) an easy reporting solution. We can generate reports in many different output formats (PDF,HTML,XML,E-TEXT,..).

Oracle XML Publisher is a complete suite with different tools. We only need to install one of them, the Oracle XML Publisher Desktop 5.6.2:

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

This software installs a plug-in in MS Word and provide us an easy way to create templates.

www.insiemeit.es

4

Index




Introduction to XML




Data Definition

Template

Creating XML Publisher Concurrent Program

Notes

www.insiemeit.es

5

Introduction to Oracle E-Business Suite Requets

In Oracle EBS, we use the concurrent program window (accessible from the main modules of the application), for executing Reports, background Programs, …

The XMLP Reports will be executing from this windows.

www.insiemeit.es

6

Index




Introduction to XML




Data Definition

Template


Notes

www.insiemeit.es

7


XMLP works based in Templates. Those Templates can be word(.rtf), Acrobat Reader(.pdf), etc. In this project we are going to work with MS Word (.rtf) templates.

The steps to create a XMLP Report are the followings:

1. Create the Data Definition object in the application EBS. This file is a XML file with

the “Select Clauses” to access the database.

1.1 With this xml, create the Concurrent Request Program based in this DataDefinition.xml.

1.2 This concurrent will execute our report when we have created the template in EBS.

1.3 The first time we execute the concurrent based in our DataDefition.xml and before create the template, we’ll get a xml data example that we can use for creating the template in MS Word using the plug-in XML Publisher Desktop.

2. Create the Template Object associated to our template file created in MS Word.

www.insiemeit.es

8

We can create a XML Publisher Templates in so many different ways.

Creating Java Programs.

Generating xdo Files (Java)

Generating xml Templaes

…..

Creating our XML Data Source

We are going to use the last option for creating our Reports.


www.insiemeit.es

9


For working with XML Publisher in Oracle E-business Suite R12, we need the following objects:

1. Data Definition (Data Source for the Template, XML)

2. Template (Document made with Microsoft Word with the body)

3. An EBS Request, that calls to the Template.

The Data Definition and the Template are going to be created in the XML Publisher Administrator Responsibility.

www.insiemeit.es

10

Index




XML Data Definition




Data Definition

Template


Notes

www.insiemeit.es

11

XML Data Definition

XML is a markup language like HTML but is extensible (It must be possible to add new keywords, concepts and structures to the source language(s) ). Is a standard language and all the database system understands XML, is easy for creating custom markup language.

XML is Case Sensitive.

All the elements are included in two tags <nombre_tag>valor</nombre_tag>

The structure of the XML we are going to use for creaing XML Reports is very easy and always is going to use the same definitions.

www.insiemeit.es

12

XML Data Definition

www.insiemeit.es

13

XML Data Definition

After we create the XML Data Definition, that is going to be the source of our Report, we have to include and register in our e-Business Suite environment.

We need to save the document with the file extension .XML

To register the Data Definition of the our Template:

Go to the main menu, and choose

XML Publisher Administrator responsibilitiy.

There are three options

click on Data Definitions.

www.insiemeit.es

14

XML Data Definition

Push the Create Data Defintion button.

www.insiemeit.es

15

XML Data Definition

The name should be the same.

We enclose all the developments in the same applications

www.insiemeit.es

16

XML Data Definition

After push Apply Button, is the time to upload our XML_Data_Definition.xml created before

.

Now, we have our Data Definition in the EBS. Next, we are going to create the concurrent for generating a dataExample.xml that is going to be uploaded in MS word.

www.insiemeit.es

17


Go to the System Administrator Responsability\Program\Define

www.insiemeit.es

18

Index




XML Data Definition





Template


Notes

www.insiemeit.es

19


CREATE THE REPORTS PARAMETERS THROUGHT THIS BUTTON

www.insiemeit.es

20


Now, we have the concurrent create. We have to associate the concurrent to a responsibilitiy. In this example, we are going to work with System Administrator.

Go to the System Administrator Resp. \ Security\Responsability\Request

www.insiemeit.es

21


www.insiemeit.es

22


Let’s execute our request from the menu.( This option is available from any responsibility). After execute the report, we will get de xml necessary for creating the template in MS Word.

www.insiemeit.es

23


www.insiemeit.es

24


Check the output button and save the xml output into our directory with a .xml extension.

www.insiemeit.es

25


The file we obtained before is going to be used by MS Word for creating the Template.

This xml file is different to the Data Definition xml file, because this last file is the result of the query to the database and the output have been shown in the explorer.

With this file, we can put the dynamic fields and the data groups in the Template created by Ms Word as you can see in the next steps.

Is very important to generate this xml file if we don´t want to create any java program or others programs more complicated this is the easier way. With the resulted xml we can work with repeating groups and simulate a preview.

www.insiemeit.es

26

Index




XML Data Definition




Template


Notes

www.insiemeit.es

27


We are going to create a ”rtf” template with a select pointing to the Oracle database.

For making this tutorial more understanding, there are some screen shots creating a template.

Open a word document with all the fixed information, it means, all the texts, images,… that is not going to be changed. If we have a document obtained from MS Access we can open that document and we use it to create the template.

www.insiemeit.es

28


In the NATO Project we have a lot of information and reports in a MS Access Database, almost the reports we are going to generate in XML Publisher are included in this Database. We can obtain the format of our Template easily from Access.

1. Open the Access Database and go to the reports path and execute the reports you are interested in implementing in Oracle EBS.

2. After executing take a look to the toolbar and notice the MS Word Symbol,

If you click on this button your MS Word application will be opened and with all the information of your executed report in the document. By default, your extension of this document is .rtf

www.insiemeit.es

29


We open or create a document with MS Word and is going to be the body and container of the data. Is this example

www.insiemeit.es

30


Other way for creating a Template is just opening the MS Word and saving the file with the .rtf extension.

RTF, is the extension of a MS Word file that is going to be recognize for Oracle e-Business Suite.

This is the menu option that is going appear after installing the BI xml Publisher Desktop

www.insiemeit.es

31


Insert the xmlData obtained through the application.

In XMLP menu, we click on “Data\Load XML Data”

www.insiemeit.es

32


Insert the fields associates to the “Select Columns”. When you click on Insert\field from the menu bar, an explorer window is going to be opened on the right of your screen, If you click on one column and drag to your document, you will have a field database column in the document.

www.insiemeit.es

33


We draw the column PURCHARSE_ORDER, and now, this columns appears in our document with a different colour. The properties show us that is data columns field

1 2

We can create a field without the wizard defining this property with the format

<? Column_selectc_name?>Access by this buttong

www.insiemeit.es

34

Index




XML Data Definition




Template


Notes

www.insiemeit.es

35


The XML Publisher Reports can be implemented in many ways.

Based in Java Program, in a Oracle Report(.rdf),…

We are going to use an utility of the EBS 12, ( In the case you are working with EBS 11.5.10 you need to install a patche). This utility uses a standard java program called XDODTEXTE.

The XML Publisher, in EBS, is a responsibility you have to assign it to the user who is going to manage those reports. This utility name is: Oracle XML Publisher Administrator

In this responsibility you’ll create data definitions and templates (associates to a data definitions created before)

Later, in the system administrator or applications developer responsibility you will create the concurrent based in the template created.

The names of the Templates, Data Definitions and concurrent are very important, because Oracle EBS associates a template to the concurrent by the names.

Use the same name for the Data Definition, Template and Concurrent Short Name

www.insiemeit.es

36


Notice that the fields name are the same name we have in the group section, in the first xml, the data definition xml. Is the same for the groups.

If we have a Select that returns many different rows we can insert a table that is going to simulate a repeating group, “Repeating Group option”.

www.insiemeit.es

37

Index




XML Data Definition




Template


Notes

www.insiemeit.es

38

The Template

After creating the Template saved with .rtf extension, you can see a preview clicking in the right option in the menu.

As you can see, is possible to select many different outputs formats.

www.insiemeit.es

39

The Template

Return to the main menu in the e-Business Suite, and choosing the responsibility XML Publisher Administrator, click on Templates. Click on the button Create Template. The name is the same that the Data Definition created before, now associate the Data Definition to this template.

www.insiemeit.es

40

The Template

Here, we associatte the rtf

www.insiemeit.es

41

Index




XML Data Definition




Template


Notes

www.insiemeit.es

42


Let’s execute the report created with XML Publisher.

Go to the application, and choose your report in the concurrent request window.

This report is the same request that we created when we generated the xml data.

If we have called with the same name to the DataDefinition, Template and the Request short name, the application will associate the request with the Template automatically.

basic tutorial xml publisher insieme

Documents