Siebel Reports Guide PDF

Siebel Reports Guide
Version 8.1, Rev. F

January 2012
Copyright © 2005, 2012 Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions
on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in
your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast,
modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any
means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-
free. If you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing
it on behalf of the U.S. 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, the
use, duplication, disclosure, modification, and adaptation shall be subject to the restrictions and license
terms set forth in the applicable Government contract, and, to the extent applicable by the terms of the
Government contract, the additional rights set forth in FAR 52.227-19, Commercial Computer Software
License (December 2007). Oracle America, Inc., 500 Oracle Parkway, Redwood City, CA 94065.
This software or hardware is developed for general use in a variety of information management
applications. It is not developed or intended for use in any inherently dangerous applications, including
applications that may create a risk of personal injury. If you use this software or hardware in dangerous
applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and
other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any
damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be
trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks
are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD,
Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced
Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content,
products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and
expressly disclaim all warranties of any kind with respect to third-party content, products, and services.
Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due
to your access to or use of third-party content, products, or services.
Contents
Siebel Reports Guide 1
Chapter 1: What’s New in This Release
Chapter 2: Overview of Siebel Reports

About Siebel Reports 17
About Using Siebel Reports 18
Who Can Use Siebel Reports? 18
Siebel Reports Output File Types 19
About Oracle BI Publisher 20
About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with
Siebel Reports 20
Chapter 3: Siebel Reports Development Environment

About the Siebel Reports Architecture 23
Workflow for Generating Reports in Connected Mode 24
Workflow for Generating Reports in Disconnected Mode 25
Siebel Reports Directory Structure 27
Siebel Reports File Types 28
About the Oracle BI Publisher Server in Siebel Business Applications 28
How Siebel Business Applications and Oracle BI Publisher Interact 29
Chapter 4: Integrating Oracle BI Publisher with Siebel

Business Applications
About Integrating Oracle BI Publisher with Siebel Business Applications 34
About Upgrading Siebel Reports 34
Where to Find Documentation for Previous Versions of Siebel Reports 34
Requirements for Using Siebel Reports 34
Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications 35
Preparing for Integration of Oracle BI Publisher with Siebel Business Applications 38
Siebel Reports Guide Version 8.1, Rev. F 3

Contents ■
Process of Installing Oracle BI Publisher for Integration with Siebel Business

Applications 39
Installing Oracle Business Intelligence Publisher Enterprise for Integration with Siebel
Business Applications 39
Installing Oracle Business Intelligence Publisher Add-in for Microsoft Word 41
Copying JAR Files to the Oracle BI Publisher Server 42
Disabling External File References on the Oracle BI Publisher Server 43
Starting and Stopping OC4J and Oracle BI Publisher 44
Upgrading to the Latest Oracle BI Publisher Patch 45
Configuring an Outbound Web Service for the Siebel Application 45
Enabling Siebel Server Components for Siebel Reports 47
About Associating Siebel Reports Views with Siebel Responsibilities 48
About Security and Authentication for Siebel Reports 48
About Oracle Business Intelligence Enterprise Edition Coexistence with Siebel Reports
49
About Configuring Security and Authentication for Siebel Reports 50
Configuring Security and Authentication for Siebel Reports 50
Setting Up and Enabling the Siebel Security Model for Siebel Reports 51
Configuring Security and Authentication for Siebel Reports Using LDAP 55
Configuring Siebel Reports in a Web Single Sign-On Environment 56
Configuring Security and Authentication for Siebel Reports Using Oracle BI Publisher
Security 56
Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server 57
Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server
59
Process of Enabling and Configuring Report Scheduling 60
Setting Up the Database Schema for the Oracle BI Publisher Server 60
Configuring the Data Service WSDL for the Oracle BI Publisher Server 61
Verifying Symbolic URL Arguments That Embed the Oracle BI Publisher Scheduling Views
in the Siebel Application 62
Testing Your Siebel Reports Integration Configurations 63
Roadmap for Upgrading Siebel Reports 64
Chapter 5: Administering Siebel Reports

Deploying Report Layout Templates to the Siebel Web Client from a Disconnected
Client 68
Uploading New or Modified Report Layout Templates for Multiple Siebel Server
Environments 69
4 Siebel Reports Guide Version 8.1, Rev. F

Contents ■
Configuring the Reports Icon 69

Disabling and Enabling the Reports Icon 70
Renaming Siebel Reports Menu Items 70
About Controlling Access to Reports 71
Automatically Purging Reports from the Siebel File System 71
Purging Scheduled Reports from the Oracle BI Publisher Server 72
Changing the Location of the Oracle BI Publisher Repository for Siebel Reports 73
Changing the Location of the Oracle BI Publisher Repository by Creating a Custom XML File
74
Changing the Location of the Oracle BI Publisher Repository by Replacing a JVM Property
Name 74
Changing the Location of the Oracle BI Publisher Repository by Changing the Absolute Path
to the Repository 75
Copying Fonts for Report Generation 75
About Working with Multilingual Reports 76
Designing Multilingual Reports 77
Roadmap for Uploading Multilingual Reports to the Siebel Application 79
Adding and Deleting Locales from Report Templates 80
About Report Translation 81
Roadmap for Optimizing the Performance of Siebel Reports 82
Setting the Report Execution Waiting Period for Reports 82
Setting the Server Request Processor Database Polling Interval for Siebel Reports
83
Setting Concurrency Parameters for Siebel Reports 84
Process of Optimizing the Generation Performance of Siebel Reports for Large Data
Volumes 85
Enabling Scalable Mode for Siebel Reports 85
Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports
87
Increasing EAI HTTP Transport Sleep Time for Siebel Reports 88
About Increasing the Java Heap Size on Oracle BI Publisher Server 89
About Reducing the Size of an Integration Object 89
Chapter 6: Generating Reports

About Generating Reports 91
Scenario for Generating Reports 92

Contents ■
About Generating Reports for Selected Records 93

Generating Reports 95
Example of Generating an Opportunity Report 97
Monitoring the Status of Currently Generating Reports 97
Viewing Details for Generated Reports 99
Deleting Reports 101
Setting Locale User Preferences for Reports 101
Chapter 7: Creating Reports

Scenario for Creating Reports 103
About Integration Objects in Siebel Reports 104
Using Integration Object Search Specifications for Siebel Reports 105
About Reporting Across Multiple Siebel Business Objects 106
Workflow for Uploading Report Layout Templates to a Siebel Application 107
About Registering and Sharing Report Layout Templates 109
About Multiorganizational Report Templates 109
Scenario for Report Template Visibility Across Organizations 110
Should You Clone an Existing Report or Create Custom Reports? 110
About Defining Report Layout Templates for Selected Records 111
Process of Creating Custom Reports 112
Extending Integration Objects to Add New Fields for Siebel Reports 115
Creating New Integration Objects for Siebel Reports 116
Generating Sample XML Data Files for Siebel Reports 118
Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for
Microsoft Word 119
Registering Report Layout Templates 120
Adding Multiple Integration Objects to a Report 124
Sharing Report Layout Templates 125
Defining Report Layout Templates for Selected Records 126
Associating Registered Reports with Siebel Application Views 127
Changing the Report Sequence Order in the Reports Menu 127
Chapter 8: Scheduling Reports

About Scheduled Reports 129
Scheduling Reports 130

Contents ■
Example of Scheduling an Opportunity Report 133

Monitoring and Viewing Scheduled Reports 134
Suspending and Resuming Scheduled Reports 134
Deleting Scheduled Reports 135
Chapter 9: Using Master-Detail Reports

About Master-Detail Reports 137
Example of Comparing the Service Request Activity (All) Report with its
Corresponding Layout Template 138
Creating a Master-Detail Layout Template in Microsoft Word 142
Chapter 10: Migrating Reports

Requirements for Migrating Reports 145
Process of Packaging and Migrating Reports 146
Packaging the Report Files in the Source Environment 146
Migrating the Report Files to the Target Environment 147
Packaging Report Database Records in the Source Environment 148
Migrating Report Database Records to the Target Environment 149
Process of Migrating an Integration Object for a Report 150
Process of Migrating New Reports after Creating New Integration Objects 151
Chapter 11: Parameterized Reports

About Parameterized Reports 153
About Report Parameter Types and Attributes 154
About Referencing Parameters in the Report Layout Template 156
About Defining Report Parameters in the Siebel Application 157
About Report Parameter Validation 158
Process of Creating Parameterized Reports 159
Adding Scrollbars to the Parameters Dialog Box 160
Defining Report Parameters in the Siebel Application 160
Example of Generating a Parameterized Report 162
Chapter 12: Troubleshooting Siebel Reports

Enabling Logging for Siebel Reports in the Siebel Application 165
About Enabling Logging for the Oracle BI Publisher Server 167

Contents ■
Enabling Debugging on Oracle BI Publisher Server for Siebel Reports 167

Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode 168
Guidelines for Resolving Class Not Found Errors When Previewing Reports in Microsoft
Word 169
Resolving Class Not Found Errors When Previewing Reports in Microsoft Word 170
Troubleshooting Error Messages for Siebel Reports 171
Chapter 13: Report Business Service

About the Report Business Service 181
Configuring the Report Business Service 182
Index

1 What’s New in This Release
What’s New in Siebel Reports Guide, Version 8.1, Rev. F

Table 1 lists some of the changes in this version of the documentation to support this release of the
software.
Table 1. What’s New in Siebel Reports Guide, Version 8.1, Rev. F
Topic Description
“About Associating Siebel Reports Views with New topic. It provides a recommended association of
Siebel Responsibilities” on page 48 Siebel Reports views with Siebel Reports
responsibilities.
“About Oracle Business Intelligence Modified topic. It describes how Oracle Business
Enterprise Edition Coexistence with Siebel Intelligence Enterprise Edition (OBIEE) coexists with
Reports” on page 49 Siebel Business Applications for use with Siebel
Reports.
“Configuring Security and Authentication for New topic. It describes how to configure security and
Siebel Reports Using Oracle BI Publisher authentication for Siebel Reports using Oracle BI
Security” on page 56 Publisher.
“Configuring the Reports Icon” on page 69 New topic. It describes how to enable and disable
Siebel Reports in Siebel Business Applications and
how to customize the Reports menu.
“About Working with Multilingual Reports” on Modified topics. For Siebel Reports, locale is the
page 76 language and locale combination based on the locale
configuration. In prior releases, language and locale
“Designing Multilingual Reports” on page 77
were two separate entities.
“Adding and Deleting Locales from Report
Templates” on page 80
“Setting Locale User Preferences for Reports”

on page 101
“About Report Translation” on page 81 Modified topic. Added information about what occurs
when multilingual reports are generated for a specific
report locale.
“Setting the Report Execution Waiting Period Modified topic. It is recommended that you limit the
for Reports” on page 82 wait time for report execution so that report
generation runs in the background.
“Increasing EAI HTTP Transport Sleep Time Modified topic. You can increase the default sleep
for Siebel Reports” on page 88 time for the EAI HTTP Transport business service to
optimize generation of complex reports.

What’s New in This Release ■
Table 1. What’s New in Siebel Reports Guide, Version 8.1, Rev. F
Topic Description
“About Increasing the Java Heap Size on New topic. It describes how to increase the JVM
Oracle BI Publisher Server” on page 89 allocation for the OC4J process for running large
reports.
“About Reducing the Size of an Integration New topic. For performance purposes, it is
Object” on page 89 recommended that you limit the fields in integration
objects to only those absolutely necessary for report
generation.
“About Generating Reports for Selected New topic. It describes how report generation is
Records” on page 93 executed when you select a specific record or
multiple records.
“Viewing Details for Generated Reports” on Modified topic. It describes the new report parameter
page 99 settings and their values.
“Registering Report Layout Templates” on Modified topic. It describes how you can override
page 120 queries in the user interface by specifying a search
specification on the primary integration object.
“About Parameterized Reports” on page 153 Modified topic. If a report template accepts run-time
parameters, a Parameters option appears in the
Schedule a Report dialog box when scheduling a
report.
“Adding Scrollbars to the Parameters Dialog New topic. It describes how to use threshold to make
Box” on page 160 scrollbars appear in the Parameters dialog box.
“Enabling Debugging on Oracle BI Publisher New topic. It describes how to configure Oracle BI
Server for Siebel Reports” on page 167 Publisher Server to capture detailed information
about errors that occur while working with Siebel
Reports in the Siebel Web Client.
Additional Changes
This book contains the following general changes:
■ Much of the content in this guide was rewritten to reflect the updated user interface.
The following term was changed:
■ Oracle E-Delivery is now Oracle Software Delivery Cloud.

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

Table 2 lists the changes described in this version of the documentation to support this release of the
software.
Table 2. New Product Features in Siebel Reports Guide, Version 8.1, Rev. E
Topic Description
“Configuring an Outbound Web Service Modified topic. Added steps for defining a WSDL for the
for the Siebel Application” on page 45 outbound Web service.
What’s New in Siebel Reports Guide, Version 8.1, Rev. D

Table 3 lists the changes described in this version of the documentation to support this release of the
software.
Table 3. New Product Features in Siebel Reports Guide, Version 8.1, Rev. D
Topic Description
Chapter 4, “Integrating Oracle BI New chapter. It provides updated content and reorganized
Publisher with Siebel Business topics to reflect the latest integration and configuration
Applications” tasks.
Chapter 8, “Scheduling Reports” Modified chapters. They reflect the latest report features
and topics have been reorganized accordingly.
Chapter 11, “Parameterized Reports”
“About Controlling Access to New topic. Reports access is based on standard Siebel
Reports” on page 23 responsibility-based visibility as well as access granted by
others.
“About Oracle BI Publisher” on New topic. It describes the Oracle BI Publisher, OC4J (Oracle
page 20 Application Server Containers for Java Platform, Enterprise
Edition), and Oracle BI Publisher Add-in for Microsoft Word
(also known as Oracle BI Publisher Desktop).
“Siebel Reports Directory Structure” Modified topic. The naming convention for XLIFF files
on page 27 requires that all languages have the same file name as the
report layout template, only the extension differs.
“About Upgrading Siebel Reports” on New topic. Provides an overview of Siebel Reports upgrades.
page 34
“Roadmap for Integrating Oracle BI New topic. It provides a high-level roadmap for integrating
Publisher with Siebel Business Oracle BI Publisher with Siebel Business Applications.
Applications” on page 35
“Setting Up and Enabling the Siebel Modified topic. You replace the existing address of the
Security Model for Siebel Reports” on Service Ports subview with the URL used to access the EAI
page 51 Object Manager.

Topic Description
“About Security and Authentication New topic. Describes the various security models available
for Siebel Reports” on page 48 for Siebel Reports.
“Roadmap for Upgrading Siebel New topic. It provides instructions for upgrading to the
Reports” on page 64 latest Siebel Reports features.
“Roadmap for Uploading Multilingual New topic. It describes how to upload multilingual reports to
Reports to the Siebel Application” on a Siebel application.
page 79
“About Report Translation” on Modified topic. Added a caution that each translated report
page 81 must have a unique name, otherwise errors can occur.
“Setting Locale User Preferences for New topic. It describes how to set the default report
Reports” on page 101 language and locale by setting user preferences.
“About Multiorganizational Report New topic. It describes the logic for how an organization-
Templates” on page 109 specific report template appears in the Reports menu.
“Scenario for Report Template New topic. It provides an example of how you might use
Visibility Across Organizations” on report template visibility across organizations.
page 110
“Suspending and Resuming New topic. It describes how to suspend and resume
Scheduled Reports” on page 134 scheduled reports.
“Example of Comparing the Service New topic. It provides an example of using a master-detail
Request Activity (All) Report with its report.
Corresponding Layout Template” on
page 138
“Syntax and Description of the Fields New topic. It provides additional information for the
for an Example Template” on example of using a master-detail report.
page 140
“About Parameterized Reports” on Modified topic. It describes how parameterized reports are
page 153 generated.
“About Report Parameter Types and New topic. It provides a description of the report parameter
Attributes” on page 154 types and attributes.
“About Defining Report Parameters in New topic. It provides information about parameter
the Siebel Application” on page 157 definitions and how to use them.
“About Report Parameter Validation” New topic. It provides an overview for checking for report
on page 158 parameter inconsistencies between the report layout
template and definitions for the template in the Siebel
application.

Topic Description
“Process of Creating Parameterized New topic. It provides instructions for defining report
Reports” on page 159 parameters.
“Defining Report Parameters in the New topic. It describes how to define report parameters in
Siebel Application” on page 160 the Siebel application. The parameters govern how the
reports appear so that users have options when generating
reports.
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.
■ Start Date and End Date replace Active Start Date and End Date, respectively.
■ The following view names have changed:

■ All Template View is now All Report Template View
■ Manager’s Template View is now Manager’s Report Template View
■ Several topics in Chapter 4, “Integrating Oracle BI Publisher with Siebel Business Applications” were
relocated to either other chapters or 880452.1 (Article ID), Siebel Maintenance Release Guide
on My Oracle Support.
■ The procedures in Chapter 4, “Integrating Oracle BI Publisher with Siebel Business Applications”
now indicate which steps are applicable to a first-time installation or upgrades (or both).
■ The following topics were relocated to Chapter 5, “Administering Siebel Reports”:
■ “Uploading New or Modified Report Layout Templates for Multiple Siebel Server Environments”
on page 69
■ “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on page 73
■ “Copying Fonts for Report Generation” on page 75
■ Updated diagram and steps in “Generating Reports” on page 95.

■ You can generate reports in MHTML (MIME HTML) format in connected mode only.
■ A diagram was added to “Process of Creating Custom Reports” on page 112.
■ Mentions of upgrading to Siebel CRM version 8.1.1.1 from Siebel CRM version 8.1.1 were
removed because they are no longer applicable.
What’s New in Siebel Reports Guide, Version 8.1, Rev. C

