Siebel Reports Guide

Version 8.1, Rev. C

June 2010
Copyright © 2005, 2010 Oracle and/or its affiliates. All rights reserved.

The Programs (which include both the software and documentation) contain proprietary information;
they are provided under a license agreement containing restrictions on use and disclosure and are also
protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering,
disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability
with other independently created software or as specified by law, is prohibited.

The information contained in this document is subject to change without notice. If you find any problems
in the documentation, please report them to us in writing. This document is not warranted to be error-
free. Except as may be expressly permitted in your license agreement for these Programs, no part of
these Programs may be reproduced or transmitted in any form or by any means, electronic or
mechanical, for any purpose.

If the Programs are delivered to the United States Government or anyone licensing or using the Programs
on behalf of the United States Government, the following notice is applicable:

U.S. GOVERNMENT RIGHTS

Programs, software, databases, and related documentation and technical data delivered to U.S.
Government customers are "commercial computer software" or "commercial technical data" pursuant to
the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such,
use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and
technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license
agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial
Computer Software--Restricted Rights (June 1987). Oracle America, Inc., 500 Oracle Parkway, Redwood
City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently
dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,
redundancy and other measures to ensure the safe use of such applications if the Programs are used for
such purposes, and we disclaim liability for any damages caused by such use of the Programs.

The Programs may provide links to Web sites and access to content, products, and services from third
parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites.
You bear all risks associated with the use of such content. If you choose to purchase any products or
services from a third party, the relationship is directly between you and the third party. Oracle is not
responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of
the agreement with the third party, including delivery of products or services and warranty obligations
related to purchased products or services. Oracle is not responsible for any loss or damage of any sort
that you may incur from dealing with any third party.

Oracle, JD Edwards, and PeopleSoft are registered trademarks of Oracle Corporation and/or its affiliates.
Other names may be trademarks of their respective owners.
 Contents

Siebel Reports Guide 1

Chapter 1: What’s New in This Release

Chapter 2: Overview of Siebel Reports

About Siebel Reports 19
About Using Siebel Reports 20
Siebel Reports Output File Types 20
Who Can Use Siebel Reports? 21
About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with
Siebel Reports 21

Chapter 3: Siebel Reports Development Environment

About the Siebel Reports Architecture 25
Workflow for Generating Reports in Connected Mode 26
Workflow for Generating Reports in Disconnected Mode 27
Siebel Reports Directory Structure 29
Siebel Reports File Types 29
About the Oracle BI Publisher Server in Siebel Business Applications 30
How Siebel Business Applications and Oracle BI Publisher Interact 31

Chapter 4: Integrating Oracle BI Publisher with Siebel

Business Applications
About Integrating Oracle BI Publisher with Siebel Business Applications 35
Where to Find Integration Instructions for Previous Versions of Siebel Reports 37
Preparing for Integration of Oracle BI Publisher with Siebel Business Applications 37
Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications 39
Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel
Business Applications 40
Installing Oracle BI Publisher for Siebel Business Applications 40
Upgrading to Oracle BI Publisher Version 10.1.3.4.1 from Version 10.1.3.4.0 42
Copying JAR Files to the Oracle BI Publisher Server 43

Siebel Reports Guide Version 8.1, Rev. C 3

Contents ■

Enabling External File References for the Oracle BI Publisher Server 44

Changing the Location of the Oracle BI Publisher Repository for Siebel Reports 45
Process of Configuring the Siebel Application for Integration with Oracle BI Publisher
46
Importing an Archive File to Apply the New Siebel Reports Features 48
Copying Fonts for Report Generation 49
Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server 50
Configuring the Outbound Web Service for the Oracle BI Publisher Server 52
Creating Report Responsibilities in the Siebel Application 54
Process of Authenticating User Access to the Oracle BI Publisher Server 56
Configuring Security and Authentication Using the Siebel Security Model 57
Configuring Security and Authentication Using the LDAP Security Model 59
Configuring Siebel Reports in a Web Single Sign-On Environment 59
Process of Enabling and Configuring Report Scheduling 60
Embedding the Oracle BI Publisher Scheduled Reports View in the Siebel Application 61
Configuring the BIPDataService WSDL for the Oracle BI Publisher Server 62
Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server
63
Uploading New or Modified Report Layout Templates for Multiple Siebel Server
Environments 64
Testing Your Siebel Reports Integration Configurations 65

Chapter 5: Administering Siebel Reports

Deploying Report Layout Templates to the Siebel Web Client from a Disconnected
Client 67
Automatically Purging Reports from the Siebel File System 68
Purging Scheduled Reports from the Oracle BI Publisher Server 69
About Working with Multilingual Reports 70
About Report Translation 72
Designing Multilingual Reports 72
Adding and Deleting Languages from Report Templates 73
Roadmap for Optimizing the Performance of Siebel Reports 74
Setting the Report Execution Waiting Period for Reports 74
Setting the Server Request Processor Database Polling Interval for Siebel Reports
75
Setting Concurrency Parameters for Siebel Reports 76

4 Siebel Reports Guide Version 8.1, Rev. C

 Contents ■

Process of Optimizing the Generation Performance of Siebel Reports for Large Data
Volumes 77
Enabling Scalable Mode for Siebel Reports 77
Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports
79
Increasing EAI HTTP Transport Sleep Time for Siebel Reports 80

Chapter 6: Generating Reports

About Generating Reports 81
Workflow for Generating Reports 83
Scenario for Generating Reports 84
Generating Reports 86
Example of Generating an Opportunity Report 87
Monitoring the Status of Currently Generating Reports 88
Viewing Generated Reports 89
Deleting Reports 90
Setting Language and Locale User Preferences for Reports 91

Chapter 7: Creating Reports

Should You Clone an Existing Report or Create Custom Reports? 93
Scenario for Creating Reports 94
Workflow for Creating Reports 95
About Integration Objects in Siebel Reports 96
About Reporting Across Multiple Siebel Business Objects 97
Workflow for Uploading Report Layout Templates to a Siebel Application 99
About Registering and Sharing Report Layout Templates 100
Process of Creating Custom Reports 101
Extending Integration Objects to Add New Fields for Siebel Reports 102
Creating New Integration Objects for Siebel Reports 103
Generating Sample XML Data Files for Siebel Reports 105
Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for
Microsoft Word 106
Previewing Report Layout Templates 107
Registering Report Layout Templates 108
Adding Multiple Integration Objects to a Report 111
Sharing Report Layout Templates 112

Siebel Reports Guide Version 8.1, Rev. C 5

Contents ■

Defining Report Layout Templates for Selected Records 112

Associating Registered Reports with Siebel Application Views 113
Changing the Report Sequence Order in the Reports Menu 113

Chapter 8: Scheduling Reports

About Scheduled Reports 115
Scheduling Reports 116
Example of Scheduling an Opportunity Report 117
Monitoring and Viewing Scheduled Reports 118
Deleting Scheduled Reports 119

Chapter 9: Using Master-Detail Reports

About Master-Detail Reports 121
How Master-Detail Reports Work 122
Creating a Master-Detail Layout Template in Microsoft Word 126

Chapter 10: Migrating Reports

Requirements for Migrating Reports 129
Process of Packaging and Migrating Reports 130
Packaging the Report Files in the Source Environment 130
Migrating the Report Files to the Target Environment 131
Packaging Report Database Records in the Source Environment 132
Migrating Report Database Records to the Target Environment 133
Process of Migrating an Integration Object for a Report 134
Process of Migrating New Reports after Creating New Integration Objects 135

Chapter 11: Parameterized Reports

About Parameterized Reports 137
About Defining Parameters in the Report Layout Template 138
About Referencing Parameters in the Report Layout Template 138
How Parameterized Reports Are Generated 139
Example of Generating a Parameterized Report 140

Appendix A: Troubleshooting Siebel Reports

Enabling Logging for the XMLP Report Server Component 141

6 Siebel Reports Guide Version 8.1, Rev. C

 Contents ■

About Enabling Logging for the Oracle BI Publisher Server 143

Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode 143
Resolving Class Not Found Errors When Previewing Reports in Microsoft Word 144
Troubleshooting Error Messages for Siebel Reports 146

Appendix B: Report Business Service

About the Report Business Service 155
Configuring the Report Business Service 156

Index

Siebel Reports Guide Version 8.1, Rev. C 7

Contents ■

8 Siebel Reports Guide Version 8.1, Rev. C

1 What’s New in This Release

This guide provides instructions for setting up the Siebel Reports environment and integrating
Oracle® Business Intelligence Publisher (Oracle BI Publisher) with Siebel Business Applications. This
guide also provides instructions for administering and troubleshooting Siebel Reports. Additionally,
this guide provides instructions for generating, creating, and scheduling reports applicable to all
users.

NOTE: For Siebel CRM version 8.1 and later, the reporting module for Siebel Reports is Oracle BI
Publisher.

What’s New in Siebel Reports Guide, Version 8.1, Rev. C

Table 1 lists the changes described in this version of the documentation to support release 8.1 of the
software.

Table 1. New Product Features in Siebel Reports Guide, Version 8.1, Rev. C

Topic Description

Chapter 6, “Generating Reports” Modified topics in these chapters to reflect the new user
Chapter 7, “Creating Reports” interface that allows for sharing of reports and includes
Chapter 8, “Scheduling Reports” other new features.

“About Using Siebel Reports” on page 20 Modified topic. Access control to generated reports is
based on standard Siebel position-based visibility.

“Copying JAR Files to the Oracle BI Modified topic. Two additional JAR files must be copied.
Publisher Server” on page 43

“Adding an Explicit Reference to JAR Files Modified topic as follows:

for the Oracle BI Publisher Server” on
■ Added a note advising that the path of the JVM DLL
page 50
Name parameter is automatically read from the
Windows registry.

■ Corrected the JVL DLL Name setting for UNIX.

■ Corrected the path for the LIBPATH environment

variable for UNIX.

■ Corrected the JVM classpaths for UNIX and Windows.

“Configuring Security and Authentication Modified topic. You replace the existing address of the
Using the Siebel Security Model” on Service Ports subview with the URL used to access the
page 57 EAI Object Manager.

Siebel Reports Guide Version 8.1, Rev. C 9

What’s New in This Release ■

Table 1. New Product Features in Siebel Reports Guide, Version 8.1, Rev. C

Topic Description

“Configuring Security and Authentication Modified topic. Replaced procedure with a cross
Using the LDAP Security Model” on reference to 974509.1 (Doc ID) on My Oracle Support.
page 59

“Configuring Siebel Reports in a Web New topic. It describes how to configure Siebel Business
Single Sign-On Environment” on page 59 Applications and Oracle BI Publisher in a Web Single
Sign-On (SSO) environment.

“Uploading New or Modified Report New topic. It describes how to register new or modified
Layout Templates for Multiple Siebel report definitions for multiple Siebel Server
Server Environments” on page 64 environments.

“Purging Reports from the Siebel File Removed topic. This feature is no longer applicable.
System” on page 66

“Automatically Purging Reports from the New topic. It provides instructions for administrators to
Siebel File System” on page 68 set up an automated process for purging reports from
the Siebel File System.

“About Working with Multilingual New topic. It describes how Siebel Reports determines
Reports” on page 70 the report language at run time.

“About Report Translation” on page 72 New topic. It describes report translation.

“Designing Multilingual Reports” on Modified topic. Added an optional step to the procedure.
page 72

Chapter 6, “Generating Reports” Modified topic. Added a note advising this chapter is not
applicable to scheduled reports.

“About Generating Reports” on page 81 Modified topic. Access to reports is based on standard
Siebel position-based visibility.

“Workflow for Generating Reports” on Modified topic. You can choose a different language and
page 83 locale rather than accept the default choices when
generating a report.

“Generating Reports” on page 86 Modified topic. You can:

■ Grant others access to your reports.

■ Select multiple records when generating reports.

■ Override the default report language and locale

settings.

“Setting Language and Locale User New topic. It describes how to override the default
Preferences for Reports” on page 91 report language and locale by setting user preferences.

“Viewing Generated Reports” on page 89 Modified topic. It describes the following:

■ Which generated reports a user has access to.

■ How to run a query on any of the fields in the Reports

views.

10 Siebel Reports Guide Version 8.1, Rev. C

 What’s New in This Release ■

Table 1. New Product Features in Siebel Reports Guide, Version 8.1, Rev. C

Topic Description

“Workflow for Creating Reports” on Modified topic. Updated the figure to reflect the new user
page 95 interface.

“About Registering and Sharing Report New topic. It describes how to register and share report
Layout Templates” on page 100 layout templates.

“Process of Creating Custom Reports” on Modified topic. Added optional steps to the process.
page 101

“Registering Report Layout Templates” Modified topic. Updated the procedure for registering
on page 108 report layout templates.

“Sharing Report Layout Templates” on New topic. It describes how to share report layout
page 112 templates.

“Defining Report Layout Templates for New topic. It describes how to configure a report layout
Selected Records” on page 112 template to display only the currently selected records in
a Siebel application view when a report is generated.

“Changing the Report Sequence Order in New topic. It describes how to define the way reports are
the Reports Menu” on page 113 ordered in the Reports menu.

“Scheduling Reports” on page 116 Modified topic. Updated the procedure for clarity and the
new user interface.

“Creating a Master-Detail Layout Modified topic. Clarified the last step in the procedure.
Template in Microsoft Word” on page 126

“Troubleshooting Error Messages for Modifiect topic. Added two new solutions for errors that
Siebel Reports” on page 146 can occur while uploading files to Oracle BI Publisher.

Additional Changes
This version of Siebel Reports Guide includes:

■ The following screen names and other user interface (UI) elements have changed:
■ The Administration - BIP Reports screen is now the Administration - BI Publisher Reports
screen.

■ The BIP Reports Server is now BI Publisher Reports.

■ The Purge Administration view is no longer available in the UI.

■ The My Jobs view is now the Scheduled Reports view.

■ The Report Template Registration view is replaced with two new template views:

❏ Reports - Customer Templates

❏ Reports - Standard Templates

■ The Generate Sample Data File button in the Integration Objects list of the template views
is now Generate Sample XML.

■ You can generate reports in MHTML format in connected mode only.

Siebel Reports Guide Version 8.1, Rev. C 11

What’s New in This Release ■

What’s New in Siebel Reports Guide, Version 8.1, Rev. B

Table 2 lists the changes described in this version of the documentation to support release 8.1 of the
software.

Table 2. New Product Features in Siebel Reports Guide, Version 8.1, Rev. B

Topic Description

“Workflow for Generating Reports in Added a caution about not modifying parameters for the
Connected Mode” on page 26 XMLP Report Server component.

“Where to Find Integration New topic. It provides pointers to integration instructions

Instructions for Previous Versions of for other releases of Siebel Reports.
Siebel Reports” on page 37

“Preparing for Integration of Oracle BI New topic. It provides prerequisites before deploying
Publisher with Siebel Business Siebel Reports.
Applications” on page 37

“Roadmap for Integrating Oracle BI New title for topic. Modified topic to reflect high-level
Publisher with Siebel Business integration tasks.
Applications” on page 39

“Process of Installing and Configuring New topic. It consolidates several of the Oracle BI
Oracle BI Publisher for Integration with Publisher installation and configuration tasks previously
Siebel Business Applications” on located elsewhere in this guide.
page 40

“Installing Oracle BI Publisher for Modified topic:

Siebel Business Applications” on
■ Added a note to make it clear that the instructions are
page 40
for a first-time installation rather than an upgrade from
a previous version.

■ Removed the optional step of downloading the Business

Intelligence Suite Enterprise Edition Documentation
Media Library.

■ Added a step to have users download Oracle BI

Publisher Desktop.

“Upgrading to Oracle BI Publisher New topic. It describes how to upgrade Oracle BI Publisher
Version 10.1.3.4.1 from Version to version 10.13.4.1 from 10.1.3.4.0. The content was
10.1.3.4.0” on page 42 relocated from Appendix C and rewritten to correct
inaccuracies and to differentiate from a first-time
installation.

“Copying JAR Files to the Oracle BI Modified topic to remove steps for enabling external file
Publisher Server” on page 43 references because those steps belong to another task.

“Enabling External File References for New topic. It describes how to enable external file
the Oracle BI Publisher Server” on references on the Oracle BI Publisher Server.
page 44

12 Siebel Reports Guide Version 8.1, Rev. C

 What’s New in This Release ■

Table 2. New Product Features in Siebel Reports Guide, Version 8.1, Rev. B

Topic Description

“Process of Configuring the Siebel Modified topic:

Application for Integration with Oracle
■ The tasks in this process were added, removed, and
BI Publisher” on page 46
reorganized, as needed.

■ Step 3 of the process was rewritten to make sure the

XMLP Report Server component is enabled and a
caution was added about not changing this
component’s parameters.

“Importing the Siebel CRM 8.1.1.1 Removed topic because it is no longer applicable.
Fix Pack SIF File for Use with Siebel
Reports”

“Importing an Archive File to Apply the New topic. It describes how to import a SIF file using Siebel
New Siebel Reports Features” on Tools to apply the new report scheduling and
page 48 parameterization features.

“Creating Report Responsibilities in the New topic. It describes how to create new report
Siebel Application” on page 54 responsibilities that are necessary for report scheduling.

“Configuring the BIPDataService Modified topic for accuracy, ease of use, and completeness.
WSDL for the Oracle BI Publisher
Server” on page 62

“Process of Authenticating User Access Tasks were added, removed, and reorganized as needed.
to the Oracle BI Publisher Server” on Subtopics were also rewritten.
page 56

Process of Enabling and Configuring Removed topics. Content relocated elsewhere in the guide.
Report Scheduling

Setting Up the Database Schema for

the Oracle BI Publisher Server

“Testing Your Siebel Reports New topic. It provides instructions for testing your
Integration Configurations” on configurations.
page 65

“Deploying Report Layout Templates to New topic. It provides instructions for moving reports from
the Siebel Web Client from a a disconnected client to a Siebel Web Client so that reports
Disconnected Client” on page 67 are available for generation in connected mode with the
Oracle BI Publisher Server.

“Purging Scheduled Reports from the Modified topic to make it clear that the purging instructions
Oracle BI Publisher Server” on page 69 are for scheduled reports.

“Setting the Report Execution Waiting Modified topic to reflect that this task is applicable to
Period for Reports” on page 74 performance optimization of reports with more than 100
records rather than 2000 records.

“Enabling Scalable Mode for Siebel Corrected directory path in Step 1 of the procedure.
Reports” on page 77

Siebel Reports Guide Version 8.1, Rev. C 13

What’s New in This Release ■

Table 2. New Product Features in Siebel Reports Guide, Version 8.1, Rev. B

Topic Description

“Configuring a Temporary Directory on Corrected directory path in Step 1 of the procedure.

the Oracle BI Publisher Server for
Siebel Reports” on page 79

“Monitoring the Status of Currently Added a tip about the timestamp of a report.
Generating Reports” on page 88

“Extending Integration Objects to Add New topic. It describes how to extend an integration object
New Fields for Siebel Reports” on to add a new field to a report.
page 102

“Scheduling Reports” on page 116 Added a note at the end of the procedure advising that the
My Jobs view is an embedded Web page from the Oracle BI
Publisher Enterprise application.

“About Parameterized Reports” on Removed the last paragraph in the topic. No preconfigured
page 137 parameterized reports ship with Siebel Business
Applications.

“Enabling Debugging for Siebel Corrected the procedure.

Reports in Disconnected Mode” on
page 143

“Troubleshooting the CLASSPATH Modified topic to correct the command syntax.

Settings Using Siebel Server Manager”
on page 153

Appendix C, “Upgrading to Siebel Removed appendix. Content relocated to the “Upgrading

Reports Version 8.1.1.1” Oracle BI Publisher” topic.

Additional Changes
■ Replaced references to Oracle application servers with ORACLE_HOME.

■ Replaced references to the Oracle BI Publisher installation directory with ORACLE_HOME/oc4j_bi.

■ Replaced references to OracleMetaLink 3 with My Oracle Support.

■ Retitled Chapter 4, “Integrating Oracle BI Publisher with Siebel Business Applications” to clarify
that tasks are integration tasks rather than installation and configuration tasks. Also made
structural changes to the content, including:

■ Topic additions, deletions, renaming, and reorganization

■ Revisions to procedures

■ New and revised index entries

■ Added new requirements for implementing Siebel Reports.

■ Modified steps in roadmap for integrating Oracle BI Publisher with Siebel Business Applications.

■ Provided a better example for the “Configuring the Outbound Web Service for the Oracle BI
Publisher Server” topic.

14 Siebel Reports Guide Version 8.1, Rev. C

 What’s New in This Release ■

■ Reworded note at the end of the “Enabling Scalable Mode for Siebel Reports” topic for clarity.

What's New in Siebel Reports, Version 8.1, Rev. A

Table 3 lists the changes described in this version of the documentation to support release 8.1 of the
software.

Table 3. New Product Features in Siebel Reports Guide, Version 8.1, Rev. A

Topic Description

Chapter 4, “Installing and Modified chapter. It describes how to install and configure
Configuring Siebel Reports” Siebel Reports version 8.1.1.1.

“Installing Oracle BI Publisher for Modified topic. It describes how to install Oracle Business
Siebel Business Applications” on Intelligence (BI) Publisher version 10.1.3.4.1.
page 31

“Purging Reports in the Oracle BI New topic. It describes how to purge reports permanently
Publisher Server” on page 51 in the Oracle BI Publisher repository.

“Process of Optimizing the Modified topic. Added a note about not executing reports
Generation Performance of Siebel with large data volumes as an immediate report request.
Reports for Large Data Volumes” on
page 57

“Enabling Scalable Mode for Siebel Modified topic. Added a note advising when not to enable
Reports” on page 58 scalable mode.

“Configuring a Temporary Directory New topic. It describes how to configure a temporary

on the Oracle BI Publisher Server for directory on the Oracle BI Publisher Server for use with
Siebel Reports” on page 60 complex reports.

“Increasing EAI HTTP Transport New topic. It describes how to increase the default sleep
Sleep Time for Siebel Reports” on time to improve performance when generating complex
page 60 reports or against large data sets.

Chapter 7, “Scheduling Reports” New chapter. It describes how to schedule reports to run
at a later date and with recurring frequency.

Chapter 9, “Using Master-Detail New chapter. Content in this chapter was relocated from
Reports” Chapter 5, “Administering Siebel Reports.”

Chapter 10, “Parameterized Reports” New chapter. It provides the additional tasks you must
perform when creating parameterized reports.

“Resolving Class Not Found Errors New topic. It describes how to resolve errors encountered
When Previewing Reports in when previewing reports in Microsoft Word.
Microsoft Word” on page 118

Appendix B, “Report Business New appendix. It describes the Report Business Service
Service” and how it is used.

Appendix C, “Upgrading to Siebel New appendix. It describes how to upgrade to Siebel

Reports Version 8.1.1.1” Reports version 8.1.1.1.

Siebel Reports Guide Version 8.1, Rev. C 15

What’s New in This Release ■

Additional Changes
This version of Siebel Reports Guide includes:

■ Several new preconfigured reports are available in this release. For a comprehensive list of the
preconfigured reports that ship with Siebel Business Applications, see 876284.1 (Doc ID) on My
Oracle Support.

■ Changes made throughout the guide to reflect the new features and functionality for the current
release of Siebel Reports.

■ Structural changes to the content, such as topic organization and heading arrangement,
revisions to procedures, and an expanded index.

What's New in Siebel Reports, Version 8.1

Table 4 lists the changes described in this version of the documentation to support release 8.1 of the
software.

Table 4. New Product Features in Siebel Reports Administration Guide, Version 8.1

Topic Description

Chapter 2, “Overview of Siebel Reports” New chapter. It describes Siebel Reports.

Chapter 3, “Siebel Reports Development New chapter. It describes the Siebel Reports
Environment” architecture and report generation, the Oracle BI
Publisher Server, and how Oracle Business
Intelligence Publisher (Oracle BI Publisher)
interacts with Siebel Business Applications.

Chapter 4, “Installing Siebel Reports” New chapter. It describes the preinstallation,

installation, and postinstallation tasks for Siebel
Reports.

Chapter 6, “Administering Siebel Reports” New chapter. It describes how to purge reports
and create multilingual reports.

Chapter 8, “Running Reports” New chapter. It describes how to run Siebel

Reports from a user perspective.

Chapter 9, “Creating Reports” New chapter. It describes the report layout

templates, integration objects, and master-detail
reports.

Chapter 12, “Migrating Reports” New chapter. It describes how to migrate reports
from one environment to another (applicable only
to disconnected clients).

Appendix A, “Troubleshooting Siebel Reports” New appendix. It describes how to enable logging
for the various components of Siebel Reports, and
how to respond to error messages.

16 Siebel Reports Guide Version 8.1, Rev. C

 What’s New in This Release ■

Additional Changes
■ Removed all Actuate-related chapters and content.

For information about integrating Siebel reports with Actuate, see Siebel Reports Administration
Guide version 8.0 on the Siebel Bookshelf.

NOTE: The Siebel Bookshelf is available on Oracle Technology Network (OTN), Oracle E-Delivery,
or it might be installed locally on your intranet, or on a network location.

■ Reports and the Reports Menu are no longer available in Siebel Tools. Siebel Reports are now
accessed using the application views in the Siebel clients.

■ Several reports are no longer available. Of particular note, the following reports are no longer
available:

■ Application Upgrade Object List. Provided object differences between repository versions.

■ Application Upgrade Attributes List. Provided attribute differences between repository

versions.

NOTE: The data provided in these reports is still accessible using the Screens menu. For more
information about using the Screens menu, see Using Siebel Tools.

■ The following reports have been relocated to the application administration views in the Siebel
clients instead of Siebel Tools:

■ Tables. Provides selected properties and lists the columns for each table.

For more information about the Tables report, see Siebel Data Model Reference.

■ EIM Interface Tables. Provides various properties for each EIM interface table.

For more information about the EIM Interface Tables report, see Siebel Enterprise Integration
Manager Administration Guide.

■ The location for the follow documentation has changed:

■ Siebel System Requirements and Supported Platforms on Oracle Technology Network (OTN).
■ Siebel Business Applications Third-Party Bookshelf is available on Oracle E-Delivery.

■ Other Siebel CRM documentation (Release Notes, Maintenance Release Guides, Alerts,
Technical Notes, Troubleshooting Steps, FAQs, Error Messages) is located on My Oracle
Support.

Siebel Reports Guide Version 8.1, Rev. C 17

What’s New in This Release ■

18 Siebel Reports Guide Version 8.1, Rev. C

2 Overview of Siebel Reports

This chapter provides a brief introduction to Siebel Reports and the reporting tools used to create
reports. It includes the following topics:

■ About Siebel Reports on page 19

■ About Using Siebel Reports on page 20

■ Siebel Reports Output File Types on page 20

■ Who Can Use Siebel Reports? on page 21

■ About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports on
page 21

About Siebel Reports

Oracle’s Siebel Business Applications ship with preconfigured reports and layout templates. You can
choose to use these reports, modify these reports, or create your own custom reports. For a
comprehensive list of the preconfigured reports that ship with Siebel Business Applications, see
876284.1 (Doc ID) on My Oracle Support.

You work with Siebel Reports in the following locations:

■ In the Siebel application to generate, schedule, and view reports. The views are also used for
Siebel application administrative tasks.

For more information about generating reports, see Chapter 6, “Generating Reports.” For
information about scheduling reports, see Chapter 8, “Scheduling Reports.”

■ In Microsoft Word by using Oracle Business Intelligence Publisher Add-in for Microsoft Word to
create and customize layout templates.

For more information about using Oracle Business Intelligence Publisher Add-in for Microsoft
Word, see “About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel
Reports” on page 21.

■ In Oracle BI Publisher to manage report scheduling, report users, and other Oracle BI Publisher
administration tasks.

Information about these administrative tasks is documented throughout this guide.

Siebel Reports Guide Version 8.1, Rev. C 19

Overview of Siebel Reports ■ About Using Siebel Reports

About Using Siebel Reports

In the Siebel clients (Siebel Web Client, Siebel Mobile Web Client, and Siebel Developer Web Client)
you use views to generate reports. While in a view, you typically perform a query, and then select
the report that you want to generate from the application-level Reports menu. From the Reports
menu, you can choose to either generate a report immediately or schedule a report to generate at
a later time. You can monitor your long-running and scheduled reports, view previously generated
reports, or delete reports from the Reports and the Scheduled Jobs views.

TIP: The reports that are available to you while in a Siebel view are based on standard Siebel
position-based visibility.

For more information about using Siebel reports from a user perspective, see Chapter 6, “Generating
Reports.” For more information scheduling reports from a user perspective, see Chapter 8,
“Scheduling Reports.” For information about positions and visibility, see Siebel Security Guide.

NOTE: The new report features (report scheduling, parameterized reports, and the new security
protocol) are available only in connected mode.

Siebel Reports Output File Types

Siebel Reports supports the following output file types:

■ PDF (Portable Document Format)

■ HTML (Hypertext Markup Language)

■ RTF (Rich Text Format)

■ XLS (Microsoft Excel format)

■ PPT (Microsoft PowerPoint format)

■ MHTML (MIME HTML)

NOTE: The PPT and MHTML report output file types are available only in connected mode. For more
information about the connection modes in relation to Siebel Reports, see “About the Siebel Reports
Architecture” on page 25.

The report output file types that are available to you for a specific report are determined by the
report developer when registering a report in the Siebel application. For more information about
registering reports, see “Registering Report Layout Templates” on page 108.

20 Siebel Reports Guide Version 8.1, Rev. C

 Overview of Siebel Reports ■ Who Can Use Siebel Reports?

Who Can Use Siebel Reports?

This topic describes the users and the tasks they are allowed to perform.

Siebel Reports users include the following:

■ Report user. Users can generate, view, monitor, and schedule reports that they are granted
access to in a Siebel application. Users can also delete reports that they have personally
generated. Additionally, users who have Microsoft Word and Oracle Business Intelligence
Publisher Add-in for Microsoft Word installed on their computers can also modify existing
templates or create custom layout templates. For more information about Oracle Business
Intelligence Publisher Add-in for Microsoft Word, see “About Using Oracle Business Intelligence
Publisher Add-in for Microsoft Word with Siebel Reports” on page 21. In a sales organization, typical
report users might be sales representatives, sales managers, and sales executives.

NOTE: Report scheduling is available only in connected mode. For more information about the
connection modes in relation to Siebel Reports, see “About the Siebel Reports Architecture” on
page 25.

■ Report developer (or business user). Developers are responsible for determining how best
to extract data from various sources and are granted permission to perform administrative tasks.
These administrative tasks include generating translatable XLIFF (XML Localization Interchange
File Format) files, uploading and registering templates in the Siebel clients, associating reports
with Siebel application views, and so on. In a sales organization, report developers might be
sales managers, business analysts, and so on.

NOTE: A sales manager might be a report user or a report developer depending on the
responsibility assigned. Your business requirements determine which views are made available
to certain users for reports development and administration. Restrictions are implemented using
the standard Siebel access controls. For more information about user management, see “Process
of Authenticating User Access to the Oracle BI Publisher Server” on page 56. For more information
about access control in general, see Siebel Security Guide.

■ Report administrator. The report administrator might perform tasks typically performed by
report developers, but the administrator is also responsible for installation and configuration
tasks, purging reports, and managing the translation of reports from one language to another.

About Using Oracle Business

Intelligence Publisher Add-in for
Microsoft Word with Siebel Reports
Oracle Business Intelligence Publisher Add-in for Microsoft Word (also known as Oracle BI Publisher
Desktop) is an authoring tool that allows you to use native formatting features of Microsoft Word to
design layout templates for reports. The application includes documentation, demos, and samples.

NOTE: Siebel Reports allows you to use a subset of the functionality and features the Oracle BI
Publisher Desktop provides. Only the features documented in this guide are supported.

Siebel Reports Guide Version 8.1, Rev. C 21

Overview of Siebel Reports ■ About Using Oracle Business Intelligence Publisher Add-in
for Microsoft Word with Siebel Reports

Oracle Business Intelligence Publisher Add-in for Microsoft Word provides separate layout, query, and
language capability in one interface. Because data logic is separate from the layout, and the layout
is not dependent on the needs of a particular language, this feature allows for flexibility in
deployment and reduced maintenance costs.

When you open Microsoft Word after installing Oracle Business Intelligence Publisher Add-in for
Microsoft Word, the Oracle BI Publisher menu toolbar appears, as shown in Figure 1.

