Steps To Download And Install The BI Publisher Desktop Tool (Plugin / Add On)

BI Publisher (formerly XML Publisher) - Version 11.5 and later
Information in this document applies to any platform.

Provide steps to download and install the BI Publisher Desktop, along with tips and tricks regarding the requirements to complete the install successfully.

 The following steps can be used for downloading and installing the BIP Desktop tool:

1. ALL versions of the BI Publisher server have a specific matching version of the BIP Desktop.

   Reference the product documentation to determine the proper version intended for your applications, and ensure a valid (matching) BIP Desktop tool is installed. It should be DOWNLOADED from:
   https://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html

2. If some other installation of BIP Desktop exists (same version or not) it must be de-installed prior to the new install.

3. The BIP Desktop install must be done on the desktop machine as a user with admin rights.

(one can right click on the executable and choose 'Run as Administrator')

     Note: The PC admin user used to perform the install must also be the user account which accesses the Desktop tool.

 

4. Microsoft Office 2016 is Certified for BIP Desktop version 12c (12.2.1.2 and 12.2.1.3).

5. Microsoft Office 2013 is Certified for BIP Desktop versions 11.1.1.9 and 12.2.1 (12c). 

6. Microsoft Office 2010 and 2007 are certified for BIP Desktop version 11.1.1.7 and 11.1.1.6. Note for Desktop 11.1.1.6 only 32-bit for Office 2010 is certified.

     Oracle BI Publisher Desktop 12.2.1.4.0 for 32 bit Office on Windows (255 MB)
     Oracle BI Publisher Desktop 12.2.1.4.0 for 64 bit Office on Windows (248 MB)

7. For the Windows client PC platform:

a. for Desktop 11.1.1.7 and 11.1.1.6
-- 64-bit Office on Windows, Windows 7, Vista
-- 32-bit Office on Windows, Windows 7, Vista, XP

b. for Desktop 11.1.1.9
-- 64-bit Office on Windows, Windows 7, Vista

c. for Desktop 12.2.1
-- 64-bit Office on Windows, Windows 7, 8.1, 10
-- 32 bit Office on Windows, Windows 7, 8.1, 10 (for cases where 32 bit office is installed on 64 bit hardware)

8. For the JRE version:

a. for Desktop 11.1.1.6, 11.1.1.7, 11.1.1.9:
-- 1.7.0_80+ or 1.6.0_35+
--- 32-bit or 64-bit

b. for Desktop 12.2.1:
-- 1.8.0_51+
--- 32-bit or 64-bit 

Note:

The versions of Microsoft Office, BI Publisher Desktop, and the Java JRE must all match as either 32-bit or 64-bit.

How To Download Oracle XML Publisher Desktop 5.6.3 (BI Publisher 10g)? (Doc ID 556032.1)

Oracle XML Publisher and BI Publisher Report

This chapter describes creating RTF templates in BI Publisher using the Template Builder for Word add-in.

Creating RTF Templates Using the Template Builder for Word

Build an Online Reporting Application Using Oracle XML Publisher

Exploring Advanced Features of Oracle BI Publisher 

https://amzn.to/3zgzzLH

Delete XML Publisher Data Definition and Template

Delete XML Publisher Data Definition and Template

The Problem:

In XML Publisher Administrator responsibility, both Data Definition and Template page don’t provide an option to delete data definition or template. Once created, you can’t even change the following:

• Data Definition Code
• Data Definition Application
• Template Code
• Template Application
• Template Type

Due to some typo error or to give some more meaningful name as per the standards, you can’t change those fields later. Also you can’t delete them too. Oracle recommends to disable them by giving an end date. But many developers don’t like to leave the wrong stuff in the system. They better like to delete them and freshly recreate them.

Why Oracle has done that way?

The reason is that: concurrent program with XML output matches the Short Name with the template Code to find out which XML Publisher template to use for post processing. If you delete this template, the Post Processor cannot find the template, and then give errors. So it is always better not to give an option to update or delete.

The Workaround:

It is always recommended to go for this workaround in development instances and NOT in any production or UAT instance. After making the Data Definition and Template perfect in dev instance, you can always migrate them to production via FNDLOAD and XDOLOADER utilities.
Before the workaround, let’s look at the main tables that store the information of the Data Definitions and Templates.

• XDO_DS_DEFINITIONS_B: table for storing data source definition represented by XML Schema Definition (XSD). Each data source has one or more elements, and this information are stored in XDO_DS_ELEMENTS_B.
• XDO_DS_DEFINITIONS_TL: translation table for XDO_DS_DEFINITIONS_B.
• XDO_LOBS: This table is used for storing locale (language and territory) sensitive binary and text files. It is mainly used for storing language layout templates.
• XDO_CONFIG_VALUES: stores the values of XML Publisher configuration properties entered from the Oracle Applications interface.
• XDO_TEMPLATES_B: table for template information. Each template has a corresponding data source definition stored in the XDO_DS_DEFINITIONS_B. Each translation of a certain template, not each template, has a corresponding physical template file. The physical template file information is stored in the XDO_LOBS.
• XDO_TEMPLATES_TL: translation table for XDO_TEMPLATES_B. 