The changes described in this version of the documentation to support this release of the software
include:
■ 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
■ 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.
What’s New in Siebel Reports Guide, Version 8.1, Rev. B

include:
■ 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.
What's New in Siebel Reports, Version 8.1, Rev. A

include:
■ 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 (Article 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

include:
■ 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 (http://www.oracle.com/

technetwork/indexes/documentation/index.html), Oracle Software Delivery Cloud, 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 (http:/
/www.oracle.com/technetwork/indexes/documentation/index.html).
■ Siebel Business Applications Third-Party Bookshelf is available on Oracle Software Delivery

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

2 Overview of Siebel Reports
The reporting module for Siebel Business Applications is Oracle® Business Intelligence Publisher
(Oracle BI Publisher). 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 17
■ About Using Siebel Reports on page 18
■ Who Can Use Siebel Reports? on page 18
■ Siebel Reports Output File Types on page 19
■ About Oracle BI Publisher on page 20
■ About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports on
page 20
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 and to
download additional preconfigured reports, see 876284.1 (Article 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 20.
■ 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.

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.
NOTE: The reports that are available to you while in a Siebel view are based on either a view-report
relationship for standard templates, or position-based and multiorganizational visibility for custom
templates. Others can also grant you access to their reports.
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.
Related Topic
“Who Can Use Siebel Reports?” on page 18
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 20. 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 23.

Overview of Siebel Reports ■ Siebel Reports Output File Types
■ 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 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.
Related Topic
“About Using Siebel Reports” on page 18
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 23.
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 120.

Overview of Siebel Reports ■ About Oracle BI Publisher
About Oracle BI Publisher

Oracle Business Intelligence Publisher (Oracle BI Publisher) is the reporting module for Siebel
Reports. Siebel Business Applications integrate with Oracle BI Publisher for report generation and
management. For more information about Oracle BI Publisher, see the documentation suite available
on Oracle Technology Network (http://www.oracle.com/technetwork/indexes/documentation/
index.html). For more information about Oracle BI Publisher and Siebel Business Applications
integration, “How Siebel Business Applications and Oracle BI Publisher Interact” on page 29.
Oracle BI Publisher Server and OC4J

When you install Oracle BI Publisher, OC4J (Oracle Application Server Containers for Java Platform,
Enterprise Edition) and the Oracle BI Publisher Server are 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. For more information about
OC4J, see Oracle Business Intelligence Publisher Installation Guide, Release 10.1.3 available on
Oracle Technology Network (http://www.oracle.com/technetwork/indexes/documentation/index.html).
For more information about the Oracle BI Publisher Server, see “About the Oracle BI Publisher Server in
Siebel Business Applications” on page 28.
Oracle BI Publisher Add-In for Microsoft Word

Oracle BI Publisher Add-in for Microsoft Word (also known as Oracle BI Publisher Desktop) is the
report authoring tool for Siebel Reports, which allows you to author and preview layout templates
using Microsoft Word. For more information about using this tool, see “About Using Oracle Business
Intelligence Publisher Add-in for Microsoft Word with Siebel Reports” on page 20.
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.
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.

Overview of Siebel Reports ■ About Using Oracle Business Intelligence Publisher Add-in
for Microsoft Word with Siebel Reports
When you open Microsoft Word after installing Oracle Business Intelligence Publisher Add-in for
Microsoft Word, the Oracle BI Publisher 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
Figure 1 shows the following new elements in Microsoft Word:
■ A new application-level menu entitled Oracle BI Publisher
■ The Oracle BI Publisher toolbar with the following menu options:
■ Data
■ Insert
■ Preview
■ Tools
■ Help
For information about installing Oracle Business Intelligence Publisher Add-in for Microsoft Word, see
“Installing Oracle Business Intelligence Publisher Enterprise for Integration with Siebel Business
Applications” on page 39.
NOTE: It is recommended that you use the same versions of Oracle BI Publisher Server and Oracle
BI Publisher Desktop in your deployment.
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.

Overview of Siebel Reports ■ About Using Oracle Business Intelligence Publisher Add-in
for Microsoft Word with Siebel Reports
■ 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.
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 23.
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 (http://www.oracle.com/technetwork/indexes/documentation/index.html).
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.

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 23
■ Workflow for Generating Reports in Connected Mode on page 24
■ Workflow for Generating Reports in Disconnected Mode on page 25
■ Siebel Reports Directory Structure on page 27
■ Siebel Reports File Types on page 28
■ About the Oracle BI Publisher Server in Siebel Business Applications on page 28
■ How Siebel Business Applications and Oracle BI Publisher Interact on page 29
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 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 25.
■ 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 24.
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 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.
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.
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.

Disconnected Mode
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 PublicReportServiceService 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 PublicReportServiceService business
service.
11 The proxy PublicReportServiceService 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.

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.

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 4 provides descriptions of these directories.
Table 4. 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 75.
\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 29.
\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: After a report template is registered, the XLIFF file (or files) is stored in
the relevant xliff\lang directory (or directories) on the Siebel Server. When you
upload the report template, all the XLIFF files from each language folder and the
RTF file are placed on the Oracle BI Publisher Server in their appropriate
locations. For more information, see “About the Oracle BI Publisher Server in Siebel
Business Applications” on page 28.
TIP: 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 Development Environment ■ Siebel Reports File Types
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 23.
■ 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 “Who Can Use Siebel Reports?” on page 18.
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 24.
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 Business Intelligence Publisher Enterprise for Integration with Siebel Business Applications” on
page 39.

Siebel Reports Development Environment ■ How Siebel Business Applications and
Oracle BI Publisher Interact
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 relation to Siebel
Reports in greater detail.
About the PublicReportServiceService Web Service

The PublicReportServiceService 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 PublicReportServiceService Web service supports the following operations:
■ Validates privileges
■ Gets information about reports and the Oracle BI Publisher repository
■ 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 107.
How Siebel Business Applications and

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.

Figure 4 compares report execution in connected mode with disconnected mode.
Figure 4. Comparison of Report Execution in Connected and Disconnected Mode
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.
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
PublicReportServiceService Web service to generate reports. The PublicReportServiceService Web
service is the interface between the Siebel application and the Oracle BI Publisher Server.


4 Integrating Oracle BI Publisher
with Siebel Business
Applications
This chapter provides instructions for administrators on how to integrate Oracle Business Intelligence
Publisher (Oracle BI Publisher) with Siebel Business Applications for report generation. It includes
the following topics:
■ About Integrating Oracle BI Publisher with Siebel Business Applications on page 34
■ About Upgrading Siebel Reports on page 34
■ Where to Find Documentation for Previous Versions of Siebel Reports on page 34
■ Requirements for Using Siebel Reports on page 34
■ Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications on page 35
■ Preparing for Integration of Oracle BI Publisher with Siebel Business Applications on page 38
■ Process of Installing Oracle BI Publisher for Integration with Siebel Business Applications on page 39
■ Upgrading to the Latest Oracle BI Publisher Patch on page 45
■ Configuring an Outbound Web Service for the Siebel Application on page 45
■ Enabling Siebel Server Components for Siebel Reports on page 47
■ Configuring Security and Authentication for Siebel Reports on page 50
■ About Security and Authentication for Siebel Reports on page 48
■ About Oracle Business Intelligence Enterprise Edition Coexistence with Siebel Reports on page 49
■ Configuring Security and Authentication for Siebel Reports on page 50
■ Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server on page 57
■ Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server on page 59
■ Process of Enabling and Configuring Report Scheduling on page 60
■ Testing Your Siebel Reports Integration Configurations on page 63
■ Roadmap for Upgrading Siebel Reports on page 64

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

with Siebel Business Applications
Siebel Business Applications integrate with Oracle Business Intelligence Publisher (Oracle BI
Publisher) for report execution. Each new Siebel CRM release typically introduces new report features
and functionality. However, before you can use these latest features, you must perform several
installation and configuration or upgrade 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. If you are
deploying Siebel Reports for the first time, see “Roadmap for Integrating Oracle BI Publisher with
Siebel Business Applications” on page 35. You might also want to review “How Siebel Business
Applications and Oracle BI Publisher Interact” on page 29. If you already have a Siebel Reports
environment and want to upgrade, see “About Upgrading Siebel Reports” on page 34.
About Upgrading Siebel Reports

If you have an existing Siebel Reports environment and you want to use the latest report features,
then you must upgrade to the latest Siebel CRM Fix Pack 8.1.1.x and perform additional configuration
tasks for both the Siebel application and Oracle BI Publisher. For instructions for upgrading, see
“Roadmap for Upgrading Siebel Reports” on page 64.
Where to Find Documentation for

Previous Versions of Siebel Reports
Each Siebel CRM release has specific Siebel Reports setup instructions and features for that particular
release that may not be applicable to earlier or later releases. To find the documentation for your
deployment, see 1172844.1 (Article ID) on my Oracle Support.
Requirements for Using Siebel Reports

The reporting module for Siebel Business Applications is Oracle Business Intelligence Publisher
(Oracle BI Publisher). This topic provides the requirements you must meet before you can use Siebel
Reports. These requirements are applicable whether you are deploying Siebel Reports for the first
time or you are upgrading from a previous Siebel CRM release.
The following requirements must be met before using Siebel Reports:
■ The latest Siebel CRM version. If not, follow the guidelines provided in “About Integrating Oracle
BI Publisher with Siebel Business Applications” on page 34.
For information about supported Siebel CRM versions, see Siebel System Requirements and
Supported Platforms on Oracle Technology Network.
Some of the requirements include:
■ A Siebel Server (or servers)
■ A Siebel Web Client for connected mode

Integrating Oracle BI Publisher with Siebel Business Applications ■ Roadmap for
Integrating Oracle BI Publisher with Siebel Business Applications
■ A Siebel mobile client (MWC or DWC) for disconnected mode
■ Siebel Tools
■ (Optional) 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.
■ Java Development Kit (JDK) version 1.6 or later and JAVA_HOME system environment variable
points to JDK
■ Siebel Server components enabled:
■ Siebel Application Object Manager (AOM), for example, SCCObjMgr_enu for Siebel Call
Center
■ EAI Object Manager
■ XMLP Report Server
■ (Optional) Workflow
NOTE: Enable this component if you plan to use workflow, the Reports Business Service, or
the XMLP Purge Records workflow.
■ Oracle BI Publisher software
■ Oracle Business Intelligence Publisher
■ Oracle BI Publisher Add-In for Microsoft Word (also known as Oracle BI Publisher Desktop)
For information about which version to use, see Siebel System Requirements and Supported
Platforms on Oracle Technology Network. For information about Oracle BI Publisher, see “About
Oracle BI Publisher” on page 20. For information about installing Oracle BI Publisher as a first-
time installation, see “Process of Installing Oracle BI Publisher for Integration with Siebel Business
Applications” on page 39. If you are upgrading Oracle BI Publisher, see “Roadmap for Upgrading
Siebel Reports” on page 64.
Roadmap for Integrating Oracle BI

Publisher with Siebel Business
Applications
Figure 5 on page 36 provides a roadmap for integrating Oracle BI Publisher with Siebel Business
Applications. This integration is a requirement for deploying Siebel Reports. It is recommended that
you print this roadmap to use as a checklist as you work your way through the integration.
Explanation of Callouts
In Figure 5, the following conventions are used:
■ A green box indicates a task.

■ A brown box indicates a subtask.
■ A black box indicates a Siebel application view
■ A box with a broken line indicates the task or subtask is only required for first-time installations
■ A broken, black line indicates a first-time installation
Figure 5. Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications
Figure 5 illustrates the high-level tasks you perform to integrate Oracle BI Publisher with Siebel
Business Applications.

1 “Preparing for Integration of Oracle BI Publisher with Siebel Business Applications” on page 38
2 (First-time installation only) “Process of Installing Oracle BI Publisher for Integration with Siebel
Business Applications” on page 39
3 “Upgrading to the Latest Oracle BI Publisher Patch” on page 45
4 Apply the latest repository, schema, and seed data changes.
For instructions, see Instructions for ACR 719B in 880452.1 (Article ID), Siebel Maintenance
Release Guide on My Oracle Support.
5 (First-time installation only) “Configuring an Outbound Web Service for the Siebel Application” on
page 45
6 “Enabling Siebel Server Components for Siebel Reports” on page 47
7 “Configuring Security and Authentication for Siebel Reports” on page 50
■ “Setting Up and Enabling the Siebel Security Model for Siebel Reports” on page 51
■ “Configuring Security and Authentication for Siebel Reports Using LDAP” on page 55
■ “Configuring Siebel Reports in a Web Single Sign-On Environment” on page 56
8 “Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server” on page 57
9 “Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server” on page 59
10 “Process of Enabling and Configuring Report Scheduling” on page 60

a (First-time installation only) “Setting Up the Database Schema for the Oracle BI Publisher
Server” on page 60
b “Configuring the Data Service WSDL for the Oracle BI Publisher Server” on page 61
c “Verifying Symbolic URL Arguments That Embed the Oracle BI Publisher Scheduling Views in the
Siebel Application” on page 62
11 “Testing Your Siebel Reports Integration Configurations” on page 63
Click the links to navigate to detailed instructions for that topic. Tasks are applicable to both Siebel
Reports first-time installations and upgrades unless otherwise indicated.
NOTE: If you are upgrading from previous versions of Siebel Reports, see the instructions in
“Roadmap for Upgrading Siebel Reports” on page 64.

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

Publisher with Siebel Business
Applications
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
and supports the latest reports enhancements.
NOTE: If you are upgrading from a previous Siebel Reports deployment, do not perform the steps
described in this topic. Instead, see “Roadmap for Upgrading Siebel Reports” on page 64.
This task is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 35.
To prepare for integration of Oracle BI Publisher with Siebel Business Applications

1 Make sure you have met the requirements for Siebel Reports.
For the requirements, see “Requirements for Using Siebel Reports” on page 34.
2 Review Siebel System Requirements and Supported Platforms on Oracle Technology Network
(http://www.oracle.com/technetwork/indexes/documentation/index.html). Also check for
applicable alerts, bulletins, or other documents on My Oracle Support.
3 Install the appropriate Java Development Kit (JDK) version and point the JAVA_HOME system
environment variable to the JDK, if you have not already done so.
To find the JDK version applicable to your deployment, see Siebel System Requirements and
4 (First-time installation only) Install the following Oracle BI Publisher software:

For installation instructions, see “Installing Oracle Business Intelligence Publisher Enterprise for
Integration with Siebel Business Applications” on page 39.
■ Oracle BI Publisher Add-In for Microsoft Word (also known as Oracle BI Publisher Desktop)
For installation instructions, see “Installing Oracle Business Intelligence Publisher Add-in for
Microsoft Word” on page 41.
For the applicable version for your deployment, see Siebel System Requirements and Supported
Platforms on Oracle Technology Network. For more information about Oracle BI Publisher, see
“About Oracle BI Publisher” on page 20 and “About Using Oracle Business Intelligence Publisher Add-
in for Microsoft Word with Siebel Reports” on page 20.
5 Before using Siebel Reports, make sure that the Siebel Server is running and the Siebel clients
and Siebel Tools can connect to the server data source.

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

for Integration with 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: Do not use this process if you are upgrading from a previous deployment of Siebel Reports.
Instead, follow the instructions provided in “Roadmap for Upgrading Siebel Reports” on page 64.
This process is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications”
on page 35.
To install Oracle BI Publisher for integration with Siebel Business Applications, perform the following
tasks:
1 “Installing Oracle Business Intelligence Publisher Enterprise for Integration with Siebel Business
Applications” on page 39
For information about which versions of this software to use for your specific deployment, see
Siebel System Requirements and Supported Platforms on Oracle Technology Network.
2 “Installing Oracle Business Intelligence Publisher Add-in for Microsoft Word” on page 41
3 “Copying JAR Files to the Oracle BI Publisher Server” on page 42
4 “Disabling External File References on the Oracle BI Publisher Server” on page 43
5 (Optional) “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on
page 73
NOTE: This task is applicable to both first-time Siebel Reports deployments as well as upgrades.
Installing Oracle Business Intelligence Publisher

Enterprise for Integration with Siebel Business
Applications
Use the following procedure to install Oracle BI Publisher Enterprise for integration with Siebel
Business Applications and Siebel Reports.
This task is a step in “Process of Installing Oracle BI Publisher for Integration with Siebel Business
NOTE: Perform the following procedure only if this is a first-time Siebel Reports deployment. This
task is not applicable if you are upgrading.

To install Oracle BI Publisher Enterprise

1 Log in to Oracle Software Delivery Cloud available at:
http://edelivery.oracle.com
2 Enter the export validation information, accept the license terms and export restrictions, and
then click Continue.
3 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.
4 Select the Oracle Business Intelligence 10.1.3 Media Pack, and then click Continue.
For example, you might select Oracle Business Intelligence (10.1.3) Media Pack for Microsoft
Windows (32-bit).
5 Download the appropriate Oracle BI Publisher 10.1.3.4.x installer for your deployment.
NOTE: Typically administrators download and install Oracle Business Intelligence Publisher
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. For
information on installing this desktop software, see “Installing Oracle Business Intelligence
Publisher Add-in for Microsoft Word” on page 41.
6 Install Oracle BI Publisher by doing the following:
a Decompress the installer into a directory of your choice.
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.x available
on Oracle Technology Network (http://www.oracle.com/technetwork/indexes/documentation/
index.html).
NOTE: OC4J is installed and the Oracle BI Publisher Server starts automatically as part of
this installation.
c Verify the installation by making sure you have an Oracle - BIPHomeX entry in the Start
Programs menu, where X is an incremental number depending on the number of Oracle
installations you have.
7 Create a local Superuser for the Oracle BI Publisher Server by doing the following:

a Start 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).
c Check the Enable Local Superuser checkbox, enter a Superuser name and password of your
choice, and then click Apply.
After creating a local superuser, administrators can log in directly to the Oracle BI Publisher
Server when the Siebel Server is not running.
Installing Oracle Business Intelligence Publisher Add-in

for Microsoft Word
Use the following procedure to install Oracle Business Intelligence Publisher Add-in for Microsoft
Word (also known as Oracle BI Publisher Desktop) for integration with Siebel Business Applications
and Siebel Reports. For more information about this software, see “About Using Oracle Business
Intelligence Publisher Add-in for Microsoft Word with Siebel Reports” on page 20.
NOTE: Perform the following procedure only if this is a first-time Siebel Reports deployment. It is
not applicable if you are upgrading.
To install Oracle BI Publisher Add-in for Microsoft Word

1 Log in to Oracle Software Delivery Cloud available at:
http://edelivery.oracle.com
NOTE: This software is listed on Oracle Software Delivery Cloud as Oracle Business Intelligence
Publisher Desktop.
2 Enter the export validation information, accept the license terms and export restrictions, and
then click Continue.
3 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.

4 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).
5 Download the appropriate Oracle BI Publisher 10.1.3.4.x installer for your deployment.
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.
6 Install Oracle Business Intelligence Publisher Add-in for Microsoft Word by doing the following:
a Decompress the appropriate .zip file according to the Media Pack you chose in Step 3.
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.
c Verify the installation by making sure you have an Oracle BI Publisher Desktop application in the
Start Programs menu.
For more information about installing this software, see the post-installation topics in Oracle BI
Publisher on Oracle Application Server for OC4J 10.1.3.1 in Oracle Business Intelligence Publisher
Installation Guide, Release 10.1.3.x available on Oracle Technology Network (http://
www.oracle.com/technetwork/indexes/documentation/index.html).
7 Make sure that applicable users install Oracle BI Publisher Desktop on a computer where
Microsoft Word for Windows is installed.
Copying JAR Files to the 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 topic describes how to add
custom Siebel Java archive (JAR) files to the Oracle Business Intelligence Publisher (Oracle BI
Publisher) Server.
NOTE: Perform the following procedure only if this is a first-time Siebel Reports deployment.
To copy JAR files to the Oracle BI Publisher Server

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

■ SiebelCustomXMLP_SIA.JAR
■ Siebel.JAR
■ SiebelXMLP.JAR
■ (Optional) InkToolsLib.jar
■ (Optional) iSignBmp.jar
NOTE: Typically, ORACLE_APPSRVR_HOME is the C:\OraHome_X\oc4j_bi directory where

oc4j_bi is the Oracle BI Publisher installation directory for Windows. The InkToolsLib.jar and
iSignBmp.jar files are required whenever signatures must appear in a Siebel report that are
captured by way of the Siebel signature capture feature.
2 If there are additional custom Java extensions, then you must copy those JAR files as well.
Disabling External File References on the Oracle BI

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

1 Start Oracle Application Server Containers for Java Platform, Enterprise Edition (OC4J) and the
Oracle BI Publisher Server.
For instructions, see “Starting and Stopping OC4J and Oracle BI Publisher” on page 44.
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 OC4J to make the changes take effect.
For instructions, see “Starting and Stopping OC4J and Oracle BI Publisher” on page 44.

Starting and Stopping OC4J and Oracle BI Publisher

There are many instances where you must start, stop, or restart Oracle Application Server Containers
for Java Platform, Enterprise Edition (OC4J) and Oracle BI Publisher.
Starting OC4J and Oracle BI Publisher

Use the following procedure to start OC4J and Oracle BI Publisher.
To start OC4J and Oracle BI Publisher

1 Click Start, Programs, Oracle - BIPHomeX (where X is a number automatically assigned 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.
2 Confirm the Oracle BI Publisher Server is started.
When the server is started, a statement appears in the command window indicating the Oracle
Containers are initialized.
Stopping OC4J and Oracle BI Publisher

Use the following procedure to stop OC4J and Oracle BI Publisher.
To stop OC4J and Oracle BI Publisher

you install Oracle BI Publisher).
2 Click Stop BI Publisher.
Restarting OC4J and Oracle BI Publisher

Use the following procedure to restart OC4J and Oracle BI Publisher.
To restart OC4J and Oracle BI Publisher

you install Oracle BI Publisher).
2 Click Stop BI Publisher.
3 Click Start BI Publisher.

Integrating Oracle BI Publisher with Siebel Business Applications ■ Upgrading to the
Latest Oracle BI Publisher Patch
Upgrading to the Latest Oracle BI

Publisher Patch
To use the latest reporting features, it is recommended that you upgrade to the latest Oracle
Business Intelligence Publisher (Oracle BI Publisher) patch release. For more information about
Oracle BI Publisher patches, see 797057.1 (Article ID) on My Oracle Support. For information about
installing Oracle BI Publisher patches in a Siebel environment, see 1262585.1 (Article ID) on My
Oracle Support.
Configuring an Outbound Web Service

for the Siebel Application
The PublicReportServiceService outbound Web service is the interface through which the Siebel
enterprise communicates with Oracle BI Publisher to upload and run reports. For this functionality to
work, the address field on the outbound Web service stored in the Siebel application must refer to
the computer on which the Oracle BI Publisher Server is installed and the port on which it can be
reached.
on page 35.
To configure an outbound Web service for the Siebel application

1 Get the latest Oracle BI Publisher WSDL by doing the following:
a Start the Oracle BI Publisher Server.

b Type the following in the browser address bar to retrieve the Web service definition:
http://host:port/xmlpserver/services/PublicReportService_v11?wsdl
c Save the output as PublicReportService_v11.WSDL to a temporary location on your computer.
2 Using Siebel Tools, remove the existing outbound Web service and related integration objects by
doing the following:
a Log in to Siebel Tools.
b In the Object Explorer, select Business Service.
c In the Business Services list, query for PublicReportService, and then delete it.
d In the Object Explorer, select Integration Object.
e In the Integration Objects list, query for XMLP Integration project, and then select and delete all
the objects.
NOTE: There are 104 objects.

Integrating Oracle BI Publisher with Siebel Business Applications ■ Configuring an
Outbound Web Service for the Siebel Application
3 Import the WSDL you saved in Step 1 (to replace the one you just removed) by doing the
following:
a From the Tools menu, choose File, New Object, EAI, and then the Web Service icon, and click OK.
b In the WSDL Import Wizard dialog box:
❏ Select XMLP Integration project.
❏ Browse to the select PublicReportService_v11.WSDL, and then click Next.
c Check the Deploy Integration Object(s) and Proxy Business Service(s) option, and then click
Finish.
4 Verify the results by doing the following:
a In the Object Explorer, select Business Service.
b In the Business Services list, perform a query where:
❏ Project is XMLP Integration
❏ Name is PublicReportService
c Check the Business Service user properties to confirm the following:
❏ 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
d In the Object Explorer, select Integration Object, and query for the XMLP Integration project.
Verify there are 128 objects.
e Compile the SRF.
f Restart the Siebel Server.
5 In the Siebel application, remove the old version of the PublicReportService outbound Web
service by doing the following:
a Navigate to the Administration - Web Service screen, then the Outbound Web Service view.
b In the name field, query for PublicReportServiceService, and then delete the service that does
not show PublicReportService_v11 as the server port name.
NOTE: Two Web services appear; make sure you delete the correct one.
6 Make sure the service port address corresponds to the Oracle BI Publisher Server by doing the
following:
a Navigate to the Administration - Web Services screen, then the Outbound Web Service view.
b In the Name field, query for PublicReportServiceService.

Integrating Oracle BI Publisher with Siebel Business Applications ■ Enabling Siebel
Server Components for Siebel Reports
c Make sure that the service port address corresponds to the Oracle BI Publisher Server.
The format is:
http://host.domain:port/xmlpserver/services/PublicReportServiceService
where:
❏ host.domain is the full path for the Oracle BI Publisher Server
❏ port is the port that the Oracle BI Publisher Server uses
For example, the address might be:
http://BIPServerHostName:9704/xmlpserver/services/PublicReportServiceService
TIP: Other than in this specific procedure, there is typically no need to change this address
because it is automatically populated when you configure the business service and the Web
service in Siebel Tools using the Web service wizard.
7 Click Clear Cache to make sure that the changes are propagated to run-time memory.
Enabling Siebel Server Components for

Siebel Reports
Before you can work with Siebel Reports, you must make sure several Siebel Server components are
enabled. This task is applicable to first-time installations and upgrades, unless otherwise indicated.
on page 35.
To enable server components for Siebel Reports

1 Navigate to the Administration - Server Configuration screen, Enterprises, then the Component
Definitions view.
2 (First-time installation only) Enable the following server components:
Component Name Component Alias Component Group
XMLP Report Server XMLPReportServer XMLP Report
EAI Object Manager (ENU) EAIObjMgr_enu Enterprise Application Integration
NOTE: If you are upgrading, you only need confirm these components are active. Additionally,
the XMLP Report Server component might already be enabled depending on how you configured
your original Siebel Server installation.
3 (Optional) Enable the Workflow server component.
NOTE: Enable this component if you plan to use workflow, the Reports Business Service, or the
XMLP Purge Records workflow.
For information about enabling Siebel Server components, see Siebel System Administration Guide.

Integrating Oracle BI Publisher with Siebel Business Applications ■ About Associating
Siebel Reports Views with Siebel Responsibilities
About Associating Siebel Reports Views

with Siebel Responsibilities
Table 5 provides a matrix showing an association of Siebel Reports views with Siebel Reports
responsibilities. It is recommended that you implement your associations in this manner, however,
you can configure specific to your deployment. For more information, see “Configuring Security and
Authentication for Siebel Reports” on page 50.
Table 5. Siebel Reports Views and Responsibilities
Responsibility
XMLP_ XMLP_ XMLP_ XMLP_

View ADMIN SCHEDULER DEVELOPER SIEBEL_GUEST
Report Job List View Yes Yes No No
Report Output List View Yes No No Yes
All Report Output List View Yes No No Yes
All Report Template View Yes No Yes No
Manager’s Report Output List View Yes No No Yes
Manager’s Report Template View Yes No Yes No
Report Template Registration View Yes No Yes No
Report Standard Template Yes No Yes No

Registration Admin View
All Report Template Across Yes No Yes No

Organization View
Related Topics
“Setting Up and Enabling the Siebel Security Model for Siebel Reports” on page 51
About Security and Authentication for

Siebel Reports
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.
There are several options to choose from for configuring security and authentication for Siebel
Reports. This topic provides a high-level description of each option and provides links to the
instructions for implementing each option.

Integrating Oracle BI Publisher with Siebel Business Applications ■ About Oracle
Business Intelligence Enterprise Edition Coexistence with Siebel Reports
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.
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.
NOTE: It is recommended that you use this model because it was designed specifically for use with
Siebel Reports.
LDAP
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.
Web Single Sign-On Authentication

This model allows you to use a nonstandard security model, such as Siteminder or some other type
of custom single sign-on.
Oracle BI Publisher Security

With Oracle BI Publisher Security authentication for Siebel user access to Oracle BI Publisher Server,
all connections between the Siebel application and Oracle BI Publisher Server are made using the
same generic user account.
About Oracle Business Intelligence

Enterprise Edition Coexistence with
Siebel Reports
Oracle Business Intelligence Enterprise Edition (OBIEE) is a comprehensive business intelligence
platform that delivers a full range of analytic and reporting capabilities. If you set up Siebel Business
Applications with Oracle BI Publisher for Siebel Reports to use an existing Oracle BI Publisher
enterprise server that is part of an OBIEE server, then you have two security options to choose from:
■ LDAP security model (recommended)
For LDAP security information relating to Siebel Reports, see “Configuring Security and
Authentication for Siebel Reports Using LDAP” on page 55.

Integrating Oracle BI Publisher with Siebel Business Applications ■ About
Configuring Security and Authentication for Siebel Reports
■ Oracle BI Server Security model
For the Oracle BI Server Security model, you must define all users and those users must belong
to designated groups in OBIEE. For more information, see “Configuring Security and
Authentication for Siebel Reports Using Oracle BI Publisher Security” on page 56.
About Configuring Security and

Authentication for Siebel Reports
Authentication between the Siebel application and Oracle BI Publisher Server performs the following:
1 Checks that a user exists in the directory as follows:
■ For LDAP, checks for a user in the directory.
■ For Siebel Security, checks by way of the endpoint that a user exists in the Siebel application.
2 Checks that a user has certain roles depending on what action they are taking:
■ For LDAP, groups are created which relate to the Oracle BI Publisher roles. Users in the LDAP
directory have these certain groups assigned to them. Oracle BI Publisher authentication to
LDAP directory checks for a user if they have a certain group.
■ For Siebel Security, each user has certain XMLP responsibilities. Oracle BI Publisher
authentication to the Siebel application, by way of an endpoint inbound Web service call,
checks that a user has the correct responsibilities that relate to the Oracle BI Publisher roles.
3 Checks Siebel XMLP responsibilities that control the Siebel user interface for Reports menu
restrictions (for example, XMLP_SCHEDULER responsibility for the scheduling option).
Configuring Security and Authentication

for Siebel Reports
on page 35. For more information about security and authentication for Siebel Reports, see “About
Security and Authentication for Siebel Reports” on page 48.
To configure security and authentication for Siebel Reports

■ Perform one of the following:
■ “Setting Up and Enabling the Siebel Security Model for Siebel Reports” on page 51
■ “Configuring Security and Authentication for Siebel Reports Using LDAP” on page 55
■ “Configuring Siebel Reports in a Web Single Sign-On Environment” on page 56
■ “Configuring Security and Authentication for Siebel Reports Using Oracle BI Publisher Security”
on page 56

Integrating Oracle BI Publisher with Siebel Business Applications ■ Configuring
Security and Authentication for Siebel Reports
Setting Up and Enabling the Siebel Security Model for

Siebel Reports
To set up the Siebel Security Model for Siebel Reports, the address field on the service port of the
Siebel Server must reflect the name of the computer hosting the Oracle BI Publisher Server. You must
also make sure certain responsibilities are assigned users and associated to the correct views. If this
is a first-time Siebel Reports installation, you must also enable the Siebel Security Model.
NOTE: It is recommended that you use this security model. It is designed specifically for use with
Siebel Reports.
This task is a step in “Configuring Security and Authentication for Siebel Reports” on page 50.
To set up and enable the Siebel Security Model for Siebel Reports
1 (First-time install only) Create the inbound Web service for the Siebel application 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) to create a new inbound Web service.
c In the Name field, query for BIPSiebelSecurityWS.
d Change the host and port number of the server port’s address to that of the Siebel Server.
For example, you might replace the existing address with:
http:/computer.domain.com/eai_enu/
start.swe?SWEExtSource=WebService&SWEExtCmd=Execute
e Clear the cache.
2 (Upgrade only) Change view names in the Siebel application to reflect repository changes: For
v81F, Rupa confirmed step is necessary.
a Navigate to the Administration - Application screen, then the Views view.
b In the View Name field, query for the following views and rename them:
Existing View Name New View Name
All Template View All Report Template View
Manager’s Report Template View Manager’s Report Template View
c Clear the cache, log out of the Siebel application, and then log back in.
3 (First-time installation only) Create four new responsibilities and add appropriate users to each by

a Navigate to the Administration - Application screen, then the Responsibilities view to create the
responsibilities described in the following table.
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
Siebel application to the Oracle BI Publisher Server.
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.
b Add appropriate users to each of the new responsibilities.
4 (Upgrade only) Verify the following responsibilities exist and confirm each are assigned the
appropriate users:
■ XMLP_ADMIN
■ XMLP_DEVELOPER
■ XMLP_SCHEDULER
■ XMLP_SIEBEL_GUEST
5 (First-time installation only) Create the following views:

■ All Report Output List View
■ All Report Template View
■ Manager's Report Output List View
■ Manager's Report Template View
■ Report Template Registration Admin View
■ Report Output List View
■ Report Standard Template Registration Admin View
■ All Report Template Across Organization View
■ Report Job List View
6 Make sure the scheduling views are associated with the appropriate responsibilities and users by
a Associate the XMLP_ADMIN responsibility to all views, then assign that responsibility to just
administrators.

b Associate the XMLP_SCHEDULER responsibility to the Report Job List View, and then assign that
responsibility only to those users who run scheduled reports.
c Do not associate any views to the following responsibilities:
❏ XMLP_DEVELOPER
❏ SIEBEL_GUEST
d Assign responsibilities to the appropriate users.
For more information about Siebel Reports views and responsibilities, see “Configuring Security
and Authentication for Siebel Reports” on page 50.
7 If changes are necessary, clear the cache, log out of the Siebel application, and then log back in.
8 (First-time installation only) Verify your configurations by doing the following:
a From the Reports drop-down list, 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.
c Confirm the views were added to the appropriate screens as shown in the following table.
View Screen
All Report Output List View Reports Server Screen
All Report Template View Report Administration
Manager's Report Output List View Reports Server Screen
Manager's Report Template View Report Administration

Report Template Registration View Report Administration
Report Standard Template Registration Admin View Report Administration Screen
All Report Template Across Organization View Report Administration Screen
9 (First-time installation only) Enable the Siebel Security Model 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 Security Configuration (under Security Center).
c In the Security Model section, perform the following, and then click Apply:
❏ Set the model to Siebel Security

❏ Enter the host name and port as the Web Service Endpoint

❏ Enter the Siebel administrator credentials
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.
The following table provides sample parameter values for a Siebel Security model
configuration.
Parameter Value
Security Model Siebel Security
Siebel Web Service http:/host.domain.com/eai_enu/

Endpoint start.swe?SWEExtSource=WebService&SWEExtCmd=Execute
Administrator NOTE: username User name is the Siebel administrator user

Username name.
Administrator password
Password
NOTE: Password is the Siebel administrator password. The
password for an account cannot be the same as the user name for
that account.
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.
10 Restart the Oracle BI Publisher Server.

For information about restarting the Oracle BI Publisher Server, see “Restarting OC4J and Oracle
BI Publisher” on page 44.
11 (First-time installation only) Verify that the Siebel Security Model has been implemented by doing
the following:
a Start the Oracle BI Publisher Enterprise application (from the Start Menu, choose Start BI
Publisher).
b Log in to the Oracle BI Publisher Enterprise application using the Siebel administrator
credentials.
The Siebel Security Model was successfully implemented if you are able to login using the Siebel
credentials.
12 Add an explicit classpath and add a new wlfullclient.jar file to the XMLPJvmSubsys profile for the
Oracle BI Publisher Server.
For instructions, see “Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server”
on page 57.
Related Topics
“Configuring Security and Authentication for Siebel Reports” on page 50

Configuring Security and Authentication for Siebel

Reports Using LDAP
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.
When implementing 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.
To configure security and authentication for Siebel Reports using LDAP

■ Follow the instructions in 1103065.1 (Article 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.
Example of Configuring Security and Authentication for Siebel Reports

Using LDAP
This topic gives one example of an LDAP directory configuration that can be used with a Siebel
application to Oracle BI Publisher integration. You might use this feature differently, depending on
your business model.
NOTE: Make sure you have configured both the Siebel application and Oracle BI Publisher so that
both are pointing to the appropriate LDAP directory.
To configure security and authentication for Siebel Reports using LDAP

1 In the LDAP server, create the following six groups:
■ XMLP_ADMIN
■ XMLP_DEVELOPER
■ SIEBEL_DEV
■ SIEBEL_ADMIN
■ SIEBEL_SCHEDULER
■ XMLP_SCHEDULER
2 Associate members to the groups.
3 Associate the LDAP users to relevant members.
These tasks ensure that when Oracle BI Publisher Server authenticates with the LDAP directory, the
correct roles are used for each user and limits the reporting actions that a user can perform.

Configuring Siebel Reports in a Web Single Sign-On

Environment
To configure Siebel Reports in a Web single sign-on environment

■ Follow the instructions in 1117126.1 (Article ID) on My Oracle Support.
For more information, see the topic about Web single sign-on authentication in Siebel Security Guide.
Configuring Security and Authentication for Siebel

Reports Using Oracle BI Publisher Security
This topic describes how to implement Oracle BI Publisher Security authentication to manage user
access to Oracle BI Publisher Server in a Siebel Reports connected environment.
When implementing Oracle BI Publisher Security authentication for Siebel user access to Oracle BI
Publisher Server, all connections between the Siebel application and Oracle BI Publisher Server are
made using the same generic user account. This generic user account is useful for certain security
topologies where multiple applications and authentication directories are used with a single shared
Oracle BI Publisher Server instance.
NOTE: This security model does not support private scheduled reports. All scheduled reports are
public.
To configure security and authentication for Siebel Reports Using Oracle BI

Publisher Security
1 Make sure the Oracle BI Publisher Server is started.
2 Log in to Oracle BI Publisher.
3 Click Admin tab, and then select Security Configuration under Security Center.
4 Under the Security Model section, select BI Publisher Security.
5 Restart the Oracle BI Publisher Server.
6 Log in to the Siebel application with administrator privileges.
7 Enter the BI Publisher user name and password by doing the following:
a Navigate to the Administration - Server Configuration screen, Enterprises, and then the
Component Definitions view.
b In the Component field, query for XMLP*.
The definition for the XMLP Report Server component appears.

Integrating Oracle BI Publisher with Siebel Business Applications ■ Adding an Explicit
Reference to JAR Files for the Oracle BI Publisher Server
c Scroll down to the Component parameters subview, and then enter the appropriate values for:
❏ BIP Server Login
❏ BIP Server Password
8 Restart the Siebel Server
Adding an Explicit Reference to JAR Files

for the Oracle BI Publisher Server
You must add an explicit reference to the Siebel JAR files for the Oracle BI Publisher Server to upload
templates and run immediate reports. 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.
The task is a step in “Roadmap for Integrating Oracle BI Publisher with Siebel Business Applications” on
page 35.
NOTE: If you are upgrading, you only need add the new wlfullclient.jar file to the explicit classpath
(see Step 3 on page 58), and then restart the Siebel Services.
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.

Integrating Oracle BI Publisher with Siebel Business Applications ■ Adding an Explicit
Reference to JAR Files for the Oracle BI Publisher Server
2 Select the XMLPJvmSubsys profile.
3 In the Profile Parameters subview, provide a reference to each of the JAR files in the CLASSES
directory in the Siebel application root directory and set the JVM DLL Name. Some of the values
are provided in the following table. Make sure that the paths correctly locate the required files.
Parameter Value
JVM <SIEBSRVR_ROOT>/classes/Siebel.jar;<SIEBSRVR_ROOT>/classes/
Classpath SiebelXMLP.jar;<SIEBSRVR_ROOT>/classes/wlfullclient.jar
where:
SIEBSRVR_ROOT is the actual path where the Siebel Server is installed.

NOTE: For UNIX, replace <SIEBSRVR_ROOT> with ${SIEBEL_HOME}.
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 178.
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.
JVM DLL For AIX, Linux, and Oracle Solaris:

Name <path to libjvm.so_file>
For HP-UX:
<path to libjvm.sl_file>
For Windows:
<path to jvm.dll >
For example, c:\Program

Files\Java\jdk1.6.0_xx\jre\client\bin\jvm.dll
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.
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 similar to the following:
/usr/jdk1.6.0_xx/jre/bin/j9vm/libjvm.so
b Set the JAVA_HOME environment variable.
For example:
/usr/java

Integrating Oracle BI Publisher with Siebel Business Applications ■ Uploading
Preconfigured Report Layout Templates to the Oracle BI Publisher Server
c Set the LIBPATH ${LIBPATH} environment variable.
For example:
/usr/jdk1.6.0_xx/jre/bin:/usr/jdk1.6.0_xx/jre/bin/j9vm
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 (Article 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 68.
Additionally, if you have a multiple Siebel Server environment, see “Uploading New or Modified Report
Layout Templates for Multiple Siebel Server Environments” on page 69.
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 171.
page 35.
To upload preconfigured report layout templates to the Oracle BI Publisher Server

1 Navigate to the Administration - BI Publisher Reports screen, then the Reports - Standard
Templates view.
2 From the application-level menu, select Edit, and then Select All.
3 Click Upload Files.
4 Set the proper access permissions to the SiebelCRMReports folder by performing the following:
b Open a new browser window and navigate to the Oracle BI Publisher Server at
http://BIPServerHostName:port/xmlpserver
c Click the Admin tab, select Roles and Permissions, and then locate the XMLP roles (XMLP_*).
TIP: These roles begin with XMLP and are listed in alphabetical order.
d For each report responsibility, click Add Folders to grant permission to the shared
SiebelCRMReports folder.
e Restart the Oracle BI Publisher Server.

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 both the
Siebel application and Oracle BI Publisher. For information about how to schedule reports, see
Chapter 8, “Scheduling Reports.”
on page 35.
To enable and configure report scheduling, perform the following tasks:
1 (First-time installation only) “Setting Up the Database Schema for the Oracle BI Publisher Server”
on page 60
2 “Configuring the Data Service WSDL for the Oracle BI Publisher Server” on page 61
3 “Verifying Symbolic URL Arguments That Embed the Oracle BI Publisher Scheduling Views in the
Siebel Application” on page 62
Setting Up the Database Schema for the Oracle BI

Publisher Server
The task is a step in “Process of Enabling and Configuring Report Scheduling” on page 60.
To set up the database schema for the Oracle BI Publisher Server

1 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 (http://www.oracle.com/technetwork/indexes/
documentation/index.html) to:
■ Set up a new database instance.

■ Create a user with privileges to add tables.
■ Create the database connection.
■ Install the schema by doing the following:
b Click the Admin tab, and then select Scheduler Configuration.

c Select the database type applicable to your deployment and provide information as shown in the
following table.
Database Enter
Oracle Connection String->jdbc:oracle:thin:@[host]:[port]:[SID]
dbtableowner is nothing but user name and password
host-is nothing but databaseserver
port-is nothing but LM_DB_port
[SID]-is nothing but dbinstance
Data base driver class: oracle.jdbc.OracleDriver
MSSQL connection string:jdbc:hyperion:sqlserver://

databaseserver:LM_DB_port;DatabaseName=databasename
username:username
password:password
Data base driver class: hyperion.jdbc.sqlserver.SQLServerDriver
db2 Connection String:
jdbc:hyperion:db2://
BIPServerHostName:port;DatabaseName=<DATABASENAME>
username:username
password:password
d Click Test Connection to make sure that the connection works.

e Click Install Schema.
The tables are automatically created.
2 Restart both the Oracle BI Publisher Server and the Siebel Server (or servers).
Configuring the Data Service 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.

To configure the data service WSDL for the Oracle BI Publisher Server
1 Log in to the Siebel application as a Siebel administrator.
2 Navigate to the Administration - Web Services screen, then the Inbound Web Services view.
3 Configure the address for the BIPDataService Web service with the host name and port number
of the Siebel Server and modify the credentials to correspond to the username, login, and
password used for logging in to the Siebel EAI object manager.
4 Select BIPDataService, and then click Generate WSDL.
5 Save the WSDL as a new data service file named dataservice.wsdl in a directory in the Oracle BI
Publisher home directory (by default, this is the \OraHome_X\oc4j_bi\bin directory).
For example, you might save the file as:
D:\OraHome_1\oc4j_bi\bin\dataservice.wsdl
NOTE: You must use lower case to match existing references.
The WSDL is now available for importing.
Verifying Symbolic URL Arguments That Embed the

Oracle BI Publisher Scheduling Views 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. 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 verify symbolic URL arguments that embed the Oracle BI Publisher Scheduling
Views in the Siebel application
1 Navigate to the Administration - Integration screen, then the Host Administration view.
2 Add a new record with the following values:
■ Name is host:port
■ Virtual Name is biphost
where host:port is the Oracle BI Publisher host address you choose from a picklist.
3 Navigate to the Administration - Integration screen, then the Symbolic URL Administration view.
4 Add a new record with the following values:
■ Name is BIPReportJobListPage

Integrating Oracle BI Publisher with Siebel Business Applications ■ Testing Your
Siebel Reports Integration Configurations
■ URL is http://biphost/xmlpserver/servlet/myhistory
■ Host Name is host:port
■ Fixup Name is Default
■ SSO Disposition is IFrame
5 Add new records in Symbolic URL Arguments.
Required Argument
Argument Name Argument Type Argument Value
PreloadUrl Yes Command http://biphost/xmlpserver/signout.jsp
PreloadUrlPerSession Yes Command True
uid Yes Field BIPUser
NOTE: For upgrades only,

you must rename this
argument to uid from id.
anyname Yes Command PostRequest
passwd Yes Field BIPPassword
_xuil Yes Field BIPLanguage
NOTE: This argument is

applicable only for non-
English deployments.
pgheader Yes Constant hide
6 Log out of the Siebel application, and then log in again.
7 (Upgrade only) Confirm the new monthly scheduling List of Value (LOV) is available by doing the
following:
a Log in to the Siebel application as a Siebel administrator.

b Navigate to the Administration - Data screen, then the List of Values view.
c In the List of Values view, make sure there is Monthly value for the XMLP_RPT_SCHEDULE_MODE
type.
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.
page 35.

Upgrading Siebel Reports
To test your Siebel Reports integration configurations

1 Log in to the Siebel application as an administrator.
2 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.
3 Generate an Oracle BI Publisher report (or reports) by doing the following:
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: When you create your own custom reports, you must upload the report template and
associate it with a view before you can use that report.
For more information about generating reports, see Chapter 6, “Generating Reports.”
Roadmap for Upgrading Siebel Reports

If you currently have an existing Siebel Reports environment and you want to use the latest reporting
features, then you must perform several upgrade tasks. It is recommended that you print out the
following process to use as a checklist as you work your way through the upgrade.
To upgrade Siebel Reports, perform the following tasks:
1 Prepare for the upgrade by doing the following:
a Make sure you have a Siebel CRM version 8.1.1 or later environment and have applied the latest
Siebel CRM Fix Pack 8.1.1.x.
b Upgrade to the appropriate Java Development Kit (JDK) version and make sure the JAVA_HOME
system environment variable points to the JDK.
For the applicable versions for your deployment, see version 8.1.1.x Siebel System Requirements
and Supported Platforms on Oracle Technology Network.
2 Make sure you have the appropriate Oracle Business Intelligence Publisher software installed:

■ Oracle Business Intelligence Publisher Add-in for Microsoft Word (also known as Oracle BI
Publisher Desktop)
For the applicable version for your deployment, see Siebel System Requirements and Supported
Platforms on Oracle Technology Network. For more information, see “Upgrading to the Latest
Oracle BI Publisher Patch” on page 45.
4 Apply the latest repository, schema, and seed data changes for ACR 719b.
For instructions, see 880452.1 (Article ID), Siebel Maintenance Release Guide on My Oracle
Support.
5 (Optional) Enable the Workflow server component.
For instructions, see “Enabling Siebel Server Components for Siebel Reports” on page 47.
6 Perform the following:
a Change view names in the Siebel application to reflect repository changes.
b Verify XMLP responsibilities, report views, and user assignments.
For instructions, see “Setting Up and Enabling the Siebel Security Model for Siebel Reports” on
page 51.
NOTE: Many of the steps in this task are applicable only to first-time installations. Make sure to
perform only steps indicated for upgrades.
7 Add a new wlfullclient.jar file to the XMLPJvmSubsys classpath for the Oracle BI Publisher Server.
For instructions, see “Adding an Explicit Reference to JAR Files for the Oracle BI Publisher Server”
on page 57.
8 “Uploading Preconfigured Report Layout Templates to the Oracle BI Publisher Server” on page 59
9 Configure report scheduling by doing the following:
a “Configuring the Data Service WSDL for the Oracle BI Publisher Server” on page 61
b Change the id symbolic URL argument name to uid and create a new pgheader argument.
For instructions, see “Verifying Symbolic URL Arguments That Embed the Oracle BI Publisher
Scheduling Views in the Siebel Application” on page 62.
10 “Testing Your Siebel Reports Integration Configurations” on page 63


5 Administering Siebel Reports
This chapter describes some of the administrative tasks for Siebel Reports. The tasks in this chapter
are for administrators only and are applicable to both connected and disconnected modes unless
otherwise indicated. This chapter includes the following topics:
■ Deploying Report Layout Templates to the Siebel Web Client from a Disconnected Client on page 68
■ Uploading New or Modified Report Layout Templates for Multiple Siebel Server Environments
■ Configuring the Reports Icon on page 69
■ Disabling and Enabling the Reports Icon on page 70
■ Renaming Siebel Reports Menu Items on page 70
■ About Controlling Access to Reports on page 71
■ Automatically Purging Reports from the Siebel File System on page 71
■ Purging Scheduled Reports from the Oracle BI Publisher Server on page 72
■ Changing the Location of the Oracle BI Publisher Repository for Siebel Reports on page 73
■ Copying Fonts for Report Generation on page 75
■ About Working with Multilingual Reports on page 76
■ Designing Multilingual Reports on page 77
■ Roadmap for Uploading Multilingual Reports to the Siebel Application on page 79
■ Adding and Deleting Locales from Report Templates on page 80
■ About Report Translation on page 81
■ Roadmap for Optimizing the Performance of Siebel Reports on page 82
■ Setting the Report Execution Waiting Period for Reports on page 82
■ Setting the Server Request Processor Database Polling Interval for Siebel Reports on page 83
■ Setting Concurrency Parameters for Siebel Reports on page 84
■ Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes on
page 85
■ About Increasing the Java Heap Size on Oracle BI Publisher Server on page 89
■ About Reducing the Size of an Integration Object on page 89

Administering Siebel Reports ■ Deploying Report Layout Templates to the Siebel Web
Client from a Disconnected Client
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.
Report templates and associated XLIFF translation files are stored in the Siebel File System and are
synchronized to the Siebel Server when a Mobile Client performs a synchronization. After you click
Upload in the user interface, 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)
■ 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

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 127.
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:

Administering Siebel Reports ■ Uploading New or Modified Report Layout Templates for
Multiple Siebel Server Environments
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.
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.
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 files.
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.
Configuring the Reports Icon

By default, the Reports icon appears in Siebel Business Applications below the application-level
menu. However, you have the option to disable it or alter which menu items appear and how they
display in the user interface.
To configure the Reports icon, perform the following tasks:
■ (Optional) “Disabling and Enabling the Reports Icon” on page 70

Administering Siebel Reports ■ Configuring the Reports Icon
■ (Optional) “Renaming Siebel Reports Menu Items” on page 70
Disabling and Enabling the Reports Icon

By default, the Reports icon appears in Siebel Business Applications below the application-level
menu. You can disable it by setting the ReportEngineType system preference in the Siebel Business
Applications. If this system preference is set to NONE, then the Reports icon does not appear.
NOTE: If the Reports icon is disabled, then you can still execute reports using Siebel workflows or
Siebel business services. For more information, see “Report Business Service” on page 181.
Disabling the Reports Icon

Use the following procedure to disable the Reports icon.
To disable the Reports icon

2 Navigate to the Administration - Application screen, then the System Preferences view.
3 Query for ReportEngineType and then set the System Preferences value to NONE.
4 Restart the Siebel Server to verify the Reports icon does not appear.
Enabling the Reports Icon

Use the following procedure to enable the Reports icon.
3 Query for ReportEngineType and then set the System Preferences value to BIP.
4 Restart the Siebel Server to verify the change.
Renaming Siebel Reports Menu Items

The Reports menu in Siebel Business Applications is customizable. You can change the text strings
that appear in the UI for the following menu items:
■ My BI Publisher Reports
■ Schedule Report
NOTE: By default, the scheduling option appears on the Reports menu only if a user has been
assigned the XMLP_SCHEDULER responsibility. For more information about reports
responsibilities, see “Setting Up and Enabling the Siebel Security Model for Siebel Reports” on
page 51.

Administering Siebel Reports ■ About Controlling Access to Reports
For example, you might want to change the My BI Publisher Reports in the Reports menu to
Generated Reports or something similar.
Using Siebel Tools, you rename Siebel Reports menu items by configuring symbolic strings to change
the text string.
To rename a Siebel Reports menu item

1 Log in to Siebel Tools with administrator privileges.
2 In the Object Explorer, select the Symbolic String object.
3 Perform one of the following:
a To change the My BI Publisher Reports menu item, query for SBL_MY_BIPUBLISHER_REPORTS,

and then edit the Current String Value.
b To change the Schedule Report menu item, query for SBL_SCHEDULE_REPORTS, and then edit
the Current String Value.
4 Compile the Symbolic String project, distribute the updated SRF, and then restart the Siebel Server.
5 Verify your changes by doing the following:
a Launch the Siebel application, and then navigate to any screen.
b Click Reports to view your changes.
About Controlling Access to Reports

Standard Siebel Business Applications access controls apply to Siebel Reports. For standard report
templates, access is controlled by way of a view to report relationship. For custom report templates,
you can apply position- and organization-based visibility to configure which report templates are
made available to users. You can also share completed reports using position-based visibility. For
more information about user access in relation to Siebel Reports, see “About Security and
Authentication for Siebel Reports” on page 48. For more information about granting access to others,
see “Sharing Report Layout Templates” on page 125. For general information about access controls,
see Siebel Security Guide.
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 72.

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
from the database and the Siebel File System after the number of days specified. For example, if you
want to keep reports for the last seven days, but remove all reports after this time frame, then you
set the value to 7.
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 101.
To automatically purge reports from the Siebel File System

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. Setting this
parameter to a low value 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.

Administering Siebel Reports ■ Changing the Location of the Oracle BI Publisher
Repository for Siebel Reports
This topic describes how to purge reports using either the Job Manager Instances List or the Job
Manager Purge Instances Window.
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 (http://
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 135.
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 71.
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, then 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 (http://www.oracle.com/technetwork/
indexes/documentation/index.html).
If you do not want to use ${oracle.home}/xdo/repository as the location of your Oracle BI

Publisher repository, then there are three different ways you can change it:
■ Create a custom XML file
For instructions, see “Changing the Location of the Oracle BI Publisher Repository by Creating a
Custom XML File” on page 74.
■ Replace a JVM property name
For instructions, see “Changing the Location of the Oracle BI Publisher Repository by Replacing a
JVM Property Name” on page 74
■ Change the absolute path to the repository
For instructions, see “Changing the Location of the Oracle BI Publisher Repository by Changing the
Absolute Path to the Repository” on page 75.

Administering Siebel Reports ■ Changing the Location of the Oracle BI Publisher
Repository for Siebel Reports
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.
This task is a step in “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports”
on page 73.
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">
<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

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.

Administering Siebel Reports ■ Copying Fonts for Report Generation
on page 73.
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.

Repository by Changing the Absolute Path to the
Repository
on page 73.
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.
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, then 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.
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).

Administering Siebel Reports ■ About Working with Multilingual Reports
■ 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.
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. A locale is a language and locale combination as defined in
the Locale Administration in the Siebel application.
Siebel Reports allows you to:
■ Configure reports that are generated for a specific locale.
■ Make sure that a report is generated against a particular Siebel record with a preference for a
specific document 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 locale preference for their own report generation.
■ Let users override the default locale values when generating reports.
■ Execute report generation using the default locale settings of the user’s session object manager.
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 locale is 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 for an
individual report (see Run-time Selection in this table).
Entity related 2 The Report Business Service is configurable for locale as an optional
(business service) inputs. If the locale is 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,
then the default application object manager values are used.
NOTE: Only use locale values as business service inputs when these
values are not set at the template level.

Administering Siebel Reports ■ Designing Multilingual Reports
Table 6. How Siebel Reports Determines the Report Language at Run Time
Default
Preference Order Description
User preferences 3 If the report layout template does not have a default locale, and the
user has set a locale property in their user preferences, then 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 Locale User
Preferences for Reports” on page 101.
Run-time selection 4 Users can override the default locale values when generating a
report.
No language or 5 If no default locale is specified in the report layout template level or

locale specified in the user preferences, then the current application object manager
values for the session are used.
Related Topics
“Roadmap for Uploading Multilingual Reports to the Siebel Application” on page 79
“Adding and Deleting Locales from Report Templates” on page 80
“About Report Translation” on page 81
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 81. 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 120.
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 107.
4 (Optional) Add a default locale to the report template.

Administering Siebel Reports ■ Designing Multilingual Reports
Related Topics
“About Working with Multilingual Reports” on page 76

Administering Siebel Reports ■ Roadmap for Uploading Multilingual Reports to the Siebel
Application
Roadmap for Uploading Multilingual

Reports to the Siebel Application
This topic describes how to upload multilingual reports to the Siebel application. You might use this
feature differently, depending on your business model.
To upload a multilingual report to the Siebel application, perform the following tasks and processes:
1 Associate the RTF layout template file with the report using the appropriate report template
registration view (Reports - Standard Templates or Reports - Custom Templates). For
information, see “Registering Report Layout Templates” on page 120.
2 Associate an XLIFF or ZIP file with the report record using the following guidelines:
■ To upload a single or multiple XLIFF files, use the following naming convention:
Report Template Filename_langcode1.xlf
where:
❏ Report Template Filename is the physical RTF filename
❏ langcode is the language code abbreviation
For example, aclist_enu.xlf.
■ To upload a ZIP file the naming convention should be in the form:
Report Template Filename.zip
NOTE: All files names are case insensitive.
3 Click Upload.
The files are stored as follows:
■ RTF file. The file is stored the SIEBEL_ROOT\XMLP\TEMPLATES directory. The RTF file and
associated XLIFF files are uploaded to Oracle BI Publisher Server in the appropriate folders.
■ ZIP file. The file is stored in the SIEBEL_ROOT\XMLP\xliff directory. The ZIP file is
automatically decompressed to the SIEBEL_ROOT\XMLP\xliff\locale_code folder.
NOTE: Validation occurs during the upload, and if any issues arise, an error message appears
and the uploaded files are deleted. For information about this validation, see “Registering Report
Layout Templates” on page 120.
4 Register the report, add the languages to the Translations list in the appropriate report
registration view (Reports - Standard Templates or Reports - Custom Templates). For
instructions, see “Registering Report Layout Templates” on page 120.
The report layout template and the associated XLIFF translation files are now registered.
5 Log in to Oracle BI Publisher Server to review the structure of the registration.
Each XLIFF file is registered using the format TemplateName_language code_TERRITORY

CODE.xlf. For more information about translation naming conventions, see Oracle Business
Intelligence Publisher Report Designer's Guide on Oracle Technology Network (http://

Administering Siebel Reports ■ Adding and Deleting Locales from Report Templates
Related Topics
Adding and Deleting Locales from Report

Templates
This topic describes how to add and delete locales from report templates.
Adding a Locale to a Report

Use the following procedure to add a locale to a report template.
To add a locale 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 locale.
4 In the Translations subview, click New.
5 In the Language field, add a new language, and then click OK.
6 (Optional) If you want a different name for the translated report to appear in the Reports menu,
enter a Report Name.
Deleting a Locale from a Report

Use the following procedure to delete a locale from a report template.
To delete a locale from a report

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

Administering Siebel Reports ■ About Report Translation
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.
Related Topics
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. For more
information about XLIFF files related to Siebel Reports, see “Siebel Reports Directory Structure” on
page 27.
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
When multilingual reports are generated for a specific report locale, the following occurs for each
component of the report translation:
■ Template text elements. Translation is determined by way of the translations in the relevant
XLIFF file.
■ MLOVs. Translation is determined based on the selected report locale and LOV data extracted
by way of EAI in the relevant language.
■ Dates and currency formatting. The format of date, time, and currency fields is based on the
template functions: format-date() and format-currency(). Both of these Oracle BI Publisher
functions use the locale code specified for the report generation to determine the correct format
to display based on the Oracle BI Publisher locale format definitions.
CAUTION: Each translated report must have a unique translated display name. If there are duplicate
names for translated reports, then when those names pass from the browser to the Siebel Server,
the server cannot differentiate which report to generate.
Related Topics

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

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 82
■ “Setting the Server Request Processor Database Polling Interval for Siebel Reports” on page 83
■ “Setting Concurrency Parameters for Siebel Reports” on page 84
■ “Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes” on
page 85
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
It is recommended that you limit the wait time for report execution. You do so by setting a threshold
value in seconds for the BIP Report Wait Time system preference. The minimum threshold value
allowed is 0, which sends all reports into the background. By setting the value greater than 0
seconds, users can return to the Siebel application while their reports generate in the background.
After the threshold is reached, and if a report is still generating, a message appears stating that the
report is running in the background and to retrieve the report from the BI Publisher Reports view.
For information about this view, see “Generating Reports” on page 95.
This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 82.
To set the report execution waiting period for reports

2 In the System Preferences list, select BIP Report Wait Time, and then change the System
Preference Value to a number greater than 0.
Related Topics
Setting Concurrency Parameters for Siebel Reports

Administering Siebel Reports ■ Setting the Server Request Processor Database Polling
Interval 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.
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

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).
NOTE: A single Oracle BI Publisher instance running on OC4J platform can handle approximately
1500 concurrent users.
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

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

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
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 82 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 (Article ID) on My Oracle Support.
2 “Enabling Scalable Mode for Siebel Reports” on page 85.
3 “Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports” on page 87.
4 “Increasing EAI HTTP Transport Sleep Time for Siebel Reports” on page 88.
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
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.

This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large
Data Volumes” on page 85 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 affect 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>


<property name="system-temp-dir">D:\Temp</property>
<property name="xslt-scalable">true</property>
</properties>

<fonts>

<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" />

</font>

<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.
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:

<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
The integration from Siebel Business Applications to Oracle BI Publisher uses an outbound Web
service call. This invokes the PublicReportServiceService Web service on Oracle BI Publisher Server.
Siebel outbound Web services use the EAI HTTP Transport business service for sending the HTTP
request. By default, HTTPSleepTime is set to 120000 milliseconds (two minutes). If the generation
of the Oracle BI Publisher report takes over two minutes, then an error occurs as a result of the
timeout. However, typically errors occur only with very large and complex reports.
This step is a task in “Roadmap for Optimizing the Performance of Siebel Reports” on page 82.
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.
To increase EAI HTTP transport sleep time for Siebel Reports

1 Log in to Siebel Tools.
2 In the Object Explorer, select the Business Service object.
3 In the Object List Editor, query for XMLP Driver Service.
4 In the Object Explorer, select Business Service Method, select the GenerateBIPReport method,
and then the HTTPSleepTime Business Service Method Arg.
5 Set the value for HTTPSleepTime accordingly.
6 Compile the SRF.
Related Topics
“Enabling Scalable Mode for Siebel Reports” on page 85
“Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports” on page 87

Administering Siebel Reports ■ About Increasing the Java Heap Size on Oracle BI
Publisher Server
About Increasing the Java Heap Size on

Oracle BI Publisher Server
When running large reports with large data sets, the Oracle BI Publisher Server OC4J process might
consume too much Java Virtual Memory (JVM). To avoid a reports failure, increase the JVM allocation
for the OC4J process. For example, to specify a heap size of 512 megabytes, specify the following in
the oc4j.cmd file (or equivalent):
-Xms512m -Xmx512m
NOTE: Different operating systems can have different JVM memory limits.
For more information about increasing the Java heap size, see the topic on setting the JVM heap size
for OC4J processes in Oracle® Application Server Performance Guide in the Oracle Business
Intelligence Publisher Documentation Library 10.1.x available on Oracle Technology Network (http:/
/www.oracle.com/technetwork/indexes/documentation/index.html).
About Reducing the Size of an

Integration Object
The number of integration components and their related fields can greatly affect the performance of
reports, especially reports that are run on large data sets. It is recommended that you limit the fields
in integration objects to only those fields that necessary for report generation. Large integration
objects increase the time necessary for the XMLP Component to extract data through Siebel
Enterprise Application Integration (EAI) and increases the size of the resulting XML used by Oracle
BI Publisher Server for report generation. Large integration objects can also affect performance when
rendering the report if the report template includes logic to extract, aggregate, or reference elements
in the XML.
Adhere to the following guidelines:
■ Avoid creating a large integration objects that might be shared by many different reports, if the
integration object contains many fields. Create individual integration objects for each report to
improve performance.
■ Deactivate any fields that are not required. When using the EAI Siebel Wizard to create an
integration object, be aware that the wizard adds all fields from the business component.

Administering Siebel Reports ■ About Reducing the Size of an Integration Object

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 91
■ Scenario for Generating Reports on page 92
■ About Generating Reports for Selected Records on page 93
■ Generating Reports on page 95
■ Example of Generating an Opportunity Report on page 97
■ Monitoring the Status of Currently Generating Reports on page 97
■ Viewing Details for Generated Reports on page 99
■ Deleting Reports on page 101
■ Setting Locale User Preferences for Reports on page 101
NOTE: This chapter is not applicable to scheduled 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. For information about granting access to reports, see
“Sharing Report Layout Templates” on page 125. You also use the Reports menu to schedule reports
in connected mode. For information about scheduling reports, see Chapter 8, “Scheduling Reports.”

Generating Reports ■ Scenario for Generating Reports
Figure 6 shows a sample Reports menu drop-down list, which displays the names of the reports
available for the current view—such as Opportunity List and Pipeline Report By Rep—as well as a link
to a user’s own previously generated reports (My BI Publisher Reports) and a link for scheduling
reports (Schedule Report).
Figure 6. Sample Reports Menu Drop-Down List
NOTE: The Reports menu and some menu items are configurable. For more information about
configuring the Reports menu, see “Configuring the Reports Icon” on page 69.
Related Topics
“Scenario for Generating Reports” on page 92
“About Generating Reports for Selected Records” on page 93
“Generating Reports” on page 95
“Example of Generating an Opportunity Report” on page 97
“Monitoring the Status of Currently Generating Reports” on page 97
“Viewing Details for Generated Reports” on page 99
“Deleting Reports” on page 101
“Setting Locale User Preferences for Reports” on page 101
“Configuring the Reports Icon” on page 69
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.”

Generating Reports ■ About Generating Reports for Selected Records
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 91
About Generating Reports for Selected

Records
You can choose which records you want to generate when you execute a report, given that report
has been configured to support the selected records feature. You select multiple records from a list
view using the CTRL key.

Generating Reports ■ About Generating Reports for Selected Records
For nonselected records reports, any query or predefined query you perform from a list view in Siebel
Business Applications is the criterion used for report generation. When you drill down on a record
from a list view into a detail view, the query context is preserved. Therefore, the query record set
for the report generation reflects the record set in the detail view.
With a selected records report, if you select individual records from a parent list applet or form applet
or child records on a list applet in a detail view, then these record selections override any user
interface or pre-defined query. The selected records become the query record set for the report
generation.
NOTE: The report developer must have specified that a particular report can be generated using the
selected records functionality. For information, see “About Defining Report Layout Templates for
Selected Records” on page 111 and “Defining Report Layout Templates for Selected Records” on
page 126.
CAUTION: It is recommended that you select no more than 50 records at a time because doing so
might cause report generation to fail. If you need to specify a large data set for a report, then execute
a query and run a nonselected records report.
About Sort Order When Generating Reports

If you sort records before executing a report, the sort order is preserved when the report is executed.
However, if the sort order is configured on the integration object used to generate the report, then
the user-defined sort order is overridden.
Related Topics

Generating Reports ■ Generating Reports
Generating Reports
You generate reports using the Siebel application views and the Reports menu. Figure 7 shows the
tasks for generating Siebel Reports.
Figure 7. Report Generation
1 (Optional) Override the default report language and local by setting user preferences.
For information about overriding user preferences for report generation, see “Setting Locale User
Preferences for Reports” on page 101. For information about how languages and locale settings
are implemented in Siebel Reports, see “About Working with Multilingual Reports” on page 76.
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.
3 From the Reports menu, you choose to either generate a report or schedule a report.

Generating Reports ■ Generating Reports
4 If you choose to:
■ Generate a report from the BI Publisher listing, you designate a report output file type, and
then click Submit. Additionally, if this is a parameterized report, you have the option to select
more criteria before selecting the report output file type.
NOTE: Optionally, you can choose a different locale rather than accept the defaults.
■ Select My BI Publisher Reports, you can choose a report that you previously generated by
drilling down on it from the My Reports view.
■ Schedule a report, you choose the report name, the output type, and other scheduling
criteria from the Schedule a Report dialog box.
5 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 4.
The report output file types are: PDF, HTML, RTF, EXCEL, PPT, and MHTML. The PPT and
MHTML output file types are available only in connected mode. For more information about
the report output file types, see “Who Can Use Siebel Reports?” on page 18.
■ Save the report. You can save the report to a destination of your choosing, and then Open it
for viewing immediately or at a later time.
If you chose to schedule a report, you can view or monitor the report job in the Scheduled
Reports view.
NOTE: The actual report is stored in the Oracle BI Publisher repository.
6 You can continue to generate or schedule reports in other formats or click Close to end.
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 Chapter 12, “Troubleshooting Siebel Reports.”
Related Topics
“Scheduling Reports” on page 129

Generating Reports ■ Example of Generating an Opportunity Report
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
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 134.

Generating Reports ■ Monitoring the Status of Currently Generating Reports
To monitor the status of a generated or currently generating report

2 Navigate to the BI Publisher Reports screen, then one of the following Reports views:
■ My Reports
■ My Team’s Reports
■ All 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 Chapter 12, “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

Generating Reports ■ Viewing Details for Generated Reports
Viewing Details for 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.
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 134.
To view generated reports details

1 Navigate to the BI Publisher Reports screen, then one of the following Reports views:
■ My Reports
■ All Reports

Generating Reports ■ Viewing Details for Generated Reports
2 In the appropriate reports list, select or query for the report that you want to view.
3 Scroll down to Report Parameters to view the details.
Some of the fields are described in the following table.
Parameter Description
Task Id The unique task ID for the report generation server request. The task ID
is useful when searching log fields to find a specific segment related to a
report request.
Start Time The start and end times of the report generation.
End Time
Query String Shows the query entered when the report was generated.
Bookmark The complete view context including any query and applet and business
component search expressions and sort specifications that were active
when the report was generated.
View Mode The visibility view mode that was used when the report was generated.
Error Message If there is a problem with report generation, an error message appears in
this field.
Description Editable field you can use to add more descriptive information or
categorization.
Tags Editable field you can use to add more descriptive information or
categorization.
NOTE: Administrators can also view a report entitled Report Usage Statistics that provides
detailed statistical information about report generation, users who run the reports, failures, long-
running reports, and so on. This report is available as part of the preconfigured reports that ship
with Siebel Business Applications. For information about downloading these reports, see
876284.1 (Article ID) on My Oracle Support.
Related Topics

Generating Reports ■ Deleting Reports
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 135.
To delete a report
1 Navigate to the BI Publisher Reports screen, then to one of the following views:
■ My Reports
■ All Reports
2 In the appropriate reports list, select a report, and then click Delete.
Related Topics
Setting Locale User Preferences for

Reports
When generating a report, you can override the report 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 locale is not specified in the report template, and a user has set the locale
properties in their user preferences, the user preferences settings are used when the report is
generated. For detailed information about how Siebel Reports determines the report language at run
time, see “About Working with Multilingual Reports” on page 76.
To set 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 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. F 10 1

Generating Reports ■ Setting Locale User Preferences for Reports
Related Topics

7 Creating Reports
This chapter describes how to create reports. It is intended only for those who have report developer
or administrator privileges.
NOTE: Most 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” and Chapter 8, “Scheduling Reports.”
This chapter includes the following topics:
■ Scenario for Creating Reports on page 103
■ About Integration Objects in Siebel Reports on page 104

■ Using Integration Object Search Specifications for Siebel Reports on page 105
■ About Reporting Across Multiple Siebel Business Objects on page 106
■ Workflow for Uploading Report Layout Templates to a Siebel Application on page 107
■ About Registering and Sharing Report Layout Templates on page 109
■ About Multiorganizational Report Templates on page 109
■ Scenario for Report Template Visibility Across Organizations on page 110
■ Should You Clone an Existing Report or Create Custom Reports? on page 110
■ About Defining Report Layout Templates for Selected Records on page 111
■ Process of Creating Custom Reports on page 112
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.

Creating Reports ■ About Integration Objects in Siebel Reports
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 “Who Can Use Siebel Reports?” on page 18. For more information about the My Reports
view, see “About Using Siebel Reports” on page 18.
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:
■ Adding custom fields to existing integration objects for Siebel reports, see “Extending Integration
Objects to Add New Fields for Siebel Reports” on page 115.
■ Creating new integration objects for Siebel reports, see “Creating New Integration Objects for
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.

Creating Reports ■ Using Integration Object Search Specifications for Siebel Reports
■ Integration objects in general, see Integration Platform Technologies: Siebel Enterprise

Application Integration.
Using Integration Object Search

Specifications for Siebel Reports
You can apply search specifications to an integration object to make a report static when the report
is executed. Static means that the search specification expression will override a user interface query
or predefined query.
Table 7 shows the integration object search specification run-time behavior for Siebel Reports. Keep
this behavior in mind when specifying your search specifications.
Table 7. Integration Object Search Specification Run-Time Behavior for Siebel Reports
Search Specification
UI Predefined Business
Query Query Applet Comp IO Expected Result
1 Y N Y Y N The report appears with records filtered by

the user interface, applet, and business
component search expressions.
2 N Y Y Y N The report appears with records filtered by

any predefined query, applet, and business
component search expressions.
3 Y N Y Y Y The report appears with records filtered by

applet and business component search
expressions, with the integration object
search expression appended (overrides the
user interface query).
4 N Y Y Y Y The report appears with records filtered by

applet and business component search
expressions, with the integration search
expression appended (overrides the
predefined query)
Additionally, the following applies to all scenarios described in Table 7:
■ Position- and organizational-based visibility and view mode are automatically preserved.
■ The selected records functionality has no affect on query behavior. The context of the selected
records becomes the user interface or predefined query.
■ Mobile Web Client functionality is not compromised.
■ Multilingual behavior does not affect the functionality.

Creating Reports ■ About Reporting Across Multiple Siebel Business Objects
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 115. For
information about creating new integration objects, see “Creating New Integration Objects for Siebel
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 120. For more information about nonprimary integration objects, see
“Adding Multiple Integration Objects to a Report” on page 124.
■ 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.
■ 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.
An example of a valid search specification is:
‘Account’.Search = “[Name] LIKE ‘A*’”
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 124.

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

Creating Reports ■ Workflow for Uploading Report Layout Templates to a Siebel Application
1 From the report template views (My Templates and All Templates Across Organizations), the RTF
report layout template and translation (XLIFF) files are uploaded using an upload business
service to the Oracle BI Publisher repository as follows:
a In connected mode, the upload service occurs by way of the PublicReportServiceService Web
service. For more information about connected mode, see “Siebel Reports Architecture and
Workflow for Generating Reports in Connected Mode” on page 24.
To upload the report to the Oracle BI Publisher repository, 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 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, the layout template (RTF) and XLIFF
files are attached to the report during the registration of the layout template.
b 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 after. For more information
about generating reports in disconnected mode, see “Siebel Reports Architecture and Workflow
for Generating Reports in Disconnected Mode” on page 26.
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.
2 For connected mode, the RTF and XLIFF files are stored in the Oracle BI Publisher repository by
way of the PublicReportServiceService Web service.
3 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 120.

Creating Reports ■ About Registering and Sharing Report Layout Templates
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.
NOTE: 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.
The two views you use for report template registration are:
■ 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).
■ 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 templates if other users have visibility to the relevant
application views. The All Templates Across Organizations view allows 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 125.
About Multiorganizational Report