Oracle BI Oracle BI
Publisher Toolbar Publisher Menu

Figure 1. Example of Oracle BI Publisher Menu and Toolbar in Microsoft Word

For information about installing Oracle Business Intelligence Publisher Add-in for Microsoft Word, see
“Installing Oracle BI Publisher for Siebel Business Applications” on page 40.

NOTE: It is recommended that you not use Oracle BI Publisher Desktop version 10.1.3.4.1 with
Oracle BI Publisher version 10.1.3.4.0.

Advantages of Using Oracle Business Intelligence Publisher Add-in for

Microsoft Word as a Report Authoring Tool
Advantages of using Oracle Business Intelligence Publisher Add-in for Microsoft Word for creating
layout templates and customizing reports include:

■ Users can build the layout and rules for reports themselves or reuse their existing company
documents. Even if your users do not have the skills to create their own layout templates, they
can begin creating the template in Microsoft Word. Then the report developer can use that same
document to finalize the template and report.

■ Deployment is more efficient, because users can build the report that they want without having
to depend on an engineer to interpret their requirements.

■ Testing cycles are reduced because users can implement changes to the report rather than tying
up valuable development resources.

■ Report developers can concentrate on extracting only data.

■ Report developers can extract data from diverse sources.

■ Both report developers and report administrators can build and maintain reports.

■ Interoperability with other standards-based reporting engines, such as Oracle’s enterprise

reporting tool that is used in Oracle E-Business Suite, PeopleSoft, JD Edwards, BI EE (Business
Intelligence Suite, Enterprise Edition Plus), and so on.

22 Siebel Reports Guide Version 8.1, Rev. C

 Overview of Siebel Reports ■ About Using Oracle Business Intelligence Publisher Add-in
for Microsoft Word with Siebel Reports

Oracle Business Intelligence Publisher Add-in for Microsoft Word

Features
Some of the Oracle Business Intelligence Publisher Add-in for Microsoft Word features that are
especially helpful in Siebel Reports template creation and customization include:

■ Template Builder. Facilitates the development of RTF (Rich Text Format) layout templates for
reports.

Using Template Builder, users create how they want their report to look, and then a report
developer can use this same document to determine how to extract data from the database in
the most efficient manner. Because both report users and report developers use the same report
authoring tool, there is much less chance for misinterpretation of the requirements.

■ Template Viewer. Allows you to preview report layouts with sample data in multiple output
formats at any stage of development. Template Viewer is a feature of Template Builder.

■ Excel Analyzer. Oracle BI Publisher Analyzer for Excel facilitates the development of Excel
templates that export data to an Excel spreadsheet. It allows you to:

■ Export the results of a report query to an Excel spreadsheet

■ Log in to Oracle Business Intelligence Publisher Add-in for Microsoft Word from Excel to
refresh your data, apply new parameters, and apply a template to the report data

■ Create templates in Excel, upload them to the Oracle BI Publisher repository, and then access
and generate reports from an Excel session

NOTE: The Analyzer for Excel feature is available only in connected mode. For more information
about the connection modes in relation to Siebel Reports, see “About the Siebel Reports
Architecture” on page 25.

For more information about using Oracle Business Intelligence Publisher Add-in for Microsoft Word,
see Oracle Business Intelligence Publisher Report Designer's Guide available on Oracle Technology
Network (OTN).

NOTE: Not all features mentioned in the Oracle Business Intelligence Publisher documentation are
currently integrated in the Siebel Reports solution; only the features documented in this guide.

Siebel Reports Guide Version 8.1, Rev. C 23

Overview of Siebel Reports ■ About Using Oracle Business Intelligence Publisher Add-in
for Microsoft Word with Siebel Reports

24 Siebel Reports Guide Version 8.1, Rev. C

3 Siebel Reports Development
Environment

This chapter describes the Siebel Reports development environment and how Siebel Reports
interacts with Oracle Business Intelligence Publisher (Oracle BI Publisher) to generate reports in
Siebel Business Applications. It includes the following topics:

■ About the Siebel Reports Architecture on page 25

■ Workflow for Generating Reports in Connected Mode on page 26

■ Workflow for Generating Reports in Disconnected Mode on page 27

■ Siebel Reports Directory Structure on page 29

■ Siebel Reports File Types on page 29

■ About the Oracle BI Publisher Server in Siebel Business Applications on page 30

■ How Siebel Business Applications and Oracle BI Publisher Interact on page 31

About the Siebel Reports Architecture

For Siebel CRM version 8.1 and later, Siebel Reports supports two architectures: one for connected
mode, and one for disconnected mode. From the perspective of the end user when requesting reports
in the various Siebel clients, there is no apparent difference. However, executing report requests
using the Siebel clients differs depending on the connection mode:

■ Disconnected mode. Requesting reports in disconnected mode runs Oracle Business

Intelligence Publisher (Oracle BI Publisher) through the XMLP Report Business Service using the
embedded Oracle BI Publisher libraries. For more information about the architecture for
disconnected mode, see “Workflow for Generating Reports in Disconnected Mode” on page 27.

■ Connected mode. Requesting reports in connected mode to a server or through the Siebel Web
Client integrates directly with the Siebel XMLP Report Server component and the Oracle BI
Publisher Server. For more information about the architecture for connected mode, the XMLP
Report Server component, and the Oracle BI Publisher Server, see “Workflow for Generating
Reports in Connected Mode” on page 26.

TIP: For some Siebel Business Applications, the Siebel Web Client is not required. It is possible
to generate Oracle BI Publisher reports with the embedded Oracle BI Publisher libraries, such as
is the case with Siebel Loyalty. Another instance of when a Siebel Web Client is not required is
when report generation is requested using a workflow by way of the business services in the
XMLP Report Server Component. These two instances, however, are not documented in this
guide. The instances are mentioned so that you know there are other reporting capabilities
available for Siebel Reports.

Siebel Reports Guide Version 8.1, Rev. C 25

Siebel Reports Development Environment ■ Workflow for Generating Reports in
Connected Mode

Workflow for Generating Reports in

Connected Mode
The Siebel Web Client and other connected clients allow you to generate reports in connected mode.
When you select a report from the Reports menu in a Siebel application view, the XMLP Report Server
component processes the request and extracts the relevant data from the Siebel Database. The XMLP
Report Server component converts the data to XML, then issues an outbound Web service call to a
standalone Oracle BI Publisher Server. The Oracle BI Publisher Server accepts the XML data file,
generates the layout template, and merges the layout template with the XML data. The Oracle BI
Publisher Server then sends the report output file back to the XMLP Report Server component using
an outbound Web service call. The report is stored in the Siebel File System and then displayed in
the Siebel application.

CAUTION: Do not modify the XMLP Report Server component parameters. Any modification can
adversely affect the operation of your Siebel Reports implementation.

Figure 2 illustrates both the architecture and workflow for generating reports in connected mode.

NOTE: Oracle BI Publisher was recently renamed; previously Oracle BI Publisher was called XML
Publisher or XMLP. For this reason, some software elements retain the XMLP naming convention.

Figure 2. Siebel Reports Architecture and Workflow for Generating Reports in Connected Mode

The following text provides a high-level description of Figure 2:

1 A report generation event is triggered from a Siebel application view.

2 The Siebel Application Object Manager (AOM) routes the event to the Siebel Database.

26 Siebel Reports Guide Version 8.1, Rev. C

 Siebel Reports Development Environment ■ Workflow for Generating Reports in
Disconnected Mode

3 The Server Request Broker (SRBroker) and the Server Request Processor (SRProc) monitor the
request and pass it to the XMLP Report Server component through the XMLP Driver Service.

4 The XMLP Driver Service makes a call to the XMLP Data Service.

5 The XMLP Data Service fetches data from the Siebel Database through the EAI Siebel Adapter,
and then returns the control back to the XMLP Data Service.

6 The XMLP Data Service passes control back to the XMLP Driver Service.

7 The XMLP Driver Service makes a call to the XMLP Adapter Service.

8 The XMLP Adapter Service makes a call to the proxy PublicReportService business service.

9 The proxy PublicReportService business service makes a Web service call to the Oracle BI
Publisher Server.

10 The Oracle BI Publisher Server executes report generation and returns the generated report
binary data by way of a Web service call back to the proxy PublicReportService business service.

11 The proxy PublicReportService business service returns control to the XMLP Adapter Service.
12 The XMLP Adapter Service then downloads the report, and creates the file in the Siebel File
System, which is displayed in the Siebel application.

Workflow for Generating Reports in

Disconnected Mode
The mobile clients (Siebel Mobile Web Client and Siebel Developer Web Client) allow you to generate
reports interactively in disconnected mode.

In disconnected mode, the Oracle BI Publisher Server is a logical component that uses the Oracle BI
Publisher XDO Engine to manage generating reports. The XMLP Report Business Service is the
interface to this logical component that instantiates the EAI Java Business Service to load the JAR
files to the JVM (Java Virtual Machine). The Oracle BI Publisher XDO Engine then processes the XML
data, XSL template, and XLIFF files to generate the report. For more information about the EAI Java
Business Service and JVM, see Transports and Interfaces: Siebel Enterprise Application Integration.

The XMLP Report Business Service and the Oracle BI Publisher core libraries (XDO JAR files) are
available as part of a Siebel mobile client installation. These core libraries are located in the
SIEBEL_CLIENT_ROOT\CLASSES directory. For information about client installation, see Siebel
Installation Guide for the operating system you are using.

Siebel Reports Guide Version 8.1, Rev. C 27

Siebel Reports Development Environment ■ Workflow for Generating Reports in
Disconnected Mode

Figure 3 illustrates both the architecture and workflow for generating reports in disconnected mode.

NOTE: Oracle BI Publisher was previously known as XML Publisher or XMLP. For this reason, some
software elements retain the XMLP naming convention.

Figure 3. Siebel Reports Architecture and Workflow for Generating Reports in Disconnected Mode

Figure 3 illustrates the following:

1 A report generation event is triggered from a view in the Siebel application.

2 Data is retrieved from the Siebel Database using the EAI Siebel Adapter and stored as XML in
the XMLP\DATA folder in the Siebel client installation (SIEBEL_CLIENT_ROOT\CLASSES) directory.

3 A call is routed to the XMLP Report Java Business Service.

4 The XMLP Report Business Service instantiates the EAI Java Business Service, and loads the JAR
files to the JVM (Java Virtual Machine).

5 The Oracle BI Publisher XDO Engine loads the XDO classes from the JAR files, and then the XML,
XLIFF, and XSL template are given as input to the XDO classes for generating the report. The
report is temporarily stored in XMLP\REPORTS, and then sent to the Siebel File System.

6 The control then goes back to the Siebel user interface where the generated report appears.

28 Siebel Reports Guide Version 8.1, Rev. C

 Siebel Reports Development Environment ■ Siebel Reports Directory Structure

Siebel Reports Directory Structure

Siebel Reports files reside in the Siebel Server installation XMLP directory (SIEBSRVR_ROOT\XMLP).

Table 5 provides descriptions of these directories.

Table 5. Siebel Reports XMLP Directory Structure

XMLP Path Description

\DATA Contains the generated XML files from the integration object definition.

\FONTS Contains the prepackaged .ttf (TrueType format) font files.

NOTE: The administrator must copy the font files from the C:\WINDOWS\Fonts
directory to the $JRE_HOME\fonts directory to make sure that reports are
displayed and print properly. For more information about copying font files, see
“Copying Fonts for Report Generation” on page 49.

\REPORTS Contains the temporary files for generating reports.

\TEMPLATES Contains the RTF (Rich Text Format) layout templates. Users can download these
report files to a local drive.

This directory also contains the XSL files necessary for disconnected mode. For
information about how these files are used for generating reports, see “How
Siebel Business Applications and Oracle BI Publisher Interact” on page 31.

\xliff\<lang> Contains the XLIFF files for localization. XLIFF is the XML format for exchanging
localization data. If multiple languages are supported, a separate xliff
subdirectory is provided for each language and is identified by its language code.
For example, XLIFF files for German reside in xliff\deu and XLIFF files for
French reside in xliff\fra.

NOTE: Siebel Language Packs are installed as part of the Siebel installation
process. For more information about installing languages, see Siebel Installation
Guide for the operating system you are using.

Siebel Reports File Types

Siebel Reports uses or generates files of the following types:

■ XML (Extensible Markup Language). XML is a metalanguage that is a simplified version of

SGML (Standard Generalized Markup Language) used for describing markup languages. A
markup language is a mechanism to identify structures in a document. XML allows you to define
a standard way to add markup to documents and provides a facility to define tags and the
structural relationships between them.

■ XSL (Extensible Stylesheet Language). A language for expressing style sheets. An XSL style
sheet is a file that describes how to display an XML document of a given type. Used in
disconnected mode only. For more information about the connection modes for Siebel Reports,
see “About the Siebel Reports Architecture” on page 25.

Siebel Reports Guide Version 8.1, Rev. C 29

Siebel Reports Development Environment ■ About the Oracle BI Publisher Server in
Siebel Business Applications

■ XLIFF (XML Localization Interchange File Format). A format to store extracted text and
carry the data from one step to another in the localization process.

Siebel Reports uses the following languages for generating reports:

■ XSL-FO (Extensible Stylesheet Language-Formatting Objects). An XML vocabulary for

specifying formatting semantics.

■ XSLT (Extensible Stylesheet Language Transformation). A language for transforming XML

documents.

■ XPath (XML Path Language). An expression language used by XSLT to access or refer to parts
of an XML document.

Siebel Reports also supports various report output file types. For more information about these
report output types, see “Siebel Reports Output File Types” on page 20.

About the Oracle BI Publisher Server in

Siebel Business Applications
This topic provides a high-level overview of the how the Oracle BI Publisher Server interacts with
Siebel Business Applications to generate and schedule reports in connected mode. For more
information about generating reports in connected mode, see “Workflow for Generating Reports in
Connected Mode” on page 26.

About the Oracle BI Publisher Server

The Oracle BI Publisher Server is installed as part of the Oracle Business Intelligence Publisher
(Oracle BI Publisher) installation. For information about installing Oracle BI Publisher, see “Installing
Oracle BI Publisher for Siebel Business Applications” on page 40.

The Oracle BI Publisher Server uses a push-pull mechanism to transfer XML data between the Siebel
application and the Oracle BI Publisher Server. During report generation, which is triggered from the
Siebel application, data is pushed from the Siebel Database to the Oracle BI Publisher Server to
generate reports. When handling a report request, the Oracle BI Publisher Server merges the data
with the report layout template from the Oracle BI Publisher repository, and then sends the report
to the Siebel application.

The following subtopics describe the Oracle BI Publisher Server functionality in greater detail.

About the PublicReportService Web Service

The PublicReportService Web service is a Web service that is exposed by Oracle BI Publisher. This
service is the mechanism that Siebel Reports uses in connected mode to upload and pass reports to
the Siebel application.

The PublicReportService Web service supports the following operations:

■ Validates privileges

■ Gets information about reports and the Oracle BI Publisher repository

30 Siebel Reports Guide Version 8.1, Rev. C

 Siebel Reports Development Environment ■ How Siebel Business Applications and
Oracle BI Publisher Interact

■ Generates reports

■ Creates and manages reports

■ Gets information about the Oracle BI Publisher Server

About the Oracle BI Publisher Repository

The Oracle BI Publisher repository resides on the Oracle BI Publisher Server. The Oracle BI Publisher
repository is a collection of reports that is installed as part of the Oracle BI Publisher Server
installation. The repository stores the preconfigured reports that ship with Siebel Business
Applications and new reports you create.

In the SharedFolder directory in the Oracle BI Publisher repository, the SIEBELCRMREPORTS directory
stores all reports. Each report stored in the SIEBELCRMREPORTS directory has its own folder. The
layout template (RTF) and XLIFF files necessary for generating that report are in that folder.

You upload the layout template files (RTF and XLIFF) to the Oracle BI Publisher Server by registering
the template in the Siebel application. The Oracle BI Publisher Server then requests report
generation using a Web service to generate the report. For more information about uploading layout
templates to the Oracle BI Publisher repository and registering layout templates, see “Workflow for
Uploading Report Layout Templates to a Siebel Application” on page 99.

How Siebel Business Applications and

Oracle BI Publisher Interact
Siebel Business Applications integrate with Oracle Business Intelligence Publisher (Oracle BI
Publisher) for report execution. However, depending on your connection mode, layout templates are
merged with XML data differently to render reports in the Siebel user interface.

Siebel Reports Guide Version 8.1, Rev. C 31

Siebel Reports Development Environment ■ How Siebel Business Applications and
Oracle BI Publisher Interact

Figure 4 compares report execution in connected mode with disconnected mode.

Figure 4. Comparison of Report Execution in Connected and Disconnected Mode

Figure 4 illustrates the following:

1 A report generation request is initiated from a Siebel application view, and then routed to one of
the following to generate the report:

■ Oracle BI Publisher XDO Engine in disconnected mode

■ Oracle BI Publisher Server in connected mode

2 The RTF Processor converts the RTF layout templates to XSL for input to the BI Publisher-FO
Processor.

3 The BI Publisher-FO Processor merges the XSL and the XML data files to produce the following
output formats:

■ XML and XSL formats are converted to HTML.

■ XML, XSL-FO, are XLIFF formats are converted to: PDF, HTML, RTF, EXCEL, PPT, and MHTML.

NOTE: The PPT and MHTML output file types are available only in connected mode.

32 Siebel Reports Guide Version 8.1, Rev. C

 Siebel Reports Development Environment ■ How Siebel Business Applications and
Oracle BI Publisher Interact

Template Builder, a feature of Oracle Business Intelligence Publisher Add-in for Microsoft Word, is
used to modify and customize layout templates. Template Builder uses form fields to encapsulate
XSL instructions for parsing XML data. Form fields are a feature of Microsoft Word and are the
building blocks for layout templates in Oracle Business Intelligence Publisher Add-in for Microsoft
Word. You use form fields in template design wherever data is required. Template Builder generates
these form fields using the Siebel application and the information specified in the layout template.

Report Execution in Disconnected Mode

The XMLP Report Business Service provides XML files to the Oracle BI Publisher XDO Engine to merge
the layout templates with XML data. One of the required inputs for the XDO Engine is an XML file.
XML files are generated by way of the EAI Siebel Adapter, using the EAI Java Business Service for
connecting a Siebel application to the XDO Engine. The EAI Java Business Service is the JVM (Java
Virtual Machine) interface between the XDO Engine and the Siebel application. The XML data file is
merged with the layout template, then Oracle BI Publisher exposes the completed report document
to the user in the Siebel application after storing the file in the Siebel File System.

Oracle BI Publisher provides the XML file to the engine using the EAI Java Business Service. The XML
contains the data that populates the resulting document. The data comes from the results of the
internal queries run against various data sources.

Oracle BI Publisher uses XSLT and XPath to extract data from the XML data and incorporates that
data into an RTF-formatted layout template during run time. XSL comprises three standards (XSLT,
XPath, and XSL- FO) for manipulating XML data. The XMLP Report Server component uses the XDO
Engine to convert the RTF templates into XSL format, and then using the BI Publisher-FO Processor,
converts the files to the published report formats.

Report Execution in Connected Mode

Oracle BI Publisher uses XSLT and XPath to extract data from the XML data and incorporates that
data into an RTF-formatted layout template during run time. The XMLP Adapter Service invokes the
PublicReportService Web service to generate reports. The PublicReportService Web service is the
interface between the Siebel application and the Oracle BI Publisher Server.

Siebel Reports Guide Version 8.1, Rev. C 33

Siebel Reports Development Environment ■ How Siebel Business Applications and
Oracle BI Publisher Interact

34 Siebel Reports Guide Version 8.1, Rev. C

4 Integrating Oracle BI Publisher
with Siebel Business
Applications

This chapter provides instructions for administrators to integrate Oracle Business Intelligence
Publisher (Oracle BI Publisher) with Siebel Business Applications. It includes the following topics:

■ About Integrating Oracle BI Publisher with Siebel Business Applications on page 35

■ Preparing for Integration of Oracle BI Publisher with Siebel Business Applications on page 37

■ Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications on page 39

■ Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel Business
Applications on page 40

■ Process of Configuring the Siebel Application for Integration with Oracle BI Publisher on page 46

■ Process of Authenticating User Access to the Oracle BI Publisher Server on page 56

■ “Configuring Siebel Reports in a Web Single Sign-On Environment” on page 59

■ Process of Enabling and Configuring Report Scheduling on page 60

■ Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server on page 63

■ “Uploading New or Modified Report Layout Templates for Multiple Siebel Server Environments” on
page 64

■ Testing Your Siebel Reports Integration Configurations on page 65

NOTE: The instructions in this chapter might not be applicable to versions of Siebel Reports earlier
than version 8.1.1.3. For integration instructions for previous Siebel Reports versions, see “Where to
Find Integration Instructions for Previous Versions of Siebel Reports” on page 37.

About Integrating Oracle BI Publisher

with Siebel Business Applications
Siebel Business Applications integrate with Oracle Business Intelligence Publisher (Oracle BI
Publisher) for report execution. As of Siebel CRM version 8.1.1.1, report scheduling and
parameterization is supported. However, before you can use these features, you must perform
several installation and configuration tasks. The tasks you perform are contingent on whether you
are deploying Siebel Reports for the first time or you are already using Siebel Reports. This topic
describes what you must do for each of these two scenarios.

CAUTION: The integration instructions in this chapter are not applicable to versions of Siebel
Reports before 8.1.1.1. For integration instructions for previous Siebel Reports versions, see “Where
to Find Integration Instructions for Previous Versions of Siebel Reports” on page 37.

Deploying Siebel Reports for the First Time

If you are deploying Siebel Reports for the first time, you must do the following:

Siebel Reports Guide Version 8.1, Rev. C 35

Integrating Oracle BI Publisher with Siebel Business Applications ■ About Integrating
Oracle BI Publisher with Siebel Business Applications

■ Install Siebel CRM version 8.1.1.

■ Upgrade to Siebel CRM 8.1.1.x.

■ Import an archive file for the new report features.

■ Install Oracle Business Intelligence Publisher version 10.1.3.4.1.

■ Install Oracle Business Intelligence Publisher Add-in for Microsoft Word (also known as Oracle BI
Publisher Desktop) version 10.1.3.4.1.

■ Perform postinstallation configuration tasks for both the Siebel application and Oracle BI
Publisher.

For detailed information about deploying Siebel Reports for the first time, see “Roadmap for
Integrating Oracle BI Publisher with Siebel Business Applications” on page 39.

Upgrading Siebel Reports to Siebel CRM Version 8.1.1.x

If you are currently using Siebel Reports in a Siebel CRM 8.1.1 environment and you want to use the
new report scheduling and parameterization features introduced in Siebel CRM version 8.1.1.x, you
must do the following:

■ Upgrade to Siebel CRM 8.1.1.x.

■ Import an archive file for the new report features.

■ Upgrade to Oracle Business Intelligence Publisher version 10.1.3.4.1.

■ Upgrade to Oracle Business Intelligence Publisher Add-in for Microsoft Word (also known as
Oracle BI Publisher Desktop) version 10.1.3.4.1.

■ Perform postinstallation configuration tasks for both the Siebel application and Oracle BI
Publisher.

For instructions on how to upgrade to Siebel CRM 8.1.1.x, see Siebel Maintenance Release Guide on
My Oracle Support. For instructions for the other tasks listed above, see the applicable topics in this
guide.

NOTE: It is recommended that you upgrade to Siebel CRM 8.1.1.x. You can, however, continue to
use an existing Siebel CRM 8.1.1 environment, but you will not be able to use the new report
scheduling and parameterization features.

For more information about Oracle BI Publisher integration with Siebel Business Applications, see
“About the Oracle BI Publisher Server in Siebel Business Applications” on page 30 and “How Siebel
Business Applications and Oracle BI Publisher Interact” on page 31.

36 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Preparing for
Integration of Oracle BI Publisher with Siebel Business Applications

Where to Find Integration Instructions for Previous

Versions of Siebel Reports
Integration instructions for previous versions of Siebel Reports are different from those provided in
this guide.

For integration instructions on the following:

■ Siebel CRM versions 8.1.1.1 and 8.1.1.2. See 1110636.1 (Doc ID) on my Oracle Support. This
document was previously published as Siebel Reports Guide version 8.1 on Siebel Bookshelf.

■ Siebel CRM version 8.1.1. See 1076966.1 (Doc ID) on My Oracle Support. This document was
previously published as Siebel Reports Guide version 8.1 on Siebel Bookshelf.

■ Siebel CRM version 8.0, 7.8, and 7.7. See the appropriate Siebel Maintenance Release Guide
on My Oracle Support.

Preparing for Integration of Oracle BI

Publisher with Siebel Business
Applications
For Siebel CRM version 8.1.1.x, the reporting module for Siebel Reports is Oracle Business
Intelligence Publisher (Oracle BI Publisher). To deploy Siebel Reports, you must install and configure
both Siebel Business Applications and Oracle BI Publisher. This topic provides the necessary
preparation tasks for a new deployment.

To prepare for integration of Oracle BI Publisher with Siebel Business Applications:

1 Review Siebel System Requirements and Supported Platforms on Oracle Technology Network.
Also check for applicable alerts, bulletins, or other documents on My Oracle Support.

2 Install Java Development Kit (JDK) version 1.5 or later and point the JAVA_HOME system
environment variable to the JDK, if you have not already performed this task.

3 Make sure that you have an existing installation of Siebel CRM version 8.1.1.x or later. If not,
upgrade Siebel CRM using the latest Siebel CRM 8.1.1.x Fix Pack as described in Siebel
Maintenance Release Guide on My Oracle Support.

Some of the requirements for Siebel Reports include:

■ Siebel Server (or servers)

■ Siebel Server components enabled:

❏ Siebel Application Object Manager (AOM), for example, Call Center Object Manager
(ENU)

❏ Siebel Enterprise Integration (EAI)

❏ XMLP Report Server component

Siebel Reports Guide Version 8.1, Rev. C 37

Integrating Oracle BI Publisher with Siebel Business Applications ■ Preparing for
Integration of Oracle BI Publisher with Siebel Business Applications

■ A Siebel client using one of the following:

❏ A Siebel Web Client (or other connected client) for connected mode

NOTE: For connected mode, a Siebel Web Client is not necessarily a requirement for some
Siebel Business Applications. Siebel Reports supports environments that have either: 1) a
Siebel Server (or servers), the Oracle BI Publisher Server, and a Siebel Web Client, or 2) a
Siebel Server (or servers), and the Oracle BI Publisher Server. For more information about
connected mode, see “About the Siebel Reports Architecture” on page 25.

❏ A Siebel mobile client (Mobile Web Client or Developer Web Client) for disconnected mode

NOTE: The Siebel mobile clients do not require that the Siebel XMLP Report Server, AOM, or
EAI server components be enabled.

■ Siebel Tools to create new or edit existing integration objects

If you need to modify an integration object in the Siebel Repository or you require an
integration object that is not available in the Siebel Repository, you must have Siebel Tools
installed. For more information about:

❏ Installing Siebel Tools, see Siebel Installation Guide for the operating system you are
using.

❏ Using Siebel Tools, see Using Siebel Tools.

❏ Extending an integration object to add new report fields, see “Extending Integration
Objects to Add New Fields for Siebel Reports” on page 102.

❏ Creating a new integration object for Siebel Reports, see “Creating New Integration
Objects for Siebel Reports” on page 103.

■ (Optional) Application Deployment Manager (ADM)

You might want to use ADM to migrate reports from one Siebel environment to another (for
example, migrating reports from the development to the production environment). For more
information about ADM, see Siebel Application Deployment Manager Guide.

4 Make sure that you have an existing installation of Oracle BI Publisher version 10.1.3.4.1.

The required Oracle BI Publisher software includes:

■ Oracle Business Intelligence Publisher version 10.1.3.4.1

OC4J (Oracle Application Server Containers for Java Platform, Enterprise Edition) is installed as
part of this installation. For more information about OC4J, see Oracle Business Intelligence
Publisher Installation Guide, Release 10.1.3 available on Oracle Technology Network (OTN).

The Oracle BI Publisher Server is also installed as part of this installation. During report
generation, which is triggered from the Siebel application, data is pushed from the Siebel
Database to the Oracle BI Publisher Server to generate reports. When handling a report
request, the Oracle BI Publisher Server merges the data with the report layout template from
the Oracle BI Publisher repository, and then sends the report to the Siebel application.

38 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Roadmap for
Integrating Oracle BI Publisher with Siebel Business Applications

■ Oracle BI Publisher Add-In for Microsoft Word (also known as Oracle BI Publisher Desktop)
version 10.1.3.4.1

Oracle BI Publisher Desktop is a report authoring tool, which allows you to author and
preview layout templates using Microsoft Word.

For information about installing Oracle BI Publisher as a first-time installation, see “Installing
Oracle BI Publisher for Siebel Business Applications” on page 40. For information about upgrading
from an existing version 10.1.3.4.0 installation, see “Upgrading to Oracle BI Publisher Version
10.1.3.4.1 from Version 10.1.3.4.0” on page 42.

Roadmap for Integrating Oracle BI

Publisher with Siebel Business
Applications
This topic provides a roadmap for integrating Oracle Business Intelligence Publisher (Oracle BI
Publisher) with Siebel Business Applications. To work with reports, you must install and configure
both the Siebel application and Oracle BI Publisher. An administrator performs these integration
tasks, often in coordination with a Siebel Tools developer.

To integrate Oracle BI Publisher with Siebel Business Applications, perform the following processes
and tasks:

1 Verify that you have installed Siebel CRM version 8.1.1 and all fix packs.

For installation information for Siebel CRM version 8.1.1, see Siebel Installation Guide for the
operating system you are using. For information on installing fix packs, see Siebel Maintenance
Release Guide on My Oracle Support.

2 “Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel Business
Applications” on page 40

3 “Process of Configuring the Siebel Application for Integration with Oracle BI Publisher” on page 46

4 “Process of Authenticating User Access to the Oracle BI Publisher Server” on page 56

5 “Configuring Siebel Reports in a Web Single Sign-On Environment” on page 59

6 “Process of Enabling and Configuring Report Scheduling” on page 60

7 “Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server” on page 63

8 “Uploading New or Modified Report Layout Templates for Multiple Siebel Server Environments” on
page 64

For more information about integration of Oracle BI Publisher with Siebel Business Applications, see
“About Integrating Oracle BI Publisher with Siebel Business Applications” on page 35.

Siebel Reports Guide Version 8.1, Rev. C 39

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Installing and Configuring Oracle BI Publisher for Integration with Siebel Business

Process of Installing and Configuring

Oracle BI Publisher for Integration with
Siebel Business Applications
This topic provides instructions for installing and configuring Oracle Business Intelligence Publisher
(Oracle BI Publisher) for integration with Siebel Business Applications.

This process is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 39.

To install and configure Oracle BI Publisher for integration with Siebel Business Applications, perform
the following tasks:

1 Perform one of the following:

■ For a first-time installation, see “Installing Oracle BI Publisher for Siebel Business Applications”
on page 40.

■ If you are upgrading to Oracle BI Publisher version 10.1.3.4.1 from version 10.1.3.4.0, see
“Upgrading to Oracle BI Publisher Version 10.1.3.4.1 from Version 10.1.3.4.0” on page 42.

2 “Copying JAR Files to the Oracle BI Publisher Server” on page 43

3 “Enabling External File References for the Oracle BI Publisher Server” on page 44

4 (Optional) “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on
page 45

For more information about working with Oracle BI Publisher in Siebel Business Applications, see
“About the Oracle BI Publisher Server in Siebel Business Applications” on page 30 and “How Siebel
Business Applications and Oracle BI Publisher Interact” on page 31.

Installing Oracle BI Publisher for Siebel Business

Applications
This topic describes how to install Oracle Business Intelligence Publisher (Oracle BI Publisher) as a
first-time installation for integration with Siebel Business Applications.

NOTE: The instructions in this topic are not applicable if you already have an existing Oracle BI
Publisher installation. To upgrade to Oracle BI Publisher version 10.1.3.4.1 from version 10.1.3.4.0,
see “Upgrading to Oracle BI Publisher Version 10.1.3.4.1 from Version 10.1.3.4.0” on page 42.

This task is one step in “Process of Installing and Configuring Oracle BI Publisher for Integration with
Siebel Business Applications” on page 40.

TIP: You can install the Oracle BI Publisher software anytime before or after the Siebel Server
installation.

40 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Installing and Configuring Oracle BI Publisher for Integration with Siebel Business

To install Oracle BI Publisher for Siebel Business Applications

