Siebel Reports Guide

Version 8.2, Rev. A December 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 errorfree. 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 END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are “commercial computer software” pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S. Government. 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: Chapter 2:

What’s New in This Release Overview of Siebel Reports
13 14 14 15

About Siebel Reports

About Using Siebel Reports Who Can Use Siebel Reports? About Oracle BI Publisher

Siebel Reports Output File Types 16

About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports 16

Chapter 3:

Siebel Reports Development Environment
19 20 21

About the Siebel Reports Architecture

Workflow for Generating Reports in Connected Mode Siebel Reports Directory Structure Siebel Reports File Types 24 23

Workflow for Generating Reports in Disconnected Mode

About the Oracle BI Publisher Server in Siebel Business Applications How Siebel Business Applications and Oracle BI Publisher Interact

24 26

Chapter 4:

Integrating Oracle BI Publisher with Siebel Business Applications
29 29

About Integrating Oracle BI Publisher with Siebel Business Applications Where to Find Documentation for Previous Versions of Siebel Reports

Chapter 5:

Administering Siebel Reports

Deploying Report Layout Templates to the Siebel Web Client from a Disconnected Client 32 Configuring the Reports Button 33

Siebel Reports Guide Version 8.2, Rev. A

3

Contents ■ Disabling and Enabling the Reports Button Renaming Siebel Reports Menu Items 34 33 About Controlling Access to Reports 34 35 35 36 37 How the Timestamp for Reports is Determined Automatically Purging Reports from the Siebel File System Purging Scheduled Reports from the Oracle BI Publisher Server 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 37 Changing the Location of the Oracle BI Publisher Repository by Replacing a JVM Property Name 38 Changing the Location of the Oracle BI Publisher Repository by Changing the Absolute Path to the Repository 39 Copying Fonts for Report Generation Designing Multilingual Reports 41 39 40 42 About Working with Multilingual Reports Roadmap for Uploading Multilingual Reports to the Siebel Application Adding and Deleting Locales from Report Templates About Report Translation 44 45 45 46 Viewing Report Usage Statistics 43 Roadmap for Optimizing the Performance of Siebel Reports Setting the Report Execution Waiting Period for Reports Setting the Server Request Processor Database Polling Interval for Siebel Reports 46 Setting Concurrency Parameters for Siebel Reports 47 Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes 48 Enabling Scalable Mode for Siebel Reports 49 Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports 51 Increasing EAI HTTP Transport Sleep Time for Siebel Reports 51 About Increasing the Java Heap Size on Oracle BI Publisher Server About Reducing the Size of an Integration Object 53 52 Chapter 6: Generating Reports 56 Generating Reports in Siebel Business Applications 4 Siebel Reports Guide Version 8. A . Rev.2.

2. Rev. A 5 .Contents ■ Setting Siebel Reports User Preferences at the Application Level About Generating Reports for Selected Records 57 57 59 60 About Generating Reports Using the Siebel High-Interactivity Client Generating Reports Using the Siebel High-Interactivity Client 61 Scenario for Generating Reports Using the Siebel High-Interactivity Client Example of Generating an Opportunity Report Using the Siebel High-Interactivity Client 63 About Generating Reports Using the Siebel Open UI Client Generating Reports Using the Siebel Open UI Client Monitoring the Status of Currently Generating Reports Viewing Details for Previously Generated Reports Deleting Reports 70 69 66 67 68 64 65 Scenario for Generating Reports Using the Siebel Open UI Client Example of Generating an Opportunity Report Using the Siebel Open UI Client Chapter 7: Creating Reports 71 72 73 76 74 78 79 79 80 Scenario for Creating Reports About Integration Objects in Siebel Reports Using Integration Object Search Specifications for Siebel Reports About Reporting Across Multiple Siebel Business Objects About Registering and Sharing Report Layout Templates About Multiorganizational Report Templates 78 Workflow for Uploading Report Layout Templates to a Siebel Application Scenario for Report Template Visibility Across Organizations About Defining Report Layout Templates for Selected Records Process of Creating Custom Reports 81 Should You Clone an Existing Report or Create Custom Reports? Extending Integration Objects to Add New Fields for Siebel Reports 84 Creating New Integration Objects for Siebel Reports 85 Generating Sample XML Data Files for Siebel Reports 87 Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft Word 88 Registering Report Layout Templates 89 Adding Multiple Integration Objects to a Report 93 Siebel Reports Guide Version 8.

2. A .Contents ■ Sharing Report Layout Templates 94 Defining Report Layout Templates for Selected Records 95 Associating Registered Reports with Siebel Application Views 96 Changing the Report Sequence Order in the Reports Menu 96 Chapter 8: Scheduling Reports 99 103 104 100 104 About Scheduled Reports Scheduling Reports Example of Scheduling an Opportunity Report Monitoring and Viewing Scheduled Reports Deleting Scheduled Reports 105 Suspending and Resuming Scheduled Reports Chapter 9: Using Master-Detail Reports 107 About Master-Detail Reports Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template 108 Creating a Master-Detail Layout Template in Microsoft Word 112 Chapter 10: Migrating Reports Requirements for Migrating Reports 115 116 Process of Packaging and Migrating Reports Packaging the Report Files in the Source Environment 116 Migrating the Report Files to the Target Environment 117 Packaging Report Database Records in the Source Environment 118 Migrating Report Database Records to the Target Environment 119 Process of Migrating an Integration Object for a Report 120 121 Process of Migrating New Reports after Creating New Integration Objects Chapter 11: Parameterized Reports About Parameterized Reports 123 124 126 127 About Report Parameter Types and Attributes About Referencing Parameters in the Report Layout Template About Defining Report Parameters in the Siebel Application About Report Parameter Validation 128 6 Siebel Reports Guide Version 8. Rev.

A 7 .2.Contents ■ Process of Creating Parameterized Reports 129 130 Adding Scrollbars to the Parameters Dialog Box Defining Report Parameters in the Siebel Application Example of Generating a Parameterized Report 132 131 Chapter 12: Troubleshooting Siebel Reports Enabling Logging for Siebel Reports in the Siebel Application About Enabling Logging for the Oracle BI Publisher Server 135 137 137 138 Enabling Debugging on Oracle BI Publisher Server for Siebel Reports Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode Guidelines for Resolving Class Not Found Errors When Previewing Reports in Microsoft Word 139 Resolving Class Not Found Errors When Previewing Reports in Microsoft Word Troubleshooting Error Messages for Siebel Reports 141 140 Chapter 13: Report Business Service About the Report Business Service 151 152 Configuring the Report Business Service Index Siebel Reports Guide Version 8. Rev.

Rev.Contents ■ 8 Siebel Reports Guide Version 8. A .2.

“Generating Reports” Uploading New or Modified Report Layout Templates for Multiple Siebel Server Environments Additional Changes The following documentation changes affect the organization of this guide: ■ Chapter 4. Most topics are now documented in 1501378. “Renaming Siebel Reports Menu Items” on page 34 was modified to provide correct query criteria. It includes new instructions for generating reports using Siebel Open UI. A Table 1 lists the changes described in this version of the documentation to support this release of Oracle’s Siebel software.3. Topic New Product Features in Siebel Reports Guide.2. Chapter modified. This book contains the following general changes: ■ ■ The Reports icon is now referred to as the Reports button. A 9 . A Description New topic. “Integrating Oracle BI Publisher with Siebel Business Applications” was rewritten to cross reference to external integration instructions. Rev. The timestamp for a report is the submit time on the Siebel Server. Table 1. Rev. New topic. this task no longer applies.2.2.1 (Article ID) on My Oracle Support. Version 8. Siebel Reports Guide Version 8.1.1. Rev. Administrators can view a report entitled Report Usage Statistics that provides detailed statistical information.1 What’s New in This Release What’s New in Siebel Reports Guide. Version 8. As of Siebel CRM version 8. Topic deleted. “How the Timestamp for Reports is Determined” on page 35 “Viewing Report Usage Statistics” on page 45 Chapter 6.

Access to reports is based on standard Siebel position-based visibility. It provides instructions for administrators to set up an automated process for purging reports from the Siebel File System.2 Table 2 lists the changes described in this version of the documentation to support this release of the software. Access control to generated reports is based on standard Siebel position-based visibility. It describes how to deploy reports to the Siebel Web Client from a disconnected client. New topic. OC4J (Oracle Application Server Containers for Java Platform. “Creating Reports” Chapter 8. It describes how Siebel Reports determines the report language at run time. It describes report translation. Modified topic. You no longer have to purge reports manually.2 Description New chapter. “Integrating Oracle BI Publisher with Siebel Business Applications” Chapter 6. It provides updated content and reorganized topics to reflect the latest integration and configuration tasks. scheduling reports. This chapter is not applicable to scheduled reports. Added an optional step to the procedure. “Generating Reports” “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 10 Siebel Reports Guide Version 8. New topic. Modified topics in these chapters to reflect the new user interface that allows for sharing reports. A . New topic. Table 2. Modified topic. Rev. New topic. Modified topic.What’s New in This Release ■ What’s New in Siebel Reports Guide. Enterprise Edition). “Generating Reports” Chapter 7. It describes the Oracle BI Publisher. and includes other new features. Version 8. New topic. Topic New Product Features in Siebel Reports Guide. Modified topic. Version 8. “Scheduling Reports” “About Using Siebel Reports” on page 14 “About Oracle BI Publisher” on page 16 “Deploying Report Layout Templates to the Siebel Web Client from a Disconnected Client” on page 32 “Automatically Purging Reports from the Siebel File System” on page 35 “About Working with Multilingual Reports” on page 40 “Designing Multilingual Reports” on page 41 “About Report Translation” on page 44 Chapter 6.2. and Oracle BI Publisher Add-in for Microsoft Word (also known as Oracle BI Publisher Desktop). Chapter 4.

It describes the new user interface. A note was added describing what to do when this occurs. It describes how to configure a report layout template to display only the currently selected records in a Siebel application view when a report is generated. Select multiple records when generating reports. Version 8. It provides an example of using a masterdetail report. Modified topic.What’s New in This Release ■ Table 2. Modified topic. Modified topic. It describes how to share report layout templates. Override the default report language and locale settings. New topic. It describes the following: ■ ■ Which generated reports a user has access to. Updated the procedure for registering report layout templates. Rev. How to run a query on any of the fields in the Reports views. “About Registering and Sharing Report Layout Templates” on page 78 “Extending Integration Objects to Add New Fields for Siebel Reports” on page 84 “Generating Sample XML Data Files for Siebel Reports” on page 87 New topic. An optional step in creating reports that describes how to extend an existing integration object to add new fields for a report. You can now do the following: ■ ■ ■ Grant others access to your reports. Modified topic. It describes how to define the way reports are ordered in the Reports menu. A 11 . only a subset of the I/O data is exported into the XML file. When you generate sample XML data.2 Description Modified topic. Topic New Product Features in Siebel Reports Guide. Oracle BI Publisher does not support report names containing special characters. New topic.2. It describes how to register and share report layout templates. New topic. New topic. “Generating Reports Using the Siebel High-Interactivity Client” on page 61 “Viewing Details for Previously Generated Reports” on page 69 Modified topic. New topic. “Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft Word” on page 88 “Registering Report Layout Templates” on page 89 “Sharing Report Layout Templates” on page 94 “Defining Report Layout Templates for Selected Records” on page 95 “Changing the Report Sequence Order in the Reports Menu” on page 96 “Scheduling Reports” on page 100 “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108 Siebel Reports Guide Version 8.

BI Publisher Reports screen. A . “Syntax and Description of the Fields for an Example Template” on page 110 “Troubleshooting Error Messages for Siebel Reports” on page 141 Additional Changes This version of Siebel Reports Guide includes: ■ The following screen names and other user interface (UI) elements have changed: ■ ■ ■ ■ ■ The Administration . It provides additional information for the example of using a master-detail report. Topic New Product Features in Siebel Reports Guide. The following topics were relocated to Chapter 5. Added two new solutions for errors that can occur while uploading files to Oracle BI Publisher.What’s New in This Release ■ Table 2.Standard Templates ■ The Generate Sample Data File button in the Integration Objects list of the template views is now Generate Sample XML.BIP Reports screen is now the Administration . Version 8. “Administering Siebel Reports”: ■ ■ ■ “Uploading New or Modified Report Layout Templates for Multiple Siebel Server Environments” on page 87 “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on page 37 “Copying Fonts for Report Generation” on page 39 12 Siebel Reports Guide Version 8.2.Customer Templates Reports . Modified topic.2 Description New topic. The BIP Reports Server is now BI Publisher Reports. The Purge Administration view is no longer available in the UI. Rev. The Report Template Registration view is replaced with two new template views: ❏ ❏ Reports . ■ ■ You can generate reports in MHTML (MIME HTML) format in connected mode only. The My Jobs view is now the Scheduled Reports view.

The views are also used for Siebel application administrative tasks. see “About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports” on page 16. or create your own custom reports. Information about these administrative tasks is documented throughout this guide. A 13 . see Chapter 6.1 (Article ID) on My Oracle Support.” For information about scheduling reports. see 876284. For more information about using Oracle Business Intelligence Publisher Add-in for Microsoft Word. modify these reports. For more information about generating reports. report users. see Chapter 8. It includes the following topics: About Siebel Reports on page 13 About Using Siebel Reports on page 14 Who Can Use Siebel Reports? on page 14 Siebel Reports Output File Types on page 15 About Oracle BI Publisher on page 16 About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports on page 16 About Siebel Reports Oracle’s Siebel Business Applications ship with preconfigured reports and layout templates. You can choose to use these reports. schedule.” ■ In Microsoft Word by using Oracle Business Intelligence Publisher Add-in for Microsoft Word to create and customize layout templates. Siebel Reports Guide Version 8. “Scheduling Reports. This chapter provides a brief introduction to Siebel Reports and the reporting tools used to create reports. Rev. ■ In Oracle BI Publisher to manage report scheduling.2. and view reports. You work with Siebel Reports in the following locations: ■ In the Siebel application to generate.2 ■ ■ ■ ■ ■ ■ Overview of Siebel Reports The reporting module for Siebel Business Applications is Oracle® Business Intelligence Publisher (Oracle BI Publisher). “Generating Reports. For a comprehensive list of the preconfigured reports that ship with Siebel Business Applications and to download additional preconfigured reports. and other Oracle BI Publisher administration tasks.

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 14

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

14

Siebel Reports Guide Version 8.2, Rev. A

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 14

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

Siebel Reports Guide Version 8.2, Rev. A

15

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

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

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

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.

16

Siebel Reports Guide Version 8.2, Rev. A

Testing cycles are reduced because users can implement changes to the report rather than tying up valuable development resources. the Oracle BI Publisher toolbar appears.2. Oracle BI Publisher Toolbar Oracle BI Publisher Menu Figure 1. A 17 . because users can build the report that they want without having to depend on an engineer to interpret their requirements.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. Report developers can concentrate on extracting only data. as shown in Figure 1. Rev. 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. Then the report developer can use that same document to finalize the template and report. see 1501378. 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. Deployment is more efficient. they can begin creating the template in Microsoft Word. ■ ■ ■ Siebel Reports Guide Version 8. Even if your users do not have the skills to create their own layout templates. NOTE: It is recommended that you use the same versions of Oracle BI Publisher Server and Oracle BI Publisher Desktop in your deployment.1 (Article ID) on My Oracle Support.

and then a report developer can use this same document to determine how to extract data from the database in the most efficient manner. see Oracle Business Intelligence Publisher Report Designer's Guide available on Oracle Technology Network (http://www. PeopleSoft. 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. Using Template Builder.2. upload them to the Oracle BI Publisher repository. apply new parameters. Both report developers and report administrators can build and maintain reports. there is much less chance for misinterpretation of the requirements. JD Edwards. Because both report users and report developers use the same report authoring tool. 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.Overview of Siebel Reports ■ About Using Oracle Business Intelligence Publisher Add-in for Microsoft Word with Siebel Reports ■ ■ ■ Report developers can extract data from diverse sources. and then access and generate reports from an Excel session NOTE: The Analyzer for Excel feature is available only in connected mode. Enterprise Edition Plus). Oracle BI Publisher Analyzer for Excel facilitates the development of Excel templates that export data to an Excel spreadsheet.html). For more information about the connection modes in relation to Siebel Reports. only the features documented in this guide. 18 Siebel Reports Guide Version 8. Allows you to preview report layouts with sample data in multiple output formats at any stage of development. Rev. Template Viewer is a feature of Template Builder. For more information about using Oracle Business Intelligence Publisher Add-in for Microsoft Word. Facilitates the development of RTF (Rich Text Format) layout templates for reports.oracle. A . Interoperability with other standards-based reporting engines.com/technetwork/indexes/documentation/index. and apply a template to the report data Create templates in Excel. see “About the Siebel Reports Architecture” on page 19. such as Oracle’s enterprise reporting tool that is used in Oracle E-Business Suite. Excel Analyzer. BI EE (Business Intelligence Suite. ■ ■ Template Viewer. NOTE: Not all features mentioned in the Oracle Business Intelligence Publisher documentation are currently integrated in the Siebel Reports solution. users create how they want their report to look. and so on.

It includes the following topics: ■ ■ ■ ■ ■ ■ ■ About the Siebel Reports Architecture on page 19 Workflow for Generating Reports in Connected Mode on page 20 Workflow for Generating Reports in Disconnected Mode on page 21 Siebel Reports Directory Structure on page 23 Siebel Reports File Types on page 24 About the Oracle BI Publisher Server in Siebel Business Applications on page 24 How Siebel Business Applications and Oracle BI Publisher Interact on page 26 About the Siebel Reports Architecture For Siebel CRM version 8. see “Workflow for Generating Reports in Connected Mode” on page 20. however. It is possible to generate Oracle BI Publisher reports with the embedded Oracle BI Publisher libraries. the XMLP Report Server component. see “Workflow for Generating Reports in Disconnected Mode” on page 21. These two instances. TIP: For some Siebel Business Applications. For more information about the architecture for disconnected mode. such as is the case with Siebel Loyalty. However. Rev. From the perspective of the user when requesting reports in the various Siebel clients. 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. and one for disconnected mode. Siebel Reports supports two architectures: one for 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. executing report requests using the Siebel clients differs depending on the connection mode: ■ Disconnected mode.2. the Siebel Web Client is not required. The instances are mentioned so that you know there are other reporting capabilities available for Siebel Reports. there is no apparent difference. are not documented in this guide.1 and later. and the Oracle BI Publisher Server. 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. Connected mode. ■ Siebel Reports Guide Version 8.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. A 19 .

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. some software elements retain the XMLP naming convention. The Siebel Application Object Manager (AOM) routes the event to the Siebel Database. Figure 2. the XMLP Report Server component processes the request and extracts the relevant data from the Siebel Database. The report is stored in the Siebel File System and then displayed in the Siebel application. Rev. generates the layout template. previously Oracle BI Publisher was called XML Publisher or XMLP. then issues an outbound Web service call to a standalone Oracle BI Publisher Server. 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 XMLP Report Server component converts the data to XML. NOTE: Oracle BI Publisher was recently renamed.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. and merges the layout template with the XML data. Figure 2 illustrates both the architecture and workflow for generating reports in connected mode. Siebel Reports Architecture and Workflow for Generating Reports in Connected Mode The following text provides a high-level description of Figure 2: 1 2 3 A report generation event is triggered from a Siebel application view. 20 Siebel Reports Guide Version 8. A . For this reason. When you select a report from the Reports menu in a Siebel application view. The Oracle BI Publisher Server accepts the XML data file.2.

binary data by way of a Web service call back to the proxy PublicReportServiceService business service. Rev. the Oracle BI Publisher Server is a logical component that uses the Oracle BI Publisher XDO Engine to manage generating reports.2. The Oracle BI Publisher XDO Engine then processes the XML data. see Siebel Installation Guide for the operating system you are using. The XMLP Data Service passes control back to the XMLP Driver Service. 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). For more information about the EAI Java Business Service and JVM. The XMLP Adapter Service makes a call to the proxy PublicReportServiceService business service. For information about client installation. 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. XSL template. In disconnected mode. 12 The XMLP Adapter Service then downloads the report. A 21 . see Transports and Interfaces: Siebel Enterprise Application Integration. The XMLP Data Service fetches data from the Siebel Database through the EAI Siebel Adapter.Siebel Reports Development Environment ■ Workflow for Generating Reports in Disconnected Mode 4 5 6 7 8 9 The XMLP Driver Service makes a call to the XMLP Data Service. Siebel Reports Guide Version 8. 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. which is displayed in the Siebel application. 10 The Oracle BI Publisher Server executes report generation and returns the generated report 11 The proxy PublicReportServiceService business service returns control to the XMLP Adapter Service. and XLIFF files to generate the report. The proxy PublicReportService business service makes a Web service call to the Oracle BI Publisher Server. and then returns the control back to the XMLP Data Service. These core libraries are located in the SIEBEL_CLIENT_ROOT\CLASSES directory. and creates the file in the Siebel File System. The XMLP Driver Service makes a call to the XMLP Adapter Service.

A call is routed to the XMLP Report Java Business Service.2. some software elements retain the XMLP naming convention. The report is temporarily stored in XMLP\REPORTS. 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.Siebel Reports Development Environment ■ Workflow for Generating Reports in Disconnected Mode Figure 3 illustrates both the architecture and workflow for generating reports in disconnected mode. The control then goes back to the Siebel user interface where the generated report appears. Figure 3. and then sent to the Siebel File System. XLIFF. The XMLP Report Business Service instantiates the EAI Java Business Service. The Oracle BI Publisher XDO Engine loads the XDO classes from the JAR files. A . Rev. For this reason. Siebel Reports Architecture and Workflow for Generating Reports in Disconnected Mode Figure 3 illustrates the following: 1 2 3 4 5 A report generation event is triggered from a view in the Siebel application. NOTE: Oracle BI Publisher was previously known as XML Publisher or XMLP. and then the XML. and XSL template are given as input to the XDO classes for generating the report. and loads the JAR files to the JVM (Java Virtual Machine). 6 22 Siebel Reports Guide Version 8.

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. \xliff\lang Contains the XLIFF files for localization.ttf (TrueType format) font files. For more information about installing languages. This directory also contains the XSL files necessary for disconnected mode. see “About the Oracle BI Publisher Server in Siebel Business Applications” on page 24. Users can download these report files to a local drive. see “How Siebel Business Applications and Oracle BI Publisher Interact” on page 26. A 23 . Table 3 provides descriptions of these directories. For more information about copying font files. XMLP Path \DATA \FONTS \REPORTS \TEMPLATES Contains the temporary files for generating reports. Siebel Reports Guide Version 8. Siebel Reports XMLP Directory Structure Description Contains the generated XML files from the integration object definition. For more information. Contains the prepackaged . Rev. XLIFF files for German reside in xliff\deu and XLIFF files for French reside in xliff\fra.2. Table 3. XLIFF is the XML format for exchanging localization data. the XLIFF file (or files) is stored in the relevant xliff\lang directory (or directories) on the Siebel Server. TIP: Siebel Language Packs are installed as part of the Siebel installation process. Contains the RTF (Rich Text Format) layout templates. For example.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). NOTE: After a report template is registered. For information about how these files are used for generating reports. see “Copying Fonts for Report Generation” on page 39. a separate xliff subdirectory is provided for each language and is identified by its language code. 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. see Siebel Installation Guide for the operating system you are using. If multiple languages are supported.