Templates
The basic logic for how an organization-specific report template appears in the Reports menu is as
follows:
■ When a user logs into the Siebel application, that user sees organization-specific reports where
the Active Position Organization equals the organization or organizations defined for a custom
template.
■ Users with more than one organization can change their Primary Active Position Organization
during a single session. After making this change, the reports that user can view is different from
the original access.

Creating Reports ■ Scenario for Report Template Visibility Across Organizations
Scenario for Report Template Visibility

Across Organizations
This topic gives one example of how report template visibility across organizations might be used.
You might use template visibility differently, depending on your business model.
A sales representative and his manager have visibility to the same Siebel view. However, the reports
they can see differ depending on their organization settings. Let us consider that the user is the
Holland organization, and his manager is in the Benelux organization. Benelux is the parent
organization of both the Holland and Belgium organizations.
When accessing the reports menu:
■ Both the sales representative and his manager can see any report that is defined in the Standard
Templates view and that is associated to the view.
■ The sales representative sees:
■ Custom templates he has created in the My Templates View. These templates have only a
default organization.
■ Custom templates that are explicitly associated to the Holland organization, given his current
active position organization is Holland.
■ The manager sees:
■ Custom templates he has created in the My Template View or templates his subordinates
have created that appear in the My Teams view. These templates have only a default
organization.
■ Custom templates that are explicitly associated to the Benelux organization, given his
current active position organization is Benelux.
■ Custom templates created by both Holland and Belgium organizations because the manager
can see report templates created by his subordinates regardless of whether the subordinate
is in a different organization.
Should You Clone an Existing Report or

