Applies to:

Siebel Reports - Version: 8.1 SIA [21039] and later   [Release: V8 and later ]
Information in this document applies to any platform.

Purpose

The Reports Business Service enables BI Publisher reports to be executed from the Siebel application via
a Workflow Process, or through scripting. The report is generated in the background by connecting to the
BI Publisher server. The report output is stored in the Siebel File System and accessed from the My BI
Publisher Reports view. The Reports Business Service can not be executed on the Mobile Web Client.

Scope and Application

The technical document is aimed at Siebel configurators. The steps are straight-forward. An SRF
compilation is required to deploy the new Business Object, Business Service and test the Workflow.

It is recommended to use the attachde archive files for this configuration and testing of the Reports
Business Service as documented in the 'Quick Setup Steps'. The 'Complete Setup Steps with Technical
Detail' show the exact configuration changes.

Siebel BI Publisher 8 Reports Business Service

Setup Overview

To use the Reports Business Service and example Workflow Process requires the following steps:

1. Add additional methods and arguments to the XMLP Business Services

2. Add example Workflow Processes
3. Add a new Business Object
4. Compile the SRF
5. Activate and deploy the Workflow Processes

Quick Setup Steps

Use the sif files below for importing the objects detailed in the technical note. The files are included in the
Reports Business Service.zip archive file.

 BIP Business Service.sif 

 Report Output Business Object.sif 
 BIP Create Report Output WF Process.sif 
 BIP Report Generation WF Process.sif 
 BIP Workflow Simulator.xml 
 BIP Workflow Simulator Input Args.xml

1. Backup all XMLP* Business Services to a sif archive file.

2. Import sif file 'BIP Business Service.sif' which includes the changes and new methods to XMLP
Business Services.
3. Import sif file 'Report Output Business Object.sif which will create a new Business Object.
4. Import sif files 'BIP Create Report Output WF Process.sif' and 'BIP Report Generation WF Process.sif'
which will create example Workflow Processes
5. Compile the SRF, log back into the application
6. Activate the new Workflow Processes in the application. Go to Site Map > Administration - Business
Process > Workflow Deployment > Active Workflow Processes > Query for BIP* > select and Activate.

Test

1. Execute the Workflow by navigating to Administration - Business Service > Simulator

2. Create a new record and click Load File. Open file 'BIP Workflow Simulator.xml' to load the example
Workflow Process. Alternatively enter the following values:

Business Service: Workflow Process Manager

Method Name: RunProcess

3. Enter the Input Arguments. Click Load File. Open the file 'BIP Workflow Simulator Input Args.xml'. This
will load the following input arguments, change according to your environment.

Inputs

Name Value
ProcessName BIP Report Generation
 
BIP User ID Administrator
BIP Password Administrator  
Integration Object BIP Accounts - Current Query
 
Bookmark [Name] LIKE 'A*'
ViewMode Organization  
Language Code ENU
Report Name Account List  

Report Output Type HTML

 

4. Select Run
5. Navigate to My Reports view and download the report. If there is no data check the Bookmark query is
valid.

Complete Setup Steps with Technical Detail

1. Add methods to the Business Service in Siebel Tools

In Siebel Tools, for the existing BI Publisher business services, arguments for some of the methods need
to be added in order to support Workflow configuration.
1.1. XMLP Data Service

Method Name - BuildMultiXMLData

Description - This method is used for generating sample data for multiple Integration Objects.
Method Arguments - Add the following method arguments for the BuildMultiXMLData method:

Name Data Type Type Optional  

IntegrationObject String Input False
 

Example runtime values:-

Inputs

Name Value  
IntegrationObject BIP Accounts - Current Query
 
BIP Accounts - Current Query IO
BIP Current Account Service Profile IO  

Method Name - BuildXMLData

Description - This method is used for building sample data for single Integration Object.
Method Arguments - Add the following method arguments for the BuildXMLData method:

Name Data Type Type Optional  

IntegrationObject String Input False
 

Example runtime values:-

Inputs
Name Value  
IntegrationObject BIP Accounts - Current Query
 

Method Name - GetDataAsBinary

Description : This method is used for pushing the run time Siebel data in binary form to the BI Publisher
Server.
Method Arguments: Add the following method arguments for the GetDataAsBinary method.

Name Data Type Optional Storage Description