1 Log in to Oracle E-Delivery available at:

http://edelivery.oracle.com

2 Choose a language, or click Continue to download with English (US) as the default language.

3 Enter the export validation information, accept the license terms and export restrictions, and
then click Continue.

4 Select Oracle Business Intelligence as the product pack, and an operating system (for example,
Microsoft Windows [32-bit]). Then click Go.

NOTE: You must select an operating system compatible with the computer on which the Oracle
BI Publisher Server is installed. For information about which platforms are supported for Siebel
Reports, see Siebel System Requirements and Supported Platforms on Oracle Technology
Network.

5 Select the Oracle Business Intelligence 10.1.3 Media Pack for your operating system, and then
click Continue.

For example, you might select Oracle Business Intelligence (10.1.3) Media Pack for Microsoft
Windows (32-bit).

6 Download the Oracle BI Publisher 10.1.3.4.1 installers. For example, if you chose Oracle Business
Intelligence (10.1.3) Media Pack for Microsoft Windows (32-bit) in Step 5, you download the
following:

■ Oracle Business Intelligence Publisher Enterprise 10.1.3.4.1 for Microsoft Windows.

■ Oracle Business Intelligence Publisher Desktop 10.1.3.4.1 for Microsoft Windows.

NOTE: Typically administrators download and install Oracle Business Intelligence Desktop
(also known as Oracle Business Intelligence Publisher Add-in for Microsoft Word) during the
Oracle BI Publisher Enterprise installation, however, you can install it any time.

7 Install Oracle BI Publisher by doing the following:

a Decompress the installer into a directory of your choice.

If you chose Oracle Business Intelligence (10.1.3) Media Pack for Microsoft Windows (32-bit)
in Step 4, you decompress the V16384-01.zip file.

CAUTION: You must extract the .zip file to a directory whose name does not contain spaces.
If the directory name contains spaces, the installation fails.

b Follow the instructions about installing Oracle BI Publisher on Oracle Application Server for OC4J
10.1.3.1 in Oracle Business Intelligence Publisher Installation Guide, Release 10.1.3 available on
Oracle Technology Network (OTN).

NOTE: OC4J is installed and the Oracle BI Publisher Server starts automatically as part of
this installation.

Siebel Reports Guide Version 8.1, Rev. C 41

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Installing and Configuring Oracle BI Publisher for Integration with Siebel Business

8 Install Oracle Business Intelligence Publisher Add-in for Microsoft Word (also known as Oracle BI
Publisher Desktop) by doing the following:

a Decompress the appropriate .zip file according to the Media Pack you chose in Step 4.

For example, if you chose Oracle Business Intelligence (10.1.3) Media Pack for Microsoft
Windows (32-bit) in Step 5, you decompress the V16380-01.zip file.

CAUTION: You must extract the .zip file to a directory whose name does not contain spaces.
If the directory name contains spaces, the installation fails.

b Run the installer.

9 Make sure that applicable users install Oracle BI Publisher Desktop on a computer where
Microsoft Word for Windows is installed.

Upgrading to Oracle BI Publisher Version 10.1.3.4.1

from Version 10.1.3.4.0
If you are currently working with Oracle Business Intelligence Publisher (Oracle BI Publisher) version
10.1.3.4.0 and you want to use the new report features (scheduling and parameterization), you must
upgrade to Oracle BI Publisher version 10.1.3.4.1 and Oracle BI Publisher Add-In for Microsoft Word
(also known as Oracle BI Publisher Desktop) version 10.1.3.4.1.

This task is a step in “Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel
Business Applications” on page 40.

NOTE: The instructions in this topic are not applicable if you are installing Oracle BI Publisher for the
first time. To install Oracle BI Publisher as a first-time installation, see “Installing Oracle BI Publisher
for Siebel Business Applications” on page 40.

You upgrade the Oracle BI Publisher Server by deploying a new Enterprise Archive (EAR) file. An EAR
file represents a Java EE application that is deployed in an application server. EAR files are standard
Java Archive (JAR) files. A JAR file aggregates many files into one, for example, JAR files are used
to distribute Java classes and associated metadata. A Web Application Archive (WAR) file is a file
used to distribute a collection of JavaServer Pages (JSP), servlets, Java classes, XML files, tag
libraries, and static Web pages (HTML and related files) that together constitute a Web application.
Java EE bundles applications into EAR files for distribution. The EAR files contain JAR files and WAR
files but might also contain:

■ One or more Web modules

■ One or more Enterprise JavaBeans (EJB) modules

■ One or more application client modules

■ Additional JAR files required by the application

■ Any combination of the above

To upgrade to Oracle BI Publisher version 10.1.3.4.1 from version 10.1.3.4.0

1 Upgrade Oracle BI Publisher by doing the following:

42 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Installing and Configuring Oracle BI Publisher for Integration with Siebel Business

a Follow the instructions as described in the Oracle Business Intelligence Publisher Installation
Guide (Release 10.1.3.4.1) Web site at

http://download.oracle.com/docs/cd/E12844_01/doc/bip.1013/e12690/T434820T524414.htm

NOTE: The steps are the same for upgrading to version 10.1.3.4.1 from version 10.1.3.4.0
with the exception that you do not need to test the login page or install the fonts.

b Follow the instructions in the Oracle Business Intelligence Publisher Release Notes (Release
10.1.3.4.1) Web site at

http://download.oracle.com/docs/cd/E12844_01/doc/bip.1013/e12691/toc.htm#T539006

2 Upgrade to Oracle BI Publisher Desktop version 10.1.3.4.1 by following the instructions at

http://download.oracle.com/docs/cd/E12844_01/doc/bip.1013/e12690/
T434820T487784.htm#4729768

The instructions contain information for uninstalling current installations.

NOTE: It is recommended that you do not use Oracle BI Publisher Desktop version 10.1.3.4.0
with Oracle BI Publisher version 10.1.3.4.1.

3 Make sure that your users upgrade to Oracle BI Publisher Desktop version 10.1.3.4.1.

For information about using Oracle BI Publisher Desktop with Siebel Reports, see “About Using
Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports” on page 21.

Copying JAR Files to the Oracle BI Publisher Server

This topic describes how to add custom Siebel Java archive (JAR) files to the Oracle Business
Intelligence Publisher (Oracle BI Publisher) Server. To successfully generate reports, you must copy
the custom Siebel Java classes associated with individual reports to the corresponding directory on
the Oracle BI Publisher Server. By default, these Java functions are not available on the Oracle BI
Publisher Server.

This task is a step in “Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel
Business Applications” on page 40.

To copy JAR files to the Oracle BI Publisher Server

1 Copy the following files from the SIEBSRVR_ROOT\CLASSES directory to the ORACLE_HOME/oc4j_bi/
j2ee/home/applications/xmlpserver/xmlpserver/WEB-INF/lib directory where
ORACLE_HOME is an Oracle application server:

■ XSLFunctions.JAR

■ SiebelCustomXMLP.JAR
■ SiebelCustomXMLP_SIA.JAR

Siebel Reports Guide Version 8.1, Rev. C 43

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Installing and Configuring Oracle BI Publisher for Integration with Siebel Business

■ Siebel.JAR

■ SiebelXMLP.JAR

NOTE: Typically, ORACLE_APPSRVR_HOME is located in the C:\OraHome_X\oc4j_bi directory for an

Oracle BI Publisher installation.

2 If there are additional custom Java extensions, you must copy those JAR files as well.

Enabling External File References for the Oracle BI

Publisher Server
This topic describes how to enable external file references on the Oracle BI Publisher Server.

This task is a step in “Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel
Business Applications” on page 40.

To enable external file references on the Oracle BI Publisher Server

1 Start Oracle Application Server Containers for Java Platform, Enterprise Edition (OC4J) by doing
the following:

a Click Start, Programs, Oracle - BIPHomeX (where X is a system-assigned number when you
install Oracle BI Publisher), and then Start BI Publisher.

A command window appears.

NOTE: You must leave this command window open while the Oracle BI Publisher Server is
running.

b Confirm the Oracle BI Publisher Server is started.

When the server is started an Oracle Containers are initialized statement appears in the
command window.

2 Log in to the Oracle BI Publisher Server with administrator privileges by doing the following:

a Click Start, Programs, Oracle - BIPHomeX, and then BI Publisher Server.

b Enter your administrator credentials (such as Administrator for the login and Administrator for
the password).

NOTE: Administrator credentials for the Oracle BI Publisher Server are established during
installation and are case sensitive.

3 Click the Admin tab, and then select Properties under Runtime Configuration.

4 Change the default value for the Disable External Reference attribute to FALSE, and then click
Apply.

5 Restart the Oracle BI Publisher Server to make the changes take effect by doing the following:

a Click Start, Programs, and then Oracle - BIPHomeX.

b Choose Stop BI Publisher.

44 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Installing and Configuring Oracle BI Publisher for Integration with Siebel Business

c Choose Start BI Publisher.

Changing the Location of the Oracle BI Publisher

Repository for Siebel Reports
This topic describes how to change the location of the Oracle BI Publisher repository for use with
Siebel Reports.

By default, the location of the Oracle BI Publisher repository is stored in the Oracle home JVM
property with a value of ${oracle.home}/xdo/repository. The Siebel application uses this JVM
property to access the Oracle BI Publisher repository. If Oracle BI Publisher is running on an Oracle
Application server or an Oracle Application Server Containers for Java Platform, Enterprise Edition
(OC4J) standalone, this oracle.home property value is automatically set by the OC4J container. For
more information about OC4J, see Oracle Business Intelligence Publisher Installation Guide, Release
10.1.3 available on Oracle Technology Network (OTN).

This task is an optional step in “Process of Installing and Configuring Oracle BI Publisher for Integration
with Siebel Business Applications” on page 40.

If you do not want to use ${oracle.home}/xdo/repository as the location of your Oracle BI

Publisher repository, there are three different ways you can change it:

■ Create a custom XML file

■ Replace a JVM property name

■ Change the absolute path to the repository

Changing the Location of the Oracle BI Publisher Repository by

Creating a Custom XML File
Use the following procedure to change the location of the Oracle BI Publisher Repository by creating
a custom XML file.

To create a custom XML file to change the location of the Oracle BI Publisher
repository
1 Copy the xmlp-server-config.xml file and paste it to a folder where Oracle BI Publisher can read
it.

For example, in an Oracle AS/OC4J 10.1.3 deployment, you copy the configuration file from:

OC4J_HOME/j2ee/home/applications/xmlpserver/xmlpserver/WEB-INF/xmlp-server-
config.xml

2 Edit the newly created .xml file to reflect the new path.

The default configuration for the xmlp-server-config.xml file is:

<?xml version="1.0" encoding="UTF-8"?>

<xmlpConfig xmlns="http://xmlns.oracle.com/oxp/xmlp">

Siebel Reports Guide Version 8.1, Rev. C 45

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

<resource>

<file path="${oracle.home}/xdo/repository"/>

</resource>

</xmlpConfig>

3 Start the application server by adding the following JVM option:

-Dxdo.server.config.dir=/home/BIP

Changing the Location of the Oracle BI Publisher Repository by

Replacing a JVM Property Name
Use the following procedure to change the location of the Oracle BI Publisher Repository by replacing
a JVM property name.

To change the location of the Oracle BI Publisher repository by replacing a JVM

property name
■ In the WEB-INF/xmlp-server-config.xml file, replace oracle.home with some other JVM property
name.

NOTE: You must set the value of the new JVM property to the correct repository path.

Changing the Location of the Oracle BI Publisher Repository by

Changing the Absolute Path to the Repository
Use the following procedure to change the location of the Oracle BI Publisher Repository by changing
the absolute path to the repository.

To change the location of the Oracle BI Publisher repository by changing the

absolute path to the repository
■ In the WEB-INF/xmlp-server-config.xml file, change the absolute path to the repository that you
want.

Process of Configuring the Siebel

Application for Integration with Oracle
BI Publisher
This topic provides instructions for configuring your Siebel application for integration with Oracle
Business Intelligence Publisher (Oracle BI Publisher).

This process is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 39.

46 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

To configure the Siebel application for integration with Oracle BI Publisher, perform the following
tasks:

1 Make sure that you have an existing installation of Siebel CRM version 8.1.1.x.

2 Using Siebel Tools, import an archive file to apply the new report scheduling and
parameterization features.

For instructions, see “Importing an Archive File to Apply the New Siebel Reports Features” on
page 48.

3 Make sure that the following components are enabled on the Siebel Server:

■ Enterprise Application Integration (EAI)

■ The applicable Siebel AOM (Application Object Manager), for example, SCCObjMgr_enu for
Siebel Call Center

■ Make sure that the XMLP Report Server Component on the Siebel Server is enabled.

NOTE: The XMLP Report Server component might already be enabled depending on how you
configured your original Siebel Server installation.

CAUTION: Do not change the XMLP Report Server component parameters. Any modification
can adversely affect performance and operation.

For information about enabling component on the Siebel Server, see Siebel System
Administration Guide.

4 Make sure that the Siebel Server is running and the Siebel Mobile Web Client and Siebel Tools
can connect to the server data source.

5 “Copying Fonts for Report Generation” on page 49

6 “Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server” on page 50

7 “Configuring the Outbound Web Service for the Oracle BI Publisher Server” on page 52
8 Create four report responsibilities in the Siebel application that correlate with roles in the Oracle
BI Publisher Server.

For instructions for these tasks, see “Creating Report Responsibilities in the Siebel Application” on
page 54.

9 Enable logging for Siebel Reports.

For information about enabling logging for Siebel Reports, see “Enabling Logging for the XMLP
Report Server Component” on page 141.

Siebel Reports Guide Version 8.1, Rev. C 47

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

Importing an Archive File to Apply the New Siebel

Reports Features
This topic describes how to import the Siebel 8.1.1.x Fix Pack archive file to update the Siebel
repository.

This task is a step in “Process of Configuring the Siebel Application for Integration with Oracle BI
Publisher” on page 46 on page 30.

To import an archive file to apply the new Siebel Reports features

1 Make sure that you have an existing installation Siebel CRM version 8.1.1.x environment.

For more information about this environment, see “Preparing for Integration of Oracle BI Publisher
with Siebel Business Applications” on page 37.

2 Change the SymStrPrefix parameter by doing the following:

a Navigate to the SIEBEL_TOOLS_ROOT\BIN\ENU directory, and then open the tools.cfg file in
a text editor.

b Change the value of the SymStrPrefix parameter in the [Siebel] section to SBL_, and then
save the tools.cfg file.

NOTE: You must change this parameter back to its original value of X_ at a later time. For
more information about the SymStrPrefix parameter, see the topic on symbolic strings in
Using Siebel Tools.

3 Log in to Siebel Tools, and then lock the following projects:

■ XMLP Integration Project

■ Table XML

■ Symbolic Strings
■ Reports UI

■ User Preferences

NOTE: If the Table XMLP project is inactive, activate this project by unchecking the Inactive
checkbox

4 Import the archive file that applies the new features by doing the following:

a From the application-level menu, select Tools, and then the Import from Archive menu item.

b In the file browser dialog window, choose BIP_8113.sif from the

D:\SIEBEL_TOOLS_ROOT\REPPATCH directory (where Siebel Tools is installed).
c Follow the import wizard prompts to import the SIF file.

d Compile the repository file.

5 Apply the schema changes by doing the following:

a In the Object Explorer, select the Table object.

b Query for all changed tables, making sure the following tables appear in the Tables list:

48 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

❏ S_REPOUTPT_PSTN

❏ S_REP_TMPL_PSTN

❏ S_XMLP_REPOUTPT

❏ S_XMLP_REP_TMPL

❏ S_XMLP_RPT_VIEW

c Click Apply/DDL, click Apply again, and then click OK.

d In the Apply Schema dialog box, do the following:

❏ Select Current Query from the Tables drop-down list.

❏ Enter the appropriate values for Database user, Database user password, and ODBC data
source, and then click Apply.

Copying Fonts for Report Generation

Fonts used in reports are obtained from the computer on which the report is generated. If a report
is generated from a computer where the fonts in the report are not available, the output might not
be as expected when trying to generate, view, preview, or schedule reports. This topic describes how
to resolve this unexpected behavior.

NOTE: It is the responsibility of the report designer to make sure that fonts are selected that match
the data that is likely to be included in a report. For more information about fonts in Siebel Business
Applications, see Siebel Global Deployment Guide.

This task is a step in “Process of Configuring the Siebel Application for Integration with Oracle BI
Publisher” on page 46.

To copy fonts
■ On the Siebel Server where the XMLP Report Server component is enabled, do one of the
following:

■ For Windows, copy the fonts in C:\WINDOWS\Fonts directory to the fonts directory in the Java
installation directory for your deployment (typically this is JAVA_HOME\lib\fonts).

■ For UNIX, copy the fonts in the /Fonts directory to the fonts directory in the Java installation
directory for your deployment.

NOTE: This task is typically performed as part of the Siebel application installation. However,
administrators can perform this task at any time.

Siebel Reports Guide Version 8.1, Rev. C 49

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

Adding an Explicit Reference to JAR Files for the Oracle

BI Publisher Server
To enable report scheduling, you must add an explicit reference to the Siebel JAR files for the Oracle
BI Publisher Server. This is because when a report is scheduled, a new .xdo file is sent to the Oracle
BI Publisher Server that contains the schedule job information.

This task is a step in “Process of Configuring the Siebel Application for Integration with Oracle BI
Publisher” on page 46.

To add an explicit reference to JAR files for the Oracle BI Publisher Server
1 Navigate to the Administration - Server Configuration screen, Enterprises, and then the Profile
Configuration view.

50 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

2 Select the XMLPJvmSubsys profile.

3 In the Profile Parameters subview, provide the appropriate values. Some of the values are
provided in the following table. Make sure that the paths correctly locate the required files.

Parameter Value

JVM For UNIX:

Classpath
${SIEBEL_HOME}/classes/SiebelXMLP.jar:${SIEBEL_HOME}/classes/
xdoparser.jar:${SIEBEL_HOME}/classes/fix6312772.jar:${SIEBEL_HOME}/classes/
xdocore.jar:${SIEBEL_HOME}/classes/xmlparserv2-904.jar:${SIEBEL_HOME}/classes/
versioninfo.jar:${SIEBEL_HOME}/classes/share.jar:${SIEBEL_HOME}/classes/
jewt4.jar:${SIEBEL_HOME}/classes/jdbc12.jar:${SIEBEL_HOME}/classes/
i18nAPI_v3.jar:${SIEBEL_HOME}/classes/collections.jar:${SIEBEL_HOME}/classes/
bipres.jar:${SIEBEL_HOME}/classes/bicmn.jar:${SIEBEL_HOME}/classes/
siebel.jar:${SIEBEL_HOME}/classes/XSLFunctions.jar:${SIEBEL_HOME}/classes/
SiebelCustomXMLP.jar:${SIEBEL_HOME}/classes/SiebelCustomXMLP_SIA.jar

where:

${SIEBEL_HOME} is the actual path where the Siebel application is

installed.

For Windows:
<SIEBSRVR_ROOT>/classes/SiebelXMLP.jar;<SIEBSRVR_ROOT>/classes/
xdoparser.jar;<SIEBSRVR_ROOT>/classes/fix6312772.jar;<SIEBSRVR_ROOT>/classes/
xdocore.jar;<SIEBSRVR_ROOT>/classes/xmlparserv2-904.jar;<SIEBSRVR_ROOT>/classes/
versioninfo.jar;<SIEBSRVR_ROOT>/classes/share.jar;<SIEBSRVR_ROOT>/classes/
jewt4.jar;<SIEBSRVR_ROOT>/classes/jdbc12.jar;<SIEBSRVR_ROOT>/classes/
i18nAPI_v3.jar;<SIEBSRVR_ROOT>/classes/collections.jar;<SIEBSRVR_ROOT>/classes/
bipres.jar;<SIEBSRVR_ROOT>/classes/bicmn.jar;<SIEBSRVR_ROOT>/classes/
siebel.jar;<SIEBSRVR_ROOT>/classes/XSLFunctions.jar;<SIEBSRVR_ROOT>/classes/
SiebelCustomXMLP.jar;<SIEBSRVR_ROOT>/classes/SiebelCustomXMLP_SIA.jar

where:

SIEBSRVR_ROOT is the actual path where the Siebel Server is installed.

CAUTION: An error might occur if the value of the CLASSPATH parameter is too
long (must be less than 1024 characters). To avoid this, copy the CLASSPATH
folder to the root directory, and then point CLASSPATH to this path.
Alternatively, you can set the CLASSPATH using the Siebel Server Manager
(srvrmgr program). For information about using the srvrmgr program to set the
CLASSPATH, see “Troubleshooting the CLASSPATH Settings Using Siebel Server
Manager” on page 153.

JVM DLL For AIX, Linux, and Oracle Solaris:

Name <path to libjvm.so_file>

For HP-UX:
<path to libjvm.sl_file>

NOTE: For Windows, the path to the JVM DLL file is automatically read from the
Windows registry setting of the JRE installed on the Siebel Server.

Siebel Reports Guide Version 8.1, Rev. C 51

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

For more information on setting the values of the JVM DLL Name and JVM Options parameters,
see Transports and Interfaces: Siebel Enterprise Application Integration.

4 For UNIX, the following steps are required:

a Set the JVM DLL Name as:

/usr/jdk1.5.0_06/jre/bin/j9vm/libjvm.so

b Set the JAVA_HOME environment variable as:

/usr/java

c Set the LIBPATH ${LIBPATH} environment variable as:

/usr/jdk1.5.0_06/jre/bin:/usr/jdk1.5.0_06/jre/bin/j9vm

Configuring the Outbound Web Service for the Oracle BI

Publisher Server
The PublicReportService outbound Web service is the mechanism that uploads reports from the
Oracle Business Intelligence Publisher (Oracle BI Publisher) Server and passes the reports to the
Siebel application in connected mode. For this functionality to work, you must set a WSDL (Web
Service Definition Language) definition for the Siebel outbound Web service to the actual address of
the Oracle BI Publisher Server. As of Siebel CRM version 8.1.1.1, you must first make changes to
some of the object definitions in the base 8.1.1 repository using Siebel Tools and generate an
updated PublicReportService Web service from the Siebel application before you can set the WSDL.

This task is a step in “Process of Configuring the Siebel Application for Integration with Oracle BI
Publisher” on page 46.

To configure the outbound Web service for the Oracle BI Publisher Server
1 Generate a new WSDL file by doing the following:

a Start up the Oracle BI Publisher Server.

b Using your browser, enter the following URL to retrieve the Web service definition.

http://<host>:<port>/xmlpserver/services/PublicReportService_v11?wsdl

where:

❏ host is the full path for your Oracle BI Publisher Server

❏ port is the port that the Oracle BI Publisher Server uses

c Save the definition as PublicReportService_v11.WSDL.

2 Using Siebel Tools, delete the PublicReportService outbound Web service and related integrated
objects by doing the following:

a Log in to Siebel Tools.

b Query for the PublicReportService business service, and then remove this object.

52 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

c Select Integration Object, query for the XMLP Integration project, and then remove all selected
objects.
3 Create the updated PublicReportService by doing the following:

a In Siebel Tools, choose File, New Objects, the EAI tab, Web Service, and then click OK.

b Select the XMLP Integration project.

c Browse to import the PublicReportService_v11.WSDL document file (the file you created in
Step 1 on page 52), and then click Next.

d Check the Deploy Integration Object(s) and Proxy Business Service(s) checkbox, and then click
Finish.
4 Check your results by doing the following:

a In Siebel Tools, select the Business Service object type.

b Perform a query with the following criteria:

❏ Project is XMLP Integration

❏ Name is PublicReportService

c Verify that the user properties are as follows:

❏ siebel_port_name is PublicReportService_v11

❏ siebel_web_service_name is PublicReportServiceService

❏ siebel_web_service_namespace is
http://xmlns.oracle.com/oxp/service/v11/PublicReportService

5 In the Object Explorer, select Integration Object, query for the XMLP Integration project, and
then verify that 128 objects are returned.

6 Compile the XMLP Integration project.

For information about compiling SRFs, see Using Siebel Tools.

7 Change the Address field on the Service Port so that it reflects the name of the computer hosting
the Oracle BI Publisher Server by doing the following:

a Log in to the Siebel application as a Siebel administrator.

b Navigate to the Administration - Web Services screen, then the Outbound Web Services view.

c In the Name field, query for PublicReportServiceService.

d Inactivate the original Web service that was replaced with the v11 version.

e Make sure that the service port address corresponds to the Oracle BI Publisher Server.

The format is:

http://<host.domain>:<port>/xmlpserver/services/PublicReportService_v11

where:

❏ host.domain is the full path for the Oracle BI Publisher Server

Siebel Reports Guide Version 8.1, Rev. C 53

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

❏ port is the port that the Oracle BI Publisher Server uses

For example, the address might be:

http://BIPhost:9704/xmlpserver/services/PublicReportService_v11

NOTE: Typically, there is no need to change this address because it is automatically

populated when you configure the business service and Web service in Siebel Tools using the
Web service wizard.

8 Click Clear Cache to make sure that the changes are propagated to run-time memory.

Creating Report Responsibilities in the Siebel

Application
Siebel Business Applications allows different users to have different report access rights to the Oracle
BI Publisher Server. User rights to reports are accomplished by creating and assigning responsibilities
in the Siebel application and by using roles and permissions on the Oracle BI Publisher Server.

This topic describes how to create four new report responsibilities in the Siebel application and how
to create and associate a new Siebel view to one of these responsibilities for use with report
scheduling.

This task is a step in “Process of Configuring the Siebel Application for Integration with Oracle BI
Publisher” on page 46.

To create new report responsibilities in the Siebel application

1 Register new report views by doing the following:

a Navigate to the Administration - Application screen, then the Views view.

b In the Views list, create the following new views, and complete the necessary fields:

❏ Report Job List View

❏ All Report Output List View
❏ All Template View

❏ Manager's Report Output List View

❏ Manager's Template View

❏ My Template View

❏ Report Standard Template Registration Admin View

NOTE: The names of these views should match the view names in Siebel Tools. These views are
packaged in the BIP_8113.sif file that you imported in “Importing an Archive File to Apply the New
Siebel Reports Features” on page 48.

2 Create four new responsibilities by doing the following:

a Navigate to the Administration - Application screen, then the Responsibilities view.

54 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Configuring the Siebel Application for Integration with Oracle BI Publisher

b Create the following new responsibilities, making sure to add appropriate users to each:

Responsibility Description

XMLP_ADMIN Administrator role for the Oracle BI Publisher Server with no

access limitations.

XMLP_DEVELOPER Assign this responsibility to allow for uploading reports from the
Oracle BI Publisher Server to the Siebel application.

XMLP_SCHEDULER Assign this responsibility to allow for scheduling of reports.

XMLP_SIEBEL_GUEST Assign this responsibility to limit access to reports. This

responsibility only allows for generation, viewing, and deletion of
user’s own reports.

NOTE: The reporting responsibilities in the Siebel application correspond to roles and
permissions on the Oracle BI Publisher Server. The names of these responsibilities must
exactly match the corresponding set of roles on the Oracle BI Publisher Server. For
information about how the Siebel application recognizes these roles and permissions, see
“Configuring Security and Authentication Using the Siebel Security Model” on page 57.

c Associate the new views you created in Step 1 with the appropriate responsibility as shown in
the following table.

View Responsibility

Report Job List View XMLP_SCHEDULER

All Report Output List View XMLP_ADMIN

All Template View XMLP_ADMIN

Manager's Report Output List View XMLP_ADMIN

Manager's Template View XMLP_ADMIN

My Template View XMLP_ADMIN

Report Standard Template Registration Admin View XMLP_ADMIN

d Log out of the Siebel application, then log back in to have the new responsibilities take effect.

3 Verify your configurations by doing the following:

a From the Reports menu, select My BI Publisher Reports.

b Confirm a new Scheduled Reports link was added to the My BI Publisher Reports screen.

The Scheduled Reports link in the Siebel application is an embedded user interface to the
Oracle BI Publisher Server that allows users to view their scheduled reports. Before you can
use this link, you must perform further configuration to embed the Scheduled Reports view
in the Siebel application.

Siebel Reports Guide Version 8.1, Rev. C 55

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Authenticating User Access to the Oracle BI Publisher Server

c Confirm the other new views you created in Step 1 were added to the appropriate screens as
shown in the following table.

View Screen

All Report Output List View Reports Server

All Template View Report Administration

Manager's Report Output List View Reports_Custom Templates

Manager's Template View Report Administration

My Template View Report Administration

Report Standard Template Registration Admin View Reports_Standard Templates

d Authenticate user access to the Oracle BI Publisher Server, and enable and configure report
scheduling.

For more information on authenticating user access, see “Process of Authenticating User
Access to the Oracle BI Publisher Server” on page 56.

Process of Authenticating User Access to

the Oracle BI Publisher Server
This topic describes the security models for authenticating access for Siebel Business Applications
users to the Oracle BI Publisher Server.

When the Oracle Business Intelligence Publisher (Oracle BI Publisher) Server receives a request from
a Siebel user to perform report functionality on the server, the Oracle BI Publisher Server queries
the Siebel application to retrieve the user privileges associated with that particular user from the
Siebel application. This retrieval is accomplished by invoking a Web service that is exposed by the
Siebel application. You must configure this Web service so that it Oracle BI Publisher Server can call
the Web service.

This task is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 39.

The following security models are available for authenticating user access to the Oracle BI Publisher
Server in a Siebel Reports connected environment:

■ Siebel Security

NOTE: It is recommended that you use the Siebel Security model if you plan to implement report
scheduling and parameterization. This security model was created for use with this functionality.

■ LDAP

For more information about the Siebel Reports environments, see Chapter 3, “Siebel Reports
Development Environment.”

To authenticate user access to the Oracle BI Publisher Server, perform one of the following tasks:

56 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Authenticating User Access to the Oracle BI Publisher Server

■ “Configuring Security and Authentication Using the Siebel Security Model” on page 57

■ “Configuring Security and Authentication Using the LDAP Security Model” on page 59

Configuring Security and Authentication Using the

Siebel Security Model
The Siebel Security model retrieves authentication information through the Siebel EAI Object
Manager (EAIObjMgr) and authenticates logins for report users against the Siebel Database one time
only, then a session token is provided for the Oracle BI Publisher Server authentication. Because
every user executing reports has their own credentials and roles, users have private visibility on the
Oracle BI Publisher Server when scheduling reports.

This topic describes how to implement the Siebel Security model to manage user access to the Oracle
BI Publisher Server in a Siebel Reports connected environment.

This task is a step in “Process of Authenticating User Access to the Oracle BI Publisher Server” on
page 56.

To configure security and authentication using the Siebel Security Model

1 Import and administer the Web service used by the Siebel Security Model by doing the following:

a Navigate to the Administration - Web Services screen, then the Inbound Web Services view.

b Import the BIPSiebelSecurityWS.XML file from the SIEBEL_TOOLS_ROOT\REPPATCH directory

(where Siebel Tools is installed).

c In the Address field of the Service Ports subview, replace the existing address with the URL used
to access the EAI Object Manager.

For example, you might replace the existing address with:

http:/myserver.mycompany.com/eai_enu/
start.swe?SWEExtSource=WebService&SWEExtCmd=Execute

NOTE: You will copy this address into the Oracle BI Publisher Server in Step 3 of this
procedure.

d Clear the cache.

2 Create a local Superuser for the Oracle BI Publisher Server by doing the following:

