BIP 11G REPORT DEVELOPMENT GUIDE

COPYRIGHT (C) 2014 Oracle Financial Services Software Limited.

All rights reserved. No part of this work may be reproduced, stored in a retrieval system, adopted or
transmitted in any form or by any means, electronic, mechanical, photographic, graphic, optic recording
or otherwise, translated in any language or computer language without the prior written permission of
Oracle Financial Services Software Limited.

Due care has been taken to make this statement of work and accompanying software package as
accurate as possible. However, Oracle Financial Services Software Limited makes no representation or
warranties with respect to the contents hereof and shall not be responsible for any loss or damage
caused to the user by the direct or indirect use of this document and accompanying software package.
Furthermore, Oracle Financial Services Software Limited reserves the right to alter, modify or otherwise
change in any manner of the content hereof, without obligation of Oracle Financial Services Software
Limited to notify any person of such revision or changes.

All company and product name are trademarks of the respective companies with which they are
associated.
 Table of Contents

BIP Report Development Guide......................................................................................... 1

1. Introduction............................................................................................................3

2. Prerequisites..............................................................................................................3
3. Create Data Model for New Report...........................................................................10
4. Design Layout Template…………………………………………………………………………………………….12
4.1 Format Setup………………………………………………………………………………………………….13

4.2 Define Sequences…………………………………………………………………………………………..13

4.3 Format Data Records………………………………………………………………………………………14

5. Report Build................................................................................................................22
5.1 Creating build Setup.............................................................................................22

5.1.1 Pre-requisites............................................................................................22

5.1.2 Creating Environment to run tool..............................................................23

6. Deployment of Build reports........................................................................................24

7. Annexure A (Use of General Package): ...................................................................26
8. Annexure B (Handled in DB Function): .......................................................................30
1. Introduction
Creating a new report consists of the following steps:
a. Prerequisites

b. Create Data Model for New Report

c. Design Layout Template

d. Report Build

e. Deployment of Build reports

f. Annexure A (use of General Package)

g. Annexure B (Changes made in Database Function)

2. Prerequisites:
1. Login to BI Publisher Server using username/password as Administrator/admin

Administrator (For BIP installation or Login to BI Publisher server refer BIP

Installation Document)
Fig 1.1
 Fig 1.2

2. Following steps are used for setting up Data Sources

 Move to Admin section by clicking on Admin tab

 Fig 1.3

 From the Administration page select JDBC Connection.

 Fig 1.4

 Select the add Data Source button.

Fig 1.5
 Enter the following fields for the new connection.

Data Source Name – BIPDB

Connection String - jdbc:oracle:thin:@ofss220102.in.oracle.com:1521:INCLUST

Username - Database username (inhiutrn)

Password - Database password (inhiutrn)

Database Driver class - (oracle.jdbc.driver.OracleDriver)

Data Source Name – BIPREPDB

Connection String - jdbc:oracle:thin:@ofss220102.in.oracle.com:1521:INCLUST

Username - Database username (inhiutrn)

Password - Database password (inhiutrn)

Database Driver class - (oracle.jdbc.driver.OracleDriver)

 Select test connection to test for successful connection.

 Click on Apply
 Fig 1.6

3. Create Data Model for New Report:

 Refer the below template for data model creation.
 Fig 2.1

 Data Model Declaration

a. Name of the file should be _datamodel.xdm

b. Use the DataSourceRef as “BIPDB” or BIPREPDB for Host reports

c. Use the DataSourceRef as “BIPBDB” for Branch reports

d. Use Default Package as “PK_AP_GEN_REP” (Refer Annexure A for

detail )

 Data Sets Section

a. The name attribute in sql tab Q1.
 b. AP_GEN_REP method from PK_AP_GEN_REP common package is
used to call the report function.

c. First parameter in AP_GEN_REP must be the report function named

(“AP_CH_R113”).

d. Second parameter in AP_GEN_REP must be no of parameters used in

report function(2).

e. Third parameter in AP_GEN_REP is identifier of dynamic parameter

followed with “:” ( :FUNC_PARAM1).

 Data Structure Section

a. Define the Group Hierarchy.

b. Group name should be in sequence G1, G2, G3,G4…. Value for source
attribute for group tab is always Q1.