Create Custom Reports?
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

Creating Reports ■ About Defining Report Layout Templates for Selected Records
■ 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.
About Defining Report Layout Templates

for Selected Records
Siebel Reports allows report developers to configure a report layout template so that users can select
one or more individual records for report generation. This topic provides a comparison of how report
generation is determined at run time when using the selected records functionality and when not
using it. For more information about using selected records, see “About Generating Reports for
Selected Records” on page 93 and “About Defining Report Layout Templates for Selected Records” on
page 111.
How Reports are Generated at Run Time When Not Using Selected
Records
If a report is not indicated in the report template registration views as supporting selected records,
then the report executes using the user interface query defined in the list or detail view in the Siebel
application based on the current view context. Drilldown context is also preserved so that when a
user drills down on a record from a list view into a detail view, the query context is preserved. The
query record set for the report generation reflects the record set in the detail view.
If you perform a query in the parent form applet on a detail view, then query replaces the record set
with a new query. If you perform a query on the child applet in a detail view, then the child applet
query is appended to the current query, and the record set in the view is reflected in the report
output.
NOTE: This functionality also applies to predefined queries.
How Reports are Generated at Run Time When Using Selected Records
If a report is indicated in the report template registration views as supporting selected records, then
the report executes only those records the user selects in the list or detail applet in the Siebel
application.
TIP: You select Multiple records using the CTRL key.
When you run a report that supports the selected records functionality from a list view, the parent
records selections are based on those records highlighted in the list applet. When you drill down, the
context is preserved, and by default, the parent applet will become the active applet. Therefore, only
the parent record and related child records will be the query used for the report generation.
If you select child records in the child list applet on a detail view, then these child records also
become selected records, and along with the associated parent record, make up the query used for
report generation.
CAUTION: It is recommended that you select no more than 50 records at a time because doing so
might cause report generation to fail. If you need to specify a large data set for a report, then run a
non-selected records report and execute a query prior to running the report.