XSLT (Extensible Stylesheet Language Transformation). An XSL style sheet is a file that describes how to display an XML document of a given type. ■ ■ Siebel Reports uses the following languages for generating reports: ■ ■ ■ XSL-FO (Extensible Stylesheet Language-Formatting Objects). For information about installing Oracle BI Publisher. XSL (Extensible Stylesheet Language). A format to store extracted text and carry the data from one step to another in the localization process. Siebel Reports also supports various report output file types. A markup language is a mechanism to identify structures in a document. Rev. A language for transforming XML documents.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). XLIFF (XML Localization Interchange File Format).1 (Article ID) on My Oracle Support. For more information about the connection modes for Siebel Reports. An expression language used by XSLT to access or refer to parts of an XML document. For more information about generating reports in connected mode. see “About the Siebel Reports Architecture” on page 19. A language for expressing style sheets.2. 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 more information about these report output types. Used in disconnected mode only. 24 Siebel Reports Guide Version 8. 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. An XML vocabulary for specifying formatting semantics. XML is a metalanguage that is a simplified version of SGML (Standard Generalized Markup Language) used for describing markup languages. see 1501378. see “Workflow for Generating Reports in Connected Mode” on page 20. A . see “Who Can Use Siebel Reports?” on page 14. XPath (XML Path Language). 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.

The layout template (RTF) and XLIFF files necessary for generating that report are in that folder. The Oracle BI Publisher repository is a collection of reports that is installed as part of the Oracle BI Publisher Server installation. In the SharedFolder directory in the Oracle BI Publisher repository. Each report stored in the SIEBELCRMREPORTS directory has its own folder. 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. When handling a report request. Siebel Reports Guide Version 8. About the PublicReportServiceService Web Service The PublicReportServiceService Web service is a Web service that is exposed by Oracle BI Publisher. The repository stores the preconfigured reports that ship with Siebel Business Applications and new reports you create. This service is the mechanism that Siebel Reports uses in connected mode to upload and pass reports to the Siebel application. which is triggered from the Siebel application. The Oracle BI Publisher Server then requests report generation using a Web service to generate the report.2. see “Workflow for Uploading Report Layout Templates to a Siebel Application” on page 76. the SIEBELCRMREPORTS directory stores all reports.Siebel Reports Development Environment ■ About the Oracle BI Publisher Server in Siebel Business Applications The Oracle BI Publisher Server uses a push-pull mechanism to transfer XML data between the Siebel application and the Oracle BI Publisher Server. data is pushed from the Siebel Database to the Oracle BI Publisher Server to generate reports. A 25 . The following subtopics describe the Oracle BI Publisher Server functionality in relation to Siebel Reports in greater detail. You upload the layout template files (RTF and XLIFF) to the Oracle BI Publisher Server by registering the template in the Siebel application. For more information about uploading layout templates to the Oracle BI Publisher repository and registering layout templates. 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. Rev. During report generation.

layout templates are merged with XML data differently to render reports in the Siebel user interface. 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 26 Siebel Reports Guide Version 8. Comparison of Report Execution in Connected and Disconnected Mode Figure 4 illustrates the following: 1 A report generation request is initiated from a Siebel application view.2. Figure 4. Figure 4 compares report execution in connected mode with disconnected mode. However. depending on your connection mode.Siebel Reports Development Environment ■ How Siebel Business Applications and Oracle BI Publisher Interact How Siebel Business Applications and Oracle BI Publisher Interact Siebel Business Applications integrate with Oracle Business Intelligence Publisher (Oracle BI Publisher) for report execution. A . Rev.