Type Type
EnableChunk String Output False Property This flag is for enabling chunking or non-chunking during the
pushing of Siebel data and downloading the report output
between Siebel and the BI Publisher Server.
IntegrationObject String Input False Property Name of the Integration Object for the primary Business
Object.
Bookmark String Input True Property The user specified search specification on the active view.
E.g. [Name] Like '3Com*'
ViewMode String Input True Property Visibility of the current active view. E.g. Organization
reportFileName String Output True Property The temporary file generated for the Siebel data in the BI
Publisher Server.
<Value> String Output True Value Siebel data for the report generation in binary form.

Example runtime values:-

Inputs

Name Value  
IntegrationObject BIP Accounts - Current Query
 
Bookmark [Name] Like 'A*'
ViewMode Organization  

 
Outputs

Name Value  
EnableChunk TRUE
 
reportFileName xmlp91996317.tmp

1.2. XMLP Adapter Service

Method Name - RunBIPReport

Description - This method is used for generating the report.
Method Arguments: Add the following method arguments for the RunBIPReport method.

Name Data Type Optional Storage Description

Type Type
BIPPassword String Input False Property BI Publisher server password for session authentication.
BIPUserId String Input False Property BI Publisher server User Id for session authentication.
EnableChunk String Input False Property This flag is for enabling chunking or non-chunking during
downloading the report output between Siebel and BI
Publisher Server.
LanguageCode String Input False Property Language code where the Siebel Object Manager is running.
ReportName String Input False Property Language independent report name to be generated.
ReportOutputId String Input False Property Row Id of Report Output BC for the generating report. 
ReportOutputType String Input False Property The output format in which the report has to be generated.
ReportSelected String Input False Property The language dependent report name.
reportFileName String Input True Property The temporary file generated for the Siebel data in the BI
Publisher server.

 
Name Value
BIPUserId Administrator  Example runtime values:-
BIPPassword Administrator
Inputs
EnableChunk True
LanguageCode ENU  
ReportName Account List
ReportOutputId 88-320FR
ReportOutputType PDF
ReportSelected Account List
reportFileName xmlp91996317.tmp
 

1.3. XMLP Driver Service

Add this method and the following arguments.

Method Name - GenerateBIPReport

Description - This method is used for running the Siebel report. This is the final method which has to be
used to report generation. This will internally generate Siebel binary data and push this to BI Publisher
server.

Method Arguments: Add the following method arguments for the GenerateBIPReport method.

Name Data Type Optional Storage Description

Type Type
BIPPassword String Input False Property BI Publisher server password for session authentication.
BIPUserId String Input False Property BI Publisher server User Id for session authentication.
EnableChunk String Input False Property This flag is for enabling chunking or non-chunking during
downloading the report output between Siebel and BI
Publisher Server.
LanguageCode String Input False Property Language code where the Siebel Object Manager is running.
ReportName String Input False Property Language independent report name to be generated.
ReportOutputId String Input False Property Row Id of Report Output BC for the generating report. 
ReportOutputType String Input False Property The output format in which the report has to be generated.
ReportSelected String Input False Property The language dependent report name.
reportFileName String Input True Property The temporary file generated for the Siebel data in the BI
Publisher server.

2. Create new Business Object

In order to generate the report using Workflow, a new record has to be created in the Report Output BC.
To create a new record in Report Output BC, we have to add a new Business Object.

2.1. Create a new Business Object with the following properties

Name Primary Business Query List Business  

Component Component
Report Output Report Output BC Query List  

2.2. Add the following Business Object Components

Name Link  
Report Output BC  
 
Report Output  
BC.Sequence Number
(Sequence)  

3. Create new Workflow Process

In Siebel Tools create new Workflow Processes for Siebel BI Publisher report generation.

3.1. Create a new Workflow Process - BIP Create Report Output

Create a new Workflow Process with the following properties

3.1.1. Workflow Process - BIP Create Report Output

Process Name Workflow Mode Business Object  
BIP Create Report Output Service Flow Report Output

3.1.2. WF Process Prop

Name In/Out Business Object Data Type Description

Report Name In Report Output String The new report name to be created.
ReportOutputId Out Report Output String Row Id of Report Output BC for the generating report.

3.1.3. WF Step

Name Type Business Component Operation  

Start Start    
 
New Report Siebel Operation Report Output BC Insert
End 0 End      

3.1.4. WF Step Branch

Step Name Name Type To Step Name  

Start Connector 0 Default New Report
 
New Report Connector 1 Connector End 0

3.1.5. WF Step I/O Arguments

Step Name Type Field Name Sub Process Method Arg Property Value/Se Inp
Nam Input Arg Name arch ut
e Specifica Fla
tion g
New Report Name Process Report Name Report Name Report Name Report   I
Rep Propert Name
ort y
  ReportOutputFil Process ReportOutputFil ReportOutputFil ReportOutputFil Report   I