Creating Reports ■ Process of Creating Custom Reports
Process of Creating Custom Reports

Siebel Business Applications allow you to create new reports based on preconfigured report layout
templates, or you can create custom reports and report layout templates.
NOTE: For suggestions as to when to modify versus create a report layout template, see “Should You
Clone an Existing Report or Create Custom Reports?” on page 110.
You create custom reports in three locations:
■ In Oracle Business Intelligence Publisher Add-in for Microsoft Word (also known as Oracle BI
Publisher Desktop) 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.

Figure 9 shows the process of creating custom reports. The roadmap 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 9. Process of Creating Reports
Figure 9 illustrates the high-level tasks you perform when creating custom reports:
1 (Optional) “Extending Integration Objects to Add New Fields for Siebel Reports” on page 115
2 (Optional) “Creating New Integration Objects for Siebel Reports” on page 116
NOTE: Create new integration objects only when no appropriate integration object exists.

3 “Generating Sample XML Data Files for Siebel Reports” on page 118
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 23.
4 “Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft
Word” on page 119
In this step, you either modify an existing report layout template or create a new one, and then
do the following:
a Assign the Siebel fields in the report layout template.
b Save the report layout template to RTF.
c Periodically preview the report layout template to verify it appears as designed.
5 “Registering Report Layout Templates” on page 120
Using the template views (Reports - Custom Templates or Reports - Standard Templates), in this
step 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 locale, report access control, and so on.