a Launch Oracle BI Publisher (for example, http://BIPServerHostName:9704/xmlpserver), and

then log in to the Oracle BI Publisher Server with administrator credentials.

NOTE: The URL for launching Oracle BI Publisher resides in the BI_Publisher_readme.txt file
located in the Oracle BI Publisher installation folder. Administrator credentials are case
sensitive.

b Click the Admin tab, and then select Security Configuration (in the Security Center section).

Siebel Reports Guide Version 8.1, Rev. C 57

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Authenticating User Access to the Oracle BI Publisher Server

c Check the Enable Local Superuser checkbox, enter a Superuser name and password of your
choice, and then click Apply.

NOTE: It is recommended that you create a local Superuser because it allows an administrator
to log in directly to the Oracle BI Publisher Server when the Siebel Server is not running.

3 Enable the Siebel Security model on the Oracle BI Publisher Server by doing the following:

a In the Security Model section, choose Siebel Security Model from the Security Model dropdown
list.

b Copy the address of the BIPSiebelSecurityWS Web service (that you entered in the Siebel
application in Step 1) and paste it into the Siebel Web Service Endpoint field.

NOTE: The address of the Web Service Endpoint parameter in the Oracle BI Publisher Server
is the same address as the inbound Web service used by the Siebel Server.

c Enter the Siebel administrator credentials, and then click Apply.

The following table provides sample parameter values for a Siebel Security model
configuration.

Parameter Value

Security Model Siebel Security

Siebel Web Service http:/myserver.mycompany.com/eai_enu/

Endpoint start.swe?SWEExtSource=WebService&SWEExtCmd=Execute

Administrator Username SADMIN

Administrator Password administrator password

NOTE: Siebel administrator credentials are necessary for the Oracle BI Publisher application
to log into the Siebel EAI object manager. These credentials are case sensitive and must
match the Siebel database specifications.

4 Verify that Siebel Security has been implemented by doing the following:

a Restart the Oracle BI Publisher Server.

b Start the Oracle BI Publisher Enterprise application (from the Start Menu, choose BI Publisher
Server).
c Log in to the Oracle BI Publisher Enterprise application using the Siebel administrator credentials
you entered in Step 3.

The Siebel Security model was successfully implemented if you are able to login using the
Siebel credentials.

5 Launch Oracle BI Publisher again using the same URL, username, and password in Step a.

6 Click the Admin tab, select Roles and Permissions (in the Security Center section), and then add
the SiebelCRMReports folder to the following roles:

■ XMLP_ADMIN

■ XMLP_SCHEDULER

58 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Configuring
Siebel Reports in a Web Single Sign-On Environment

■ XMLP_DEVELOPER

■ XMLP_SIEBEL_GUEST

7 Log out of the Oracle BI Publisher Server.

Configuring Security and Authentication Using the LDAP

Security Model
This topic describes how to implement LDAP security adapter authentication to manage user access
to the Oracle BI Publisher Server in a Siebel Reports connected environment.

This task is a step in “Process of Authenticating User Access to the Oracle BI Publisher Server” on
page 56.

To implement LDAP authentication for Siebel user access to the Oracle BI Publisher Server, you
implement LDAP authentication for your Siebel application, and you must use the same LDAP
directory for the Oracle BI Publisher Server.

In an implementation using LDAP authentication, an LDAP security adapter provided with Siebel
Business Applications authenticates users against an LDAP-compliant directory. The directory stores
information that is required to allow users to connect to the database and the Oracle BI Publisher
Server and this information is retrieved by the security adapter when users try to run a report. When
users log into a Siebel application that uses LDAP authentication, they are already authenticated for
the current session.

NOTE: Using the LDAP security adapter to connect to a Microsoft Active Directory Server (ADS)
directory has not been certified for use with Oracle BI Publisher.

To implement LDAP authentication for the Oracle BI Publisher Server

■ For detailed instructions, see 974509.1 (Doc ID) on My Oracle Support.

For more information on implementing LDAP for Oracle BI Publisher, refer to the Oracle BI Publisher
documentation. For more information on setting up an LDAP directory, see the topic on setting up
the LDAP or ADS Directory in Siebel Security Guide.

Configuring Siebel Reports in a Web

Single Sign-On Environment
This topic provides instructions for configuring Siebel Reports for a Web Single Sign-On (SSO)
environment.

To configure Siebel Reports in a Web SSO environment

■ Follow the instructions in 1117126.1 (Doc ID) on My Oracle Support.

Siebel Reports Guide Version 8.1, Rev. C 59

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Enabling and Configuring Report Scheduling

Process of Enabling and Configuring

Report Scheduling
Before you can use report scheduling, you must perform several configuration tasks. For information
about how to schedule reports, see “Scheduling Reports” on page 116.

This process is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 39.

To enable and configure report scheduling, perform the following:

1 Make sure have performed the tasks as described in the following processes:

a “Process of Installing and Configuring Oracle BI Publisher for Integration with Siebel Business
Applications” on page 40

b “Process of Configuring the Siebel Application for Integration with Oracle BI Publisher” on
page 46

c “Process of Authenticating User Access to the Oracle BI Publisher Server” on page 56

2 Create the scheduling database on the Oracle BI Publisher Server by following the instructions
in Oracle Business Intelligence Publisher Administrator's and Developer's Guide, Release
10.1.3.4 available on Oracle Technology Network (OTN) to:

■ Set up a new database instance.

■ Create a user with privileges to add tables.

■ Create the database connection.

■ Install the schema.

3 Create the scheduling tables by doing the following:

a Log in to the Oracle BI Publisher Enterprise application with administrator privilege.

b Click the Admin tab, and then select Scheduler Configuration.

c Click Test Connection to make sure that the connection works.

d Click Install Schema.

The tables are automatically created.

4 Create new scheduling List of Values (LOVs).

a Log in to the Siebel application as a Siebel administrator.

b Navigate to the Administration - Data screen, then the LOV Explorer view.

c Add a new XMLP_RPT_SCHEDULE_MODE type.

NOTE: The Replication Level field is automatically populated to All. Keep the default values
for the other fields.

d Navigate to the List of Values view.

60 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Enabling and Configuring Report Scheduling

e Create three new LOV records with the following values:

Type Display Value Translate Order

XMLP_RPT_SCHEDULE_MODE Run Immediately Y 1

XMLP_RPT_SCHEDULE_MODE Run Once Y 2

XMLP_RPT_SCHEDULE_MODE Run Daily/Weekly Y 3

f Click Clear Cache to update run-time memory with the new LOV values.

The display values are now available as choices for the Time field in the Schedule a Report
dialog box. For more information about this field, see “Scheduling Reports” on page 116.

5 Embed the Scheduled Reports view in the Siebel Application.

For instructions, see “Embedding the Oracle BI Publisher Scheduled Reports View in the Siebel
Application” on page 61.

6 Modify the command file that you use to start the Oracle BI Publisher Server to include the
location of the BIPDataService Web service.

For information about modifying this file, see “Configuring the BIPDataService WSDL for the Oracle
BI Publisher Server” on page 62.

Embedding the Oracle BI Publisher Scheduled Reports

View in the Siebel Application
The Scheduled Reports view in the Siebel application is for managing scheduled reports. This view is
an embedded Web page from the Oracle BI Publisher Enterprise application. To configure this view,
you implement a symbolic URL to display external contents in the Siebel user interface by specifying
how to construct the external application and define arguments and values that are passed to the
Siebel client.

This task is a step in “Process of Enabling and Configuring Report Scheduling” on page 60.

For more information about working with symbolic URLs, see Siebel Portal Framework Guide. For
information about how to schedule reports, see Chapter 8, “Scheduling Reports.”

To embed the Scheduled Reports view in the Siebel application

1 Log in to the Siebel application as a Siebel administrator.

2 Create a host reference by doing the following:

a Navigate to the Administration - Integration screen, WI Symbolic URL List, and then the Host
Administration view.
b Create a new host with the following settings:

❏ Name is BIPSeverHostName:Port

Siebel Reports Guide Version 8.1, Rev. C 61

Integrating Oracle BI Publisher with Siebel Business Applications ■ Process of
Enabling and Configuring Report Scheduling

❏ Virtual Name is biphost

3 Create the symbolic URL by doing the following:

a Navigate to the Administration - Integration screen, WI Symbolic URL List, and then the Symbolic
URL Administration view.

b Create a new record with the following settings:

❏ Name is BIPReportJobListPage

❏ URL is http://BIPServerHostName/xmlpserver/servlet/myjob

❏ Host Name is BIPServerHostName:Port

❏ Fixup Name is Default

❏ SSO Disposition is IFrame

where host:port is the Oracle BI Publisher host address you choose from a picklist.

c In the Symbolic URL Arguments subview, add the following arguments to the symbolic URL:

Required Argument
Name Argument Type Argument Value

passwd Yes Field BIPPassword

id Yes Field BIPUser

anyname Yes Command PostRequest

PreloadUrlPerSession Yes Command True

PreloadUrl Yes Command http://BIPServerHostName/

xmlpserver/login.jsp

Configuring the BIPDataService WSDL for the Oracle BI

Publisher Server
The Oracle BI Publisher Server uses a Web service to pull data from the Siebel application when a
report is scheduled and executed. The WSDL (Web Service Definition Language) provides a definition
of this Web service. The Oracle BI Publisher Server must know where this WSDL file is located.

You must edit the command file that points to the WSDL location so that it is read when the Oracle
BI Publisher Server starts. The command file is typically located in the bin directory of the OC4J
application server. Modify the command file to include the path to where the WSDL is stored using
the following syntax:

-Duser.dir=<some path>

This task is a step in “Process of Enabling and Configuring Report Scheduling” on page 60.

62 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Uploading
Preconfigured Report Layout Templates to the Oracle BI Publisher Server

To configure the BIPDataService WSDL for the Oracle BI Publisher Server

1 Import the BIPDataService Web service by doing the following:

a Navigate to the Administration - Web Services screen, then the Inbound Web Services view.

b Import the BIPDataService.xml file.

c Configure the address for the Web service with the host name of the Siebel Server.

d Modify the credentials to correspond to the username, login, and password used for logging in
to the Siebel EAI object manager.
2 Post the BIPDataService WSDL file by doing the following:

a Navigate to the Administration - Web Services screen, then the Inbound Web Services view.

b Select BIPDataService, click Generate WSDL.

c Save the WSDL as dataservice.wsdl in the oc4j_bi\bin directory in the Oracle BI Publisher
home directory.

For example, you might save the file as:

D:\OraHome_1\oc4j_bi\bin\dataservice.wsdl

NOTE: You must name the file dataservice.wsdl (lowercase) to match existing references.

d Modify the oc4j and admin sections of the oc4j.cmd file with the following argument to add a
property that identifies to the Oracle BI Publisher Server the default location of the WSDL file:

-Duser.dir=D:\OraHome_1\oc4j_bi\bin

For example:

"D:\OraHome_1\jdk\bin\java" -XX:MaxPermSize=128m -Xmx512m

-Duser.dir=D:\OraHome_1\oc4j_bi\bin -Duser.language=en -Duser.country=US -jar
"%ADMIN_JAR%" %CMDARGS%

NOTE: The oc4j.cmd file is located in ORACLE_HOME\oc4j_bi\bin directory. The oc4j.cmd

script invokes the Java that starts the Oracle BI Publisher Server.

Uploading Preconfigured Report Layout

Templates to the Oracle BI Publisher
Server
Siebel Business Applications ship with preconfigured report layout templates. To make these report
layout templates accessible to users in connected mode, you must upload them to the Oracle BI
Publisher Server. For a comprehensive list of the preconfigured reports that ship with Siebel Business
Applications, see 876284.1 (Doc ID) on My Oracle Support.

NOTE: The instructions in this topic are not applicable for new reports you create or modify while in
disconnected mode. Such reports require deployment to the Siebel Web Client. For instructions, see
“Deploying Report Layout Templates to the Siebel Web Client from a Disconnected Client” on page 67.

Siebel Reports Guide Version 8.1, Rev. C 63

Integrating Oracle BI Publisher with Siebel Business Applications ■ Uploading New
or Modified Report Layout Templates for Multiple Siebel Server Environments

This task is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 39.

CAUTION: If the report layout templates are not uploaded to the Oracle BI Publisher Server, when
a user attempts to run a report, an error occurs and the report fails. For more information about this
failure, see Error Message SBL-OMS-00203 in “Troubleshooting Error Messages for Siebel Reports” on
page 146.

To upload preconfigured report layout templates to the Oracle BI Publisher Server

1 If you are upgrading from Siebel CRM version 8.1.1 to Siebel CRM version 8.1.1.1 or 8.1.1.2, do
the following:

a Make a copy of your existing reports (both standard and custom) that reside on the Oracle BI
Publisher Server.

b Delete the existing reports from the Oracle BI Publisher Server either through the administration
console or at the operating system level. By default, reports are located in
C:\OraHome_1\xmlp\XMLP\Reports\SiebelCRMReports, where OraHome_1 is the installation
directory of the Oracle BI Publisher Server.
c Proceed to Step 2.

NOTE: This step is not applicable for Siebel CRM version 8.1.1.3.

2 Navigate to the Administration - BI Publisher Reports screen, then the Reports - Standard
Templates view.

3 From the application-level menu, select Edit, and then Select All.

4 Click Upload Files.

5 Verify the report layout templates were successfully uploaded by doing the following:

a Navigate to the Oracle BI Publisher Enterprise application.

b Click the Reports tab, and then click Shared Folders.

c Verify a SiebelCRMReports folder exists and that the uploaded reports appear in this folder.

Uploading New or Modified Report

Layout Templates for Multiple Siebel
Server Environments
This topic describes how to upload new or modified report layout templates in a multiple Siebel
Server environment.

This task is optional in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 39.

64 Siebel Reports Guide Version 8.1, Rev. C

 Integrating Oracle BI Publisher with Siebel Business Applications ■ Testing Your
Siebel Reports Integration Configurations

To upload new or modified report layout templates for a multiple Siebel Server
environment
1 For each of the Siebel Servers, copy the new or modified RTF file to the following directory:

SIEBSRVR_ROOT\TEMP\XMLP

NOTE: Overwrite any existing file.

2 For each of the Siebel Servers, copy the .XLF (XLIFF) file to the appropriate language folder in
the following directory:

SIEBSRVR_ROOT\XMLP\XLIFF

For example, the language folder for English (U.S.) is as follows:

SIEBSRVR_ROOT\XMLP\XLIFF\ENU
3 Log in to the Oracle BI Publisher Server as administrator and manually delete the report layout
template from the SiebelCRMReports folder.

4 Log in to the Siebel Web Client and upload the new or modified report layout template by doing
the following:

a Navigate to the Administration - BI Publisher Reports screen, then the relevant template view
(Reports - Custom Templates or Reports - Standard Templates).
b Click Upload Files.

Testing Your Siebel Reports Integration

Configurations
It is recommended that you test your integration configurations by registering a preconfigured Oracle
BI Publisher report layout template in the Siebel application, then generating a report for that
template.

NOTE: You must complete all configuration tasks as described in “Roadmap for Integrating Oracle BI
Publisher with Siebel Business Applications” on page 39 before performing the following procedure.

To test your configurations

1 Register a preconfigured Oracle BI Publisher report layout template.

a Navigate to the Administration - BI Publisher Reports screen, then the relevant template view
(Reports - Custom Templates or Reports - Standard Templates).
b Select the Account List report layout template, and then click Upload Files.

c Navigate to the View Association view to associate the Account List report to the Account List
view.

The Account List report layout template is now available to the Siebel application for use in
generating reports.

2 Generate an Oracle BI Publisher report (or reports) by doing the following:

Siebel Reports Guide Version 8.1, Rev. C 65

Integrating Oracle BI Publisher with Siebel Business Applications ■ Testing Your
Siebel Reports Integration Configurations

a Navigate to the Accounts screen, then the Accounts List view.

b Perform a query that returns approximately 30 records, and then click Reports.

c In the BI Publisher section, choose Account List.

d Select the report output type, and then click Submit.

The report is generated after you choose to open the report.

e Generate the report in a different format or click Close to close the output type dialog box.

NOTE: To generate a report other than the Account List report, you must first register the report
layout template to the Oracle BI Publisher Server, and then associate the report with the appropriate
view or views in the Siebel application. For more information about generating reports, see
Chapter 6, “Generating Reports.”

66 Siebel Reports Guide Version 8.1, Rev. C

5 Administering Siebel Reports

This chapter describes some of the administrative tasks for Siebel Reports. It includes the following
topics:

■ Deploying Report Layout Templates to the Siebel Web Client from a Disconnected Client on page 67

■ Automatically Purging Reports from the Siebel File System on page 68

■ Purging Scheduled Reports from the Oracle BI Publisher Server on page 69

■ About Working with Multilingual Reports on page 70

■ About Report Translation on page 72

■ Designing Multilingual Reports on page 72

■ Adding and Deleting Languages from Report Templates on page 73

■ Roadmap for Optimizing the Performance of Siebel Reports on page 74

■ Setting the Report Execution Waiting Period for Reports on page 74

■ Setting the Server Request Processor Database Polling Interval for Siebel Reports on page 75

■ Setting Concurrency Parameters for Siebel Reports on page 76

■ Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes on
page 77

The tasks in this chapter are for administrators only and are applicable to both connected and
disconnected modes unless otherwise indicated.

Deploying Report Layout Templates to

the Siebel Web Client from a
Disconnected Client
Siebel reports are typically developed on a disconnected client, such as the Siebel Developer Web
Client. After you test and verify a report layout template, you must move that report to the Siebel
Server to deploy the report to the Siebel Web Client. The report is then available for generation in
connected mode with the Oracle Business Intelligence Publisher (Oracle BI Publisher) Server. This
topic describes how to deploy reports to the Siebel Web Client from a disconnected client.

To deploy a report to the Siebel Web Client from a disconnected client

1 Copy the following report files from the Siebel Developer Web Client (or other disconnected
client) directory to the Siebel Server directory:

■ Report layout template file (.rtf)

Siebel Reports Guide Version 8.1, Rev. C 67

Administering Siebel Reports ■ Automatically Purging Reports from the Siebel File System

■ XLIFF (.xlf) files

NOTE: It is recommended that you locate your report layout template files in the
SIEBSRVR_ROOT\XMLP\Templates directory and the XLIFF files in the
SIEBSRVR_ROOT\XMLP\xliff\language directory.
2 Register the report by doing the following:

a Navigate to the Administration - BI Publisher Reports screen, then one of the following template
views:
❏ Reports - Custom Templates

❏ Reports - Standard Templates

b Create a new record and assign the template and integration object to the record.

c In the XLIFF field, assign the associated .xlf file to the report.

NOTE: The Generate XLIFF button is disabled in the Siebel Web Client and that is why you must
explicitly select the .xlf file.

3 Assign the report to a Siebel view or views.

For information about assigning reports to Siebel views, see “Associating Registered Reports with
Siebel Application Views” on page 113.

4 Upload the report to the Oracle BI Publisher Server by doing the following:

a Navigate back to the applicable template view.

b Click Upload Files.

5 Verify the report was successfully uploaded by doing the following:

a Log in to the Oracle BI Publisher Server with administrator privilege.

b Click the Reports tab, expand Shared Folders, and then click SiebelCRMReports.

c Verify that the new report layout template and associated files were uploaded.

Automatically Purging Reports from the

Siebel File System
Administrators must periodically purge reports from the Siebel File System. You purge reports by
using filters or by running a workflow process. For more information about workflow processes, see
Siebel Business Process Framework: Workflow Guide. This topic describes how to set up reports to
automatically purge after the reports meet certain criteria.

NOTE: Administrators are also responsible for purging reports from the Oracle BI Publisher Server.
For information about this purging, see “Purging Scheduled Reports from the Oracle BI Publisher
Server” on page 69.

68 Siebel Reports Guide Version 8.1, Rev. C

Administering Siebel Reports ■ Purging Scheduled Reports from the Oracle BI Publisher
Server

You can set up Siebel Reports to automatically purge reports from the Siebel Database after a
specified time interval. The BIP Delete After Days system preference allows you to specify a nonzero
positive value that executes the Auto Purge workflow to purge the reports. The reports are purged
form the database after the number of days specified.

CAUTION: It is recommended that only administrators perform this task, because you run the risk
of inadvertently depleting or contaminating the report repository. Report developers and other users
can delete reports, but they must not purge reports. For information about deleting reports, see
“Deleting Reports” on page 90.

To automatically purge reports from the Siebel File System

1 Log in to the Siebel application as a Siebel administrator.

2 Navigate to the Administration - Application screen, then the System Preferences view.

3 In the System Preferences list, select BIP Delete After Days, and change the value to a positive,
nonzero value.

By default, the value is set to -1 (minus 1).

NOTE: It is recommended that you set this value in relation to your daily report volumes,
especially for large-scale implementations where many reports are generated. The -1 setting
prevents the Siebel File System from increasing to an unmanageable size.

4 Navigate to the Administration - Server Management screen, then the Jobs view.

5 Add a new job entitled Workflow Process Manager.

6 Add a parameter to the job as follows:

a Enter Workflow Process Name as the name.

b Give the parameter a value of XMLP Purge Records.

7 Click Submit.

You can also schedule this job to generate periodically using a workflow. For more information about
scheduling workflows, see Siebel Business Process Framework: Workflow Guide.

Purging Scheduled Reports from the

Oracle BI Publisher Server
Scheduled reports that users have generated are stored in the Oracle Business Intelligence Publisher
(Oracle BI Publisher) scheduling database. Administrators can periodically purge scheduled reports
from the Oracle BI Publisher Server by removing Oracle Business Intelligence Scheduler job
instances from the database.

TIP: You cannot purge scheduled reports from the Siebel application or by using the Oracle BI
Publisher administration application.

This topic describes how to purge reports using either the Job Manager Instances List or the Job
Manager Purge Instances Window.

Siebel Reports Guide Version 8.1, Rev. C 69

Administering Siebel Reports ■ About Working with Multilingual Reports

To purge scheduled reports from the Oracle BI Publisher Server

■ Follow the instructions provided in the Purging Oracle BI Scheduler Job Instances topic in the
Oracle Business Intelligence Scheduler Guide on Oracle Technology Network (OTN).

CAUTION: It is recommended that only administrators purge scheduled reports, because you run
the risk of inadvertently depleting or contaminating the report repository. Report developers and
other users can delete reports, but they cannot purge reports. For information about deleting
reports, see “Deleting Scheduled Reports” on page 119.

NOTE: Administrators are also responsible for purging reports from the Siebel File System. For
information about this purging, see “Automatically Purging Reports from the Siebel File System” on
page 68.

About Working with Multilingual Reports

The Siebel Reports architecture supports generating reports in multiple languages from a single
object manager for a variety of needs. Siebel Reports allows you to:

■ Configure reports that are generated for a specific language and locale.

■ Make sure that a report is generated against a particular Siebel record with a preference for a
specific document language and locale for that record. For example, you might have a preference
for a document language for a specific Quote report.

■ Let users set a default language and locale preference for their own report generation.

■ Let users override the default language and locale values when executing reports.

■ Execute report generation using the default language and locale settings of the users session
object manager.

70 Siebel Reports Guide Version 8.1, Rev. C

 Administering Siebel Reports ■ About Working with Multilingual Reports

Table 6 provides details of how this logic is implemented in Siebel Reports. The order defines the logic
applied at run time to determine which default language preferences to use.

Table 6. How Siebel Reports Determines the Report Language at Run Time

Default
Preference Order Description

Template specific 1 If a default language and locale are specified in the report layout
template, then these values appear as the default selection for the
report output. However, users can override these settings at run
time (see Run-time Selection in this table).

Entity related 2 The Report Business Service is configurable for language and locale
(business service) as optional inputs. If the language and locale are specified at the
template level, then the template parameters are used rather than
those specified for the input. If no parameters are passed to the
Report Business Service, the default application object manager
values are used.

NOTE: Only use language and locale values as business service

inputs when these values are not set at the template level.

User preferences 3 If the report layout template does not have a default language and
locale, and the user has set a language and locale property in their
user preferences, the user preference values are used. Otherwise,
the values in the report layout template prevail.

For information about setting user preferences for report generation,

see “Setting Language and Locale User Preferences for Reports” on
page 91.

Run-time selection 4 Users can override the default language and locale values when
generating a report.

No language or 5 If no default language and locale are specified in the report layout
locale specified template level or in the user preferences, then the current
application object manager values for the session are used.

Related Topics
■ “About Report Translation” on page 72

■ “Designing Multilingual Reports” on page 72

■ “Adding and Deleting Languages from Report Templates” on page 73

Siebel Reports Guide Version 8.1, Rev. C 71

Administering Siebel Reports ■ About Report Translation

About Report Translation

To translate reports, you must externalize the user interface elements for localization in the
languages that you want. To externalize the user interface means to separate the localizable
attributes from the nonlocalizable attributes of the user interface elements for each translation. In
the case of reports, strings are externalized to an XLIFF file. The XLIFF format separates localizable
text from formatting, allowing the translator to work only on the text to be translated.

Typically, an administrator manages report translations; a third party usually performs the actual
translation.

NOTE: For a list of the languages that Siebel Reports supports, see Siebel System Requirements and
Supported Platforms on Oracle Technology Network.

Related Topics
■ “Roadmap for Optimizing the Performance of Siebel Reports” on page 74

■ “Designing Multilingual Reports” on page 72

■ “Adding and Deleting Languages from Report Templates” on page 73

Designing Multilingual Reports

Designing multilingual reports is the same as designing a standard report. The only difference is that
you must externalize the user interface elements for localization in the languages that you want.

For more information about externalizing the user interface elements, see “About Report Translation”
on page 72. For more information about designing reports, see Chapter 7, “Creating Reports.”

To design a multilingual report

1 Design a report in the default language, for example, ENU (English U.S.).
2 Using Oracle Business Intelligence Publisher Add-in for Microsoft Word, redesign the layout
template for the new language.

3 In the Siebel application, register the report.

For information about registering reports, see “Registering Report Layout Templates” on page 108.

NOTE: How translation files are uploaded from Oracle Business Intelligence Publisher Add-in for
Microsoft Word to generate reports differs depending on the connection mode; that is, whether
it uses connected or disconnected mode. For more information about uploading files, see
“Workflow for Uploading Report Layout Templates to a Siebel Application” on page 99.

4 (Optional) Add a default language and locale to the report template.

Related Topics
■ “Roadmap for Optimizing the Performance of Siebel Reports” on page 74

■ “About Report Translation” on page 72

72 Siebel Reports Guide Version 8.1, Rev. C

 Administering Siebel Reports ■ Adding and Deleting Languages from Report Templates

■ “Adding and Deleting Languages from Report Templates” on page 73

Adding and Deleting Languages from

Report Templates
This topic describes how to add and delete languages from report templates.

Adding a Language to a Report

Use the following procedure to add a language to a report template.

To add a language to a report

1 Log in to the Siebel application.

2 Navigate to the Administration - BI Publisher Reports screen, then to one of the following
template views:

■ Reports - Custom Templates

■ Reports - Standard Templates

3 In the appropriate Template list, select the report to which you want to add a language.

4 In the Translations subview, click New.

5 In the Language field, add a new language, and then click OK.

Deleting a Language from a Report

Use the following procedure to delete a language from a report template.

To delete a language from a report

1 Log in to the Siebel application.
2 Navigate to the Administration - BI Publisher Reports screen, then to one of the following
template views:

■ Reports - Custom Templates

■ Reports - Standard Templates

3 In the Report Template Registration list, select the report from which you want to delete a
language.

4 In the Translations list, choose a language, and then click Delete.

NOTE: This step removes only the language from the report; it does not remove the report.

Siebel Reports Guide Version 8.1, Rev. C 73

Administering Siebel Reports ■ Roadmap for Optimizing the Performance of Siebel
Reports

Related Topics
■ “Roadmap for Optimizing the Performance of Siebel Reports” on page 74

■ “About Report Translation” on page 72

■ “Designing Multilingual Reports” on page 72

Roadmap for Optimizing the

Performance of Siebel Reports
There are several tasks you can perform to optimize the performance of Siebel Reports. It is
recommended you perform these tasks as part of the Siebel Reports installation process. However,
you can perform them later. These tasks are not implemented in a particular order.

■ “Setting the Report Execution Waiting Period for Reports” on page 74

■ “Setting the Server Request Processor Database Polling Interval for Siebel Reports” on page 75

■ “Setting Concurrency Parameters for Siebel Reports” on page 76

■ “Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes” on
page 77

NOTE: Most of these tasks are applicable only when the client is in connected mode unless noted
otherwise.

Setting the Report Execution Waiting

Period for Reports
To optimize the performance of reports with more than 100 records, it is recommended that you limit
the wait time for report execution. The BIP Report Wait Time system preference allows you to set a
threshold value in seconds.

When a low waiting period is specified, a message appears soon after report generation begins noting
that the time taken to generate the report exceeds the waiting period. To monitor and view the
report, go to the My Reports view. For information about the My Reports view, see “Generating
Reports” on page 86.

This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 74.

To set the report execution waiting period for reports

1 Navigate to the Administration - Application screen, then the System Preferences view.

2 In the System Preferences list, select BIP Report Wait Time, and then change the value to a
number greater than 100.

Related Topics
Setting the Server Request Processor Database Polling Interval for Siebel Reports

74 Siebel Reports Guide Version 8.1, Rev. C

 Administering Siebel Reports ■ Setting the Server Request Processor Database Polling
Interval for Siebel Reports

Setting Concurrency Parameters for Siebel Reports

Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes

Setting the Server Request Processor

Database Polling Interval for Siebel
Reports
To optimize the performance of Siebel Reports, it is recommended you change the Database Polling
Interval parameter for the Server Request Processor (SRProc) server component. This parameter
defines how long to wait before SRProc polls the database again when the current polling does not
get requests.

NOTE: This parameter is hidden by default and does not appear in either the Siebel Server Manager
GUI or the Siebel Server Manager command-line interface program.

This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 74.

Use the following procedure to set the Database Polling Interval server component parameter.

To set the Server Request Processor database polling interval for Siebel Reports
1 Navigate to the Administration - Server Configuration screen, Servers, and then the Components
view.

2 In the Components list, select Server Request Processor (alias SRProc).

3 Scroll down, click the Parameters subview, and then click Hidden.

4 In the Parameter list, select Database Polling Interval, and change the value from 10 to 1.

The Value on Restart and Default Values are updated as well.

5 Restart the Siebel Server.

Alternatively, you can use the srvrmgr command-line interface to restart the SRProc component

For more information about setting the server component parameters and restarting the Siebel
Server and server components, see Siebel System Administration Guide.

Related Topics
Setting the Report Execution Waiting Period for Reports

Setting Concurrency Parameters for Siebel Reports

Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes

Siebel Reports Guide Version 8.1, Rev. C 75

Administering Siebel Reports ■ Setting Concurrency Parameters for Siebel Reports

Setting Concurrency Parameters for

Siebel Reports
To optimize the performance of Siebel Reports, it is recommended that you change the values of the
Maximum Tasks (MaxTasks) and the Maximum MT Servers (MaxMTServers) parameters. Perform one
of the following procedures on the computer where the XMLP Report Server component is enabled.
You configure the concurrency parameters for Siebel Reports by using the Server Manager GUI or
the Server Manager command-line interface program (srvrmgr program).

This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 74.

Setting Concurrency Parameters Using a Siebel Application

Use the following procedure to set the concurrency parameters using a Siebel application.

To set concurrency parameters using a Siebel application

1 Log in to the Siebel application as a Siebel administrator.

2 Navigate to the Administration - Server Configuration screen, Servers, and then the Components
view.

3 In the Components list, select XMLP Report Server.

4 Click the Parameters view tab, and perform the following:

a For the Maximum Tasks parameter, change the Value on Restart to 100.

b For the Maximum MT Servers parameter, change the Value on Restart to 2.

Setting Concurrency Parameters Using the Server Manager

Use the following procedure to set the concurrency parameters using the Server Manager (srvrmgr).

To set concurrency parameters using Server Manager

■ Execute the following Server Manager (srvrmgr) commands to increase the MaxTasks parameter
to 100 and the MaxMTServers parameter to 2:

change param maxtasks=100 for comp xmlpreportserver server XmlpServer

change param maxmtservers=2 for comp xmlpreportserver server XmlpServer

where:

XmlpServer is the name of the Siebel Server.

Related Topics
Setting the Report Execution Waiting Period for Reports

Setting the Server Request Processor Database Polling Interval for Siebel Reports

76 Siebel Reports Guide Version 8.1, Rev. C

 Administering Siebel Reports ■ Process of Optimizing the Generation Performance of
Siebel Reports for Large Data Volumes

Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes

Process of Optimizing the Generation

Performance of Siebel Reports for Large
Data Volumes
To optimize Siebel Reports generation performance with large data volumes (greater than 10,000
records), it is recommended that you adjust the DSMaxFetchArraySize profile parameter.

This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 74 and is
applicable to connected mode.

CAUTION: It is recommended that you perform the following procedure on a separate named
subsystem (for example, reportsdatascr) that is used only by the XMLP Report Server component.
Otherwise, the Application Object Manager (AOM) on the client computer might fail when retrieving
large amounts of data.

To optimize the generation performance of Siebel Reports for large data volumes, perform the
following tasks:

1 Set the DSMaxFetchArraySize profile configuration parameter value to -1.

For instructions for setting this parameter, see 1064043.1 (Doc ID) on My Oracle Support.

2 “Enabling Scalable Mode for Siebel Reports” on page 77.

3 “Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports” on page 79.

4 “Increasing EAI HTTP Transport Sleep Time for Siebel Reports” on page 80.

For more information about setting server profile parameters, see Siebel System Administration
Guide.

NOTE: It is recommended that you not execute reports with large data volumes as an immediate
report request. Instead, schedule these reports on the Oracle BI Publisher Server.

Related Topics
Setting the Report Execution Waiting Period for Reports

Setting the Server Request Processor Database Polling Interval for Siebel Reports

Setting Concurrency Parameters for Siebel Reports

Enabling Scalable Mode for Siebel Reports

To optimize Siebel Reports generation performance, you can enable the scalable mode parameter by
configuring the Oracle BI Publisher xdo.cfg file in the jre\lib directory.

Siebel Reports Guide Version 8.1, Rev. C 77

Administering Siebel Reports ■ Process of Optimizing the Generation Performance of
Siebel Reports for Large Data Volumes

This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large
Data Volumes” on page 77 and is applicable to connected mode.

NOTE: It is recommended that you only enable scalable mode when viewing large reports online with
a high concurrent report usage because this mode consumes more resources and might impact
overall performance. If large reports are more common than not in your deployment, then set the
scalable mode for all reports. Setting the scalable option prepares the FO processor to handle large
data, longer processing times, time-outs, and so on. Although scalable mode is a relatively slower
process, this mode makes sure there is no data loss even if the report is complex.

To enable scalable mode for Siebel Reports

1 Navigate to the ORACLE_HOME\xmlp\XMLP\Admin\Configuration directory.

2 Open the xdo.cfg file, and in the <Properties></Properties> tag, use the following syntax to set
the Scalable Mode parameter to true (if it is not already set):

<property name="xslt-scalable">true</property>

NOTE: You can set scalable mode to either true or false.

3 Save the xdo.cfg file.

The following is a sample xdo.cfg file:

<config version="1.0.0" xmlns="http://xmlns.oracle.com/oxp/config/">

<!-- Properties -->

<properties>

<!-- System level properties -->

<!-- PLEASE uncomment this property and set it to a valid temp directory
path. -->

<property name="system-temp-dir">D:\Temp</property>

<property name="xslt-scalable">true</property>

</properties>

<!-- Font setting -->

<fonts>

<!-- Font setting (for FO to PDF etc...) -->

<font family="Arial" style="normal" weight="normal">

<truetype path="/fonts/Arial.ttf" />

</font>

<font family="Default" style="normal" weight="normal">

<truetype path="/fonts/ALBANWTJ.ttf" />

78 Siebel Reports Guide Version 8.1, Rev. C

 Administering Siebel Reports ■ Process of Optimizing the Generation Performance of
Siebel Reports for Large Data Volumes

</font>

<!-- Font substitute setting (for PDFForm filling etc...) -->

<font-substitute name="MSGothic">

<truetype path="/fonts/msgothic.ttc" ttcno="0" />

</font-substitute>

</fonts>

<currency-formats>

<currency code="USD" mask="FM9G990D00"/>

<currency code="JPY" mask="FMFM9G990"/>

<currency code="ILS" mask="FM9G990D00"/>

<currency code="EUR" mask="FM9G990D00"/>

<currency code="TRK" mask="FM9G990D00"/>

</currency-formats>

</config>

Related Topics
Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports

Increasing EAI HTTP Transport Sleep Time for Siebel Reports

Configuring a Temporary Directory on the Oracle BI

Publisher Server for Siebel Reports
To benefit reports generation, configure a temporary directory for the Oracle BI Publisher Server. This
temporary space allows you to build complex reports that you can clean up after the reports are
generated.

This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large
Data Volumes” on page 77 and is applicable to connected mode.

To configure a temporary directory on the Oracle BI Publisher Server for Siebel

Reports
1 Navigate to the ORACLE_HOME\xmlp\XMLP\Admin\Configuration directory.

NOTE: The path for the Java installation folder varies depending on where you installed JRE.

2 Open the xdo.cfg file, and in the <Properties></Properties> tag, use the following syntax to set
the temporary directory:

Siebel Reports Guide Version 8.1, Rev. C 79

Administering Siebel Reports ■ Process of Optimizing the Generation Performance of
Siebel Reports for Large Data Volumes

<property name="system-temp-dir">d:\tmp</property>

NOTE: Make sure the location of the temporary directory has adequate space for the temporary
files.

3 Save the xdo.cfg file.

Related Topics
Enabling Scalable Mode for Siebel Reports

Increasing EAI HTTP Transport Sleep Time for Siebel Reports

Increasing EAI HTTP Transport Sleep Time for Siebel

Reports
You can optimize report generation for complex reports by increasing the default sleep time for the
EAI HTTP Transport business service. This is especially helpful when generating complex reports or
against large data sets, that might take longer than a couple of minutes to generate.

This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large
Data Volumes” on page 77 and is applicable to connected mode.

To increase EAI HTTP transport sleep time for Siebel Reports, see 859193.1 (Doc ID) on My Oracle
Support.

Related Topics
Enabling Scalable Mode for Siebel Reports

Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports

80 Siebel Reports Guide Version 8.1, Rev. C

6 Generating Reports

This chapter describes how to generate, view, monitor, and delete reports in Siebel Business
Applications from a user perspective. It includes the following topics:

■ About Generating Reports on page 81

■ Workflow for Generating Reports on page 83

■ Scenario for Generating Reports on page 84

■ Generating Reports on page 86

■ Example of Generating an Opportunity Report on page 87

■ Monitoring the Status of Currently Generating Reports on page 88

■ Viewing Generated Reports on page 89

■ Deleting Reports on page 90

■ Setting Language and Locale User Preferences for Reports on page 91

NOTE: This chapter is not applicable to scheduled reports. For information about scheduled reports,
see Chapter 8, “Scheduling Reports.”

About Generating Reports

You use the Reports menu to generate reports. The Reports menu is a drop-down list that appears
after clicking Reports on the Siebel application toolbar while you are in a Siebel view. The reports
available to you for that view are based on standard Siebel responsibility-based visibility and access
granted by others.

For more information about visibility and data access control in Siebel Business Applications, see
Siebel Security Guide.

You also use the Reports menu to schedule reports in connected mode. For information about
scheduling reports, see Chapter 8, “Scheduling Reports.”

Siebel Reports Guide Version 8.1, Rev. C 81

Generating Reports ■ About Generating Reports

Figure 5 provides a sample Reports menu that might appear when you click Reports while in the
Opportunities List view.

Figure 5. Sample Reports Menu

Related Topics
“Workflow for Generating Reports” on page 83

“Scenario for Generating Reports” on page 84

“Generating Reports” on page 86

“Example of Generating an Opportunity Report” on page 87

“Monitoring the Status of Currently Generating Reports” on page 88

“Viewing Generated Reports” on page 89

“Deleting Reports” on page 90

82 Siebel Reports Guide Version 8.1, Rev. C

 Generating Reports ■ Workflow for Generating Reports

Workflow for Generating Reports

You generate reports using the Siebel application views and the Reports menu. Figure 6 shows the
workflow for generating Siebel Reports.

Figure 6. Workflow for Generating a Report

Figure 6 illustrates the following:

1 Report requests are initiated from a Siebel application view. Typically, a query is run to limit the
number of records before requesting the report.

2 From the Reports menu, you choose to either generate a report or schedule a report.

3 If you:

■ Choose a report from the BI Publisher listing, you must first designate a report output file
type, and then click Submit.

NOTE: Optionally, you can choose a different language and locale rather than accept the
defaults.

■ Select My BI Publisher Reports, you choose a report by drilling down on it from the My
Reports view.

■ Schedule a report, you choose a report name, output file type, and other scheduling criteria
from the Schedule a Report dialog box.

Siebel Reports Guide Version 8.1, Rev. C 83

Generating Reports ■ Scenario for Generating Reports

4 If you chose a report from the BI Publisher section or drilled down on a report from the My
Reports view, from the File Download dialog box, you can choose to:

■ Open the report. The report downloads and appears in a browser window in the format you
chose in Step 3.

The report output file types are: PDF, HTML, RTF, EXCEL, and PPT. The PPT output file type
is available only in connected mode. For more information about the report output file types,
see “Siebel Reports Output File Types” on page 20.

■ Save the report. You can save the report to a destination of your choosing, and then Open it
for viewing.

If you chose to schedule a report, the report is stored in the Oracle BI Publisher repository for
future viewing and retrieval.

5 You can continue to download reports in other formats or click Close to end.

NOTE: Report scheduling is available only in connected mode. For more information about the
connection modes in relation to Siebel Reports, see “About the Siebel Reports Architecture” on
page 25. For information about scheduling reports, see Chapter 8, “Scheduling Reports.”

Related Topics
“About Generating Reports” on page 81

“Scenario for Generating Reports” on page 84

“Generating Reports” on page 86

“Example of Generating an Opportunity Report” on page 87

“Monitoring the Status of Currently Generating Reports” on page 88

“Viewing Generated Reports” on page 89

“Deleting Reports” on page 90

Scenario for Generating Reports

This topic gives a scenario of how you might use Siebel Reports in Siebel Business Applications. You
might use Siebel Reports differently, depending on your business model.

This scenario describes one example of a sales representative generating reports. In this example,
the representative chooses a report and the report output type, then the report generates and
appears in the chosen format. While generating, the representative can monitor or view the status
of the report and after successful completion, she can access the report immediately or a later time.

NOTE: The process for scheduling reports is similar, however, you choose Schedule Report from the
Reports menu instead of selecting a report from the drop-down list. For information about scheduling
reports, see Chapter 8, “Scheduling Reports.”

84 Siebel Reports Guide Version 8.1, Rev. C

 Generating Reports ■ Scenario for Generating Reports

Choosing a Report to Generate

A sales representative generates a series of account and opportunity reports periodically. These
reports include: Account List, Pipeline Analysis, and Opportunity Marketing Events Summary. They
provide a view of her current pipeline and other account-related activities. Today, the sales
representative decides to generate the Account List report. She navigates to the Accounts view, and
then clicks Reports. From the resulting Reports menu, she can choose a report. In this case, she
chooses Account List in the BI Publisher (BIP) section of the Reports menu.

Choosing the Report Output Type and Monitoring Status

Next, the sales representative is prompted to choose a report output type. In this case, she chooses
PDF, which automatically triggers the report to start generating data. After successful completion,
the report appears in the chosen format, where she can either open or save the report. However, if
the report takes a while to render, a message appears indicating that she must access the report
from the My Reports view. From the My Reports view, she can monitor the status of the report and
eventually access the report when the status shows Success.

Accessing a Generated Report

After several weeks, the sales representative decides she wants to take another look at this Account
List report. She accesses the report directly from the My Reports view by drilling down on the report
that she wants to see. After she drills down on the Account List report, the File Download dialog box
appears from which she can choose to open the report, save the report, or cancel the request. If she
chooses to open the report, the report appears.

Related Topics
“About Generating Reports” on page 81

“Workflow for Generating Reports” on page 83

“Generating Reports” on page 86

“Example of Generating an Opportunity Report” on page 87

“Monitoring the Status of Currently Generating Reports” on page 88

“Viewing Generated Reports” on page 89

“Deleting Reports” on page 90

Siebel Reports Guide Version 8.1, Rev. C 85

Generating Reports ■ Generating Reports

Generating Reports
You use the Reports menu to generate either a preconfigured report (provided with each Siebel
application) or a report you have previously generated, or a report others have granted you access
to.

To generate a report
1 (Optional) Override the default report language and local by setting user preferences.

For information about setting user preferences for report generation, see “Setting Language and
Locale User Preferences for Reports” on page 91.

2 Navigate to the Siebel application view from which you want to generate a report, run a query
to limit the number of returned records, and then click Reports.

TIP: It is strongly recommended that you perform a query before generating a report.
Performing a query will limit the number of returned records for the report. Alternatively, you
can use the CTRL or SHIFT keys to select multiple records.

3 From the Reports menu, select a report from one of the following:

■ BI Publisher section

■ My BI Publisher Reports link

4 Perform one of the following:

■ If you choose a report from the BI Publisher section, in the Report Output Type dialog box,
select the file format for the report, and then click Submit.

The report is generated and appears in a browser window where you can open or save the
report. If the report takes a while to render, a message appears indicating that you must
view the report from the My Reports view. The amount of time before this message appears
is set in the BIP Report Wait Time system preference by the administrator.

NOTE: The file formats available to you are determined by the developer at the time that the
report is registered. The output file types include: PDF, HTML, RTF, EXCEL, PPT (PPT is only
available in connected mode), or All.

■ If you choose a report from the My BI Publisher Reports link, the My Reports view appears.

The My Reports view shows long-running reports that are currently generating as well as the
reports that you have previously generated. The status field indicates whether a report ran
successfully (Success), encountered errors (Error), or is still generating (In Progress). When
reports are generated successfully, the Status field changes to Success. You can open or save
a report that shows a Success status by drilling down on that report.

For more information about monitoring reports, see “Monitoring the Status of Currently
Generating Reports” on page 88.

NOTE: If a report encounters errors while generating, a log file is created that the report
developers or administrators can use to troubleshoot the problem. For more information
about troubleshooting reports, see Appendix A, “Troubleshooting Siebel Reports.”

86 Siebel Reports Guide Version 8.1, Rev. C

 Generating Reports ■ Example of Generating an Opportunity Report

5 (Optionally) Override the default language and locale settings to the language of your choice.

For information about how languages and locale settings are implemented in Siebel Reports, see
“About Working with Multilingual Reports” on page 70.

Related Topics
“About Generating Reports” on page 81

“Workflow for Generating Reports” on page 83

“Scenario for Generating Reports” on page 84

“Example of Generating an Opportunity Report” on page 87

“Monitoring the Status of Currently Generating Reports” on page 88

“Viewing Generated Reports” on page 89

“Deleting Reports” on page 90

Example of Generating an Opportunity

Report
This topic gives one example of generating a Siebel report. You might use this feature differently,
depending on your business needs.

In this example, assume you want to generate the By Sales Rep opportunity report in PDF format.

To generate the By Sales Rep Opportunity report

1 Navigate to the Opportunities screen, My Opportunities, and then the Opportunity List view.

TIP: The predefined query for this view shows only your current opportunities. If you want to
see all of your opportunities, click Query, and then click Go.

2 Run a query to limit the number of records returned, and then click Reports.
3 From the BI Publisher section of the Reports menu, select the By Sales Rep report.

4 In the Select the Report Output Type dialog box, choose PDF, and then click Submit.

The By Sales Rep report Opportunity appears in a browser window, prompting you to open, save,
or cancel the request.

5 Click Open.

The By Sales Rep Opportunity report appears in PDF format in a new browser window, from which
you can choose to print, save, or cancel the report.

Related Topics
“Workflow for Generating Reports” on page 83

Siebel Reports Guide Version 8.1, Rev. C 87

Generating Reports ■ Monitoring the Status of Currently Generating Reports

“Scenario for Generating Reports” on page 84

“Generating Reports” on page 86

“Monitoring the Status of Currently Generating Reports” on page 88

“Viewing Generated Reports” on page 89

“Deleting Reports” on page 90

Monitoring the Status of Currently

Generating Reports
This topic describes how to monitor the status of currently generating reports.

NOTE: This topic is not applicable to scheduled reports. For information about monitoring scheduled
reports, see “Monitoring and Viewing Scheduled Reports” on page 118.

To monitor the status of a generated or currently generating report

1 Log in to the Siebel application.

2 Navigate to the BI Publisher Reports screen, then one of the following Reports views:

■ My Reports

■ My Team’s Reports

■ All Reports

88 Siebel Reports Guide Version 8.1, Rev. C

 Generating Reports ■ Viewing Generated Reports

3 In the appropriate reports list, look for the report that you want to monitor, and then review the
Status field for that report.

The status indicators are: In Progress, Success, and Error as described in the following table.

Field Description

Owner User ID of the person who generated the report.

Status Indicates:

■ In Progress when a report is currently generating.

■ Success when a report generates successfully.

■ Error when a report encounters errors while generating. To troubleshoot,

see Appendix A, “Troubleshooting Siebel Reports.”

TIP: The timestamp for a report is the submit time on the Siebel Server. If a user submits a
report when the XMLP Report Server component is not enabled, the report appears with a blank
status in the My Reports view. Then, when the XLMP Report Server component is enabled, the
report immediately shows a status of In Progress. However, the status might not appear long
enough for you to view it. This behavior is because typically the In Progress status disappears
after only a few seconds and is replaced with a status of Success. The My Reports view allows
you to monitor the progress of a currently generating report.

4 If the report shows a status of Success, you can drill down on the report to view it or save it.

Related Topics
“Workflow for Generating Reports” on page 83

“Scenario for Generating Reports” on page 84

“Generating Reports” on page 86

“Example of Generating an Opportunity Report” on page 87

“Viewing Generated Reports” on page 89

“Deleting Reports” on page 90

Viewing Generated Reports

After a report is generated, the report is saved in the Siebel File System. The report shows data as
of the time the report was run. You can view reports that:

■ You have personally generated

■ Your team members have generated

■ All generated reports

Position-based visibility applies to generated reports, that is, a user’s position specifies which reports
that user has access to.

Siebel Reports Guide Version 8.1, Rev. C 89

Generating Reports ■ Deleting Reports

For more information about positions and visibility in Siebel Business Applications, see Siebel
Security Guide.

NOTE: This topic is not applicable to scheduled reports. For information about viewing scheduled
reports, see “Monitoring and Viewing Scheduled Reports” on page 118.

To view generated reports

1 Navigate to the BI Publisher Reports screen, then one of the following Reports views:

■ My Reports

■ My Team’s Reports

■ All Reports

2 In the appropriate reports list, drill down on the report name that you want to view.

TIP: You can perform a query on any of the fields to find multiple reports.

3 In the File Download dialog box, do one of the following:

■ Click Open to view the file.

The report appears in a new browser window where you can print or save it.

■ Click Save to save the file.

The Save As dialog box appears where you can browse to find a location to save the file.

■ Click Cancel to cancel the request.

Related Topics
“Workflow for Generating Reports” on page 83

“Scenario for Generating Reports” on page 84

“Generating Reports” on page 86

“Example of Generating an Opportunity Report” on page 87

“Monitoring the Status of Currently Generating Reports” on page 88

“Deleting Reports” on page 90

Deleting Reports
This topic describes how to delete unwanted reports. You can delete reports that you have personally
generated or have been granted access to. After a report is deleted, it is no longer available in the
Siebel File System.

NOTE: This topic is not applicable to scheduled reports. For information about deleting scheduled
reports, see “Deleting Scheduled Reports” on page 119.

90 Siebel Reports Guide Version 8.1, Rev. C

 Generating Reports ■ Setting Language and Locale User Preferences for Reports

To delete a report
1 Navigate to the BI Publisher Reports screen, then to one of the following views:

■ My Reports

■ My Team’s Reports

■ All Reports

2 In the appropriate reports list, select a report, and then click Delete.

Related Topics
“Workflow for Generating Reports” on page 83

“Scenario for Generating Reports” on page 84

“Generating Reports” on page 86

“Example of Generating an Opportunity Report” on page 87

“Monitoring the Status of Currently Generating Reports” on page 88

“Viewing Generated Reports” on page 89

Setting Language and Locale User

Preferences for Reports
When generating a report, you can override the default report language and locale by setting user
preferences. For example, assume the default language for your deployment is English U.S. (ENU),
you can choose to generate the report in another language, such as Japanese (JPN) or German
(DEU).

NOTE: If a default report language and locale are not specified in the report template, and the user
has set the language and locale properties in their user preference, the user preferences settings are
used when the report is generated.

To set language and locale user preferences for reports

1 Navigate to the User Preferences screen, then the Report Parameters view.

2 Change the Locale and Language properties to the language of your choice.

NOTE: Setting user preferences allows you to generate reports in the language and locale you
specified as long as there is no default language or locale set in the report layout template.

Siebel Reports Guide Version 8.1, Rev. C 91

Generating Reports ■ Setting Language and Locale User Preferences for Reports

92 Siebel Reports Guide Version 8.1, Rev. C

7 Creating Reports

This chapter describes how to create reports. It is intended only for those who have report developer
or administrator privileges.

NOTE: End users do not typically have access to the administration views in the Siebel application,
and as such, are not able to perform the tasks in this chapter. For information about reporting from
the user perspective, see Chapter 6, “Generating Reports.”

This chapter includes the following topics:

■ Should You Clone an Existing Report or Create Custom Reports? on page 93

■ Scenario for Creating Reports on page 94

■ Workflow for Creating Reports on page 95

■ About Integration Objects in Siebel Reports on page 96

■ About Reporting Across Multiple Siebel Business Objects on page 97

■ Workflow for Uploading Report Layout Templates to a Siebel Application on page 99

■ Process of Creating Custom Reports on page 101

Should You Clone an Existing Report or

Create Custom Reports?
Siebel Reports provides report developers and business users with the option of adding new reports,
based on the existing report layout templates, or creating their own custom reports and report layout
templates. This topic helps you to determine which type of report to create and why.

The following are some situations in which you might want to clone an existing report:

■ When you add new fields to a report layout template

■ When differences between your new report and an existing report are minor

■ When you want multiple versions of the same report showing slightly different data to different
categories of users

When your requirements are not satisfied by an existing report and there are significant differences
between the report that you want and an existing report, create a custom report. The following are
some situations in which you must create a custom report:

■ When the report requires a new integration object

■ When the report requires a new integration component for an existing integration object. For
example, you create a new report for a view that belongs to the same business object.

Siebel Reports Guide Version 8.1, Rev. C 93

Creating Reports ■ Scenario for Creating Reports

Scenario for Creating Reports

This topic gives a scenario of how you might create reports in Siebel Business Applications. You might
use reports differently, depending on your business model.

This scenario describes how a sales manager works with a report developer to create a custom
opportunity report.

Sales Manager Generates Daily Sales Reports

A sales manager has a team of five sales representatives for the western region of a company. Every
day he generates a series of reports, including Opportunity by Sales Rep, Account List, and Forecast
Analysis Details to get the latest, current-account activities, and forecasted revenues for his sales
representatives. These reports are view-based and available from the Reports menu in the Siebel
application.

Sales Manager Modifies an Existing Sales Report to Hand Off to the Report Developer
These reports give the sales manager a good understanding of the opportunities in the pipeline for
each sales representative on his team, and allows him to monitor how they are progressing through
the sales cycle. Towards the end of the quarter, he wants to know how much potential revenue his
team might be able to close for the quarter. To learn that information, he wants to see a revenue
breakdown for the team’s opportunities by probability and sales stage. He knows, however, that no
such report is currently available, but realizes that the reports developer can create such a report
for him. Because the sales manager wants the report to have a certain look, he starts creating a
preliminary opportunity report himself using Oracle Business Intelligence Publisher Add-in for
Microsoft Word. When he is satisfied with the report layout template design, he hands off the
template to the report developer.

Sales Manager Generates the New Sales Report

After the reports developer finalizes the custom report, the sales manager can choose the report
from the Reports menu while in an Opportunity view. After choosing a report output type, the report
appears in a browser window, from which the sales manager can open or save the report. However,
if the report takes a while to render, a message appears indicating that he must access the report
from the My Reports view. From this view, he can monitor the status of the report and eventually
access the report when the status shows Success. For more information about report output file
types, see “Siebel Reports Output File Types” on page 20. For more information about the My Reports
view, see “About Using Siebel Reports” on page 20.

94 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Workflow for Creating Reports

Workflow for Creating Reports

Siebel Business Applications allow you to create new reports based on preconfigured report layout
templates, or you can create your own custom reports and report layout templates.

Figure 7 shows the workflow for creating custom reports. The workflow is applicable to both
connected and disconnected modes. For more information about the connection modes in relation to
Siebel Reports, see Chapter 3, “Siebel Reports Development Environment.”

Figure 7. Workflow for Creating Reports

Figure 7 illustrates the following workflow:

Siebel Reports Guide Version 8.1, Rev. C 95

Creating Reports ■ About Integration Objects in Siebel Reports

1 (Optional) Create a new integration object or extend an existing integration object using Siebel
Tools.

NOTE: Create new integration objects only when no appropriate integration object exists.

2 Create XML data using the Sample Data File Generation view in the Siebel client.

In this step, the following tasks are performed:

a Select an integration object for the report.

b Generate the sample XML data file, and then save it.

NOTE: The XML data file is typically saved to the XMLP\DATA directory in the Siebel File System.
You can however, save the XML to another location. For more information about the Siebel
Reports directory structure, see “About the Siebel Reports Architecture” on page 25.

3 Create a new report layout template, or modify an existing report layout template, using Oracle
Business Intelligence Publisher Add-in for Microsoft Word. Do the following:

a Assign the Siebel fields in the report layout template.

b Save the report layout template to RTF.

c Preview the report layout template to verify it appears as designed.

4 Register the report layout template using the template views (Reports - Custom Templates or
Reports - Standard Templates). Do the following:

a Create a new report.

b Select a report layout template.

c Assign an integration object.

d Select an output file type.

e (Optional) Select a default language and locale, report access control, and so on.

5 Associate the report with Siebel application views.

About Integration Objects in Siebel

Reports
Integration objects are metadata objects in Siebel Business Applications that provide the ability to
obtain Siebel data in XML format. Typical Siebel integration involves transporting data from an
external application to a Siebel deployment, using Siebel EAI and integration objects. In the context
of Siebel EAI, data is transported in the form of an integration message. A message, in this context,
typically consists of header data that identifies the message type and structure, and a body that
contains one or more instances of data, for example, orders, accounts, or employee records.

Siebel integration objects are used to define which Siebel data is integrated. A typical business object
contains several business components and fields. In most integrations, only a subset of this data is
necessary for generating reports. Siebel integration object definitions specify the components and
which fields to integrate, and facilitate the integration by exchanging integration data as XML files.
For more information about:

96 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ About Reporting Across Multiple Siebel Business Objects

■ Adding custom fields to existing integration objects for Siebel reports, see “Extending Integration
Objects to Add New Fields for Siebel Reports” on page 102.

■ Creating new integration objects for Siebel reports, see “Creating New Integration Objects for
Siebel Reports” on page 103.

NOTE: It is recommended that you request the assistance of a Siebel Tools developer to create
new integration objects for Siebel Reports.

■ Viewing integration object definitions, see Using Siebel Tools.

■ Integration objects in general, see Integration Platform Technologies: Siebel Enterprise

Application Integration.

About Reporting Across Multiple Siebel

Business Objects
Siebel Reports provides the ability to generate reports across multiple, unrelated Siebel business
objects without having to build the relationships into a single business object. To generate reports
across multiple business objects, you create a report based on multiple integration objects.

NOTE: Siebel Business Applications ship with standard integration objects for creating reports.
However, if there is no appropriate integration object available, you can either extend an existing
integration object or create new integration objects.

For information about extending integration objects, see “Extending Integration Objects to Add New
Fields for Siebel Reports” on page 102. For information about creating new integration objects, see
“Creating New Integration Objects for Siebel Reports” on page 103.

The following conditions and restrictions apply to reporting on multiple integration objects:

■ When specifying the integration objects in the report template in the Integration Objects list,
nonprimary integration objects must have a valid search specification value.

For more information about the report template in the Integration Objects list, see “Registering
Report Layout Templates” on page 108. For more information about nonprimary integration
objects, see “Adding Multiple Integration Objects to a Report” on page 111.

■ At run time, the query from the current view in the Siebel application is captured and passed to
the primary integration object. However, for integration objects other than the primary
(sometimes referred to as secondary integration objects) that are associated with a report,
queries are not passed from the user interface. The secondary integration objects are passed
according to the expression provided in the object’s search specification. For this reason, a valid
search specification value is required to filter the data for nonprimary integration objects.

NOTE: Position-based visibility is automatically applied.

Siebel Reports Guide Version 8.1, Rev. C 97

Creating Reports ■ About Reporting Across Multiple Siebel Business Objects

■ If no search specification value is entered for nonprimary integration objects, or the expression
is incorrect, the integration object returns all data from the relevant business components. This
omission returns potentially unwanted data, and also has a negative impact on performance.

NOTE: It is recommended that you test search specifications for multiple integration objects in a
relevant application view to make sure the search specification is valid before applying the
specification to a report in the applicable report template view.

For information about adding multiple integration objects to reports, see “Adding Multiple Integration
Objects to a Report” on page 111.

98 Siebel Reports Guide Version 8.1, Rev. C

Creating Reports ■ Workflow for Uploading Report Layout Templates to a Siebel Application

Workflow for Uploading Report Layout

Templates to a Siebel Application
This topic describes how Siebel Business Applications support Oracle BI Publisher report layout
templates for report generation. After a report layout template is created using Oracle Business
Intelligence Publisher Add-in for Microsoft Word, the report layout template and translation files must
be uploaded to the Siebel application before you can generate reports. Figure 8 shows how the
uploading of these files differs depending on the type of connection mode (connected or
disconnected).

Figure 8. How the Layout Template and Translation Files Are Uploaded from Oracle Business
Intelligence Publisher Add-in for Microsoft Word to Generate Reports

Figure 8 illustrates the following:

■ From the report template views (Reports - Custom Templates or Reports - Standard Templates),
the RTF report layout template and translation files are uploaded using an upload business
service to the Oracle BI Publisher repository as follows:

Siebel Reports Guide Version 8.1, Rev. C 99

Creating Reports ■ About Registering and Sharing Report Layout Templates

■ In connected mode, the upload service occurs by way of the PublicReportService Web service.
For more information about connected mode, see “Siebel Reports Architecture and Workflow
for Generating Reports in Connected Mode” on page 26.

■ In disconnected mode, the upload service is not applicable. All files (RTF, XLIFF, and XSL) are
local to the Oracle BI Publisher XDO Engine when generating reports. For more information
about generating reports in disconnected mode, see “Siebel Reports Architecture and Workflow
for Generating Reports in Disconnected Mode” on page 28.

■ To upload the report to the Oracle BI Publisher repository (connected mode only), the following
must occur:

■ The report layout template must have been saved in RTF format using Oracle Business
Intelligence Publisher Add-in for Microsoft Word.

■ You must click Upload Files in the report template views (Reports - Custom Templates or
Reports - Standard Templates) in the Siebel application. The RTF and XLIFF files are uploaded
and an XDO report definition file is created when the reports are generating.

■ The report layout template (RTF) and language (XLIFF) files are attached to the report during
the registration of the report layout template.

NOTE: The Generate XLIFF button is disabled (grayed out) in connected mode.

■ Before moving to the Oracle BI Publisher repository (connected mode), the layout template (RTF)
and XLIFF files are attached to the report during the registration of the layout template.

■ For disconnected mode, you must click Generate XLIFF to create XSL. Whereas in connected
mode, XSL is generated at run time by the Oracle BI Publisher Server.

NOTE: The Upload Files button is disabled (grayed out) in disconnected mode.

■ For connected mode, the RTF and XLIFF files are stored in the Oracle BI Publisher repository by
way of the PublicReportServiceService Web service. In disconnected mode, the report templates
and XLIFF files are stored in the Siebel client installation folder (that is,
SIEBEL_ROOT_CLIENT\xmlp\templates and SIEBEL_ROOT_CLIENT\xmlp\XLIFF, respectively).

For more information about uploading from Oracle Business Intelligence Publisher Add-in for
Microsoft Word, see “Registering Report Layout Templates” on page 108.

About Registering and Sharing Report

Layout Templates
Siebel Business Applications allow users to register and share report layout templates with others.
Access to report templates is controlled using position-based visibility.

TIP: Standard Siebel responsibilities control which reports views users can access. If you want to
prevent users from creating their own report templates and executing them from the Siebel
application, then do not grant access to the relevant template views. For example, you might want
to limit access to the Reports - Standard Templates view only to administrators.

100 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

The two views you use for report template registration are:

■ Reports - Custom Templates. This view contains report templates that are filtered by
positions. Users with visibility to the My Templates view can create their own custom report
templates. Only these users can see or execute the custom report templates in the Siebel
application. However, they can share them if other users have visibility to the relevant application
views. The My Teams and All Templates views allow managers and administrators to see the
report templates of their subordinates. For more information about shared report layout
templates, see “Sharing Report Layout Templates” on page 112.

■ Reports - Standard Templates. This view contains the standard (preconfigured) report
templates provided with the Siebel application and any custom templates that you want to be
accessible enterprise-wide (that is, not based on position-based visibility). These templates are
visible within the Siebel application. The templates are based on the standard association of
Siebel views; that is, users can execute reports if they have access to the relevant views.

CAUTION: It is strongly recommended that you limit access to standard templates only to
administrators. Otherwise, you run the risk of users inadvertently modifying the standard report
templates (or other templates that are visible to all users in the enterprise).

Process of Creating Custom Reports

Siebel Business Applications ship with preconfigured reports. However, using Oracle Business
Intelligence Publisher (Oracle BI Publisher) and Siebel Reports, you can create your own custom
reports. This topic describes the process for creating custom reports.

You create custom reports in three locations:

■ In Oracle Business Intelligence Publisher Add-in for Microsoft Word by modifying the existing or
creating new report layout templates.

■ In the Siebel clients by using the Siebel Reports Administration views to upload and register
report layout templates, associate reports with Siebel application views, and other administrative
tasks.

■ (Optional) In Siebel Tools by either extending an existing integration object or creating new
integration object definitions that execute at run time.

NOTE: Siebel Business Applications ship with standard integration objects. You create new
integration objects only when existing integration objects do not suffice.

To create custom reports, perform the following tasks:

1 (Optional) “Extending Integration Objects to Add New Fields for Siebel Reports” on page 102

2 (Optional) “Creating New Integration Objects for Siebel Reports” on page 103

3 “Generating Sample XML Data Files for Siebel Reports” on page 105

4 “Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft
Word” on page 106

5 “Previewing Report Layout Templates” on page 107

6 “Registering Report Layout Templates” on page 108

Siebel Reports Guide Version 8.1, Rev. C 10 1

Creating Reports ■ Process of Creating Custom Reports

7 (Optional) “Adding Multiple Integration Objects to a Report” on page 111

8 (Optional) “Sharing Report Layout Templates” on page 112

9 (Optional) “Defining Report Layout Templates for Selected Records” on page 112

10 “Associating Registered Reports with Siebel Application Views” on page 113

11 (Optional) “Changing the Report Sequence Order in the Reports Menu” on page 113

Extending Integration Objects to Add New Fields for

Siebel Reports
Siebel Business Applications ship with preconfigured reports and each of these reports references an
integration object that serves as the report schema. This topic describes how to extend an existing
integration object to add new fields for a report.

NOTE: It is recommended that you seek the assistance of a Siebel Tools configurator for integration
object modification. It is also recommended that you consider this option before creating new
integration objects for your reports. For information about creating new integration objects for Siebel
reports, see “Creating New Integration Objects for Siebel Reports” on page 103.

This task is an optional step in “Process of Creating Custom Reports” on page 101.

To extend an integration object to add a new field

1 In the Siebel client, identify the integration object by doing the following:

a Navigate to the Administration - BI Publisher Reports screen, then the relevant report template
view (either the Reports - Custom Templates view or Reports - Standard Templates view).

b Select the report for which you want to add a new field.
c In the Primary Integration Object Name column, identify and make note of the integration object
for this report.

NOTE: Integration objects for reports begin with BIP.

2 Add a new field to the integration object by doing the following:

a Log in to Siebel Tools.

b In the Object Explorer, select and expand Integration Object.

TIP: Integration objects do not appear in the Object Explorer by default. Click the View
menu, Options, and then the Object Explorer tab to add the integration objects to the Object
Explorer view.

c Query for the integration object associated with the report.

d Expand the Integration Component and Integration Component Field object types to view the
existing fields associated with this integration component.
e Create a new integration component field record and copy the Name, Data Type, and Length
properties from the underlying business component field whose data you want to display in the
report.

102 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

f Set the XML-related properties to construct the XML file when data is extracted.

NOTE: You must follow the convention for naming XML tags, that is, remove all spaces and
special characters. However, it is not a requirement that you use the ss_ prefix convention.

3 Deploy the modified integration object by doing the following:

a While still in Siebel Tools, navigate to the Integration Objects List.

b Right-click the integration object you want to deploy, and then select Deploy to Runtime
Database.

NOTE: This action overrides the object definition in the SRF file.

c In the Siebel client, Navigate to the Administration - Web Services screen, then the Deployed
Integration Objects view.
d Query for the integration object to verify it was deployed.

e Navigate to the Administration - Web Services screen, Inbound Web Services view.

f Click Clear Cache to update the run-time database.

The extended integration object is now available for generating a new sample data file.

For information about generating sample data files, see “Generating Sample XML Data Files for Siebel
Reports” on page 105. For more information about working with and deploying integration objects,
see Integration Platform Technologies: Siebel Enterprise Application Integration.

Creating New Integration Objects for Siebel Reports

Siebel Business Applications ship with preconfigured integration objects that you can use for
customizing your reports. However, you might want to create new integration objects, given no
applicable integration objects are available in the Siebel Repository. Using Siebel Tools, you can
create new integration objects. For more information about the role of integration objects in Siebel
Reports, see “About Integration Objects in Siebel Reports” on page 96.

NOTE: It is strongly recommended you seek the assistance of a Siebel Tools developer for
integration object creation. It is also recommended that you consider extending an existing
integration object to add new fields before creating new integration objects for your reports. For
information about extending existing integration objects, see “Extending Integration Objects to Add
New Fields for Siebel Reports” on page 102.

This task is an optional step in “Process of Creating Custom Reports” on page 101.

After new integration objects are created and deployed, you can use the integration objects to
register a report layout template. For more information about registering a report layout template,
see “Registering Report Layout Templates” on page 108.

NOTE: When creating custom integration objects for Siebel Reports, make sure that the fields used
for dynamic queries in the applet of the master business component are also contained in the
integration component. Dynamic queries are specific, customized queries that you create.

Siebel Reports Guide Version 8.1, Rev. C 10 3

Creating Reports ■ Process of Creating Custom Reports

To create a new integration object for Siebel Reports

1 Log in to Siebel Tools.

2 Use the Integration Object Builder wizard to create the new integration object, making sure to
name the new object definition with the prefix, BIP.

By default, you must add the BIP prefix so that integration objects appear in the Sample Data
File Generation view.

NOTE: It is recommended that if you use this wizard for creating integration objects, that you
inactivate only the required business component fields for the report. By default, the wizard
automatically adds all business component fields in the integration component. A large amount
of fields in an integration component might affect performance.

Typically, you add to an integration component only the fields that are required in the report. You
must also add to the integration component fields in the user interface that are required for
querying and filtering the data before executing the report.

3 Deploy the integration object to the run-time database by doing the following:

a In the Object Explorer in Siebel Tools, select Integration Object.

b In the Integration Object list, right-click the integration object you want to deploy, and then
select Deploy to Runtime Database.
c In the Siebel client, navigate to the Administration - Web Services screen, then the Inbound Web
Services view.

d Click Clear Cache to invalidate the integration object and Web services definitions in the run-time
database.
4 (Optional) Generate a new sample data file for the integration object for use when designing your
report templates.

This newly created integration object is now available in the Sample Data File Generation view for
your use when creating custom reports.

For information about generating sample data files, see “Generating Sample XML Data Files for Siebel
Reports” on page 105. For more information about integration objects and deploying an integration
object without compiling an SRF, see Integration Platform Technologies: Siebel Enterprise
Application Integration.

104 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

Generating Sample XML Data Files for Siebel Reports

This topic describes how to generate and save XML files for use in a report. You use the Sample Data
File Generation view in the Siebel application to choose an integration object that seeds the data for
a new report. Integration objects are metadata objects in Siebel Business Applications that provide
the ability to obtain Siebel application data in XML format. XML data is used to create the report
layout templates in RTF format and to generate reports at run time. When an XML data file generates
successfully, it is used by the Siebel XMLP Report Server component in connected mode, and by the
Oracle BI Publisher XDO Engine in disconnected mode to merge with the report layout template to
construct the report. The produced document is then stored in the Siebel File System.

NOTE: It is recommended that you consider extending an existing integration object to add new
fields before creating new integration objects for your reports. If, however, there is no existing
integration object that fits your requirements, you can create new integration objects using Siebel
Tools.

For information about extending existing integration objects, see “Extending Integration Objects to
Add New Fields for Siebel Reports” on page 102. For information about creating new integration
objects for reports, see “Creating New Integration Objects for Siebel Reports” on page 103.

This task is a step in “Process of Creating Custom Reports” on page 101.

To generate a sample XML data file for a report

1 Navigate to the Administration - BI Publisher Reports screen, then the Sample Data File
Generation view.

2 In the Sample Data File Generation list, select the integration object for which you want to
generate a data file, and then click Generate Sample XML.

An XML file is generated with the name of the integration object followed by .xml and saved to
the SIEBSRVR_ROOT\XMLP\DATA directory. For example, if the integration object name is
BIPLiteratureFulfillment, the file name for the XML file is BIPLiteratureFulfillment.xml.

NOTE: When you generate sample XML data, only a subset of the I/O data is exported into the
XML file. If some fields (such as multivalue fields) are not populated, these fields do not appear
when loaded into Microsoft Word using Oracle BI Publisher Add-In for Microsoft Word (also known
as Oracle BI Publisher Desktop). If this occurs, export the schema using Siebel Tools (from the
Tools menu, select Integration Object, and then Generate Schema). Rename the file with an .xsd
extension, and then load this schema into Microsoft Word using the Oracle BI Publisher menu.
All fields are now available for use in the template. For more information about XML schema
generation, see Transports and Interfaces: Siebel Enterprise Application Integration.

You can now create report layout templates based on this XML data using Oracle Business
Intelligence Publisher Add-in for Microsoft Word. For information about creating report layout
templates, see “Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in
for Microsoft Word” on page 106.

Siebel Reports Guide Version 8.1, Rev. C 10 5

Creating Reports ■ Process of Creating Custom Reports

Creating Report Layout Templates Using Oracle

Business Intelligence Publisher Add-in for Microsoft
Word
This topic describes how to create report layout templates for reports using Oracle Business
Intelligence Publisher Add-in for Microsoft Word.

This task is a step in “Process of Creating Custom Reports” on page 101.

NOTE: It is recommended that you use Oracle Business Intelligence Publisher Add-in for Microsoft
Word to create your custom RTF-formatted report layout templates. If you use other RTF-formatted
templates for creating your reports, you must manually code the XSL statements and references to
the data fields. Coding XSL is out of scope for this documentation.

CAUTION: Oracle BI Publisher does not support report names containing special characters.

The following are some situations in which you must create a new report layout template:

■ When a layout template requires that you add new fields or design a different layout

■ When a layout template requires association with a different integration component for the
specified integration object

■ When a layout template requires association with a different or multiple integration objects

The following procedure assumes you have installed Oracle Business Intelligence Publisher Add-in
for Microsoft Word. This procedure provides only quick reference information for creating report
layout templates. For detailed information, see Oracle Business Intelligence Publisher User’s Guide,
which is available from the Oracle BI Publisher Desktop program menu (click Start, Programs, Oracle
BI Publisher Desktop, and then BI Publisher Users Guide).

To create a report layout template using Oracle Business Intelligence Publisher Add-
in for Microsoft Word
1 Start Microsoft Word.
2 From the application-level menu in Microsoft Word, select Oracle BI Publisher, Data, and then
Load Sample XML Data.

3 In the Select XML Data window, select the XML data file.

NOTE: Typically, the XML data files reside in the XMLP\DATA directory on which the Siebel Server
is running.

4 Define the format of the report and the Siebel fields that you want to appear in the report, using the
Template Wizard as follows:

a From the Microsoft Word toolbar, choose Insert, Table/Form, and then Wizard.

b In the Template Wizard, choose the report format, and then click Next.

You can choose one of the following: Table, Form, or Free Form.

c (Optional) Change the XML data grouping, and then click Next.

d Select the Siebel fields that you want to appear in your report, and then click Next.

106 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

e If the data is to appear in Table format, decide the grouping and sorting, and then click Next.

f Label the Siebel fields as you want them to appear in the new report, and then click Finish.

g Save the report layout template in RTF format.

The following files are created and stored in the Siebel File System for retrieval by the Siebel
application as follows:

❏ The report layout template (RTF) and XLIFF files in connected mode

❏ The XSL and XLIFF files in disconnected mode

h Preview the report layout template.

NOTE: During the report layout template creation process, you can preview your work-in-
progress templates. For information about previewing report layout templates, see
“Previewing Report Layout Templates” on page 107.

If you are currently creating a report for which you want to use this report layout template, you must
register the report layout template in the Siebel application, see “Registering Report Layout
Templates” on page 108.

NOTE: Additional information is provided in Oracle Business Intelligence Publisher Report Designer's
Guide in the Oracle Business Intelligence Publisher Documentation Library 10.1.3.4 available on
Oracle Technology Network (OTN). Not all features mentioned in the Oracle Business Intelligence
Publisher documentation are currently supported in Siebel Reports; only the features documented in
this guide.

Previewing Report Layout Templates

During the report creation process, you can preview Oracle Business Intelligence Publisher (Oracle
BI Publisher) report layout templates by selecting the preview template option from the Oracle BI
Publisher menu item in Microsoft Word.

This task is a step in “Process of Creating Custom Reports” on page 101.

The following procedure assumes you have installed Oracle Business Intelligence Publisher Add-in
for Microsoft Word. For information about installing Oracle Business Intelligence Publisher Add-in for
Microsoft Word, see “Installing Oracle BI Publisher for Siebel Business Applications” on page 40.

To preview a work-in-progress Oracle BI Publisher report layout template

1 In Microsoft Word, open the RTF template file (if not already open).

Typically, the template files are stored in SIEBSRVR_ROOT\XMLP\TEMPLATES.

2 From the application-level menu, select Oracle BI Publisher, Preview Template, and then choose
the output file format.

The report appears in the chosen format with the data substituted.

3 (Optional) Continue to preview different output file formats.

4 Save the file in RTF format.

Siebel Reports Guide Version 8.1, Rev. C 10 7

Creating Reports ■ Process of Creating Custom Reports

For more information about creating report layout templates, see “Creating Report Layout Templates
Using Oracle Business Intelligence Publisher Add-in for Microsoft Word” on page 106.

Registering Report Layout Templates

You must register report layout templates so that users have access to reports using the Reports
menu in the Siebel application. To generate reports, report layout template files created using Oracle
Business Intelligence Publisher Add-in for Microsoft Word, must be uploaded. How these files are
uploaded differs depending on the connection mode; that is, whether the Siebel application is in
connected or disconnected mode. This topic describes how to upload and register layout templates
from the Siebel application for both connection modes.

NOTE: Each report can have only one report layout template, but you can register the same report
layout template for many reports.

This task is a step in “Process of Creating Custom Reports” on page 101.

In connected mode, the Oracle BI Publisher Server requires the RTF and XLIFF files in its folder
structure. If the files are not available, the report is not generated. When the upload is successful,
a new folder structure is created in the Oracle BI Publisher repository. This folder has the same name
as the report selected and contains the report layout template (RTF), XLIFF, and .xdo files. The Oracle
BI Publisher Server creates the XSL file during run time.

In disconnected mode, the RTF, XLIFF, and XSL files must be made available (by uploading the files
to the Oracle BI Publisher XDO Engine) before the reports are generated. For more information about
uploading report layout templates to the Siebel application, see “Workflow for Uploading Report Layout
Templates to a Siebel Application” on page 99.

To register a layout template for a report

1 Make sure the Oracle BI Publisher Server is running.
a Click Start, Programs, and then Oracle - BIPHomeX.

b Choose Start BI Publisher.

A command window appears.

NOTE: You must leave this command window open while the Oracle BI Publisher Server is
running.

2 In the Siebel application, navigate to the Administration - BI Publisher Reports screen, then one
of the following template views:

■ Reports - Custom Templates

■ Reports - Standard Templates

3 In the appropriate templates list, click New.

4 Register the report layout template for the report by doing the following:

a Type a report name and optionally a description.

b Select a report layout template.

108 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

c Select an output type.

d (Optional) Select an existing XLIFF file.

e (Optional) Assign a position or positions in the Report Access field.

NOTE: The Report Access field is available only in the Reports - Custom Templates view to
allow for sharing of generated reports.

f Fill in the rest of the fields.

The fields are described in the following table.

Field Description

Start Date1 A start date and time for the report.

For preconfigured reports that ship with Siebel Business Applications,

there is no start date. For reports that you create, the Start Date field
automatically populates with the current date and time when the
report layout template was registered. However, you can change these
values any time.

End Date1 An end date for the report. After the end date passes, the report no
longer appears in the Reports menu. By default, this field is NULL.

Primary The primary integration object for the report. This field is read-only
Integration Object and is automatically populated when you select an integration object
Name in the report template Integration Objects subview.

Template The RTF report layout template that is used to generate the report.
Templates are stored in the following folder:

SIEBSRVR_ROOT\XMLP\TEMPLATES
Output Type The format of the generated report, which can be one of the following:
PDF, HTML, RTF, XLS, PPT, MHTML, or All.

NOTE: If a report is saved with only one report output type, the
Report Output Type dialog box does not appear when the user selects
that report in the Reports menu. Instead, the report begins generating
in the assigned format. Typically, the output type is set to All. PPT is
applicable only in connected mode.

Default Language The default language for the template.

Default Locale The default locale for the template.

XLIFF XLIFF files contain the strings of the report column, field labels, and
captions that are used for translation purposes.

NOTE: If you change a report layout template and upload the

template to a Siebel client, you must regenerate the report.

Siebel Reports Guide Version 8.1, Rev. C 10 9

Creating Reports ■ Process of Creating Custom Reports

Field Description

Report Access Controls access to generated reports using positions.

NOTE: The Report Access field is available only in the Reports -

Custom Templates view to allow for sharing of generated reports.

Selected Records Indicates that only the currently selected records in a Siebel
application view are included in the report at run time. For more
information about how to use the selected records feature, see
“Defining Report Layout Templates for Selected Records” on page 112.
1. The start and end dates determine the period that a report is available for use. If you choose a start date, you must
also choose an end date. Conversely, if you choose an end date, you must also choose a start date.

5 Associate a primary integration object with the report by doing the following:

a In the relevant Integration Objects subview, click New.

b Fill in the fields in the new record.

The fields are described in the following table.

Field Description

Integration The integration object that you want to associate with the report layout
Object Name template.

Search A query data filter. When you create a nonprimary integration object for a
Specification report, you must enter a search specification value. For example, the value
of the search specification might be the following expression:

[Status] = 'Closed'

NOTE: This field is not required for primary integration objects, because
queries are taken from the Siebel application views.

For more information about multiple integration objects with regard to

Siebel Reports, see “About Reporting Across Multiple Siebel Business
Objects” on page 97.

Primary Indicates that this integration object is the primary integration object. The
Primary Integration Object Name field in the template views are
automatically populated when you select a primary integration object.

NOTE: The first integration object that you associate with a report is
automatically indicated as the primary integration object.

c (Optional) Click Generate Sample XML for use when designing reports.
6 (Optional) If you want to generate reports for multiple business objects, perform the tasks as
described in “Adding Multiple Integration Objects to a Report” on page 111.

110 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

7 (Optional) Assign a language or languages to the report layout template.

For information about assigning languages to report layout templates, see “Adding and Deleting
Languages from Report Templates” on page 73.

You must now associate the registered report with the views in which you want the report to be
available. For more information on associating reports, see “Associating Registered Reports with Siebel
Application Views” on page 113.

Adding Multiple Integration Objects to a Report

This topic describes how to create a Siebel report that reports across multiple, unrelated Siebel
business objects. For more information about reporting across multiple business objects, see “About
Reporting Across Multiple Siebel Business Objects” on page 97.

This task is an optional step in “Process of Creating Custom Reports” on page 101.

The following procedure assumes that you have registered or are in the process of registering a
report layout template, as described in “Registering Report Layout Templates” on page 108.

To add multiple integration objects to a report

1 Navigate to the Administration - BI Publisher Reports screen, and then one of the following
views:

■ Reports - Custom Templates

■ Reports - Standard Template

2 In the relevant report template view, select a report (if not already selected).

3 In the Integration Objects subview, click New.

NOTE: Custom integration objects previously created appear as well as the preconfigured
integration objects that ship with the Siebel application. One of the integration objects is
indicated as primary. This Primary field is automatically indicated when associating an integration
object with a report for the first time.

4 Fill in the fields in the new record.

The fields are described in Step 5 in “Registering Report Layout Templates” on page 108.

5 Repeat Step 3 and Step 4 of this procedure for each additional integration object that you want
to add.

6 Click Generate Sample XML.

One XML data file is generated for the multiple integration objects.

NOTE: This step is similar to what occurs in “Generating Sample XML Data Files for Siebel Reports”
on page 105, but in the Sample Data File Generation view, you can generate XML for only one
integration object.

If you are currently creating a report, you must now associate the registered report with a Siebel
application view. See “Associating Registered Reports with Siebel Application Views” on page 113.

Siebel Reports Guide Version 8.1, Rev. C 11 1

Creating Reports ■ Process of Creating Custom Reports

Sharing Report Layout Templates

Siebel Business Applications allow you to share report layout templates. If a report template is
registered in the Siebel application, you can define the visibility of the report template for use by
others using the Templates views. After you add a report to the My Templates view, you can make
that report accessible and shareable with others, using the My Team’s Templates and the All
Templates views.

This task is an optional step in “Process of Creating Custom Reports” on page 101.

The Report Access field on the report record controls access to the report templates that can be
executed. After a user is granted access to the report template, the template appears in the Reports
menu when a user navigates to the relevant view.

To share a report layout template

1 Navigate to the Administration - BI Publisher Reports screen, then the Reports - Custom
Templates view.

2 Perform one of the following:

■ Query for an existing report.

■ Click New to register a new report.

For information about registering a new report, see “Registering Report Layout Templates” on
page 108.

3 Grant access to the report by doing the following:

a Click the Report Access field to display the Position dialog box.

b In the Position dialog box, select the positions that you want to grant access to the report, and
then click Add.

NOTE: You can select multiple positions by using the CTRL key.

Defining Report Layout Templates for Selected Records

You can configure a report template to display only the currently selected records in a Siebel
application view when a report is generated. When you implement the selected records feature, any
query a user might perform is rendered irrelevant. The report is generated, using the selected
records.

NOTE: This feature applies to any level of hierarchy visible in the view; that is, this feature is
applicable to parent-child views and parent-child-grandchild views.

This task is an optional step in “Process of Creating Custom Reports” on page 101.

To define a report layout template for a selected record

1 In the Siebel application, navigate to the Administration - BI Publisher Reports screen, then one
of the following template views:

112 Siebel Reports Guide Version 8.1, Rev. C

 Creating Reports ■ Process of Creating Custom Reports

■ Reports - Standard Templates

■ Reports - Custom Templates

2 In the appropriate templates list, select the report for which you want to enable the single or
multiselect feature, and then click the Selected Records field.

Associating Registered Reports with Siebel Application

Views
After registering a report, you associate the report with one or more Siebel application views. The
context-sensitive report appears in the Reports menu only in the views that are associated with the
report.

This task is a step in “Process of Creating Custom Reports” on page 101.

To associate a registered report with a Siebel application view

1 Navigate to the Administration - BI Publisher Reports screen, then the View Association view.

2 In the Views list, select a view with which you want to associate a report.

3 In the Reports List subview, click Add.

4 In the Views dialog box, do the following:

a Choose a report name and optionally a description.

b (Optional) Assign a sequence number.

c Click OK.

The report is now available in the Reports menu when a user is in a view with which the report
is associated and the user has visibility to that view.

5 Test the newly created report by generating it.

For information about generating reports, see Chapter 6, “Generating Reports.”

NOTE: If a report encounters errors while generating, a log file is created that report developers
and administrators can use to troubleshoot the problem. For more information about
troubleshooting reports, see Appendix A, “Troubleshooting Siebel Reports.”

Changing the Report Sequence Order in the Reports

Menu
This task is an optional step in “Process of Creating Custom Reports” on page 101.

Siebel Reports Guide Version 8.1, Rev. C 11 3

Creating Reports ■ Process of Creating Custom Reports

You can define the way reports are ordered or even hide a report from appearing in the Reports menu
by setting the Sequence field on the report record. You can define this field when creating a report
(or change the sequence later) to a numeric value that determines the sort order of the reports. The
sort order is calculated with the lowest value appearing higher in the list of reports. The Siebel
application calculates the order. The calculation is based on the following logic:

■ The sequence value can be any positive integer including 0 (zero) or NULL.

■ When the sequence value is set to 0 (zero), the report does not appear in the Reports menu.

■ If the field value is blank or NULL, the report is generated using the standard sort order (that is,
according to the report name). This setting is the default.

■ Reports with a positive integer sequence value are sorted by the sequence value and ordered
before any report with a NULL sequence value.
■ If two or more records have the same sequence value, the records are sorted by name.

TIP: Because the Sequence field is a standard, numeric-business component field, you can add your
own business logic for how reports appear in the application. For more information about configuring
business components, see Configuring Siebel Business Applications.

To change the report sequence order in the Reports menu

1 Navigate to the Administration - BI Publisher Reports screen, then the View Association view.

2 Select the view for which you want to define the report order.

3 In the Report List list, use the sequence field to assign a sequence to some or all of the reports.

114 Siebel Reports Guide Version 8.1, Rev. C

8 Scheduling Reports

This chapter describes how to schedule reports in Siebel Business Applications from a user
perspective. It includes the following topics:

■ About Scheduled Reports on page 115

■ Scheduling Reports on page 116

■ Example of Scheduling an Opportunity Report on page 117

■ Monitoring and Viewing Scheduled Reports on page 118

■ Deleting Scheduled Reports on page 119

About Scheduled Reports

You can schedule reports to generate at a later time using the Schedule Report menu item from the
Reports menu. This menu item opens a dialog box from which you select the report you want to
schedule. From this dialog box, you assign a job name, the criteria for generating the report (such
as time and date you want the report to run, how often you want the report to generate, whether
the report generates with a recurring frequency, and so on). After the report job is scheduled, you
can view the report using the Scheduled Reports view.

NOTE: Report scheduling requires the Siebel Web Client in connected mode. For more information
about the connection modes in relation to Siebel Reports, see “About the Siebel Reports Architecture”
on page 25.

The Scheduled Reports view is an Oracle BI Publisher Web page that is embedded in the Siebel user
interface. The Siebel application and Oracle BI Publisher exchange data by way of a Web service to
produce the report.

Related Topics
“Scheduling Reports” on page 116

“Example of Scheduling an Opportunity Report” on page 117

“Monitoring and Viewing Scheduled Reports” on page 118

“Deleting Scheduled Reports” on page 119

Siebel Reports Guide Version 8.1, Rev. C 11 5

Scheduling Reports ■ Scheduling Reports

Scheduling Reports
If granted scheduling privileges, you can schedule reports to generate at a specific time (including
immediately) and recurring frequency. While in a Siebel application view, you schedule a report by
selecting the Schedule Report menu item from the Reports menu.

CAUTION: If you are unable to schedule reports, you might not have the appropriate access controls
assigned. Ask your administrator to grant you the XMLP_SCHEDULER responsibility.

Report scheduling is available only in connected mode. For more information about the connection
modes in relation to Siebel Reports, see “About the Siebel Reports Architecture” on page 25.

NOTE: You cannot schedule parameterized reports. For information about parameterized reports,
see Chapter 11, “Parameterized Reports.”

To schedule a report
1 Navigate to the Siebel application view from which you want to schedule a report, and click
Reports.

2 From the Reports menu, select Schedule Report.

3 In the Schedule a Report dialog box, enter the schedule criteria for the report, and then click
Schedule.

Some fields are described in the following table.

Field Description

Report Name The report you want to schedule.

Job Name Enter a name for the job you are scheduling.

NOTE: Any descriptive text for the job name is acceptable, the job name
does not have to be unique. However, for search purposes, you might
want to adopt a naming convention.

Output Type The output file format for the report. For information about the available
output types, see “Siebel Reports Output File Types” on page 20.

Report Language The language for the report.

Report Locale The locale for the report.

Time The recurrence of the report. Choices are: Run Immediately, Run Once,
or Daily/Weekly.

If you choose to run the report immediately, the job is triggered as soon as
you click Schedule. If you choose to run the report only one time, you must
also enter the exact date and time to run the report. If you choose to run
the report daily or weekly, you must also enter the day of the week, specify
the time for the selected day, and the date range of the occurrence.

Day of the week The day of the week you want the report to generate.

116 Siebel Reports Guide Version 8.1, Rev. C

 Scheduling Reports ■ Example of Scheduling an Opportunity Report

Field Description

Public If checked, the output of the job is viewable by all users. By default, this
field is not checked.

Save Data If checked, the XML data of the job is saved and is viewable in the Scheduled
Reports view. By default, this field is checked.

Save Output If checked, the output of the job is saved and is viewable in the Scheduled
Reports view. By default, this field is checked.

Run Date The date the report generates.

Run Time The time the report generates.

Active Start Date/ If a date is set in either of these fields, then it restricts the dates for which
Active End Date scheduling is active. Null by default.

4 (Optional) Schedule another report with different criteria.

NOTE: The Schedule a Report dialog box remains open until you click Cancel.

5 Click Cancel to exit the scheduling dialog box.

6 To view or monitor the report, do the following:

a Navigate to the BI Publisher Reports screen, then the Scheduled Reports view.

NOTE: The Scheduled Reports view is an embedded Web page from the Oracle BI Publisher
Enterprise application.

b Click the document icon to view the actual report.

c (Optional) Drill down on the Job Name for more information, and then click Back to view
additional scheduled reports.

Related Topics
“About Scheduled Reports” on page 115

“Example of Scheduling an Opportunity Report” on page 117

“Monitoring and Viewing Scheduled Reports” on page 118

“Deleting Scheduled Reports” on page 119

Example of Scheduling an Opportunity

Report
This topic gives one example of scheduling a Siebel report. You might use this feature differently,
depending on your business needs. For more information about report scheduling, see “Scheduling
Reports” on page 116.

In this example, assume you want the By Sales Rep opportunity report to generate in HTML format
each Tuesday and Thursday at 10:15 a.m. for a two week period from August 2-15, 2009.

Siebel Reports Guide Version 8.1, Rev. C 11 7

Scheduling Reports ■ Monitoring and Viewing Scheduled Reports

To schedule the By Sales Rep Opportunity report

1 Navigate to the Opportunities screen, My Opportunities, and then the Opportunity List view.

2 Run a query to limit the number of records returned, and then click Reports.

3 From the Reports menu, select Schedule Report.

4 In the Schedule a Report dialog box, enter the following schedule criteria for the report, and then
click Schedule:

■ Report Name is By Sales Rep Opportunity

■ Job Name is <Enter a job name>

■ Output Type is HTML

■ Time is Run Daily/Weekly

■ Day of the Week is Check the Tuesday checkbox, hold the CTRL key, and then click the
Thursday check box

■ Active Start Date is 8/2/2009

■ Active End Date is 8/15/2009

■ Run Time is 10:15:00 AM

For descriptions of these and other fields in this dialog box, see “Scheduling Reports” on page 116.

5 (Optional) Navigate to the BI Publisher Reports screen, then the Scheduled Reports view to
monitor the scheduled report.

For information about monitoring and viewing your scheduled reports, see “Monitoring and
Viewing Scheduled Reports” on page 118.

Related Topics
“About Scheduled Reports” on page 115

“Scheduling Reports” on page 116

“Monitoring and Viewing Scheduled Reports” on page 118

“Deleting Scheduled Reports” on page 119

Monitoring and Viewing Scheduled

Reports
This topic describes how to monitor the status of scheduled reports using the Scheduled Reports
view. The Scheduled Reports view is an embedded Oracle BI Publisher Web page, where you can
view completed job history, scheduled jobs, and recurring jobs that you submitted from the Schedule
Report menu item in the Reports menu. In this view, you can also delete, suspend, or resume
scheduled reports that have not yet generated. For more information about report scheduling, see
“About Scheduled Reports” on page 115 and “Scheduling Reports” on page 116.

118 Siebel Reports Guide Version 8.1, Rev. C

 Scheduling Reports ■ Deleting Scheduled Reports

To monitor the status of a scheduled report

1 Navigate to the BI Publisher Reports screen, then the Scheduled Reports view.

NOTE: The Scheduled Reports view is an embedded Web page from the Oracle BI Publisher
Enterprise application.

2 Monitor the status in Oracle BI Publisher by doing one of the following:

■ Click the History tab to view a history of your report jobs.

■ Click the Schedules tab to view the report jobs you have scheduled and their status. Drill
down on a report to view detailed information about the report job.

For more information about viewing scheduled reports, see “Monitoring and Viewing Scheduled
Reports” on page 118.

Related Topics
“About Scheduled Reports” on page 115

“Scheduling Reports” on page 116

“Example of Scheduling an Opportunity Report” on page 117

“Deleting Scheduled Reports” on page 119

Deleting Scheduled Reports

This topic describes how to delete reports that you have personally scheduled. You use the Scheduled
Reports view to delete the scheduled reports that you no longer want. For more information about
the Scheduled Reports view, see “About Scheduled Reports” on page 115.

To delete scheduled reports

1 Navigate to the BI Publisher Reports screen, then the Scheduled Reports view.

2 Click the checkbox next to the report you want to delete, and then click Delete.

NOTE: This step removes the report from the report list; it does not remove the report from the
Oracle BI Publisher repository. Only administrators can purge Siebel reports from the Oracle BI
Publisher repository. For more information about purging scheduled reports, see “Purging
Scheduled Reports from the Oracle BI Publisher Server” on page 69.

In the Scheduled Reports view, you can also monitor and view your scheduled reports. See
“Monitoring and Viewing Scheduled Reports” on page 118.

Additionally, you can delete non-scheduled reports you have personally generated using the My
Reports view. For information about deleting non-scheduled reports, see “Deleting Reports” on
page 90.

Related Topics
“About Scheduled Reports” on page 115

Siebel Reports Guide Version 8.1, Rev. C 11 9

Scheduling Reports ■ Deleting Scheduled Reports

“Scheduling Reports” on page 116

“Example of Scheduling an Opportunity Report” on page 117

“Monitoring and Viewing Scheduled Reports” on page 118

120 Siebel Reports Guide Version 8.1, Rev. C

9 Using Master-Detail Reports

This chapter describes master-detail reports and how they work, as well as how to create a master-
detail layout template. It includes the following topics:

■ About Master-Detail Reports

■ How Master-Detail Reports Work

■ Creating a Master-Detail Layout Template in Microsoft Word

About Master-Detail Reports

This topic describes master-detail reports in Siebel Business Applications. A master-detail report
displays a list of detail business component records for each record in a master business component,
to which the master and detail business components have a one-to-many relationship. It is similar
to a master-detail view in a Siebel application, in that detail records are displayed for each master
record. Unlike a master-detail view, however, a master-detail report lists detail records for all master
records at the same time, rather than for one master record at a time.

Figure 9 shows an example of a Service Request Activity - All report in Siebel Service, which is a
master-detail report.

Figure 9. Example of a Master-Detail Service Request Activity (All) Report

In this example, the master-detail reports provide master information for each service request,
followed by a list of activities for that service request. Each service request begins on its own page.
For further analysis of the Service Request Activity - All master-detail report, see “How Master-Detail
Reports Work” on page 122.

A master-detail report can also have multiple detail elements. In this case, a list of detail records
appears for several business components for each master record. For example, the Account Service
Profile report provides three lists for each account master record: customer survey responses,
opportunities, and service requests. A report with two detail elements is described in “Creating a
Master-Detail Layout Template in Microsoft Word” on page 126. Many of the preconfigured reports that
ship with Siebel Business Applications are master-detail reports.

Siebel Reports Guide Version 8.1, Rev. C 12 1

Using Master-Detail Reports ■ How Master-Detail Reports Work

A master detail report incorporates a parent business component and related child and grandchild
business components as defined in the business object definition that the integration object is based
on. When executing a report, the UI context is captured and passed to the primary integration
component of the integration object. If a multivalue field (MVF) is included in a report, only the first
record is displayed. To display all the records from an MVF in the report, an integration object must
have been created in Siebel Tools under the associated integration object based on the business
component that contains the MVF to be displayed.

This information is also valid for indirect MVFs. For example, consider the case where the business
address (an MVF) of an account associated with an opportunity appears in the report. The business
addresses in the MVF are not directly related to the opportunity, but they are related to the account
that it is associated with it. To display all the records in the business address MVF as a detail section,
first create a link between the Business Address business component and the Opportunity business
component using Account Id as the source field. Include the Business Address business component
under the Opportunity business object, and then create an integration object with the Business
Address business component under the integration object, and include the necessary MVF. For more
information about master-detail reports, see “How Master-Detail Reports Work” on page 122 and
“Creating a Master-Detail Layout Template in Microsoft Word” on page 126.

How Master-Detail Reports Work

This topic gives one example of how master-detail reports work by comparing a specific layout
template with its corresponding report. You might use the feature differently, depending on your
business model. This example compares the Service Request Activity (All) report and its
corresponding layout template.

To compare the Service Request Activity (All) report in Siebel Service with its
corresponding layout template
1 Generate the Service Request Activity (All) report in Siebel Service by performing the tasks:
a Open the Siebel Service application.

b Navigate to the Service screen, then All Service Requests across Organizations view.

NOTE: My Service Requests is the default view.

c In the All Service Requests across Organizations list, select an account, click Reports, and then
from the Reports menu, select Service Request Activity (All).

d Choose a report output type, and then click Submit.

e In the File Download dialog box, select Open.

The Service Request Activity (All) report appears in the browser window. To view this report,
see Figure 9 on page 121.

122 Siebel Reports Guide Version 8.1, Rev. C

 Using Master-Detail Reports ■ How Master-Detail Reports Work

2 Open the layout template for the Service Request Activity (All) report using Microsoft Word:

a Navigate to the \XMLP\TEMPLATES folder (or the equivalent on your computer), and then open
srvreqaa.rtf.

Notice the following features of this template as shown in the following figure:

❏ There is a table (form) for the master record

❏ There is a table (list) for each set of child records.

❏ There is a for each loop (over all master records) that includes the parent form and all
the child lists.

❏ There is a condition on the IF statement (<?if:current-group()//ssAction?>) for the

Activity section, which prevents the Activity section from displaying header information
if there are no activities for the service request.

NOTE: To identify the layout template associated with a report, use the appropriate
Template view (either Reports - Custom Templates or Reports - Standard Templates in the
Administration - BI Publisher Reports screen).

b From the Oracle BI Publisher menu, select Tools, Field Browser, and then Show All.

The Field Browser dialog box appears, which allows you to view and modify the template
logic.

Siebel Reports Guide Version 8.1, Rev. C 12 3

Using Master-Detail Reports ■ How Master-Detail Reports Work

Table 7 provides details of the Oracle BI Publisher syntax and description for the fields defined in the
example template.

Table 7. Oracle BI Publisher Syntax and Field Definitions for the Service Request Activity (All)
Report Template

Syntax Oracle BI Publisher Code Description

If <?if://ssServiceRequest?> An IF condition that checks for

service request records. If there are
no service request records, no
records are displayed.

for-eachgroup: <?for-each- The start of a group section which

ssServiceRequest group:ssServiceRequest; iterates for each record in the
position()?> Service Request data set.

ssSrNumber <?ssSrNumber?> Field mappings

ssAccount <?ssAccount?>
ssStatus <?ssStatus?

If <?if://ssCreated?> If condition that does not display the

ssCreated field if null.

ssCreated <?format- Field formatting

date:psfn:totext(ssCreated,
"yyyy-MM-dd'T'HH:mm:ss",
"MM/dd/yyyy hh:mm:ss");
'SHORT_TIME'?>
End <?end if?> End of if condition

ssSeverity <?ssSeverity?> Field mappings

ssDescription <?ssDescription?>

If <?if://ssClosedDate?> If condition that does not display the

ssClosedDate field if null.

ssClosedDate <?format- Field formatting

date:psfn:totext(ssClosedDa
te,"yyyy-MM-dd'T'HH:mm:ss",
"MM/dd/yyyy hh:mm:ss");
'SHORT_TIME'?>
End <?end if?> End of if condition

ssPriority <?ssPriority?> Field mappings

ssCustomerRefNumber <?ssCustomerRefNumber?>
ssOwner <?ssOwner?>

for-each:current-group() <?for-each:current- Start of a group section, iterating

group()?> for each record in the current group
(for example, Service Request).

124 Siebel Reports Guide Version 8.1, Rev. C

 Using Master-Detail Reports ■ How Master-Detail Reports Work

Table 7. Oracle BI Publisher Syntax and Field Definitions for the Service Request Activity (All)
Report Template

Syntax Oracle BI Publisher Code Description

If <?if:current-group()// Condition to check for Action

ssAction?> records. If there are no records, do
not display the section.

for-each:ssAction <?for-each:ssAction?> Beginning of the repeating element

group for Action.

If <?if://ssCreated?> If condition that does not display the

ssCreated field if null.

ssCreated <?format- Field formatting

date:psfn:totext(ssCreated,
"yyyy-MM-dd'T'HH:mm:ss",
"MM/dd/yyyy hh:mm:ss");
'SHORT_TIME'?>
End <?end if?> End of if condition

ssCreatedByN <?ssCreatedByName?> Field mappings

ssOwnedBy <?ssOwnedBy?>
sssStatussType <?ssType?>
ssDescription <?ssStatus?>
<?ssDescription?>
end for-each:ssAction <?end for-each?> End of the repeating element group
for Action.

End if <?end if?> The end of the if condition

end for-each <?end for-each?> End of current-group() repeating

group section.

page break <?split-by-page-break:?> Page break after the end of the

group section.

end for-each-group: <?end for-each-group?> End of Service Request group

ssServiceRequest section

End <?end if?> End if statement for conditional

check on Service Request records

If <?if:not(// If condition that prints "No Data

ssServiceRequest)?> Found" at the bottom of the report if
there are no records.

End <?end if?> End if statement for above

condition.

You can view additional information about the integration object definition (and related integration
components) in Siebel Tools. For information about viewing integration object definitions in Siebel
Tools, see Using Siebel Tools.

Siebel Reports Guide Version 8.1, Rev. C 12 5

Using Master-Detail Reports ■ Creating a Master-Detail Layout Template in Microsoft
Word

For more information about Oracle BI Publisher syntax, see Oracle Business Intelligence Publisher
Report Designer's Guide, Release 10.1.3.4 available on Oracle Technology Network (OTN). For more
information about creating master-detail templates, see “How Master-Detail Reports Work” on
page 122 and “Creating a Master-Detail Layout Template in Microsoft Word” on page 126.

Creating a Master-Detail Layout

Template in Microsoft Word
Creating a master-detail report follows the same process as creating a simple report. However,
consider the following important points when creating master-detail reports:

■ Make sure that all child integration components in the integration object have the appropriate
value in the Parent Integration Component property.

■ In the RTF template, make sure that the correct for-each-group and for-each:current-group
elements are placed in the template, see “How Master-Detail Reports Work” on page 122.

■ When creating custom integration objects for Siebel Reports, make sure that the fields used for
dynamic queries in the applet of the master component are also contained in the integration
component. Dynamic queries are specific, customized queries that you create.

To create a master-detail layout template in Microsoft Word

1 Open Microsoft Word, and create a new document.

2 Using the Oracle BI Publisher Desktop menu, select Data, and then Load XML Data.

3 Select the XML file containing the sample data, and then save the template in RTF format.

4 Add the relevant titles, formatting, page header and footer, and so on to the document.

5 Add the Master data section by doing the following:

a Insert a master data section manually, or by using the Insert menu option from the Oracle BI
Publisher Desktop menu.
b Select the master data section, and add a for-each-group section:

❏ Click Insert, Repeating Group, and then the Advanced tab.

NOTE: This process embeds the for loop within the table and does not replicate the location
of the controls in the preconfigured examples.

❏ Change the expression:

<?for-each-group:ssServiceRequest;position()?>

c (Optional) If you want to view descriptive text for the inserted sections, click Tools, Options,
Build, and then Descriptive.
6 Add the Detail data section by doing the following:

a Select the detail data section.

b From the Oracle BI Publisher menu, click Insert, and then Repeating Group.

126 Siebel Reports Guide Version 8.1, Rev. C

 Using Master-Detail Reports ■ Creating a Master-Detail Layout Template in Microsoft
Word

c Select the defaults, and then click OK.

7 Insert a page break after the final detail section by doing the following:

a Select the Oracle BI Publisher properties of the entire group.

b Navigate to Create, Group, and then Properties.

c Select a page break option.

8 Add the additional formatting features and conditions.

For more information on adding features, see “How Master-Detail Reports Work” on page 122.

9 After testing the report, register the report layout template in the usual manner.

For information about registering report layout templates, see “Registering Report Layout
Templates” on page 108.

Viewing Descriptive Text for Repeating Group Sections

When creating templates with repeating group sections, you might find it useful to view the
descriptive text for the inserted sections. Descriptive text allows you to view the Oracle BI Publisher
syntax.

To view the descriptive text for the repeating group sections

1 Start Microsoft Word.

2 From the Oracle BI Publisher application-level menu, click Options, Build, and then in the For-
each form field box, select Descriptive.

For more information about master-detail reports, see “About Master-Detail Reports” on page 121 and
“How Master-Detail Reports Work” on page 122.

Siebel Reports Guide Version 8.1, Rev. C 12 7

Using Master-Detail Reports ■ Creating a Master-Detail Layout Template in Microsoft
Word

128 Siebel Reports Guide Version 8.1, Rev. C

10 Migrating Reports
This chapter describes how to migrate reports from a development, test, or production environment
to another. The tasks in this chapter are performed by the system administrator and are for
disconnected mode only. This chapter includes the following topics:

■ Requirements for Migrating Reports on page 129

■ Process of Packaging and Migrating Reports on page 130

■ Process of Migrating an Integration Object for a Report on page 134

■ Process of Migrating New Reports after Creating New Integration Objects on page 135

Requirements for Migrating Reports

You can use Application Deployment Manager (ADM) to migrate reports from one environment to
another. When you migrate reports, you are importing data values from a source environment to a
target environment. For example, you migrate reports from the development or test environment
(source) to the production environment (target).

For more information about ADM, see Siebel Application Deployment Manager Guide. For information
about setting up your environment to use ADM for migrating reports, see “Requirements for Migrating
Reports” on page 129.

Before migrating reports from one environment to another, perform the following tasks:

1 In the source environment, make sure the reports are finalized and ready to migrate.

2 Perform the following in the source environment:

a Install Perl software (version 5.0 or later).

b Make sure you include the Application Deployment Manager (ADM) component group as part of
the Siebel Server installation process.

For more information about installing Siebel Servers, see Siebel Installation Guide for the
operating system you are using.

c Set up ADM for your particular deployment needs. In particular, you must have a Siebel
Management Server and Siebel Management Agents installed.

For more information on setting up ADM, see Siebel Installation Guide for the operating
system you are using.

Siebel Reports Guide Version 8.1, Rev. C 12 9

Migrating Reports ■ Process of Packaging and Migrating Reports

Process of Packaging and Migrating

Reports
The Application Deployment Manager (ADM) packaging process prepares the report template data
for migration by consolidating the information into a single deployment package. This deployment
package is the functional entity used by the ADM framework to stage and execute the deployment.
The deployment package is a set of files representing the report files, held in a predefined package
directory, together with a package descriptor file holding details of the package contents.

To migrate XML files along with their associated SIF objects, you must specify the repository SIF
object and the XML file for packaging. After the migration of the integration objects is called, the SIF
objects and the XML files are migrated together.

To migrate reports from one environment to another:

1 Make sure you have met the necessary requirements for migrating reports.

For information about these requirements, see “Requirements for Migrating Reports” on page 129.

2 “Packaging the Report Files in the Source Environment” on page 130

3 “Migrating the Report Files to the Target Environment” on page 131

4 “Packaging Report Database Records in the Source Environment” on page 132

5 “Migrating Report Database Records to the Target Environment” on page 133

Packaging the Report Files in the Source Environment

This topic describes how to package the report files in the source environment.

This task is a step in “Process of Packaging and Migrating Reports” on page 130.

The following procedure assumes that your reports are finalized and available in the source
environment.

To package the report files

1 Manually copy the files that you want to migrate from the source environment Siebel Server
installation directory (SIEBSRVR_ROOT\XMLP) to the following target environment:

SharedFolder\PackageName\file\siebsrvr\XMLP\<subdirectory_name>

where:

SharedFolder is a shared folder on the deployment computer.

PackageName is the name of the ADM package folder that contains the report files to be
migrated.

file is the type of file, such as database, repository, and so on.

siebsrvr\XMLP<subdirectory_name> is the Siebel Server folder structure.

130 Siebel Reports Guide Version 8.1, Rev. C

 Migrating Reports ■ Process of Packaging and Migrating Reports

a Copy the XML files to the following directory:

SharedFolder\PackageName\file\AppServer\XMLP\DATA

b Copy the RTF and XSL files to the following directory:

SharedFolder\PackageName\file\AppServer\XMLP\TEMPLATES

c Copy the XLIFF files to the following directory:

SharedFolder\PackageName\file\AppServer\XMLP\enu\xliff

2 Run the following command to generate a descriptor file for the package:

admpkgr generate "shared folder\package name"

where:

SharedFolder\PackageName is the shared folder and package name in which the packages to be
migrated reside.

Migrating the Report Files to the Target Environment

This topic describes how to migrate the report files to the target environment.

This task is a step in “Process of Packaging and Migrating Reports” on page 130.

To migrate the report files to the target environment

1 Navigate to the installation folder where the Siebel Management Server is installed.

2 Run the following command to create a package folder structure:

admpkgr init SharedFolder\PackageName

where:

SharedFolder\PackageName is the shared folder package name in which the packages to be

migrated reside.

NOTE: You must specify a path in a shared location.

TIP: If an error occurs, you might have an invalid path to the JAR files. To resolve this error,
make sure the CLASSPATH variable points to the exact location of the JAR files in the
admpkgr.bat file in the Management Server installation folder.

3 Run the following command to call the deploy.bat file to load the package to the server database:

deploy_enterprise load username password PackageName

where:

■ deploy_enterprise is of the form deploy_enterprise, where enterprise is replaced by the

enterprise name given by the user at the time of the configuration.

Siebel Reports Guide Version 8.1, Rev. C 13 1

Migrating Reports ■ Process of Packaging and Migrating Reports

■ username and password are the username and password account of the Siebel user who is
deploying the package.

■ PackageName is the name of the package for which the descriptor was created in Step 2 on
page 131.

4 Run the following command to create a session for the deployment:

deploy_enterprise create username password PackageName

5 Run the following copy command to complete the deployment of the sample package:

deploy_enterprise copy username password PackageName

6 In the destination Siebel Server folder ( siebsrvr\XMLP), verify that the files you placed in the
deployment package (as described in Step 1 on page 130) are available in the appropriate
folders.

Packaging Report Database Records in the Source

Environment
This topic describes how to use Application Deployment Manager (ADM) to package report database
records.

This task is a step in “Process of Packaging and Migrating Reports” on page 130.

To package report database records

1 Navigate to the Application Deployment Manager screen, then the Deployment Projects view.

2 In the Deployment Projects list, create a new project record.

3 Fill in the project fields as necessary, making sure to check the Export to File field to create the
export file.

For descriptions of the projects fields, see Siebel Application Deployment Manager Guide.

NOTE: It is recommended that you name your report projects with a BIP prefix. This prefix
allows you to search for your report projects.

4 In the Deployment Filter field in the Deployment Project data type list, create search expressions
for the data types to filter only those items of a data type that match the condition for migration.
Save each filter.

For example, if you create a report in the source environment and that report is:

■ Named Test Account List

■ Based on the BIP Accounts - Current Query integration object

132 Siebel Reports Guide Version 8.1, Rev. C

 Migrating Reports ■ Process of Packaging and Migrating Reports

■ Associated with the Account List view

You enter the following filter information to migrate the data types to the target environment:

Data Type Filter

BIP Sample Data Generation [Name]=' BIP Accounts - Current Query'

BIP Report Template Registration [Report Name]=' Test Account List'

BIP View Association [Name]=' Account List View'

BIP Report Template Translations [Report Name]=' Test Account List'

NOTE: If the data type of interest is not available, it might be set as Inactive. Make sure the
Active field for the data type is checked in the Data Type Details view.

This step allows you to query the reports being migrated to the target environment.

5 Enable the report project by performing the following:

a Navigate to the Deployment Projects view.

b In the Deployment Projects list, select the draft deployment.

The Status field of the draft deployment project record appears as Draft.

c Click the Enable button to activate the report project.

ADM populates the Status field with Enabled and the Publication Date/Time field with the date
and time of the report project activation.

6 Export the reports by performing the following:

a Navigate to the Application Deployment Manager screen, then the Deployment Sessions view.

b Select the newly enabled report project, and make sure the Export to File and the Deployment
Lock fields are checked.
c Enter a shared location to store the XML files that contain the database records.

d Click Deploy.

The database record XML files are exported to the shared location.

Migrating Report Database Records to the Target

Environment
Use the following procedure to migrate report database records from the source environment to the
target environment.

To migrate report database records to the target environment

1 Navigate to the Application Deployment Manager screen, then the Deployment Sessions view.

Siebel Reports Guide Version 8.1, Rev. C 13 3

Migrating Reports ■ Process of Migrating an Integration Object for a Report

2 Click the Deployment Sessions Menu button, and select Deploy from File.

3 In the Deploy from File dialog box, enter the file paths from which to migrate the database
records by doing the following:

a Enter the file path for the XML file that contains the Sample Data Generation file, and then click
Import.

b Enter the file path for the XML file that contains the Report Template Registration file, and then
click Import.

c Enter the file path for the XML file that contains the View Association file, and then click Import.

NOTE: Make sure to specify the shared location where the database records are stored.

For example, you might enter the following shared locations:

■ \\sharedlocation\88-25ZC7_BIP_Sample_Data_Generation.xml

■ \\sharedlocation\88-25ZC7_BIP_Report_Template_Registration.xml

■ \\sharedlocation\88-25ZC7_BIP_View_Association.xml

4 In the target environment, make sure the data was migrated correctly by verifying that the
report appears in the Reports menu.

For example, in Step 4 on page 132 in the “Packaging Report Database Records in the Source
Environment” you created a report named Test Account List. To verify that report migrated
correctly, navigate to the Accounts screen, and then the Account List view. Click Reports to verify
the Test Account List report appears in the Reports menu.

Process of Migrating an Integration

Object for a Report
This topic describes how to migrate integration objects for reports from the source environment.

NOTE: The following process assumes you have created a new integration object that has yet to be
migrated.

To migrate an integration object for a report, perform the following tasks:

1 Create and export a SIF file for the integration object by doing the following:

a Log in to Siebel Tools.

b In the Object Explorer, select Integration Object.

c In the Integration Object list, right-click the integration object for which you want to create the
SIF file, and then click Add to Hot Fix.
d In the Generate Hot-Fix dialog box, enter a label, and then click Export.

A directory containing this SIF file is placed in the Tools\ADM directory.

134 Siebel Reports Guide Version 8.1, Rev. C

 Migrating Reports ■ Process of Migrating New Reports after Creating New Integration
Objects

2 Copy the SIF and descriptor files in the repository folder of the ADM package that was created
when you ran the admpkgr init command.

For more information about generating the command, see “Packaging the Report Files in the
Source Environment” on page 130.

3 Perform the steps as described in “Packaging the Report Files in the Source Environment” on
page 130.

NOTE: If there is no report for this integration object and there are no plans to move a report
for this integration object, you can skip Step 1 on page 130.

4 Verify that the integration object was moved to the target environment, perform the following:

a Log in to the target environment computer.

b Navigate to the Administration - BI Publisher Reports screen, then the Sample Data File
Generation view.

c Make sure the integration object appears in the Sample Data File Generation list.

Process of Migrating New Reports after

Creating New Integration Objects
This topic describes how to migrate reports if you create new reports based on newly created
integration objects.

To migrate a new report after creating a new integration object, perform the following:

1 Perform the procedure in “Process of Migrating an Integration Object for a Report” on page 134.

2 Generate the XML data file for the report as described in “Generating Sample XML Data Files for
Siebel Reports” on page 105.

3 Copy the database record files in the related package folder along with the SIF file, and then
migrate them.

Siebel Reports Guide Version 8.1, Rev. C 13 5

Migrating Reports ■ Process of Migrating New Reports after Creating New Integration
Objects

136 Siebel Reports Guide Version 8.1, Rev. C

11 Parameterized Reports
This chapter describes parameterized reports and how they work. The topics in this chapter include:

■ About Parameterized Reports on page 137

■ About Defining Parameters in the Report Layout Template on page 138

■ About Referencing Parameters in the Report Layout Template on page 138

■ How Parameterized Reports Are Generated on page 139

■ Example of Generating a Parameterized Report on page 140

For instructions for creating reports and layout templates, see Chapter 7, “Creating Reports.”

About Parameterized Reports

Parameterized reports allow you to pass data into an Oracle Business Intelligence (BI) Publisher RTF
report template at run time and customize the report output.

NOTE: Parameterized reports are available only in connected mode. For more information about the
connection modes in relation to Siebel Reports, see “About the Siebel Reports Architecture” on
page 25.

Parameterized reports allow you to:

■ Narrow the query, sort specification, or grouping by a field for report execution.

■ Produce different reports from the same report template.

The administrator defines the parameters and the attributes of the report template during design
time. A parameter is a name/value pair that defines certain criteria. Each parameter can have a
default value, only one value, or a blank value.

RTF templates can have many parameters of the following two types:

■ Simple string. A user-defined value or default value defined in the template.

■ Pick list. In pick lists, predefined values are available for user selection with no arbitrary input.

NOTE: You cannot schedule parameterized reports.

Related Topics
“About Defining Parameters in the Report Layout Template” on page 138

“About Referencing Parameters in the Report Layout Template” on page 138

“How Parameterized Reports Are Generated” on page 139

“Example of Generating a Parameterized Report” on page 140

Siebel Reports Guide Version 8.1, Rev. C 13 7

Parameterized Reports ■ About Defining Parameters in the Report Layout Template

About Defining Parameters in the Report

Layout Template
Parameters are most commonly used for controlling the layout of the report, such as dynamic
grouping or dynamic sections, depending on the parameter. You can also use parameters to filter
data in the template, but this action is not recommended for performance reasons. It is more efficient
to filter records in the Siebel UI using a query than in the report template.

You must define template parameter definitions at the beginning of an RTF report template. When
defining a default parameter value that contains a space character, wrap the parameter declaration
in both double and single quotation marks, see the following example:

<?param@begin: Param1;"'default value'";'string'?>

Table 8 provides the values to use for specific parameter types.

Table 8. Template Parameter Value Definitions

Parameter Value

A string parameter with a default value of <?param@begin: Param1;'default_value';'string'?>

default_value

A string parameter without a default value <?param@begin: Param2?>

A picklist parameter containing the values <?param@begin: Param3;'One';'string';'One,Two'?>

One and Two, with a default value of One

Related Topics
“About Parameterized Reports” on page 137

“About Referencing Parameters in the Report Layout Template” on page 138

“How Parameterized Reports Are Generated” on page 139

“Example of Generating a Parameterized Report” on page 140

About Referencing Parameters in the

Report Layout Template
You control the layout of RTF report templates using parameter values. For information about
parameter syntax and usage, see about defining parameters topic in the Oracle Business Intelligence
Publisher Report Designer's Guide Release 10.1.3.4 available on Oracle Technology Network
(OTN).
You use template parameters within a report layout template to dynamically change the layout of
the report using conditions based on the parameter value. Some examples are:

■ Control the sorting pattern in a table. You can select a column name for sorting.

138 Siebel Reports Guide Version 8.1, Rev. C

 Parameterized Reports ■ How Parameterized Reports Are Generated

■ Control the grouping pattern in a table. You can select a column name for the group.

■ Render data rows in different colors by defining a user-specified field (such as ACTIVE_STATUS).

TIP: To test that the parameters are passed through correctly, you can display user input directly
on the report. In this manner, you can verify Oracle BI Publisher received the correct user input, but
there is no impact on the report layout controls.

Use the following syntax to display the run-time parameter values on the report output for the
example parameters defined in Table 8 on page 138:

Param1 = <?$Param1?>

Param2 = <?$Param2?>

Param3 = <?$Param3?>

Related Topics
“About Parameterized Reports” on page 137

“About Defining Parameters in the Report Layout Template” on page 138

“How Parameterized Reports Are Generated” on page 139

“Example of Generating a Parameterized Report” on page 140

How Parameterized Reports Are

Generated
Parameterized reports allow you to pass data into a report layout template at run time and customize
the output of that report. The user can narrow the query, sort specification, or grouping by a field
at the report’s execution time. A parameterized report can produce many different reports from the
same report template. This topic describes how parameterized reports are generated.

You generate parameterized reports the same as you generate other reports. But, when requesting
a parameterized report and the report template contains optional parameters, the parameters
appear in the Run Report list applet allowing you to enter those parameters. After entering the
parameters and clicking Submit, the report is executed. The parameters you can define include the:

■ Parameter name as defined in the template

■ Pick values. This parameter type allows for user select values, but no free input.

■ Input of string type parameter, but this is only available when this parameter is of string type.

Related Topics
“About Parameterized Reports” on page 137

“About Defining Parameters in the Report Layout Template” on page 138

“About Referencing Parameters in the Report Layout Template” on page 138

“Example of Generating a Parameterized Report” on page 140

Siebel Reports Guide Version 8.1, Rev. C 13 9

Parameterized Reports ■ Example of Generating a Parameterized Report

Example of Generating a Parameterized

Report
This topic gives one example of generating a Siebel report. You might use this feature differently,
depending on your business needs.

In this example, assume you have created a parameterized report and want to generate that report
in pdf format.

To generate a parameterized report

1 Navigate to the application view that the parameterized report is associated with.

2 Run a query to limit the number of records returned, and then click Submit.

3 Select the parameterized report from the Reports menu.

NOTE: If this parameterized report has parameters defined, the Siebel application retrieves
them from the template on the Oracle BI Publisher Server at run time.

4 From the pop-up applet, select the output file type, enter the parameters, and then click submit.

The report is generated by the Oracle BI Publisher Server, and then transferred to the Siebel
application screen.

Related Topics
“About Parameterized Reports” on page 137

“About Defining Parameters in the Report Layout Template” on page 138

“About Referencing Parameters in the Report Layout Template” on page 138

“How Parameterized Reports Are Generated” on page 139

140 Siebel Reports Guide Version 8.1, Rev. C

A Troubleshooting Siebel Reports

This appendix describes how to enable logging for the various Siebel Reports components and
provides common error messages that might occur when generating these reports.

It contains the following topics:

■ Enabling Logging for the XMLP Report Server Component on page 141

■ About Enabling Logging for the Oracle BI Publisher Server on page 143

■ Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode on page 143

■ Resolving Class Not Found Errors When Previewing Reports in Microsoft Word on page 144

■ Troubleshooting Error Messages for Siebel Reports on page 146

NOTE: Oracle Business Intelligence Publisher (Oracle BI Publisher) for Siebel Business Applications
logs all exceptions and debug level information.

Enabling Logging for the XMLP Report

Server Component
You can configure Siebel Business Applications to create log files that capture detailed information
about errors that occur while generating reports. The reports administrator can use the log files to
investigate why the error occurred.

You set the log level for the XMLP Report Server component by using the Server Manager UI or the
Server Manager command-line interface program (srvrmgr program).

NOTE: You can adjust the log levels at any time.

Setting the Log Level for the XMLP Report Server Component Using
the Server Manager UI
Use the following procedure to set the log level for the XMLP Report Server component using the
Server Manager UI.

To set the log level for the XMLP Report Server component using the Server Manager
UI
1 Navigate to the Administration-Server Configuration screen, Servers, and then the Components
view.

2 In the Component field, query for XMLP Report Server, and then click the Events view tab.

3 In Events list, query for XMLP Report Log, and then set the log level value to 5.

4 Click the Component tab.

Siebel Reports Guide Version 8.1, Rev. C 14 1

Troubleshooting Siebel Reports ■ Enabling Logging for the XMLP Report Server
Component

5 In the Component field, query for Call Center Object Manager (ENU), and then click the Events
tab.

6 In the Events list, query for XMLP Report Log, and then set the log level value to 5.

7 Stop and restart the XMLP Report Server and Call Center Object Manager (ENU) server
components.

For more information about restarting the Siebel Server, see Siebel System Administration Guide.

Setting the Log Level for the XMLP Report Server Component Using
Server Manager
Use the following procedure to set the log level for the XMLP Report Server component using Server
Manager (srvrmgr).

To set the log level for the XMLP Report Server component using Server Manager
1 Run the following command to connect to the Siebel Server Manager:

srvrmgr /g <gateway machine name:port number> /s <xmlp siebel server name>

/e <enterprise> /u <user name> /p <password>

where:

gateway machine name:port number is the name of the physical computer on which the Siebel
Gateway Name Server is running and the port number on which the Gateway Name Server is
listening.

NOTE: The colon and port number are optional if using an optional default port.

xmlp siebel server name is the name of the server on which the XMLP Report Server component
is enabled.

user name is the login name of the administrator.

password is the password for the administrator.

For example, you might use the following command:

srvrmgr /g <gateway machine name>:2330 /s <xmlp siebel server name> /e Siebel

/u SADMIN /p MSSQL

2 Run the following command to change the event log level:

change evtloglvl XMLPReportLog=5 for comp xmlpreportserver

where 5 is the event log level that you want to change.

For example, to get details for a call to a business service, run the following command:

change evtloglvl ObjMgrBusServiceLog=5 for comp xmlpreportserver

3 Shut down the XMLP Report Server component and then restart this component to make sure
logging changes take effect.

142 Siebel Reports Guide Version 8.1, Rev. C

 Troubleshooting Siebel Reports ■ About Enabling Logging for the Oracle BI Publisher
Server

About Enabling Logging for the Oracle BI

Publisher Server
You can configure the Oracle BI Publisher Server to create log files that capture detailed information
about errors that occur while generating Siebel Reports in connected mode. The administrator can
use the log files to understand how much time it takes for a report to render and so on.

For information about enabling logging for the Oracle BI Publisher Server, see the chapter about
setting the system maintenance options in Oracle Business Intelligence Publisher Administrator's and
Developer's Guide, Release 10.1.3.4 available on Oracle Technology Network (OTN).

Enabling and Disabling Debugging for

Siebel Reports in Disconnected Mode
You can configure the Oracle BI Publisher XDO Engine to create log files that capture detailed
information about errors that occur while generating Siebel Reports in disconnected mode. The
administrator can use the log files to learn when there are report generation problems with the JAR
(Java ARchive) files or the Oracle BI Publisher (RTF) layout templates.

Enabling Debugging for Siebel Reports in Disconnected Mode

Use the following procedure to enable debugging for the Oracle BI Publisher XDO Engine.

To enable debugging for Siebel Reports in disconnected mode

1 In a text editor such as Notepad, create a new file entitled, xdodebug.cfg, and type in the
following for use as a sample file:

LogLevel=STATEMENT

LogDir=<path to logging directory>

2 Place the file in the jre\lib directory used by the Siebel client (for example, C:\Program
Files\Java\jre1.6.0_07\lib) and make sure that the directory specified by the LogDir
parameter exists. The resulting log files from the report generation will be created at this
location.

If an error occurs while generating reports in disconnected mode, an xdo.log file is created and saved
to the path specified in the .cfg file. Use this log file for troubleshooting.

Siebel Reports Guide Version 8.1, Rev. C 14 3

Troubleshooting Siebel Reports ■ Resolving Class Not Found Errors When Previewing
Reports in Microsoft Word

Disabling Debugging for Siebel Reports in Disconnected Mode

To optimize the performance of Siebel Reports in disconnected mode, you might want to disable
debugging for the Oracle BI Publisher XDO Engine.

To disable debugging for disconnected mode

1 On the computer where Oracle’s Siebel Developer Web Client is installed, copy the xdo.cfg in the
jre\lib installation folder to another computer for backup purposes.

2 Remove or rename the xdo.cfg in the jre\lib directory used by the Siebel client.

Resolving Class Not Found Errors When

Previewing Reports in Microsoft Word
Errors can occur when previewing reports with Microsoft Word that use preconfigured RTF templates.

Resolving Class Not Found Errors When Previewing Reports in

Microsoft Word
To resolve the Class not found error when previewing reports in Microsoft Word, you create a custom
batch file to launch Microsoft Word and load the required template libraries before opening the RTF
template.

NOTE: In your batch file, replace the explicit drive and folder locations with those on your own
computer based on where you installed the Siebel Web Client.

Observe and adhere to the following guidelines when resolving Class not found errors:

■ Make sure there are no spaces or new line character after the -Xbootclasspath/a: string. For
example, this string might appear as follows:

■ set_JAVA_OPTIONS=-Xbootclasspath/a:C:\81DQSSIA\client\classes…)
■ To check the syntax, turn off word wrapping in the editor you are using so that set
_JAVA_OPTIONS is a single line. You must have three distinct lines in your batch file if word
wrapping is turned off.

■ Check the path to Microsoft Word that the batch file references.

■ Search for winword.exe from C:\Program Files to find the path.

■ The %1 in the batch file is an argument to represent a document that is typically opened in
Microsoft Word (RTF files).

■ Do not use set _JAVA_OPTIONS as a system environment variable because this prevents you from
previewing reports in the Siebel client.

To resolve Class not found errors when previewing reports in Microsoft Word
1 Navigate to C:\Program Files.

144 Siebel Reports Guide Version 8.1, Rev. C

 Troubleshooting Siebel Reports ■ Resolving Class Not Found Errors When Previewing
Reports in Microsoft Word

2 Create a MSWordForBIPub.bat file containing the following code to set the _JAVA_OPTIONS
environment variable before launching Microsoft Word.

echo %1

set _JAVA_OPTIONS=-Xbootclasspath/a:

C:\81DQSSIA\client\classes\SiebelXMLP.jar;C:\81DQSSIA\client\
classes\siebel.jar;C:\81DQSSIA\client\classes\XSLFunctions.jar;C:\81DQSSIA\
client\classes\SiebelCustomXMLP.jar;C:\81DQSSIA\client\classes\SiebelCustomXMLP
_SIA.jar

"C:\Program Files\microsoft office\Office\Winword.exe" %1

TIP: Create a shortcut to the MSWordForBIPub.bat batch file and move it to your desktop.

3 If you want to make sure this batch file is always executed when opening a preconfigured report
layout template, you associate the RTF files with the .bat file by doing the following:

a Navigate to the template files in your Siebel client environment. (For example,
C:\Siebel\client\XMLP\TEMPLATES)
b Sort the templates files by Type.

c Right-click on a RTF file (or select all) and Select Open With to choose an text editor.

d Click Browse to find the .bat file, and then open it.

e Check the Always use the selected program to open this kind of file checkbox, and then click OK.

This associates the selected RTF file or files with the batch file created in Step 2 on page 145.
The batch file sets an environment variable needed for publishing Oracle BI Publisher reports
from within Microsoft Word.

Additional Notes
The following provides additional information about this topic:

■ There is no requirement to associate .doc extensions with this batch file.

■ This workaround automatically associates the RTF file with the batch file. Now, when you double-
click a RTF file, you see a command prompt window (running the batch file) automatically run at
the same time. Alternatively, you can go to the desktop shortcut icon and run the shortcut to the
.bat file to test the report preview.

■ Many delivered RTF files in the Siebel client Templates directory

(C:\siebel\client\XMLP\TEMPLATES) are set to read only. Before previewing reports from this
directory, go to Properties for the applicable template and remove the Read-only attribute to
avoid run-time errors.

Siebel Reports Guide Version 8.1, Rev. C 14 5

Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Troubleshooting Error Messages for

Siebel Reports
Table 9 contains the error messages that you might encounter when using Siebel Reports and the
suggested solutions for resolving the errors.

Table 9. Resolving Siebel Reports Error Messages

Connection
Error Message or Symptom Description and Solution Mode

SBL-OMS-00203: Error <?> invoking This error occurs when you fail to upload the Connected
method "<?>" for Business Service template to the Oracle BI Publisher Server. and
"<?>" disconnected
To resolve, see “Troubleshooting Errors While
Running Siebel Reports (SBL-OMS-00203)”
on page 151.

"Unable to find definition for This error occurs after clicking Submit to Connected
component XMLPReportServer(SBL- generate a report. and
SRQ-00103)" error when I clicked on disconnected
To resolve, see “Troubleshooting Error After
the Submit button to generate the
Clicking Submit to Generate a Report (SBL-
report."
SRQ-00103)” on page 151.

The specialized method 'GetFileToDir' This error occurs when the path settings in Connected
is not supported on Business the configuration files are incorrect. and
Component 'Report Template BC' disconnected
To resolve, see “Troubleshooting Errors That
used by Business Object 'Report
Occur Due to Incorrect Configuration File
Administration'.
Settings (SBL-DAT-00322)” on page 151.
(SBL-DAT-00322)

SBL-RPT-50504: Error occurred while This error occurs when users forget to Disconnected
saving the record. No data file provide a sample XML data file for only
provided for XLIFF generation. generating an XLIFF file.

To resolve, see “Troubleshooting XLIFF File

Errors” on page 152.

"Class name incorrect" error when This error occurs when Oracle BI Publisher Disconnected
generating BI Publisher reports or the JAR files are not loaded. only

To resolve, set the classpath, see

“Troubleshooting the CLASSPATH Settings
Using Siebel Server Manager” on page 153.

146 Siebel Reports Guide Version 8.1, Rev. C

 Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Table 9. Resolving Siebel Reports Error Messages

Connection
Error Message or Symptom Description and Solution Mode

Reports having custom java class Verify that SiebelCustomXMLP.jar, Connected

involved are not generating. SiebelXMLP.jar are under only
SIEBSRVR_ROOT\classes.
Make sure that the Oracle BI Publisher
Server path is:

$OC4J_PATH\j2ee\home\applications\
xmlpserver\xmlpserver\WEB-INF\lib.

For Siebel Industry Applications, make sure

the following files are in both paths:

■ SiebelCustomXMLP_SIA.jar

■ SiebelXMLP.jar

][java.lang.String][EXCEPTION] This error appears in the Oracle BI Publisher Not