Siebel Reports Development Environment ■ How Siebel Business Applications and Oracle BI Publisher Interact 2 3 The RTF Processor converts the RTF layout templates to XSL for input to the BI Publisher-FO Processor. 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. and MHTML. RTF. NOTE: The PPT and MHTML output file types are available only in connected mode. PPT. and then using the BI Publisher-FO Processor. EXCEL. 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.FO) for manipulating XML data. The PublicReportServiceService Web service is the interface between the Siebel application and the Oracle BI Publisher Server. Oracle BI Publisher provides the XML file to the engine using the EAI Java Business Service. a feature of Oracle Business Intelligence Publisher Add-in for Microsoft Word. Template Builder. You use form fields in template design wherever data is required. is used to modify and customize layout templates. A 27 . Rev.2. Template Builder generates these form fields using the Siebel application and the information specified in the layout template. XSL-FO. The EAI Java Business Service is the JVM (Java Virtual Machine) interface between the XDO Engine and the Siebel application. 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. Template Builder uses form fields to encapsulate XSL instructions for parsing XML data. Siebel Reports Guide Version 8. converts the files to the published report formats. The XML data file is merged with the layout template. are XLIFF formats are converted to: PDF. 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. The data comes from the results of the internal queries run against various data sources. XML files are generated by way of the EAI Siebel Adapter. 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. using the EAI Java Business Service for connecting a Siebel application to the XDO Engine. The XMLP Report Server component uses the XDO Engine to convert the RTF templates into XSL format. The XML contains the data that populates the resulting document. The XMLP Adapter Service invokes the PublicReportServiceService Web service to generate reports. One of the required inputs for the XDO Engine is an XML file. XML. XPath. 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. HTML. and XSL. XSL comprises three standards (XSLT.

A .2. Rev.Siebel Reports Development Environment ■ How Siebel Business Applications and Oracle BI Publisher Interact 28 Siebel Reports Guide Version 8.

A 29 . However.x and perform additional configuration tasks for both the Siebel application and Oracle BI Publisher.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 29 Where to Find Documentation for Previous Versions of Siebel Reports on page 29 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. 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.1 (Article ID) on My Oracle Support. Rev. To find the documentation for your deployment.1 (Article ID) on my Oracle Support. then you must upgrade to the latest Siebel CRM Fix Pack 8. see 1501378.2.2. NOTE: If you have an existing Siebel Reports environment and you want to use the latest report features. see 1172844. For integration instructions. Siebel Reports Guide Version 8. you must perform several installation and configuration or upgrade tasks. before you can use these latest features. The tasks you perform are contingent on whether you are deploying Siebel Reports for the first time or you are already using Siebel Reports.2.

A .2. Rev.Integrating Oracle BI Publisher with Siebel Business Applications ■ Where to Find Documentation for Previous Versions of Siebel Reports 30 Siebel Reports Guide Version 8.

This chapter includes the following topics: Deploying Report Layout Templates to the Siebel Web Client from a Disconnected Client on page 32 Configuring the Reports Button on page 33 Disabling and Enabling the Reports Button on page 33 Renaming Siebel Reports Menu Items on page 34 About Controlling Access to Reports on page 34 How the Timestamp for Reports is Determined on page 35 Automatically Purging Reports from the Siebel File System on page 35 Purging Scheduled Reports from the Oracle BI Publisher Server on page 36 Changing the Location of the Oracle BI Publisher Repository for Siebel Reports on page 37 Copying Fonts for Report Generation on page 39 About Working with Multilingual Reports on page 40 Designing Multilingual Reports on page 41 Roadmap for Uploading Multilingual Reports to the Siebel Application on page 42 Adding and Deleting Locales from Report Templates on page 43 About Report Translation on page 44 Viewing Report Usage Statistics on page 45 Roadmap for Optimizing the Performance of Siebel Reports on page 45 Setting the Report Execution Waiting Period for Reports on page 46 Setting the Server Request Processor Database Polling Interval for Siebel Reports on page 46 Setting Concurrency Parameters for Siebel Reports on page 47 Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes on page 48 About Increasing the Java Heap Size on Oracle BI Publisher Server on page 52 About Reducing the Size of an Integration Object on page 53 Siebel Reports Guide Version 8. A 31 .5 ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Administering Siebel Reports This chapter describes some of the administrative tasks for Siebel Reports.2. Rev. The tasks in this chapter are for administrators only and are applicable to both connected and disconnected modes unless otherwise indicated.

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. A . After you click Upload in the user interface. Rev. 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. Verify the report was successfully uploaded by doing the following: 32 Siebel Reports Guide Version 8.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. assign the associated . Click Upload Files. 4 Upload the report to the Oracle BI Publisher Server by doing the following: a b 5 Navigate back to the applicable template view. 3 Assign the report to a Siebel view or views. This topic describes how to deploy reports to the Siebel Web Client from a disconnected client. After you test and verify a report layout template.Standard Templates b c Create a new record and assign the template and integration object to the record. you must move that report to the Siebel Server to deploy the report to the Siebel Web Client. In the XLIFF field. see “Associating Registered Reports with Siebel Application Views” on page 96. 2 Register the report by doing the following: a Navigate to the Administration . such as the Siebel Developer Web Client.2. For information about assigning reports to Siebel views. the report is then available for generation in connected mode with the Oracle Business Intelligence Publisher (Oracle BI Publisher) Server. NOTE: The Generate XLIFF button is disabled in the Siebel Web Client and that is why you must explicitly select the . then one of the following template views: ❏ ❏ Reports . 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 (.Custom Templates Reports .xlf file to the report.rtf) XLIFF (.BI Publisher Reports screen.xlf file.

Siebel Reports Guide Version 8. Use the following procedure to enable and disable the Reports button. Rev. However. and then set the System Preferences value as described in the following table. Verify that the new report layout template and associated files were uploaded. Click the Reports tab. the Reports button appears in Siebel Business Applications below the application-level menu. To disable the Reports button 1 2 3 Log in to the Siebel application with administrator privileges.Application screen. Navigate to the Administration . You can disable it by setting the ReportEngineType system preference in the Siebel Business Applications. you have the option to disable it or alter which menu items appear and how they display in the user interface. see “Report Business Service” on page 151. If this system preference is set to NONE. and then click SiebelCRMReports.2. perform the following tasks: ■ ■ (Optional) “Disabling and Enabling the Reports Button” on page 33 (Optional) “Renaming Siebel Reports Menu Items” on page 34 Disabling and Enabling the Reports Button By default. A 33 . To configure the Reports button. expand Shared Folders. NOTE: If the Reports icon is disabled. Configuring the Reports Button By default. System Preference Value NONE BIP Description This option disables the Reports button. For more information. then you can still execute reports using Siebel workflows or Siebel business services. then the Reports button does not appear. Disabling and Enabling the Reports Button This topic is an optional step in “Configuring the Reports Button” on page 33. Query for ReportEngineType.Administering Siebel Reports ■ Configuring the Reports Button a b c Log in to the Oracle BI Publisher Server with administrator privilege. then the System Preferences view. 4 Restart the Siebel Server to verify the Reports icon does not appear. the Reports button appears in Siebel Business Applications below the application-level menu. This option enables the Reports button.

To rename a Siebel Reports menu item 1 2 3 Log in to Siebel Tools with administrator privileges. Click Reports to view your changes. For custom report templates. A .Administering Siebel Reports ■ About Controlling Access to Reports Renaming Siebel Reports Menu Items This topic is an optional step in “Configuring the Reports Button” on page 33. you might want to change My BI Publisher Reports in the Reports menu to Generated Reports or something similar. For more information about granting access to others. and then navigate to any screen. For general information about access controls. Using Siebel Tools. see the topic on setting up and enabling the Siebel Security Model for Siebel Reports in 1501378. Perform one of the following: a b 4 5 To change the My BI Publisher Reports menu item. You can also share completed reports using position-based visibility. see the topic about security and authentication in 1501378. distribute the updated SRF. Rev. To change the Schedule Report menu item. The Reports menu in Siebel Business Applications is customizable. and then restart the Siebel Server.2. you can apply position.and organization-based visibility to configure which report templates are made available to users. query for SBL_SCHEDULE_BIPUBLISHER_REPORTS. About Controlling Access to Reports Standard Siebel Business Applications access controls apply to Siebel Reports. 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. and then edit the Current String Value.1 (Article ID) on My Oracle Support. For example. and then edit the Current String Value. access is controlled by way of a view to report relationship. In the Object Explorer. For standard report templates. see Siebel Security Guide. For more information about user access in relation to Siebel Reports. you rename Siebel Reports menu items by configuring symbolic strings to change the text string. For more information about reports responsibilities. select the Symbolic String object. 34 Siebel Reports Guide Version 8. query for SBL_MY_BIPUBLISHER_REPORTS. see “Sharing Report Layout Templates” on page 94. Verify your changes by doing the following: a b Launch the Siebel application.1 (Article ID) on My Oracle Support. Compile the Symbolic String project.

Administering Siebel Reports ■ How the Timestamp for Reports is Determined How the Timestamp for Reports is Determined The timestamp for a report is the submit time on the Siebel Server. then you set the value to 7. For information about deleting reports. the value is set to -1 (minus 1). the report appears with a blank status in the My Reports view. when the XLMP Report Server component is enabled. To automatically purge reports from the Siebel File System 1 2 3 Log in to the Siebel application as a Siebel administrator.Application screen. nonzero value. because you run the risk of inadvertently depleting or contaminating the report repository.2. 4 Navigate to the Administration . You purge reports by using filters or by running a workflow process. see Siebel Business Process Framework: Workflow Guide. see “Deleting Reports” on page 70. the status might not appear long enough for you to view it. but they must not purge reports. then the Jobs view. see “Purging Scheduled Reports from the Oracle BI Publisher Server” on page 36. especially for large-scale implementations where many reports are generated. In the System Preferences list. For example. This behavior is because typically the In Progress status disappears after only a few seconds and is replaced with a status of Success (or Error). By default. Automatically Purging Reports from the Siebel File System Administrators must periodically purge reports from the Siebel File System. Siebel Reports Guide Version 8. but remove all reports after this time frame. NOTE: Administrators are also responsible for purging 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. This topic describes how to set up reports to automatically purge after the reports meet certain criteria. However. if you want to keep reports for the last seven days. For information about this purging. Report developers and other users can delete reports. CAUTION: It is recommended that only administrators perform this task. A 35 . If a report is submitted when the XMLP Report Server component is not enabled. Rev. Navigate to the Administration . select BIP Delete After Days.Server Management screen. For more information about workflow processes. and change the value to a positive. Setting this parameter to a low value prevents the Siebel File System from increasing to an unmanageable size. then the System Preferences view. NOTE: It is recommended that you set this value in relation to your daily report volumes. The reports are purged from the database and the Siebel File System after the number of days specified. Then. the report immediately shows a status of In Progress. 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.

For information about this purging. You can also schedule this job to generate periodically using a workflow. see “Deleting Scheduled Reports” on page 105. see “Automatically Purging Reports from the Siebel File System” on page 35. Rev.com/technetwork/indexes/documentation/index. Report developers and other users can delete reports. Give the parameter a value of XMLP Purge Records. 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:// www. Click Submit.html). but they cannot purge reports.2. Administrators can periodically purge scheduled reports from the Oracle BI Publisher Server by removing Oracle Business Intelligence Scheduler job instances from the database. because you run the risk of inadvertently depleting or contaminating the report repository. see Siebel Business Process Framework: Workflow Guide. CAUTION: It is recommended that only administrators purge scheduled reports. 36 Siebel Reports Guide Version 8. Add a parameter to the job as follows: a b 7 Enter Workflow Process Name as the name. For more information about scheduling workflows. TIP: You cannot purge scheduled reports from the Siebel application or by using the Oracle BI Publisher administration application. This topic describes how to purge reports using either the Job Manager Instances List or the Job Manager Purge Instances Window.Administering Siebel Reports ■ Purging Scheduled Reports from the Oracle BI Publisher Server 5 6 Add a new job entitled Workflow Process Manager. A . NOTE: Administrators are also responsible for purging reports from the Siebel File System.oracle. 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. For information about deleting reports.

the location of the Oracle BI Publisher repository is stored in the Oracle home JVM property with a value of ${oracle.home property value is automatically set by the OC4J container. ■ Replace a JVM property name For instructions. 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.1. A 37 .oracle. then this oracle.3 available on Oracle Technology Network (http://www. see “Changing the Location of the Oracle BI Publisher Repository by Replacing a JVM Property Name” on page 38 ■ Change the absolute path to the repository For instructions. For more information about OC4J.com/technetwork/ indexes/documentation/index. Enterprise Edition (OC4J) standalone. see “Changing the Location of the Oracle BI Publisher Repository by Creating a Custom XML File” on page 37. If you do not want to use ${oracle. If Oracle BI Publisher is running on an Oracle Application server or an Oracle Application Server Containers for Java Platform. By default.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.Administering Siebel Reports ■ Changing the Location of the Oracle BI Publisher Repository for Siebel Reports 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.html).2.home}/xdo/repository. see Oracle Business Intelligence Publisher Installation Guide. Siebel Reports Guide Version 8. Rev. The Siebel application uses this JVM property to access the Oracle BI Publisher repository. see “Changing the Location of the Oracle BI Publisher Repository by Changing the Absolute Path to the Repository” on page 39. Release 10.

xml file to reflect the new path.1.3 deployment.0" encoding="UTF-8"?> <xmlpConfig xmlns="http://xmlns. Rev.2.xml 2 Edit the newly created . For example. To create a custom XML file to change the location of the Oracle BI Publisher repository 1 Copy the xmlp-server-config.oracle. replace oracle.Administering Siebel Reports ■ Changing the Location of the Oracle BI Publisher Repository for Siebel Reports This task is a step in “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on page 37.dir=/home/BIP Changing the Location of the Oracle BI Publisher Repository by Replacing a JVM Property Name Use the following procedure to change the location of the Oracle BI Publisher Repository by replacing a JVM property name. This task is a step in “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on page 37.server. 38 Siebel Reports Guide Version 8.home}/xdo/repository"/> </resource> </xmlpConfig> 3 Start the application server by adding the following JVM option: -Dxdo.xml file is: <?xml version="1.home with some other JVM property name.com/oxp/xmlp"> <resource> <file path="${oracle.xml file. NOTE: You must set the value of the new JVM property to the correct repository path.config.xml file and paste it to a folder where Oracle BI Publisher can read it. To change the location of the Oracle BI Publisher repository by replacing a JVM property name ■ In the WEB-INF/xmlp-server-config. The default configuration for the xmlp-server-config. A . in an Oracle AS/OC4J 10. you copy the configuration file from: OC4J_HOME/j2ee/home/applications/xmlpserver/xmlpserver/WEB-INF/xmlp-serverconfig.

Siebel Reports Guide Version 8. 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). To copy fonts ■ On the Siebel Server where the XMLP Report Server component is enabled. If a report is generated from a computer where the fonts in the report are not available. NOTE: This task is typically performed as part of the Siebel application installation. then the output might not be as expected when trying to generate.2. 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. preview. Use the following procedure to change the location of the Oracle BI Publisher Repository by changing the absolute path to the repository. see Siebel Global Deployment Guide. copy the fonts in the /Fonts directory to the fonts directory in the Java installation directory for your deployment. do one of the following: ■ ■ For Windows. view.xml file. Copying Fonts for Report Generation Fonts used in reports are obtained from the computer on which the report is generated. For more information about fonts in Siebel Business Applications. change the absolute path to the repository that you want. However. Rev. administrators can perform this task at any time. or schedule reports.Administering Siebel Reports ■ Copying Fonts for Report Generation Changing the Location of the Oracle BI Publisher Repository by Changing the Absolute Path to the Repository This task is a step in “Changing the Location of the Oracle BI Publisher Repository for Siebel Reports” on page 37. This topic describes how to resolve this unexpected behavior. For UNIX. A 39 . 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.

then the Locale view). If the locale is specified at the template level. the values in the report layout template prevail. Let users override the default locale values when generating reports. and the user has set a locale property in their user preferences. Let users set a default locale preference for their own report generation. 40 Siebel Reports Guide Version 8. then the template parameters are used rather than those specified for the input. you might have a preference for a document language for a specific Quote report. If no parameters are passed to the Report Business Service. For example. users can override these settings at run time for an individual report (see Run-time Selection in this table). Execute report generation using the default locale settings of the user’s session object manager. A locale is a language and locale combination as defined in the locale administration screen in the Siebel application (Data Administration screen. Make sure that a report is generated against a particular Siebel record with a preference for a specific document locale for that record. Table 4. The order defines the logic applied at run time to determine which default language preferences to use. However. NOTE: Only use locale values as business service inputs when these values are not set at the template level. then the user preference values are used.2. How Siebel Reports Determines the Report Language at Run Time Order 1 Description If a default locale is specified in the report layout template. Default Preference Template specific Entity related (business service) 2 User preferences 3 If the report layout template does not have a default locale. For information about setting user preferences for report generation. then these values appear as the default selection for the report output. Otherwise. then the default application object manager values are used. The Report Business Service is configurable for locale as an optional inputs. Siebel Reports allows you to: ■ ■ Configure reports that are generated for a specific locale.Administering Siebel Reports ■ About Working with Multilingual Reports 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. ■ ■ ■ Table 4 provides details of how this logic is implemented in Siebel Reports. see “About Generating Reports Using the Siebel Open UI Client” on page 64. A . Rev.

see “About Report Translation” on page 44. If no default locale is specified in the report layout template level or in the user preferences. 4 (Optional) Using Oracle Business Intelligence Publisher Add-in for Microsoft Word. For information about registering reports. Default Preference Run-time selection No language or locale specified Related Topics “Designing Multilingual Reports” on page 41 “Roadmap for Uploading Multilingual Reports to the Siebel Application” on page 42 “Adding and Deleting Locales from Report Templates” on page 43 “About Report Translation” on page 44 Designing Multilingual Reports Designing multilingual reports is the same as designing a standard report. see “Registering Report Layout Templates” on page 89. whether it uses connected or disconnected mode.Administering Siebel Reports ■ Designing Multilingual Reports Table 4. A 41 . redesign the layout template for the new language. For more information about uploading files. see Chapter 7.S. then the current application object manager values for the session are used. 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. For more information about designing reports. see “Workflow for Uploading Report Layout Templates to a Siebel Application” on page 76.). In the Siebel application.” To design a multilingual report 1 2 3 Design a report in the default language. that is.2. Related Topics “About Working with Multilingual Reports” on page 40 “Roadmap for Uploading Multilingual Reports to the Siebel Application” on page 42 “Adding and Deleting Locales from Report Templates” on page 43 Siebel Reports Guide Version 8. register the report. ENU (English U. for example. The only difference is that you must externalize the user interface elements for localization in the locales that you want. add a default locale to the report layout template. Rev. Using Oracle Business Intelligence Publisher Add-in for Microsoft Word. How Siebel Reports Determines the Report Language at Run Time Order 4 5 Description Users can override the default locale values when generating a report. For more information about externalizing the user interface elements. “Creating Reports.

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

com/technetwork/indexes/documentation/index. For more information about translation naming conventions. Deleting a Locale from a Report Use the following procedure to delete a locale from a report template. Adding a Locale to a Report Use the following procedure to add a locale to a report template. (Optional) If you want a different name for the translated report to appear in the Reports menu. Related Topics “About Working with Multilingual Reports” on page 40 “Designing Multilingual Reports” on page 41 “Adding and Deleting Locales from Report Templates” on page 43 “About Report Translation” on page 44 Adding and Deleting Locales from Report Templates You add or delete a locale by adding or deleting a language. Navigate to the Administration . A 43 .Custom Templates Reports . click New.xlf. In the Translations subview. Each XLIFF file is registered using the format TemplateName_language code_TERRITORY CODE.2. add a new language. To add a locale to a report 1 2 Log in to the Siebel application.html). This topic describes how to add and delete locales from report templates. select the report to which you want to add a locale.Administering Siebel Reports ■ Adding and Deleting Locales from Report Templates 5 Log in to Oracle BI Publisher Server to review the structure of the registration. then to one of the following template views: ■ ■ Reports . enter a Report Name. Siebel Reports Guide Version 8.BI Publisher Reports screen. In the Language field. see “About Working with Multilingual Reports” on page 40.Standard Templates 3 4 5 6 In the appropriate Template list. For more information about locales. and then click OK. see Oracle Business Intelligence Publisher Report Designer's Guide on Oracle Technology Network (http:// www.oracle. Rev.

Translation is determined by way of the translations in the relevant XLIFF file. a third party usually performs the actual translation. Rev. Typically. NOTE: For a list of the languages that Siebel Reports supports. and then click Delete. NOTE: This step removes only the language from the report. then to one of the following template views: ■ ■ Reports . In the case of reports. A . When multilingual reports are generated for a specific report locale. Translation is determined based on the selected report locale and LOV data extracted by way of EAI in the relevant language. see “Siebel Reports Directory Structure” on page 23.BI Publisher Reports screen. you must externalize the user interface elements for localization in the languages that you want.Standard Templates 3 4 In the Report Template Registration list.2. an administrator manages report translations. allowing the translator to work only on the text to be translated. choose a language. To externalize the user interface means to separate the localizable attributes from the nonlocalizable attributes of the user interface elements for each translation.Administering Siebel Reports ■ About Report Translation To delete a locale from a report 1 2 Log in to the Siebel application. Navigate to the Administration .Custom Templates Reports . it does not remove the report. strings are externalized to an XLIFF file. MLOVs. select the report from which you want to delete a language. In the Translations list. For more information about XLIFF files related to Siebel Reports. The XLIFF format separates localizable text from formatting. 44 Siebel Reports Guide Version 8. see Siebel System Requirements and Supported Platforms on Oracle Technology Network. Related Topics “About Working with Multilingual Reports” on page 40 “Designing Multilingual Reports” on page 41 “Roadmap for Uploading Multilingual Reports to the Siebel Application” on page 42 “About Report Translation” on page 44 About Report Translation To translate reports. the following occurs for each component of the report translation: ■ ■ Template text elements.

CAUTION: Each translated report must have a unique translated display name. If there are duplicate names for translated reports. Siebel Reports Guide Version 8. This report is available as part of the preconfigured reports that ship with Siebel Business Applications.2. ■ ■ ■ ■ “Setting the Report Execution Waiting Period for Reports” on page 46 “Setting the Server Request Processor Database Polling Interval for Siebel Reports” on page 46 “Setting Concurrency Parameters for Siebel Reports” on page 47 “Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes” on page 48 NOTE: Most of these tasks are applicable only when the client is in connected mode unless noted otherwise. It is recommended you perform these tasks as part of the Siebel Reports installation process. failures. long-running reports. Rev.1 (Article ID) on My Oracle Support. and currency fields is based on the template functions: format-date() and format-currency(). For information about downloading these reports. However. A 45 . The format of date. Related Topics “About Working with Multilingual Reports” on page 40 “Designing Multilingual Reports” on page 41 “Roadmap for Uploading Multilingual Reports to the Siebel Application” on page 42 “Adding and Deleting Locales from Report Templates” on page 43 Viewing Report Usage Statistics Administrators can view a report entitled Report Usage Statistics that provides detailed statistical information about report generation. time. Roadmap for Optimizing the Performance of Siebel Reports There are several tasks you can perform to optimize the performance of Siebel Reports. and so on. 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. then when those names pass from the browser to the Siebel Server. see 876284. you can perform them later. the server cannot differentiate which report to generate. users who run the reports. These tasks are not implemented in a particular order.Administering Siebel Reports ■ Viewing Report Usage Statistics ■ Dates and currency formatting.

46 Siebel Reports Guide Version 8.Administering Siebel Reports ■ Setting the Report Execution Waiting Period for Reports Setting the Report Execution Waiting Period for Reports It is recommended that you limit the wait time for report execution. and if a report is still generating. The minimum threshold value allowed is 0. and then change the System Preference Value to a number greater than 0. Related Topics Setting the Server Request Processor Database Polling Interval for Siebel Reports Setting Concurrency Parameters for Siebel Reports Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes Setting the Server Request Processor Database Polling Interval for Siebel Reports To optimize the performance of Siebel Reports. To set the report execution waiting period for reports 1 2 Navigate to the Administration . users can return to the Siebel application while their reports generate in the background. select BIP Report Wait Time.Application screen. After the threshold is reached. This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 45. a message appears stating that the report is running in the background and to retrieve the report from the BI Publisher Reports view. Use the following procedure to set the Database Polling Interval server component parameter. which sends all reports into the background. Rev. then the System Preferences view. This parameter defines how long to wait before SRProc polls the database again when the current polling does not get requests. By setting the value greater than 0 seconds.2. it is recommended you change the Database Polling Interval parameter for the Server Request Processor (SRProc) server component. In the System Preferences list. You do so by setting a threshold value in seconds for the BIP Report Wait Time system preference. A . For information about this view. NOTE: This parameter is hidden by default and does not appear in either the Siebel Server Manager GUI or the Siebel Server Manager command-line interface program. This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 45. see “Generating Reports Using the Siebel High-Interactivity Client” on page 61.

Administering Siebel Reports ■ Setting Concurrency Parameters for Siebel Reports

To set the Server Request Processor database polling interval for Siebel Reports 1 2 3 4
Navigate to the Administration - Server Configuration screen, Servers, and then the Components view. In the Components list, select Server Request Processor (alias SRProc). Scroll down, click the Parameters subview, and then click Hidden. In the Parameter list, select Database Polling Interval, and change the value from 10 to 1. The Value on Restart and Default Values are updated as well.

5

Restart the Siebel Server. Alternatively, you can use the srvrmgr command-line interface to restart the SRProc component For more information about setting the server component parameters and restarting the Siebel Server and server components, see Siebel System Administration Guide.

Related Topics Setting the Report Execution Waiting Period for Reports Setting Concurrency Parameters for Siebel Reports Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes

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. This task is a step in “Roadmap for Optimizing the Performance of Siebel Reports” on page 45.

Setting Concurrency Parameters Using a Siebel Application
Use the following procedure to set the concurrency parameters using a Siebel application.

To set concurrency parameters using a Siebel application 1 2 3
Log in to the Siebel application as a Siebel administrator. Navigate to the Administration - Server Configuration screen, Servers, and then the Components view. In the Components list, select XMLP Report Server.

Siebel Reports Guide Version 8.2, Rev. A

47

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

4

Click the Parameters view tab, and perform the following:

a b

For the Maximum Tasks parameter, change the Value on Restart to 100. For the Maximum MT Servers parameter, change the Value on Restart to 2.

Setting Concurrency Parameters Using the Server Manager
Use the following procedure to set the concurrency parameters using the Server Manager (srvrmgr).

To set concurrency parameters using Server Manager
■ Execute the following Server Manager (srvrmgr) commands to increase the MaxTasks parameter to 100 and the MaxMTServers parameter to 2: change param maxtasks=100 for comp xmlpreportserver server XmlpServer change param maxmtservers=2 for comp xmlpreportserver server XmlpServer where: XmlpServer is the name of the Siebel Server.

Related Topics Setting the Report Execution Waiting Period for Reports Setting the Server Request Processor Database Polling Interval for Siebel Reports 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 45 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.

48

Siebel Reports Guide Version 8.2, Rev. A

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

2 3 4

“Enabling Scalable Mode for Siebel Reports” on page 49. “Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports” on page 51. “Increasing EAI HTTP Transport Sleep Time for Siebel Reports” on page 51.

For more information about setting server profile parameters, see Siebel System Administration Guide. NOTE: It is recommended that you not execute reports with large data volumes as an immediate report request. Instead, schedule these reports on the Oracle BI Publisher Server.

Related Topics Setting the Report Execution Waiting Period for Reports Setting the Server Request Processor Database Polling Interval for Siebel Reports Setting Concurrency Parameters for Siebel Reports

Enabling Scalable Mode for Siebel Reports
To optimize Siebel Reports generation performance, you can enable the scalable mode parameter by configuring the Oracle BI Publisher xdo.cfg file in the jre\lib directory. This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes” on page 48 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 2
Navigate to the ORACLE_HOME\xmlp\XMLP\Admin\Configuration directory. 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" <!-- Properties --> <properties> xmlns="http://xmlns.oracle.com/oxp/config/">

Siebel Reports Guide Version 8.2, Rev. A

49

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

<!-- System level properties --> <!-- PLEASE uncomment this property and set it to a valid temp directory path. --> <property name="system-temp-dir">D:\Temp</property> <property name="xslt-scalable">true</property> </properties> <!-- Font setting --> <fonts> <!-- Font setting (for FO to PDF etc...) --> <font family="Arial" style="normal" weight="normal"> <truetype path="/fonts/Arial.ttf" /> </font> <font family="Default" style="normal" weight="normal"> <truetype path="/fonts/ALBANWTJ.ttf" /> </font> <!-- Font substitute setting (for PDFForm filling etc...) --> <font-substitute name="MSGothic"> <truetype path="/fonts/msgothic.ttc" ttcno="0" /> </font-substitute> </fonts> <currency-formats> <currency code="USD" mask="FM9G990D00"/> <currency code="JPY" mask="FMFM9G990"/> <currency code="ILS" mask="FM9G990D00"/> <currency code="EUR" mask="FM9G990D00"/> <currency code="TRK" mask="FM9G990D00"/> </currency-formats> </config> Related Topics Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports

50

Siebel Reports Guide Version 8.2, Rev. A

Administering Siebel Reports ■ Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes 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. A 51 . 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. 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. You can optimize report generation for complex reports by increasing the default sleep time for the EAI HTTP Transport business service. HTTPSleepTime is set to 120000 milliseconds (two minutes). Rev. This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes” on page 48 and is applicable to connected mode. By default. However. typically errors occur only with very large and complex reports. that might take longer than a couple of minutes to generate.cfg file. This step is a task in “Roadmap for Optimizing the Performance of Siebel Reports” on page 45. and in the <Properties></Properties> tag. 3 Save the xdo. This is especially helpful when generating complex reports or against large data sets. then an error occurs as a result of the timeout.2.cfg file. This invokes the PublicReportServiceService Web service on Oracle BI Publisher Server. If the generation of the Oracle BI Publisher report takes over two minutes. NOTE: The path for the Java installation folder varies depending on where you installed JRE. Siebel outbound Web services use the EAI HTTP Transport business service for sending the HTTP request. Siebel Reports Guide Version 8. 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. 2 Open the xdo. 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.

Set the value for HTTPSleepTime accordingly. Compile the SRF. For more information about increasing the Java heap size. To increase EAI HTTP transport sleep time for Siebel Reports 1 2 3 4 5 6 Log in to Siebel Tools. In the Object Explorer. query for XMLP Driver Service. In the Object List Editor. 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. In the Object Explorer. select the Business Service object. For example. and then the HTTPSleepTime Business Service Method Arg. A .cmd file (or equivalent): -Xms512m -Xmx512m NOTE: Different operating systems can have different JVM memory limits.html). select Business Service Method.Administering Siebel Reports ■ About Increasing the Java Heap Size on Oracle BI Publisher Server This task is a step in “Process of Optimizing the Generation Performance of Siebel Reports for Large Data Volumes” on page 48 and is applicable to connected mode. 52 Siebel Reports Guide Version 8.oracle. To avoid a reports failure. specify the following in the oc4j.1. select the GenerateBIPReport method. increase the JVM allocation for the OC4J process. Rev.x available on Oracle Technology Network (http:/ /www. to specify a heap size of 512 megabytes. the Oracle BI Publisher Server OC4J process might consume too much Java Virtual Memory (JVM). Related Topics “Enabling Scalable Mode for Siebel Reports” on page 49 “Configuring a Temporary Directory on the Oracle BI Publisher Server for Siebel Reports” on page 51 About Increasing the Java Heap Size on Oracle BI Publisher Server When running large reports with large data sets.com/technetwork/indexes/documentation/index.2.

Adhere to the following guidelines: ■ Avoid creating a large integration objects that might be shared by many different reports. Deactivate any fields that are not required. It is recommended that you limit the fields in integration objects to only those fields that necessary for report generation. aggregate. 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. Create individual integration objects for each report to improve performance. Large integration objects can also affect performance when rendering the report if the report template includes logic to extract. A 53 .Administering Siebel Reports ■ About Reducing the Size of an Integration Object About Reducing the Size of an Integration Object The number of integration components and their related fields can greatly affect the performance of reports.2. or reference elements in the XML. especially reports that are run on large data sets. be aware that the wizard adds all fields from the business component. When using the EAI Siebel Wizard to create an integration object. Rev. if the integration object contains many fields. ■ Siebel Reports Guide Version 8.

A .2.Administering Siebel Reports ■ About Reducing the Size of an Integration Object 54 Siebel Reports Guide Version 8. Rev.

2. monitor. Siebel Reports Guide Version 8. This chapter does not apply to scheduled reports. This chapter also describes the reports user preferences that you can set at the application level. Rev. A 55 .6 ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Generating Reports This chapter describes how to generate. see Configuring Siebel Open UI. and delete reports in Siebel Business Applications from a user perspective using the Siebel Open UI client and the high-interactivity client. It includes the following topics: Generating Reports in Siebel Business Applications on page 56 Setting Siebel Reports User Preferences at the Application Level on page 57 About Generating Reports for Selected Records on page 57 About Generating Reports Using the Siebel High-Interactivity Client on page 59 Scenario for Generating Reports Using the Siebel High-Interactivity Client on page 60 Generating Reports Using the Siebel High-Interactivity Client on page 61 Example of Generating an Opportunity Report Using the Siebel High-Interactivity Client on page 63 About Generating Reports Using the Siebel Open UI Client on page 64 Scenario for Generating Reports Using the Siebel Open UI Client on page 65 Generating Reports Using the Siebel Open UI Client on page 66 Example of Generating an Opportunity Report Using the Siebel Open UI Client on page 67 Monitoring the Status of Currently Generating Reports on page 68 Viewing Details for Previously Generated Reports on page 69 Deleting Reports on page 70 NOTE: For more information about the Siebel Open UI client. view.

You can access your previously generated reports by clicking the My Reports button in the Generate Report pane. For general information about the Siebel Open UI client. The instructions are grouped under the following high-level topics: ■ ■ “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 “About Generating Reports Using the Siebel Open UI Client” on page 64 Siebel Reports Mode Differences Although you can generate Siebel Reports in either the Siebel Open UI client or the high-interactivity client. 56 Siebel Reports Guide Version 8. The basic functionality for generating reports using these two clients is very similar. For general information about the high-interactivity client. You can override the default settings for the file output type and locale in the Generate Report pane.2. The Reports drop-down list (that shows reports available for a specific view) appears in the Report Name field in the Generate Report pane. however. For this reason. see Siebel Fundamentals for Siebel Open UI. NOTE: Report scheduling and parameterized reports are currently not available in the Siebel Open UI client. there are differences that will impact how you work with reports.Generating Reports ■ Generating Reports in Siebel Business Applications Generating Reports in Siebel Business Applications Siebel Business Applications supports report generation using the Siebel Open UI client and the highinteractivity client. see Siebel System Administration Guide. the user interface differs. You are automatically redirected to the My Reports View in the BI Publisher Reports screen. For more information about using Siebel Reports in high-interactivity clients versus Siebel Open UI clients. a separate set of report generation instructions is provided for each client as needed. In the Siebel Open UI client: ■ ■ ■ ■ The Reports Menu is known as the Generate Report pane. A .1. see Article ID 1499842. Rev.

It is applicable to both the Siebel Open UI client and the highinteractivity client. you can also override the report output file format or formats that were specified in the report layout template by setting user preferences at the application level. You can choose which records you want to generate when you execute a report.S. as long as there is no default language or locale specified in the report layout template. assume the default language for your deployment is English U. Siebel Reports Guide Version 8. NOTE: The default report output file types are determined by the report developer. you can choose to generate your reports in another language. Rev. CAUTION: It is recommended that you select no more than 50 records at a time because doing so might cause report generation to fail. To set Siebel Reports user preferences at the application level 1 2 3 Navigate to the User Preferences screen. For detailed information about how report locale is determined at run time. if you set the Output Type property in user preferences.2. You select multiple records from a list view using the CTRL key. That is. then execute a query and generate a nonselected records report. For more information about report output file types. Similarly. By setting Siebel Reports user preferences at the application level. A 57 . then the Report Parameters view. such as Japanese (JPN) or German (DEU). given that report has been configured to support the selected records feature. Change the Locale and Language properties to the language of your choice. see “Siebel Reports Output File Types” on page 15. It is applicable to both the Siebel Open UI client and the Siebel high-interactivity client.Generating Reports ■ Setting Siebel Reports User Preferences at the Application Level Setting Siebel Reports User Preferences at the Application Level This topic describes how to set user preferences to override default values for report names and output files types and language. see “About Working with Multilingual Reports” on page 40. Change the Output Type property. For example. If you need to specify a large data set for a report. (ENU). Related Topics “Generating Reports in Siebel Business Applications” on page 56 “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 “About Generating Reports Using the Siebel Open UI Client” on page 64 About Generating Reports for Selected Records This topic describes how to generate reports only for specific records. then the user preferences setting is used when you generate your reports. you can generate your reports in any supported locale that you specify.

About Sort Order When Generating Reports If you sort records before executing a report. 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. any query or predefined query you perform from a list view in Siebel Business Applications is the criterion used for report generation. NOTE: The report developer must have specified that a particular report can be generated using the selected records functionality. The selected records become the query record set for the report generation. However. the query record set for the report generation reflects the record set in the detail view. Related Topics “Generating Reports in Siebel Business Applications” on page 56 “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 “About Generating Reports Using the Siebel Open UI Client” on page 64 58 Siebel Reports Guide Version 8. When you drill down on a record from a list view into a detail view. For information. then the user-defined sort order is overridden. the sort order is preserved when the report is generated. see “Defining Report Layout Templates for Selected Records” on page 95. the query context is preserved.2. A .Generating Reports ■ About Generating Reports for Selected Records For nonselected records reports. Rev. if the sort order is configured on the integration object used to generate the report. then these record selections override any user interface or predefined query. Therefore.

see “About Generating Reports Using the Siebel Open UI Client” on page 64. For information about generating reports using the Siebel Open UI client. Rev. A 59 .” Figure 5 shows a sample Reports menu drop-down list.Generating Reports ■ About Generating Reports Using the Siebel High-Interactivity Client About Generating Reports Using the Siebel High-Interactivity Client This topic describes report generation using the Siebel high-interactivity client. “Scheduling Reports. The reports available to you for that view are based on standard Siebel responsibility-based visibility and access granted by others. 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. Figure 5. which displays the names of the reports available for the current view—such as Opportunity List and By Sales 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). It does not apply to the Siebel Open UI client. Sample Reports Menu Drop-Down List Related Topics “Generating Reports in Siebel Business Applications” on page 56 “Scenario for Generating Reports Using the Siebel High-Interactivity Client” on page 60 “Generating Reports Using the Siebel High-Interactivity Client” on page 61 “Example of Generating an Opportunity Report Using the Siebel High-Interactivity Client” on page 63 “Monitoring the Status of Currently Generating Reports” on page 68 “Viewing Details for Previously Generated Reports” on page 69 “Deleting Reports” on page 70 Siebel Reports Guide Version 8. see Chapter 8. You also use the Reports menu to schedule reports in connected mode. For information about scheduling reports.2.

Choosing the Report Output File Type and Monitoring Report Status Next. In this example. the sales representative is prompted to choose a report output file type. where she can either open or save the report. she can choose a report. After she drills down on the Account List report. While generating. the File Download dialog box appears from which she can choose to open the report. They provide a view of her current pipeline and other account-related activities. This scenario describes one example of a sales representative generating reports using the highinteractivity client. a message appears indicating that she must access the report from the My Reports view. A . “Scheduling Reports. see Chapter 8. In this case. she chooses PDF. the report appears. Pipeline Analysis. and then clicks Reports. you choose Schedule Report from the Reports menu instead of selecting a report from the drop-down list. the representative can monitor or view the status of the report and after successful completion. However. depending on your business model. She navigates to the Accounts List view.Generating Reports ■ Scenario for Generating Reports Using the Siebel High-Interactivity Client Scenario for Generating Reports Using the Siebel High-Interactivity Client This topic gives a scenario of how you might generate reports in Siebel Business Applications using the Siebel high-interactivity client. the sales representative decides she wants to take another look at this Account List report.2. the representative chooses a report and the report output type. If she chooses to open the report. and Opportunity Marketing Events Summary. the report appears in the chosen format. she chooses Account List in the BI Publisher section of the Reports menu. the sales representative decides to generate the Account List report. These reports include: Account List. see “Scenario for Generating Reports Using the Siebel Open UI Client” on page 65. which automatically triggers the report to start generating data. if the report takes a while to render. however. Accessing Previously Generated Report After several weeks. For information about scheduling reports. she can monitor the status of the report and eventually access the report when the status shows Success. You might use Siebel Reports differently. After successful completion. or cancel the request. she can access the report immediately or a later time. For a similar scenario using the Siebel Open UI client.” Choosing Reports to Generate A sales representative generates a series of account and opportunity reports periodically. NOTE: The process for scheduling reports is similar. Related Topics “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 60 Siebel Reports Guide Version 8. She accesses the report directly from the My Reports view by drilling down on the report that she wants to see. Rev. NOTE: This topic does not apply to the Siebel Open UI client. save the report. In this case. Today. From the My Reports view. then the report generates and appears in the chosen format. From the resulting Reports menu. performs a query to limit the number of records returned.

NOTE: This topic does not apply to the Siebel Open UI client.2. see “Generating Reports Using the Siebel Open UI Client” on page 66. see “About Working with Multilingual Reports” on page 40. Siebel Reports Guide Version 8. For information about overriding user preferences for report generation. A 61 . Figure 6. see “About Generating Reports Using the Siebel High-Interactivity Client” on page 59.Generating Reports ■ Generating Reports Using the Siebel High-Interactivity Client “Generating Reports Using the Siebel High-Interactivity Client” on page 61 “Example of Generating an Opportunity Report Using the Siebel High-Interactivity Client” on page 63 Generating Reports Using the Siebel High-Interactivity Client You generate reports for the Siebel high-interactivity client using the application views and the Reports menu. Figure 6 shows the tasks for generating Siebel Reports. Rev. Report Generation Using the High-interactivity Client To generate a report using the Siebel high-interactivity client 1 (Optional) Override the default report language and locale by setting user preferences at the application level. For a similar scenario using the Siebel Open UI client. For information about how languages and locale settings are implemented in Siebel Reports.

The report downloads and appears in a browser window in the format you chose in Step 4. you have the option to select more criteria before selecting the report output file type. see “Siebel Reports Output File Types” on page 15. The report output file types are: PDF. Rev. The PPT and MHTML output file types are available only in connected mode. you can choose a different locale rather than accept the defaults. NOTE: The actual report is stored in the Oracle BI Publisher repository. You can save the report to a destination of your choosing. ■ Save the report. ■ ■ Select My BI Publisher Reports. Additionally. a log file is created that the report developers or administrators can use to troubleshoot the problem. If you chose to schedule a report. you designate a report output file type. RTF. A . you can choose a report that you previously generated by drilling down on it from the My Reports view. For more information about troubleshooting reports. you choose to either generate a report or schedule a report. NOTE: Optionally. if this is a parameterized report. and MHTML. and other scheduling criteria from the Schedule a Report dialog box. 6 You can continue to generate or schedule reports in other formats or click Close to end. If you choose to: ■ Generate a report from the BI Publisher listing. For more information about the report output file types. EXCEL. TIP: It is strongly recommended that you perform a query before generating a report. you choose the report name. and then click Reports. 5 If you chose a report from the BI Publisher section or drilled down on a report from the My Reports view. NOTE: If a report encounters errors while generating. see Chapter 12. you can view or monitor the report job in the Scheduled Reports view. “Troubleshooting Siebel Reports. PPT.2. and then Open it for viewing immediately or at a later time. run a query to limit the number of returned records. Schedule a report.” Related Topics “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 “Scenario for Generating Reports Using the Siebel High-Interactivity Client” on page 60 “Example of Generating an Opportunity Report Using the Siebel High-Interactivity Client” on page 63 62 Siebel Reports Guide Version 8. you can choose to: ■ Open the report. Performing a query will limit the number of returned records for the report. HTML. and then click Submit. from the File Download dialog box. 3 4 From the Reports menu.Generating Reports ■ Generating Reports Using the Siebel High-Interactivity Client 2 Navigate to the Siebel application view from which you want to generate a report. the output type.

You might use this feature differently. and then the Opportunities List view. and then click Go. For a similar scenario using the Siebel Open UI client. The By Sales Rep Opportunity report appears in PDF format in a new browser window. In the Select the Report Output Type dialog box. Related Topics “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 “Scenario for Generating Reports Using the Siebel High-Interactivity Client” on page 60 “Generating Reports Using the Siebel High-Interactivity Client” on page 61 “Monitoring the Status of Currently Generating Reports” on page 68 “Viewing Details for Previously Generated Reports” on page 69 “Deleting Reports” on page 70 Siebel Reports Guide Version 8. depending on your business model. A 63 . From the BI Publisher section of the Reports menu.Generating Reports ■ Example of Generating an Opportunity Report Using the Siebel HighInteractivity Client Example of Generating an Opportunity Report Using the Siebel HighInteractivity Client This topic gives one example of generating a report using the Siebel high-interactivity client. or cancel the report. 2 3 4 Run a query to limit the number of records returned. choose PDF. save. TIP: The predefined query for this view shows only your current opportunities. prompting you to open. or cancel the request. from which you can choose to print. If you want to see all of your opportunities. The By Sales Rep report Opportunity appears in a browser window. To generate a By Sales Rep Opportunity report 1 Navigate to the Opportunities screen. and then click Reports. NOTE: This topic does not apply to the Siebel Open UI client.2. select the By Sales Rep report. 5 Click Open. click Query. Rev. My Opportunities. see “Example of Generating an Opportunity Report Using the Siebel Open UI Client” on page 67. This example shows how to generate the By Sales Rep opportunity report in PDF format. and then click Submit. save.

Sample Generate Report Pane Related Topics “Generating Reports in Siebel Business Applications” on page 56 “Scenario for Generating Reports Using the Siebel Open UI Client” on page 65 “Generating Reports Using the Siebel Open UI Client” on page 66 “Example of Generating an Opportunity Report Using the Siebel Open UI Client” on page 67 64 Siebel Reports Guide Version 8. Rev. Figure 7 shows a sample Generate Report pane. From this pane. output type. The reports available to you for that view are based on standard Siebel responsibility-based visibility and access granted by others (the behavior is similar to the drop-down Reports menu in the highinteractivity client).Generating Reports ■ About Generating Reports Using the Siebel Open UI Client About Generating Reports Using the Siebel Open UI Client This topic describes report generation using the Siebel Open UI client. A . you can also override the report name. For information about generating reports using the high-interactivity client. see “About Generating Reports Using the Siebel High-Interactivity Client” on page 59. which provides a drop-down list from which you can choose a report for the current view—such as By Sales Rep and Opportunity List—as well as a link to a user’s own previously generated reports (My Reports). and locale. It does not apply to the highinteractivity client. You use Siebel application views and the Generate Report pane to generate reports. Figure 7.2. The Generate Report pane appears after clicking Reports on the application toolbar while you are in a Siebel view.

In this case. This scenario describes one example of a sales representative generating reports using the Siebel Open UI client. If she chooses to open the report. You might use Siebel Reports differently. the sales representative decides to generate a new Account List report. the representative generates reports for immediate and future use. They provide a view of her current pipeline and other account-related activities. In this example. save the report. she can choose a report from the Report Name drop-down list. the report appears. She navigates to the Accounts view. Optionally. Rev. Accessing Previously Generated Reports After several weeks. she chooses Account List. NOTE: This topic does not apply to the high-interactivity client.Generating Reports ■ Scenario for Generating Reports Using the Siebel Open UI Client Scenario for Generating Reports Using the Siebel Open UI Client This topic gives a scenario of how you might use Siebel Reports in Siebel Business Applications using the Siebel Open UI client. Choosing Reports to Generate A sales representative generates a series of account and opportunity reports periodically. a dialog box appears from which she can choose to open the report. and then clicks Reports. A 65 . Related Topics “About Generating Reports Using the Siebel Open UI Client” on page 64 “Generating Reports Using the Siebel Open UI Client” on page 66 “Example of Generating an Opportunity Report Using the Siebel Open UI Client” on page 67 Siebel Reports Guide Version 8. In this case. depending on your business model. the sales representative decides she wants to take another look at this Account List report. the representative can monitor or view the status of the report and after successful completion. or cancel the request. Today. she can access the report immediately or a later time. From the resulting Generate Report pane. For a similar scenario using the highinteractivity client.2. see “Scenario for Generating Reports Using the Siebel High-Interactivity Client” on page 60. While generating. After she drills down on the Account List report. she can change the name of the report by entering a new name in the Custom Report field or choose to override the default report output file type and locale (as indicated in those fields). These reports include: Account List. performs a query to limit the number of returned records. Pipeline Analysis. she chooses the default values. and Opportunity Marketing Events Summary. She accesses the report directly from the My Reports view by drilling down on the report that she wants to see.

and then click Reports. For information about overriding report user preferences at the application level. 2 Navigate to the Siebel application view from which you want to generate a report. TIP: It is strongly recommended that you perform a query before generating a report. TIP: If a report encounters errors while generating. run a query to limit the number of returned records. NOTE: This topic does not apply to the Siebel high-interactivity client. see “Setting Siebel Reports User Preferences at the Application Level” on page 57.2. To generate reports using the Siebel Open UI client 1 (Optional) Override the default report language and locale by setting user preferences at the application level. (Optional) Type a custom name for the report rather than accept the value in the Report Name field. The reports available to you are based on the screen and view you are using. (Optional) Choose a different locale rather than accept the default value. Field Report Name Custom Name Output Type Report Locale Description Select a report from the drop-down list. see “Generating Reports Using the Siebel High-Interactivity Client” on page 61. see Chapter 12. Performing a query will limit the number of returned records for the report. “Troubleshooting Siebel Reports. Rev. a log file is created that the report developers or administrators can use to troubleshoot the problem. 3 In the Generate Report pane. For a similar scenario using the high-interactivity client. Some fields are described in the following table. (Optional) Choose a different file output type rather than accept the default value. complete the appropriate fields.” 66 Siebel Reports Guide Version 8. For information about how languages and locale settings are implemented in Siebel Reports. NOTE: The field default values are determined by the report developer. For more information about troubleshooting reports. see “About Working with Multilingual Reports” on page 40.Generating Reports ■ Generating Reports Using the Siebel Open UI Client Generating Reports Using the Siebel Open UI Client For the Siebel Open UI client. 4 Click Submit to generate the report. you generate reports using the application views and the Reports pane. A .

Generating Reports ■ Example of Generating an Opportunity Report Using the Siebel Open UI Client

5 6 7

Click My Reports to navigate to the My Reports view (in the BI Publisher Reports screen) to monitor the status of the report or to view it. In the My Reports view, drill down on the report to open or save the file. NOTE: The actual report is stored in the Oracle BI Publisher repository. (Optional) Print the report using the application or browser Print menu as applicable.

Related Topics “About Generating Reports Using the Siebel Open UI Client” on page 64 “Scenario for Generating Reports Using the Siebel Open UI Client” on page 65 “Example of Generating an Opportunity Report Using the Siebel Open UI Client” on page 67

Example of Generating an Opportunity Report Using the Siebel Open UI Client
This topic gives one example of generating a Siebel report using the Siebel Open UI client. You might use this feature differently, depending on your business model. NOTE: This topic does not apply to the high-interactivity client. For a similar scenario using the highinteractivity client, see “Example of Generating an Opportunity Report Using the Siebel HighInteractivity Client” on page 63. This example shows how to generate an opportunity report by sales representative to output in German and PDF format.

To generate a 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 3

Run a query to limit the number of records returned, and then click Reports. From the Generate Report pane, select or enter the following options:
■ ■ ■ ■

Report Name is By Sales Rep Custom Name field is My Opportunities by Sales Rep Output Type is PDF Report Locale is German (DEU)

4 5

Click Submit to generate the report. To monitor the status of the report or to view or print the report, click My Reports. This action takes you directly to the My Reports view in the BI Publisher Reports screen.

6

In the My Reports view, drill down on the report to open or save the file.

Siebel Reports Guide Version 8.2, Rev. A

67

Generating Reports ■ Monitoring the Status of Currently Generating Reports

7

(Optional) Print the report using the application or browser Print menu as applicable.

Related Topics “About Generating Reports Using the Siebel Open UI Client” on page 64 “Scenario for Generating Reports Using the Siebel Open UI Client” on page 65 “Generating Reports Using the Siebel Open UI Client” on page 66

Monitoring the Status of Currently Generating Reports
This topic describes how to monitor the status of currently generating reports. It is applicable to both the Siebel Open UI client and the high-interactivity client. NOTE: This topic is not applicable to scheduled reports. For information about monitoring scheduled reports, see “Monitoring and Viewing Scheduled Reports” on page 104.

To monitor the status of a currently generating report 1 2
Log in to the Siebel application. Navigate to the My Reports view in the BI Publisher Reports screen. TIP: In the Siebel Open UI client, you can alternatively click Reports while in an Siebel view, and then click the My Reports button in the Generate Report pane.

3

In the My Reports list, locate the report that you want to monitor, and then review the Status field for that report as described in the following table. Status In Progress Success Error Description Indicates a report is currently generating. Indicates a report generated successfully. Indicates a report encountered an error while generating. Contact your system administrator to troubleshoot.

NOTE: The status value might take some time to appear.

4

Drill down on the report for more detail. For more information about viewing report details, see “Viewing Details for Previously Generated Reports” on page 69.

Related Topics “Viewing Details for Previously Generated Reports” on page 69

68

Siebel Reports Guide Version 8.2, Rev. A

Generating Reports ■ Viewing Details for Previously Generated Reports

Viewing Details for Previously Generated Reports
This topic describes how to view details for previously generated reports. This topic is applicable to both the Siebel Open UI client and the high-interactivity client. 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 responsibilities 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 104.

To view details for previously generated reports 1
Navigate to the BI Publisher Reports screen, then one of the following Reports views:
■ ■ ■

My Reports My Team’s Reports All Reports

TIP: In the Siebel Open UI client, you can alternatively click Reports while in an Siebel view, and then click the My Reports button in the Generate Report pane.

2 3

In the appropriate reports list, select or query for the report that you want to view. Scroll down to Report Parameters to view the details. Some of the fields are described in the following table. Parameter Bookmark Description 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. Editable field you can use to add more descriptive information or categorization. The start and end times of the report generation. If there is a problem with report generation, an error message appears in this field.

Description Start Time End Time Error Message

Siebel Reports Guide Version 8.2, Rev. A

69

It is applicable to both the Siebel Open UI client and the high-interactivity client.2. and then click Delete. Rev. Shows the query entered when the report was generated.Generating Reports ■ Deleting Reports Parameter File Size Query String Report Access Tags Task Id Description The size of the physical output file in kilobytes. then to one of the following views: ■ ■ ■ My Reports My Team’s Reports All Reports TIP: In the Siebel Open UI client. The value in this field is useful for administrators and debugging. Editable field you can use to add more descriptive information or categorization. The visibility view mode that was used when the report was generated. 2 In the appropriate reports list. To delete a report 1 Navigate to the BI Publisher Reports screen. The task ID is useful when searching log fields to find a specific segment related to a report request. For information about deleting scheduled reports. it is no longer available in the Siebel File System. 70 Siebel Reports Guide Version 8. you can alternatively click Reports while in an Siebel view. The unique task ID for the report generation server request. see “Deleting Scheduled Reports” on page 105. Use this field to allow other Siebel users to share the report output. select a report. You can delete reports that you have personally generated or have been granted access to. View Mode Related Topics “Monitoring the Status of Currently Generating Reports” on page 68 Deleting Reports This topic describes how to delete unwanted reports. NOTE: This topic is not applicable to scheduled reports. A . and then click the My Reports button in the Generate Report pane. After a report is deleted.

For information about the differences. This scenario describes how a sales manager works with a report developer to create a custom opportunity report.” This chapter includes the following topics: ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Scenario for Creating Reports on page 71 About Integration Objects in Siebel Reports on page 72 Using Integration Object Search Specifications for Siebel Reports on page 73 About Reporting Across Multiple Siebel Business Objects on page 74 Workflow for Uploading Report Layout Templates to a Siebel Application on page 76 About Registering and Sharing Report Layout Templates on page 78 About Multiorganizational Report Templates on page 78 Scenario for Report Template Visibility Across Organizations on page 79 Should You Clone an Existing Report or Create Custom Reports? on page 79 About Defining Report Layout Templates for Selected Records on page 80 Process of Creating Custom Reports on page 81 NOTE: The Reports menu as described in this chapter applies only to Siebel high-interactivity clients. It is intended only for those who have report developer or administrator privileges.7 Creating Reports This chapter describes how to create reports. Rev. Scenario for Creating Reports This topic gives a scenario of how you might create reports in Siebel Business Applications. “Scheduling Reports. You might use reports differently. A 71 . and as such. In Siebel Open UI. NOTE: Most users do not typically have access to the administration views in the Siebel application.2. “Generating Reports”and Chapter 8. depending on your business model. are not able to perform the tasks in this chapter. it is known as the Generate Reports pane and the user interface is different. see Chapter 6. Siebel Reports Guide Version 8. For information about reporting from the user perspective. see “About Generating Reports Using the Siebel High-Interactivity Client” on page 59 and “About Generating Reports Using the Siebel Open UI Client” on page 64.

data is transported in the form of an integration message. 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. or employee records. To learn that information. From this view. the report appears in a browser window. A typical business object contains several business components and fields. he starts creating a preliminary opportunity report himself using Oracle Business Intelligence Publisher Add-in for Microsoft Word. In the context of Siebel EAI. and facilitate the integration by exchanging integration data as XML files. Rev. in this context. and forecasted revenues for his sales representatives. Account List. Siebel integration objects are used to define which Siebel data is integrated. For more information about the My Reports view. A message. For more information about: 72 Siebel Reports Guide Version 8. he can monitor the status of the report and eventually access the report when the status shows Success. and allows him to monitor how they are progressing through the sales cycle. and a body that contains one or more instances of data. from which the sales manager can open or save the report. For more information about report output file types. however. for example. In most integrations. When he is satisfied with the report layout template design. Sales Manager Generates the New Sales Report After the reports developer finalizes the custom report. he wants to see a revenue breakdown for the team’s opportunities by probability and sales stage. a message appears indicating that he must access the report from the My Reports view. 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.Creating Reports ■ About Integration Objects in Siebel Reports Sales Manager Generates Daily Sales Reports A sales manager has a team of five sales representatives for the western region of a company. including Opportunity by Sales Rep. Siebel integration object definitions specify the components and which fields to integrate. that no such report is currently available. current-account activities. Every day he generates a series of reports. Typical Siebel integration involves transporting data from an external application to a Siebel deployment. Towards the end of the quarter. if the report takes a while to render. see “Who Can Use Siebel Reports?” on page 14. he wants to know how much potential revenue his team might be able to close for the quarter. 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. the sales manager can choose the report from the Reports menu while in an Opportunity view. see “About Using Siebel Reports” on page 14. He knows. using Siebel EAI and integration objects. and Forecast Analysis Details to get the latest. orders. However. only a subset of this data is necessary for generating reports.2. he hands off the template to the report developer. After choosing a report output type. accounts. These reports are view-based and available from the Reports menu in the Siebel application. typically consists of header data that identifies the message type and structure. A .

The report appears with records filtered by any predefined query. and business component search expressions. Table 5 shows the integration object search specification run-time behavior for Siebel Reports. Keep this behavior in mind when specifying your search specifications. A 73 . 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. 2 N Y Y Y N Siebel Reports Guide Version 8. see “Creating New Integration Objects for Siebel Reports” on page 85. Rev. Integration objects in general. Static means that the search specification expression will override a user interface query or predefined query. applet. Table 5. applet. and business component search expressions. Integration Object Search Specification Run-Time Behavior for Siebel Reports Search Specification UI Query 1 Y Predefined Query N Applet Y Business Component Y IO N Expected Result The report appears with records filtered by the user interface.Creating Reports ■ Using Integration Object Search Specifications for Siebel Reports ■ ■ Adding custom fields to existing integration objects for Siebel reports. Creating new integration objects for Siebel reports. 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.2. see Using Siebel Tools. see “Extending Integration Objects to Add New Fields for Siebel Reports” on page 84.

74 Siebel Reports Guide Version 8. with the integration object search expression appended (overrides the user interface query). the following applies to all scenarios described in Table 5: ■ ■ ■ ■ Position.2.and organizational-based visibility and view mode are automatically preserved. Mobile Web Client functionality is not compromised. see “Extending Integration Objects to Add New Fields for Siebel Reports” on page 84. with the integration search expression appended (overrides the predefined query) 4 N Y Y Y Y Additionally. see “Creating New Integration Objects for Siebel Reports” on page 85. For information about creating new integration objects. The context of the selected records becomes the user interface or predefined query. you create a report based on multiple integration objects. unrelated Siebel business objects without having to build the relationships into a single business object. Rev. if there is no appropriate integration object available. For information about extending integration objects. NOTE: Siebel Business Applications ship with standard integration objects for creating reports. A .Creating Reports ■ About Reporting Across Multiple Siebel Business Objects Table 5. Multilingual behavior does not affect the functionality. To generate reports across multiple business objects. The report appears with records filtered by applet and business component search expressions. The selected records functionality has no affect on query behavior. you can either extend an existing integration object or create new integration objects. About Reporting Across Multiple Siebel Business Objects Siebel Reports provides the ability to generate reports across multiple. Integration Object Search Specification Run-Time Behavior for Siebel Reports Search Specification UI Query 3 Y Predefined Query N Applet Y Business Component Y IO Y Expected Result The report appears with records filtered by applet and business component search expressions. However.

The secondary integration objects are passed according to the expression provided in the object’s search specification. For information about adding multiple integration objects to reports. ■ If no search specification value is entered for nonprimary integration objects. queries are not passed from the user interface.2. A 75 . the integration object returns all data from the relevant business components. NOTE: Position-based visibility is automatically applied. For more information about the report template in the Integration Objects list. For this reason. see “Registering Report Layout Templates” on page 89. An example of a valid search specification is: ‘Account’. At run time. the query from the current view in the Siebel application is captured and passed to the primary integration object. For more information about nonprimary integration objects. see “Adding Multiple Integration Objects to a Report” on page 93. or the expression is incorrect. ■ Siebel Reports Guide Version 8. Rev. and also has a negative impact on performance. nonprimary integration objects must have a valid search specification value. This omission returns potentially unwanted data.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 integration objects other than the primary (sometimes referred to as secondary integration objects) that are associated with a report. However. see “Adding Multiple Integration Objects to a Report” on page 93. a valid search specification value is required to filter the data for nonprimary integration objects.Creating Reports ■ About Reporting Across Multiple Siebel Business Objects 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.

How the Layout Template and Translation Files Are Uploaded from Oracle Business Intelligence Publisher Add-in for Microsoft Word to Generate Reports 76 Siebel Reports Guide Version 8.2. Rev. Figure 8 shows how the uploading of these files differs depending on the type of connection mode (connected or disconnected). A .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. the report layout template and translation files must be uploaded to the Siebel application before you can generate reports. After a report layout template is created using Oracle Business Intelligence Publisher Add-in for Microsoft Word. Figure 8.

XSL is generated at run time by the Oracle BI Publisher Server. the RTF and XLIFF files are stored in the Oracle BI Publisher repository by way of the PublicReportServiceService Web service. see “Registering Report Layout Templates” on page 89. the report templates and XLIFF files are stored in the Siebel client installation folder (that is. The RTF and XLIFF files are uploaded and an XDO report definition file is created when the reports are generating. ❏ Before moving to the Oracle BI Publisher repository.2. For disconnected mode. 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.) NOTE: The Upload Files button is disabled (grayed out) in disconnected mode. Siebel Reports Guide Version 8. the layout template (RTF) and XLIFF files are attached to the report during the registration of the layout template.Creating Reports ■ Workflow for Uploading Report Layout Templates to a Siebel Application Figure 8 illustrates the following: 1 From the report template views (Reports . the upload service is not applicable. see “Siebel Reports Architecture and Workflow for Generating Reports in Connected Mode” on page 20.Custom Templates or Reports . For more information about uploading from Oracle Business Intelligence Publisher Add-in for Microsoft Word. You must click Upload Files in the report template views in the Siebel application. see “Siebel Reports Architecture and Workflow for Generating Reports in Disconnected Mode” on page 22. 2 3 For connected mode. SIEBEL_ROOT_CLIENT\xmlp\templates and SIEBEL_ROOT_CLIENT\xmlp\XLIFF. All files (RTF. you must click Generate XLIFF to create XSL. To upload the report to the Oracle BI Publisher repository. (Whereas in connected mode.Standard Templates). b In disconnected mode. Rev. XLIFF. the RTF report layout template and translation files are uploaded using an upload business service to the Oracle BI Publisher repository as follows: a In connected mode. The report layout template (RTF) and language (XLIFF) files are attached to the report during the registration of the report layout template. For more information about connected mode. the upload service occurs by way of the PublicReportServiceService Web service. respectively). In disconnected mode. and XSL) are local to the Oracle BI Publisher XDO Engine when generating reports after. A 77 . ❏ NOTE: The Generate XLIFF button is disabled (grayed out) in connected mode. For more information about generating reports in disconnected mode.

■ Reports .2.Standard Templates. Only these users can see or execute the custom report templates in the Siebel application. then do not grant access to the relevant template views. This view contains report templates that are filtered by positions. ■ 78 Siebel Reports Guide Version 8. However. users can execute reports if they have access to the relevant views. Users with more than one organization can change their Primary Active Position Organization during a single session. that user sees organization-specific reports where the Active Position Organization equals the organization or organizations defined for a custom template. not based on position-based visibility). These templates are visible within the Siebel application. The All Templates Across Organizations view allows managers and administrators to see the report templates of their subordinates. they can share templates if other users have visibility to the relevant application views. the reports that user can view is different from the original access. After making this change. Otherwise. For more information about shared report layout templates. Users with visibility to the My Templates view can create their own custom report templates. Rev. you might want to limit access to the Reports . For example. 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 is.Standard Templates view only to administrators. NOTE: Standard Siebel responsibilities control which reports views users can access.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. CAUTION: It is strongly recommended that you limit access to standard templates only to administrators. The two views you use for report template registration are: ■ Reports . A .Custom 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. Access to report templates is controlled using position-based visibility. If you want to prevent users from creating their own report templates and executing them from the Siebel application. The templates are based on the standard association of Siebel views. you run the risk of users inadvertently modifying the standard report templates (or other templates that are visible to all users in the enterprise). see “Sharing Report Layout Templates” on page 94.