6 (Optional) “Adding Multiple Integration Objects to a Report” on page 124
In this step, you add new integration objects to a report, and the generate sample XML.
7 (Optional) “Sharing Report Layout Templates” on page 125
In this step, you grant report access to others by adding positions.
8 (Optional) “Defining Report Layout Templates for Selected Records” on page 126
In this step, you click the Selected Records field to configure a report template to display only
the currently selected records in a Siebel application view when a report is generated.
9 “Associating Registered Reports with Siebel Application Views” on page 127
10 (Optional) “Changing the Report Sequence Order in the Reports Menu” on page 127
Using the Association View, in this step you can define the way reports are ordered or prevent
them from appearing in the Reports menu.

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 116.
This task is an optional step in “Process of Creating Custom Reports” on page 112.
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:
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.
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.
NOTE: You must migrate a modified SRF between environments for any changes you make to
integration objects.
For information about generating sample data files, see “Generating Sample XML Data Files for Siebel
Reports” on page 118. 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 104.
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 115.
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 120.
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.
By default, a QueryString field is automatically populated in the sample XML and parsed as a field
value in the integration object during report execution. This field contains the user-defined query
that was entered when the report was executed. You can display this field value on the report
template. For example, the format of the field might be [Account Status] = “Active”].

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
deactivate 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
creating custom reports. For information about generating sample data files, see “Generating Sample
XML Data Files for Siebel Reports” on page 118. For more information about integration objects and
deploying an integration object without compiling an SRF, see Integration Platform Technologies:
Siebel Enterprise Application Integration.

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 115. For information about creating new
integration objects for reports, see “Creating New Integration Objects for Siebel Reports” on page 116.
This task is a step in “Process of Creating Custom Reports” on page 112.
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, click Generate Sample XML, and then save the file to the
SIEBSRVR_ROOT\XMLP\DATA directory.
An XML file is generated with the name of the integration object followed by .xml. 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. For information about creating
report layout templates, see “Creating Report Layout Templates Using Oracle Business Intelligence
Publisher Add-in for Microsoft Word” on page 119.

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.
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 (also known as Oracle BI Publisher Desktop). 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.
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
5 Periodically preview the report layout template by doing the following:
a In Microsoft Word, open the RTF template file (if not already open).
NOTE: Typically, the template files are stored in SIEBSRVR_ROOT\XMLP\TEMPLATES.
b 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.
c (Optional) Continue to preview different output file formats.
d Save the file in RTF format.
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 120.
NOTE: Additional report template creation 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 (http://www.oracle.com/technetwork/
indexes/documentation/index.html). Not all features mentioned in the Oracle Business Intelligence
Publisher documentation are currently supported in Siebel Reports; only the features documented in
this guide.
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.

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 107.
NOTE: If you are uploading new or modified report layout templates in a multiple Siebel Server
environment, see also “Uploading New or Modified Report Layout Templates for Multiple Siebel Server
Environments” on page 69. If you are uploading multilingual reports, see also “Roadmap for Uploading
Multilingual Reports to the Siebel Application” on page 79.
When associating an RTF or ZIP file with a report, the following validation checks occur to make sure
that:
■ The RTF file name is not already in use
■ An RFT file name appears in the Template field
■ The XLIFF file name contains the same template name as the physical template file name
■ An XLF or ZIP file name appears in the XLIFF field
To register a report layout template

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:
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.
NOTE: An error message appears if a report already exists in the Siebel application with the
same Report Name value, including other user’s reports or standard preconfigured reports
that ship with Siebel Business Applications.
b Select a report layout template.

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.
Some of the fields are described in the following table.
TIP: 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.
Field Description
Start Date 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 Date 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 Locale The default locale for the template. Locale is the language and locale
combination based on the locale configuration in the Siebel
application. For more information, see Siebel Global Deployment
Guide.

Field Description
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.
Report Access Controls access to report templates using positions.
NOTE: The Report Access field is available only in the Reports -

Custom Templates view to allow for sharing of report templates.
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 126.
Parameters Indicates that the report is a parameterized report that accepts run-
time parameters. You define the parameters associated with the report
in the Parameters list. For information about defining parameters for
a report, see “Defining Report Parameters in the Siebel Application” on
page 160.
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.

Field Description
Search A query data filter. When you create a nonprimary integration object
Specification for a report, you must enter a search specification value. For example,
the value of the search specification might be the following expression:
'IntegrationComponentName'.Search = "[FiledName] =
""ValueToBeTested"""
For example:
'Contact'.Search = "[Last Name] = ""Sh"""
NOTE: You can override queries in the user interface by specifying a

search specification on the primary integration object. 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 106.
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 124.
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
Locales from Report Templates” on page 80.
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 127.
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 106.
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 120.

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 - 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 120.
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 118, 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 127.
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.
The Report Access field on the report record controls access to the report templates that are
executable. 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.
NOTE: The Report Access field is available only in the Reports - Custom Templates view to allow
for sharing of generated reports based on position.

2 Perform one of the following:
■ Select or 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 120.
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.
4 You can define multiorganizational templates by adding a specific organization or organizations

to the report template in the organizations multi-value group (MVG).
a Click the Organizations field to display the Organizations dialog box.
b Select the organizations that you want to grant access to the report, and then click Add.
You select multiple records using the shift or control keys.
NOTE: By default, custom templates belong to the default organization.
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. The report is generated, using the selected records in
the context of the application view. 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.
NOTE: If you encounter problems using this feature, you might need to perform additional Siebel
Tools configuration. For instructions, see 1180903.1 (Article ID) on My Oracle Support.
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:
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.
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 Chapter 12, “Troubleshooting Siebel Reports.”
Changing the Report Sequence Order in the Reports

Menu
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, use the sequence field to assign a sequence to some or all of the reports.

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 129
■ Scheduling Reports on page 130
■ Example of Scheduling an Opportunity Report on page 133
■ Monitoring and Viewing Scheduled Reports on page 134
■ Suspending and Resuming Scheduled Reports on page 134
■ Deleting Scheduled Reports on page 135
About Scheduled Reports

You schedule reports using the Schedule Report menu item from the Reports menu. This menu item
opens a dialog box from which you select a report to schedule and the criteria for generating the
report (such as when to generate the report, how often you want the report to generate, and whether
the report generates with a recurring frequency). After a report job is scheduled, you can monitor
and view the report using the Scheduled Reports view.
The Scheduled Reports view is an Oracle BI Publisher Web page that is embedded in the Siebel
application user interface. The Siebel application and Oracle BI Publisher exchange data by way of a
Web service to produce the report. For more information about using the Schedule Reports view, see
“Monitoring and Viewing Scheduled Reports” on page 134.
NOTE: Report scheduling requires the Siebel Web Client in connected mode. For more information
about report scheduling in connected mode, see “Workflow for Generating Reports in Connected Mode”
on page 24.
Related Topics
“Example of Scheduling an Opportunity Report” on page 133
“Monitoring and Viewing Scheduled Reports” on page 134
“Suspending and Resuming Scheduled Reports” on page 134
“Deleting Scheduled Reports” on page 135