eName Propert eName eName eName Name
y
  Owner Id Express Owner Id Owner Id Owner Id   LoginId() I
ion
  Time Generated Express Time Generated Time Generated Time Generated   TimeSta I
ion mp()
  O:New Express O:New O:New O:New ReportOut [&Siebel O
Report70 ion Report70 Report70 Report70 putId Operatio
 n Object
Id]

3.2. Create a new Workflow Process - BIP Report Generation

Create a new Workflow Process with the following properties

3.2.1. Create a new Workflow Process - BIP Report Generation

Process Name Workflow Mode Business Object  

BIP Report Generation Long Running Flow  
 

3.2.2. WF Process Prop

Name In/Out Business Data Description

Object Type
BIP Password In   String BI Publisher server password for session authentication.
BIP User ID In   String BI Publisher server User Id for session authentication.
Bookmark In   String The user specified search specification on the active view.
E.g. [Name] Like '3Com*'
Integration Object In   String Name of the Integration Object for the primary Business
Object.
Language Code In   String Language code where the Siebel Object Manager is running.
Report Name In   String Language independent report name to be generated.
Report Output In   String The output format in which the report has to be generated.
Type
ReportOutputId In/Out   String Row Id of Report Output BC for the generating report.
ViewMode In   String Visibility of the current active view. E.g. Organization.
reportFileName Out   String Temporary file generated for the Siebel data in the BI
Publisher Server.

 3.2.3. WF Step

Name Type Business Business Service Subprocess Business Operation

Service Name Method Name Component
Start Start       Report Output  
BC
BIP New Sub     BIP Create    
Report Output Process Report Output
RunReport Business XMLP Driver GenerateBIPReport      
Service Service
End 0 End          
 

3.2.4. WF Step Branch

Step Name Name Type To Step Name  

Start Connector 0 Default BIP New Report Output
 
BIP New Report Output Connector 2 Connector RunReport
RunReport Connector 1 Connector End 0  

3.2.5 WF Step I/O Arguments

Step Name Type Field Sub Method Property Value/Sear Inp Output SubProc
Name Name Process Arg Name ch ut Arg ess
Input Arg Specificati Fla Output
on g Arg
BIP Report Proce Report Report Report Report   I    
New Name ss Name Name Name Name
Report Proper
Output ty
BIP O:BIP New Output O:BIP New O:BIP New O:BIP New ReportO   O ReportO ReportO
New Report Argum Report Report Report utputId utputId utputId
Report Output20 ent Output20 Output20 Output20
Output
RunR LoginId Expre LoginId LoginId LoginId   LoginId() I    
eport ssion
RunR BIPUserId Proce BIPUserId BIPUserId BIPUserId BIP User   I    
eport ss ID
Proper
ty
RunR BIPPassw Proce BIPPassw BIPPassw BIPPassw BIP   I    
eport ord ss ord ord ord Passwor
Proper d
ty
RunR ReportNa Proce ReportNa ReportNa ReportNa Report   I    
eport me ss me me me Name
Proper
ty
RunR ReportOut Proce ReportOut ReportOut ReportOut Report   I    
eport putType ss putType putType putType Output
Proper Type
ty
RunR Language Proce Language Language Language Languag   I    
eport Code ss Code Code Code e Code
Proper
ty
RunR ReportOut Proce ReportOut ReportOut ReportOut Report   I    
eport putId ss putId putId putId Output Id
Proper
ty
  ReportSel Proce ReportSel ReportSel ReportSel Report   I    
ected ss ected ected ected Name
 Proper
ty
  Integration Proce Integration Integration Integration Integrati   I    
Object ss Object Object Object on
Proper Object
ty
  ViewMode Proce ViewMode ViewMode ViewMode View   I    
ss Mode
Proper
ty
  MethodNa Literal MethodNa MethodNa MethodNa   GenerateBI I    
me me me me PReport
  Bookmark Proce Bookmark Bookmark Bookmark Bookmar   I    
ss k
Proper
ty
  LDAPEnab Literal LDAPEnab LDAPEnab LDAPEnab   True I    
led led led led

4. Deploy and Test Configuration

4.1 Compile the SRF, log back into the application

4.2 Activate the new Workflow Processes in the application. Go to Site Map > Administration -
Business Process > Workflow

Deployment > Active Workflow Processes > Query for BIP* > select and Activate.

4.3 To test, follow the test steps detailed at the beginning of the document.