oracle.apps.xdo.XDOException: log file or console when generating a report applicable
XSLT10gR1: Failed Secure Java when the JAR files have not been copied to
Extensions check. the Oracle BI Publisher Server, or the
required Disable External Reference
parameter attribute has not been set to
FALSE.

To resolve, see “Changing the Location of the

Oracle BI Publisher Repository for Siebel
Reports” on page 45.

Verify the BIP Server Userid and This error message appears in the XMLP log Connected
Password. (SBL-RPT-50529) or file, because the user has not provided the only
correct User ID and password for the Oracle
Failed to log into BI Publisher: invalid
BI Publisher Server in the XMLP Report
username or password.
Server component parameters.

To resolve, see “Troubleshooting Oracle BI

Publisher Server Login Errors” on page 153.

Generic Error in Compression Verify whether the temp\xmlp directory Connected

Routine (SBL-UIF-00227) exists in the Siebel Server root directory and
(SIEBSRVR_ROOT). If it does not, create one. disconnected
Also make sure the Siebel File System is set
appropriately. For information about setting
the Siebel File System, see Siebel System
Administration Guide.

Siebel Reports Guide Version 8.1, Rev. C 14 7

Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Table 9. Resolving Siebel Reports Error Messages

Connection
Error Message or Symptom Description and Solution Mode