Scheduling Reports ■ Scheduling Reports
Scheduling Reports
You schedule reports by selecting the Schedule Report menu item from the Reports menu while in a
Siebel application view. If you have been granted scheduling privileges, you can schedule reports
using various criteria. 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 23.
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.
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.
A scheduling dialog box appears.

3 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 file types, see “Who Can Use Siebel Reports?” on page 18.
Report Locale The locale for the report.
Frequency The recurrence of the report. Choices are: Run Immediately, Run Once,
Run Daily/Weekly, or Run Monthly.
If you choose to run the report:
■ Immediately, the job is triggered as soon as you click Schedule.
■ Only one time, you must enter the exact date and time to run the
report.
■ Daily or weekly, you must enter the day (or days) of the week, specify
the run time for the selected day (or days), and a start and end date.
■ Monthly, you must enter the month (or months), the day (or range of
days) to run, and a start and end date.
See also Run Time below.
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 and time the report generates when you choose the run once
frequency.
Run Time The time the report generates when you choose a daily/weekly or
monthly frequency.
NOTE: For a run once frequency, time is converted to UTC (Coordinated

Universal Time). For daily, weekly, or monthly frequencies, the date,
time, and time zone are based on the Oracle BI Publisher Server.

Field Description
Start Date and If a date is set in either of these fields, then it restricts the dates for which
End Date scheduling is active. By default, the start date is the date you schedule
the report and the end date is NULL. A start and end date are required
for the daily/weekly and monthly frequencies. The default Start Date
format is based on the date format of the current user preferences.
Day(s) The day (or days) of the week or date range you want the report to
generate when you choose a daily/weekly frequency.
Month(s) The month (or months) you want the report to generate when you choose
a monthly frequency.
Date(s) The day (or days) of the week or date range you want the report to
generate when you choose a monthly frequency.
A message appears indicating the report (with Job ID) has been scheduled.
4 (Optional) If scheduling a parameterized report, enter the run-time parameters by doing the
following:
a Click Parameter.
The Parameters dialog box appears.
b Enter the values, and then click Submit.
NOTE: For this option to appear, the report developer must have indicated the report as a
parameterized report in the applicable report template registration view.
5 (Optional) Schedule another report with different criteria.
6 Click Close to exit the scheduling dialog box.
NOTE: The scheduling dialog box remains open until you close it.
7 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 Drill down on the Job Name for more information, and then click Back if you want to view
additional scheduled reports.
Related Topics
“About Scheduled Reports” on page 129

Scheduling Reports ■ Example of Scheduling an Opportunity Report
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
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.
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 Tuesday and Thursday
■ Start Date is 8/2/2009
■ 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 130.
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 134.
Related Topics

Scheduling Reports ■ Monitoring and Viewing Scheduled Reports
Monitoring and Viewing Scheduled

Reports
Using the Scheduled Reports view, you can view scheduled jobs and completed job history for reports
that you have generated or have been given access to. In this view, you can also suspend, resume,
or delete scheduled reports. For more information, see “Suspending and Resuming Scheduled Reports”
on page 134 and “Deleting Scheduled Reports” on page 135.
To monitor the status of a scheduled report

1 Navigate to the BI Publisher Reports screen, then the Scheduled Reports view.
2 Monitor the status in Oracle BI Publisher by doing one of the following:
■ 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.
■ Click the History tab to view a history of your report jobs.
Related Topics
Suspending and Resuming Scheduled

Reports
Using the Scheduled Reports view, you can suspend and resume scheduled reports you have
previously generated or have been granted access to.
To suspend or resume a scheduled report

2 Click the Schedules tab.
3 Click the checkbox next to the applicable report, and then click Suspend or Resume.

Scheduling Reports ■ Deleting Scheduled Reports
Related Topics
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 129.
To delete scheduled reports

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 72.
Related Topics

Scheduling Reports ■ Deleting Scheduled Reports

9 Using Master-Detail Reports
This chapter describes master-detail reports as well as how to create a master-detail layout
template. It includes the following topics:
■ About Master-Detail Reports
■ Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout
Template
■ 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 10 shows an example of a Service Request Activity - All report in Siebel Service, which is a
master-detail report.
Figure 10. 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 “Example of
Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on
page 138.

Using Master-Detail Reports ■ Example of Comparing the Service Request Activity (All)
Report with its Corresponding Layout Template
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 142. Many of the preconfigured reports that
ship with Siebel Business Applications are master-detail reports.
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 “Example of Comparing the Service Request Activity (All)
Report with its Corresponding Layout Template” on page 138 and “Creating a Master-Detail Layout
Template in Microsoft Word” on page 142.
Example of Comparing the Service

Request Activity (All) Report with its
Corresponding Layout Template
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 10 on page 137.
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.
For more information, see “Syntax and Description of the Fields for an Example Template” on page 140.

Syntax and Description of the Fields for an Example Template

Table 8 provides details of the Oracle BI Publisher syntax and description for the fields defined in the
example template.
Table 8. 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",
'SHORT_TIME'?>
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).

Table 8. 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",
'SHORT_TIME'?>
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.

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 (http://
www.oracle.com/technetwork/indexes/documentation/index.html). For more information about
creating master-detail templates, see “Example of Comparing the Service Request Activity (All) Report
with its Corresponding Layout Template” on page 138 and “Creating a Master-Detail Layout Template in
Microsoft Word” on page 142.
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 “Example of Comparing the Service Request Activity (All)
Report with its Corresponding Layout Template” on page 138.
■ 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.

Word
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.
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 “Example of Comparing the Service Request Activity
(All) Report with its Corresponding Layout Template” on page 138.
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
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 137 and
“Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout
Template” on page 138.

Word

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 145
■ Process of Packaging and Migrating Reports on page 146
■ Process of Migrating an Integration Object for a Report on page 150
■ Process of Migrating New Reports after Creating New Integration Objects on page 151
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 145.
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.

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 145.
2 “Packaging the Report Files in the Source Environment” on page 146
3 “Migrating the Report Files to the Target Environment” on page 147
4 “Packaging Report Database Records in the Source Environment” on page 148
5 “Migrating Report Database Records to the Target Environment” on page 149
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 146.
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.

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.
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.

■ 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 147.
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 146) 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.
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

■ 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.

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 148 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:
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.

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 146.
3 Perform the steps as described in “Packaging the Report Files in the Source Environment” on
page 146.
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 146.
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 150.
2 Generate the XML data file for the report as described in “Generating Sample XML Data Files for
3 Copy the database record files in the related package folder along with the SIF file, and then
migrate them.

Migrating Reports ■ Process of Migrating New Reports after Creating New Integration
Objects

11 Parameterized Reports
This chapter describes parameterized reports and how to create them. It is intended only for those
who have report developer or administrator privileges. It includes the following topics:
■ About Parameterized Reports on page 153
■ About Report Parameter Types and Attributes on page 154
■ About Referencing Parameters in the Report Layout Template on page 156
■ About Defining Report Parameters in the Siebel Application on page 157
■ About Report Parameter Validation on page 158
■ Process of Creating Parameterized Reports on page 159
■ Example of Generating a Parameterized Report on page 162
About Parameterized Reports

Parameterized reports allow developers and administrators to pass data into an Oracle Business
Intelligence Publisher (Oracle BI Publisher) RTF report layout template at run time and customize the
report output. You can schedule parameterized reports. Additionally, parameterized reports are
supported in both connected and disconnected mode (from the Mobile Web Client).
Parameterized reports allow you to:
■ Narrow the query, sort specification, or grouping by a field for report execution
■ Produce many different reports from the same report template
How Parameterized Reports Are Generated

Parameterized reports are generated in the same manner as other reports. The parameters a user
chooses and the parameter values entered are held in memory at run time. After entering the
parameters and clicking Submit, the report is executed and the parameter values are removed from
memory.

Parameterized Reports ■ About Report Parameter Types and Attributes
When scheduling a parameterized report, if a report template accepts run-time parameters, then a
Parameters option appears in the Schedule a Report dialog box. You click Parameters to enter the
parameter values from the Parameters dialog box. When you click Submit, the parameter values
entered are held in memory. You can amend the parameter values by clicking Parameters again, upon
which the parameter values you previously entered appear. To finalize the schedule report request,
click Submit again. A message appears showing that the report is scheduled, and the parameter
values entered are passed with the report request.
CAUTION: To use the Parameters option with scheduled reports, you must have installed the
appropriate Oracle BI Publisher patch level. For information about which patch to use, see 880452.1
(Article ID), Siebel Maintenance Release Guide on My Oracle Support.
Related Topics
“About Report Parameter Types and Attributes” on page 154
“About Referencing Parameters in the Report Layout Template” on page 156
“About Defining Report Parameters in the Siebel Application” on page 157
“About Report Parameter Validation” on page 158
“Process of Creating Parameterized Reports” on page 159
“Adding Scrollbars to the Parameters Dialog Box” on page 160
“Defining Report Parameters in the Siebel Application” on page 160
“Example of Generating a Parameterized Report” on page 162
About Report Parameter Types and

Attributes
Parameters and attributes for the report template are defined at design time. These definitions are
created in the Siebel application and determine the applet control type displayed at run time. The
types of parameters include: Checkbox, Date, LOV, Text, Number, DateTime, Label, and TextArea.
Attributes for each parameter include the custom display name (including custom multilingual
translations), default value, required field, LOV name (for LOV type only), and order. For information
about defining these parameters and attributes, see “Defining Report Parameters in the Siebel
Application” on page 160.
Table 9. Report Parameter Types
Parameter
Type Behavior
Check box Displays a simple check box Boolean parameter.
Date Displays a text box where the user can enter a date value and an associated calendar
control which can be invoked using an icon. The date format is based on the user
preferences.

Parameterized Reports ■ About Report Parameter Types and Attributes
Table 9. Report Parameter Types
Parameter
Type Behavior
LOV Displays a picklist where the user selects a value from a list. You can define any
application list of values (based on Picklist Generic BC). Dynamic list of values are
not possible. An LOV must exist in the list of application list of values. The LOV
parameter type supports MLOV translation. The list of values available are those
defined in the application list of values. Hierarchical LOVs are not possible.
NOTE: The picklist name chosen from the UI determines whether it is bounded or
not. If the selected picklist is bounded, then the LOV parameter is bounded, but if
the selected picklist is not bounded, then the LOV parameter is not bounded.
Text Displays a text box where the user can enter a string value.
Number Displays a text box where the user can enter a numeric value. The number control
invokes the standard calculator widget.
DateTime Displays a text box where the user can enter a date and time value and an associated
calendar control which can be invoked using an icon. The calendar control includes
time and time zone options. The date format is based on the user preferences.
Label This parameter type is simple text that you can use as descriptive text for a section
separator. There is no control type related to this parameter.
The only applicable property for this parameter type is Display Value and the Order
attribute. All parameters of type Label align from the left when rendered in the user
interface. The longest Label property of a Label type parameter is used for the
alignment starting position. All other parameter types are then aligned relative to
the starting position.
NOTE: It is not possible to define font face, size, color, style, or alignment or wrap
the Display Value with HTML formatting codes in order to determine the run-time
appearance of labels.
TextArea Displays a text area (with small scrollbar) where the user can enter a large string
value.
Related Topics
“About Parameterized Reports” on page 153

Parameterized Reports ■ About Referencing Parameters in the Report Layout Template
About Referencing Parameters in the