given his current active position organization is Benelux. A 79 . The following are some situations in which you must create a custom report: ■ When the report requires a new integration object Siebel Reports Guide Version 8.2. Let us consider that the user is the Holland organization. the reports they can see differ depending on their organization settings. Rev. 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. ■ ■ 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. You might use template visibility differently. Custom templates that are explicitly associated to the Holland organization. and his manager is in the Benelux organization. ■ 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. depending on your business model.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. These templates have only a default organization. create a custom report. However. These templates have only a default organization. given his current active position organization is Holland. Benelux is the parent organization of both the Holland and Belgium organizations. A sales representative and his manager have visibility to the same Siebel view. Custom templates that are explicitly associated to the Benelux organization. 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.

Creating Reports ■ About Defining Report Layout Templates for Selected Records ■ When the report requires a new integration component for an existing integration object. If you perform a query on the child applet in a detail view. then run a non-selected records report and execute a query prior to running the report. If you select child records in the child list applet on a detail view. and the record set in the view is reflected in the report output. 80 Siebel Reports Guide Version 8. TIP: You select Multiple records using the CTRL key. 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. and along with the associated parent record. The query record set for the report generation reflects the record set in the detail view. NOTE: This functionality also applies to predefined queries. the query context is preserved. then the child applet query is appended to the current query. If you perform a query in the parent form applet on a detail view. For more information about using selected records. 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. you create a new report for a view that belongs to the same business object. 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. and by default. CAUTION: It is recommended that you select no more than 50 records at a time because doing so might cause report generation to fail. see “About Generating Reports for Selected Records” on page 57 and “About Defining Report Layout Templates for Selected Records” on page 80. then these child records also become selected records. When you drill down.2. then query replaces the record set with a new query. If you need to specify a large data set for a report. For example. Drilldown context is also preserved so that when a user drills down on a record from a list view into a detail view. the parent records selections are based on those records highlighted in the list applet. 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. the parent applet will become the active applet. Rev. the context is preserved. make up the query used for report generation. When you run a report that supports the selected records functionality from a list view. 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. only the parent record and related child records will be the query used for the report generation. A . Therefore.