Queries for Data Definitions:

SELECT *

  FROM XDO_DS_DEFINITIONS_B

WHERE DATA_SOURCE_CODE = 'XX_DATA_DEF_CODE';

SELECT *

  FROM XDO_DS_DEFINITIONS_TL

WHERE DATA_SOURCE_CODE = 'XX_DATA_DEF_CODE';

SELECT *

  FROM XDO_LOBS

WHERE LOB_CODE = 'XX_DATA_DEF_CODE';

SELECT *

  FROM XDO_CONFIG_VALUES

WHERE DATA_SOURCE_CODE = 'XX_DATA_DEF_CODE';

Delete the Data Definitions:

-- API to delete Data Definition from XDO_DS_DEFINITIONS_B  and XDO_DS_DEFINITIONS_TL table

BEGIN

XDO_DS_DEFINITIONS_PKG.DELETE_ROW (<DATA_DEF_APP_NAME>,<DATA_DEF_CODE>);

COMMIT;

END;

-- Delete Data Templates, xml schema etc. from XDO_LOBS table (There is no API)

DELETE FROM XDO_LOBS

         WHERE LOB_CODE = <DATA_DEF_CODE>

            AND APPLICATION_SHORT_NAME = <DATA_DEF_APP_NAME>

            AND LOB_TYPE IN

                   ('XML_SCHEMA',

                    'DATA_TEMPLATE',

                    'XML_SAMPLE',

                    'BURSTING_FILE');

-- Delete from XDO_CONFIG_VALUES (if required)

DELETE FROM XDO_CONFIG_VALUES

      WHERE APPLICATION_SHORT_NAME = <DATA_DEF_APP_NAME>

            AND DATA_SOURCE_CODE = <DATA_DEF_CODE>;

Queries for the Templates:

SELECT *

  FROM XDO_TEMPLATES_B

WHERE TEMPLATE_CODE = 'XX_TEMPLATE_CODE';

SELECT *

  FROM XDO_TEMPLATES_TL

WHERE TEMPLATE_CODE = 'XX_TEMPLATE_CODE';

SELECT *

  FROM XDO_LOBS

WHERE LOB_CODE = 'XX_TEMPLATE_CODE';

SELECT *

  FROM XDO_CONFIG_VALUES

WHERE TEMPLATE_CODE = 'XX_TEMPLATE_CODE';

Delete the templates:

-- API to delete Data Definition from XDO_TEMPLATES_B and XDO_TEMPLATES_TL table

BEGIN

XDO_TEMPLATES_PKG.DELETE_ROW (<TEMPLATE_APP_NAME>, <TEMPLATE_CODE>);

COMMIT;

END;

-- Delete the Templates from XDO_LOBS table (There is no API)

DELETE FROM XDO_LOBS

      WHERE     LOB_CODE = <TEMPLATE_CODE>

            AND APPLICATION_SHORT_NAME = <TEMPLATE_APP_NAME>

            AND LOB_TYPE IN ('TEMPLATE_SOURCE', 'TEMPLATE');

-- Delete from XDO_CONFIG_VALUES (if required)

DELETE FROM XDO_CONFIG_VALUES

      WHERE     APPLICATION_SHORT_NAME = <TEMPLATE_APP_NAME>

            AND TEMPLATE_CODE = <TEMPLATE_CODE>

            AND DATA_SOURCE_CODE = <DATA_DEF_CODE>;

 

Oracle XML Tags Example

<?for-each:G_1?> 
<?end for-each?> 

Page Break: <?split-by-page-break:?>

Serial Number : <xsl:value-of select="position()"/>

Summation column : <?sum(current-group()/LINE_AMT)?> 
 
<?end body?> 

SQL function:

<?xdofx:decode(C_AMT_DUE_REM_INV,0,'',C_AMT_DUE_REM_INV)?> 

Current date : 

<?xdoxslt:sysdate('DD-MON-YYYY HH24:MI')?>
<?xdoxslt:sysdate('Day Month DD,YYYY')?> 

Format Number: 

<?format-number:field_name;'99G999G999G990D99'?>

<fo:bidi-override direction="ltr" unicode-bidi="bidi-override"><?field_number?></fo:bidi-override>

<?xdoxslt:set_variable($_XDOCTX,'V_OP',CS_OP_VAL_NEW)?>

<?xdoxslt:set_variable($_XDOCTX,'V_CLOS',CS_CL_VAL_NEW)?>

<?xdoxslt:get_variable($_XDOCTX,'V_OP')+RECEIPT_VAL-xdoxslt:get_variable($_XDOCTX,'V_CLOS')?> 

Sorting:

<?sort:SOURCE1;'ascending';data-type='text'?>
<?sort:SOURCE1;'descending';data-type='text'?>
<?sort:current-group()/ITEM_NAME;'ascending';data-type='text'?> 

 
Condition:

