BIP Reports Setup in Siebel

BIP Reports Documentation




Introduction 2
Steps to convert Actuate Report into Oracle BI Publisher 2
Actuate Reports Conversion Assistant 3
Steps to Convert Report Layout 4
Siebel Reporting Architecture with BI Publisher 7
Two Different Modes for BI Publisher Integration 7

Siebel Reports Architecture and Report Flow Generation for Connected Mode 7
Siebel Reports Architecture and Report Flow Generation for Disconnected Mode 9
OBI Publisher Reports 11
1. Create a new Integration Object in Siebel Tools – 11
2. Create sample XML file- 14
3. Create a Report template- 17
4. Register the report template using the Report Template Registration view. 26
5. View Association- 27









Introduction
BI Publisher has been introduced to Siebel users since its Release 8.1.1 as a new reporting platform replacing the older Actuate base reporting platform. It is tightly integrated with the Siebel architecture and its applications. The users can run and manage their reports with BI Publisher from Siebel applications UI.
This document provides detail description of how to convert Actuate reports to BI reports and how to create reports Using OBI Publisher

Steps to convert Actuate Report into Oracle BI Publisher

The Siebel Reports integration with Oracle BI Publisher is based on a loosely coupled architecture where Oracle BI Publisher runs as a standalone server. The integration point for Siebel Reporting will be through standard Web services integration using Siebel EAI. Reports will be submitted and rendered within the context of the Siebel user interface. The reports can be saved within the Siebel file system. Actuate, in a Siebel CRM environment, handles the report layout in an Actuate design File (.ROD file) and the report data comes from Siebel in pre-built report objects (Business Objects, Business Components etc.). In Oracle BI Publisher the data model and the layout are separate entities, therefore, the Actuate Reports Conversion Assistant can assist with part of the reports conversion process.




Actuate Reports Conversion Assistant
Actuate Reports Conversion Assistant is a command line utility that converts the Actuate layout design into BI Publisher layout design. It takes the .BAS file as input that is generated by Actuate Design File (.ROD) during compilation. The conversion tool reads the .BAS file and generates an RTF template for BI Publisher.
Prerequisites

1. Windows OS environment
2. JRE 1.5 or above installed in the machine and this should be set in the Windows path environment variable. To verify the version of java in the machine, type the following in a command prompt:
Java -version



3. If the Java version is lower than 1.5 then you must change the path at the command prompt to the higher version:
Set path = [enter the path to a higher version of Java.exe]; %path%
Note: The complete install of Oracle BI Publisher 10.1.3.4 includes a JDK 1.5 installation.
Steps to Convert Report Layout


1. Extract the files from ActuateConversionAssistant_v1.00.zip to a suitable location



2. From a Windows command prompt navigate to the extracted locations and the ‘scripts’ folder.




3. Type "run" to start the conversion. The run command can have the following options:
run –i -o

-l
Option -i is a mandatory switch, -o and -l are optional and will default to the input bas file location. [-i , -o , -l] can be a file name or a folder location (for multiple report conversion) To convert multiple reports at a time, run the following command run –i basFile_path -o RTFfile_path This will read all the files in the basFile_path location and put the generated files with corresponding names in the RTFfile_path location. By default a log file is created at location RTFfile_path.


4. Review the BI Publisher rtf template and log file created. If the log file indicates any function that could not be handled then inspect the RTF template in the BI Publisher Word Add-In. In the Template Builder, open the Field Browser under the Tools menu. Look for the label mentioned in the log file and the corresponding data commented out with in tags . These are copied functions or expressions from Actuate. These need to be converted into BI Publisher syntax to handle the function or expression. If the log file indicates failure to convert any Actuate Report object, then you will have to manually add the equivalent report object in the RTF template.



5. Using a sample XML data for the report, preview the report output while you are using the Template Builder. Make modifications as necessary to match the look and feel of the report layout.

6. Deploy the RTF template to Oracle BI Publisher Server.





OBI Publisher Reports
Following are the steps to generate a simple report in Siebel with the help of OBI Publisher which is a new feature in Version 8.1.1.
1. Create a new integration object using Siebel Tools
2. Create XML data using the Sample Data File Generation view in the Siebel client.
3. Create a new report template or modify an existing report template using Oracle BI Publisher Desktop.
4. Register the report template using the Report Template Registration view.
5. Associate the report with Siebel views.
The detailed explanation of each step is as follows:
1. Create a new Integration Object in Siebel Tools –
Integration Object is a logical representation of external application data, or of Siebel data that needs to map to an external application. You can either create an Integration object through New Object wizard or by directly creating a new record at object level.















Compile the Integration object into srf.

2. Create sample XML file-
After creating the Integration object, we have to create a sample xml file which is our data source. Log into Siebel Application. Go to Administration – BIP Reports -> Sample Data File Generation view .Query for the Integration object created and click on Generate sample XML button.


Once the sample xml file is created, we have to save it in Client root->XMLP->DATA folder.



3. Create a Report template-
Now that we have the xml data source, we have to develop a template file on which we want to see the Report. Open a word document (considering that OBI Publisher desktop is installed).Go to Data -> Load xml. Choose the xml file generated and load it to the template.




Now that we have loaded the data, we have to insert fields. Go to Insert ->Choose Field if we want add a few fields only .Choose table to insert a table or Form or Free form.














You can also give headings and attach logos to your report template.
Select Tools->Field Browser. Dialog box opens which shows the template logic and allows us to change it.


Go to Preview->Choose in which format you want to preview the report. This allows us to preview the report.


A pop up will come asking to save the file in rtf extension.Click Yes and save the file in Client root\XMLP\TEMPLATES folder.

Now you can preview the report in any format.
Go to Tools -> Validate Template. This will validate the template which is created.



4. Register the report template using the Report Template Registration view.

Log into Application Administration – BIP Reports -> Report Template Registration view. Create a new record. Give the name of your report as you want to see it in Application. Give the rtf template name and output type. Go to Report Template Integration Object and add the Integration object you created.

Save the record.
Click on Generate Xliff button. This will generate the .xsl file(localization file) in Client Root\XMLP\Template Folder.


XML, XLIFF, and XSL template are given as input to the XDO classes for generating the report.
5. View Association-
Associate the report to views on which you want to generate report. Go to Administration- BIP Reports -> View Association. Query for the view. On report list applet, add the report name and save.

6. Now that the configuration is over. You can go to the specific view and click on Reports icon.

Under BIP, You can the report name which you created. Click on that. A window will open which will ask the output type. Select the output type and click on Submit. You can view the report in template which you have created.





















Deploying BI Reports for Mobile Clients
--add the xmlp resp. to user
--Copy files to client installed dir (Data,rtf,xsl.xlf
)