c. In the example CH113 group G1 is based on “cod_cc_brn”, group G2

is based on “cod_prod” , G3 is based on “cod_acct_no” and G4 is
detail group.

 Creating Summary Column

a. Name attribute of the summary Column should be start with “sum_”
(Ex: sum_amt_tax_absorbed).

b. Source attribute should be the name of the column on which the

summary calculation is to be performed (Ex: amt_tax_absorbed).

c. Name of the aggregate function (Ex: SUM() ).

 Exception for branch Report

a. If the first parameter for branch report function is the branch code
and there is no option for enters value from flexcube screen then first
parameter should be “P_COD_BRANCH” instead of “FUNC_PARAM1”.

 Create a folder for DataModel

a. Create a folder for maintaining the datamodel for the report on name
CH113.xdm and copy the finished _datamodel.xdm file in this folder.
4. Design Layout Template:

 For design e-text template open a word document. Save the file inside the
report data model folder (CH113.xdm). Extension of the file should be .rtf.
Name of the file should be report name (CH113.rtf).

 There are two types of E-text template: fixed-position based and Delimiter-
based. In our design there are only fixed-position based template is used.

 Entire E-text template design can be divided into mainly three parts :

a. Format Setup

b. Define Sequence

c. Format Data Records

4.1 Format Setup

This is the first part in e-Text template design used in all reports. Structure of
Format setup is as shown below:

Fig 3.1

Template Type – Specifies the type of the Template used. It should be

FIXED_POSITION_BASED Output character set – Specified the character set to be
used when generating the output. it should be iso-8859-1 new record character –
Specifies character(s) to use to signify the explicit and implicit new records at run
times. It should be Carriage Return.

4.2 Define Sequences

 This is the second part in e-Text template design Structure of define sequence is
as shown below:

Fig 3.2

Define sequence – define a sequence name which is used in template field

(CH113Seq). Reset at level - Subcommand for define sequence command used
for where the sequence resets its starting number (G1) Increment basis -
Subcommand specifies if the sequence should be incremented based on record
OR level (LEVEL).

4.3 Format Data Records

This is the main part in e-Text template design

Commands used in format Data record:

Below description and figure shows how to define the commands in creation of
data template:

<LEVEL> - Used to define start of a group Parameter for level command

must be a XML element. Parameter for level command must be a XML
element. Also used to define the hierarchy of data. Level can be used in
nested way.

<END LEVEL> - Declares the end of the current level. Parameter for end
level command must be a XML element. Name of the end level must be
in capital letter.
<POSITION> - specifies the starting position of the data field in a record.
For starting element in the record, value for position is always 1. The unit
is in number of character.

<LENGTH> - specifies the length of the data field. The unit is in number of
character. If the data is less than the specified length, it is padded. If the
data is longer, it is truncated.

<FORMAT> - specifies the data type and format setting. Value for format
column can be Alpha, Number or Date. Alpha is used for any alpha
numeric values. For custom number format the syntax is
“Number,###,###,###,###,##0.00”. For other than custom number
format the syntax is “Number,###,###,###,##0.00”. For any date field
used in report header section the syntax is “Date, DD-MON-YYYY”. For
any date field used in detail section the syntax is “Date, dd/mm/yyyy”.

<PAD> - Specifies the padding style and padding character. Padding style
can be Left (L) or Right(R). Both numeric and alpha numeric character can
be used as a padding character.

<DATA> - Specifies the data source and dynamic data are represented
with the element name in capital letter. It can be static or dynamic. Static
data are represented with in single quote in order to represent any group
header or data level. Dynamic data can simply contain the XML tag name,
or it can contain expressions and functions.

<COMMENT> - Use this column to note any free form comments to the
template.

<NEW RECORD> - Specifies a new record. Cursor moves to new row.

<DISPLAY CONDITION> - specifies the condition when a record should be

printed.
 Fig 3.3
Following is a simple structure of format data record layout.

 Report Header

 Page Header

 Group Header G1

 Group Header G2

 Detail Group (Inner Most Group G3)

 Group Footer G2

 Group Footer G1

 Report Footer

 Page Footer

Fig 3.4
For design format data record we need to start design from detail section then
header section and finally footer section.

Report Group section details

Every group has group header and group footer part other than inner most
group.