NOTE: Siebel Business Applications ship with standard integration objects. (Optional) In Siebel Tools by either extending an existing integration object or creating new integration object definitions that execute at run time. 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. and other administrative tasks. A 81 . or you can create custom reports and report layout templates.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. associate reports with Siebel application views. NOTE: For suggestions as to when to modify versus create a report layout template. In the Siebel clients by using the Siebel Reports administration views to upload and register report layout templates. Rev. see “Should You Clone an Existing Report or Create Custom Reports?” on page 79. ■ Siebel Reports Guide Version 8.2. You create new integration objects only when existing integration objects do not suffice.

see Chapter 3. Rev. 82 Siebel Reports Guide Version 8. The roadmap is applicable to both connected and disconnected modes. A .2. Process of Creating Reports Figure 9 illustrates the high-level tasks you perform when creating custom reports: 1 2 (Optional) “Extending Integration Objects to Add New Fields for Siebel Reports” on page 84 (Optional) “Creating New Integration Objects for Siebel Reports” on page 85 NOTE: Create new integration objects only when no appropriate integration object exists. For more information about the connection modes in relation to Siebel Reports.” Figure 9. “Siebel Reports Development Environment.Creating Reports ■ Process of Creating Custom Reports Figure 9 shows the process of creating custom reports.

Select an output file type. (Optional) Select a default locale. see “About the Siebel Reports Architecture” on page 19. Periodically preview the report layout template to verify it appears as designed. and the generate sample XML. 8 (Optional) “Defining Report Layout Templates for Selected Records” on page 95 In this step. 7 (Optional) “Sharing Report Layout Templates” on page 94 In this step. Generate the sample XML data file. 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. save the XML to another location. 4 “Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft Word” on page 88 In this step. in this step the following tasks are performed: a b Select an integration object for the report. You can however.Creating Reports ■ Process of Creating Custom Reports 3 “Generating Sample XML Data Files for Siebel Reports” on page 87 Using the Sample Data File Generation view in the Siebel client. (Optional) “Adding Multiple Integration Objects to a Report” on page 93 In this step. you add new integration objects to a report. you either modify an existing report layout template or create a new one. For more information about the Siebel Reports directory structure. and so on. report access control. Rev. you grant report access to others by adding positions. Assign an integration object. in this step do the following: a b c d e 6 Create a new report. and then save it. 9 “Associating Registered Reports with Siebel Application Views” on page 96 10 (Optional) “Changing the Report Sequence Order in the Reports Menu” on page 96 Using the Association View. Select a report layout template. and then do the following: a b c 5 Assign the Siebel fields in the report layout template. “Registering Report Layout Templates” on page 89 Using the template views (Reports .Custom Templates or Reports . Siebel Reports Guide Version 8. Save the report layout template to RTF. in this step you can define the way reports are ordered or prevent them from appearing in the Reports menu.Standard Templates).2. NOTE: The XML data file is typically saved to the XMLP\DATA directory in the Siebel File System. A 83 .

2 Add a new field to the integration object by doing the following: a b Log in to Siebel Tools. and Length properties from the underlying business component field whose data you want to display in the report. However. In the Primary Integration Object Name column.Standard Templates view). To extend an integration object to add a new field 1 In the Siebel client. For information about creating new integration objects for Siebel reports. identify and make note of the integration object for this report. NOTE: It is recommended that you seek the assistance of a Siebel Tools configurator for integration object modification. Create a new integration component field record and copy the Name. Select the report for which you want to add a new field. c d e Query for the integration object associated with the report. Data Type. then the relevant report template view (either the Reports . A . see “Creating New Integration Objects for Siebel Reports” on page 85. identify the integration object by doing the following: a b c Navigate to the Administration . Set the XML-related properties to construct the XML file when data is extracted.2. Click the View menu. that is. TIP: Integration objects do not appear in the Object Explorer by default. NOTE: Integration objects for reports begin with BIP.Custom Templates view or Reports . remove all spaces and special characters. 84 Siebel Reports Guide Version 8. This topic describes how to extend an existing integration object to add new fields for a report. select and expand Integration Object. Options. and then the Object Explorer tab to add the integration objects to the Object Explorer view. In the Object Explorer. navigate to the Integration Objects List.Creating Reports ■ Process of Creating Custom Reports 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.BI Publisher Reports screen. NOTE: You must follow the convention for naming XML tags. it is not a requirement that you use the ss_ prefix convention. This task is an optional step in “Process of Creating Custom Reports” on page 81. Rev. Expand the Integration Component and Integration Component Field object types to view the existing fields associated with this integration component. It is also recommended that you consider this option before creating new integration objects for your reports. f 3 Deploy the modified integration object by doing the following: a While still in Siebel Tools.

c d e f In the Siebel client. Query for the integration object to verify it was deployed. This task is an optional step in “Process of Creating Custom Reports” on page 81. For example. For information about generating sample data files. Using Siebel Tools. By default. This field contains the user-defined query that was entered when the report was executed. Siebel Reports Guide Version 8. Rev. For more information about the role of integration objects in Siebel Reports. NOTE: This action overrides the object definition in the SRF file. and then select Deploy to Runtime Database. you can use the integration objects to register a report layout template. see Integration Platform Technologies: Siebel Enterprise Application Integration. However. Inbound Web Services view. Navigate to the Administration . Creating New Integration Objects for Siebel Reports Siebel Business Applications ship with preconfigured integration objects that you can use for customizing your reports. It is also recommended that you consider extending an existing integration object to add new fields before creating new integration objects for your reports. A 85 . 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. then the Deployed Integration Objects view. For more information about registering a report layout template. After new integration objects are created and deployed. you might want to create new integration objects. You can display this field value on the report template. Navigate to the Administration . the format of the field might be [Account Status] = “Active”].Web Services screen. make sure that the fields used for dynamic queries in the applet of the master business component are also contained in the integration component. NOTE: When creating custom integration objects for Siebel Reports. given no applicable integration objects are available in the Siebel Repository. a QueryString field is automatically populated in the sample XML and parsed as a field value in the integration object during report execution. see “Extending Integration Objects to Add New Fields for Siebel Reports” on page 84. see “Registering Report Layout Templates” on page 89. see “Generating Sample XML Data Files for Siebel Reports” on page 87. customized queries that you create. you can create new integration objects.2. For information about extending existing integration objects. Dynamic queries are specific. NOTE: It is strongly recommended you seek the assistance of a Siebel Tools developer for integration object creation. Click Clear Cache to update the run-time database.Web Services screen. see “About Integration Objects in Siebel Reports” on page 72.Creating Reports ■ Process of Creating Custom Reports b Right-click the integration object you want to deploy. For more information about working with and deploying integration objects.

then the Inbound Web Services view. select Integration Object. A . This newly created integration object is now available in the Sample Data File Generation view for creating custom reports. see “Generating Sample XML Data Files for Siebel Reports” on page 87. A large amount of fields in an integration component might affect performance. 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. Click Clear Cache to invalidate the integration object and Web services definitions in the run-time database. In the Integration Object list. 86 Siebel Reports Guide Version 8. see Integration Platform Technologies: Siebel Enterprise Application Integration. NOTE: It is recommended that if you use this wizard for creating integration objects. you must add the BIP prefix so that integration objects appear in the Sample Data File Generation view. For information about generating sample data files. (Optional) Generate a new sample data file for the integration object for use when designing your report templates.2. In the Siebel client.Web Services screen. that you deactivate only the required business component fields for the report. BIP. the wizard automatically adds all business component fields in the integration component. right-click the integration object you want to deploy. Typically. you add to an integration component only the fields that are required in the report. For more information about integration objects and deploying an integration object without compiling an SRF. By default.Creating Reports ■ Process of Creating Custom Reports To create a new integration object for Siebel Reports 1 2 Log in to Siebel Tools. navigate to the Administration . and then select Deploy to Runtime Database. Rev. making sure to name the new object definition with the prefix. 3 Deploy the integration object to the run-time database by doing the following: a b c d 4 In the Object Explorer in Siebel Tools. Use the Integration Object Builder wizard to create the new integration object. By default.

BI Publisher Reports screen. For information about extending existing integration objects. 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. Siebel Reports Guide Version 8. If some fields (such as multivalue fields) are not populated. click Generate Sample XML. select Integration Object. export the schema using Siebel Tools (from the Tools menu.2. To generate a sample XML data file for a report 1 2 Navigate to the Administration . see “Creating New Integration Objects for Siebel Reports” on page 85. If this occurs. see Transports and Interfaces: Siebel Enterprise Application Integration. then the Sample Data File Generation view.xml. 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. and then Generate Schema). see “Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft Word” on page 88. For example. An XML file is generated with the name of the integration object followed by . For more information about XML schema generation. All fields are now available for use in the template.Creating Reports ■ Process of Creating Custom Reports Generating Sample XML Data Files for Siebel Reports This topic describes how to generate and save XML files for use in a report. When an XML data file generates successfully.xml. If. For information about creating report layout templates. there is no existing integration object that fits your requirements. and then save the file to the SIEBSRVR_ROOT\XMLP\DATA directory. NOTE: When you generate sample XML data. only a subset of the I/O data is exported into the XML file. In the Sample Data File Generation list. see “Extending Integration Objects to Add New Fields for Siebel Reports” on page 84. you can create new integration objects using Siebel Tools. the file name for the XML file is BIPLiteratureFulfillment. XML data is used to create the report layout templates in RTF format and to generate reports at run time. however. select the integration object for which you want to generate a data file. and by the Oracle BI Publisher XDO Engine in disconnected mode to merge with the report layout template to construct the report. A 87 . if the integration object name is BIPLiteratureFulfillment. You can now create report layout templates based on this XML data.xsd extension. Integration objects are metadata objects in Siebel Business Applications that provide the ability to obtain Siebel application data in XML format. it is used by the Siebel XMLP Report Server component in connected mode. Rev. Rename the file with an . and then load this schema into Microsoft Word using the Oracle BI Publisher menu. 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). This task is a step in “Process of Creating Custom Reports” on page 81. For information about creating new integration objects for reports.

the XML data files reside in the XMLP\DATA directory on which the Siebel Server is running. From the application-level menu in Microsoft Word. Programs. You can choose one of the following: Table. choose Insert. 4 Define the format of the report and the Siebel fields that you want to appear in the report. and then click Next. (Optional) Change the XML data grouping. choose the report format. This task is a step in “Process of Creating Custom Reports” on page 81. 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. and then Load Sample XML Data. Rev. and then BI Publisher Users Guide). 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). A . 88 Siebel Reports Guide Version 8. Data. In the Template Wizard. and then click Next. NOTE: Typically. or Free Form. Coding XSL is out of scope for this documentation. To create a report layout template using Oracle Business Intelligence Publisher Addin for Microsoft Word 1 2 3 Start Microsoft Word. select Oracle BI Publisher. and then Wizard. Form. see Oracle Business Intelligence Publisher User’s Guide. select the XML data file.2. you must manually code the XSL statements and references to the data fields. using the Template Wizard as follows: a b c From the Microsoft Word toolbar. In the Select XML Data window. For detailed information. If you use other RTF-formatted templates for creating your reports.Creating Reports ■ Process of Creating Custom Reports Creating Report Layout Templates Using Oracle Business Intelligence Publisher Add-in for Microsoft Word This topic describes how to create report layout templates for reports using Oracle Business Intelligence Publisher Add-in for Microsoft Word. which is available from the Oracle BI Publisher Desktop program menu (click Start. Table/Form. Oracle BI Publisher Desktop. This procedure provides only quick reference information for creating report layout templates.

Rev. and then click Finish. report layout template files created using Oracle Business Intelligence Publisher Add-in for Microsoft Word. 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. only the features documented in this guide.oracle.Creating Reports ■ Process of Creating Custom Reports d e f g Select the Siebel fields that you want to appear in your report. Save the file in RTF format. 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. 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. that is.html). c d (Optional) Continue to preview different output file formats. must be uploaded.3. but you can register the same report layout template for many reports. Not all features mentioned in the Oracle Business Intelligence Publisher documentation are currently supported in Siebel Reports. To generate reports. open the RTF template file (if not already open). and then click Next. This task is a step in “Process of Creating Custom Reports” on page 81. If you are currently creating a report for which you want to use this report layout template. b From the application-level menu. The report appears in the chosen format with the data substituted. and then click Next. A 89 . select Oracle BI Publisher. Save the report layout template in RTF format. you must register the report layout template in the Siebel application. Preview Template. see “Registering Report Layout Templates” on page 89.1.4 available on Oracle Technology Network (http://www. This topic describes how to upload and register layout templates from the Siebel application for both connection modes. Siebel Reports Guide Version 8. and then choose the output file format. How these files are uploaded differs depending on the connection mode.2. NOTE: Each report can have only one report layout template.com/technetwork/ indexes/documentation/index. Label the Siebel fields as you want them to appear in the new report. If the data is to appear in Table format. whether the Siebel application is in connected or disconnected mode. NOTE: Typically. the template files are stored in SIEBSRVR_ROOT\XMLP\TEMPLATES. decide the grouping and sorting.

NOTE: An error message appears if a report already exists in the Siebel application with the same Report Name value. NOTE: You must leave this command window open while the Oracle BI Publisher Server is running.2.BI Publisher Reports screen. A command window appears.Standard Templates 3 4 In the appropriate templates list. Programs. NOTE: If you are uploading multilingual reports. and XSL files must be made available (by uploading the files to the Oracle BI Publisher XDO Engine) before the reports are generated. 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. This folder has the same name as the report selected and contains the report layout template (RTF).BIPHomeX. navigate to the Administration . see also “Roadmap for Uploading Multilingual Reports to the Siebel Application” on page 42. XLIFF. Register the report layout template for the report by doing the following: a Type a report name and optionally a description. Rev. then one of the following template views: ■ ■ Reports .xdo files.Custom Templates Reports . click New. see “Workflow for Uploading Report Layout Templates to a Siebel Application” on page 76. For more information about uploading report layout templates to the Siebel application. the Oracle BI Publisher Server requires the RTF and XLIFF files in its folder structure.Creating Reports ■ Process of Creating Custom Reports In connected mode. b c Select a report layout template. Choose Start BI Publisher. a new folder structure is created in the Oracle BI Publisher repository. XLIFF. A . including other user’s reports or standard preconfigured reports that ship with Siebel Business Applications. When associating an RTF or ZIP file with a report. When the upload is successful. Select an output type. the report is not generated. the RTF. The Oracle BI Publisher Server creates the XSL file during run time. If the files are not available. and . and then Oracle . 2 In the Siebel application. a b Click Start. 90 Siebel Reports Guide Version 8. In disconnected mode.

Creating Reports ■ Process of Creating Custom Reports d e (Optional) Select an existing XLIFF file. there is no start date. if you choose an end date. The primary integration object for the report. Locale is the language and locale combination based on the locale configuration in the Siebel application. the report no longer appears in the Reports menu. see Siebel Global Deployment Guide. Rev. Conversely. which can be one of the following: PDF. Default Locale The default locale for the template. After the end date passes. field labels. Field Start Date Description A start date and time for the report. the report begins generating in the assigned format. Some of the fields are described in the following table. you can change these values any time. f Fill in the rest of the fields. PPT is applicable only in connected mode. For preconfigured reports that ship with Siebel Business Applications. Instead. the Start Date field automatically populates with the current date and time when the report layout template was registered. and captions that are used for translation purposes. HTML. the Report Output Type dialog box does not appear when the user selects that report in the Reports menu. TIP: The start and end dates determine the period that a report is available for use. Typically. MHTML. XLS. For reports that you create. If you choose a start date. you must also choose an end date. PPT. NOTE: If a report is saved with only one report output type.Custom Templates view to allow for sharing of generated reports. NOTE: The Report Access field is available only in the Reports . RTF. or All. the output type is set to All. you must also choose a start date. XLIFF files contain the strings of the report column. (Optional) Assign a position or positions in the Report Access field. However. This field is read-only and is automatically populated when you select an integration object in the report template Integration Objects subview. By default. End Date Primary Integration Object Name Template An end date for the report.2. NOTE: If you change a report layout template and upload the template to a Siebel client. The RTF report layout template that is used to generate the report. XLIFF Siebel Reports Guide Version 8. this field is NULL. For more information. you must regenerate the report. Templates are stored in the following folder: SIEBSRVR_ROOT\XMLP\TEMPLATES Output Type The format of the generated report. A 91 .

2. see “Defining Report Parameters in the Siebel Application” on page 131. For more information about how to use the selected records feature. Fill in the fields in the new record. For information about defining parameters for a report. click New. The fields are described in the following table. Parameters 5 Associate a primary integration object with the report by doing the following: a b In the relevant Integration Objects subview. Rev. 92 Siebel Reports Guide Version 8. Indicates that the report is a parameterized report that accepts runtime parameters.Creating Reports ■ Process of Creating Custom Reports Field Report Access Description Controls access to report templates using positions. Field Integration Object Name Description The integration object that you want to associate with the report layout template. see “Defining Report Layout Templates for Selected Records” on page 95. A . 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. You define the parameters associated with the report in the Parameters list.

For more information about multiple integration objects with regard to Siebel Reports. You must now associate the registered report with the views in which you want the report to be available. Siebel Reports Guide Version 8. unrelated Siebel business objects. For more information on associating reports.Creating Reports ■ Process of Creating Custom Reports Field Search Specification Description A query data filter. The following procedure assumes that you have registered or are in the process of registering a report layout template.2. the value of the search specification might be the following expression: 'IntegrationComponentName'. This field is not required for primary integration objects. NOTE: The first integration object that you associate with a report is automatically indicated as the primary integration object. you must enter a search specification value. This task is an optional step in “Process of Creating Custom Reports” on page 81. c 6 7 (Optional) Click Generate Sample XML for use when designing reports. A 93 . see “Adding and Deleting Locales from Report Templates” on page 43. see “About Reporting Across Multiple Siebel Business Objects” on page 74. When you create a nonprimary integration object for a report. (Optional) Assign a language or languages to the report layout template. Primary Indicates that this integration object is the primary integration object. Rev. For information about assigning languages to report layout templates.Search = "[Last Name] = ""Sh""" NOTE: You can override queries in the user interface by specifying a search specification on the primary integration object. (Optional) If you want to generate reports for multiple business objects. see “About Reporting Across Multiple Siebel Business Objects” on page 74.Search = "[FiledName] = ""ValueToBeTested""" For example: 'Contact'. For example. For more information about reporting across multiple business objects. see “Associating Registered Reports with Siebel Application Views” on page 96. as described in “Registering Report Layout Templates” on page 89. Adding Multiple Integration Objects to a Report This topic describes how to create a Siebel report that reports across multiple. because queries are taken from the Siebel application views. perform the tasks as described in “Adding Multiple Integration Objects to a Report” on page 93. The Primary Integration Object Name field in the template views are automatically populated when you select a primary integration object.

NOTE: Custom integration objects previously created appear as well as the preconfigured integration objects that ship with the Siebel application. you can generate XML for only one integration object. 5 6 Repeat Step 3 and Step 4 of this procedure for each additional integration object that you want to add.Creating Reports ■ Process of Creating Custom Reports To add multiple integration objects to a report 1 Navigate to the Administration . See “Associating Registered Reports with Siebel Application Views” on page 96.2.Custom Templates view.BI Publisher Reports screen. but in the Sample Data File Generation view. In the Integration Objects subview.Standard Template 2 3 In the relevant report template view. you must now associate the registered report with a Siebel application view. select a report (if not already selected). and then one of the following views: ■ ■ Reports .Custom Templates Reports . The fields are described in Step 5 in “Registering Report Layout Templates” on page 89. 4 Fill in the fields in the new record. This Primary field is automatically indicated when associating an integration object with a report for the first time.Custom Templates view to allow for sharing of generated reports based on position. The Report Access field on the report record controls access to the report templates that are executable. One XML data file is generated for the multiple integration objects. After a user is granted access to the report template. One of the integration objects is indicated as primary.BI Publisher Reports screen. Rev. NOTE: This step is similar to what occurs in “Generating Sample XML Data Files for Siebel Reports” on page 87. click New. NOTE: The Report Access field is available only in the Reports . then the Reports . Sharing Report Layout Templates Siebel Business Applications allow you to share report layout templates. To share a report layout template 1 Navigate to the Administration . Click Generate Sample XML. This task is an optional step in “Process of Creating Custom Reports” on page 81. If you are currently creating a report. A . the template appears in the Reports menu when a user navigates to the relevant view. you can define the visibility of the report template for use by others using the Templates views. 94 Siebel Reports Guide Version 8. If a report template is registered in the Siebel application.

The report is generated.BI Publisher Reports screen. custom templates belong to the default organization. see “Registering Report Layout Templates” on page 89. you might need to perform additional Siebel Tools configuration. 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. select the positions that you want to grant access to the report. see 1180903. This task is an optional step in “Process of Creating Custom Reports” on page 81. This feature applies to any level of hierarchy visible in the view. In the Position dialog box. To define a report layout template for a selected record 1 In the Siebel application. Click New to register a new report. Rev. A 95 . select the report for which you want to enable the single or multiselect feature. NOTE: By default. and then click Add. navigate to the Administration . using the selected records in the context of the application view. NOTE: You can select multiple positions by using the CTRL key. this feature is applicable to parent-child views and parent-child-grandchild views. and then click Add.Standard Templates Reports .Custom Templates 2 In the appropriate templates list.1 (Article ID) on My Oracle Support. For information about registering a new report. Select the organizations that you want to grant access to the report. For instructions. You select multiple records using the shift or control keys.Creating Reports ■ Process of Creating Custom Reports 2 Perform one of the following: ■ ■ Select or query for an existing report. and then click the Selected Records field. a b Click the Organizations field to display the Organizations dialog box. then one of the following template views: ■ ■ Reports . 3 Grant access to the report by doing the following: a b Click the Report Access field to display the Position dialog box. NOTE: If you encounter problems using this feature. Siebel Reports Guide Version 8. 4 You can define multiorganizational templates by adding a specific organization or organizations to the report template in the organizations multi-value group (MVG).2. that is.

2. 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). you associate the report with one or more Siebel application views. do the following: a b c Choose a report name and optionally a description. 5 Test the newly created report by generating it. The Siebel application calculates the order. For information about generating reports. In the Views list. This setting is the default. the report does not appear in the Reports menu. click Add.” NOTE: If a report encounters errors while generating. The sort order is calculated with the lowest value appearing higher in the list of reports. see Chapter 12. according to the report name). a log file is created that report developers and administrators can use to troubleshoot the problem. 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. For more information about troubleshooting reports. the report is generated using the standard sort order (that is. “Generating Reports. select a view with which you want to associate a report. 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. Rev. then the View Association view. see Chapter 6. If the field value is blank or NULL. “Troubleshooting Siebel Reports. 96 Siebel Reports Guide Version 8.Creating Reports ■ Process of Creating Custom Reports Associating Registered Reports with Siebel Application Views After registering a report. The context-sensitive report appears in the Reports menu only in the views that are associated with the report. In the Reports List subview. To associate a registered report with a Siebel application view 1 2 3 4 Navigate to the Administration . 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. A .BI Publisher Reports screen. (Optional) Assign a sequence number. This task is a step in “Process of Creating Custom Reports” on page 81.” Changing the Report Sequence Order in the Reports Menu This task is an optional step in “Process of Creating Custom Reports” on page 81. Click OK. In the Views dialog box.

numeric-business component field. In the Report List. If two or more records have the same sequence value. A 97 . use the sequence field to assign a sequence to some or all of the reports. see Configuring Siebel Business Applications. the records are sorted by name. Siebel Reports Guide Version 8. Rev.2. TIP: Because the Sequence field is a standard.Creating Reports ■ Process of Creating Custom Reports ■ ■ Reports with a positive integer sequence value are sorted by the sequence value and ordered before any report with a NULL sequence value. then the View Association view.BI Publisher Reports screen. For more information about configuring business components. you can add your own business logic for how reports appear in the application. To change the report sequence order in the Reports menu 1 2 3 Navigate to the Administration . Select the view for which you want to define the report order.

A .Creating Reports ■ Process of Creating Custom Reports 98 Siebel Reports Guide Version 8. Rev.2.

About Scheduled Reports You schedule reports using the Schedule Report menu item from the Reports menu.8 ■ ■ ■ ■ ■ ■ Scheduling Reports This chapter describes how to schedule reports in Siebel Business Applications from a user perspective using Siebel high-interactivity clients.2. Rev. It includes the following topics: About Scheduled Reports on page 99 Scheduling Reports on page 100 Example of Scheduling an Opportunity Report on page 103 Monitoring and Viewing Scheduled Reports on page 104 Suspending and Resuming Scheduled Reports on page 104 Deleting Scheduled Reports on page 105 NOTE: Report scheduling is not supported in Siebel Open UI for Siebel CRM version 8. you can monitor and view the report using the Scheduled Reports view. 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. The Siebel application and Oracle BI Publisher exchange data by way of a Web service to produce the report. see “Monitoring and Viewing Scheduled Reports” on page 104. The Scheduled Reports view is an Oracle BI Publisher Web page that is embedded in the Siebel application user interface.2. For more information about report scheduling in connected mode.2. For more information about using the Schedule Reports view. and whether the report generates with a recurring frequency). Related Topics “Scheduling Reports” on page 100 “Example of Scheduling an Opportunity Report” on page 103 “Monitoring and Viewing Scheduled Reports” on page 104 “Suspending and Resuming Scheduled Reports” on page 104 “Deleting Scheduled Reports” on page 105 Siebel Reports Guide Version 8. NOTE: Report scheduling requires the Siebel Web Client in connected mode. how often you want the report to generate.2. After a report job is scheduled. A 99 . see “Workflow for Generating Reports in Connected Mode” on page 20.