PublicReportService::executeCreate Make sure that the report name does not Connected
Report Failure: due to Report Name contain the following special characters: only
contains special characters for report
■ Forward slash (/)

■ Backslash (\)

■ Double quote (")

■ Single quote (')

■ Tilde (~)

■ Ampersand (&)

■ Asterisk (*)

■ Plus sign (+)

■ Left angle bracket (<)

■ Right angle bracket (>)

■ Percent sign (%)

SBL-EAI-04308: Operation This error occurs when you execute a report Connected
'runReport' of Web Service 'http:// that has missing bits on the Oracle BI only
xmlns.oracle.com/oxp/service/ Publisher Server (such as the .xdo file).
PublicReportService.PublicReportSer
To resolve, upload the layout template from
viceService' at port
Oracle BI Publisher using the Report
'PublicReportService' failed with the
Template Registration view. For more
following explanation:
information about uploading layout
"oracle.apps.xdo.webservice.
templates, see “Registering Report Layout
exception.OperationFailedException:
Templates” on page 108.
PublicReportService::
generateReport failed: due to
oracle.apps.xdo.servlet.
CreateException: Report definition
not found:/SiebelCRMReports/
<Report Name>/<Report
Name>.xdo".

148 Siebel Reports Guide Version 8.1, Rev. C

 Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Table 9. Resolving Siebel Reports Error Messages

Connection
Error Message or Symptom Description and Solution Mode

Alignment issues with columns with The problem occurs when the table header Connected
HTML file output type row and the data row are composed of two and
different tables with no space between disconnected
them. HTML, and sometimes EXCEL, might
generate output with alignment issues.

NOTE: There are two tables, one for Table

Header and one for Data Row. But they look
like one single table, because there is no
space between the two tables.

To resolve, see “Troubleshooting Alignment

Problems in HTML Output” on page 153.

Alignment issue with JPN/PSJ The PPT output type for Japanese (JPN) is Connected
environment in the reports. distorted in generated reports. Create the only
font mappings for the Oracle BI Publisher
Server to make sure that the HTML output
appears correctly.

To resolve, see “Troubleshooting Japanese

Font Errors” on page 154.

Siebel Reports Guide Version 8.1, Rev. C 14 9

Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Table 9. Resolving Siebel Reports Error Messages

Connection
Error Message or Symptom Description and Solution Mode

SBL-EAI-05010: Class name This error occurs while uploading files to

incorrect or does not extend Oracle BI Publisher.
SiebelBusinessService : com/siebel/
To resolve, verify the following:
data/SiebelPropertySet -- JVM
Exception:java.lang.NoClassDefFoun ■ JAVA_HOME variable is set correctly.
dError: com/siebel/data/
SiebelPropertySetObjMgrBusService ■ The following JAR files (Siebel.JAR,
Log SiebelXMLP.JAR, XSLFunctions.JAR,
SiebelCustomXMLP.JAR, and
Object manager error: ([0] Class SiebelCustomXMLP_SIA.JAR) are copied
name incorrect or does not extend from the following directory:
SiebelBusinessService : <?>
siebelroot\classes\original
Then make sure they are copied to the
following directory:

ORACLE_HOME\j2ee\home\
applications\xmlpserver\xmlpserve\
WEB-INF\lib

■ The CLASSPATH variable is set correctly

in the JVMSubSys profile.

■ The JVM SubSystem Name parameter

for XMLPReportServer is set to
XMLPJvmSubsys.

NOTE: If this value is JAVA, override it.

SBL-EAI-04308: Operation This error occurs while uploading files to

'uploadReport' of Web Service 'http:/ Oracle BI Publisher.
/xmlns.oracle.com/oxp/service/v11/
This error indicates that the Oracle BI
PublicReportService.PublicReportSer
Publisher Server already has a copy of the
viceService' at port
file that is currently being uploaded. The
'PublicReportService_v11' failed with
uploadReport method does not support
the following explanation:
uploading a new version of an existing file.
"oracle.apps.xdo.webservice.excepti
on.InvalidParametersException: To resolve, the administrator must either
PublicReportService::executeUpload rename or delete the folder for the existing
Report Failure: Due to Report with instance of the report on the Oracle BI
Path [/SiebelCRMReports/Application Publisher Server. The Oracle BI Publisher
Activity/Application Activity.xdo] Server stores the report layout templates
already exist!". in:

ORACLE_HOME\xmlp\XMLP\Reports\
SiebelCRMReports

150 Siebel Reports Guide Version 8.1, Rev. C

 Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Troubleshooting Errors While Running Siebel Reports (SBL-OMS-

00203)
Use the following procedure if errors occur while generating Siebel Reports (error message SBL-OMS-
00203).

To troubleshoot errors while generating Siebel Reports

1 Make sure the XMLP Report Server component is enabled.

2 Increase the XMLP Report Server component log level to 5 to create a more detailed log file.

3 Copy the xdodebug.log file to the jre\lib directory.

For information about performing these tasks, see “Enabling Logging for the XMLP Report Server
Component” on page 141 and “Enabling and Disabling Debugging for Siebel Reports in Disconnected
Mode” on page 143.

Additionally, you might encounter an instance where a layout template was registered with one
database, but you generated it with a different database, and the generation fails. If this error
happens, you must complete the following task.

To regenerate and rerun the report

1 Regenerate the XML data.

2 Reregister the layout template.

3 Regenerate the report.

Troubleshooting Error After Clicking Submit to Generate a Report

(SBL-SRQ-00103)
Use the following procedure if an error occurs after clicking Submit to generate a report (error
message SBL-SRQ-00103).

To troubleshoot if an error occurs after clicking Submit to generate a report

1 Enable and synchronize the XMLPReportServer component.

For information about enabling this component, see Siebel System Administration Guide.

2 Restart the Siebel Server.

For information about restarting the Siebel Server, see Siebel System Administration Guide.

Troubleshooting Errors That Occur Due to Incorrect Configuration File

Settings (SBL-DAT-00322)
Use one of the following procedures to correct errors that occur due to incorrect configuration file
settings (error message SBL-DAT-00322).

Siebel Reports Guide Version 8.1, Rev. C 15 1

Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

To troubleshoot for errors when in connected mode

1 Make sure Siebel File System path is correct by doing the following:

a Navigate to the Administration - Server Configuration screen, Servers, and then the Components
view.
b Query for the Callcenter Object Manager (or other application specific Object Manager, like Siebel
Sales or Siebel Service).

c Click the Parameters view tab, and then query for FileSystemManager, and then click Advanced.

d In Siebel File System field, provide the path as \\<machine name>\fs.

e Make sure that the fs directory exists in the D: drive and also that it is shared.
2 Restart the Siebel Server.

3 Verify that the File System component is running.

4 Verify that CLASSPATH is set in the JVMSubSys profile parameter.

5 Verify that all the required JAR files are included and available in the CLASSPATH.

6 Verify that the CLASSPATH separator is in the correct format for Windows or UNIX.

In UNIX, the CLASSPATH separator is a colon (:). In Windows, the CLASSPATH separator is a
semicolon (;).

To troubleshoot for errors when in disconnected mode

1 In the application .cfg file, search for FileSystem, and then add \\<machine name>\fs\att as the
value, making sure the fs directory is shared.

2 In the [XMLPReports] section of the .cfg file, make sure this section is defined as follows:

[XMLPReports]
XdoDir = /xmlp/templates/
ReportOutputDir = /xmlp/reports/
ReportDataDir = /xmlp/data/

3 To check whether the file system path is set properly, try to register the template.

If registering the template is successful, you can drill down on the generated XLIFF file. If either
browsing the template fails or the drilldown fails, this means that the file system path is not set
appropriately.

Troubleshooting XLIFF File Errors

Use the following procedure when users forget to provide a sample XML data file when generating
XLIFF files.

To troubleshoot XLIFF errors

1 Navigate to the Administration - BI Reports screen, then the Sample Data File Generation view.

2 Select the integration object associated with the report, and then click Generate Sample XML.

152 Siebel Reports Guide Version 8.1, Rev. C

 Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Troubleshooting the CLASSPATH Settings Using Siebel Server

Manager
Use the following procedure to change the CLASSPATH parameter using the Siebel Server Manager
utility.

To change the CLASSPATH parameter using Siebel Server Manager

1 Log in to the Server Manager command-line interface (srvrmgr program).

For information on how to start and use the srvrmgr program, see the Siebel System
Administration Guide.

■ Execute the following command to change the CLASSPATH:

change param CLASSPATH=SIEBSRVR_ROOT\classes\SiebelXMLP.jar;SIEBSRVR_ROOT\classes\

xdoparser.jar;SIEBSRVR_ROOT\classes\fix6312772.jar;SIEBSRVR_ROOT\classes\
xdocore.jar;SIEBSRVR_ROOT\classes\xmlparserv2-904.jar;SIEBSRVR_ROOT\classes\
versioninfo.jar;SIEBSRVR_ROOT\classes\share.jar;SIEBSRVR_ROOT\classes\jewt4.jar;
SIEBSRVR_ROOT\classes\jdbc12.jar;SIEBSRVR_ROOT\classes\i18nAPI_v3.jar;
SIEBSRVR_ROOT\classesvcollections.jar;SIEBSRVR_ROOT\classes\bipres.jar;
SIEBSRVR_ROOT\classes\bicmn.jar;SIEBSRVR_ROOT\classes\Siebel.jar;
SIEBSRVR_ROOT\classes\XSLFunctions.jar;SIEBSRVR_ROOT\classes\SiebelCustomXMLP.jar
for named subsystem XMLPJvmSubsys

Troubleshooting Oracle BI Publisher Server Login Errors

Use the following procedure when Oracle BI Publisher login errors occur.

To troubleshoot Oracle BI Publisher Server login errors

1 Navigate to the Administration - Server Configuration screen, then the Servers view.

2 Click the Component view tab, and query for XMLP Report Server.

3 Click the Parameters view tab, query for BIP Server Login, and then enter (or verify) the correct
login information for the Oracle BI Publisher Server.

4 While still in the Parameters view tab, query for the BIP Server Password, and then enter (or
verify) the correct password for the Oracle BI Publisher Server.

Troubleshooting Alignment Problems in HTML Output

Use the following procedure to troubleshoot alignment problems in HTML output.

To fix alignment problems in HTML output

1 Add a row to the Table Header.

2 Copy the Form fields from the data row in the added row.

3 Delete the previous table that contained the data row.

The single table now contains both header and data row.

Siebel Reports Guide Version 8.1, Rev. C 15 3

Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports

Troubleshooting Japanese Font Errors

Use the following procedure to properly display JPN (Japanese) fonts in Siebel Reports.

To create font mapping to display Japanese fonts properly

1 Search for msgothic.ttc, and then copy the file to the computer on which the Oracle BI Publisher
Server is installed:

\Java\jdk\jre\lib\fonts

2 Restart OC4J (Oracle Application Server Containers for Java Platform, Enterprise Edition).

3 Launch the Oracle BI Publisher Server URL.

4 Log in to Oracle BI Publisher Server.

5 Navigate to Admin, Runtime configuration, and then Font Mappings.

6 Create the following two font mappings:

■ Arial, Normal, msgothic.ttc

■ Arial, Bold, msgothic.ttc

154 Siebel Reports Guide Version 8.1, Rev. C

B Report Business Service

This appendix describes the Report Business Service and its methods. These methods are used in
scripts or workflow processes to automate reporting-related business processes. For example, you
can define workflow processes to automate the business processes for generating a report with a
specific query, or saving a report in a specific format, or emailing a report to a customer.

This appendix is intended for Siebel configurators. It consists of the following topics:

■ About the Report Business Service on page 155

■ Configuring the Report Business Service on page 156

About the Report Business Service

Most users are familiar with report generation in the Siebel Business Application views. In these
views, users can run a query, and then generate a report interactively or schedule a report for later
generation. Subsequently, users can view, print, or share the report with others. This mechanism
requires user interaction to accomplish reporting business needs.

Using the Report Business Service business service methods, administrators can generate, share,
and print reports automatically without user interaction. Because reports are automatically
generated when certain business rules are satisfied, there is no way for the user to pass a query.
Therefore, the view mode applied on the report executable is used for obtaining data.

Siebel Business Process Designer, an interactive software tool, lets you automate how your
organization handles workflow processes. For more information about Siebel Business Process
Designer and workflow processes, see Siebel Business Process Framework: Workflow Guide.

NOTE: Currently, the Report Business Service business service methods are supported only on run-
time events. Therefore, a user must be logged on to trigger an event that will invoke these methods.

Knowledge of Siebel Tools, scripting, Siebel Business Process Designer, and the Oracle BI Publisher
Server is necessary to use the Report Business Service report business service methods. Having an
understanding of running the business services is also necessary. Administrators can create as many
workflow processes as needed to satisfy their business requirements and include the necessary
report business service methods as steps (recall that workflow processes can include one or more
business services as steps). The report designers can test these workflow processes in the Business
Process simulator. For more information about workflow processes and the Business Process
simulator, see Siebel Business Process Framework: Workflow Guide.

NOTE: The Reports Business Service report business service methods are executed only in the Siebel
Web Client.

Siebel Reports Guide Version 8.1, Rev. C 15 5

Report Business Service ■ Configuring the Report Business Service

Configuring the Report Business Service

The Report Business Service enables Oracle BI Publisher reports to be executed from the Siebel
application using a workflow process, or through scripting. The report is generated in the background
by connecting to the Oracle BI Publisher Server. The report output is stored in the Siebel File System
and accessed from the My BI Publisher Reports view.

NOTE: The Reports Business Service can not be executed on the Mobile Web Client.

For detailed information about using the Report Business Service service and its methods, see
823360.1 (Doc ID) on My Oracle Support.

156 Siebel Reports Guide Version 8.1, Rev. C

 Index

A FONTS directory, described 29

adding an explicit reference to JAR files for REPORTS, directory described 29
the Oracle BI Publisher Server 50 TEMPLATES directory, described 29
administering reports 67 xliff directory, described 29

B E
BIPSiebelSecurityWS.XML file, embedding the Scheduled Jobs view in the
importing 57 Siebel application 61
enabling and configuring report scheduling,
process of 60
C enabling external file references for the
class not found errors Oracle BI Publisher Server 44
resolving when previewing reports in error messages, troubleshooting for
Microsoft Word 144 reports 146
configuring security and authentication for Extensible Markup Language
Siebel Reports See XML
using the LDAP model 59 Extensible Stylesheet Language
using the Siebel Security model 57 See XSL
configuring the BIPDataService WSDL 62 Extensible Stylesheet Language
configuring the outbound Web service for Transformation
the Oracle BI Publisher Server 52 See XSLT
configuring the Siebel application for Extensible Stylesheet Language-Formatting
integration with Oracle BI Publisher, Objects
process of 46 See XSL-FO
copying JAR files to the Oracle BI Publisher
Server 43
custom reports F
creating new integration objects for 103 fonts, copying for report generation 49
creating, workflow for 95
extending integration objects for Siebel G
Reports 102 generating reports
process of creating 101 about 81
example of 87
D monitoring the status of 88
debugging procedure for 86
disabling for Siebel Reports in disconnected scenario for 84
mode 144 workflow for 83
enabling for Siebel Reports in disconnected workflow for connected mode 26
mode 143 workflow for generating in disconnected
deleting scheduled reports 119 mode 27
deploying reports to the Siebel Web Client
from a disconnected client 67 I
deploying Siebel Reports for the first importing new report features for Siebel
time 35 CRM version 8.1.1.1 48
description of 101 installing Oracle BI Publisher 40
directory structure for Siebel Reports integrating Oracle BI Publisher with Siebel
DATA directory, described 29 Business Applications

Siebel Reports Guide Version 8.1, Rev. C 15 7

Index ■ L

about 35 layout templates 73

preparation tasks for 37 designing 72
process of installing and configuring Oracle BI
Publisher 40 O
roadmap for 39 optimization
integration instructions for previous enabling scalable mode for Siebel Reports 77
versions of Siebel Reports, increasing EAI HTTP transport sleep time
finding 37 for 80
integration objects for Siebel Reports optimizing performance for large data
creating new 103 volumes, process of 77
extending to add new fields to a report 102 setting a temporary directory on the Oracle BI
Publisher Server for 79
L setting concurrency parameters for 76
languages setting the report execution wait time for 74
adding to report layout templates 73 setting the server request processor wait time
deleting from report layout templates 73 for 75
LDAP security model, configuring security Oracle BI Publisher
and authentication for 59 installing for Siebel Business Applications 40
logging for Siebel Reports Oracle BI Publisher repository
enabling logging for the XMLP Report Server about 31
component 141 changing the location of for Siebel
setting log levels for using the GUI 141 Reports 45
setting log levels for using the Server Manager Oracle BI Publisher Server
(srvrmgr) 142 about 30
logging for the Oracle BI Publisher Server adding an explicit reference to JAR files 50
about enabling 143 configuring the outbound Web service for 52
copying JAR files to 43
M enabling external file references for 44
master-detail reports securing Siebel user access to, process of 56
about 121 Oracle BI Publisher-Siebel application
creating master-detail layout templates in interaction 31
Microsoft Word 126 Oracle Business Intelligence Publisher Add-
how they work, example of 122 in for Microsoft Word
using 121 about using with Siebel Reports 21
migrating reports advantages of using 22
migrating an integration object for a Excel Analyzer feature 23
report 134 menu and toolbar, example of 22
migrating new reports after creating new Template Builder feature 23
integration objects 135 Template Viewer feature 23
migrating the report files to the target using to create report layout templates 106
environment 131
moving database records to the target P
environment 133 parameterized reports
packaging and migrating reports, process about 137
of 130 about defining parameters in the report layout
packaging database records in the source template 138
environment 132 about defining parameters in the report
packaging the report files in the source template 138
environment 130 about referencing parameters in the report
requirements for 129 layout template 138
multilingual reports example of generating 140
about working with 70 how they are generated 139
adding and deleting languages from report PublicReportService outbound Web service,

158 Siebel Reports Guide Version 8.1, Rev. C

 Index ■ R

configuring 52 Reports Business Service

purging reports about 155
automatically purging from the Siebel File configuring 156
System 68 Reports menu, changing the report sequence
from the Oracle BI Publisher Server 69 order 113
purging scheduled reports 69 Reports menu, using to generate reports 81
reports, setting language and locale for 91
R
registering report layout templates, S
about 100 Scheduled Jobs view, embedding in the
report execution modes comparison, Siebel application 61
diagram of 32 scheduled reports
report layout template views 101 about 115
report layout templates deleting 119
creating using Oracle BI Publisher Add-in for enabling and configuring, process of 60
Microsoft Word 106 example of 117
defining for selected records 112 monitoring and viewing 118
diagram for uploading to a Siebel procedure for 116
application 99 securing Siebel user access to the Oracle BI
previewing 107 Publisher Server, process of 56
registering 108 sharing report layout templates, about 100
registering and sharing, about 100 Siebel application-Oracle BI Publisher
sharing 112 interaction 31
workflow for uploading to a Siebel Siebel Reports
application 99 about 19
report sequence order, changing 113 about integration objects for 96
report translation, about 72 about using 20
reports architecture, described 25
about parameterized reports 137 configuring in a Web SSO environment 59
adding multiple integration objects to 111 deploying for the first time 35
associating registered reports with application development environment, described 25
views 113 directory structure, described 29
creating 93 file types, described 29
creating new responsibilities in the Siebel overview of 19
application 54 report execution in connected mode 33
deleting 90 report execution in disconnected mode 33
determining whether to modify existing or report output files types 20
creating custom 93 uploading preconfigured reports to the Oracle
generating 86 BI Publisher Server 63
generating sample XML data files for 105 users, described 21
previewing work-in-progress report layout using Oracle Business Intelligence Publisher
templates 107 Add-in for Microsoft Word with 21
registering and sharing report layout workflow for generating reports in connected
templates, about 100 mode 26
registering report layout templates 108 workflow for generating reports in
reporting across multiple Siebel business disconnected mode 27
objects 97 Siebel Security model, configuring security
scenario for creating custom 94 and authentication for 57
troubleshooting 141
uploading report layout templates to a Siebel T
application, workflow for 99 testing integration configurations for Siebel
using master-detail reports 121 Reports 65
viewing previously generated reports 89 troubleshooting

Siebel Reports Guide Version 8.1, Rev. C 15 9

Index ■ U

tasks for 141 10.1.3.4.0 42

troubleshooting reports Siebel Reports to Siebel CRM version 8.1.1.x
alignment problems in JPN and PSJ from version 8.1.1 36
environments 149 uploading files to Oracle BI Publisher error
error messages for 146 SBL-EAI-04308 150
error while uploading files to Oracle BI SBL-EAI-05010 150
Publisher 150 user preferences, setting report language
resolving class name incorrect errors 146 and locale 91
resolving class not found errors when
previewing reports in Microsoft W
Word 144 Web service
resolving column alignment problems in HTML configuring the PublicReportService outbound
and EXCEL 149 Web service 52
resolving error after clicking Submit to PublicReportService Web service, about 30
generate a report 146 Web SSO, configuring Siebel Reports for 59
resolving error due to special character workflow
violations 148 for generating reports (diagram) 83
resolving errors relating to the Siebel File generating reports in connected mode 26
System or XMLP directory 147 generating reports in disconnected mode 27
resolving errors while running 146
resolving for custom Java classes 147
resolving for incorrect path settings in X
configuration files 146 XLIFF (XML Localization Interchange File
resolving for Oracle BI Publisher run-time Format), described 30
errors 147 XML (Extensible Markup Language),
resolving Oracle BI Publisher Server login described 29
errors 147 XPath (XML Path Language), described 30
resolving report definition errors 148 XSL (Extensible Stylesheet Language),
resolving XLIFF errors 146 described 29
XSL-FO (Extensible Stylesheet Language-
Formatting Objects), described 30
U XSLT (Extensible Stylesheet Language
upgrading Transformation), described 30
Oracle BI Publisher to version 10.1.3.4.1 from

160 Siebel Reports Guide Version 8.1, Rev. C