Date format for group level element should always be ‘dd/mm/yyyy’.

Group header should under lined with “-“character instead of “_”.

Group summary label should be placed near to the summary field and not at the
start of the line.

Amount Fields along with Column headers should always be right aligned.

For repeating group header section on every page '[PAGE_HEADER]' tag is used.

For adding explicit page break '[PAGE_BREAK]' tag is used.

For making the report to be split based on any field (like branch code) then“%%
ReportName.out” is used (%% CH113.out).
 Every number data type column having number format must be used with nvl ()
function.

Design Methodologies:
First design detail group (inner most group G3).

Draw the level command line for G3

Insert data field column header row

Insert data row

For first data row position should be 1

Length should be equal to greater than database length of the element

Calculate the maximum length

Then design other group header and footer

 Fig 3.5

Fig 3.6

Report Header
This is the First section in format data record part. This part should execute only
once during the entire report execution. If there is no content need to display in
report header section then we need to start the level and end the level. In the
below example there is no content for report header section.

Fig 3.7
 Do not use page header tag in Report header.

Page Header
This is the Second section in format data record part. This part should execute on
every page during the entire report execution. There must be minimum two
sections with report name before start Group level. First one for Report header
and second one for Page header. If there is no content need to display in page
header section then we need to start the level and end the level.

Fig 3.8

All the parameters displayed in page header must use xpath syntax. Xpath syntax
for any parameter is /reportName/ParameterName. Eg:/CH113/P_COD_BANK).

All the database element displayed in page header need not required any xpath
syntax.

For display runtime in page header use SYSDATE function.

For display page number in page header use the user define tag [PAGE_NO]'.

Page header and report header should start and end with solid line (Length of
this line should be equal to total length of fields in inner most group).

Date format in header section should always be ‘DD-MON-YYYY’.

 Design diagram for page header is as shown below.

Design methodologies for page header

First draw the line with the length defined by total length of the filed in inner
most group.

Starting Location for middle text ( FLEXCUBE, SAVING INTERESTS etc) in all the
lines should be calculated as (Length of the line/2) –(Length of the Text/2) . This
will give you exact starting location to centre the text. Starting position for level
bank code, branch code and op. id should be same.

Starting position for bank code and branch code should be same.

Starting position for bank name and branch name should be same.

Starting position for level run date, run time and report no. should be same.
 Fig 3.9

Report Footer
This is the Second last section in format data record part. This part should
execute only once during the entire report execution.

If there is no content need to display in report footer section then we need to

start the level and end the level.

Generally summary for the report are displayed in this section “No data found
for this report” should always be in report footer with appropriate condition
based on session id.

“No Data found for this report” should always be center aligned.

“End of Report” text should be in report footer if report is not to be split based
on any field (like Branch_code).

“End of Report” text should be in Group footer if report is to be split based on

any field (like Branch_code).
 “End of Report” should always be center aligned.

Page Footer
This is the last section in format data record part. This part should execute at the
end of every page during the entire report execution.

If there is no content need to display in report footer section then we need to

start the level and end the level.

In the below example there is no content for page footer section.

Fig 3.10

5. Report Build :
5.1 Creating build setup
5.1.1 Pre-requisites :

1. jdk1.7:

Open Command prompt, type <java –version>, this will show you current
version of JDK. Message should be like below:
java version "1.7.0_51"
 Java(TM) 2 Runtime Environment, Standard Edition (build jdk1.7.0_51)
Java HotSpot(TM) Client VM (build jdk1.7.0_51, mixed mode)

If java version is not 1.7x or java is not installed at all, then install jdk 1.7.

2. Jars:

Copy ‘collections.jar’,‘i18nAPI_v3.jar’,‘ojdbc14.jar’,‘versioninfo.jar’,‘xdo-
core.jar’,'xdoparser.jar','xdoparser11g.jar' and ‘xmlparserv2.jar’ to
“D:\Reports_11g\Reports_WorkSpace\Host\TOOL_LIB\” folder.

3. Java Source:

Copy below the following files in

“D:\Reports_11g\Reports_WorkSpace\Host” folder