Report scheduling is available only in connected mode. For information about parameterized reports. select Schedule Report. Ask your administrator to grant you the XMLP_SCHEDULER responsibility. 100 Siebel Reports Guide Version 8. you might not have the appropriate access controls assigned. CAUTION: If you are unable to schedule reports. For more information about the connection modes in relation to Siebel Reports. see Chapter 11. NOTE: You cannot schedule parameterized reports. “Parameterized Reports. A scheduling dialog box appears. see “About the Siebel Reports Architecture” on page 19. From the Reports menu. you can schedule reports using various criteria.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. A . and click Reports. Rev. If you have been granted scheduling privileges.2.” To schedule a report 1 2 Navigate to the Siebel application view from which you want to schedule a report.

Monthly. and time zone are based on the Oracle BI Publisher Server. By default. and a start and end date. The date and time the report generates when you choose the run once frequency. Output Type Report Locale Frequency The output file format for the report. Only one time. you must enter the exact date and time to run the report. By default. If checked. Some fields are described in the following table. or Run Monthly. A 10 1 . NOTE: Any descriptive text for the job name is acceptable. the date. the day (or range of days) to run. If you choose to run the report: ■ ■ ■ ■ Immediately. or monthly frequencies. this field is checked. The recurrence of the report. see “Siebel Reports Output File Types” on page 15. Daily or weekly. If checked. See also Run Time below. The locale for the report. and then click Schedule. this field is checked. for search purposes. Siebel Reports Guide Version 8. this field is not checked. Choices are: Run Immediately. Rev. the output of the job is viewable by all users. Run Once. specify the run time for the selected day (or days). you must enter the day (or days) of the week. the job is triggered as soon as you click Schedule. NOTE: For a run once frequency. Enter a name for the job you are scheduling. the job name does not have to be unique. time is converted to UTC (Coordinated Universal Time). The time the report generates when you choose a daily/weekly or monthly frequency.2. the output of the job is saved and is viewable in the Scheduled Reports view. weekly. the XML data of the job is saved and is viewable in the Scheduled Reports view. you must enter the month (or months). time. By default. and a start and end date. However. For daily. Run Daily/Weekly.Scheduling Reports ■ Scheduling Reports 3 Enter the schedule criteria for the report. you might want to adopt a naming convention. For information about the available output file types. Public Save Data Save Output Run Date Run Time If checked. Field Report Name Job Name Description The report you want to schedule.

b Enter the values.2. Rev. To view or monitor the report.Scheduling Reports ■ Scheduling Reports Field Start Date and End Date Description If a date is set in either of these fields. Related Topics “About Scheduled Reports” on page 99 “Example of Scheduling an Opportunity Report” on page 103 “Monitoring and Viewing Scheduled Reports” on page 104 “Suspending and Resuming Scheduled Reports” on page 104 “Deleting Scheduled Reports” on page 105 102 Siebel Reports Guide Version 8. 4 (Optional) If scheduling a parameterized report. NOTE: The Scheduled Reports view is an embedded Web page from the Oracle BI Publisher Enterprise application. A start and end date are required for the daily/weekly and monthly frequencies. By default. NOTE: For this option to appear. b Drill down on the Job Name for more information. and then click Submit. The day (or days) of the week or date range you want the report to generate when you choose a daily/weekly frequency. A . NOTE: The scheduling dialog box remains open until you close it. the report developer must have indicated the report as a parameterized report in the applicable report template registration view. The default Start Date format is based on the date format of the current user preferences. 5 6 7 (Optional) Schedule another report with different criteria. do the following: a Navigate to the BI Publisher Reports screen. the start date is the date you schedule the report and the end date is NULL. The Parameters dialog box appears. The day (or days) of the week or date range you want the report to generate when you choose a monthly frequency. Click Close to exit the scheduling dialog box. Day(s) Month(s) Date(s) A message appears indicating the report (with Job ID) has been scheduled. enter the run-time parameters by doing the following: a Click Parameter. and then click Back if you want to view additional scheduled reports. then the Scheduled Reports view. then it restricts the dates for which scheduling is active. The month (or months) you want the report to generate when you choose a monthly frequency.

Related Topics “About Scheduled Reports” on page 99 “Scheduling Reports” on page 100 “Monitoring and Viewing Scheduled Reports” on page 104 “Suspending and Resuming Scheduled Reports” on page 104 “Deleting Scheduled Reports” on page 105 Siebel Reports Guide Version 8. Run a query to limit the number of records returned. and then click Reports. You might use this feature differently. For information about monitoring and viewing your scheduled reports. see “Monitoring and Viewing Scheduled Reports” on page 104. In this example. For more information about report scheduling. My Opportunities. A 10 3 . select Schedule Report.m. for a two week period from August 2-15. see “Scheduling Reports” on page 100. From the Reports menu.2. To schedule the By Sales Rep Opportunity report 1 2 3 4 Navigate to the Opportunities screen. In the Schedule a Report dialog box. assume you want the By Sales Rep opportunity report to generate in HTML format each Tuesday and Thursday at 10:15 a. 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. Rev.Scheduling Reports ■ Example of Scheduling an Opportunity Report Example of Scheduling an Opportunity Report This topic gives one example of scheduling a Siebel report. 2009. 5 (Optional) Navigate to the BI Publisher Reports screen. see “Scheduling Reports” on page 100. depending on your business needs. and then the Opportunity List view. then the Scheduled Reports view to monitor the scheduled report.

Rev. you can also suspend. NOTE: The Scheduled Reports view is an embedded Web page from the Oracle BI Publisher Enterprise application. and then click Suspend or Resume. NOTE: The Scheduled Reports view is an embedded Web page from the Oracle BI Publisher Enterprise application. 104 Siebel Reports Guide Version 8. 2 3 Click the Schedules tab. In this view. or delete scheduled reports. Click the History tab to view a history of your report jobs. you can view scheduled jobs and completed job history for reports that you have generated or have been given access to. then the Scheduled Reports view. To suspend or resume a scheduled report 1 Navigate to the BI Publisher Reports screen. To monitor the status of a scheduled report 1 Navigate to the BI Publisher Reports screen.2. resume. then the Scheduled Reports view. For more information. A . see “Suspending and Resuming Scheduled Reports” on page 104 and “Deleting Scheduled Reports” on page 105. Click the checkbox next to the applicable report. you can suspend and resume scheduled reports you have previously generated or have been granted access to. 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.Scheduling Reports ■ Monitoring and Viewing Scheduled Reports Monitoring and Viewing Scheduled Reports Using the Scheduled Reports view. Related Topics “About Scheduled Reports” on page 99 “Scheduling Reports” on page 100 “Example of Scheduling an Opportunity Report” on page 103 “Suspending and Resuming Scheduled Reports” on page 104 “Deleting Scheduled Reports” on page 105 Suspending and Resuming Scheduled Reports Using the Scheduled Reports view.

Only administrators can purge Siebel reports from the Oracle BI Publisher repository. see “Purging Scheduled Reports from the Oracle BI Publisher Server” on page 36. it does not remove the report from the Oracle BI Publisher repository.Scheduling Reports ■ Deleting Scheduled Reports Related Topics “About Scheduled Reports” on page 99 “Scheduling Reports” on page 100 “Example of Scheduling an Opportunity Report” on page 103 “Monitoring and Viewing Scheduled Reports” on page 104 “Deleting Scheduled Reports” on page 105 Deleting Scheduled Reports This topic describes how to delete reports that you have personally scheduled.2. A 10 5 . then the Scheduled Reports view. For more information about purging scheduled reports. To delete scheduled reports 1 2 Navigate to the BI Publisher Reports screen. and then click Delete. Click the checkbox next to the report you want to delete. NOTE: This step removes the report from the report list. For more information about the Scheduled Reports view. see “About Scheduled Reports” on page 99. You use the Scheduled Reports view to delete the scheduled reports that you no longer want. Rev. Related Topics “About Scheduled Reports” on page 99 “Scheduling Reports” on page 100 “Example of Scheduling an Opportunity Report” on page 103 “Monitoring and Viewing Scheduled Reports” on page 104 “Suspending and Resuming Scheduled Reports” on page 104 Siebel Reports Guide Version 8.

A . Rev.Scheduling Reports ■ Deleting Scheduled Reports 106 Siebel Reports Guide Version 8.2.

It is similar to a master-detail view in a Siebel application.All master-detail report.2. rather than for one master record at a time. 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.All report in Siebel Service. followed by a list of activities for that service request. which is a master-detail report. the master-detail reports provide master information for each service request. Figure 10. Example of a Master-Detail Service Request Activity (All) Report In this example. Figure 10 shows an example of a Service Request Activity . Rev. Unlike a master-detail view. For further analysis of the Service Request Activity . to which the master and detail business components have a one-to-many relationship. a master-detail report lists detail records for all master records at the same time. A 10 7 . however. see “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108. Siebel Reports Guide Version 8. Each service request begins on its own page. A master-detail report displays a list of detail business component records for each record in a master business component. in that detail records are displayed for each master record.9 ■ ■ ■ Using Master-Detail Reports This chapter describes master-detail reports as well as how to create a master-detail layout template.

see “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108 and “Creating a Master-Detail Layout Template in Microsoft Word” on page 112. A report with two detail elements is described in “Creating a Master-Detail Layout Template in Microsoft Word” on page 112. You might use the feature differently. opportunities. only the first record is displayed. A . In the All Service Requests across Organizations list. To display all the records in the business address MVF as a detail section. To display all the records from an MVF in the report. When executing a report. 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. The business addresses in the MVF are not directly related to the opportunity. For example. select an account. select Service Request Activity (All). 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. 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. click Reports. Include the Business Address business component under the Opportunity business object. and include the necessary MVF. and service requests. In this case. depending on your business model. the UI context is captured and passed to the primary integration component of the integration object. Navigate to the Service screen. 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 b c Open the Siebel Service application. first create a link between the Business Address business component and the Opportunity business component using Account Id as the source field. then All Service Requests across Organizations view. This example compares the Service Request Activity (All) report and its corresponding layout template.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.2. Rev. For example. and then create an integration object with the Business Address business component under the integration object. Many of the preconfigured reports that ship with Siebel Business Applications are master-detail reports. but they are related to the account that it is associated with it. If a multivalue field (MVF) is included in a report. This information is also valid for indirect MVFs. 108 Siebel Reports Guide Version 8. a list of detail records appears for several business components for each master record. For more information about master-detail reports. and then from the Reports menu. consider the case where the business address (an MVF) of an account associated with an opportunity appears in the report. NOTE: My Service Requests is the default view. the Account Service Profile report provides three lists for each account master record: customer survey responses.

Field Browser. which prevents the Activity section from displaying header information if there are no activities for the service request. Rev.rtf. For more information. The Field Browser dialog box appears. There is a table (list) for each set of child records. and then open srvreqaa. see Figure 10 on page 107.Custom Templates or Reports . There is a condition on the IF statement (<?if:current-group()//ssAction?>) for the Activity section.BI Publisher Reports screen). select Open. NOTE: To identify the layout template associated with a report. There is a for-each loop (over all master records) that includes the parent form and all the child lists. Notice the following features of this template as shown in the following figure: ❏ ❏ ❏ ❏ There is a table (form) for the master record.Using Master-Detail Reports ■ Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template d e Choose a report output type.Standard Templates in the Administration .2. select Tools. 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). b From the Oracle BI Publisher menu. see “Syntax and Description of the Fields for an Example Template” on page 110. The Service Request Activity (All) report appears in the browser window. Siebel Reports Guide Version 8. use the appropriate Template view (either Reports . A 10 9 . In the File Download dialog box. To view this report. and then Show All. which allows you to view and modify the template logic. and then click Submit.

Service Request). A . Syntax If Oracle BI Publisher Syntax and Field Definitions for the Service Request Activity (All) Report Template Oracle BI Publisher Code <?if://ssServiceRequest?> Description An IF condition that checks for service request records. no records are displayed. 110 Siebel Reports Guide Version 8. Rev. Table 6. The start of a group section which iterates for each record in the Service Request data set. 'SHORT_TIME'?> <?end if?> <?ssSeverity?> <?ssDescription?> <?if://ssClosedDate?> <?formatdate:psfn:totext(ssClosedDa te. Field formatting End ssPriority ssCustomerRefNumber ssOwner for-each:current-group() End of if condition Field mappings Start of a group section. "MM/dd/yyyy hh:mm:ss").Using Master-Detail Reports ■ Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template Syntax and Description of the Fields for an Example Template Table 6 provides details of the Oracle BI Publisher syntax and description for the fields defined in the example template. If there are no service request records."yyyy-MM-dd'T'HH:mm:ss". "MM/dd/yyyy hh:mm:ss"). 'SHORT_TIME'?> <?end if?> <?ssPriority?> <?ssCustomerRefNumber?> <?ssOwner?> <?for-each:currentgroup()?> If condition that does not display the ssCreated field if null. "yyyy-MM-dd'T'HH:mm:ss". Field formatting End ssSeverity ssDescription If ssClosedDate End of if condition Field mappings If condition that does not display the ssClosedDate field if null. iterating for each record in the current group (for example. Field mappings for-eachgroup: ssServiceRequest ssSrNumber ssAccount ssStatus If ssCreated <?for-eachgroup:ssServiceRequest. position()?> <?ssSrNumber?> <?ssAccount?> <?ssStatus? <?if://ssCreated?> <?formatdate:psfn:totext(ssCreated.2.

"yyyy-MM-dd'T'HH:mm:ss". do not display the section. If condition that does not display the ssCreated field if null. End You can view additional information about the integration object definition (and related integration components) in Siebel Tools. End if statement for above condition. Siebel Reports Guide Version 8. The end of the if condition End of current-group() repeating group section. Rev. For information about viewing integration object definitions in Siebel Tools.2. End of Service Request group section End if statement for conditional check on Service Request records If condition that prints "No Data Found" at the bottom of the report if there are no records. Syntax If Oracle BI Publisher Syntax and Field Definitions for the Service Request Activity (All) Report Template Oracle BI Publisher Code <?if:current-group()// ssAction?> <?for-each:ssAction?> <?if://ssCreated?> <?formatdate:psfn:totext(ssCreated. A 11 1 . Beginning of the repeating element group for Action. 'SHORT_TIME'?> <?end if?> <?ssCreatedByName?> <?ssOwnedBy?> <?ssType?> <?ssStatus?> <?ssDescription?> <?end for-each?> <?end if?> <?end for-each?> <?split-by-page-break:?> <?end for-each-group?> <?end if?> <?if:not(// ssServiceRequest)?> <?end if?> Description Condition to check for Action records. Field formatting for-each:ssAction If ssCreated End ssCreatedByN ssOwnedBy sssStatussType ssDescription end for-each:ssAction End if end for-each page break end for-each-group: ssServiceRequest End If End of if condition Field mappings End of the repeating element group for Action. see Using Siebel Tools.Using Master-Detail Reports ■ Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template Table 6. Page break after the end of the group section. If there are no records. "MM/dd/yyyy hh:mm:ss").

oracle.2. A . formatting.html). Select the XML file containing the sample data. and then the Advanced tab. click Tools. or by using the Insert menu option from the Oracle BI Publisher Desktop menu.4 available on Oracle Technology Network (http:// www. When creating custom integration objects for Siebel Reports. Repeating Group. Rev. select Data. 112 Siebel Reports Guide Version 8. Select the master data section. Add the relevant titles.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. Creating a Master-Detail Layout Template in Microsoft Word Creating a master-detail report follows the same process as creating a simple report. customized queries that you create. see “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108. For more information about creating master-detail templates. However. and then Load XML Data. Dynamic queries are specific. Using the Oracle BI Publisher Desktop menu. make sure that the fields used for dynamic queries in the applet of the master component are also contained in the integration component.1. Add the Master data section by doing the following: a b Insert a master data section manually. 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. Options.com/technetwork/indexes/documentation/index. and then Descriptive. see “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108 and “Creating a Master-Detail Layout Template in Microsoft Word” on page 112.position()?> c (Optional) If you want to view descriptive text for the inserted sections. and create a new document. make sure that the correct for-each-group and for-each:current-group elements are placed in the template. and add a for-each-group section: ❏ Click Insert. NOTE: This process embeds the for loop within the table and does not replicate the location of the controls in the preconfigured examples. ■ To create a master-detail layout template in Microsoft Word 1 2 3 4 5 Open Microsoft Word. and so on to the document. Build. ❏ Change the expression: <?for-each-group:ssServiceRequest.3. and then save the template in RTF format. In the RTF template. page header and footer.

9 After testing the report. For more information about master-detail reports. Group. Add the additional formatting features and conditions. 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. For information about registering report layout templates. Navigate to Create. Rev. To view the descriptive text for the repeating group sections 1 2 Start Microsoft Word.Using Master-Detail Reports ■ Creating a Master-Detail Layout Template in Microsoft Word 6 Add the Detail data section by doing the following: a b c 7 a b c 8 Select the detail data section.2. Descriptive text allows you to view the Oracle BI Publisher syntax. select Descriptive. Select a page break option. see “About Master-Detail Reports” on page 107 and “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108. register the report layout template in the usual manner. and then in the Foreach form field box. click Insert. A 11 3 . and then click OK. Build. Insert a page break after the final detail section by doing the following: Select the Oracle BI Publisher properties of the entire group. see “Example of Comparing the Service Request Activity (All) Report with its Corresponding Layout Template” on page 108. From the Oracle BI Publisher menu. and then Repeating Group. For more information on adding features. From the Oracle BI Publisher application-level menu. Siebel Reports Guide Version 8. click Options. and then Properties. Select the defaults. see “Registering Report Layout Templates” on page 89.

A .2.Using Master-Detail Reports ■ Creating a Master-Detail Layout Template in Microsoft Word 114 Siebel Reports Guide Version 8. Rev.

This chapter includes the following topics: ■ ■ ■ ■ Requirements for Migrating Reports on page 115 Process of Packaging and Migrating Reports on page 116 Process of Migrating an Integration Object for a Report on page 120 Process of Migrating New Reports after Creating New Integration Objects on page 121 Requirements for Migrating Reports You can use Application Deployment Manager (ADM) to migrate reports from one environment to another. you migrate reports from the development or test environment (source) to the production environment (target). make sure the reports are finalized and ready to migrate. test. For more information about ADM. see Siebel Application Deployment Manager Guide.0 or later). Siebel Reports Guide Version 8. For more information about installing Siebel Servers. c Set up ADM for your particular deployment needs. see Siebel Installation Guide for the operating system you are using. see Siebel Installation Guide for the operating system you are using.2. you are importing data values from a source environment to a target environment. In particular. Before migrating reports from one environment to another. Perform the following in the source environment: a b Install Perl software (version 5. you must have a Siebel Management Server and Siebel Management Agents installed. The tasks in this chapter are performed by the system administrator and are for disconnected mode only. see “Requirements for Migrating Reports” on page 115. perform the following tasks: 1 2 In the source environment. Rev. or production environment to another. Make sure you include the Application Deployment Manager (ADM) component group as part of the Siebel Server installation process. When you migrate reports. For more information on setting up ADM. For information about setting up your environment to use ADM for migrating reports.10 Migrating Reports This chapter describes how to migrate reports from a development. A 11 5 . For example.

held in a predefined package directory. see “Requirements for Migrating Reports” on page 115. repository. Rev. A . you must specify the repository SIF object and the XML file for packaging. 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. and so on. 116 Siebel Reports Guide Version 8. the SIF objects and the XML files are migrated together. such as database. To migrate reports from one environment to another: 1 2 3 4 5 Make sure you have met the necessary requirements for migrating reports.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. “Packaging the Report Files in the Source Environment” on page 116 “Migrating the Report Files to the Target Environment” on page 117 “Packaging Report Database Records in the Source Environment” on page 118 “Migrating Report Database Records to the Target Environment” on page 119 Packaging the Report Files in the Source Environment This topic describes how to package the report files in the source environment. The following procedure assumes that your reports are finalized and available in the source environment. 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. To migrate XML files along with their associated SIF objects. together with a package descriptor file holding details of the package contents. This task is a step in “Process of Packaging and Migrating Reports” on page 116. siebsrvr\XMLP<subdirectory_name> is the Siebel Server folder structure. For information about these requirements. file is the type of file. After the migration of the integration objects is called.2.

TIP: If an error occurs. NOTE: You must specify a path in a shared location. make sure the CLASSPATH variable points to the exact location of the JAR files in the admpkgr. you might have an invalid path to the JAR files. A 11 7 . To migrate the report files to the target environment 1 2 Navigate to the installation folder where the Siebel Management Server is installed. where enterprise is replaced by the enterprise name given by the user at the time of the configuration. Migrating the Report Files to the Target Environment This topic describes how to migrate the report files to the target environment.bat file in the Management Server installation folder. 3 Run the following command to call the deploy. To resolve this error. 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.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. Siebel Reports Guide Version 8. This task is a step in “Process of Packaging and Migrating Reports” on page 116.Migrating Reports ■ Process of Packaging and Migrating Reports a Copy the XML files to the following directory: SharedFolder\PackageName\file\AppServer\XMLP\DATA b Copy the RTF and XSL files to the following directory: SharedFolder\PackageName\file\AppServer\XMLP\TEMPLATES c Copy the XLIFF files to the following directory: SharedFolder\PackageName\file\AppServer\XMLP\enu\xliff 2 Run the following command to generate a descriptor file for the package: admpkgr generate "shared folder\package name" where: SharedFolder\PackageName is the shared folder and package name in which the packages to be migrated reside. Rev.2.

PackageName is the name of the package for which the descriptor was created in Step 2 on page 117. NOTE: It is recommended that you name your report projects with a BIP prefix. see Siebel Application Deployment Manager Guide. This prefix allows you to search for your report projects. create a new project record. This task is a step in “Process of Packaging and Migrating Reports” on page 116. create search expressions for the data types to filter only those items of a data type that match the condition for migration. For descriptions of the projects fields. Save each filter.Current Query integration object 118 Siebel Reports Guide Version 8. if you create a report in the source environment and that report is: ■ ■ Named Test Account List Based on the BIP Accounts . 4 In the Deployment Filter field in the Deployment Project data type list. To package report database records 1 2 3 Navigate to the Application Deployment Manager screen. Packaging Report Database Records in the Source Environment This topic describes how to use Application Deployment Manager (ADM) to package report database records. Rev.Migrating Reports ■ Process of Packaging and Migrating Reports ■ ■ username and password are the username and password account of the Siebel user who is deploying the package. verify that the files you placed in the deployment package (as described in Step 1 on page 116) are available in the appropriate folders. Fill in the project fields as necessary. For example. making sure to check the Export to File field to create the export file. In the Deployment Projects list. 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).2. then the Deployment Projects view. A .