Report Layout Template
You control the layout of 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 (http://
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.
■ 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.
NOTE: You can also use parameters to filter data in a template, but this action is not recommended
for performance reasons. It is more efficient to filter records in the user interface using a query than
in the report layout template.
You must define template parameter definitions at the beginning of an RTF report layout template
using the following syntax:
<?param@begin: Param1>
NOTE: Default values are now defined in the user interface (in previous releases, default values were
defined in the report layout template). For more information about defining default values, see
“Defining Report Parameters in the Siebel Application” on page 160.
Related Topics

Parameterized Reports ■ About Defining Report Parameters in the Siebel Application
About Defining Report Parameters in the

Siebel Application
Typically, you use parameters to control the layout of a report, such as dynamic grouping or dynamic
sections.
Use the following sample syntax in the RTF report layout template to display run-time parameter
values on the report output:
Param1 = <?$Param1?>
The following bullet points provide information about parameter definitions and how to use them:
■ In the Parameters list in the Templates views, you can:
■ Define parameters using the New button.
NOTE: It is recommended that you do not copy parameters using the Copy Record
functionality.
■ Make a parameter required by setting the Required field to Y. A red asterisk appears next to
the parameter at run time.
■ Define the order in which parameters appear at run time by setting values in the Order field.
Parameters must have a unique Order value. If the order values are left blank, then the
parameters appear in the user interface after any other values.
■ The parameter choices a user can select at run time is displayed as a single list. If a large number
of parameters is specified, then the list becomes too large and impedes the ability to select
values correctly, especially with smaller screen resolutions. It is possible to configure a scrollbar
to appear on the parameter applet (helpful for usability) when there are a large number of
parameters you want to display. By default, the threshold at which the scrollbar automatically
displays in the Parameters dialog box is 25 parameters. Using Siebel Tools, you can reconfigure
that value. For information about configuring the threshold, see “Adding Scrollbars to the
Parameters Dialog Box” on page 160.
■ For each data type, the appropriate validation occurs at run time to check that a user has entered
a correct value.
■ Each parameter value a user enters at run time is passed to the Oracle BI Publisher Server as
string values when the report is generated. Therefore, certain data types, such as Date, must
address the appropriate functions for the value to be recognized as an official date value. For
example, you can use the canonical date functions to convert a string value into a date value.
■ The minimum and maximum validation (date values entered within a set range) and validation
or defaults using date functions, such as Today()-7 and conditional value logic (a display of one
parameter that depends on another value) are not currently possible.
■ In the Parameter Translations list in the Templates views, you can associate a language
translation by setting a display value.

Parameterized Reports ■ About Report Parameter Validation
■ By default, there are a set number of parameter definition fields available in the Report
Parameters virtual business component. If you want to add more parameters of a certain data
type than already exist, then you can create more fields in the virtual business component. By
default, the number of parameter definition fields by data type that are provided are described
in the following table.
Number of Parameter
Data Type Definition Fields
LOV 10
Text 5
Text Area 5
Number 10
Date 5
Date/Time 5
Check box 10
CAUTION: Although possible, it is recommended that you do not use parameters to filter data in a
report layout template. Doing so can negatively affect performance.
Related Topics
About Report Parameter Validation

Given the report parameters have been defined, you can check for any inconsistencies using the
validation feature. The validation verifies the:
■ Number of parameters defined in the Siebel application equals the number of parameters defined
in the report layout template.
NOTE: Most parameter types are dynamically mapped to the Report Parameter Form Applet
business component field, however, Label parameter types are not. Additionally, Label parameter
types are ignored during validation against the report layout template.

Parameterized Reports ■ Process of Creating Parameterized Reports
■ Name attribute for each parameter in the Siebel application has an equivalent placeholder in the
report layout template.
For information about when to perform parameter validation, see “Defining Report Parameters in the
Siebel Application” on page 160.
Related Topics
Process of Creating Parameterized

Reports
To create a parameterized report, perform the following tasks:
1 Create parameter definitions (or make sure the definitions exist) in the report layout template.
For example, you might have the following definition:
<?param@begin: Param1?>
NOTE: For this example, a parameter must also exist as a parameter definition in the Siebel
application with the Name property set to Param1 for the value of the output above to populate.
For information about parameter definitions in report layout templates, see “About Referencing
Parameters in the Report Layout Template” on page 156.
2 (Optional) Adding Scrollbars to the Parameters Dialog Box on page 160
3 “Defining Report Parameters in the Siebel Application” on page 160
Related Topics

Parameterized Reports ■ Defining Report Parameters in the Siebel Application
Adding Scrollbars to the Parameters Dialog Box

The parameter choices available for a report at run time appear as a single list. If a large number of
parameters is specified, then the list becomes too large, which impedes the ability to select values
correctly (especially with smaller screen resolutions). You can configure a scrollbar to appear on the
Parameter dialog box to make the list more usable. By default, the threshold value at which the
scrollbar automatically appears is 25 parameters, however, you can change that value using Siebel
Tools. For more information see “About Defining Report Parameters in the Siebel Application” on
page 157.
To configure the parameterized reports threshold for scrollbars to appear

1 Log in to Siebel Tools with administrator privileges.
2 In the Object Explorer, select Applet, and then in the Object List Editor query for Report
Parameters Applet.
3 In the Object Explorer, select Applet User Prop, and then set the Display Scrollbar user property
to the threshold value that you want.
NOTE: The scrollbar appears when the number of parameters that appear in the UI is greater
than or equal to the threshold value.
4 Compile the SRF.
The threshold is used for all parameterized reports and for all users in the application.
Related Topics
Defining Report Parameters in the Siebel

Application
This topic describes how to define report parameters in the Siebel application so that users have
options when generating reports that govern what appears in the report output.

Parameterized Reports ■ Defining Report Parameters in the Siebel Application
To define report parameters in the Siebel application

1 Navigate to the Administration - BI Publisher Reports screen, then the Reports - Custom
Templates view.
2 From the applicable Template view, select a template, and then check the Parameters field to set
it to True.
NOTE: This flag ensures the parameter applet appears at run time. The template views you have
access to depend on the user’s responsibilities.
3 Scroll down to the Parameters list, click New, and then fill in the applicable fields.
The following table describes some of the fields.
Field Description
Label Descriptive text for the parameter. You can use this field for translations.
Name The name of the parameter. This field references the placeholder
parameter name in the report layout template.
Order The order in which parameters appear at run time.
Type The type of parameter. Choices are: Checkbox, Date, LOV, Text, Number,
DateTime, Label, and TextArea. For a description of each parameter, see
“About Report Parameter Types and Attributes” on page 154.
Default Use this field to provide the default value for the parameter. This default
value appears in the Report Parameter dialog box and is passed to the
Oracle BI Publisher Server for report generation.
Picklist Name The name of the picklist from which users choose values in the parameter
dialog box. Use this field for LOV parameter types.
Required A value of Y indicates the parameter is required. If required, a value must

be entered in the user interface.
NOTE: Each parameter name value you define must have a correlating parameter definition in
the report layout template. For example, if you define a parameter with the Name property as
Param1, then the definition of Param1 must appear in the report layout template.
4 If there are translations, add the following information for each language:
■ Default Value
■ Display Name
NOTE: Translation fields are multilingual.
5 Click Validate to check for inconsistencies between the template definitions you defined above
and the report layout template. For more information about this feature, see “About Report
Parameter Validation” on page 158.
Related Topics

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 a specific 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 report from the Reports menu.
NOTE: If this report has parameters defined, the Siebel application retrieves the parameters
from the parameter definitions for the report template defined in the Siebel application.
4 From the parameter pop-up applet, select the parameter values for the report, and then click
Submit.
NOTE: If the report does not have a default output type defined, you must select the output file
type, and then click Submit again.
The report is generated by the Oracle BI Publisher Server, and then transferred to the Siebel
application screen. For more information about generating reports, see “Generating Reports” on
page 91.
Related Topics



12 Troubleshooting Siebel Reports
This chapter describes how to enable logging for the various Siebel Reports components and how to
troubleshoot common error messages that might occur when generating reports.
It contains the following topics:
■ Enabling Logging for Siebel Reports in the Siebel Application on page 165
■ About Enabling Logging for the Oracle BI Publisher Server on page 167
■ Enabling Debugging on Oracle BI Publisher Server for Siebel Reports on page 167
■ Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode on page 168
■ Guidelines for Resolving Class Not Found Errors When Previewing Reports in Microsoft Word on
page 169
■ Resolving Class Not Found Errors When Previewing Reports in Microsoft Word on page 170
■ Troubleshooting Error Messages for Siebel Reports on page 171
NOTE: Oracle Business Intelligence Publisher (Oracle BI Publisher) for Siebel Business Applications
logs all exceptions and debug level information.
Enabling Logging for Siebel Reports in

the Siebel Application
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.

Troubleshooting Siebel Reports ■ Enabling Logging for Siebel Reports in the Siebel
Application
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.
5 In the Component field, query for your AOM (Application Object Manager), for example, 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 AOM 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

Troubleshooting Siebel Reports ■ About Enabling Logging for the Oracle BI Publisher
Server
3 Shut down the XMLP Report Server component and then restart this component to make sure
logging changes take effect.
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 (http://
Enabling Debugging on Oracle BI

Publisher Server for Siebel Reports
You can configure Oracle BI Publisher Server to capture detailed information about errors that occur
while working with Siebel Reports in the Siebel Web Client.
NOTE: This debugging is in addition to the usual debugging capabilities available in Siebel Business
Applications.
To enable debugging on Oracle BI Publisher Server

1 Log in to Oracle BI Publisher Server with administrator privileges.
2 Click the Admin tab, and then Server Configuration under System Maintenance.
3 Change the Debug Level value from Exception to Debug, and then click Apply.
4 In a text editor, such as Notepad, create a new file entitled xdodebug.cfg, and then type in the
following for use as a sample file:
LogLevel=log_level
LogDir=logging_directory_path
5 Copy the newly created xdodebug.cfg file to:
ORACLE_HOME\oc4j_b\jdk\jre\lib directory
where:
❏ ORACLE_HOME\oc4j_b is the directory where Oracle BI Publisher Server is installed.

Troubleshooting Siebel Reports ■ Enabling and Disabling Debugging for Siebel Reports in
Disconnected Mode
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.

Troubleshooting Siebel Reports ■ Guidelines for 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.
Guidelines for Resolving Class Not Found

Errors When Previewing Reports in
Microsoft Word
This topic provides guidelines for resolving class not found errors when previewing reports in
Microsoft Word.
Guidelines for Resolving Class Not Found Errors When Previewing

Reports in Microsoft Word
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.
For instructions for resolving, see Resolving Class Not Found Errors When Previewing Reports in
Microsoft Word on page 170.

Troubleshooting Siebel Reports ■ Resolving Class Not Found Errors When Previewing
Reports in Microsoft Word
Resolving Class Not Found Errors When

Previewing Reports in Microsoft Word
Errors can occur when previewing reports with Microsoft Word that use preconfigured RTF (Rich Text
Format) templates. To resolve these types of errors, 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. It is not necessary to associate .doc
extensions with this batch file.
To resolve class not found errors when previewing reports in Microsoft Word
1 Navigate to C:\Program Files.
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.

Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports
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 170.
The batch file sets an environment variable needed for publishing Oracle BI Publisher reports
from within Microsoft Word.
NOTE: 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 standard 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.
Troubleshooting Error Messages for

Siebel Reports
Table 10 contains the error messages that you might encounter when using Siebel Reports and the
suggested solutions for resolving the errors.
Table 10. 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 176.
"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 176.
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 176.
(SBL-DAT-00322)

Connection
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 177.
"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 178.
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 “Starting and Stopping OC4J

and Oracle BI Publisher” on page 44.
SBL-EAI-04116 BIP: Server This error might occur if the report Connected
connection is lost generation has extended the HTTP Sleep only
Time, typically only for very large or
complex reports.
To resolve, increase the HTTPSleepTime

method argument for the XMLP Driver
Service business service.

Connection
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 178.
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.
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 (%)

Connection
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:
PublicReportService::
generateReport failed: due to
oracle.apps.xdo.servlet.
CreateException: Report definition
not found:/SiebelCRMReports/
<Report Name>/<Report
Name>.xdo".
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 178.
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 178.

Connection
SBL-EAI-05010: Class name This error occurs while uploading files to Not
incorrect or does not extend Oracle BI Publisher. applicable
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 Not

'uploadReport' of Web Service 'http:/ Oracle BI Publisher. applicable
/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

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 Siebel Reports in the
Siebel Application” on page 165 and “Enabling and Disabling Debugging for Siebel Reports in
Disconnected Mode” on page 168.
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.
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).

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.
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.

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 Siebel System Administration
Guide.
Execute the following command to change the CLASSPATH:
change param CLASSPATH=SIEBSRVR_ROOT\classes\Siebel.jar;

SIEBSRVR_ROOT\classes\SiebelXMLP.jar;SIEBSRVR_ROOT\classes\wlfullclient.jar;
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.
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


13 Report Business Service
This chapter 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 181
■ Configuring the Report Business Service on page 182
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.

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. For example, you might want to add a
button to invoke report generation. 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.
For detailed information about using the Report Business Service and its methods, see 823360.1
(Article ID) on My Oracle Support.

Index
A Transformation
administering reports 67 See XSLT
Extensible Stylesheet Language-Formatting
Objects
C See XSL-FO
copying JAR files to the Oracle BI Publisher
Server 42
custom reports G
creating new integration objects for 116 generating reports 95
creating, process of 112 about 91
extending integration objects for Siebel diagram of 95
Reports 115 example of 97
process of creating, diagram of 113 for selected records, about 93
monitoring the status of 97
scenario for 92
D workflow for connected mode 24
debugging workflow for generating in disconnected
disabling for Siebel Reports in disconnected mode 25
mode 169
enabling for Siebel Reports in disconnected
mode 168 I
enabling on Oracle BI Publisher for Siebel integrating Oracle BI Publisher with Siebel
Reports 167 Business Applications
deleting scheduled reports 135 guidelines for 34
deploying reports to the Siebel Web Client preparation tasks for 38
from a disconnected client 68 process of installing and configuring Oracle BI
description of 109 Publisher 39
directory structure for Siebel Reports roadmap for 35
DATA directory, described 27 roadmap for, diagram of 36
FONTS directory, described 27 integration objects for Siebel Reports
REPORTS, directory described 27 creating new 116
TEMPLATES directory, described 27 extending to add new fields to a report 115
xliff directory, described 27 reducting the size of, about 89
disabling external file references for the
Oracle BI Publisher Server 43 J
documentation, where to find previous JAR files for the Oracle BI Publisher Server,
versions of Siebel Reports 34 adding an explicit reference to 57
E L
enabling and configuring report scheduling, locales
process of 60 adding to report layout templates 80
error messages, troubleshooting for deleting from report layout templates 80
reports 171 logging for Siebel Reports
Extensible Markup Language enabling logging for in the Siebel
See XML application 165
Extensible Stylesheet Language setting log levels for using the GUI 165
See XSL setting log levels for using the Server Manager
Extensible Stylesheet Language (srvrmgr) 166

Index ■ M
logging for the Oracle BI Publisher Server starting and stopping 44

about enabling 167 upgrading to the latest patch 45
Oracle BI Publisher Add-in for Microsoft
M Word
master-detail reports See Oracle Business Intelligence Publisher
about 137 Add-in for Microsoft Word
creating master-detail layout templates in Oracle BI Publisher Enterprise, installing 39
Microsoft Word 142 Oracle BI Publisher repository
example of comparing the Service Request about 29
Activity (All) report with its changing the location of for Siebel
corresponding layout template 138 Reports 73
using 137 Oracle BI Publisher Server
migrating reports about 28
migrating an integration object for a about installing 20
report 150 adding an explicit reference to JAR files 57
migrating new reports after creating new copying JAR files to 42
integration objects 151 disabling external file references for 43
migrating the report files to the target increasing the Java heap size for, about 89
environment 147 Oracle BI Publisher-Siebel application
moving database records to the target interaction 29
environment 149 Oracle Business Intelligence Publisher Add-
packaging and migrating reports, process in for Microsoft Word
of 146 about using with Siebel Reports 20
packaging database records in the source advantages of using 21
environment 148 Excel Analyzer feature 22
packaging the report files in the source installing 41
environment 146 menu and toolbar, example of 21
requirements for 145 Template Builder feature 22
multilingual reports Template Viewer feature 22
about working with 76 using to create report layout templates 119
adding and deleting locales from report layout
templates 80 P
designing 77 parameter type
uploading to the Siebel application, roadmap Check box, described 154
for 79 Date, described 154
DateTime, described 155
O Label, described 155
OC4J, starting and stopping 44 LOV, described 155
optimization Number, described 155
enabling scalable mode for Siebel Reports 85 Text, described 155
increasing EAI HTTP transport sleep time TextArea, described 155
for 88 parameter validation, about 158
optimizing performance for large data parameterized reports
volumes, process of 85 about 153
setting a temporary directory on the Oracle BI about defining parameters in the report
Publisher Server for 87 template 156
setting concurrency parameters for 84 about referencing parameters in the report
setting the report execution wait time for 82 layout template 156
setting the server request processor wait time creating, process of 159
for 83 example of generating 162
Oracle BI Publisher how they are generated 153
enabling debugging on Oracle WebLogic purging reports
Server for Siebel Reports 167 automatically purging from the Siebel File

Index ■ R
System 71 registering and sharing report layout

from the Oracle BI Publisher Server 72 templates, about 109
purging scheduled reports 72 registering report layout templates 120
reporting across multiple Siebel business
R objects 106
registering report layout templates, scenario for creating custom 103
about 109 setting locale user preferences 101
report execution modes comparison, troubleshooting 165
diagram of 30 uploading report layout templates to a Siebel
report generation, copying fonts for application, workflow for 107
75 using master-detail reports 137
report layout template views 109 viewing details for generated reports 99
report layout templates Reports Business Service
creating using Oracle BI Publisher Add-in for about 181
Microsoft Word 119 configuring 182
defining for selected records 126 Reports menu
defining for selected records, about 111 changing the report sequence order 127
diagram for uploading to a Siebel renaming menu items 70
application 107 sample diagram of 92
registering 120 using to generate reports 91
registering and sharing, about 109
sharing 125 S
uploading new or modified templates for scenario
multiple Siebel Server creating custom reports 103
environments 69 scheduled reports
workflow for uploading to a Siebel about 129
application 107 adding scrollbars to the Parameters dialog
report parameters box 160
about defining in the Siebel application 157 deleting 135
report sequence order, changing in the enabling and configuring, process of 60
Reports menu 127 example of 133
report templates monitoring and viewing 134
about multiorganizational templates 109 procedure for 130
visibility across organizations, scenario suspending and resuming 134
for 110 selected records
report translation, about 81 defining report layout templates for 126
reports defining report layout templates for,
about generating 91 about 111
about parameterized reports 153 sharing report layout templates, about 109
adding multiple integration objects to 124 Siebel application-Oracle BI Publisher
associating registered reports with application interaction 29
views 127 Siebel Reports
creating 103 about 17
deleting 101 about controlling access to 71
determining the report locale at run time 76 about integration objects for 104
determining whether to modify existing or about using 18
creating custom 110 administering 67
generating 95 architecture, described 23
generating an opportunity report, example development environment, described 23
of 97 directory structure, described 27
generating sample XML data files for 118 file types, described 28
generating, diagram of 95 overview of 17
parameter types and attributes, about 154 report execution in connected mode 31

Index ■ T
report execution in disconnected mode 31 errors while running 171

report output files types 19 incorrect path settings in configuration
upgrading 34 files 171
upgrading, roadmap for 64 Oracle BI Publisher run-time errors 172
uploading preconfigured reports to the Oracle Oracle BI Publisher Server login errors 173
BI Publisher Server 59 report definition errors 174
users, described 18 XLIFF errors 172
using integration object search
specifications 105 U
using Oracle Business Intelligence Publisher upgrading
Add-in for Microsoft Word with 20 Oracle BI Publisher to latest patch 45
workflow for generating reports in connected Siebel Reports, roadmap for 64
mode 24 upgrading Siebel reports, about 34
workflow for generating reports in uploading files to Oracle BI Publisher error
disconnected mode 25 SBL-EAI-04308 175
Siebel Server components, enabling for SBL-EAI-05010 175
Siebel Reports 47 user preferences, setting locale for
reports 101
T using Siebel Reports, requirements for 34
testing integration configurations for Siebel
Reports 63 W
troubleshooting reports Web service
alignment problems in JPN and PSJ PublicReportServiceService Web service,
environments 174 about 29
class name incorrect errors 172 workflow
class not found errors when previewing generating reports in connected mode 24
reports in Microsoft Word 170 generating reports in disconnected mode 25
class not found errors when previewing
reports in Microsoft Word, guidelines
for 169 X
column alignment problems in HTML and XLIFF (XML Localization Interchange File
EXCEL 174 Format), described 28
custom Java classes 172 XML (Extensible Markup Language),
error after clicking Submit to generate a described 28
report 171 XPath (XML Path Language), described 28
error due to special character violations 173 XSL (Extensible Stylesheet Language),
error messages for 171 described 28
error while uploading files to Oracle BI XSL-FO (Extensible Stylesheet Language-
Publisher 175 Formatting Objects), described 28
errors relating to the Siebel File System or XSLT (Extensible Stylesheet Language
XMLP directory 173 Transformation), described 28

Siebel Reports Guide PDF

Încărcat de

Informații document

Titlu original

Drepturi de autor

Formate disponibile

Partajați acest document

Partajați sau inserați document

Opțiuni de partajare

Vi se pare util acest document?

Este necorespunzător acest conținut?

Drepturi de autor:

Formate disponibile

Siebel Reports Guide PDF

Încărcat de

Drepturi de autor:

Formate disponibile

Siebel Reports Guide

Version 8.1, Rev. F

U.S. GOVERNMENT RIGHTS

Siebel Reports Guide 1

Chapter 1: What’s New in This Release

Chapter 2: Overview of Siebel Reports

Chapter 3: Siebel Reports Development Environment

Chapter 4: Integrating Oracle BI Publisher with Siebel

Siebel Reports Guide Version 8.1, Rev. F 3

Process of Installing Oracle BI Publisher for Integration with Siebel Business

Chapter 5: Administering Siebel Reports

4 Siebel Reports Guide Version 8.1, Rev. F

Configuring the Reports Icon 69

Chapter 6: Generating Reports

Siebel Reports Guide Version 8.1, Rev. F 5

About Generating Reports for Selected Records 93

Chapter 7: Creating Reports

Chapter 8: Scheduling Reports

6 Siebel Reports Guide Version 8.1, Rev. F

Example of Scheduling an Opportunity Report 133

Chapter 9: Using Master-Detail Reports

Chapter 10: Migrating Reports

Chapter 11: Parameterized Reports

Chapter 12: Troubleshooting Siebel Reports

Siebel Reports Guide Version 8.1, Rev. F 7

Enabling Debugging on Oracle BI Publisher Server for Siebel Reports 167

Chapter 13: Report Business Service

8 Siebel Reports Guide Version 8.1, Rev. F

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

Table 1. What’s New in Siebel Reports Guide, Version 8.1, Rev. F

“Setting Locale User Preferences for Reports”

Siebel Reports Guide Version 8.1, Rev. F 9

Table 1. What’s New in Siebel Reports Guide, Version 8.1, Rev. F

The following term was changed:

■ Oracle E-Delivery is now Oracle Software Delivery Cloud.

10 Siebel Reports Guide Version 8.1, Rev. F

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

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

Siebel Reports Guide Version 8.1, Rev. F 11

12 Siebel Reports Guide Version 8.1, Rev. F

■ 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.

❏ Reports - Customer Templates

❏ Reports - Standard Templates

■ The following view names have changed:

■ Manager’s Template View is now Manager’s Report Template View

■ The following topics were relocated to Chapter 5, “Administering Siebel Reports”:

■ “Copying Fonts for Report Generation” on page 75

■ Updated diagram and steps in “Generating Reports” on page 95.

Siebel Reports Guide Version 8.1, Rev. F 13

■ A diagram was added to “Process of Creating Custom Reports” on page 112.

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

■ 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.

❏ Reports - Customer Templates

❏ Reports - Standard Templates

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

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

■ 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.