1. GenerateXSL.java
2. GenerateMSXSL.java
3. GenerateCHINTXSL.java
4. GenerateCMBXSL.java
5. GenerateWebServiceXDM.java
6. GenerateMSXDOsAndXDMs.java
7. GenerateCHINTXDOsAndXDMs.java
8. GenerateCMBXDOsAndXDMs.java
9. BIP.properties

Note: you can directly copy Reports_11g folder under Xsltool_11g from
VSS without follow step 4.1.2.

5.1.2 Creating Environment to run the tool:

1. Environment Setting:

Create Folder “Reports_11g” in “D:\” drive.

Create Below subfolders in “Reports_11g” Folder

D:\Reports_11g\Reports_WorkSpace\Host\RTF
D:\Reports_11g\Reports_WorkSpace\Host\RTF\eTEXT
D:\Reports_11g\Reports_WorkSpace\Host\RTF\PDF
D:\Reports_11g\Reports_WorkSpace\Host\TOOL_LIB
D:\Reports_11g\Reports_WorkSpace\Host\ws_rpt
D:\Reports_11g\Reports_WorkSpace\Host\XDM
 D:\Reports_11g\Reports_WorkSpace\Host\XSL

2. Batch File:

Copy ‘GenXSL.Bat’ in “D:\Reports_11g\Reports_WorkSpace\Host”

3. Steps to Generate XDM and XSL:

a. Open Reports_11g folder.

b. Place the rtf inside
“Reports_11g\Reports_WorkSpace\Host\eTEXT” if the format of
rtf is Plain Text .
c. Place the rtf inside
“Reports_11g\Reports_WorkSpace\Host\RTF\pdf” if the format of
rtf is Rich Text Format.
d. Place the corresponding rtf's xdm in the
“Reports_11g\Reports_WorkSpace\Host\XDM” folder.
e. Double click on GenWSXDM.bat for creating Enriched xdm and
generating xdo folders in
“Reports_11g\Reports_WorkSpace\Host\ws_rpt”.
f. Replace Enriched xdm folders from
“Reports_11g\Reports_WorkSpace\Host\ws_rpt” to
“Reports_11g\Reports_WorkSpace\Host\XDM”.
g. Double click on GenXSL.bat.
h. Follow similar above steps in sequence by using
GenCHINTXDMsAndXDOs.bat and GenCHINTXSL.Bat for CHINTXX.
i. Follow similar above steps in sequence by using
GenCMBXDMsAndXDOs.bat and GenCMBXSL.Bat for CMBXX.
j. Follow similar above steps in sequence by using
GenMSXDMsAndXDOs.bat and GenMSXSL.Bat for MSXXX.
k. Select the Option from the displayed Menu.
l. After successfully completion, output for deployment will be
available in “D:\Reports_11g\Reports_WorkSpace\Host\ws_rpt”
folder.

6. Deployment of Build reports:

 Deploy the build xdm and xdo folders from
“Reports_11g\Reports_WorkSpace\Host\ws_rpt” to

“<BIP_11g_Home>\user_projects\domains\bifoundation_domain\config\bipubli
sher\repository\Users\~administrator”

 After successful login to BI Publisher Server following steps are used.

 Navigate to My Folder by clicking My Folder link.

Fig 5.1
 Fig 5.2

7. Annexure A (Use of General Package):

All the flexcube reports are called through a common package
“PK_AP_GEN_REP”.

All the six static parameter defined in the specification part of the package.

Sixteen dynamic parameter are defined in the specification part of the package.

If any report need more than sixteen dynamic parameter then we have to add
parameter in the package specification (Ex: FUNC_PARAM17).
Function “AP_GEN_REP” is defined in the body part of “PK_AP_GEN_REP”.

Below figure shows design diagram for “PK_AP_GEN_REP” specification and

body.

Fig 6.1
Fig 6.2
8. Annexure B (Handled in DB Function):
Some changes that are required in database function in order get required
output.

Changes are two type out of some are generic (changes required in all report)
and some are report specific.

Generic Changes:
 Every function must have order by condition.

 Order by clause must contain group element name

 Every function must return session id value.

 Every function must return cursor as last parameter.

 All select clause elements in cursor must have alias.

Report Specific Changes:

 For calculating running total analytic function is used

 For calculating diffidence between two date oracle function is

used.

 For converting number to word “AP_CONV_AMT_TO_WORDS” is

used.