To migrate report database records to the target environment 1 Navigate to the Application Deployment Manager screen. ADM populates the Status field with Enabled and the Publication Date/Time field with the date and time of the report project activation. it might be set as Inactive. 5 Enable the report project by performing the following: a b Navigate to the Deployment Projects view. 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. The Status field of the draft deployment project record appears as Draft.Migrating Reports ■ Process of Packaging and Migrating Reports ■ Associated with the Account List view You enter the following filter information to migrate the data types to the target environment: Data Type BIP Sample Data Generation BIP Report Template Registration BIP View Association BIP Report Template Translations Filter [Name]=' BIP Accounts . then the Deployment Sessions view. In the Deployment Projects list.2. c Click the Enable button to activate the report project. Siebel Reports Guide Version 8. Make sure the Active field for the data type is checked in the Data Type Details view. select the draft deployment.Current Query' [Report Name]=' Test Account List' [Name]=' Account List View' [Report Name]=' Test Account List' NOTE: If the data type of interest is not available. and make sure the Export to File and the Deployment Lock fields are checked. Enter a shared location to store the XML files that contain the database records. Select the newly enabled report project. Rev. A 11 9 . then the Deployment Sessions view. This step allows you to query the reports being migrated to the target environment. 6 Export the reports by performing the following: a b c d Navigate to the Application Deployment Manager screen. Click Deploy.

Rev.Migrating Reports ■ Process of Migrating an Integration Object for a Report 2 3 Click the Deployment Sessions Menu button. enter a label. In the Generate Hot-Fix dialog box. and then the Account List view. In the Deploy from File dialog box. NOTE: The following process assumes you have created a new integration object that has yet to be migrated. A . 120 Siebel Reports Guide Version 8. navigate to the Accounts screen. and then click Import. A directory containing this SIF file is placed in the Tools\ADM directory. enter the file paths from which to migrate the database records by doing the following: a b c Enter the file path for the XML file that contains the Sample Data Generation file. make sure the data was migrated correctly by verifying that the report appears in the Reports menu. right-click the integration object for which you want to create the SIF file. To migrate an integration object for a report. and then click Import. Enter the file path for the XML file that contains the View Association file. Process of Migrating an Integration Object for a Report This topic describes how to migrate integration objects for reports from the source environment. To verify that report migrated correctly. and then click Add to Hot Fix. For example. and then click Export. NOTE: Make sure to specify the shared location where the database records are stored. in Step 4 on page 118 in the “Packaging Report Database Records in the Source Environment” you created a report named Test Account List. In the Object Explorer. Enter the file path for the XML file that contains the Report Template Registration file. and select Deploy from File. For example. Click Reports to verify the Test Account List report appears in the Reports menu.xml 4 In the target environment.2. select Integration Object. In the Integration Object list. and then click Import. you might enter the following shared locations: ■ ■ ■ \\sharedlocation\88-25ZC7_BIP_Sample_Data_Generation.xml \\sharedlocation\88-25ZC7_BIP_View_Association. perform the following tasks: 1 Create and export a SIF file for the integration object by doing the following: a b c d Log in to Siebel Tools.xml \\sharedlocation\88-25ZC7_BIP_Report_Template_Registration.

For more information about generating the command. perform the following: 1 2 3 Perform the procedure in “Process of Migrating an Integration Object for a Report” on page 120. perform the following: a b c Log in to the target environment computer.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. 3 Perform the steps as described in “Packaging the Report Files in the Source Environment” on page 116.BI Publisher Reports screen. Siebel Reports Guide Version 8. To migrate a new report after creating a new integration object.2. A 12 1 . Rev. Copy the database record files in the related package folder along with the SIF file. 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. Generate the XML data file for the report as described in “Generating Sample XML Data Files for Siebel Reports” on page 87. NOTE: If there is no report for this integration object and there are no plans to move a report for this integration object. Make sure the integration object appears in the Sample Data File Generation list. and then migrate them. Navigate to the Administration . 4 Verify that the integration object was moved to the target environment. then the Sample Data File Generation view. see “Packaging the Report Files in the Source Environment” on page 116. you can skip Step 1 on page 116.

2.Migrating Reports ■ Process of Migrating New Reports after Creating New Integration Objects 122 Siebel Reports Guide Version 8. A . Rev.

” This chapter includes the following topics: ■ ■ ■ ■ ■ ■ ■ ■ About Parameterized Reports on page 123 About Report Parameter Types and Attributes on page 124 About Referencing Parameters in the Report Layout Template on page 126 About Defining Report Parameters in the Siebel Application on page 127 About Report Parameter Validation on page 128 Process of Creating Parameterized Reports on page 129 Defining Report Parameters in the Siebel Application on page 131 Example of Generating a Parameterized Report on page 132 NOTE: Parameterized reports are not supported in Siebel Open UI for Siebel CRM version 8. and as such. sort specification. The parameters a user chooses and the parameter values entered are held in memory at run time. Parameterized reports allow you to: ■ ■ Narrow the query. You can schedule parameterized reports. A 12 3 . Rev. It is intended only for those who have report developer or administrator privileges. 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.11 Parameterized Reports This chapter describes parameterized reports and how to create them.2. Siebel Reports Guide Version 8. “Generating Reports”and Chapter 8. For information about reporting from the user perspective. NOTE: Most users do not typically have access to the administration views in the Siebel application.2.2. are not able to perform the tasks in this chapter. see Chapter 6. After entering the parameters and clicking Submit. Additionally. 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.2. parameterized reports are supported in both connected and disconnected mode (from the Mobile Web Client). “Scheduling Reports. the report is executed and the parameter values are removed from memory.

You can amend the parameter values by clicking Parameters again. The types of parameters include: Checkbox. then a Parameters option appears in the Schedule a Report dialog box. see “Defining Report Parameters in the Siebel Application” on page 131. Report Parameter Types Behavior Displays a simple check box Boolean parameter. the parameter values entered are held in memory. For information about defining these parameters and attributes. Text.2. and TextArea. Displays a text box where the user can enter a date value and an associated calendar control which can be invoked using an icon. These definitions are created in the Siebel application and determine the applet control type displayed at run time. Parameter Type Check box Date 124 Siebel Reports Guide Version 8. see 880452. Attributes for each parameter include the custom display name (including custom multilingual translations). When you click Submit. To finalize the schedule report request. and order. A . LOV. For information about which patch to use. and the parameter values entered are passed with the report request.1 (Article ID). Date. Number. Rev. You click Parameters to enter the parameter values from the Parameters dialog box. if a report template accepts run-time parameters. Related Topics “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 “Example of Generating a Parameterized Report” on page 132 About Report Parameter Types and Attributes Parameters and attributes for the report template are defined at design time. A message appears showing that the report is scheduled. Siebel Maintenance Release Guide on My Oracle Support. you must have installed the appropriate Oracle BI Publisher patch level. Label. upon which the parameter values you previously entered appear. Table 7. CAUTION: To use the Parameters option with scheduled reports. DateTime.Parameterized Reports ■ About Report Parameter Types and Attributes When scheduling a parameterized report. required field. click Submit again. LOV name (for LOV type only). default value. The date format is based on the user preferences.

Hierarchical LOVs are not possible. 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. size. Parameter Type LOV Text Number DateTime Displays a text box where the user can enter a string value. or alignment or wrap the Display Value with HTML formatting codes in order to determine the run-time appearance of labels. Displays a text box where the user can enter a numeric value. There is no control type related to this parameter. If the selected picklist is bounded. Related Topics “About Parameterized Reports” on page 123 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 “Example of Generating a Parameterized Report” on page 132 Siebel Reports Guide Version 8. The only applicable property for this parameter type is Display Value and the Order attribute. Report Parameter Types Behavior Displays a picklist where the user selects a value from a list. This parameter type is simple text that you can use as descriptive text for a section separator. The calendar control includes time and time zone options. The date format is based on the user preferences. Label TextArea Displays a text area (with small scrollbar) where the user can enter a large string value. The longest Label property of a Label type parameter is used for the alignment starting position. but if the selected picklist is not bounded. You can define any application list of values (based on Picklist Generic BC). color. then the LOV parameter is not bounded. All other parameter types are then aligned relative to the starting position. The LOV parameter type supports MLOV translation. NOTE: It is not possible to define font face. A 12 5 . Rev. All parameters of type Label align from the left when rendered in the user interface. then the LOV parameter is bounded.Parameterized Reports ■ About Report Parameter Types and Attributes Table 7. The list of values available are those defined in the application list of values. An LOV must exist in the list of application list of values. The number control invokes the standard calculator widget. NOTE: The picklist name chosen from the UI determines whether it is bounded or not.2. Dynamic list of values are not possible. style.

4 available on Oracle Technology Network (http:// www.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. Control the grouping pattern in a table. Render data rows in different colors by defining a user-specified field (such as ACTIVE_STATUS). NOTE: You can also use parameters to filter data in a template. but there is no impact on the report layout controls. Rev. It is more efficient to filter records in the user interface using a query than in the report layout template. TIP: To test that the parameters are passed through correctly. default values were defined in the report layout template). you can verify Oracle BI Publisher received the correct user input. you can display user input directly on the report. see “Defining Report Parameters in the Siebel Application” on page 131. You can select a column name for sorting.3.1. Some examples are: ■ ■ ■ Control the sorting pattern in a table. For information about parameter syntax and usage.com/technetwork/indexes/documentation/index.2. In this manner. 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. A . Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 “Example of Generating a Parameterized Report” on page 132 126 Siebel Reports Guide Version 8.oracle. see about defining parameters topic in the Oracle Business Intelligence Publisher Report Designer's Guide Release 10. You use template parameters within a report layout template to dynamically change the layout of the report using conditions based on the parameter value. For more information about defining default values.html). You can select a column name for the group. but this action is not recommended for performance reasons.

you can associate a language translation by setting a display value. then the parameters appear in the user interface after any other values. such as Today()-7 and conditional value logic (a display of one parameter that depends on another value) are not currently possible. the appropriate validation occurs at run time to check that a user has entered a correct value. must address the appropriate functions for the value to be recognized as an official date value. For each data type. you can reconfigure that value. Rev. then the list becomes too large and impedes the ability to select values correctly. A 12 7 . The minimum and maximum validation (date values entered within a set range) and validation or defaults using date functions. ■ ■ ■ ■ Siebel Reports Guide Version 8. you use parameters to control the layout of a report. certain data types. 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. the threshold at which the scrollbar automatically displays in the Parameters dialog box is 25 parameters. 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. For example. In the Parameter Translations list in the Templates views. you can use the canonical date functions to convert a string value into a date value. ■ ■ Make a parameter required by setting the Required field to Y.2. For information about configuring the threshold. NOTE: It is recommended that you do not copy parameters using the Copy Record functionality. see “Adding Scrollbars to the Parameters Dialog Box” on page 130. ■ The parameter choices a user can select at run time is displayed as a single list. If a large number of parameters is specified. Therefore. By default. such as Date. If the order values are left blank. Using Siebel Tools. especially with smaller screen resolutions. you can: ■ Define parameters using the New button. Parameters must have a unique Order value. 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?> Param2 = <?$Param2?> Param3 = <?$Param3?> The following bullet points provide information about parameter definitions and how to use them: ■ In the Parameters list in the Templates views. 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.Parameterized Reports ■ About Defining Report Parameters in the Siebel Application About Defining Report Parameters in the Siebel Application Typically.

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. it is recommended that you do not use parameters to filter data in a report layout template. By default. Label parameter types are ignored during validation against the report layout template. Rev.2. Number of Parameter Definition Fields 10 5 5 10 5 5 10 Data Type LOV Text Text Area Number Date Date/Time Check box CAUTION: Although possible. If you want to add more parameters of a certain data type than already exist. Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Report Parameter Validation” on page 128 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 “Example of Generating a Parameterized Report” on page 132 About Report Parameter Validation Given the report parameters have been defined.Parameterized Reports ■ About Report Parameter Validation ■ By default. A . you can check for any inconsistencies using the validation feature. Additionally. Doing so can negatively affect performance. 128 Siebel Reports Guide Version 8. there are a set number of parameter definition fields available in the Report Parameters virtual business component. then you can create more fields in the virtual business component. Label parameter types are not. however. the number of parameter definition fields by data type that are provided are described in the following table.

you might have the following definition: <?param@begin: Param1?> NOTE: For this example.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 example. see “About Referencing Parameters in the Report Layout Template” on page 126.2. For information about parameter definitions in report layout templates. see “Defining Report Parameters in the Siebel Application” on page 131. Rev. For information about when to perform parameter validation. perform the following tasks: 1 Create parameter definitions (or make sure the definitions exist) in the report layout template. A 12 9 . 2 3 (Optional) Adding Scrollbars to the Parameters Dialog Box on page 130 “Defining Report Parameters in the Siebel Application” on page 131 Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 Siebel Reports Guide Version 8. 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. Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 “Example of Generating a Parameterized Report” on page 132 Process of Creating Parameterized Reports To create a parameterized report.

If a large number of parameters is specified.2. You can configure a scrollbar to appear on the Parameter dialog box to make the list more usable. select Applet User Prop. which impedes the ability to select values correctly (especially with smaller screen resolutions). A . By default. then the list becomes too large. select Applet.Parameterized Reports ■ Process of Creating Parameterized Reports “Example of Generating a Parameterized Report” on page 132 Adding Scrollbars to the Parameters Dialog Box The parameter choices available for a report at run time appear as a single list. The threshold is used for all parameterized reports and for all users in the application. NOTE: The scrollbar appears when the number of parameters that appear in the UI is greater than or equal to the threshold value. For more information see “About Defining Report Parameters in the Siebel Application” on page 127. 4 Compile the SRF. To configure the parameterized reports threshold for scrollbars to appear 1 2 3 Log in to Siebel Tools with administrator privileges. Rev. In the Object Explorer. you can change that value using Siebel Tools. the threshold value at which the scrollbar automatically appears is 25 parameters. however. and then in the Object List Editor query for Report Parameters Applet. In the Object Explorer. and then set the Display Scrollbar user property to the threshold value that you want. Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Defining Report Parameters in the Siebel Application” on page 131 “Example of Generating a Parameterized Report” on page 132 130 Siebel Reports Guide Version 8.

if you define a parameter with the Name property as Param1. Use this field for LOV parameter types. The order in which parameters appear at run time. A value of Y indicates the parameter is required. and then fill in the applicable fields. LOV. and then check the Parameters field to set it to True.Custom Templates view. The following table describes some of the fields. click New. then the Reports . For a description of each parameter. Number. 4 If there are translations. Field Label Name Order Type Description Descriptive text for the parameter. 3 Scroll down to the Parameters list. This default value appears in the Report Parameter dialog box and is passed to the Oracle BI Publisher Server for report generation. and TextArea. From the applicable Template view. Date.2. For example. The template views you have access to depend on the user’s responsibilities. Label. Use this field to provide the default value for the parameter. NOTE: This flag ensures the parameter applet appears at run time. To define report parameters in the Siebel application 1 2 Navigate to the Administration . If required. The type of parameter. Rev.Parameterized Reports ■ Defining Report Parameters in the Siebel Application 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.BI Publisher Reports screen. select a template. The name of the picklist from which users choose values in the parameter dialog box. This field references the placeholder parameter name in the report layout template. Default Picklist Name Required NOTE: Each parameter name value you define must have a correlating parameter definition in the report layout template. A 13 1 . a value must be entered in the user interface. You can use this field for translations. The name of the parameter. DateTime. Choices are: Checkbox. add the following information for each language: ■ Default Value Siebel Reports Guide Version 8. Text. see “About Report Parameter Types and Attributes” on page 124. then the definition of Param1 must appear in the report layout template.

To generate a parameterized report 1 2 3 Navigate to the application view that the parameterized report is associated with. NOTE: If the report does not have a default output type defined.2. A . Rev. assume you have created a parameterized report and want to generate that report in a specific format. depending on your business needs. Run a query to limit the number of records returned. and then transferred to the Siebel application screen. the Siebel application retrieves the parameters from the parameter definitions for the report template defined in the Siebel application. 132 Siebel Reports Guide Version 8. select the parameter values for the report. Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Example of Generating a Parameterized Report” on page 132 Example of Generating a Parameterized Report This topic gives one example of generating a Siebel report. For more information about generating reports. and then click Submit. In this example. For more information about this feature. see “Generating Reports” on page 55. Select the report from the Reports menu. see “About Report Parameter Validation” on page 128. NOTE: If this report has parameters defined.Parameterized Reports ■ Example of Generating a Parameterized Report ■ Display Name NOTE: Translation fields are multilingual. and then click Submit. 4 From the parameter pop-up applet. The report is generated by the Oracle BI Publisher Server. 5 Click Validate to check for inconsistencies between the template definitions you defined above and the report layout template. you must select the output file type. and then click Submit again. You might use this feature differently.

Parameterized Reports ■ Example of Generating a Parameterized Report Related Topics “About Parameterized Reports” on page 123 “About Report Parameter Types and Attributes” on page 124 “About Referencing Parameters in the Report Layout Template” on page 126 “About Defining Report Parameters in the Siebel Application” on page 127 “About Report Parameter Validation” on page 128 “Process of Creating Parameterized Reports” on page 129 “Adding Scrollbars to the Parameters Dialog Box” on page 130 “Defining Report Parameters in the Siebel Application” on page 131 Siebel Reports Guide Version 8.2. Rev. A 13 3 .

Parameterized Reports ■ Example of Generating a Parameterized Report 134 Siebel Reports Guide Version 8. A . Rev.2.

NOTE: You can adjust the log levels at any time.2. Siebel Reports Guide Version 8. 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. It contains the following topics: ■ ■ ■ ■ ■ ■ ■ Enabling Logging for Siebel Reports in the Siebel Application on page 135 About Enabling Logging for the Oracle BI Publisher Server on page 137 Enabling Debugging on Oracle BI Publisher Server for Siebel Reports on page 137 Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode on page 138 Guidelines for Resolving Class Not Found Errors When Previewing Reports in Microsoft Word on page 139 Resolving Class Not Found Errors When Previewing Reports in Microsoft Word on page 140 Troubleshooting Error Messages for Siebel Reports on page 141 NOTE: Oracle Business Intelligence Publisher (Oracle BI Publisher) for Siebel Business Applications logs all exceptions and debug level information. 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). The reports administrator can use the log files to investigate why the error occurred.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. Rev. To set the log level for the XMLP Report Server component using the Server Manager UI 1 Navigate to the Administration-Server Configuration screen. and then the Components view. 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. Servers. A 13 5 .

In the Component field. see Siebel System Administration Guide. In Events list. 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. run the following command: change evtloglvl ObjMgrBusServiceLog=5 for comp xmlpreportserver 136 Siebel Reports Guide Version 8. For example. Rev. NOTE: The colon and port number are optional if using an optional default port. and then set the log level value to 5. for example. For example. For more information about restarting the Siebel Server. Call Center Object Manager (ENU).Troubleshooting Siebel Reports ■ Enabling Logging for Siebel Reports in the Siebel Application 2 3 4 5 6 7 In the Component field. to get details for a call to a business service. xmlp siebel server name is the name of the server on which the XMLP Report Server component is enabled. 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). Stop and restart the XMLP Report Server and Siebel Application Object Manager server components. A .2. query for XMLP Report Server. password is the password for the administrator. query for XMLP Report Log. query for XMLP Report Log. Click the Component tab. query for your AOM (Application Object Manager). In the Events list. and then set the log level value to 5. and then click the Events view tab. and then click the Events tab. 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. user name is the login name of the administrator.

cfg. 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. To enable debugging on Oracle BI Publisher Server 1 2 3 4 Log in to Oracle BI Publisher Server with administrator privileges. and then click Apply. 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. and then Server Configuration under System Maintenance.html).3. For information about enabling logging for the Oracle BI Publisher Server.4 available on Oracle Technology Network (http:// www. create a new file entitled xdodebug.2.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. Release 10. NOTE: This debugging is in addition to the usual debugging capabilities available in Siebel Business Applications. see the chapter about setting the system maintenance options in Oracle Business Intelligence Publisher Administrator's and Developer's Guide. Change the Debug Level value from Exception to Debug. Click the Admin tab.com/technetwork/indexes/documentation/index.oracle. Rev. Siebel Reports Guide Version 8.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.1. In a text editor. 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. A 13 7 . such as Notepad.

To enable debugging for Siebel Reports in disconnected mode 1 In a text editor such as Notepad. Enabling Debugging for Siebel Reports in Disconnected Mode Use the following procedure to enable debugging for the Oracle BI Publisher XDO Engine. The resulting log files from the report generation will be created at this location. create a new file entitled. A .2. C:\Program Files\Java\jre1.cfg file.cfg. Rev. 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. If an error occurs while generating reports in disconnected mode. Use this log file for troubleshooting.0_07\lib) and make sure that the directory specified by the LogDir parameter exists.log file is created and saved to the path specified in the .6. xdodebug. 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. 138 Siebel Reports Guide Version 8. an xdo.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 %1 in the batch file is an argument to represent a document that is typically opened in Microsoft Word (RTF files).2.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. Rev. see Resolving Class Not Found Errors When Previewing Reports in Microsoft Word on page 140.cfg in the jre\lib installation folder to another computer for backup purposes. To disable debugging for disconnected mode 1 2 On the computer where Oracle’s Siebel Developer Web Client is installed. A 13 9 . this string might appear as follows: set_JAVA_OPTIONS=-Xbootclasspath/a:C:\81DQSSIA\client\classes… ■ To check the syntax. Siebel Reports Guide Version 8. copy the xdo. you might want to disable debugging for the Oracle BI Publisher XDO Engine. 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.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.exe from C:\Program Files to find the path. You must have three distinct lines in your batch file if word wrapping is turned off. Do not use set _JAVA_OPTIONS as a system environment variable because this prevents you from previewing reports in the Siebel client. Check the path to Microsoft Word that the batch file references. turn off word wrapping in the editor you are using so that set_JAVA_OPTIONS is a single line. Remove or rename the xdo. ■ ■ ■ ■ For instructions for resolving. Search for winword.

bat file by doing the following: a b c d Navigate to the template files in your Siebel client environment. Create a MSWordForBIPub.bat file. you create a custom batch file to launch Microsoft Word and load the required template libraries before opening the RTF template. Right-click on a RTF file (or select all) and Select Open With to choose an text editor. To resolve these types of errors.jar. Click Browse to find the . NOTE: In your batch file.jar "C:\Program Files\microsoft office\Office\Winword. It is not necessary to associate . 3 If you want to make sure this batch file is always executed when opening a preconfigured report layout template.C:\81DQSSIA\client\classes\XSLFunctions. Rev. 140 Siebel Reports Guide Version 8.C:\81DQSSIA\client\classes\SiebelCustomXMLP _SIA.jar.bat file containing the following code to set the _JAVA_OPTIONS environment variable before launching Microsoft Word. C:\Siebel\client\XMLP\TEMPLATES) Sort the templates files by Type. (For example.bat batch file and move it to your desktop.jar. replace the explicit drive and folder locations with those on your own computer based on where you installed the Siebel Web Client.jar. echo %1 set _JAVA_OPTIONS=-Xbootclasspath/a: C:\81DQSSIA\client\classes\SiebelXMLP.C:\81DQSSIA\ client\classes\SiebelCustomXMLP. To resolve class not found errors when previewing reports in Microsoft Word 1 2 Navigate to C:\Program Files.C:\81DQSSIA\client\ classes\siebel. and then open it.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.2.doc extensions with this batch file. A . you associate the RTF files with the .exe" %1 TIP: Create a shortcut to the MSWordForBIPub.