<?xdoxslt:ifelse(condition,true,false)?>
<?xdoxslt:ifelse(0=1,'yes 0 and 1 are equal','No 0 and 1 are not equal')?>
<?xdoxslt:ifelse ((APR) != 0, xdoxslt:div((APR1)*100,(APR)),0)?> ---Not required- <?end if?>

<?xdofx:to_number()?>

<?xdofx:if ../../../../CF_DOCUMENT ='STANDARD' or SECURITY_POR_PO_NUM!=''?> 

<?if: ../../../../CF_DOCUMENT ='STANDARD' or SECURITY_POR_PO_NUM!=''?>


<?if: CF_ACC_CODE='Y'  ?> <?call-template: code_y_acc_y?> <?end if?>

<?if: CF_ACC_CODE='N' ?><?call-template: code_n_acc_n?> <?end if?>

<?choose:?>

<?when: CP_RUNFOR='AA'?> ... <?end when?>

<?when: CP_RUNFOR='BB'?> ... <?end when?>

<?end choose?> 

<?xdoxslt:toWordsAmt(CS_IGST_AMT)?>

<?template:code_n_acc_n?>

<?end template?>

<?template:code_y_acc_y?>

<?end template?>

Last Page Only Content

<?start@last-page:body?>
<?end body?>

HIDE the COLUMN from the RTF report in ORACLE

Goto the Column Heading and the type the Code like:

In
the if
field we type the code like:

<?if@column:/items/@type="PRIVATE"?>

In
the end if
field we type the code like:

<?end if?>

Then go to the row of open value field.

In
the if
field we type the code like:

<?if@column:/items/@type="PRIVATE"?>

In
the 20.00
field we type the code like:

<?if@column:/items/@type="PRIVATE"?>  <?CF_OPENING_VAL?>  <?end if?>  

In
the end if
field we type the code like:

<?end if?>

Then go to the SUM total of the field and type the code like :

In
the if
field we type the code like:

<?if@column:/items/@type="PRIVATE"?>

In
the end if
field we type the code like:

<?end if?>

Displaying image dynamically in XML Publisher (BI Tools) in RTF Template :

Right click on company logo image and click “Size” 

then goto “AltText” tab 

and enter dynamic path in “Alternative Text” field.

e.g. url:{concat(‘${OA_MEDIA}’,’/JG_LOGO.jpg’)}. 

Dynamic Logo: url:{concat('$[OA_MEDIA]','/',//ORG_CODE)}  

BI Publisher software Link

How to eliminate particular rows in RTF

<?for-each:G_ICODE?><?if: CF_OPENING_QTY !=0 and RECEIPT_QTY !=0 and ISSUE_QTY !=0?>
<?CF_OPENING_QTY?>
<?RECEIPT_QTY?>
<?ISSUE_QTY?>
<?end if?>
<?end for-each?>
 

How to Register Oracle XML Reports

Overview

Oracle XML Publisher is a template-based publishing solution delivered with the Oracle E-Business Suite. It provides a new approach to report design and publishing by integrating familiar desktop word processing tools with existing E-Business Suite data reporting. At runtime, XML Publisher merges the custom templates with the concurrent request data extracts to generate output in PDF, HTML, RTF, EXCEL or even TEXT for use with EFT and EDI transmissions.

                                                                           STEP -1
Navigation: Login into Oracle Applications –> Go to System Administrator  Responsibility –> Concurrent –>   
Executable


FIELDS:

• Executable: This is User Understandable Name
  
• Short Name: This is Unique and for system reference
  
• Application: Under which application you want to register this CONA_PO Program
  
• Description: Description
  
• Execution Method: Based on this field, your file has to be placed in respective directory or database.
  
• Execution File Name: This is the actual Report file name.
  

Action: Save

                                                               STEP -2
 Create a new concurrent program Purchase Order Report that will call the CONA_PO executable declared above. Make sure that output format is placed as XML.


Navigation: Go to Application Developer Responsibility -> Concurrent ->Program

Note: Output Format should by  'XML' for registering the report in XML.

                                                                      STEP -3
Make sure that the report parameter name and the token name are same.

 
                                                                      STEP -4

Add this new concurrent  program to the corresponding responsibility.
Navigation: Go to System Administrator Responsibility ->Security ->Responsibility->Request

                                                                      STEP -5

Next process is to attach the designed rtf file with the XML code. 
In order to attach the rtf file the user should have the responsibility XML Publisher Administrator assigned to him.

First provide the concurrent program short name as Data Definition name in the  template manager and register the template using the data definition created.


Navigation: Go to XML Publisher Administrator->Data Definitions->Create Data definition.

Note: Make sure the code of the data definition must be the same as the short name of the Concurrent Program we registered for the procedure. So that the concurrent manager can retrieve the templates associated with the concurrent program

  

Now create the template with the help of template manager


                                                                      STEP -6
Navigation: Go to XML Publisher Administrator->Templates ->Create Templates.