To resolve. see “Troubleshooting Errors That Occur Due to Incorrect Configuration File Settings (SBL-DAT-00322)” on page 146. This error occurs when the path settings in the configuration files are incorrect. Table 8. you can go to the desktop shortcut icon and run the shortcut to the . when you double-click a RTF file.2. Rev. (SBL-DAT-00322) Connected and disconnected Connected and disconnected Siebel Reports Guide Version 8. Troubleshooting Error Messages for Siebel Reports Table 8 contains the error messages that you might encounter when using Siebel Reports and the suggested solutions for resolving the errors. 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. To resolve. you see a command prompt window (running the batch file) automatically run at the same time. see “Troubleshooting Error After Clicking Submit to Generate a Report (SBLSRQ-00103)” on page 146.bat file to test the report preview. Connection Mode Connected and disconnected Error Message or Symptom SBL-OMS-00203: Error <?> invoking method "<?>" for Business Service "<?>" "Unable to find definition for component XMLPReportServer(SBLSRQ-00103)" error when I clicked on the Submit button to generate the report." The specialized method 'GetFileToDir' is not supported on Business Component 'Report Template BC' used by Business Object 'Report Administration'.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. NOTE: This workaround automatically associates the RTF file with the batch file. A 14 1 . Alternatively. This associates the selected RTF file or files with the batch file created in Step 2 on page 140. Resolving Siebel Reports Error Messages Description and Solution This error occurs when you fail to upload the template to the Oracle BI Publisher Server. go to Properties for the applicable template and remove the Read-only attribute to avoid run-time errors. Now. The batch file sets an environment variable needed for publishing Oracle BI Publisher reports from within Microsoft Word. This error occurs after clicking Submit to generate a report. To resolve. see “Troubleshooting Errors While Running Siebel Reports (SBL-OMS-00203)” on page 146.

or the required Disable External Reference parameter attribute has not been set to FALSE. Make sure that the Oracle BI Publisher Server path is: $OC4J_PATH\j2ee\home\applications\ xmlpserver\xmlpserver\WEB-INF\lib For Siebel Industry Applications. No data file provided for XLIFF generation.2. "Class name incorrect" error when generating BI Publisher reports This error occurs when Oracle BI Publisher or the JAR files are not loaded.XDOException: XSLT10gR1: Failed Secure Java Extensions check. Disconnected only Reports having custom java class involved are not generating. see “Troubleshooting XLIFF File Errors” on page 147. see “Troubleshooting the CLASSPATH Settings Using Siebel Server Manager” on page 148.xdo.jar. To resolve. Rev.jar Connected only ][java.String][EXCEPTION] oracle. A . Verify that SiebelCustomXMLP.1 (Article ID) on My Oracle Support. set the classpath. To resolve. see the topic on starting and stopping OC4J and Oracle BI Publisher in 1501378. This error appears in the Oracle BI Publisher log file or console when generating a report when the JAR files have not been copied to the Oracle BI Publisher Server. Not applicable 142 Siebel Reports Guide Version 8.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports Table 8. To resolve.apps.jar SiebelXMLP. make sure the following files are in both paths: ■ ■ SiebelCustomXMLP_SIA. Resolving Siebel Reports Error Messages Description and Solution This error occurs when users forget to provide a sample XML data file for generating an XLIFF file. Connection Mode Disconnected only Error Message or Symptom SBL-RPT-50504: Error occurred while saving the record.lang.jar are under SIEBSRVR_ROOT\classes. SiebelXMLP.

Rev. Connected only Generic Error in Compression Routine (SBL-UIF-00227) Verify whether the temp\xmlp directory exists in the Siebel Server root directory (SIEBSRVR_ROOT).Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports Table 8. because the user has not provided the correct User ID and password for the Oracle BI Publisher Server in the XMLP Report Server component parameters.2. increase the HTTPSleepTime method argument for the XMLP Driver Service business service. Make sure that the report name does not contain the following special characters: ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ ■ Forward slash (/) Backslash (\) Double quote (") Single quote (') Tilde (~) Ampersand (&) Asterisk (*) Plus sign (+) Left angle bracket (<) Right angle bracket (>) Percent sign (%) Connected and disconnected PublicReportService::executeCreate Report Failure: due to Report Name contains special characters for report Connected only Siebel Reports Guide Version 8. see “Troubleshooting Oracle BI Publisher Server Login Errors” on page 148. see Siebel System Administration Guide. typically only for very large or complex reports. create one. Resolving Siebel Reports Error Messages Description and Solution This error might occur if the report generation has extended the HTTP Sleep Time. Connection Mode Connected only Error Message or Symptom SBL-EAI-04116 BIP: Server connection is lost Verify the BIP Server Userid and Password. A 14 3 . For information about setting the Siebel File System. To resolve. To resolve. If it does not. This error message appears in the XMLP log file. Also make sure the Siebel File System is set appropriately. (SBL-RPT-50529) or Failed to log into BI Publisher: invalid username or password.

HTML. CreateException: Report definition not found:/SiebelCRMReports/ <Report Name>/<Report Name>. because there is no space between the two tables. see “Troubleshooting Alignment Problems in HTML Output” on page 148. exception. see “Registering Report Layout Templates” on page 89. Connected and disconnected Alignment issue with JPN/PSJ environment in the reports.oracle. and sometimes EXCEL. The PPT output type for Japanese (JPN) is distorted in generated reports.2.xdo".webservice. To resolve. But they look like one single table.PublicReportSer viceService' at port 'PublicReportService' failed with the following explanation: "oracle.xdo. NOTE: There are two tables. Create the font mappings for the Oracle BI Publisher Server to make sure that the HTML output appears correctly. Connected only 144 Siebel Reports Guide Version 8. To resolve. Connection Mode Connected only Error Message or Symptom SBL-EAI-04308: Operation 'runReport' of Web Service 'http:// xmlns.OperationFailedException: PublicReportService:: generateReport failed: due to oracle.xdo.xdo file).apps. For more information about uploading layout templates. A .com/oxp/service/ PublicReportService.servlet. Alignment issues with columns with HTML file output type The problem occurs when the table header row and the data row are composed of two different tables with no space between them. upload the layout template from Oracle BI Publisher using the Report Template Registration view. might generate output with alignment issues. Resolving Siebel Reports Error Messages Description and Solution This error occurs when you execute a report that has missing bits on the Oracle BI Publisher Server (such as the . see “Troubleshooting Japanese Font Errors” on page 148. one for Table Header and one for Data Row.apps.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports Table 8. Rev. To resolve.

To resolve.JAR. To resolve.JAR.xdo.excepti on. The uploadReport method does not support uploading a new version of an existing file. override it. This error occurs while uploading files to Oracle BI Publisher.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports Table 8.JAR.xdo] already exist!".PublicReportSer viceService' at port 'PublicReportService_v11' failed with the following explanation: "oracle.oracle. SiebelCustomXMLP. verify the following: ■ ■ JAVA_HOME variable is set correctly.NoClassDefFoun dError: com/siebel/data/ SiebelPropertySetObjMgrBusService Log Object manager error: ([0] Class name incorrect or does not extend 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.JAR) are copied from the following directory: Connection Mode Not applicable Error Message or Symptom SBL-EAI-05010: Class name incorrect or does not extend SiebelBusinessService : com/siebel/ data/SiebelPropertySet -.com/oxp/service/v11/ PublicReportService.InvalidParametersException: PublicReportService::executeUpload Report Failure: Due to Report with Path [/SiebelCRMReports/Application Activity/Application Activity.JVM Exception:java.2. SBL-EAI-04308: Operation 'uploadReport' of Web Service 'http:/ /xmlns. the administrator must either rename or delete the folder for the existing instance of the report on the Oracle BI Publisher Server. and SiebelCustomXMLP_SIA.lang.webservice. The following JAR files (Siebel. Resolving Siebel Reports Error Messages Description and Solution This error occurs while uploading files to Oracle BI Publisher. XSLFunctions. SiebelXMLP.apps. The JVM SubSystem Name parameter for XMLPReportServer is set to XMLPJvmSubsys. This error indicates that the Oracle BI Publisher Server already has a copy of the file that is currently being uploaded. The Oracle BI Publisher Server stores the report layout templates in: ORACLE_HOME\xmlp\XMLP\Reports\ SiebelCRMReports Not applicable Siebel Reports Guide Version 8. NOTE: If this value is JAVA. A 14 5 . Rev.JAR.

To troubleshoot errors while generating Siebel Reports 1 2 3 Make sure the XMLP Report Server component is enabled. To regenerate and rerun the report 1 2 3 Regenerate the XML data. Rev. If this error happens. 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). 2 Restart the Siebel Server.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports Troubleshooting Errors While Running Siebel Reports (SBL-OMS00203) Use the following procedure if errors occur while generating Siebel Reports (error message SBL-OMS00203). A . For information about enabling this component. see “Enabling Logging for Siebel Reports in the Siebel Application” on page 135 and “Enabling and Disabling Debugging for Siebel Reports in Disconnected Mode” on page 138. For information about performing these tasks.log file to the jre\lib directory. To troubleshoot if an error occurs after clicking Submit to generate a report 1 Enable and synchronize the XMLPReportServer component. you must complete the following task. Increase the XMLP Report Server component log level to 5 to create a more detailed log file. and the generation fails. but you generated it with a different database. see Siebel System Administration Guide. you might encounter an instance where a layout template was registered with one database. Additionally. see Siebel System Administration Guide. Reregister the layout template. Copy the xdodebug. 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).2. 146 Siebel Reports Guide Version 8. For information about restarting the Siebel Server. Regenerate the report.

To troubleshoot for errors when in disconnected mode 1 2 In the application . In Siebel File System field.cfg file. this means that the file system path is not set appropriately.cfg file. Click the Parameters view tab. Restart the Siebel Server. the CLASSPATH separator is a colon (:). like Siebel Sales or Siebel Service). and then query for FileSystemManager. and then add \\<machine name>\fs\att as the value. 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.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports To troubleshoot for errors when in connected mode 1 Make sure Siebel File System path is correct by doing the following: a b c d e 2 3 4 5 6 Navigate to the Administration . Verify that all the required JAR files are included and available in the CLASSPATH. and then click Advanced. then the Sample Data File Generation view. and then the Components view. Verify that the File System component is running. In UNIX. If either browsing the template fails or the drilldown fails. In the [XMLPReports] section of the . If registering the template is successful.Server Configuration screen. Make sure that the fs directory exists in the D: drive and also that it is shared. Rev. search for FileSystem. In Windows. try to register the template. making sure the fs directory is shared. and then click Generate Sample XML. Verify that CLASSPATH is set in the JVMSubSys profile parameter. provide the path as \\<machine name>\fs.BI Reports screen. Servers.2. 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 2 Navigate to the Administration . Siebel Reports Guide Version 8. Verify that the CLASSPATH separator is in the correct format for Windows or UNIX.). Select the integration object associated with the report. you can drill down on the generated XLIFF file. Query for the Callcenter Object Manager (or other application specific Object Manager. A 14 7 . the CLASSPATH separator is a semicolon (.

Click the Parameters view tab. Execute the following command to change the CLASSPATH: change param CLASSPATH=SIEBSRVR_ROOT\classes\Siebel. Troubleshooting Japanese Font Errors Use the following procedure to properly display JPN (Japanese) fonts in Siebel Reports.Server Configuration screen. While still in the Parameters view tab. Rev. Click the Component view tab. Copy the Form fields from the data row in the added row. Delete the previous table that contained the data row. To troubleshoot Oracle BI Publisher Server login errors 1 2 3 4 Navigate to the Administration . query for the BIP Server Password. To fix alignment problems in HTML output 1 2 3 Add a row to the Table Header. To change the CLASSPATH parameter using Siebel Server Manager 1 Log in to the Server Manager command-line interface (srvrmgr program).SIEBSRVR_ROOT\classes\wlfullclient. SIEBSRVR_ROOT\classes\SiebelXMLP. Troubleshooting Alignment Problems in HTML Output Use the following procedure to troubleshoot alignment problems in HTML output.jar. 148 Siebel Reports Guide Version 8. see Siebel System Administration Guide.jar.2. Troubleshooting Oracle BI Publisher Server Login Errors Use the following procedure when Oracle BI Publisher login errors occur. query for BIP Server Login.jar. and then enter (or verify) the correct login information for the Oracle BI Publisher Server. The single table now contains both header and data row. A . then the Servers view. and query for XMLP Report Server. and then enter (or verify) the correct password for the Oracle BI Publisher Server. For information on how to start and use the srvrmgr program.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports Troubleshooting the CLASSPATH Settings Using Siebel Server Manager Use the following procedure to change the CLASSPATH parameter using the Siebel Server Manager utility.

Log in to Oracle BI Publisher Server.ttc.ttc Siebel Reports Guide Version 8.ttc Arial. msgothic. Runtime configuration.2. Navigate to Admin. Launch the Oracle BI Publisher Server URL. Normal. A 14 9 . and then Font Mappings. msgothic. Create the following two font mappings: ■ ■ Arial. Bold.Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports To create font mapping to display Japanese fonts properly 1 Search for msgothic. Enterprise Edition). Rev. and then copy the file to the computer on which the Oracle BI Publisher Server is installed: \Java\jdk\jre\lib\fonts 2 3 4 5 6 Restart OC4J (Oracle Application Server Containers for Java Platform.

2. A .Troubleshooting Siebel Reports ■ Troubleshooting Error Messages for Siebel Reports 150 Siebel Reports Guide Version 8. Rev.

there is no way for the user to pass a query. This mechanism requires user interaction to accomplish reporting business needs. 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). you can define workflow processes to automate the business processes for generating a report with a specific query. and the Oracle BI Publisher Server is necessary to use the Report Business Service report business service methods. or share the report with others. NOTE: Currently. For more information about Siebel Business Process Designer and workflow processes. and print reports automatically without user interaction. This appendix is intended for Siebel configurators. scripting. the Report Business Service business service methods are supported only on runtime events. It consists of the following topics: ■ ■ About the Report Business Service on page 151 Configuring the Report Business Service on page 152 About the Report Business Service Most users are familiar with report generation in the Siebel Business Application views. Siebel Reports Guide Version 8. lets you automate how your organization handles workflow processes. For more information about workflow processes and the Business Process simulator. Because reports are automatically generated when certain business rules are satisfied. These methods are used in scripts or workflow processes to automate reporting-related business processes. see Siebel Business Process Framework: Workflow Guide. For example. Therefore. users can run a query. Siebel Business Process Designer. Siebel Business Process Designer. NOTE: The Reports Business Service report business service methods are executed only in the Siebel Web Client.2. A 15 1 . and then generate a report interactively or schedule a report for later generation. or saving a report in a specific format. see Siebel Business Process Framework: Workflow Guide. an interactive software tool. a user must be logged on to trigger an event that will invoke these methods. the view mode applied on the report executable is used for obtaining data. or emailing a report to a customer. Knowledge of Siebel Tools.13 Report Business Service This chapter describes the Report Business Service and its methods. users can view. In these views. Having an understanding of running the business services is also necessary. Using the Report Business Service business service methods. The report designers can test these workflow processes in the Business Process simulator. Therefore. administrators can generate. Subsequently. share. Rev. print.

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. A . For detailed information about using the Report Business Service and its methods.2. Rev.1 (Article ID) on My Oracle Support. 152 Siebel Reports Guide Version 8. or through scripting. For example.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. see 1425724. you might want to add a button to invoke report generation.

scenario for 60 using the Siebel high-interactivity client 61 using the Siebel high-interactivity client. about 64 using the Siebel Open UI client. described 23 FONTS directory. diagram of 61 using the Siebel Open UI client 66 using the Siebel Open UI client. process of 81 extending integration objects for Siebel Reports 84 process of creating. scenario for 65 workflow for connected mode 20 workflow for generating in disconnected mode 21 C custom reports creating new integration objects for 85 creating. about 53 E error messages. A 15 3 .Index A administering reports 31 G Generate Report pane for Siebel Open UI. example of 63 using the high-interactivity client. about 57 in Siebel Business Applications. diagram of 82 D debugging disabling for Siebel Reports in disconnected mode 139 enabling for Siebel Reports in disconnected mode 138 enabling on Oracle BI Publisher for Siebel Reports 137 deleting scheduled reports 105 deploying reports to the Siebel Web Client from a disconnected client 32 description of 78 directory structure for Siebel Reports DATA directory.2. directory described 23 TEMPLATES directory. described 23 documentation. described 23 REPORTS. described 23 xliff directory. troubleshooting for reports 141 Extensible Markup Language See XML Extensible Stylesheet Language See XSL Extensible Stylesheet Language Transformation See XSLT Extensible Stylesheet Language-Formatting Objects See XSL-FO L locales adding to report layout templates 43 deleting from report layout templates 43 logging for Siebel Reports enabling logging for in the Siebel application 135 setting log levels for using the GUI 135 setting log levels for using the Server Manager Siebel Reports Guide Version 8. example of 67 using the Siebel Open UI client. about 59 using the Siebel high-interactivity client. Rev. about 56 monitoring the status of 68 using a Siebel high-activity client. sample diagram of 64 using to generate reports in Siebel Open UI 64 generating reports for selected records. where to find previous versions of Siebel Reports 29 I integrating Oracle BI Publisher with Siebel Business Applications guidelines for 29 integration objects for Siebel Reports creating new 85 extending to add new fields to a report 84 reducing the size of.

process of 116 packaging database records in the source environment 118 packaging the report files in the source environment 116 requirements for 115 multilingual reports about working with 40 adding and deleting locales from report layout templates 43 designing 41 uploading to the Siebel application. described 124 Date. described 125 LOV. copying fonts for 39 154 Siebel Reports Guide Version 8. described 124 DateTime. described 125 TextArea. described 125 Number. Rev.2. A . about 52 Oracle BI Publisher-Siebel application interaction 26 Oracle Business Intelligence Publisher Addin for Microsoft Word about using with Siebel Reports 16 advantages of using 17 Excel Analyzer feature 18 menu and toolbar. about 78 report execution modes comparison. diagram of 26 report generation. process of 129 example of generating 132 how they are generated 123 purging reports automatically purging from the Siebel File System 35 from the Oracle BI Publisher Server 36 purging scheduled reports 36 O optimization enabling scalable mode for Siebel Reports 49 increasing EAI HTTP transport sleep time for 51 optimizing performance for large data volumes.Index ■ M (srvrmgr) 136 logging for the Oracle BI Publisher Server about enabling 137 M master-detail reports about 107 creating master-detail layout templates in Microsoft Word 112 example of comparing the Service Request Activity (All) report with its corresponding layout template 108 using 107 migrating reports migrating an integration object for a report 120 migrating new reports after creating new integration objects 121 migrating the report files to the target environment 117 moving database records to the target environment 119 packaging and migrating reports. described 125 Label. about 128 parameterized reports about 123 about defining parameters in the report template 126 about referencing parameters in the report layout template 126 creating. example of 17 Template Builder feature 18 Template Viewer feature 18 using to create report layout templates 88 P parameter type Check box. process of 48 setting a temporary directory on the Oracle BI Publisher Server for 51 setting concurrency parameters for 47 setting the report execution wait time for 46 setting the server request processor wait time for 46 Oracle BI Publisher enabling debugging on Oracle WebLogic Server for Siebel Reports 137 R registering report layout templates. roadmap for 42 Oracle BI Publisher repository about 25 changing the location of for Siebel Reports 37 Oracle BI Publisher Server about 24 about installing 16 increasing the Java heap size for. described 125 parameter validation. described 125 Text.

described 24 Siebel Reports Guide Version 8. described 23 file types. scenario for 79 report translation.2. about 64 parameter types and attributes. using to generate reports 66 Siebel Reports about 13 about controlling access to 34 about integration objects for 72 about using 14 administering 31 architecture. example of 67 generating in Siebel Business Applications 56 generating sample XML data files for 87 generating using the Siebel high-interactivity client 61 generating using the Siebel high-interactivity client. described 19 development environment. A 15 5 . example of 63 generating an opportunity report using the Siebel Open UI client. using to generate reports 61 Siebel Open UI client. about 124 registering and sharing report layout templates. workflow for 76 using master-detail reports 107 viewing details for previously generated reports 69 Reports Business Service about 151 configuring 152 Reports menu changing the report sequence order 96 renaming menu items 34 sample diagram of 59 using to generate reports 59 S scenario creating custom reports 71 scheduled reports about 99 adding scrollbars to the Parameters dialog box 130 deleting 105 example of 103 monitoring and viewing 104 procedure for 100 suspending and resuming 104 selected records defining report layout templates for 95 defining report layout templates for. changing in the Reports menu 96 report templates about multiorganizational templates 78 visibility across organizations. about 59 generating using the Siebel high-interactivity client. about 80 sharing report layout templates. about 78 sharing 94 workflow for uploading to a Siebel application 76 report parameters about defining in the Siebel application 127 report sequence order. about 80 diagram for uploading to a Siebel application 76 registering 89 registering and sharing. diagram of 61 generating using the Siebel Open UI client 66 generating using the Siebel Open UI client. about 78 registering report layout templates 89 reporting across multiple Siebel business objects 74 scenario for creating custom 71 setting user preferences for Siebel Reports at the application level 57 troubleshooting 135 uploading report layout templates to a Siebel application.Index ■ S report layout template views 78 report layout templates creating using Oracle BI Publisher Add-in for Microsoft Word 88 defining for selected records 95 defining for selected records. described 19 directory structure. about 78 Siebel application-Oracle BI Publisher interaction 26 Siebel high-interactivity client. about 44 reports about parameterized reports 123 adding multiple integration objects to 93 associating registered reports with application views 96 creating 71 deleting 70 determining the report locale at run time 40 determining whether to modify existing or creating custom 79 generating an opportunity report using a Siebel high-interactivity client. Rev.

Index ■ T overview of 13 report execution in connected mode 27 report execution in disconnected mode 27 report output files types 15 users. described 24 XML (Extensible Markup Language).2. about 25 workflow generating reports in connected mode 20 generating reports in disconnected mode 21 X XLIFF (XML Localization Interchange File Format). described 24 XSL (Extensible Stylesheet Language). described 24 XPath (XML Path Language). described 24 XSL-FO (Extensible Stylesheet LanguageFormatting Objects). described 24 XSLT (Extensible Stylesheet Language Transformation). A . described 14 using integration object search specifications 73 using Oracle Business Intelligence Publisher Add-in for Microsoft Word with 16 workflow for generating reports in connected mode 20 workflow for generating reports in disconnected mode 21 files 141 Oracle BI Publisher run-time errors 142 Oracle BI Publisher Server login errors 143 report definition errors 144 XLIFF errors 142 U uploading files to Oracle BI Publisher error SBL-EAI-04308 145 SBL-EAI-05010 145 user preferences setting at the application level for Siebel Reports 57 setting report parameters to change the default report output type 57 T troubleshooting reports alignment problems in JPN and PSJ environments 144 class name incorrect errors 142 class not found errors when previewing reports in Microsoft Word 140 class not found errors when previewing reports in Microsoft Word. guidelines for 139 column alignment problems in HTML and EXCEL 144 custom Java classes 142 error after clicking Submit to generate a report 141 error due to special character violations 143 error messages for 141 error while uploading files to Oracle BI Publisher 145 errors relating to the Siebel File System or XMLP directory 143 errors while running 141 incorrect path settings in configuration W Web service PublicReportServiceService Web service. described 24 156 Siebel Reports Guide Version 8. Rev.

Sign up to vote on this title
UsefulNot useful