You are on page 1of 452

Data Access Guide

BusinessObjects Enterprise 6.1 Business Intelligence Windows and UNIX

Data Access Guide

Copyright

No part of the computer software or this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying, recording, or by any information storage and retrieval system, without permission in writing from Business Objects S.A. The information in this document is subject to change without notice. If you find any problems with this documentation, please report them to Business Objects S.A. in writing at documentation@businessobjects.com. Business Objects S.A. does not warrant that this document is error free. Copyright Business Objects S.A. 2003. All rights reserved. Printed in France.

Trademarks

The Business Objects logo, WebIntelligence, BusinessQuery, the Business Objects tagline, BusinessObjects, BusinessObjects Broadcast Agent, Rapid Mart, Set Analyzer, Personal Trainer, and Rapid Deployment Template are trademarks or registered trademarks of Business Objects S.A. in the United States and/or other countries. Contains IBM Runtime Environment for AIX(R), Java(TM) 2 Technology Edition Runtime Modules (c) Copyright IBM Corporation 1999, 2000. All Rights Reserved. This product includes code licensed from RSA Security, Inc. Some portions licensed from IBM are available at http://oss.software.ibm.com/icu4j. All other company, product, or brand names mentioned herein, may be the trademarks of their respective owners.

Use restrictions

This software and documentation is commercial computer software under Federal Acquisition regulations, and is provided only under the Restricted Rights of the Federal Acquisition Regulations applicable to commercial computer software provided at private expense. The use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in subdivision (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at 252.2277013. U.S. Patent Numbers 5,555,403, 6,247,008, and 6,578,027. 320-50-610-01

Patents Part Number

Data Access Guide

Contents
Contents Preface Maximizing Your Information Resources 3 7 Information resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Useful addresses at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Part I Creating Connections Chapter 1 Accessing Data with Business Objects Products 17

Connecting to your data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Data Access Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23 WebIntelligence connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Accessing non-RDBMS data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Chapter 2 Creating a Connection to a Database on Windows 29

Creating a connection to access a database on Windows . . . . . . . . . . . . . . 31 Creating connections with Supervisor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 Creating connections with Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Creating connections with BusinessObjects . . . . . . . . . . . . . . . . . . . . . . . . 39 Creating Restrictive connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Logging in using the Business Objects login . . . . . . . . . . . . . . . . . . . . . . . . 44 Configuring the Advanced tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Configuring the Custom tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47 Chapter 3 Creating a Connection to a Database on UNIX 49

Creating connections to databases on UNIX . . . . . . . . . . . . . . . . . . . . . . . . 51

Contents

Data Access Guide

Part II Managing Connections Chapter 4 Chapter 5 Using Predefined Data Access Variables Checking your Connection Configuration 59 65

Using the Check Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67 Part III Configuring Specific Data Access Drivers Chapter 6 IBM DB2 Data Access 73

Connecting to Business Objects products with IBM DB2 . . . . . . . . . . . . . . 75 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76 Configuring the IBM DB2 server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 IBM DB2 datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97 Chapter 7 Informix Data Access 99

Connecting to Business Objects products with Informix . . . . . . . . . . . . . . 101 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Informix datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121 Chapter 8 Microsoft Data Access 123

Connecting to Business Objects products with Microsoft products . . . . . . 125 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126 Stored procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141 Microsoft datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143 Chapter 9 Oracle Data Access 145

Connecting to Business Objects products with Oracle . . . . . . . . . . . . . . . 147 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148 Configuring the Oracle server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169 Oracle datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Contents

Data Access Guide

Chapter 10

Red Brick Data Access

173

Connecting to Business Objects products with Red Brick . . . . . . . . . . . . . 175 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176 Red Brick datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191 Chapter 11 Sybase Data Access 193

Connecting to Business Objects products with Sybase . . . . . . . . . . . . . . . 195 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 196 Sybase datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 215 Chapter 12 Teradata Data Access 217

Connecting to Business Objects products with Teradata . . . . . . . . . . . . . . 219 Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220 Teradata datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237 Part IV Optimizing Data Access Chapter 13 Data Access Parameter File Reference 241

IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244 Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258 Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267 Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278 Red Brick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289 Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299 Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

Contents

Data Access Guide

Chapter 14

Functions

321

Adding a function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323 IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326 Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337 Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342 Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348 Red Brick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359 Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366 Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372 Chapter 15 General Data Access Configuration File Reference 379

IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381 Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387 Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392 Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397 Red Brick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 405 Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409 Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 417 Other parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 423 Chapter 16 WebIntelligence Data Access Configuration File Reference 425

Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427 Common parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437 Parameters supported by all ODBC drivers . . . . . . . . . . . . . . . . . . . . . . . 443 Index 445

Contents

Maximizing Your Information Resources

preface

Data Access Guide

Overview
Information, services, and solutions
The Business Objects business intelligence solution is supported by thousands of pages of documentation, available from the products, on the Internet, on CD, and by extensive online help systems and multimedia. Packed with in-depth technical information, business examples, and advice on troubleshooting and best practices, this comprehensive documentation set provides concrete solutions to your business problems. Business Objects also offers a complete range of support and services to help maximize the return on your business intelligence investment. See in the following sections how Business Objects can help you plan for and successfully meet your specific technical support, education, and consulting requirements.

Data Access Guide

Information resources
Whatever your Business Objects profile, we can help you quickly access the documentation and other information you need.

Where do I start?
Below are a few suggested starting points; there is a summary of useful web addresses on page 14. Documentation Roadmap The Documentation Roadmap references all Business Objects guides and multimedia, and lets you see at a glance what information is available, from where, and in what format. View or download the Business Objects Documentation Roadmap at www.businessobjects.com/services/documentation.htm Documentation from the products You can access electronic documentation at any time from the product you are using. Online help, multimedia, and guides in Adobe PDF format are available from the product Help menus. Documentation on the web The full electronic documentation set is available to customers with a valid maintenance agreement on the Online Customer Support (OCS) website at www.businessobjects.com/services/support.htm Buy printed documentation You can order printed documentation through your local sales office, or from the online Business Objects Documentation Supply Store at www.businessobjects.com/services/documentation.htm Search the Documentation CD Search across the entire documentation set on the Business Objects Documentation CD shipped with our products. This CD brings together the full set of documentation, plus tips, tricks, multimedia tutorials, and demo materials. Order the Documentation CD online, from the Business Objects Documentation Supply Store, or from your local sales office.

Information resources

10

Data Access Guide

Multimedia Are you new to Business Objects? Are you upgrading from a previous release or expanding, for example, from our desktop to our web solution? Try one of our multimedia quick tours or Getting Started tutorials. All are available via the Online Customer Support (OCS) website or on the Documentation CD.

How can I get the most recent documentation?


You can get our most up-to-date documentation via the web. Regularly check the sites listed below for the latest documentation, samples, and tips. Tips & Tricks Open to everyone, this is a regularly updated source of creative solutions to any number of business questions. You can even contribute by sending us your own tips. www.businessobjects.com/forms/tipsandtricks_login.asp Product documentation We regularly update and expand our documentation and multimedia offerings. With a valid maintenance agreement, you can get the latest documentation in seven languages on the Online Customer Support (OCS) website. Developer Suite Online Developer Suite Online provides documentation, samples, and tips to those customers with a valid maintenance agreement and a Developer Suite license via the Online Customer Support (OCS) website.

Send us your feedback


Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: documentation@businessobjects.com
NOTE

If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: www.businessobjects.com/services/support.htm

Data Access Guide

11

Services
A global network of Business Objects technology experts provides customer support, education, and consulting to ensure maximum business intelligence benefit to your business.

How we can support you?


Business Objects offers customer support plans to best suit the size and requirements of your deployment. We operate three global customer support centers: Americas: San Jose, California and Atlanta, Georgia Europe: Maidenhead, United Kingdom Asia: Tokyo, Japan and Sydney, Australia Online Customer Support Our Customer Support website is open to all direct customers with a current maintenance agreement, and provides the most up-to-date Business Objects product and technical information. You can log, update, and track cases from this site using the Business Objects Knowledge Base.

Having an issue with the product?


Have you exhausted the troubleshooting resources at your disposal and still not found a solution to a specific issue? For support in deploying Business Objects products, contact Worldwide Customer Support at: www.businessobjects.com/services/support.htm

Looking for the best deployment solution for your company?


Business Objects consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in relational and multidimensional databases, in connectivities, database design tools, customized embedding technology, and more. For more information, contact your local sales office, or contact us at: www. businessobjects.com/services/consulting.htm

Looking for training options?


From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. Find more information on the Business Objects Education website: www.businessobjects.com/services/education.htm

Services

12

Data Access Guide

Useful addresses at a glance


Address
Business Objects Documentation www.businessobjects.com/services/ documentation.htm

Content
Overview of Business Objects documentation. Links to Online Customer Support, Documentation Supply Store, Documentation Roadmap, Tips & Tricks, Documentation mailbox.

Business Objects Documentation mailbox documentation@businessobjects.com Product documentation www.businessobjects.com/services/ support.htm

Feedback or questions about documentation.

The latest Business Objects product documentation, to download or view online.

Business Objects product information Information about the full range of Business Objects products. www.businessobjects.com Developer Suite Online www.techsupport.businessobjects.com Knowledge Base (KB) www.techsupport.businessobjects.com Available to customers with a valid maintenance agreement and a Developer Suite license via the Online Customer Support (OCS) website. Provides all the documentation, latest samples, kits and tips. Technical articles, documents, case resolutions. Also, use the Knowledge Exchange to learn what challenges other users both customers and employees face and what strategies they find to address complex issues. From the Knowledge Base, click the Knowledge Exchange link. Practical business-focused examples.

Tips & Tricks www.businessobjects.com/forms/ tipsandtricks_login.asp

Data Access Guide

13

Address Online Customer Support www.techsupport.businessobjects.com

Content

Starting point for answering questions, resolving issues. Information about registering with Worldwide Customer Support. The range of Business Objects training options and modules.

www.businessobjects.com/services Business Objects Education Services www.businessobjects.com/services/ education.htm

Business Objects Consulting Services Information on how Business Objects can help maximize your business intelligence investment. www.businessobjects.com/services/ consulting.htm

Useful addresses at a glance

14

Data Access Guide

About this guide


The Data Access User Guide includes information on how to connect your RDBMS to Business Objects products.

Audience
This guide is intended for users who create connections between relational databases and BusinessObjects, Designer, or Supervisor. It also includes information about configuring your connections for WebIntelligence.

Conventions used in this guide


The conventions used in this guide are described in the table below. Convention This font Indicates Code, SQL syntax, computer programs. For example: @Select(Country\Country Id). This font is also used for all paths, directories, scripts, commands and files for UNIX. Placed at the end of a line of code, the symbol ( ) indicates that the next line should be entered continuously with no carriage return.

Some code more code

$DIRECTORYPATHNAME The path to a directory in the Business Objects installation/configuration directory structure. For example: $INSTALLDIR refers to the Business Objects installation directory. $LOCDATADIR refers to a subdirectory of the Business Objects installation directory called locData.

Creating Connections

part

Accessing Data with Business Objects Products

chapter

18

Data Access Guide

Overview
This chapter includes information about the following: Connecting to your data Data Access Drivers Connections WebIntelligence connections Accessing non-RDBMS data

Accessing Data with Business Objects Products

Data Access Guide

19

Connecting to your data


A connection allows you to access your data on an RDBMS through BusinessObjects.

Workflow information
First you need to ensure you have access information about your database. 1. Install middleware so that you can access your database through either your computer or a server. 2. Install Business Objects products and the appropriate Data Access driver. For more information on installing Business Objects products, see Installation and Configuration for Windows or Installation and Configuration for UNIX. 3. Using the Connections dialog, connect your middleware to your products. 4. Make any necessary modifications to the connectivity parameters.

Database Connectivity Definitions


In order for you to understand connecting to BusinessObjects products, you need to understand the following terms: Relational database Database server ODBC Data Access driver Relational database A relational database contains tables which are groupings of data, columns which are single attributes of a table, and rows which are individual records.

Connecting to your data

20

Data Access Guide

The following image is a table:

The table is CUSTOMER. The columns are NAME, ADDRESS, and TELEPHONE. The rows are JONES 20 MAIN 555.1243; RUIZ 21 MAIN 555.1423; and SMITH 19 MAIN 555.1234. Tables are joined in different ways to access information. Database server A database server is a computer system that processes database queries. Servers are often dedicated, meaning that they perform no other tasks besides their server tasks.

Accessing Data with Business Objects Products

Data Access Guide

21

ODBC ODBC is an application programming interface for database access. You can access multiple RDBMS with ODBC. ODBC architecture has two major components: the driver manager an ODBC driver The driver manager displays all installed ODBC drivers. Data Access driver A Data Access driver is Business Objects software that allows communication between Business Objects products and your middleware. You must install a Data Access driver with your Business Objects product.

Connecting to your data

22

Data Access Guide

Data Access Drivers


A Business Objects Data Access driver connects BusinessObjects to your middleware. Your middleware connects to a network which accesses your database. In order to use Business Objects products, you must first install your middleware, then a Data Access driver. The driver you install is dependent on the type of database you use. For example, if you access an Oracle 8i database, you must install the appropriate middleware (Oracle 8i Client), then the BusinessObjects Oracle Data Access driver. The types of databases supported through Data Access drivers are listed below. Each data access driver is described in its respective chapter in this guide.and the chapters associated with the connection: IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata

Accessing Data with Business Objects Products

Data Access Guide

23

Connections
A connection is a link between BusinessObjects, a Business Objects Data Access driver, your middleware, and your database. A connection can also be a link between 3-tier BusinessObjects and your database. You must have a connection between your Business Objects application and your database in order to access your data.
NOTE

Connecting to WebIntelligence requires you to set parameters in more than one file.

Who creates connections


An administrator creates a repository connection to the database. A universe designer creates a connection. A BusinessObjects user who wants to edit SQL creates a connection.

Creating a connection
In order to create a connection from a Business Objects product to your database, you must have the following: middleware information about your database server a Business Objects product, such as BusinessObjects, Designer, or Supervisor Business Objects Data Access driver

Connections

24

Data Access Guide

The following diagrams show the parts that make up a connection. BusinessObjects in Two-tier mode The following diagram shows BusinessObjects in Two-tier mode.

Accessing Data with Business Objects Products

Data Access Guide

25

BusinessObjects in Three-tier mode The following diagram shows BusinessObjects in Three-tier mode.

Connections

26

Data Access Guide

WebIntelligence connections
With WebIntelligence 6x, you must make sure that any changes you make to your BusinessObjects connection are replicated for WebIntelligence. This applies specifically to any changes you make to data access configuration files or to data access parameter files. For more information on data access configuration files, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425. For more information on data access parameter files, see Data Access Parameter File Reference on page 241. For example, if you change a parameter in the BusinessObjects data configuration file (RDBMSname.sbo), you must also change the parameter in the WebIntelligence data configuration file (RDBMSname.sbo).
EXAMPLE Editing an Oracle connection for both WebIntelligence and BusinessObjects

1. From the following directory, locate the BusinessObjects data configuration file in the directory: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle 2. In a text editor, open the oracle.sbo file. 3. Modify the InputDateFormat parameter: InputDateFormat=DD-MM-YYYY HH:MM:SS 4. Save the oracle.sbo file.

Accessing Data with Business Objects Products

Data Access Guide

27

5. In the dataAccess/connectionServer/oracle directory: 6. In a text editor, open the oracle.sbo file. 7. Modify the Input Date Format parameter: Input Date Format=DD-MM-YYYY HH:MM:SS 8. Save the oracle.sbo file. You must save the changes in both files to make sure the modifications to the parameter are set.

WebIntelligence connections

28

Data Access Guide

Accessing non-RDBMS data


Information about Relational database management systems only is available in this guide. For information about connecting to an OLAP cube, see the Essbase OLAP Access Pack User's Guide, Express OLAP Access Pack User's Guide, or DB2 OLAP Access Pack User's Guide. For information about connecting to data in a Microsoft Excel file, see the BusinessQuery Users Guide.

Accessing Data with Business Objects Products

Creating a Connection to a Database on Windows

chapter

30

Data Access Guide

Overview
This chapter provides information about creating connections to database middleware running on Windows: It covers the following topics: Creating connections with Supervisor Creating connections with Designer Logging in using the Business Objects login Creating Restrictive connections Configuring the Advanced tab Configuring the Custom tab For information on creating connections to access a database on UNIX, see the chapter on creating connections to databases running on UNIX.

Creating a Connection to a Database on Windows

Data Access Guide

31

Creating a connection to access a database on Windows


In order to access your database on Windows, you must: Install middleware. Install Supervisor, Designer, or BusinessObjects. Install the Business Objects Data Access driver for your database middleware. Connect your Business Objects products with one of the procedures in this section. Once you have installed a driver, you have access to its network layer. A network layer allows you to display the connectivity dialog boxes with which you can access your database.You can create connections in which Business Objects products? You can connect to your database through three Business Objects products: Product Supervisor Designer BusinessObjects See the section... Creating connections with Supervisor Creating connections with Designer Creating connections with BusinessObjects

Creating a connection to access a database on Windows

32

Data Access Guide

Creating connections with Supervisor


You can use Supervisor to create connections for the following reasons: Creating a repository connection Creating a new connection for a universe Creating a connection for stored procedures or WebIntelligence auditing
NOTE

You can create only secured connections from Supervisor. A secured connection stores the connection in the security domain of the Business Objects repository to centralize and control access to sensitive or critical data. Creating a repository connection You must create a repository for your BusinessObjects deployment. For more information about repositories, see the Deployment Guide and the Supervisors Guide. To create a repository connection: 1. Start Supervisor. 2. When the Login dialog box appears, click Admin. The Administration Setup Wizard appears. Note: For information on Supervisor, see the Supervisors Guide. 3. In Step 3 of the Administration Setup Wizard, select your database client from the Select the network layer list box. 4. Click Setup. The database client dialog box appears. 5. Select your database server version from the Database engine list box. 6. Type a name for the connection in the Name text box. For information on accessing your database using a BusinessObjects login, see Logging in using the Business Objects login on page 44. 7. Type your user name in the User name text box. 8. Type your password in the Password text box. 9. Type the service name or database alias name used to access your server in the Database text box. Or Select a data source from the Data Source Name drop down list. If you do not

Creating a Connection to a Database on Windows

Data Access Guide

33

have a data source available, click ODBC Admin and define one. 10. Click Test. 11. If your connection is successful, click OK. Or If your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration.
NOTE

You can modify all connection parameters except for the connection type. When creating connections with Supervisor, the connection is always a secured connection. If you want to set additional connection options, see Configuring the Advanced tab on page 45. Creating a new connection for a universe You can create a new secured connection for a universe from Supervisor. To create a new universe connection: 1. Start Supervisor. 2. Click the Universe tab in the Resource pane. 3. Double-click a universe. The universe properties dialog box appears. 4. Click the Definition tab and click New. The Add a connection dialog appears. 5. Click a database client in the Network Layer box. 6. Click OK. The database client dialog box appears. 7. Select your release of a database server version from the Database engine list box. 8. Type a name for the connection in the Name text box. For information on accessing your database using a BusinessObjects login, see Logging in using the Business Objects login on page 44. 9. Type your user name in the User name text box. 10. Type your password in the Password text box. 11. Type the service name or database alias name used to access your server in

Creating connections with Supervisor

34

Data Access Guide

the Database text box. Or Select a data source from the Data Source Name drop down list. If you do not have a data source available, click ODBC Admin and define one. 12. Click Test. 13. If your connection is successful, click OK. Or If your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration. If you want to set additional connection options, see Configuring the Advanced tab on page 45.
NOTE

You can modify all connection parameters except for the connection type. When creating connections with Supervisor, the connection is always a secured connection. Creating a connection for stored procedures or WebIntelligence auditing For more information on stored procedures, see the section on stored procedures in the chapter specific to your database in this guide. For information on WebIntelligence auditing, see the Auditor Users Guide. To create a connection to access stored procedures or for use with WebIntelligence auditing: 1. Start Supervisor. 2. Select Tools > Connections. 3. Click Add in the Connections dialog box. 4. Click a database client in the Add a connection dialog box. 5. Click OK. The database client dialog box appears. 6. Select a database server from the Database engine list box. 7. Type a name for the connection in the Name text box. For information on accessing your database using a BusinessObjects login,

Creating a Connection to a Database on Windows

Data Access Guide

35

see Logging in using the Business Objects login on page 44. 8. Type your user name in the User name text box. 9. Type your password in the Password text box. 10. Type the service name or database alias name used to access your server in the Database text box. Or Select a data source from the Data Source Name drop down list. If you do not have a data source available, click ODBC Admin and define one. 11. Click Test. 12. If your connection is successful, click OK. Or If your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration. If you want to set additional connection options, see Configuring the Advanced tab on page 45.
NOTE

You can modify all connection parameters except for the connection type. When creating connections with Supervisor, the connection is always a secured connection.

Creating connections with Supervisor

36

Data Access Guide

Creating connections with Designer


You can create connections for universes with Designer. When do you need to create a connection for a universe? When you create a universe, you must firstly create a connection for the universe. The connection parameters are saved in the universe. You can modify the connection at any time. You can use Designer to create connections for the following reasons: Creating a new connection for the active universe Adding a new connection to the connections available to a universe Each case is described in its respective section below. What type of connections can you create? You can create the following types of connections:
Type Description

Personal

Specifies that the connection belongs to the user who defined it. Other users cannot use or modify the connection. This option is not recommended for a Designer connection. Stores the connection in the security domain of the Business Objects repository to centralize and control access to sensitive or critical data. Use this option if you are creating a universe that is accessible through the BusinessObjects repository.

Secured

Shared

Specifies that the connection is shared by multiple users. All users who have access to this connection can use it and edit it. Shared connections are not secure. This option is best used in a universe testing environment.

Once a connection is saved in a Business Objects product, you can modify all its parameters except for its type. If you want to define the same connection with a different type, you must recreate it.

Creating a Connection to a Database on Windows

Data Access Guide

37

NOTE

If you want to export a universe to a BusinessObjects repository, you must create a secured connection. Creating a new connection for the active universe You create a connection when you create a universe. You can also create a new connection for an open universe. To create a connection for the active universe: 1. Start Designer and open a universe. 2. Select File > Parameters. The Universe Parameters dialog box appears. 3. Click the Definition tab and click New. The Add a connection dialog appears. 4. Click a database client in the Network Layer box. 5. Click OK. The database client dialog box appears. 6. Select your database servern version from the Database engine list box. 7. Type a name for the connection in the Name text box. For information on accessing your database using a BusinessObjects login, see Logging in using the Business Objects login on page 44. 8. Type your user name in the User name text box. 9. Type your password in the Password text box. 10. Type the service name or database alias name used to access your server in the Database text box. Or Select a data source from the Data Source Name drop down list. If you do not have a data source available, click ODBC Admin and define one. 11. If your connection is successful, click OK. Or If your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration. If you want to set additional connection options, see Configuring the Advanced tab on page 45.

Creating connections with Designer

38

Data Access Guide

Adding a new connection to the connections available to a universe You can add a connection to the list of connections available to the active universe. Universes that appear in the list of available connections appear in the Connections drop down list on the Definition page of the Parameters dialog box (Select File > Parameters). Once you have added a connection to the list of available connections, you can select any listed connection to apply to the active universe at any time. To add a new connection to the list of available connections: 1. Start Designer. 2. Select Tools > Connections. The Connections dialog box appears. 3. Click Add. The Add a connection dialog box appears. 4. Click a database client in the Network Layer box. 5. Click OK. The database client dialog box appears. 6. Select database server version from the Database engine list box. 7. Type a name for the connection in the Name text box. For information on accessing your database using a BusinessObjects login, see Logging in using the Business Objects login on page 44. 8. Type your user name in the User name text box. 9. Type your password in the Password text box. 10. Type the service name or database alias name used to access your server in the Database text box. Or Select a data source from the Data Source Name drop down list. If you do not have a data source available, click ODBC Admin and define one. 11. If your connection is successful, select your type of connection from the Type box. Or If your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration. 12. Click OK. If you want to set additional connection options, see Configuring the Advanced tab on page 45.

Creating a Connection to a Database on Windows

Data Access Guide

39

Creating connections with BusinessObjects


You can modify SQL scripts through BusinessObjects. You can open and run the scripts or create new ones. Accessing your database from the Free-Hand SQL Editor To access a database from the SQL Free and SQL Editor: 1. Start BusinessObjects and click the New Report Wizard button on the Standard toolbar. The New Report Wizard appears. 2. Select an option for the report layout, then click Next. The Specify Data Access dialog box appears. 3. Click Others and select Free-hand SQL. 4. Click Finish. The Free-Hand SQL dialog appears. 5. Click the Create a new connection icon. The Add a connection dialog appears. 6. Click a database client in the Network Layer box. 7. Click OK. The database Client dialog box appears. 8. Select a database server release from the Database engine list box. 9. Type a name for the connection in the Name text box. For information on accessing your database using a BusinessObjects login, see Logging in using the Business Objects login on page 44. 10. Type your user name in the User name text box. 11. Type your password in the Password text box. 12. Type the service name or database alias name used to access your server in the Database text box. 13. Click Test. If the message The server is responding! appears, your connection is successful. If the message The server is not responding! appears, your connection is not successful. Click Details. Contact your database administrator for information about your database or middleware configuration. 14. If your connection is successful, select your type of connection from the Type

Creating connections with BusinessObjects

40

Data Access Guide

box. You can select the following types of connections: Type Personal Description Specifies that the connection belongs to the user who defined it. Other users cannot use or modify the connection. Use this option to access database accounts to test an SQL sample through Free-Hand SQL. Shared Specifies that the connection is shared by multiple users. All users who have access to this connection can use it and edit it.

You cannot create a secured connection with the Freehand SQL Editor. Once a connection is saved in a Business Objects product, you can modify all its parameters except for its type. If you want to define the same connection with a different type, you must recreate it. 15. Click OK. If you want to set additional connection options, see Configuring the Advanced tab on page 45.
NOTE

When you deploy WebIntelligence on UNIX platforms, you need to create your connections directly on the UNIX platform. For more information, see Click OK to close the Connectivity dialog box. on page 47.

Creating a Connection to a Database on Windows

Data Access Guide

41

Creating Restrictive connections


A restrictive connection is a special type of connection that can be used to restrict data access. If you want to force a user to enter data account access parameters, for example when they refresh a report, you should define a restrictive connection. You can define a restrictive connection at the data account level with the following connection types: Secured Universe connections (exported) Non secured universe connections (not exported) Secured connections used for Stored procedures Connections defined for Free hand SQL The restrictive connection uses a @Variable function as a User name value in the login page of the Network layer dialog box for the connection. It has the following syntax: @Variable(BOUSERPROMPT)
NOTE

You should only use Restrictive connections with Business Objects desktop products. Restrictive connections are not supported for use with server products such as WebIntelligenceand Broadcast Agent. Restrictive connections have the following characteristics: Use the @Variable(BOUSERPROMPT) function as a login parameter. When a BusinessObjects document is refreshed using a restrictive connection, a login box appears, and the user must enter their database user name and password to access the data in the document. The BusinessObjects user must know their database user name and login. This is independent of their Business Objects user name and password.

Creating Restrictive connections

42

Data Access Guide

Restrictive connections and connection time Depending on the advanced parameters defined for a restrictive connection, a user may be required to enter database login to access data more than once in a session for different data access actions. Some examples are listed below: Advanced parameter Effect on connection activity when selected...

Keep the connection User is prompted to enter database login parameters active during the whole on the first refresh of a report, but not for subsequent session refreshes. However, if the user starts the SQL parser to validate a SQL statement, then they could be prompted to enter database login to run the SQL check. Disconnect after each transaction User is prompted for database login on each document refresh, or each time a query is run.

Defining a restrictive connection You can define a restrictive connection as follows: 1. Open the Add a Connection page. See the creating connection procedures earlier in the book to get this dialog box. 2. Click a driver name and click OK. A dialog box for your Data Access driver opens to the Login page. The Database engine drop-down list box displays the RDBMS available for the Data Access driver that you selected. 3. Type a name for the connection. (You can enter up to 35 characters.) 4. Select a RDBMS from the Database Engine drop-down list box. 5. Do the following in the Login group box: - Type @Variable(BOUSERPROMPT) in the User Name box. - Type the password for the database in the Password box. - Select or type the name of your database, or connection, in the Database drop-down list box, or text box, depending on your target RDBMS. 6. Select Secured from the connection type from the Type list box. 7. Specify all the remaining parameters that are specific to your RDBMS. 8. Click the Test button. If the connection is valid a message box appears indicating that the connection is correct. If you receive an error message, check to see that you entered all the parameters correctly. If the error persists, refer to the section

Creating a Connection to a Database on Windows

Data Access Guide

43

of your RDBMS documentation relating to error messages. 9. Click the OK button. The Universe Parameters dialog box is displayed once again. It displays the name of the current connection.

Creating Restrictive connections

44

Data Access Guide

Logging in using the Business Objects login


You can use a Business Objects login to access your database. The Business Objects login must be identical to your database login. Using the same login increases the security of a connection, as a user is verified as a Business Objects user when they connect to the repository before connecting to the database. Contact your Business Objects administrator to request your Business Objects login. For more information on creating users and modifying profiles, see the Supervisors Guide.

Creating a Connection to a Database on Windows

Data Access Guide

45

Configuring the Advanced tab


Use the Advanced tab to override the following common configuration options: Defining the duration of a connection into a pool Switching between synchronous and asynchronous modes Defining how Business Objects products respond when database resources are not available Defining the size of the array fetch To set any additional connectivity options, click the Custom tab. For information on the Custom tab, see Configuring the Custom tab on page 47. Item Connection Properties Keep the connection active during the whole session Click if you want your connection to stay active during the entire session of the product; the connection ends when the user exits the application. Click if you want your connection to stay active for a defined period of time. You must also enter a value for the number of minutes. This is the default Connection Property. Disconnect after each transaction Click if you want your connection to disconnect immediately after the transaction is completed. Users will have to reconnect each time they want to access data. Click if you want to give users who submit queries to the server: the ability to regain control immediately the ability to cancel queries using the Esc key Note: If you are creating a connection for a universe which is accessed with WebIntelligence, do not select Use asynchronous mode. Description

Keep the connection active for x minutes

Connection Mode Use asynchronous mode

Configuring the Advanced tab

46

Data Access Guide

Item Use synchronous mode

Description Click if you want to give users who submit queries the ability to cancel queries using the Esc key. This is the default Connection Mode.

Locked resources Get error message and stop Click if you want your connection to disconnect and notify the user that the resource is locked when a user receives an error message. This is the default Locked Resources option. Wait for resources Array fetch size Click if you want your connection to remain active without notifying users. Enter the maximum number of rows authorized with each fetch. If you enter 20, and your query retrieves 100 rows, the connection executes 5 fetches to retrieve your data. Five fetches of 20 rows each equals 100 rows of data. If you enter 1, the array fetch is deactivated and data is retrieved row by row. Note: Deactivating array fetch is the safest way of retrieving your data but row-by-row retrieval slows down server performance. The greater the value in the Array fetch size option, the faster your rows are retrieved; you must, however, ensure you have adequate client system memory. Note: If a query retrieves data containing blob or long text types, the array fetch is automatically reset to 1. The default value is 20. Perform the cost estimate Click the check box if you want to perform a cost estimate.

Creating a Connection to a Database on Windows

Data Access Guide

47

Configuring the Custom tab


The Custom tab is only for advanced users. The following appears in the Oracle Client Custom tab for a repository connection:
RecommendedLenTransfert Hint

For information on these parameters, see Data Access Parameter File Reference on page 241. To override connectivity options in the Custom tab: 1. Click the option you want to configure. In the Description box, you can find a description and the possible values for the option you selected. 2. Enter a new value in the Value box and click Set. 3. Repeat step 1 and 2 if you need to modify the configuration of other options. 4. Click OK to close the Connectivity dialog box.

Configuring the Custom tab

48

Data Access Guide

Creating a Connection to a Database on Windows

Creating a Connection to a Database on UNIX

chapter

50

Data Access Guide

Overview
This chapter describes creating connections to access supported middleware for UNIX platforms.

Creating a Connection to a Database on UNIX

Data Access Guide

51

Creating connections to databases on UNIX


To deploy WebIntelligence server on a UNIX platform, you must: ensure your database middleware is installed and available before you run WebIntelligence create connections directly on your UNIX platform Once you create the Business Objects repository on a Windows platform, the repository characteristics are stored in the bomain.key file. This file is distributed to all users so they may access the repository. The default location for this file is:
/<Application Data Directory>/LocData/

For more information on the bomain.key file, see the Supervisors Guide. When you deploy WebIntelligence on UNIX, you may not have access to the bomain.key file. If you dont have one, you can create this file directly on your UNIX platform using the wmainkey utility. The wmainkey utility creates the connection to the repository and creates the bomain.key file itself. The default location for this file is:
/<WebIntelligence Install Directory>/SetUp/

Using the Wmainkey utility


The wmainkey utility is executed from the shell command line. Use the following syntax:
wmainkey [-f] <filename>

The wmainkey command can be used in three ways: without any option specified When you run the command, you are prompted for each required parameter. with the -f option You specify an .xml file containing the definitions of the connection parameters. with the -c option Accepts options from the command line. You use the wmainkey utility as follows:
wmainkey -t wmainkey -t wmainkey -i <filename> -k <filename> [-m <middleware>] [-e <database>][-u <user name>] [-p <password>] [-s <source>] [-d <database>] [-on <owner name>] [-o <keyfile>]

Creating connections to databases on UNIX

52

Data Access Guide

wmainkey -f wmainkey -h

Parameters
The following parameters are available: Parameter -lm -le -x -c -t -i -k -m -e -u -p -s -d -on -o -f <def_file> <keyfile> <client_middleware> <database_engine> <user> <password> <source> <database> <owner_name> <keyfile> Value Meaning List available client middleware. List available database engines. Export a connection definition file. Create a keyfile. Test a connection. Specify an input connection definition file. Specify an input keyfile. Specify a client middleware name. Specify a database engine name. Specify a user name. Specify a password. Specify a data source name. Specify a database name. Specify an owner name Specify the output keyfile name. Force overwrite of output file

Creating a Connection to a Database on UNIX

Data Access Guide

53

Creating the bomain.key file interactively


When you execute wmainkey, the utility prompts you for each connection parameter. Once you have finished creating the bomain.key file, the connection parameters and the default configuration settings are stored within the bomain.key file. To create the bomain.key file: 1. Start wmainkey from a shell command line by typing: /<WebIntelligence Install Directory>/SetUp/wmainkey 2. Choose the RDBMS you are accessing. (1) DB2 CAE (2) Oracle OCI Specify which Database: For example, enter 2 for Oracle. 3. Enter the number that corresponds to your database engine. 4. Enter the connection parameters: Username, Password, and Service Name. 5. Enter y to check the connection to your server. If you get an error message, check your connection parameters and try again. Once you have completed entering the connection parameters, the bomain.key is created inside:
/<Application Data Directory>/LocData/

and a mainkey.param file containing all the connection parameters, except for the password which is hidden, is created inside:
/<WebIntelligence Install Directory>/SetUp/ NOTE

The mainkey.param file contains the connection parameters and the configuration settings. Use the cat command to display the content of the file: cat /<WebIntelligence Install Directory>/SetUp /mainkey.param

For more information on parameters, see Data Access Parameter File Reference on page 241 and Functions on page 321.

Creating connections to databases on UNIX

54

Data Access Guide

Using wmainkey with a parameter file (option -i)


The -i option of wmainkey specifies an xml file containing the parameters to use to create the bomain.key file. Wmainkey can also create the parameter file which can then be edited using a text or an xml editor. There are three steps: 1. Run wmainkey from the command line using the -x -n and -d parameters:
wmainkey -x -m <middleware> -e <database> > <xml filename>

For example, if you use an Oracle database named orcl and want to name the xml file bomainparam.xml enter:
wmainkey -x -m Oracle -e orcl > bomainparam.xml

2. Edit the.xml you have created in the above step with a text editor. An example of the correct format appears below. 3. Run wmainkey again with the -i option specifying the filename. For example, if you want to use a file named bomainparam.xmlenter:
wmainkey -i bomainparam.xml

Creating a Connection to a Database on UNIX

Data Access Guide

55

Parameter file format Use wmainkey to create the file then edit it with a text or xml editor. For example, the content of the parameter file should be in the following format:
<?xml version="1.0" encoding="UTF-8"?> <ConnectionDefinition NetworkLayer="ODBC" RDBMS="MS SQL Server 7.x"> <Shared/> <ConnectionName>My connection</ConnectionName> <User>test</User> <Password>test</Password> <DataSource>my DSN</DataSource> <Pooling>33</Pooling> <ArrayFetch>44</ArrayFetch> <ArrayBind>55</ArrayBind> <LogTimeout>66</LogTimeout> <CustomParameter Name="Binary Slice Size">345</ CustomParameter> </ConnectionDefinition>

Save the file, as, for example:


$INSTALLDIR/setup/bomainparam.xml

Using wmainkey from the command line (option -c)


The -c option of wmainkey lets you specify parameters in the command line. For example:
$INSTALLDIR/setup/wmainkey -c -e <database engine> -m <client middleware>

Creating connections to databases on UNIX

56

Data Access Guide

Updating bomain.key
You may need to update the existing bomain.key file, for example if the repositorys connection parameters have changed. To do so, you must create or edit the parameter file and run wmainkey with the -f option specifying the file. Before starting the wmainkey command, you must ensure that you are logged on as the same user used to run the Configuration Tool. Otherwise, you may not have sufficient rights to create the file. To create the parameter file, see Using the Wmainkey utility on page 51. To edit the parameter file: Use a text editor to open the parameter file. Edit the file as needed and save the modifications. Launch wmainkey from the command line by typing:
$INSTALLDIR/setup/wmainkey -f <filename>

where <filename> corresponds to the parameter file. To avoid having to type the full path of the file location, change to the $INSTALLDIR/setup directory first. If prompted for the password parameter, enter the password. The updated bomain.key file by default is stored in the directory
$INSTALLDIR/node/<hostname>/<clustername>/locdata

unless you specified a different location.

Checking your connection with wmainkey


You can use wmainkey to check your connection to your database. At the terminal prompt, enter:
wmainkey -t -k bomain.key

Displaying wmainkey help


To display help for wmainkey, enter:
wmainkey -h

The help screen appears.

Creating a Connection to a Database on UNIX

Managing Connections

part

Using Predefined Data Access Variables

chapter

60

Data Access Guide

Overview
In Business Objects products you can use predefined variables for security purposes. The following predefined variables contain the login parameter used to connect to the database: DBUSER which contains the user name DBPASSWORD which contains the password DBDATABASE which contains the alias name for the protocol, server name and database name These predefined variables are different from other variables used in Business Objects products, for example BOUSER, and BOPASS, which refer to user identification. For more information about variables used in Business Objects products, refer to the Designers Guide or to the BusinessObjects Users Guide. You can use these predefined variables to: Define a restriction on an object Define a condition on a query

Defining a restriction on an object using predefined variables


In Designer, you can define an object in which you include these database variables in the Where clause. To use these variables, you must enter the following syntax:
@Variable(DBVARIABLE)

@Variable is a function used to reference a value assigned to a name or variable. To access the Edit Properties dialog box in Designer: 1. Open Designer. 2. Open a universe. 3. In the Universe Window, right-click an object. 4. Click Object Properties.

Using Predefined Data Access Variables

Data Access Guide

61

The Edit Properties dialog box displays the object properties and SQL definition of the Customer object, which enables users to retrieve all the customer last names having a first name equal to the DBUSER value: .

SELECT Customer.last_name FROM Customer WHERE ( Customer.first_name )

@variable('DBUSER')

62

Data Access Guide

Defining a condition on a query using predefined variables


In BUSINESSOBJECTS, you can define a query in which you include these variables in the query condition. To use these variables, you must: 1. Display the Query Panel. 2. Drag an object from the Classes and Objects box to the Conditions box. 3. Double-click an operator from the Operators box. 4. Double-click the Type a new prompt operand. 5. A text box appears next to the operator. 6. Enter the predefined variable then press Enter. 7. When you enter a variable inside the text box, you must type it in uppercase.

Using Predefined Data Access Variables

Data Access Guide

63

The following image shows a query whose definition enables users to retrieve all the customers whose last names are not equal to the DBPASSWORD value.

Click the View SQL button on the Query Panel toolbar to display the SQL definition of this query:

64

Data Access Guide

Using Predefined Data Access Variables

Checking your Connection Configuration

chapter

66

Data Access Guide

Overview
Business Objects allows you to check your connection configuration. Using a command line tool, you have the following options: Checking available connectivities Displaying a list of installed data access drivers Displaying a list of active data access drivers Checking your middleware Testing a connection to a database server Checking a data access driver.

Checking your Connection Configuration

Data Access Guide

67

Using the Check Tool


The Check tool is a command line utility provided with your data access driver. You can use the Check tool to check your client middleware and Business Objects data access driver installation at any time. The Check tool is installed as follows: <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connection Server\cscheck.exe

Using the Check tool


You can run the Check tool at any time. Running the Check tool To run the cscheck utility: 1. Open a DOS prompt. 2. Change to the path where the utility is installed, for example: cd <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer 3. Enter cscheck with the values you want to check. 4. Review the returned information. The Check tool syntax and functions that you can use are described below.

Check tool syntax


You use the Check tool in a command editor. You use the following syntax: Check tool syntax Description

cscheck (--help|-h) [(--language|l) <lg>] Displays general help message for cscheck utility. <lg>: output language name. cscheck [(--language|l) <lg>] <function name> (--help|-h) Displays the help message for the function.

cscheck [(--language|l) <lg>] [--xml|x] [- Calls the function with its options. -mute|m] <function name> <function --xml: xml output options> --mute: no output

Using the Check Tool

68

Data Access Guide

<function name> can take the following values: (middleware|mw) (list|lt) (accessdriver|ad) (connectivity|ct) (driverssearch|ds) (find|fd) (ping|pg) Each of these functions is described in the following section.

Check tool functions


You can run the following functions: Drivers search The tool returns the list of BO access drivers that are installed on your local machine. Syntax cscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (driverssearch|ds) Example cscheck driverssearch List This function returns the list of network layers and database engines and allows you to get the correct network layers and database engine syntax when using other functions.
NOTE

This function returns the full list of supported data access drivers and middleware. You receive the full list even if you do not have all the listed data access drivers and middleware installed. Syntax cscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (list|lt) Example
cscheck list

Checking your Connection Configuration

Data Access Guide

69

Middleware On your local machine, the tool checks the client middleware installation. Specify which couple(s) network layer / database engine you want to validate and run the command. Syntax cscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (middleware|mw) {(-c|-clientlayer) <layername> (-d|--database) <dbname>} Example
cscheck --xml middleware -c "Oracle Client" -d "Oracle 8.1" > c:\result.xml

Data access driver On your local machine, the tool checks the Business Objects access driver(s) installation. Specify which couple(s) network layer / database engine you want to validate and run the command. Syntax cscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (accessdriver|ad) {(-c|-clientlayer) <layername> (-d|--database) <dbname>} Example
cscheck -l English accessdriver -c "Oracle Client" -d "Oracle 8.1"

Connectivity On your local machine, the tool checks the global connectivity (ies) (client middleware + BO access driver) installation. Specify which couple(s) network layer / database engine you want to validate and run the command. Syntax cscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (connectivity|ct) {(-c|-clientlayer) <layername> (-d|--database) <dbname>} Example
cscheck -l English connectivity -c "Oracle Client" -d "Oracle 8.1">c:\result.txt

Using the Check Tool

70

Data Access Guide

Find Returns the list of access drivers loaded by Connection Server Syntax cscheck (find|fd) Example
cscheck find m local

Ping Attempts to establish a simple connection with connection server. It returns information such as the network layer, and user name. Syntax cscheck (ping|pg) Example
cscheck ping -m local -c "Oracle Client" -d "Oracle 8.1" -u "efashion" -p "password" -s "Harlaxton"

Checking your Connection Configuration

Configuring Specific Data Access Drivers

part

IBM DB2 Data Access

chapter

74

Data Access Guide

Overview
This chapter provides information about IBM DB2-specific connections, including: Optimizing data access performance Configuring the IBM DB2 server IBM DB2 datatype conversion For information on creating a connection to access a DB2 database on Windows, see the chapter Creating a Connection to a Database on Windows. For information on creating connections to access an DB2 database on UNIX, see the chapter Creating a Connection to a Database on UNIX.

IBM DB2 Data Access

Data Access Guide

75

Connecting to Business Objects products with IBM DB2


The following operating systems and IBM DB2 releases are supported for connection: IBM DB2 Release IBM DB2 on NT/Unix Middleware DB2 Client

Connecting to Business Objects products with IBM DB2

76

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install the IBM DB2 Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name driver.prm (XML format) driveren.prm (text format) driveren.prm (XML format) db2.stg (XML format) db2en.txt (text format) db2en.stg db2.sbo Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information, see Modifying the parameter files on page 77. Contains information about each SQL function used in the driver.prm Contain external strategy definitions based on SQL. For more information, see Modifying an external strategy File on page 89. Contains information about the external strategies used in db2.stg Contains the default connection parameters. For more information, see Modifying the data configuration files on page 88.

The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\db2 WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\db2

When you modify a connection parameter for WebIntelligence, you need to also modify the parameter files in both oracle directories.

IBM DB2 Data Access

Data Access Guide

77

When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\oracle directory.

Modifying the parameter files


You can add SQL functions or modify existing parameters in the driver.prm file to optimize your connection. There are two driver.prm files: Oracle parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both driver.prm files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\db2\driver.prm The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the driver.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\db2\driver.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\db2\driver.prm If you use WebIntelligence, you must modify both driver.prm files every time you make a change to one file. The driver.prm file is declared in either the AS400.sbo file or the DB2.sbo file in the following parameter:
SQL Parameter File=

Optimizing data access performance

78

Data Access Guide

General parameter file The driveren.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS This section contains all the parameters needed for SQL generation. It can also include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and other creation parameters.
NOTE

Business Objects recommends that you only add parameters. If you must modify a parameter, exercise caution as the parameter settings enable Business Objects products to create SQL. If you modify the settings, the modified parameters could generate errors. Do not remove parameters. For information about each parameter, see Data Access Parameter File Reference on page 241. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. This SQL syntax is used for the Automatic Time Hierarchy feature in Designer or in BusinessObjects. OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition. FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects.

IBM DB2 Data Access

Data Access Guide

79

Business Objects products provide you with the most commonly used functions. If you need additional functions, you can add them to the driveren.prm file. A function has the following structure: Function parameter (n) Description Order in which the function appears in the driveren.prm file. n starts at 0 and each function number should be different. The name of the function as it appears in BusinessObjects.

NAME= function name

TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text TYPE=A IN_MACRO=Y GROUP=Y SQL=SQL function name($A,$N) Function help text that appears in Designer and BusinessObjects. Type of function: A=alphanumeric, N=numeric, and D=date. Indicates whether the function should appear in BusinessObjects. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric), $N (numeric), $D (date), and $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

Optimizing data access performance

80

Data Access Guide

Before you create your function, make sure you are using the correct driver.prm file: Your IBM DB2 server IBM DB2/UDB for NT Parameter file db2udben.prm

Adding a function to the driveren.prm File Business Objects provides a list of SQL functions in the driveren.prm file. You may add functions to this list. To add a function: 1. Open the driveren.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD= parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an aggregate function or N if the function is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.

IBM DB2 Data Access

Data Access Guide

81

NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file on page 87. The following is an example of a newly created function:
(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Optimizing data access performance

82

Data Access Guide

To see your newly created function in Designer: In Designer, in the left pane, double click an object. The Edit Properties dialog appears. In the Select section of the dialog, click the >> button. The following dialog appears:

Function TYPE=A

Function SQL=($A,$D)

IBM DB2 Data Access

Data Access Guide

83

To see your function in BusinessObjects: In BusinessObjects, create a report. In the Query Panel, click User Objects. The User Objects dialog appears. Click Add.

Function HELP= Function TRAD= Function TYPE=A

Function NAME= Example

Each argument is checked on input to ensure the input matches the datatype indicated in the function. For example, if a function is specified as a DATE format, the user must enter a date format. WebIntelligence parameter file The driveren.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions You should use an XML editor to view and modify this file. Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.

Optimizing data access performance

84

Data Access Guide

EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation> </DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes. The available <Operator> attributes are: Arity Type, possible values: Numeric, Char, String, DateTime, Logical or All ID : identifier of the operator

IBM DB2 Data Access

Data Access Guide

85

EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the driveren.prm XML file on page 87. If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.
EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/>

Optimizing data access performance

86

Data Access Guide

<Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

IBM DB2 Data Access

Data Access Guide

87

Adding a function to the driveren.prm XML file You must add your function to the BusinessObjects driveren.prm file before completing this procedure. For more information, see Adding a function to the driveren.prm File on page 80. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\DB2\driveren.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in BusinessObjects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects Displays the type of function: String Numeric DateTime

5. In the <Arguments> section, include any arguments for your function. Each argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the driveren.prm file.

Optimizing data access performance

88

Data Access Guide

Modifying the data configuration files


The db2.sbo file is the data access configuration file. It contains all the default connection parameters. When you change the data access configuration file, all parameter default values are changed for new connections. All connections made after the parameter values are changed use those parameter values as default values.
NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For further information on these parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Structure of the data configuration files These text files, structured like a filename.ini file, are divided into three sections: [DEFAULTS], [SQL Syntax], and [Database Engine]. DEFAULTS section This section contains among other things all the parameters that: configure by default the Advanced tab in the connection dialog box define the default database engine define the default driver.prm and driver.rss files SQL Syntax section This section displays all the database engines accessible with this driver. The database engine name, such as DB2/400 V4, appears in the Login tab when you click the Database engine list box. For each listed database engine, there is a separate [Database Engine] section.

IBM DB2 Data Access

Data Access Guide

89

Database Engine section This section contains all the parameters that are specific to a database engine. If a parameter exists in both the [DEFAULTS] and [Database Engine] sections, the value defined in the [Database Engine] section overrides the value entered in the [DEFAULTS] section.

Modifying an external strategy File


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe. When you purchase an IBM DB2 Access Pack, you are provided with an external strategy file which is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data Access\RDBMS\legacy\Db2\db2en.txt

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide. Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP].
EXAMPLE The following is a section of the db2en.txt file: [STRATEGY] TYPE=OBJECT NAME= Strategy for Classes and Objects [SQL] SQL= SELECT Tab.NAME,'|', Col.NAME,'|', Tab.CREATOR || '\' || Tab.NAME,'|', Col.NAME,'|', Tab.NAME CONCAT '.' CONCAT Col.NAME,'|', ' ','|', CASE Col.typename WHEN 'DATE' THEN 'D'

Optimizing data access performance

90

Data Access Guide

WHEN 'DOUBLE' THEN 'N' WHEN 'INTEGER' THEN 'N' WHEN 'SMALLINT' THEN 'N' WHEN 'LONG VARCHAR' THEN 'T' ELSE 'C' END,'|', ' ','|', 'O','|', Tab.CREATOR FROM SYSIBM.SYSCOLUMNS Col, SYSIBM.SYSTABLES Tab WHERE ( Col.TBNAME=Tab.NAME ) AND ( Col.TBCREATOR=Tab.CREATOR Order by 19,1,3;

[HELP] HELP= This strategy reads the database structure. It associates tables with classes as well as columns with objects.

STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure SQL subsection This subsection contains the SQL statements that enable a universe designer to create classes and objects, joins, or table structure.

IBM DB2 Data Access

Data Access Guide

91

HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe. Creating an external strategy file If you want to create an external strategy file, copy the strategy file, such as db2en.txt, from the DB2 subfolder. To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type. For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy.For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy. For example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example: example.txt. Declaring an external strategy file Once you create an external strategy file, you have to declare it in order for Designer to use it. To declare an external strategy file: 1. Open the driveren.prm file with a text editor. The driveren.prm file is located by default at: <BO Path>\BusinessObjects Enterprise 6\Data Access\RDBMS\legacy\DB2\ 2. Scroll to the STG= parameter. 3. Enter the name of the external strategy file. For example: STG=example. You must enter the name of the stdriver.txt file without its extension and path. Since you do not enter a path, the stdriver.txt file must be located in the same folder as the driveren.prm file.

Optimizing data access performance

92

Data Access Guide

Modifying the driveren.sbo and driver.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driverEN.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg file is an XML file containing the driver information relevant to WebIntelligence only.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data Access\RDBMS\legacy\driveren.sbo

The driveren.sbo file for WebIntelligence is an XML file at:


<BO Path>\BusinessObjects Enterprise 6\data Access\RDBMS\connectionServer\driveren.cfg NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file. The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer For example, the IBM DB2 entry is displayed below:

IBM DB2 Data Access

Data Access Guide

93

DB2_CAE= IBM DB2 Client,Allows you to access an IBM DB2 database

DB2_CAE IBM DB2 Client Allows you to access an IBM DB2 database

the key name for CAE the name of the network layer the description of the network layer

The following illustration displays each element of the entry in BusinessObjects:

b a. The registry entry b. The name of the network layer c. The network layer description

Optimizing data access performance

94

Data Access Guide

This file containts the name of the network layer and its description. Do not change the key name. This key name matches one in your Windows registry, if it is modified, you could experience problems with your computer. Alias Section This section displays a list of Business Objects 5.x Data Access drivers and their compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears in the Windows system registry the Data Access driver for Business Objects 6 compatible driver. Each driver is listed by registry key name without underscore characters For example, below you have the IBM DB2 CAE v5 registry entry for Business Objects 5.x and the corresponding Business Objects 6.x compatible Data Access driver:
DB2_CAE_V5=DB2 CAE

DB2_CAE_V5 DB2 CAE

the key name of the IBM DB2 CAE v5 Data Access Driver for Business Objects 5.x the key name of the Data Access driver for Business Objects 6

The driveren.cfg file The driveren.cfg file for WebIntelligence contains the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for IBM DB2:
<NetworkLayer Name="DB2 CAE"> <Message id="Comment">Allows you to access an IBM DB2 database</Message> <Message id="Name">IBM DB2 Client</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 92. If you change any part of the drivers section of the driveren.sbo file, make sure you make the same changes to the driveren.cfg file.

IBM DB2 Data Access

Data Access Guide

95

NOTE

It is not recommended that you modify these files.

Optimizing data access performance

96

Data Access Guide

Configuring the IBM DB2 server


Overview
You can configure your IBM DB2 server to improve performance with Business Objects products.

Modifying the CURSORHOLD parameter to improve RDBMS performance


A transaction is a logical unit that contains one or more SQL statements. Each transaction ends either by a COMMIT or a ROLLBACK. Transactions are executed inside a cursor, the SQL technique to process rows in a query result one at a time. Once a transaction is completed, a database can either leave the cursor open until the next transaction or close it. Leaving the cursor open is the default. Closing the cursor improves the interaction between your Business Objects products and your server. Deactivate the CURSORHOLD parameter to close the cursor. This enables your database to work more efficiently since it does not have to maintain resources at the end of each transaction.

IBM DB2 Data Access

Data Access Guide

97

IBM DB2 datatype conversion


Business Objects supports four datatypes: date character number long text

IBM DB2 Datatypes


The following table lists the IBM DB2 internal datatypes and their equivalent in Business Objects products:
IBM/DB2 Datatype Business Objects Suggested Datatype

CLOB CHARACTER DATE DECIMAL DOUBLE FLOAT INTEGER LONG VARCHAR NUMERIC SMALLINT TIME TIMESTAMP VARCHAR

LONG TEXT CHARACTER DATE NUMBER NUMBER NUMBER NUMBER LONG TEXT NUMBER NUMBER DATE DATE CHARACTER

IBM DB2 datatype conversion

98

Data Access Guide

IBM DB2 Data Access

Informix Data Access

chapter

100

Data Access Guide

This chapter provides information about Informix-specific connections, including: Optimizing data access performance Informix datatype conversion For information on creating a connection to access an Syabse database on Windows, see the chapter Creating a Connection to a Database on Windows. For information on creating connections to access an informix database on UNIX, see the chapter Creating a Connection to a Database on UNIX.

Informix Data Access

Data Access Guide

101

Connecting to Business Objects products with Informix


The following operating systems and Informix releases are supported for connection: Informix Release IBM Informix DS Middleware Informix SDK 2.81 (ODBC)

Connecting to Business Objects products with Informix

102

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install a Informix Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name informix.prm (XML format) informixen.prm (text format) informixen.prm (XML format) informix.stg (XML format) informixen.txt (text format) informixen.stg informix.sbo Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information, see Modifying the Informix parameter files on page 103. Contains information about each SQL function used in the informix.prm Contains external strategy definitions based on SQL. For more information, see Modifying an external strategy file on page 116. Contains information about the external strategies used in informix.stg Contains the default connection properties. For more information, see Modifying the data access configuration file on page 115.

The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\informix WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\informix

Informix Data Access

Data Access Guide

103

When you modify a connection parameter for WebIntelligence, you need to also modify the parameter files in both informix directories. When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\informix directory.

Modifying the Informix parameter files


You can add SQL functions or modify existing parameters in the informix.prm file to optimize your connection. There are two informix.prm files: Informix parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both informix.prm files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\informix\informix.prm The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the informix.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\informix\informix.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\informix\informix.prm If you use WebIntelligence, you must modify both informix.prm files every time you make a change to one file.

Optimizing data access performance

104

Data Access Guide

The driver.prm file is declared in the informix.sbo file in the following parameter:
SQL Parameter File=

General parameter file The informix.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS The RDBMS section contains all the parameters needed for SQL generation. It may include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and so on.
NOTE

Business Objects recommends that you only add parameters. If you must modify a parameter, exercise caution as the parameter settings enable Business Objects products to create SQL. If you modify the settings, the modified parameters could generate errors. Do not remove parameters. For a description of each Informix parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. The DATE SQL syntax is used for the Automatic Time Hierarchy feature in Designer and BusinessObjects. For a description of each Informix parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition in BusinessObjects.

Informix Data Access

Data Access Guide

105

For a description of each Informix parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects. For information on creating functions, see Adding a function to the informix.prm file on page 106. The informix.prm file for WebIntelligence is an XML file. Do not move this file as it is dependent on a DTD file for syntax. For more information on including functions in WebIntelligence, see Adding a function to the informix.prm XML file on page 113. Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the informix.prm file. A function has the following structure:
SQL parameters Description

Order in which the function appears in the informix.prm file. The value n starts at 0. Each function number should be unique.

NAME= function name Displays the name of the function as it appears in BusinessObjects. TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text Function help text that appears in Designer and BusinessObjects.

Optimizing data access performance

106

Data Access Guide

SQL parameters

Description

TYPE=A

Displays the type of function: A=alphanumeric N=numeric D=date

IN_MACRO=Y GROUP=Y SQL=SQL function name($A,$N)

Indicates whether the function should appear in BusinessObjects. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric) $N (numeric) $D (date) $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

Adding a function to the informix.prm file Business Objects provides a list of SQL functions in the informix.prm file. You may add functions to this list. To add a function to the informix.prm file: 1. Open the informix.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD=

Informix Data Access

Data Access Guide

107

parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an aggregate function or N if the function is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the informix.prm XML file on page 113.

Optimizing data access performance

108

Data Access Guide

The following is an example of a newly created function:


(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Viewing a newly added function in the Functions list To see your newly created function in Designer: In Designer, double click an object in the Universe pane. An edit properties dialog box appears for the object. Click the >> button to the left of the Select or Where edit boxes. The following dialog box appears:

Function TYPE=A

Function SQL=($A,$D)

Informix Data Access

Data Access Guide

109

To see your newly created function in BusinessObjects: In BusinessObjects, create a report. In the Query Panel, click User Objects. The User Objects dialog appears. Click Add.
:

Function HELP= Function TRAD= Function TYPE=A

Function Example

Each argument is checked on input to ensure the input matches the datatype indicated in the function. For example, if a function is specified as a DATE format, the user must enter a date format. WebIntelligence parameter file The informix.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions You should use an XML editor to view and modify this file.

Optimizing data access performance

110

Data Access Guide

Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation> </DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes.

Informix Data Access

Data Access Guide

111

The available <Operator> attributes are: Arity Type, possible values: Numeric, Char, String, DateTime, Logical or All ID: identifier of the operator
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the informix.prm XML file on page 113. If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.

Optimizing data access performance

112

Data Access Guide

EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

Informix Data Access

Data Access Guide

113

Adding a function to the informix.prm XML file You must add your function to the BusinessObjects informix.prm file before completing this procedure. For more information, see Adding a function to the informix.prm file on page 106. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\informix\informix.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in BusinessObjects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects. This is optional in this file. Displays the type of function: String Numeric Char DateTime Logical All

5. In the <Arguments> section, include any arguments for your function. Each

Optimizing data access performance

114

Data Access Guide

argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the informix.prm file.

Informix Data Access

Data Access Guide

115

The following is an example of a function for WebIntelligence:


<Function Group="False" ID="Example" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> </Arguments> <SQL>example($A,$D)</SQL> </Function>

Modifying the data access configuration file


The informix.sbo file is the data access configuration file. It contains all the default connection parameters. When you change the data access configuration file, all parameter default values are changed for new connections. All connections made after the parameter values are changed use those parameter values as default values. You can find the informix.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products at the following location:
<BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\legacy\informix

You can find the informix.sbo file for WebIntelligence at the following location:
<BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\informix NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For more information on data access configuration parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Optimizing data access performance

116

Data Access Guide

Modifying an external strategy file


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe. When you purchase an Informix Access Pack, you are provided with an external strategy file which is located by default at:
<BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\legacy\informix\informixEN.txt

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide.

Informix Data Access

Data Access Guide

117

Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP]. STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure In the preceding example, the strategy is a JOIN type:
TYPE=JOIN

SQL subsection This subsection contains the SQL statements that enable a universe designer to create classes and objects, joins, or table structure. HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe. Creating an external strategy file If you want to create an external strategy file, copy the strategy file, such as informixen.txt, from the Informix subfolder. To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type. For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy. For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy.For

Optimizing data access performance

118

Data Access Guide

example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example: example.txt. Declaring an External Strategy File Once you have created an external strategy file, you must declare it to force Designer to use it. To declare an external strategy file: 1. Open the informixEN.prm file with a text editor. The informixen.prm file is located by default at:
<BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\legacy\informix\informixEN.prm

2. Scroll to the STG= parameter. 3. Enter the name of the external strategy file. For example: STG=example. You must enter the name of the stdriver.txt file without its extension and path. Since you do not enter a path, the stdriver.txt file must be located in the same folder as the syb10en.prm file.

Modifying the driverEN.sbo and driverEN.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driveren.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg and driver.cfg files are XML files containing the equivalent driver information relevant to WebIntelligence.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\driveren.sbo

The driveren.sbo and driver.sbo XML files for WebIntelligence are here:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg

Informix Data Access

Data Access Guide

119

NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file. The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer
NOTE

This file contains the name of the network layer and its description. Do not change the key name. This key name matches one in your Windows registry, if it is modified, you could experience problems with your computer. Alias Section This section displays a list of Business Objects 5.x Data Access drivers and their compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears in the Windows system registry the Data Access driver for Business Objects 6 compatible driver. Each driver is listed by registry key name without underscore characters

Optimizing data access performance

120

Data Access Guide

The driveren.cfg and driver.cfg file The driveren.cfg and driver.cfg files for WebIntelligence contain the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for Informix:
<NetworkLayer Name="Informix CLI"> <Message id="Comment">Allows you to access an Informix Dynamic Server database</Message> <Message id="Name">Informix ODBC Driver</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 119.

Informix Data Access

Data Access Guide

121

Informix datatype conversion


The Business Objects product interface supports four datatypes: date character number long text. The following table lists the Informix internal datatypes and their equivalent in Business Objects products:
Informix Datatype Suggested BusinessObjects Datatype

CHAR DATE DATETIME DECIMAL FLOAT INTEGER MONEY NCHAR NVARCHAR SERIAL SMALLINT SMALLFLOAT TEXT VARCHAR

CHARACTER DATE DATE NUMBER NUMBER NUMBER NUMBER CHARACTER CHARACTER NUMBER NUMBER NUMBER LONG TEXT CHARACTER

Informix datatype conversion

122

Data Access Guide

Informix Data Access

Microsoft Data Access

chapter

124

Data Access Guide

Overview
This chapter provides information about Microsoft-specific connections, including: Optimizing data access performance Stored procedures Microsoft datatype conversion For information on creating a connection to access a Microsoft database on Windows, see the chapter Creating a Connection to a Database on Windows.

Microsoft Data Access

Data Access Guide

125

Connecting to Business Objects products with Microsoft products


The following operating systems and Microsoft products are supported for connection: For information on how to configure your middleware, refer to your Microsoft documentation. Microsoft product Microsoft SQL Server 2000 Middleware ODBC 2000

Connecting to Business Objects products with Microsoft products

126

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install the Microsoft Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name driver.prm XML format) driveren.prm (text format) driveren.prm (XML format) odbc.sbo Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information see Modifying the ODBC parameter files on page 126. Contains information about each SQL function used in the driver.prm. This file contains the default connection parameters. For more information, see Modifying the data access configuration file on page 136. This file contains the description of all Data Access drivers, and a Data Access driver alias section. For more information, see Modifying the driverEN.sbo and driverEN.cfg files on page 139.

driveren.sbo

Modifying the ODBC parameter files


The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\odbc WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\odbc

When you modify a connection parameter for WebIntelligence, you need to modify the parameter files in both odbc directories.

Microsoft Data Access

Data Access Guide

127

When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\odbc directory. You can add SQL functions or modify existing parameters in the odbc.prm file to optimize your connection. There are two odbc.prm files: Oracle parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both oracle.prm files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc\driver.prm The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the driver.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle\driver.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\oracle\driver.prm If you use WebIntelligence, you must modify both driver.prm files every time you make a change to one file. The driver.prm file is declared in the odbc.sbo file in the following parameter:
SQL Parameter File=

Optimizing data access performance

128

Data Access Guide

General parameter file The driveren.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS The RDBMS section contains all the parameters needed for SQL generation. It may include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and so on. Most of the configuration applied to each parameter should not be modified since the settings enable Business Objects products to generate SQL. If you change the settings, this may generate errors. For information about each parameter, see Data Access Parameter File Reference on page 241. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. The DATE SQL syntax is used for the Automatic Time Hierarchy feature in Designer and BusinessObjects. OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition in BusinessObjects. FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects. For information on creating functions, see Adding a function to the driveren.prm file on page 130.

Microsoft Data Access

Data Access Guide

129

Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the driveren.prm file. A function has the following structure:
Function Parameter Description

Order in which the function appears in the driveren.prm file. The value n starts at 0. Each function number should be unique.

NAME= function name Displays the name of the function as it appears in BusinessObjects. TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text TYPE=A Function help text that appears in Designer and BusinessObjects. Displays the type of function: A=alphanumeric N=numeric D=date

Optimizing data access performance

130

Data Access Guide

Function Parameter

Description

IN_MACRO=Y GROUP=Y SQL=SQL function name($A,$N)

Indicates whether the function should appear in BusinessObjects. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric) $N (numeric) $D (date) $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

Adding a function to the driveren.prm file Business Objects provides a list of SQL functions in the driveren.prm file. You may add functions to this list. To do so: 1. Open the driveren.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD= parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an

Microsoft Data Access

Data Access Guide

131

aggregate function or N if the fucntion is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file on page 135. The following is an example of a newly created function:
(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Optimizing data access performance

132

Data Access Guide

WebIntelligence parameter file The driveren.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation>

Microsoft Data Access

Data Access Guide

133

</DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes. The available <Operator> attributes are: Arity Type, possible values : Numeric, Char, String, DateTime, Logical or All ID : identifier of the operator
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBSTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the driveren.prm XML file on page 135.

Optimizing data access performance

134

Data Access Guide

If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.
EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

Microsoft Data Access

Data Access Guide

135

Adding a function to the driveren.prm XML file You must add your function to the BusinessObjects driveren.prm file before completing this procedure. For more information, see Adding a function to the driveren.prm file on page 130. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\ODBC\driveren.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in BusinessObjects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects Displays the type of function: String Numeric DateTime

5. In the <Arguments> section, include any arguments for your function. Each argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the driveren.prm file.

Optimizing data access performance

136

Data Access Guide

Modifying the data access configuration file


The data access configuration file, the odbc.sbo file, contains the default connection properties. If you want to change the data access configuration files, all parameter default values are changed. All connections made after the parameter values are changed use those parameter values as default values. You can find the odbc.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc

You can find the odbc.sbo file for WebIntelligence at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\odbc NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For more information on data access configuration parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Modifying an external strategy file


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe.


NOTE

An external strategy file for ODBC data access is not shipped with this version of Business Objects products. If you have licences for other data access drivers, you can create an external strategy file by using an external strategy text file shipped with another data access driver. If you need to create an external strategy file from scratch, refer to the Designers Guide for instructions on creating and using external strategy files.

Microsoft Data Access

Data Access Guide

137

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide. Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP]. STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure SQL subsection This subsection contains the SQL statements that enables a universe designer to create classes and objects, joins, or table structure. HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe. Creating an External Strategy File To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type.For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy.For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy.For example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example:
microsften.txt

Optimizing data access performance

138

Data Access Guide

Declaring an external strategy file Once you create an external strategy file, you have to declare it in order for Designer to use it. To declare an external strategy file: 1. Open the driveren.prm file with a text editor. The driveren.prm file is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\odbc

2. Scroll to the STG= parameter. 3. Enter the name of the external strategy file. For example: STG=example. You must enter the name of the stdriver.txt file without its extension and path. Since you do not enter a path, the stdriver.txt file must be located in the same folder as the driveren.prm file.
EXAMPLE The following is an example of a strategy file: [STRATEGY] TYPE=OBJECT NAME=Candidate Objects Strategy [SQL] SQL=SELECT col1_list FROM table1 WHERE condition; [HELP] HELP=This strategy creates a list of candidate objects

Microsoft Data Access

Data Access Guide

139

Modifying the driverEN.sbo and driverEN.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driveren.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg file is an XML file containing the driver information relevant to WebIntelligence only.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\driverEN.sbo

The driveren.sbo file for WebIntelligence is an XML file at:


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file. The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer

Optimizing data access performance

140

Data Access Guide

For example, the Microsoft entry is displayed below:


ODBC= ODBC Drivers,Allows you to access various databases

ODBC ODBC Drivers Allows you to access various databases Alias Section

the key name for ODBC the name of the network layer the description of the network layer

This section displays a list of Business Objects 5.x Data Access drivers and compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears in the Windows system registry the Data Access driver for Business Objects 6.x compatible driver. Each driver is listed by registry key name without underscore characters The driveren.cfg file The driveren.cfg file for WebIntelligence contains the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for Microsoft:
<NetworkLayer Name="ODBC"> <Message id="Comment">Allows you to access various databases</Message> <Message id="Name">ODBC Drivers</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 139.
NOTE

It is not recommended that you modify these files.

Microsoft Data Access

Data Access Guide

141

Stored procedures
Business Objects supports the following type of Microsoft SQL Server stored procedures: all stored procedures without an OUTPUT parameter. This includes stored procedures that return values through the RETURN command. all stored procedures and user defined functions whose owner is the database user specified in the connection string (SUSER_SNAME) all stored procedures and user-defined functions which are granted public access all stored procedures and user defined functions whose access has been granted to the user specified in the connection string (SUSER_SNAME)
EXAMPLE Simple stored procedures

Stored procedures such as the following examples are supported in Business Objects products:
CREATE PROCEDURE get_sales_for_title @title varchar(80) -- This is the input parameter. AS -- Get the sales for the specified title. SELECT "YTD_SALES" = ytd_sales FROM titles WHERE title = @title CREATE PROCEDURE my_proc @first int = NULL, -- NULL default value @second int = 2, -- Default value of 2 @third int = 3 -- Default value of 3 AS -- Display values SELECT @first, @second, @third

Stored procedures

142

Data Access Guide

The execution of the following stored procedures is not supported: Any stored procedure having an OUTPUT parameter Any stored procedure that returns data through a cursor (global or parameter) Functions Any stored procedure whose name or parameter name does not follow the rules for regular identifiers

Microsoft Data Access

Data Access Guide

143

Microsoft datatype conversion


Business Objects supports Microsoft SQL Server. The BusinessObjects interface supports four datatypes: date character number long text

Microsoft SQL Server


The following table lists the Microsoft SQL Server internal datatypes and their BusinessObjects equivalent
Microsoft SQL Server Datatype Business Objects Suggested Datatype

BIT BOOLEAN CHAR DATETIME DECIMAL FLOAT INT MONEY NUMERIC REAL SMALLDATETIME SMALLINT SMALLMONEY TEXT TINYINT VARCHAR

NUMBER NUMBER CHARACTER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER CHARACTER NUMBER CHARACTER

Microsoft datatype conversion

144

Data Access Guide

Microsoft Data Access

Oracle Data Access

chapter

146

Data Access Guide

Overview
This chapter provides information about Oracle-specific connections, including: Optimizing data access performance Configuring the Oracle server Oracle datatype conversion For information on creating a connection to access an Oracle database on Windows, see the chapter Creating a Connection to a Database on Windows. For information on creating connections to access an Oracle database on UNIX, see the chapter Creating a Connection to a Database on UNIX.

Oracle Data Access

Data Access Guide

147

Connecting to Business Objects products with Oracle


The following operating systems and Oracle releases are supported for connection: Oracle Release Oracle 8i Oracle 9i Middleware Net8 Client 8.1.7 Net9

Connecting to Business Objects products with Oracle

148

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install the Oracle Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name oracle.prm (XML format) oracleen.prm (text format) oracleen.prm (XML format) Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information, see Modifying the Oracle parameter files on page 149. Contains information about each SQL function used in the oracle.prm

oracle.stg (XML format) Contains external strategy definitions based on SQL. For more information, see Modifying an external oracleen.txt (text strategy file on page 162. format) oracleen.stg oracle.sbo Contains information about the external strategies used in oracle.stg Contains the default connection properties. For more information, see Modifying the data access configuration file on page 161.

The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\oracle WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\oracle

When you modify a connection parameter for WebIntelligence, you need to also modify the parameter files in both oracle directories.

Oracle Data Access

Data Access Guide

149

When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\oracle directory.

Modifying the Oracle parameter files


You can add SQL functions or modify existing parameters in the oracle.prm file to optimize your connection. There are two oracle.prm files: Oracle parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both oracle.prm files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle\oracle.prm The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the oracle.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle\oracle.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\oracle\oracle.prm If you use WebIntelligence, you must modify both oracle.prm files every time you make a change to one file. The driver.prm file is declared in the oracle.sbo file in the following parameter:
SQL Parameter File=

Optimizing data access performance

150

Data Access Guide

General parameter file The oracle.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS The RDBMS section contains all the parameters needed for SQL generation. It may include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and so on.
NOTE

Business Objects recommends that you only add parameters. If you must modify a parameter, exercise caution as the parameter settings enable Business Objects products to create SQL. If you modify the settings, the modified parameters could generate errors. Do not remove parameters. For a description of each Oracle parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. The DATE SQL syntax is used for the Automatic Time Hierarchy feature in Designer and BusinessObjects. For a description of each Oracle parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition in BusinessObjects. For a description of each Oracle parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information.

Oracle Data Access

Data Access Guide

151

FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects. For information on creating functions, see Adding a function to the oracle.prm file on page 152. The oracle.prm file for WebIntelligence is an XML file. Do not move this file as it is dependent on a DTD file for syntax. For more information on including functions in WebIntelligence, see Adding a function to the oracle.prm XML file on page 159. Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the oracle.prm file. A function has the following structure:
SQL parameters Description

Order in which the function appears in the oracle.prm file. The value n starts at 0. Each function number should be unique.

NAME= function name Displays the name of the function as it appears in BusinessObjects. TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text TYPE=A Function help text that appears in Designer and BusinessObjects. Displays the type of function: A=alphanumeric N=numeric D=date

Optimizing data access performance

152

Data Access Guide

SQL parameters

Description

IN_MACRO=Y GROUP=Y SQL=SQL function name($A,$N)

Indicates whether the function should appear in BusinessObjects. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric) $N (numeric) $D (date) $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

Adding a function to the oracle.prm file Business Objects provides a list of SQL functions in the oracle.prm file. You may add functions to this list. To add a function to the oracle.prm file: 1. Open the oracle.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD= parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an

Oracle Data Access

Data Access Guide

153

aggregate function or N if the function is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the oracle.prm XML file on page 159.

Optimizing data access performance

154

Data Access Guide

The following is an example of a newly created function:


(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Viewing a newly added function in the Functions list To see your newly created function in Designer: In Designer, double click an object in the Universe pane. An edit properties dialog box appears for the object. Click the >> button to the left of the Select or Where edit boxes. The following dialog box appears:

Function TYPE=A

Function SQL=($A,$D)

Oracle Data Access

Data Access Guide

155

To see your newly created function in BusinessObjects: In BusinessObjects, create a report. In the Query Panel, click User Objects. The User Objects dialog appears. Click Add.
:

Function HELP= Function TRAD= Function TYPE=A

Function Example

Each argument is checked on input to ensure the input matches the datatype indicated in the function. For example, if a function is specified as a DATE format, the user must enter a date format. WebIntelligence parameter file The oracle.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions You should use an XML editor to view and modify this file.

Optimizing data access performance

156

Data Access Guide

Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation> </DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes.

Oracle Data Access

Data Access Guide

157

The available <Operator> attributes are: Arity Type, possible values: Numeric, Char, String, DateTime, Logical or All ID: identifier of the operator
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the oracle.prm XML file on page 159. If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.

Optimizing data access performance

158

Data Access Guide

EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

Oracle Data Access

Data Access Guide

159

Adding a function to the oracle.prm XML file You must add your function to the BusinessObjects oracle.prm file before completing this procedure. For more information, see Adding a function to the oracle.prm file on page 152. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\oracle\oracle.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in BusinessObjects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects. This is optional in this file. Displays the type of function: String Numeric Char DateTime Logical All

5. In the <Arguments> section, include any arguments for your function. Each

Optimizing data access performance

160

Data Access Guide

argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the oracle.prm file.

Oracle Data Access

Data Access Guide

161

The following is an example of a function for WebIntelligence:


<Function Group="False" ID="Example" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> </Arguments> <SQL>example($A,$D)</SQL> </Function>

Modifying the data access configuration file


The oracle.sbo file is the data access configuration file. It contains all the default connection parameters. When you change the data access configuration file, all parameter default values are changed for new connections. All connections made after the parameter values are changed use those parameter values as default values. You can find the oracle.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle

You can find the oracle.sbo file for WebIntelligence at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\oracle NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For more information on data access configuration parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Optimizing data access performance

162

Data Access Guide

Modifying an external strategy file


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe. When you purchase an Oracle Access Pack, you are provided with an external strategy file which is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle\oracleEN.txt

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide.

Oracle Data Access

Data Access Guide

163

Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP].
EXAMPLE Here is a section of the oracleen.txt file: [STRATEGY] TYPE=OBJECT NAME= External Strategy: Classes and Objects [SQL] SQL=SELECT U1.table_name,'|', U1.column_name,'|', translate(initcap(U1.table_name),'_',' '),'|', translate(initcap(U1.column_name),'_',' '),'|', U1.table_name||'.'||U1.column_name,'|', ' ','|', decode(SUBSTR(U1.DATA_TYPE,1,1),'N','N','F','N','D','D','C'),' |', SUBSTR(U2.comments,1,474),'|', 'O','|' FROM USER_TAB_COLUMNS U1,USER_COL_COMMENTS U2 WHERE U1.table_name=U2.table_name and U1.column_name=U2.column_name UNION SELECT S.SYNONYM_NAME,'|', U1.column_name,'|', translate(initcap(S.SYNONYM_NAME),'_',' '),'|', translate(initcap(U1.column_name),'_',' '),'|', S.SYNONYM_NAME||'.'||U1.column_name,'|', ' ','|', decode(SUBSTR(U1.DATA_TYPE,1,1),'N','N','F','N','D','D','C'),' |', SUBSTR(U2.comments,1,474),'|',

Optimizing data access performance

164

Data Access Guide

'O','|' FROM ALL_TAB_COLUMNS U1, ALL_COL_COMMENTS U2, ALL_OBJECTS O, USER_SYNONYMS S WHERE S.table_owner=O.owner AND S.table_name=O.object_name AND (O.OBJECT_TYPE='TABLE' OR O.OBJECT_TYPE='VIEW') AND O.owner=U1.owner AND O.object_name=U1.table_name AND U1.owner=U2.owner AND U1.table_name=U2.table_name AND U1.column_name=U2.column_name ; [HELP] HELP= This strategy reads the database structure. It associates tables with classes as well as columns with objects.

STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure In the preceding example, the strategy is a JOIN type:
TYPE=JOIN

SQL subsection This subsection contains the SQL statements that enable a universe designer to create classes and objects, joins, or table structure. HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe.

Oracle Data Access

Data Access Guide

165

Creating an external strategy file If you want to create an external strategy file, copy the strategy file, such as oracleen.txt, from the Oracle subfolder. To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type. For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy. For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy.For example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example: example.txt.

Modifying the driverEN.sbo and driverEN.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driveren.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg and driver.cfg files are XML files containing the equivalent driver information relevant to WebIntelligence.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\driveren.sbo

The driveren.sbo and driver.sbo XML files for WebIntelligence are here:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg

Optimizing data access performance

166

Data Access Guide

NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file. The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer For example, the Oracle entry is displayed below:
Oracle_OCI=Oracle Client,Allows you to access Oracle 8.x and Oracle 9.x servers

Oracle_OCI
Oracle Client Allows you to access Oracle 8.x and Oracle 9.x servers

the key name for Net8 and Net9 the name of the network layer the description of the network layer

Oracle Data Access

Data Access Guide

167

The following illustration displays each element of the entry in BusinessObjects:

a. The registry entry b. The name of the network layer c. The network layer description

Optimizing data access performance

168

Data Access Guide

This file contains the name of the network layer and its description. Do not change the key name. This key name matches one in your Windows registry, if it is modified, you could experience problems with your computer. Alias Section This section displays a list of Business Objects 5.x Data Access drivers and their compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears in the Windows system registry the Data Access driver for Business Objects 6 compatible driver. Each driver is listed by registry key name without underscore characters For example, below you have the Oracle 8i registry entry for Business Objects 5.x and the Business Objects 6 compatible Data Access driver:
Oracle_8=Oracle OCI

Oracle_8 Oracle OCI

the key name of the Oracle Data Access Driver for Business Objects 5.x the key name of the Data Access driver for Business Objects 6

The driveren.cfg and driver.cfg file The driveren.cfg and driver.cfg files for WebIntelligence contain the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for Oracle:
<NetworkLayer Name="Oracle OCI"> <Message id="Comment">Allows you to access Oracle 8.x and Oracle 9.x servers</Message> <Message id="Name">Oracle Client</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 166.
NOTE

It is not recommended that you modify these files.

Oracle Data Access

Data Access Guide

169

Configuring the Oracle server


Overview
This section covers how to configure your server to allow your users to access Oracle stored procedures.

Accessing stored procedures


NOTE

Modifying and setting up access to stored procedures are advanced user tasks; this section is for database administrators. To let your users access stored procedures in BusinessObjects, implement the following steps before they create connections: 1. Create a cursor inside a package. See Creating a Cursor inside a Package on page 170 for more information. 2. Create the stored procedures using the defined cursor. See Creating a Stored Procedure on page 170 for more information. Both steps are done using an Oracle procedural language called Procedural Language/Standard Query Language (PL/SQL). Supported Stored Procedures Business Objects products support the following stored procedures: Any PL/SQL procedures that return result sets through a REF Cursor. PL/SQL stored procedures that have at least one IN/OUT REF cursor variable parameter and no OUT or IN/OUT parameter. Unsupported Stored Procedures The following stored procedures are not supported by Business Objects products: Any PL/SQL procedure that does not return result sets through a REF CURSOR parameter Any PL/SQL procedures having at least one OUT parameter Any PL/SQL function Any PL/SQL procedure having one IN/OUT parameter of a type different than a REF CURSOR, for example, VARRAY Any PL/SQL Table function

Configuring the Oracle server

170

Data Access Guide

Ensure that your stored procedures are Business Objects-compatible. Creating a Cursor inside a Package A package is a database object that contains related PL/SQL types, objects, and subprograms. To create a package, you can use the following statement:
CREATE or REPLACE PACKAGE catalog_data AS TYPE CatCurTyp IS REF CURSOR RETURN all_objects%ROWTYPE; END catalog_data;

Creating a Stored Procedure Stored procedures are sets of PL/SQL statements grouped together to perform a specific task.
NOTE

In BusinessObjects, you can only access standalone procedures. To create a stored procedure on your database, use the following statement:
CREATE or REPLACE PROCEDURE get_allobjects(cat_cv IN OUT catalog_data.catcurtyp) AS BEGIN OPEN cat_cv FOR SELECT * FROM all_objects; END;

or, if you want to include several parameters:


CREATE or REPLACE PROCEDURE get_ownerobjects(owner_name IN varchar2, cat_cv IN OUT catalog_data.catcurtyp) AS BEGIN OPEN cat_cv FOR SELECT * FROM all_objects WHERE owner=owner_name; END;

In both statements, use catcurtyp cursor that you previously created in the package. In the examples, catalog_data.catcurtyp is used. See your Oracle documentation for more information on how to create packages and stored procedures.

Oracle Data Access

Data Access Guide

171

Accessing the Stored Procedure from BusinessObjects After creating a stored procedure, see Creating a connection for stored procedures or WebIntelligence auditing on page 34 for information on connecting to your stored procedure. For information on how to create a report using stored procedures, see the BusinessObjects Users Guide.
EXAMPLE Packaged stored procedures and standalone stored procedures

The following is a packaged declaration, it is not supported by Business Objects:


CREATE or REPLACE PACKAGE pac2 AS TYPE curtyp IS REF CURSOR RETURN GUEST%ROWTYPE; PROCEDURE pproc(cat_cv IN OUT curtyp); END pac2;

The following is a standalone stored procedure, it is supported by Business Objects:


CREATE or REPLACE PACKAGE pac1 AS TYPE curtyp IS REF CURSOR RETURN GUEST%ROWTYPE; END pac1;

You need the Package definition at least to create the cursor type.

Configuring the Oracle server

172

Data Access Guide

Oracle datatype conversion


Business Objects products support four datatypes: date character number long text The following table lists the Oracle internal datatypes and their equivalent in Business Objects products:
Oracle Datatype BusinessObjects Suggested Datatype

CHAR DATE FLOAT INTEGER LONG NUMBER VARCHAR VARCHAR2 * indicates Oracle 9i datatype

CHARACTER DATE NUMBER NUMBER LONG TEXT NUMBER CHARACTER CHARACTER

Oracle Data Access

Red Brick Data Access

chapter

174

Data Access Guide

Overview
This chapter provides information about Red Brick-specific connections, including: Optimizing data access performance Red Brick datatype conversion For information on creating a connection to access a Microsoft database on Windows, see the chapter Creating a Connection to a Database on Windows.

Red Brick Data Access

Data Access Guide

175

Connecting to Business Objects products with Red Brick


The following operating systems and Red Brick products are supported for connection: Red Brick product IBM Red Brick Decision Server Middleware IBM Red Brick ODBC

For information on how to configure your middleware, refer to your Red Brick documentation
NOTE

You cannot create a repository on Red Brick Decision Server. To create a repository, you must access a repository enabled RDBMS, for example Oracle, IBM DB2, Sybase, Informix, MS SQL Server or Teradata.

Connecting to Business Objects products with Red Brick

176

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install the Red Brick ODBC Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name driver.prm XML format) driveren.prm (text format) driveren.prm (XML format) odbc.sbo Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information see Modifying the Red Brick ODBC parameter files on page 176. Contains information about each SQL function used in the driver.prm. This file contains the default connection parameters. For more information, see Modifying the data access configuration file on page 186. This file contains the description of all Data Access drivers, and a Data Access driver alias section. For more information, see Modifying the driverEN.sbo and driverEN.cfg files on page 189.

driveren.sbo

Modifying the Red Brick ODBC parameter files


The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\odbc WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\odbc

When you modify a connection parameter for WebIntelligence, you need to modify the parameter files in both odbc directories.

Red Brick Data Access

Data Access Guide

177

When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\odbc directory. You can add SQL functions or modify existing parameters in the odbc.prm file to optimize your connection. There are two odbc.prm files: Oracle parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both Red Brick ODBC parameter files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc\driver.prm The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the driver.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle\driver.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\oracle\driver.prm If you use WebIntelligence, you must modify both driver.prm files every time you make a change to one file. The driver.prm file is declared in the odbc.sbo file in the following parameter:
SQL Parameter File=

Optimizing data access performance

178

Data Access Guide

General parameter file The driveren.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS The RDBMS section contains all the parameters needed for SQL generation. It may include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and so on. Most of the configuration applied to each parameter should not be modified since the settings enable Business Objects products to generate SQL. If you change the settings, this may generate errors. For information about each parameter, see Data Access Parameter File Reference on page 241. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. The DATE SQL syntax is used for the Automatic Time Hierarchy feature in Designer and BusinessObjects. OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition in BusinessObjects. FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects. For information on creating functions, see Adding a function to the driveren.prm file on page 180.

Red Brick Data Access

Data Access Guide

179

Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the driveren.prm file. A function has the following structure:
Function Parameter Description

Order in which the function appears in the driveren.prm file. The value n starts at 0. Each function number should be unique.

NAME= function name Displays the name of the function as it appears in BusinessObjects. TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text TYPE=A Function help text that appears in Designer and BusinessObjects. Displays the type of function: A=alphanumeric N=numeric D=date

Optimizing data access performance

180

Data Access Guide

Function Parameter

Description

IN_MACRO=Y GROUP=Y SQL=SQL function name($A,$N)

Indicates whether the function should appear in BusinessObjects. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric) $N (numeric) $D (date) $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

Adding a function to the driveren.prm file Business Objects provides a list of SQL functions in the driveren.prm file. You may add functions to this list. To do so: 1. Open the driveren.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD= parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an

Red Brick Data Access

Data Access Guide

181

aggregate function or N if the fucntion is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file on page 185. The following is an example of a newly created function:
(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Optimizing data access performance

182

Data Access Guide

WebIntelligence parameter file The driveren.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation>

Red Brick Data Access

Data Access Guide

183

</DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes. The available <Operator> attributes are: Arity Type, possible values : Numeric, Char, String, DateTime, Logical or All ID : identifier of the operator
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBSTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the driveren.prm XML file on page 185.

Optimizing data access performance

184

Data Access Guide

If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.
EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

Red Brick Data Access

Data Access Guide

185

Adding a function to the driveren.prm XML file You must add your function to the BusinessObjects driveren.prm file before completing this procedure. For more information, see Adding a function to the driveren.prm file on page 180. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\ODBC\driveren.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in BusinessObjects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects Displays the type of function: String Numeric DateTime

5. In the <Arguments> section, include any arguments for your function. Each argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the driveren.prm file.

Optimizing data access performance

186

Data Access Guide

Modifying the data access configuration file


The data access configuration file, the odbc.sbo file, contains the default connection properties. If you want to change the data access configuration files, all parameter default values are changed. All connections made after the parameter values are changed use those parameter values as default values. You can find the odbc.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc

You can find the odbc.sbo file for WebIntelligence at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\odbc NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For more information on data access configuration parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Modifying an external strategy file


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe.


NOTE

An external strategy file for ODBC data access is not shipped with this version of Business Objects products. If you have licences for other data access drivers, you can create an external strategy file by using an external strategy text file shipped with another data access driver. If you need to create an external strategy file from scratch, refer to the Designers Guide for instructions on creating and using external strategy files.

Red Brick Data Access

Data Access Guide

187

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide. Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP]. STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure SQL subsection This subsection contains the SQL statements that enables a universe designer to create classes and objects, joins, or table structure. HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe. Creating an External Strategy File To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type.For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy.For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy.For example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example:
microsften.txt

Optimizing data access performance

188

Data Access Guide

Declaring an external strategy file Once you create an external strategy file, you have to declare it in order for Designer to use it. To declare an external strategy file: 1. Open the driveren.prm file with a text editor. The driveren.prm file is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\odbc

2. Scroll to the STG= parameter. 3. Enter the name of the external strategy file. For example: STG=example. You must enter the name of the stdriver.txt file without its extension and path. Since you do not enter a path, the stdriver.txt file must be located in the same folder as the driveren.prm file.
EXAMPLE The following is an example of a strategy file: [STRATEGY] TYPE=OBJECT NAME=Candidate Objects Strategy [SQL] SQL=SELECT col1_list FROM table1 WHERE condition; [HELP] HELP=This strategy creates a list of candidate objects

Red Brick Data Access

Data Access Guide

189

Modifying the driverEN.sbo and driverEN.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driveren.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg file is an XML file containing the driver information relevant to WebIntelligence only.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\driverEN.sbo

The driveren.sbo file for WebIntelligence is an XML file at:


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file. The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer

Optimizing data access performance

190

Data Access Guide

For example, the Microsoft entry is displayed below:


ODBC= ODBC Drivers,Allows you to access various databases

ODBC ODBC Drivers Allows you to access various databases

the key name for ODBC the name of the network layer the description of the network layer

This file containts the name of the network layer and its description. Do not change the key name. This key name matches one in your Windows registry, if it is modified, you could experience problems with your computer. Alias Section This section displays a list of Business Objects 5.x Data Access drivers and compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears in the Windows system registry the Data Access driver for Business Objects 6.x compatible driver. Each driver is listed by registry key name without underscore characters The driveren.cfg file The driveren.cfg file for WebIntelligence contains the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for Microsoft:
<NetworkLayer Name="ODBC"> <Message id="Comment">Allows you to access various databases</Message> <Message id="Name">ODBC Drivers</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 189.
NOTE

It is not recommended that you modify these files.

Red Brick Data Access

Data Access Guide

191

Red Brick datatype conversion


The BusinessObjects interface supports four datatypes: date character number long text

Red Brick
The following table lists the Red Brick internal datatypes and their BusinessObjects equivalent
Red Brick datatype Business Objects Suggested Datatype

CHAR DATE DECIMAL FLOAT INTEGER NUMERIC SMALLINT TIME TIMESTAMP

CHARACTER DATE NUMBER NUMBER NUMBER NUMBER NUMBER CHARACTER DATE

Red Brick datatype conversion

192

Data Access Guide

Red Brick Data Access

Sybase Data Access

chapter

194

Data Access Guide

Overview
This chapter provides information about sybase-specific connections, including: Optimizing data access performance Sybase datatype conversion For information on creating a connection to access an Syabse database on Windows, see the chapter Creating a Connection to a Database on Windows. For information on creating connections to access an sybase database on UNIX, see the chapter Creating a Connection to a Database on UNIX.

Sybase Data Access

Data Access Guide

195

Connecting to Business Objects products with Sybase


The following operating systems and Sybase releases are supported for connection: Sybase Release Syabse Adaptive Server Syabse ASE IQ Middleware Open Client 12.x ASIQ ODBC 7

Connecting to Business Objects products with Sybase

196

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install a Sybase Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name sybase.prm (XML format) sybaseen.prm (text format) sybaseen.prm (XML format) sybase.stg (XML format) sybaseen.txt (text format) sybaseen.stg sybase.sbo Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information, see Modifying the Sybase parameter files on page 197. Contains information about each SQL function used in the sybase.prm Contains external strategy definitions based on SQL. For more information, see Modifying an external strategy file on page 210. Contains information about the external strategies used in sybase.stg Contains the default connection properties. For more information, see Modifying the data access configuration file on page 209.

The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\sybase WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\sybase

Sybase Data Access

Data Access Guide

197

When you modify a connection parameter for WebIntelligence, you need to also modify the parameter files in both sybase directories. When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\sybase directory.

Modifying the Sybase parameter files


You can add SQL functions or modify existing parameters in the sybase.prm file to optimize your connection. There are two sybase.prm files: Sybase parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both sybase.prm files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase\sybase.prm The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the sybase.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase\sybase.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\sybase\sybase.prm If you use WebIntelligence, you must modify both sybase.prm files every time you make a change to one file.

Optimizing data access performance

198

Data Access Guide

The driver.prm file is declared in the sybase.sbo file in the following parameter:
SQL Parameter File=

General parameter file The sybase.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS The RDBMS section contains all the parameters needed for SQL generation. It may include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and so on.
NOTE

Business Objects recommends that you only add parameters. If you must modify a parameter, exercise caution as the parameter settings enable Business Objects products to create SQL. If you modify the settings, the modified parameters could generate errors. Do not remove parameters. For a description of each Sybase parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. The DATE SQL syntax is used for the Automatic Time Hierarchy feature in Designer and BusinessObjects. For a description of each Sybase parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition in BusinessObjects.

Sybase Data Access

Data Access Guide

199

For a description of each Sybase parameter, see Data Access Parameter File Reference on page 241. If you are using WebIntelligence, also see Functions on page 321 for more information. FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects. For information on creating functions, see Adding a function to the sybase.prm file on page 200. The sybase.prm file for WebIntelligence is an XML file. Do not move this file as it is dependent on a DTD file for syntax. For more information on including functions in WebIntelligence, see Adding a function to the sybase.prm XML file on page 207. Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the sybase.prm file. A function has the following structure:
SQL parameters Description

Order in which the function appears in the sybase.prm file. The value n starts at 0. Each function number should be unique.

NAME= function name Displays the name of the function as it appears in BusinessObjects. TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text Function help text that appears in Designer and BusinessObjects.

Optimizing data access performance

200

Data Access Guide

SQL parameters

Description

TYPE=A

Displays the type of function: A=alphanumeric N=numeric D=date

IN_MACRO=Y GROUP=Y SQL=SQL function name($A,$N)

Indicates whether the function should appear in BusinessObjects. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric) $N (numeric) $D (date) $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

Adding a function to the sybase.prm file Business Objects provides a list of SQL functions in the sybase.prm file. You may add functions to this list. To add a function to the sybase.prm file: 1. Open the sybase.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD=

Sybase Data Access

Data Access Guide

201

parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an aggregate function or N if the function is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the sybase.prm XML file on page 207.

Optimizing data access performance

202

Data Access Guide

The following is an example of a newly created function:


(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Viewing a newly added function in the Functions list To see your newly created function in Designer: In Designer, double click an object in the Universe pane. An edit properties dialog box appears for the object. Click the >> button to the left of the Select or Where edit boxes. The following dialog box appears:

Function TYPE=A

Function SQL=($A,$D)

Sybase Data Access

Data Access Guide

203

To see your newly created function in BusinessObjects: In BusinessObjects, create a report. In the Query Panel, click User Objects. The User Objects dialog appears. Click Add.
:

Function HELP= Function TRAD= Function TYPE=A

Function Example

Each argument is checked on input to ensure the input matches the datatype indicated in the function. For example, if a function is specified as a DATE format, the user must enter a date format. WebIntelligence parameter file The sybase.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions You should use an XML editor to view and modify this file.

Optimizing data access performance

204

Data Access Guide

Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation> </DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes.

Sybase Data Access

Data Access Guide

205

The available <Operator> attributes are: Arity Type, possible values: Numeric, Char, String, DateTime, Logical or All ID: identifier of the operator
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the sybase.prm XML file on page 207. If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.

Optimizing data access performance

206

Data Access Guide

EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

Sybase Data Access

Data Access Guide

207

Adding a function to the sybase.prm XML file You must add your function to the BusinessObjects sybase.prm file before completing this procedure. For more information, see Adding a function to the sybase.prm file on page 200. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\sybase\sybase.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in BusinessObjects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects. This is optional in this file. Displays the type of function: String Numeric Char DateTime Logical All

5. In the <Arguments> section, include any arguments for your function. Each

Optimizing data access performance

208

Data Access Guide

argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the sybase.prm file.

Sybase Data Access

Data Access Guide

209

The following is an example of a function for WebIntelligence:


<Function Group="False" ID="Example" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> </Arguments> <SQL>example($A,$D)</SQL> </Function>

Modifying the data access configuration file


The sybase.sbo file is the data access configuration file. It contains all the default connection parameters. When you change the data access configuration file, all parameter default values are changed for new connections. All connections made after the parameter values are changed use those parameter values as default values. You can find the sybase.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase

You can find the sybase.sbo file for WebIntelligence at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\sybase NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For more information on data access configuration parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Optimizing data access performance

210

Data Access Guide

Modifying an external strategy file


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe. When you purchase an Sybase Access Pack, you are provided with an external strategy file which is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase\sybaseEN.txt

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide.

Sybase Data Access

Data Access Guide

211

Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP]. STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure In the preceding example, the strategy is a JOIN type:
TYPE=JOIN

SQL subsection This subsection contains the SQL statements that enable a universe designer to create classes and objects, joins, or table structure. HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe. Creating an external strategy file If you want to create an external strategy file, copy the strategy file, such as sybaseen.txt, from the Sybase subfolder. To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type. For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy. For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy.For example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example: example.txt.

Optimizing data access performance

212

Data Access Guide

Declaring an External Strategy File Once you have created an external strategy file, you must declare it to force Designer to use it. To declare an external strategy file: 1. Open the sybaseEN.prm file with a text editor. The sybaseen.prm file is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase\sybaseEN.prm

2. Scroll to the STG= parameter. 3. Enter the name of the external strategy file. For example: STG=example. You must enter the name of the stdriver.txt file without its extension and path. Since you do not enter a path, the stdriver.txt file must be located in the same folder as the syb10en.prm file.

Modifying the driverEN.sbo and driverEN.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driveren.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg and driver.cfg files are XML files containing the equivalent driver information relevant to WebIntelligence.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\driveren.sbo

The driveren.sbo and driver.sbo XML files for WebIntelligence are here:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file.

Sybase Data Access

Data Access Guide

213

The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer For example, the Sybase entry is displayed below:
Sybase_CTL= Sybase Open Client,Allows you to access Sybase SQL Server 11.x, and Adaptive Server 11.x . Sybase_CTL Sybase Open Client Allows you to access Sybase SQL Server 11.x, and Adaptive Server 11.x. NOTE

Key name for Sybase Open Client. Name of the network layer. Description of the network layer

This file contains the name of the network layer and its description. Do not change the key name. This key name matches one in your Windows registry, if it is modified, you could experience problems with your computer. Alias Section (to validate) This section displays a list of Business Objects 5.x Data Access drivers and their compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears

Optimizing data access performance

214

Data Access Guide

in the Windows system registry the Data Access driver for Business Objects 6 compatible driver. Each driver is listed by registry key name without underscore characters

For example, below you have the Open Client 11 registry entry for Business Objects product release 4.1 and its Business Objects product release 5.1 compatible Data Access driver: Open_Client_11=Sybase CTL Open_Client_11 is the key name of the Open Client 11 Data Access driver for version 4.1. Sybase CTL is the key name of the Data Access driver for version 5.1.

For example, below you have the Sybase 8i registry entry for Business Objects 5.x and the Business Objects 6 compatible Data Access driver:
Sybase_8=Sybase OCI

Sybase_8 Sybase OCI

the key name of the Sybase Data Access Driver for Business Objects 5.x the key name of the Data Access driver for Business Objects 6

The driveren.cfg and driver.cfg file The driveren.cfg and driver.cfg files for WebIntelligence contain the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for Sybase:
<NetworkLayer Name="Sybase OCI"> <Message id="Comment">Allows you to access Sybase 8.x and Sybase 9.x servers</Message> <Message id="Name">Sybase Client</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 213.

Sybase Data Access

Data Access Guide

215

Sybase datatype conversion


Business Objects products support four datatypes: date character number long text The following table lists the Sybase internal datatypes and their equivalent in Business Objects products
Sybase Datatype BusinessObjects Datatype

BIT CHAR DATETIME DECIMAL FLOAT INT MONEY NUMERIC REAL SMALLDATETIME SMALLINT SMALLMONEY TINYINT VARCHAR

NUMBER CHARACTER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER CHARACTER

Sybase datatype conversion

216

Data Access Guide

Sybase Data Access

Teradata Data Access

chapter

218

Data Access Guide

Overview
This chapter provides information about Microsoft-specific connections, including: Optimizing data access performance Teradata datatype conversion For information on creating a connection to access a Teradata database on Windows, see the chapter Creating a Connection to a Database on Windows. For information on creating connections to access a Teradata database on UNIX, see the chapter Creating a Connection to a Database on UNIX.

Teradata Data Access

Data Access Guide

219

Connecting to Business Objects products with Teradata


The following operating systems and Teradata products are supported for connection: For information on how to configure your middleware, refer to your Teradata documentation. Teradata release Teradata Middleware Teradata ODBC Driver

Connecting to Business Objects products with Teradata

220

Data Access Guide

Optimizing data access performance


You can modify and add parameters to the connection parameter files to improve data access performance. This section contains information for advanced users.

Overview
When you install the Teradata Data Access driver, connection parameter files are copied to the data access folder in the BusinessObjects path. Business Objects products use these files to manage your connections. You can customize these files to optimize connections. The following connection parameter files are installed: File name driver.prm XML format) driveren.prm (text format) driveren.prm (XML format) driver.sbo Description Contain the parameters needed to create and manage your universes, and generate SQL. For more information see Modifying the Teradata parameter files on page 221. Contains information about each SQL function used in the driver.prm. This file contains the default connection parameters. For more information, see Modifying the data access configuration file on page 230. This file contains the description of all Data Access drivers, and a Data Access driver alias section. For more information, see Modifying the driverEN.sbo and driverEN.cfg files on page 235.

driveren.sbo

driver.stg (XML format)

Contains external strategy definitions based on SQL. For more information, see Modifying an external driveren.txt (text strategy file on page 230. format)

Teradata Data Access

Data Access Guide

221

Modifying the Teradata parameter files


The parameter files are installed in two separate folders:. Connection files used by... Path

All Business Objects products <BO Path>\BusinessObjects Enterprise 6\data except WebIntelligence access\RDBMS\legacy\teradata WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\teradata

When you modify a connection parameter for WebIntelligence, you need to modify the parameter files in both teradata directories. When you modify a connection parameter for all other Business Objects products you only need to modify the parameter files in the \legacy\teradata directory. You can add SQL functions or modify existing parameters in the teradata.prm file to optimize your connection. There are two terdata.prm files: Oracle parameter file General parameter file Description Contains the parameters relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products Contains the parameters relevant to WebIntelligence only.

WebIntelligence parameter file

Depending on your Business Objects products you edit either one or both teradata.prm files as follows: The connection is used by any Business Objects product except WebIntelligence If you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\teradata\driver.prm

Optimizing data access performance

222

Data Access Guide

The connection is used by WebIntelligence If you are using WebIntelligence you need to modify both the driver.prm files listed below: <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\teradata\driver.prm <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connection server\teradata\driver.prm If you use WebIntelligence, you must modify both driver.prm files every time you make a change to one file. The driver.prm file is declared in the teradata.sbo file in the following parameter:
SQL Parameter File=

General parameter file The driveren.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: RDBMS DATE OPERATORS FUNCTIONS RDBMS The RDBMS section contains all the parameters needed for SQL generation. It may include the strategy file to use for creating candidate objects and joins, parameters to prefix tables with qualifiers and/or owners, and so on. Most of the configuration applied to each parameter should not be modified since the settings enable Business Objects products to generate SQL. If you change the settings, this may generate errors. For information about each parameter, see Data Access Parameter File Reference on page 241. DATE This section defines the SQL syntax for a given date. It contains the syntax for Year, Quarter, and Month. The DATE SQL syntax is used for the Automatic Time Hierarchy feature in Designer and BusinessObjects.

Teradata Data Access

Data Access Guide

223

OPERATORS This section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition in BusinessObjects. FUNCTIONS This section defines the SQL functions with their SQL syntax. These functions appear in Designer to create universe objects or in BusinessObjects to create user objects. For information on creating functions, see Adding a function to the driveren.prm file on page 224. Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the driveren.prm file. A function has the following structure:
Function Parameter Description

Order in which the function appears in the driveren.prm file. The value n starts at 0. Each function number should be unique.

NAME= function name Displays the name of the function as it appears in BusinessObjects. TRAD= Input field1: $Input field2: Displays input field names for each argument you entered inside the parentheses of the SQL function (the SQL= parameter). These input field names appear in the User Object dialog box in BusinessObjects. Each input field name should end by a :. If you have more than one input field, from the second and onwards, you must add a $ sign in front of the input field name. HELP= Help text TYPE=A Function help text that appears in Designer and BusinessObjects. Displays the type of function: A=alphanumeric N=numeric D=date

Optimizing data access performance

224

Data Access Guide

Function Parameter

Description

IN_MACRO=Y

Indicates whether the function appears in the list of available functions when defining a user defined object. Indicates whether the function is an aggregate function. Displays a SQL function with its arguments. This function name appears in Designer. Inside the parentheses, you enter the arguments that make up the function. The possible arguments are: $A (alphanumeric) $N (numeric) $D (date) $* (all types). If the function does not contain arguments, you leave a blank inside the parentheses.

GROUP=Y SQL=SQL function name($A,$N)

Adding a function to the driveren.prm file Business Objects provides a list of SQL functions in the driveren.prm file. You may add functions to this list. To do so: 1. Open the driveren.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD= parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an

Teradata Data Access

Data Access Guide

225

aggregate function or N if the fucntion is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file on page 229. The following is an example of a newly created function:
(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Optimizing data access performance

226

Data Access Guide

WebIntelligence parameter file The driveren.prm file for WebIntelligence is an XML file divided into the following four sections: Configuration DateOperations Operators Functions Configuration This section defines parameters for SQL generation. Each parameter is defined with the tag <Parameter>. The Name attribute specifies the name of the parameter. The data included in the tag is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section defines functions related to date handling. The attribute Name is used to specify the identifier of the <DateOperation> tag.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation>

Teradata Data Access

Data Access Guide

227

</DateOperations>

Operators This section defines the operators available in the database. The operator properties are indicated with the <Operator> tag attributes. The available <Operator> attributes are: Arity Type, possible values : Numeric, Char, String, DateTime, Logical or All ID : identifier of the operator
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBSTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

Functions This section defines the functions available in the database. A function is defined with the tag <Function>. The available <Function> attributes are: Group InMacro Type Name ID For more information, see Adding a function to the driveren.prm XML file on page 229.

Optimizing data access performance

228

Data Access Guide

If the function takes one or more arguments, these arguments are described with the <Argument> tag. Currently, only attribute Type is defined. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument incremented by 1.
EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

Teradata Data Access

Data Access Guide

229

Adding a function to the driveren.prm XML file You must add your function to the BusinessObjects driveren.prm file before completing this procedure. For more information, see Adding a function to the driveren.prm file on page 224. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\teradata\driveren.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function should appear in the list of available functions when defining user defined objects. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects Displays the type of function: String Numeric DateTime

5. In the <Arguments> section, include any arguments for your function. Each

Optimizing data access performance

230

Data Access Guide

argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the driveren.prm file.

Modifying the data access configuration file


The data access configuration file, the teradata.sbo file, contains the default connection properties. If you want to change the data access configuration files, all parameter default values are changed. All connections made after the parameter values are changed use those parameter values as default values. You can find the teradata.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\teradata

You can find the odbc.sbo file for WebIntelligence at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\teradata NOTE

You should configure this file only if you want to change the default values permanently, otherwise it is recommended that you do not modify this file. If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box. For more information on data access configuration parameters, see General Data Access Configuration File Reference on page 379 and WebIntelligence Data Access Configuration File Reference on page 425.
If you just want to override the parameters for a specific connection, you may use the Advanced or Custom tab in the connection dialog box.

Modifying an external strategy file


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe.


When you create a universe in Designer, you use a default strategy which is a SQL script that reads structural information from your database. It is also possible to

create an external strategy to create your universe.

Teradata Data Access

Data Access Guide

231

When you purchase an Teradata Access Pack, you are provided with an external strategy file which is located by default at:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\teradata\teradataEN.txt

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide.

Optimizing data access performance

232

Data Access Guide

Structure of the external strategy file This text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP].
EXAMPLE Here is a section of the teraden.txt file: [STRATEGY] TYPE=JOIN NAME= Same Column Name on Teradata [SQL] SQL= SELECT trim(Columns1.DataBaseName)||'.'||Columns1.TableName,'', trim(Columns2.DataBaseName)||'.'||Columns2.TableName,'', trim(Columns1.DataBaseName)||'.'||Trim(Columns1.TableName) ||'.'||trim(Columns1.ColumnName)||'='||trim(Columns2.DataBaseN ame) ||'.'||Trim(Columns2.TableName)||'.'||trim(Columns2.ColumnName ),'', '','' FROM DBC.ColumnsX Columns1, DBC.ColumnsX Columns2 WHERE Columns2.DataBaseName=Columns1.DataBaseName AND Columns2.TableName>Columns1.TableName AND Columns2.ColumnName=Columns1.ColumnName AND Columns1.Columntype=Columns2.Columntype and Columns1.databasename <> 'DBC' and Columns2.databasename <> 'DBC' ; [HELP] HELP= This strategy is based on the name parity of the column and creates a list of Candidate Joins.

Teradata Data Access

Data Access Guide

233

STRATEGY section This section contains the name and type of strategy. You can create three types of strategy: OBJECT, to create your universe classes and objects JOIN, to create your universe joins STRUC, to create your table structure In the preceding example, the strategy is a JOIN type:
TYPE=JOIN

SQL subsection This subsection contains the SQL statements that enable a universe designer to create classes and objects, joins, or table structure. HELP subsection This subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe. Creating an external strategy file If you want to create an external strategy file, copy the strategy file, such as teraden.txt, from the Teradata subfolder. To create an external strategy file: 1. Open a text editor. 2. Create a new [STRATEGY] section. 3. Enter a TYPE parameter and define the strategy type. For example: TYPE=JOIN. 4. Enter a NAME parameter and name the strategy. For example: NAME=External Strategy: Matching column names. 5. Create an [SQL] subsection. 6. Define the SQL definition for this strategy. For example: SQL=SQL statements 7. Create a [HELP] subsection and add a description for this strategy.For example: HELP=Creates joins based on columns with the same name. 8. Save the file with a .txt file type. For example: example.txt.

Optimizing data access performance

234

Data Access Guide

The external strategy file contains external strategy definitions based on SQL. You can also create an external strategy file based on a flat file. For more information on external strategies, see the Designers Guide.

Teradata Data Access

Data Access Guide

235

Modifying the driverEN.sbo and driverEN.cfg files


These files contain a description of all Data Access drivers and a Data Access driver alias section. The driveren.sbo file is a text file containing the driver information relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products. The driverEN.cfg file is an XML file containing the driver information relevant to WebIntelligence only.
NOTE

It is not recommended that you modify these files. You can find the driveren.sbo file at the following location:
<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\driveren.sbo

The driveren.cfg file for WebIntelligence is an XML file at:


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg NOTE

If you have WebIntelligence, you must modify both files every time you make a change to one file. The driveren.sbo file The text file for BusinessObjects, Designer, Supervisor, and other Business Objects products, structured like a filename.ini file, is divided into two sections: [drivers], and [alias]. It is not recommended that you modify this file. Drivers Section This section lists all the Data Access drivers with a description of each driver. On each line, there is: the key name as it appears in the Windows system registry the name of network layer that you select to create a connection the description of the network layer that appears when you select the network layer For example, the Teradata entry is displayed below:
Teradata=Teradata ODBC Driver,Allows you to access Teradata

Optimizing data access performance

236

Data Access Guide

databases

Teradata Teradata ODBC Driver


Allows you to access Teradata databases

the key name for Teradata the name of the network layer the description of the network layer

This file containts the name of the network layer and its description. Do not change the key name. This key name matches one in your Windows registry, if it is modified, you could experience problems with your computer. Alias Section This section displays a list of Business Objects 5.x Data Access drivers and compatible Business Objects 6.x Data Access drivers. It enables Business Objects 6.x products to correctly interpret your Business Object 5.x product connections. Your users can use previously defined connections with the current version. On each alias row, there is: the Data Access driver for Business Objects 5.x driver key name as it appears in the Windows system registry the Data Access driver for Business Objects 6.x compatible driver. Each driver is listed by registry key name without underscore characters The driveren.cfg file The driveren.cfg file for WebIntelligence contains the same information as the drivers section of the driversen.sbo file, but in a different format. The following is the entry for Teradata:
<NetworkLayer Name="Teradata"> <Message id="Comment">Allows you to access Teradata databases</Message> <Message id="Name">Teradata ODBC Driver</Message> </NetworkLayer>

For a complete description of where this information is displayed, see Drivers Section on page 235.
NOTE

It is not recommended that you modify these files.

Teradata Data Access

Data Access Guide

237

Teradata datatype conversion


Business Objects products support three datatypes: date character number The following table lists the Teradata internal datatypes and their equivalent in Business Objects products:
Teradata Datatype

Business Objects Datatype

DATE DECIMAL FLOAT INTEGER SMALLINT BYTEINT DATETIME VARCHAR

DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE CHARACTER

Teradata datatype conversion

238

Data Access Guide

Teradata Data Access

Optimizing Data Access

part

Data Access Parameter File Reference

chapter

242

Data Access Guide

Overview
This chapter provides an alphabetical reference for all parameters you may find in driveren.prm files. For each RDBMS, there are two driver.prm files. The driver.prm file relevant to BusinessObjects, Designer, Supervisor, and other Business Objects products is made up of four sections: General Date Operators Functions The parameters indicated in the General section are described in detail in this chapter. There is also a listing of Functions for each RDBMS. For more information, see Functions on page 321.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file. The parameters in the General section of each parameter file are described for the following RDBMS: IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata

Data Access Parameter File Reference

Data Access Guide

243

NOTE

Certain parameters can be set in the Parameter page of the Universe Parameters dialog box in Designer (File > Parameters > Parameters). If you modify a parameter in Designer, the new value replaces any modification that you have made to the parameter value in the PRM file. See the Designers Guide for more information.

244

Data Access Guide

IBM DB2
The following parameters are included by default in the following files: db2udben.prm db2iseriesen.prm db2mvsen.prm Not all the parameters are supported by all IBM DB2 RDBMS, so certain parameters may not appear in one or more PRM files. Where only one default value is given, this is the default parameter value for all supported IBM DB2 RDBMS.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file.

BACK_QUOTE_SUPPORTED
Back_Quote_Supported=Y | N

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

BACK_QUOTE_SUPPORTED=value Y not available Y

Specifies enclosing table or column names containing spaces or special characters with backquotes ( ` ). Values Y Encloses table and column names with backquotes. N Backquotes are not included around table and column names. Result
Table name=`My Table`

COMMA
Comma=|| || | + +

Data Access Parameter File Reference

Data Access Guide

245

Syntax Default value

COMMA=value ||' '||

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1||' '||Tab.Col2

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value ||

Specifies the concatenation operator. Values: || +

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins. NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

IBM DB2

246

Data Access Guide

EXT_JOIN_INVERT
Ext_Join_Invert=YES|NO

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

EXT_JOIN_INVERT=value YES YES not available

Specifies how to display an outer join symbol in a join expression. Values YES When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears reversed in position in a join expression. NO When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears on the same side on which you created the outer join.

GROUPBY_EXCLUDE_COMPLEX
Groupby_Exclude_Complex=Y | N

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

GROUPBY_EXCLUDE_COMPLEX=value N Y Y

Specifies whether the database allows you to enter formulas, aliases or indexes in GROUP BY clauses. Values Y Specifies that the database does not allow you to enter formulas, aliases, or indexes in GROUP BY clauses. If you run a query containing measure objects and complex objects (for example, with the substring function or the

Data Access Parameter File Reference

Data Access Guide

247

concatenation operator), your Business Objects product displays the following error message: Your database does not allow you to do aggregations with the n object. N Specifies that the database does allow you to enter formulas, aliases, or indexes in GROUP BY clauses.

GROUPBY_WITHOUT_CONSTANT
Groupby_Without_Constant=Y | N

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

GROUPBY_WITHOUT_COMPLEX=value N Y Y

Specifies whether or not you authorize the addition of objects whose SQL definition is a constant in a GROUP BY clause. Values Y Specifies that you can add any constant object to the query but it will not be present in the GROUP BY clause. N Specifies that you can insert all the objects of a query (for example, without aggregate functions) in a GROUP BY clause.

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value NO

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database. NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

IBM DB2

248

Data Access Guide

INTERSECT
Intersect=INTERSECT |

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

INTERSECT=value INTERSECT no value no value

Specifies if the database supports the INTERSECT set operator. Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If you choose this value, two queries are generated.

INTERSECT_IN_SUBQUERY
Intersect_in_Subquery=INTERSECT |

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

INTERSECT_IN_SUBQUERY=value INTERSECT no value no value

Specifies if the database supports the INTERSECT set operator within a subquery. Values INTERSECT The database supports the INTERSECT set operator within a subquery. no value The database does not support the INTERSECT set operator within a subquery. If you choose this value, two queries are generated.

Data Access Parameter File Reference

Data Access Guide

249

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

MINUS
MINUS=EXCEPT |

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

MINUS=value EXCEPT no value no value

Specifies if the database supports the MINUS set operator. Values EXCEPT Specifies that the database supports the MINUS set operator. no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

MINUS_IN_SUBQUERY
MINUS_IN_SUBQUERY=EXCEPT |

IBM DB2

250

Data Access Guide

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

MINUS_IN_SUBQUERY=value EXCEPT no value no value

Specifies if the database supports the MINUS set operator within a subquery. Values EXCEPT Specifies that the database supports the MINUS set operator within a subquery. no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

OUTERJOINS_GENERATION
Outerjoins_Generation= AINSI_92 | DB2| NO

Syntax Default value

OUTERJOINS_GENERATION=value DB2

Specifies the SQL syntax for outer joins. Values AINSI_92 Generates the AINSI 92 syntax. This value generates an outer join in the FROM clause, whereas other values generate the outer join in the WHERE clause. Also, when you modify this setting, you can check that your outer join is set up correctly by editing the join and verifying that the expression is correctly phrased and that the cardinalities are correct. DB2 Outer joins are supported. NO Outer joins are not supported. Result
FROM T2 LEFT OUTER JOIN T1 ON T1.col1 = T2.col2

Data Access Parameter File Reference

Data Access Guide

251

OVER_CLAUSE
OVER_CLAUSE= Y | N

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

OVER_CLAUSE=value Y not available not available

Allows Business Objects products to include RISQL functions when generating SQL. The supported RISQL functions for the database are listed in the RISQL_Functions parameter. Values Y Business Objects products can include RISQL functions when generating SQL. N Business Objects products cannot include RISQL functions when generating SQL.

OWNER
Owner=Y|N

Syntax Default value

OWNER=value Y

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

QUALIFIER
Qualifier=Y | N

IBM DB2

252

Data Access Guide

Syntax Default value

QUALIFIER=value N

Specifies whether the database authorizes prefixing tables with the qualifier name, for example, the database name. Values Y Specifies that the database does support prefixing tables by the qualifier name. N Specifies that the database does not support prefixing tables by the qualifier name.

RISQL_FUNCTIONS
RISQL_FUNCTIONS=RANK | SUM | AVG | COUNT | MIN | MAX

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

RISQL_FUNCTION=value RANK,SUM,AVG,COUNT,MIN,MAX not available not available

Lists RISQL functions supported by database.

SORT_BY_NO
Sort_By_No=YES|NO

Syntax Default value

SORT_BY_NO=value YES

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not

Data Access Parameter File Reference

Data Access Guide

253

included in the SELECT statement.

STG
Stg=filename

Syntax Default value

STG=value db2en

Specifies the name of the external strategy file. Values db2en This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

STRING_FORMAT_IN_SUBQUERY
STRING_FORMAT_IN_SUBQUERY= YES

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

STRING_FORMAT_IN_SUBQUERY=value not available not available YES

IBM DB2

254

Data Access Guide

TABLE_DELIMITER
TABLE_DELIMITER=

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm

TABLE_DELIMITER=value not available

Specifies that table or column names that contain spaces or special characters are enclosed within quotation marks if the parameter Back_Quote_Supported is activated. Values Table or column names that contain spaces or special characters are enclosed in double quotation marks.

To use this parameter the BACK_QUOTE_SUPPORTED parameter must be set to BACK_QUOTE_SUPPORTED=Y. Result
Table name=My Table

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator. Values UNION The database supports the UNION set operator. no value The database does not support the UNION set operator. If you choose this value, two queries are generated.

Data Access Parameter File Reference

Data Access Guide

255

UNION_IN_SUBQUERY
Union_in_Subquery=UNION|

Syntax Default value

UNION_IN_SUBQUERY=value UNION

Specifies if the database supports the UNION set operator within a subquery. Values UNION The database supports the UNION set operator within a subquery. no value The database does not support the UNION set operator within a subquery. If you choose this value, two queries are generated.

IBM DB2

256

Data Access Guide

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd

Syntax Default value db2udben.prm Default value db2iseriesen.prm Default value db2mvsen.prm
NOTE

User_Input_Date_Format=value yyyy-mm-dd \d yyyy-mm-dd yyyy-mm-dd

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence. If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence.

Data Access Parameter File Reference

Data Access Guide

257

USER_INPUT_NUMERIC_SEPARATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file. Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,) . Numbers are separated with a period (.) Result with , value
100,00 is One hundred

Result with . value


100.00 is One hundred

IBM DB2

258

Data Access Guide

Informix
The following parameters are included by default in the informixen.prm file.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file.

COMMA
Comma=||
|

|| | + +

Syntax Default value

COMMA=value ||' '||

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1||' '||Tab.Col2

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value ||

Specifies the concatenation operator. Values: || +

EVAL_WITHOUT_PARENTHESIS
=Y

Data Access Parameter File Reference

Data Access Guide

259

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins.

NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

EXT_JOIN_INVERT
Ext_Join_Invert=YES|NO

Syntax Default value

EXT_JOIN_INVERT=value YES

Specifies how to display an outer join symbol in a join expression. Values YES When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears reversed in position in a join expression. NO When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears on the same side on which you created the outer join.

FORCE_SORTED_LOV
Force_sorted_lov= Y | N

Syntax Default value

FORCE_SORTED_LOV=value Y

Retrieves a list of values that is sorted. Values Y Specifies that the list of values is sorted. N Specifies that the list of values is not sorted.

Informix

260

Data Access Guide

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value YES

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database. NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

INTERSECT
Intersect=INTERSECT |

Syntax Default value

INTERSECT=value

Specifies if the database supports the INTERSECT set operator. Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If you choose this value, two queries are generated.

INTERSECT_IN_SUBQUERY
Intersect_in_Subquery=INTERSECT |

Syntax Default value

INTERSECT_IN_SUBQUERY=value

Specifies if the database supports the INTERSECT set operator in a subquery. Values INTERSECT The database supports the INTERSECT set operator within a subquery. no value The database does not support the INTERSECT set operator within a subquery. If you choose this value, two queries are generated.

Data Access Parameter File Reference

Data Access Guide

261

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

LNG_SQL_HELP
=80

MINUS
MINUS=MINUS | EXCEPT |

Syntax Default value

MINUS=value

Specifies if the database supports the MINUS set operator. Values MINUS Specifies that the database supports the MINUS set operator. EXCEPT Specifies that the database supports the MINUS set operator.

no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

MINUS_IN_SUBQUERY
MINUS_IN_SUBQUERY=MINUS | EXCEPT |

Informix

262

Data Access Guide

Syntax Default value

MINUS_IN_SUBQUERY=value

Specifies if the database supports the MINUS set operator within a subquery. Values MINUS Specifies that the database supports the MINUS set operator within a subquery. EXCEPT Specifies that the database supports the MINUS set operator within a subquery.

no value Specifies that the database does not support the MINUS set operator within a subquery. If you choose this value, two queries are generated.

OUTERJOINS_COMPLEX
Outerjoins_Complex= Y | N

Syntax Default value

OUTERJOINS_COMPLEX=value Y

Specifies if the database authorizes outer joins with complex joins (i.e using AND, LIKE,...). Values Y Specifies that the database supports outer joins with complex joins. N Specifies that the database does not support outer joins with complex joins.

NOTE

When you select Outerjoin, you must still edit the join manually in the SQL Join Expression box.

OUTERJOINS_GENERATION
Outerjoins_Generation=INFORMIX | NO | ANSI_92

Syntax Default value

OUTERJOINS_GENERATION=value INFORMIX

Specifies the SQL syntax for outer joins.

Data Access Parameter File Reference

Data Access Guide

263

Values INFORMIX Outer joins are supported. ANSI_92 Generates the ANSI92 syntax. Generates an outer join in the FROM clause, whereas other values generate the outer join in the WHERE clause. Also, when you modify this setting, you can check that your outer join is set up correctly by editing the join and verifying that the expression is correctly phrased and that the cardinalities are correct. NO Outer joins are not supported. Result

FROM T1, T2 WHERE T1.col1(+) = T2.col2

OWNER
Owner=Y|N

Syntax Default value

OWNER=value Y

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

QUALIFIER
Qualifier=Y | N

Syntax Default value

QUALIFIER=value N

Specifies whether the database authorizes prefixing tables with the qualifier name, for example, the database name. Values Y Specifies that the database does support prefixing tables by the qualifier

Informix

264

Data Access Guide

name. N Specifies that the database does not support prefixing tables by the qualifier name.

QUOTE_OWNER
Outerjoins_Generation= Y | N

Syntax Default value

QUOTE_OWNER=value Y

Specifies whether or not an owner name should be in single quotes. Values Y Specifies that table names are prefixed by an owner name in single quotes. This is mandatory for an ANSI compliant Informix database. If not, Informix converts the owner name in upper case characters. N Specifies that table names are not prefixed by an owner name in single quotes. Result
SELECT Alias.col (<Alias> is a local Alias) FROM 'Owner'.table.col Alias

SORT_BY_NO
Sort_By_No=YES | NO

Syntax Default value

SORT_BY_NO=value YES

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

Data Access Parameter File Reference

Data Access Guide

265

STG
Stg=filename

Syntax Default value

STG=value informixen

Specifies the name of the external strategy file. Values informixen This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator. Values UNION The database supports the UNION set operator. no value The database does not support the UNION set operator. If you choose this value, two queries are generated.

UNION_IN_SUBQUERY
Union_in_Subquery=UNION|

Syntax Default value

UNION_IN_SUBQUERY=value

Specifies if the database supports the UNION set operator within a subquery. Values UNION The database supports the UNION set operator within a subquery. no value The database does not support the UNION set operator within a subquery. If you choose this value, two queries are generated.

Informix

266

Data Access Guide

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd | 'MM/DD/YYYY'

Syntax Default value


NOTE

USER_INPUT_DATE_FORMAT=value 'MM/DD/YYYY'

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence. If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence.

USER_INPUT_NUMERIC_SEPARATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file. Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,) . Numbers are separated with a period (.) Result with , value
100,00 is One hundred

Result with . value


100.00 is One hundred

Data Access Parameter File Reference

Data Access Guide

267

Microsoft SQL Server


The following parameters are included by default in the sqlsrven.prm file.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file.

BACK_QUOTE_SUPPORTED
Back_Quote_Supported=Y | N

Syntax Default value

BACK_QUOTE_SUPPORTED=value Y

Specifies enclosing table or column names containing spaces or special characters with backquotes ( ` ). Values Y Encloses table and column names with backquotes. N Backquotes are not included around table and column names. Result
Table name=`My Table`

CHECK_OWNER_STATE
Check_Owner_State=Y | N

Syntax Default value

CHECK_OWNER_STATE=value N

Specifies database support of table classification by owner name. Values Y Checks if the database supports table classification by owner name. N Does not check if the database supports table classification by owner name.

CHECK_QUALIFIER_STATE
Check_Qualifier_State=Y | N

Microsoft SQL Server

268

Data Access Guide

Syntax Default value

CHECK_QUALIFIER_STATE=value N

Specifies database support of table classification by qualifier. Values Y Checks if the database supports table classification by qualifier. N Does not check if the database supports table classification by qualifier.

COMMA
Comma=|| || | + +

Syntax Default value

COMMA=value +' +

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1+' '+Tab.Col2

Data Access Parameter File Reference

Data Access Guide

269

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value +

Specifies the concatenation operator. Values: || +

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins. NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value NO

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database. NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

Microsoft SQL Server

270

Data Access Guide

INTERSECT
Intersect=INTERSECT |

Syntax Default value

INTERSECT=value

Specifies if the database supports the INTERSECT set operator. Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If you choose this value, two queries are generated.

INTERSECT_IN_SUBQUERY
Intersect_in_Subquery=INTERSECT |

Syntax Default value

INTERSECT_IN_SUBQUERY=value

Specifies if the database supports the INTERSECT set operator in a subquery. Values INTERSECT The database supports the INTERSECT set operator within a subquery. no value The database does not support the INTERSECT set operator within a subquery. If you choose this value, two queries are generated.

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to

Data Access Parameter File Reference

Data Access Guide

271

display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

LEFT_OUTER
Left_Outer=$(+) | $*

Syntax Default value

LEFT_OUTER=value $*

Specifies the left outer join syntax. Values $* This syntax is used with Sybase, MS SQL Server and Red Brick. $(+) represents a join expression.

MINUS
MINUS=MINUS | EXCEPT |

Syntax Default value

MINUS=value

Specifies if the database supports the MINUS set operator. Values MINUS Specifies that the database supports the MINUS set operator. EXCEPT Specifies that the database supports the MINUS set operator. no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

MINUS_IN_SUBQUERY
MINUS_IN_SUBQUERY=MINUS | EXCEPT |

Syntax Default value

MINUS_IN_SUBQUERY=value

Specifies if the database supports the MINUS set operator within a subquery. Values MINUS Specifies that the database supports the MINUS set operator

Microsoft SQL Server

272

Data Access Guide

within a subquery. EXCEPT Specifies that the database supports the MINUS set operator within a subquery. no value Specifies that the database does not support the MINUS set operator within a subquery. If you choose this value, two queries are generated.

OWNER
Owner=Y|N

Syntax Default value

OWNER=value Y

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

OUTERJOINS_GENERATION
Outerjoins_Generation=USUAL | FULL_ODBC | NO

Syntax Default value

OUTERJOINS_GENERATION=value USUAL

Specifies the SQL syntax for outer joins. Values USUAL Outer joins are supported. This is a generic, non-RDBMS-specific value. FULL_ODBC Outer joins are supported. This is an ODBC-specific value. NO Outer joins are not supported. Result
FROM T1, T2 WHERE T1.col1(+) = T2.col2

Data Access Parameter File Reference

Data Access Guide

273

QUALIFIER
Qualifier=Y | N

Syntax Default value

QUALIFIER=value Y

Specifies whether the database authorizes prefixing tables with the qualifier name, for example, the database name. Values Y Specifies that the database does support prefixing tables by the qualifier name. N Specifies that the database does not support prefixing tables by the qualifier name.

REFRESH_COLUMNS_TYPE
Refresh_Columns_Type=O | Q | T

Syntax Default value

REFRESH_COLUMNS_TYPE=value Q

Indicates how columns are refreshed. Values O Columns are refreshed by owner name. Q Columns are refreshed by qualifier name. T Columns are refreshed by table name.

RIGHT_OUTER
Right_Outer=$(+) | *$

Syntax Default value

RIGHT_OUTER=value *$

Specifies the right outer join syntax. Values *$ This syntax is used with Microsoft SQL Server. $ This represents a join expression.

Microsoft SQL Server

274

Data Access Guide

SORT_BY_NO
Sort_By_No=YES | NO

Syntax Default value

SORT_BY_NO=value NO

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

STG
Stg=filename

Syntax Default value

STG=value sqlsrven

Specifies the name of the external strategy file. Values sqlsrven This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

TABLE_DELIMITER
TABLE_DELIMITER= |

Syntax Default value

TABLE_DELIMITER=value

Specifies that table or column names that contain spaces or special characters are enclosed within quotation marks if the parameter Back_Quote_Supported is activated.

Data Access Parameter File Reference

Data Access Guide

275

Values Table or column names that contain spaces or special characters are enclosed in double quotation marks. Table or column names that contain spaces or special characters are enclosed in single quotation marks. This value can be used only with Microsoft Access.

To use this parameter the BACK_QUOTE_SUPPORTED parameter must be set to BACK_QUOTE_SUPPORTED=Y. Result
Table name=My Table

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator. Values UNION The database supports the UNION set operator. no value The database does not support the UNION set operator. If you choose this value, two queries are generated.

UNION_iN_SUBQUERY
Union_in_Subquery=UNION|

Syntax Default value

UNION_IN_SUBQUERY=value UNION

Specifies if the database supports the UNION set operator within a subquery. Values UNION The database supports the UNION set operator within a subquery. no value The database does not support the UNION set operator within a subquery. If you choose this value, two queries are generated.

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY

Microsoft SQL Server

276

Data Access Guide

HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd

Syntax Default value


NOTE

User_Input_Date_Format=value 'yyyy-mm-dd HH:mm:ss'

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence. If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence. Values 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats for Microsoft SQL Server. {\d 'yyyy-mm-dd'} This is an ODBC date format. Other RDBMS-specific date and time formats.

USER_INPUT_NUMERIC_SEPARATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file. Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,) . Numbers are separated with a period (.)Result with , value
100,00 is One hundred

Data Access Parameter File Reference

Data Access Guide

277

Result with . value


100.00 is One hundred

Microsoft SQL Server

278

Data Access Guide

Oracle
The following parameters are included by default in the oracleen.prm file.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file.

BACK_QUOTE_SUPPORTED
Back_Quote_Supported=Y | N

Syntax Default value

BACK_QUOTE_SUPPORTED=value Y

Specifies enclosing table or column names containing spaces or special characters with backquotes ( ` ). Values Y Encloses table and column names with backquotes. N Backquotes are not included around table and column names. Result
Table name=`My Table`

CASE_SENSITIVE
Case_Sensitive=Y | N

Syntax Default value

CASE_SENSITIVE=value N

Specifies if the database is case sensitive. Values Y Specifies that the database is case sensitive. N Specifies that the database is not case sensitive.

CHECK_OWNER_STATE
Check_Owner_State=Y | N

Data Access Parameter File Reference

Data Access Guide

279

Syntax Default value

CHECK_OWNER_STATE=value N

Specifies database support of table classification by owner name. Values Y Checks if the database supports table classification by owner name. N Does not check if the database supports table classification by owner name.

CHECK_QUALIFIER_STATE
Check_Qualifier_State=Y | N

Syntax Default value

CHECK_QUALIFIER_STATE=value N

Specifies database support of table classification by qualifier. Values Y Checks if the database supports table classification by qualifier. N Does not check if the database supports table classification by qualifier.

COMMA
Comma=||
|

|| | + +

Syntax Default value

COMMA=value ||' '||

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1||' '||Tab.Col2

Oracle

280

Data Access Guide

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value ||

Specifies the concatenation operator. Values: || +

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins. NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

EXT_JOIN_INVERT
Ext_Join_Invert=YES|NO

Syntax Default value

EXT_JOIN_INVERT=value YES

Specifies how to display an outer join symbol in a join expression. Values YES When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears reversed in position in a join expression. NO When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears on the same side on which you created the outer join.

Data Access Parameter File Reference

Data Access Guide

281

EXTERN_SORT_EXCLUDE_DISTINCT
Extern_Sort_Exclude_Distinct=Y | N

Syntax Default value

EXTERN_SORT_EXCLUDE_DISTINCT= value Y

Specifies the generation of a SELECT DISTINCT when a query contains an ORDER BY. Values Y Specifies that a SELECT DISTINCT is not generated as the query contains an ORDER BY. N Specifies that a DISTINCT is generated even though the query contains an ORDER BY.

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value NO

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database. NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

INTERSECT
Intersect=INTERSECT |

Syntax Default value

INTERSECT=value INTERSECT

Specifies if the database supports the INTERSECT set operator.

Oracle

282

Data Access Guide

Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If you choose this value, two queries are generated.

INTERSECT_IN_SUBQUERY
Intersect_in_Subquery=INTERSECT |

Syntax Default value

INTERSECT_IN_SUBQUERY=value INTERSECT

Specifies if the database supports the INTERSECT set operator within a subquery. Values INTERSECT The database supports the INTERSECT set operator within a subquery. no value The database does not support the INTERSECT set operator within a subquery. If you choose this value, two queries are generated.

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

Data Access Parameter File Reference

Data Access Guide

283

LEFT_OUTER
Left_Outer=$(+) | $*

Syntax Default value

LEFT_OUTER=value $(+)

Specifies the left outer join syntax. Values $* This syntax is used with Sybase, MS SQL Server and Red Brick. $ represents a join expression. $(+)

MINUS
MINUS=MINUS |

Syntax Default value

MINUS=value MINUS

Specifies if the database supports the MINUS set operator. Values MINUS Specifies that the database supports the MINUS set operator. no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

MINUS_IN_SUBQUERY
MINUS_IN_SUBQUERY=MINUS |

Syntax Default value

MINUS_IN_SUBQUERY=value MINUS

Specifies if the database supports the MINUS set operator within a subquery. Values MINUS Specifies that the database supports the MINUS set operator within a subquery. no value Specifies that the database does not support the MINUS set operator within a subquery. If you choose this value, two queries are generated.

Oracle

284

Data Access Guide

OUTERJOINS_GENERATION
Outerjoins_Generation=USUAL | NO

Syntax Default value

OUTERJOINS_GENERATION=value USUAL

Specifies the SQL syntax for outer joins. Values USUAL Outer joins are supported. This is a generic, non-RDBMS-specific value. NO Outer joins are not supported. Result
FROM T1, T2 WHERE T1.col1(+) = T2.col2

OWNER
Owner=Y | N

Syntax Default value

OWNER=value Y

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

REVERSE_TABLE_WEIGHT
Reverse_Table_Weight=Y | N

Syntax Default value

REVERSE_TABLE_WEIGHT=value Y

Specifies in which order tables should be generated.

Data Access Parameter File Reference

Data Access Guide

285

Values Y Specifies that tables are generated from the smallest to the largest. N Specifies that tables are generated from the largest to the smallest. If the parameter has no value, tables are generated from the largest to the smallest.

SORT_BY_NO
Sort_By_No=YES | NO

Syntax Default value

SORT_BY_NO=value NO

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

STG
Stg=filename

Syntax Default value

STG=value oracleen

Specifies the name of the external strategy file. Values oracleen This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

TABLE_DELIMITER
TABLE_DELIMITER= |

Oracle

286

Data Access Guide

Syntax Default value

TABLE_DELIMITER=value

Specifies that table or column names that contain spaces or special characters are enclosed within quotation marks if the parameter Back_Quote_Supported is activated. Values Table or column names that contain spaces or special characters are enclosed in double quotation marks. Table or column names that contain spaces or special characters are enclosed in single quotation marks. This value can be used only with Microsoft Access.

To use this parameter the BACK_QUOTE_SUPPORTED parameter must be set to BACK_QUOTE_SUPPORTED=Y. Result
Table name=My Table

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator. Values UNION The database supports the UNION set operator. no value The database does not support the UNION set operator. If you choose this value, two queries are generated.

UNION_IN_SUBQUERY
Union_in_Subquery=UNION|

Syntax Default value

UNION_IN_SUBQUERY=value UNION

Specifies if the database supports the UNION set operator within a subquery.

Data Access Parameter File Reference

Data Access Guide

287

Values UNION The database supports the UNION set operator within a subquery. no value The database does not support the UNION set operator within a subquery. If you choose this value, two queries are generated.

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd

Syntax Default value


NOTE

User_Input_Date_Format=value 'DD-MM-YYYY HH:MM:SS'

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence. If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence. Values 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with Oracle. Other RDBMS-specific date and time formats.

USER_INPUT_NUMERIC_SEPARATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file.

Oracle

288

Data Access Guide

Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,) . Numbers are separated with a period (.) Result with , value
100,00 is One hundred

Result with . value


100.00 is One hundred

Data Access Parameter File Reference

Data Access Guide

289

Red Brick
The following parameters are included by default in the redbricken.prm file.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file

CHECK_OWNER_STATE
Check_Owner_State=Y | N

Syntax Default value

CHECK_OWNER_STATE=value N

Specifies database support of table classification by owner name. Values Y Checks if the database supports table classification by owner name.

CHECK_QUALIFIER_STATE
Check_Qualifier_State=Y | N

Syntax Default value

CHECK_QUALIFIER_STATE=value N

Specifies database support of table classification by qualifier. Values Y Checks if the database supports table classification by qualifier. N Does not check if the database supports table classification by qualifier.

COMBINE_WITHOUT_PARENTHESIS
COMBINE_WITHOUT_PARENTHESIS=Y | N

Specifies whether or not to encapsulate a query with parentheses when it contains UNION, INTERSECT or MINUS operators.

Red Brick

290

Data Access Guide

Values Y - Removes the parentheses. This is the default value. N - Leaves the parentheses.

COMMA
Comma=|| || | + +

Syntax Default value

COMMA=value +' '+

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1+' '+Tab.Col2

Data Access Parameter File Reference

Data Access Guide

291

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value +

Specifies the concatenation operator. Values: ||

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins. NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

GROUPBY_WITH_ALIAS
GROUPBY_WITH_ALIAS= Y | N

Syntax Default value

GROUP_BY_ALIAS=value Y

Specifies whether the database can create a GROUP BY clause in the SELECT statement. Values Y Allows you to create a GROUP BY clause in the SELECT statement. This is possible using an internal alias which references a concatenated T1.col+T2.col+...+Tn.col statement. N Does not let you to create a GROUP BY clause in the SELECT statement.

Red Brick

292

Data Access Guide

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value NO

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database. NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

INTERSECT
Intersect=INTERSECT |

Syntax Default value

INTERSECT=value INTERSECT

Specifies if the database supports the INTERSECT set operator. Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If you choose this value, two queries are generated.

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to

Data Access Parameter File Reference

Data Access Guide

293

display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

LEFT_OUTER
Left_Outer=$(+) | $*

Syntax Default value

LEFT_OUTER=value $*

Specifies the left outer join syntax. Values $* This syntax is used with Red Brick, Oracle, and MS SQL Server. $(+) represents a join expression.

MINUS
MINUS=EXCEPT

Syntax Default value

MINUS=value EXCEPT

Specifies if the database supports the MINUS set operator. Values EXCEPT Specifies that the database supports the MINUS set operator. no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

OLAP_CLAUSE
OLAP_CLAUSE=WHEN

Specifies whether Business Objects products generate a WHEN clause if a function listed in the RISQL_Functions parameter is used in a condition. Value WHEN Generates a WHEN clause if a function listed in the RISQL_Functions parameter is used in a condition. This parameter must be used with the GROUPBY clause.

Red Brick

294

Data Access Guide

OUTERJOINS_GENERATION
Outerjoins_Generation= AINSI_92 | USUAL | NO

Syntax Default value

OUTERJOINS_GENERATION=value USUAL

Specifies the SQL syntax for outer joins. Values AINSI_92 Generates the AINSI 92 syntax. This value generates an outer join in the FROM clause, whereas other values generate the outer join in the WHERE clause. Also, when you modify this setting, you can check that your outer join is set up correctly by editing the join and verifying that the expression is correctly phrased and that the cardinalities are correct. USUAL Outer joins are supported. This is a generic, non-RDBMS-specific value. This is the default value for Red Brick. NO Outer joins are not supported.

OWNER
Owner=Y|N

Syntax Default value

OWNER=value N

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

PREFIX_SYS_TABLE
PREFIX_SYS_TABLE= RBW_

Syntax Default value

PREFIX_SYS_TABLE=value RBW_

Data Access Parameter File Reference

Data Access Guide

295

Specifies if the system tables are displayed in Designer. Values RBW_ Specifies that the Red Brick system tables are hidden in the Designer table browser. no value Specifies that the database system tables are displayed in the Designer table browser.

QUALIFIER
Qualifier=Y | N

Syntax Default value

QUALIFIER=value N

Specifies whether the database authorizes prefixing tables with the qualifier name, for example, the database name. Values Y Specifies that the database does support prefixing tables by the qualifier name. N Specifies that the database does not support prefixing tables by the qualifier name.

REFRESH_COLUMNS_TYPE
REFRESH_COLUMNS_TYPE= O | Q | T

Syntax Default value

REFRESH_COLUMNS_TYPE=value Q

Indicates how columns are refreshed. Values O Columns are refreshed by owner name. This is the default value with Oracle. Q Columns are refreshed by qualifier name. This is the default value with Red Brick, Sybase, MS SQL Server and MS Access. T Columns are refreshed by table name. This is the default value with dBase.Columns are refreshed by table name. This is the default value with dBase.

Red Brick

296

Data Access Guide

RIGHT_OUTER
Right_Outer=*$

Syntax Default value

RIGHT_OUTER=value *$

Specifies the right outer join syntax. Values *$ This represents a join expression. CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTOREPORT,TERTILE This is the default list of functions for Red Brick.

RISQL_FUNCTIONS
RISQL_FUNCTION=CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTOREPORT,TER TILE,NTILE

Lists the RISQL functions supported by the database. Values CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTOREPORT,TERTILE,NTIL E

SORT_BY_NO
Sort_By_No=YES | NO

Syntax Default value

SORT_BY_NO=value NO

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

Data Access Parameter File Reference

Data Access Guide

297

STG
STG=filename

Syntax Default value

STG=value redbricken

Specifies the name of the external strategy file. Values redbricken This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator. Values UNION The database supports the UNION set operator. no value The database does not support the

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd

Syntax Default value


NOTE

User_Input_Date_Format=value \d 'yyyy-mm-dd'

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence.

Red Brick

298

Data Access Guide

If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence.

USER_INPUT_NUMERIC_SEPERATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value .

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file. Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,) . Numbers are separated with a period (.)

Result with , value 100,00 is One hundred Result with . value 100.00 is One hundred

Data Access Parameter File Reference

Data Access Guide

299

Sybase
The following parameters are included by default in the sybaseen.prm file.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file.

CHECK_OWNER_STATE
Check_Owner_State=Y | N

Syntax Default value

CHECK_OWNER_STATE=value N

Specifies database support of table classification by owner name. Values Y Checks if the database supports table classification by owner name.

CHECK_QUALIFIER_STATE
Check_Qualifier_State=Y | N

Syntax Default value

CHECK_QUALIFIER_STATE=value N

Specifies database support of table classification by qualifier. Values Y Checks if the database supports table classification by qualifier. N Does not check if the database supports table classification by qualifier.

COMMA
Comma=|| || | + +

Sybase

300

Data Access Guide

Syntax Default value

COMMA=value +' +

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1+' '+Tab.Col2

Data Access Parameter File Reference

Data Access Guide

301

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value +

Specifies the concatenation operator. Values: ||

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins.

NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

EXT_JOIN_INVERT
Ext_Join_Invert=YES|NO

Syntax Default value

EXT_JOIN_INVERT=value YES

Specifies how to display an outer join symbol in a join expression. Values YES When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears reversed in position in a join expression. NO When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears on the same side on which you created the outer join.

Sybase

302

Data Access Guide

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value NO

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database.

NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

INTERSECT_IN_SUBQUERY
Intersect_in_Subquery=INTERSECT |

Syntax Default value

INTERSECT_IN_SUBQUERY=value INTERSECT

Specifies if the database supports the INTERSECT set operator within a subquery. Values INTERSECT The database supports the INTERSECT set operator within a subquery.

no value The database does not support the INTERSECT set operator within a subquery. If you choose this value, two queries are generated.

INTERSECT
Intersect=INTERSECT |

Syntax Default value

INTERSECT=value INTERSECT

Specifies if the database supports the INTERSECT set operator.

Data Access Parameter File Reference

Data Access Guide

303

Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If you choose this value, two queries are generated.

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

LEFT_OUTER
Left_Outer=$(+) | $*

Syntax Default value

LEFT_OUTER=value $*

Specifies the left outer join syntax. Values $* This syntax is used with oracle, MS SQL Server and Red Brick. $(+) represents a join expression.

MINUS_IN_SUBQUERY
MINUS_IN_SUBQUERY=MINUS | EXCEPT |

Syntax Default value

MINUS_IN_SUBQUERY=value

Specifies if the database supports the MINUS set operator within a subquery.

Sybase

304

Data Access Guide

Values MINUS Specifies that the database supports the MINUS set operator within a subquery. EXCEPT Specifies that the database supports the MINUS set operator within a subquery. no value Specifies that the database does not support the MINUS set operator within a subquery. If you choose this value, two queries are generated.

MINUS
MINUS=MINUS |

Syntax Default value

MINUS=value MINUS

Specifies if the database supports the MINUS set operator. Values MINUS Specifies that the database supports the MINUS set operator.

no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

OUTERJOINS_GENERATION
Outerjoins_Generation= AINSI_92 | USUAL | NO

Syntax Default value

OUTERJOINS_GENERATION=value ANSI_92

Specifies the SQL syntax for outer joins. Values AINSI_92 Generates the AINSI 92 syntax. This value generates an outer join in the FROM clause, whereas other values generate the outer join in the WHERE clause. Also, when you modify this setting, you can check that your outer join is set up correctly by editing the join and verifying that the expression is correctly phrased and that the cardinalities are correct. OuterJoins_Generation default value = AINSI_92. USUAL Outer joins are supported. This is a generic, non-RDBMS-specific

Data Access Parameter File Reference

Data Access Guide

305

value. This is the default value for Sybase 11. NO Outer joins are not supported. Result

FROM T1, T2 WHERE T1.col1(+) = T2.col2

OWNER
Owner=Y|N

Syntax Default value

OWNER=value Y

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

QUALIFIER
Qualifier=Y | N

Syntax Default value

QUALIFIER=value Y

Specifies whether the database authorizes prefixing tables with the qualifier name, for example, the database name. Values Y Specifies that the database does support prefixing tables by the qualifier name. N Specifies that the database does not support prefixing tables by the qualifier name.

REFRESH_COLUMNS_TYPE
Refresh_Columns_Type=O | Q | T

Sybase

306

Data Access Guide

Syntax Default value

REFRESH_COLUMNS_TYPE=value Q

Indicates how columns are refreshed. Values O Columns are refreshed by owner name. Q Columns are refreshed by qualifier name. T Columns are refreshed by table name.

RIGHT_OUTER
Right_Outer=$(+)

Syntax Default value

RIGHT_OUTER=value

Specifies the right outer join syntax. Values $ This represents a join expression.

SORT_BY_NO
Sort_By_No=YES | NO

Syntax Default value

SORT_BY_NO=value NO

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

Data Access Parameter File Reference

Data Access Guide

307

STG
STG=filename

Syntax Default value

STG=value sqlsrven

Specifies the name of the external strategy file. Values sqlsrven This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

UNION_IN_SUBQUERY
Union_in_Subquery=UNION|

Syntax Default value

UNION_IN_SUBQUERY=value UNION

Specifies if the database supports the UNION set operator within a subquery. Values UNION The database supports the UNION set operator within a subquery. no value The database does not support the UNION set operator within a subquery. If you choose this value, two queries are generated.

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator. Values UNION The database supports the UNION set operator. no value The database does not support the UNION set operator. If you choose this value, two queries are generated.

Sybase

308

Data Access Guide

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd

Syntax Default value


NOTE

User_Input_Date_Format=value 'DD-MM-YYYY HH:MM:SS'

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence. If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence. Values 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with oracle. Other RDBMS-specific date and time formats.

USER_INPUT_NUMERIC_SEPERATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file. Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,)

Data Access Parameter File Reference

Data Access Guide

309

. Numbers are separated with a period (.)Result with , value


100,00 is One hundred

Result with . value


100.00 is One hundred

Sybase

310

Data Access Guide

Teradata
The following parameters are included by default in the teradataen.prm file.
NOTE

If you have WebIntelligence, you must modify both driver.prm files every time you make a change to one file.

BACK_QUOTE_SUPPORTED
Back_Quote_Supported=Y | N

Syntax Default value

BACK_QUOTE_SUPPORTED=value Y

Specifies enclosing table or column names containing spaces or special characters with backquotes ( ` ). Values Y Encloses table and column names with backquotes. N Backquotes are not included around table and column names. Result
Table name=`My Table`

COMBINE_WITHOUT_PARENTHESIS
COMBINE_WITHOUT_PARENTHESIS=Y | N

Specifies whether or not to encapsulate a query with parentheses when it contains UNION, INTERSECT or MINUS operators. Values Y - Removes the parentheses. This is the default value. N - Leaves the parentheses.

COMMA
Comma=|| || | + +

Data Access Parameter File Reference

Data Access Guide

311

Syntax Default value

COMMA=value ||' '||

Specifies the database concatenation operator used to replace a comma for objects that have the following syntax:
Tab.Col1, Tab.Col2

Values ||' '|| Replaces commas with || || +' '+ Replaces commas with + + Result

Tab.Col1||' '||Tab.Col2

CONCAT
Concat=|| | +

Syntax Default value

CONCAT=value ||

Specifies the concatenation operator. Values: || +

EXT_JOIN_INVERT
Ext_Join_Invert=YES|NO

Syntax Default value

EXT_JOIN_INVERT=value YES

Specifies how to display an outer join symbol in a join expression. Values YES When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears reversed in position in a join expression. NO When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears on the same side on which you

Teradata

312

Data Access Guide

created the outer join.

EXT_JOIN
Ext_Join=YES | NO

Syntax Default value

EXT_JOIN=value YES

Specifies support of outer joins. Values YES Specifies that the database supports outer joins. NO Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are not available.

GROUPBYCOL
GroupByCol=YES|NO

Syntax Default value

GROUPBYCOL=value NO

Specifies whether a GROUP BY clause accepts integers for column names. Values YES Specifies that a GROUP BY clause followed by an integer is supported by the database. NO Specifies that a GROUP BY clause followed by an integer is not supported by the database.

INTERSECT
Intersect=INTERSECT |

Syntax Default value

INTERSECT=value INTERSECT

Specifies if the database supports the INTERSECT set operator. Values INTERSECT The database supports the INTERSECT set operator. no value The database does not support the INTERSECT set operator. If

Data Access Parameter File Reference

Data Access Guide

313

you choose this value, two queries are generated.

INTERSECT_IN_SUBQUERY
Intersect_in_Subquery=INTERSECT |

Syntax Default value

INTERSECT_IN_SUBQUERY=value INTERSECT

Specifies if the database supports the INTERSECT set operator within a subquery. Values INTERSECT The database supports the INTERSECT set operator within a subquery. no value The database does not support the INTERSECT set operator within a subquery. If you choose this value, two queries are generated.

KEY_INFO_SUPPORTED
KEY_INFO_SUPPORTED=Y | N

Syntax Default value

KEY_INFO_SUPPORTED=value Y

Specifies if you can retrieve primary and secondary key definitions from the database account. Values Y Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to display the keys in the Structure window. N Specifies that the database does not let you retrieve primary and secondary key definitions from the database account.

MINUS_IN_SUBQUERY
MINUS_IN_SUBQUERY=MINUS |

Syntax Default value

MINUS_IN_SUBQUERY=value MINUS

Specifies if the database supports the MINUS set operator within a subquery.

Teradata

314

Data Access Guide

Values MINUS Specifies that the database supports the MINUS set operator within a subquery. no value Specifies that the database does not support the MINUS set operator within a subquery. If you choose this value, two queries are generated.

MINUS
MINUS=MINUS |

Syntax Default value

MINUS=value MINUS

Specifies if the database supports the MINUS set operator. Values MINUS Specifies that the database supports the MINUS set operator. no value Specifies that the database does not support the MINUS set operator. If you choose this value, two queries are generated.

OLAP_CLAUSE
OLAP_CLAUSE=QUALIFY

Specifies whether Business Objects products generate a QUALIFY clause if a function listed in the RISQL_Functions parameter is used in a condition. Value QUALIFY generates a QUALIFY clause if a function listed in the RISQL_Functions parameter is used in a condition. This is the value for Teradata databases.

This parameter must be used with the GROUPBY clause.

OUTERJOINS_GENERATION
Outerjoins_Generation=Ingres

Specifies the SQL syntax for outer joins. Syntax Default value OUTERJOINS_GENERATION=value USUAL

Specifies the SQL syntax for outer joins.

Data Access Parameter File Reference

Data Access Guide

315

Values INGRES Outer joins are supported. NO Outer joins are not supported. Result

FROM T1 LEFT JOIN T2 ON T1.col1 = T2.col2

OWNER
Owner=Y | N

Syntax Default value

OWNER=value Y

Specifies if the database authorizes prefixing tables with the owner name (for example, user name). Values Y Specifies that the database does support prefixing tables by the owner name. N Specifies that the database does not support prefixing tables by the owner name.

QUALIFIER
Qualifier=Y | N

Syntax Default value

QUALIFIER=value Y

Specifies whether the database authorizes prefixing tables with the qualifier name, for example, the database name. Values Y Specifies that the database does support prefixing tables by the qualifier name.

N Specifies that the database does not support prefixing tables by the qualifier name.

Teradata

316

Data Access Guide

RISQL_FUNCTIONS
RISQL_FUNCTION=CSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANTILE,PERC ENT_RANK

Lists the RISQL functions supported by the database. Values CSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANTILE

SORT_BY_NO
Sort_By_No=YES | NO

Syntax Default value

SORT_BY_NO=value NO

Specifies if users are authorized to sort columns that are not included in the SELECT statement. Values YES Specifies that users are not authorized to sort columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is unavailable in the Query Panel. NO Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

STG
Stg=filename

Syntax Default value

STG=value teradataen

Specifies the name of the external strategy file. Values teradataen This is the default Business Objects external strategy file. filename If you replace or rename the default Business Objects external strategy file, make sure the name of the file appears here. Do not include the file extension.

TABLE_DELIMITER
TABLE_DELIMITER= |

Data Access Parameter File Reference

Data Access Guide

317

Syntax Default value

TABLE_DELIMITER=value

Specifies that table or column names that contain spaces or special characters are enclosed within quotation marks if the parameter Back_Quote_Supported is activated. Values Table or column names that contain spaces or special characters are enclosed in double quotation marks. Table or column names that contain spaces or special characters are enclosed in single quotation marks. This value can be used only with Microsoft Access.

To use this parameter the BACK_QUOTE_SUPPORTED parameter must be set to BACK_QUOTE_SUPPORTED=Y. Result
Table name=My Table

UNION_IN_SUBQUERY
Union_in_Subquery=UNION|

Syntax Default value

UNION_IN_SUBQUERY=value UNION

Specifies if the database supports the UNION set operator within a subquery. Values UNION The database supports the UNION set operator within a subquery. no value The database does not support the UNION set operator within a subquery. If you choose this value, two queries are generated.

UNION
Union=UNION|

Syntax Default value

UNION=value UNION

Specifies if the database supports the UNION set operator.

Teradata

318

Data Access Guide

Values UNION The database supports the UNION set operator.

no value The database does not support the UNION set operator. If you choose this value, two queries are generated.

USER_INPUT_DATE_FORMAT
User_Input_Date_Format=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/ yyyy hh:m:s am/pm|yyyy-mm-dd

Syntax Default value


NOTE

User_Input_Date_Format=value ''yyyy-mm-dd'

This is a WebIntelligence-only parameter. Only modify the User_Input_Date_Format in the driver.prm XML file. Specifies the default date and hour formats input by users in WebIntelligence. If this value is not the same as the InputDateFormat parameter in the driver.sbo file, the values indicated in this parameter overwrite the values in the InputDateFormat parameter for WebIntelligence. Values ''yyyy-mm-dd' This is the default date and hour formats with Teradata. Other RDBMS-specific date and time formats.

USER_INPUT_NUMERIC_SEPARATOR
User_Input_Numeric_Separator= , | .
|

Syntax Default value


NOTE

User_Input_Numeric_Separator=value

This is a WebIntelligence-only parameter. Only modify the User_Input_Numeric_Separator in the driver.prm XML file.

Data Access Parameter File Reference

Data Access Guide

319

Specifies the character used to indicate a separator in a numeric value. Values , Numbers are separated with a comma (,) . Numbers are separated with a period (.) Result with , value
100,00 is One hundred

Result with . value


100.00 is One hundred

Teradata

320

Data Access Guide

Data Access Parameter File Reference

Functions

chapter

322

Data Access Guide

Overview
The driveren.prm files contain both parameters and functions. This chapter describes the functions. Functions are RDBMS-specific. IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata For information on the parameters, see Data Access Parameter File Reference on page 241.

Functions

Data Access Guide

323

Adding a function
Business Objects provides you with the most commonly used functions. If you need additional functions, you can add them to the driveren.prm file. For more information on the structure of a function, see the your RDBMS chapter. Adding a function to the driveren.prm file Business Objects provides a list of SQL functions in the driveren.prm file. You may add functions to this list. To do so: 1. Open the driveren.prm file with a text editor. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function. 4. You must leave a carriage return below the last function. 5. Inside the n parameter, increment the function by 1. 6. Enter a new function name in the NAME= parameter. 7. Enter an input field name for each SQL function argument in the TRAD= parameter. If the new function doesnt have arguments, leave this parameter blank. 8. Enter explicit help text for the function in the HELP= parameter. 9. Enter the function type in the TYPE= parameter. 10. Enter either Y or N in the IN_MACRO= parameter, indicating Y if the function is accessible from BusinessObjects or N if the function is not accessible from BusinessObjects. 11. Enter either Y or N in the GROUP= parameter, indicating Y if the function is an aggregate function or N if the fucntion is not an aggregate function. 12. Enter the SQL function name with any arguments in the SQL= parameter. 13. Save the file.
NOTE

If you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file. The following is an example of a newly created function:
(60) NAME= Example TRAD= Text: $Date: HELP= Displays an Example function

Adding a function

324

Data Access Guide

TYPE=A IN_MACRO=Y GROUP=N SQL=example($A,$D)

Adding a function to the driveren.prm XML file You must add your function to the BusinessObjects driveren.prm file before completing this procedure. 1. In an XML editor, open <BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer\RDBMS\driver.prm. 2. Copy a defined function with all of its parameters. 3. Scroll to the bottom of the file and paste the copied function before the </Functions> tag. 4. In the <Function> tag, modify the items between the quotes for the following: Function tag Group Description Indicates whether the function is an aggregate function. The values are: True False ID InMacro Displays the name of the function as it appears in BusinessObjects Indicates whether the function appears in the list of available functions when you define a user defined object. The values are: True False Name Type Displays the name of the function as it appears in BusinessObjects Displays the type of function: String Numeric DateTime

Functions

Data Access Guide

325

5. In the <Arguments> section, include any arguments for your function. Each argument has a <Message id=n> tag which holds the type of argument. 6. In the <SQL> tag, include the SQL necessary to run the function. 7. Save the oracle.prm file. The following is an example of a function for WebIntelligence:
<Function Group="False" ID="Example" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> </Arguments> <SQL>example($A,$D)</SQL> </Function>

Adding a function

326

Data Access Guide

IBM DB2
IBM DB2 function table
Name Trad/Arguments Function Type Minimum of: Maximum of: Average of: Sum of: Count of: Numeric Numeric Numeric Numeric Numeric Available Aggre in function gate list Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes No No Description

0 Minimum 1 Maximum 2 Average 3 Sum 4 Count

Selects the minimum value Selects the maximum value Returns the average value Returns the sum of the values Returns the number of values Returns the ASCII code of a character Returns the value entered in its corresponding ASCII code Concatenates two character strings Returns a specified number of characters from the left of a character string Removes blank characters from the left of a character string

5 ASCII code Character: 6 Character Value of the character:

Alphanumeric No Alphanumeric No

7 Concat 8 Left

String1: $String2: Alphanumeric Yes String: $Length: Alphanumeric Yes

No No

9 LeftTrim

String:

Alphanumeric Yes

No

Functions

Data Access Guide

327

Name

Trad/Arguments Function Type Object: Numeric

Available Aggre in function gate list Yes Yes No No

Description

10 Length 11 Locate

Returns the length of a character string Returns the position of a character in a character string Returns a character string in lower case Repeats a character expression n number of times Returns a specified number of characters from the right of a character string Removes blank characters from the right of a character string Extracts a sequence of characters from a character string Returns a character string in upper case Returns a string consisting of blank characters Returns a character string in which a number of character were replaced by new characters

Object: $Search: Numeric

12 Lowercase 13 Repeat

String: Expression: $Number of times: String: $Nbr of char. to extract:

Alphanumeric Yes Alphanumeric Yes

No No

14 Right

Alphanumeric Yes

No

15 RightTrim Object:

Alphanumeric Yes

No

16 Substring String: $Initial position: $Number of characters: 17 Uppercase 18 Space String: Nbr space char:

Alphanumeric Yes

No

Alphanumeric Yes Alphanumeric Yes

No No

19 Insert

String: $String_exp1: $Start: $Length:

Alphanumeric Yes

No

IBM DB2

328

Data Access Guide

Name

Trad/Arguments Function Type Numeric expression: Value: Numeric

Available Aggre in function gate list Yes No

Description

20 Absolute

Returns the absolute value of a given expression Returns the arc cosine of a numeric expression Returns the arc sine of a numeric expression Returns the arc tangent of a numeric expression Returns the angle in radians whose tangent is angle1/ angle2 Returns the cosine of a number Returns the value of a number rounded up to the nearest integer Returns the exponential value of the specified value Returns the value of a number rounded down to the nearest integer Returns the natural logarithm of the specified value

21 Arc cosine 22 Arc sine

Numeric

Yes

No

Value:

Numeric

Yes

No

23 Arc tangent 24 Angle Tangent 2

Value:

Numeric

Yes

No

Angle 1: $Angle 2: 2

Numeric

Yes

No

25 Cosine 26 Ceil

Angle: Numeric expression: Value:

Numeric Numeric

Yes Yes

No No

27 Exp

Numeric

Yes

No

28 Floor

Numeric expression:

Numeric

Yes

No

29 Log

Value:

Numeric

Yes

No

Functions

Data Access Guide

329

Name

Trad/Arguments Function Type Value: $Divided by Numeric

Available Aggre in function gate list Yes No

Description

30 Mod

Returns the remainder of a division Returns the constant value of 3.141592653589793 2 Returns a random number between 0 and 1 Returns a number that represents the sign of the specified number Returns the sine of a number Returns the square root of a number Returns the tangent of a number Returns the cotangent of a number Converts radians to degrees Returns the base 10 logarithm of the specified value Returns a value raised to the nth power

31 Pi

Numeric

No

No

32 Random

Value:

Numeric

No

No

33 Sign

Value:

Numeric

No

No

34 Sine 35 Sqrt 36 Tangent 37 Cotangent 38 Degrees 39 Log10

Angle: Square root of: Angle: Angle:

Numeric Numeric Numeric Numeric

Yes Yes Yes Yes

No No No No

Angle: num exp:

Numeric Numeric

Yes Yes

No No

40 Power

num exp: $int exp:

Numeric

Yes

No

IBM DB2

330

Data Access Guide

Name

Trad/Arguments Function Type num exp: num exp: $int exp: num exp: $int exp: Numeric Numeric

Available Aggre in function gate list Yes Yes No No

Description

41 Radians 42 Round

Converts degrees to radians Returns a number rounded to n decimal places Returns a value truncated to x decimal places Returns the name of the current database Returns the username of the current DB2 user Allows an expression to be selected based on one or more conditions Prompts the user to enter a specific value Prompts the user to enter a specific value Prompts the user to enter a specific value Returns the day of the week (1 equals Sunday) Returns a character string containing the name of the day Returns the day of the year (1-366)

43 Truncate

Numeric

Yes

No

44 Database 45 User

Alphanumeric Yes Alphanumeric Yes

No No

46 Case

Alphanumeric No

No

47 Character Question: prompt 48 Numeric prompt 49 Date prompt 50 DayOfWeek Question: Question: Date:

Alphanumeric Yes Numeric Date Date Yes Yes Yes

No No No No

51 DayName Date:

Date

Yes

No

52 DayOfYear

Date:

Date

Yes

No

Functions

Data Access Guide

331

Name

Trad/Arguments Function Type Date: Date

Available Aggre in function gate list Yes No

Description

53 Days

Returns an integer representation of a date Returns the hour part of a value Returns the number of days between the date value and the start of the Julian date calendar Returns the microsecond part of a value Returns the number of seconds between midnight and the specified time value Returns the minute part of a value Returns the month part of a value Returns a character string containing the name of the month Returns the second part of a value Returns time from a value Returns a timestamp from a value or a pair of values

54 Hour

Value:

Date Date

Yes Yes

No No

55 JulianDay Date:

56 Value: Microsecond 57 Value: MidnightSec onds 58 Minute 59 Month Value: Value:

Date

Yes

No

Date

Yes

No

Date Date Date

Yes Yes Yes

No No No

60 Date: MonthName 61 Second 62 Time 63 Timestamp Value: Value: Value: $Value

Date Date Date

Yes Yes Yes

No No No

IBM DB2

332

Data Access Guide

Name

Trad/Arguments Function Type Date: Date

Available Aggre in function gate list Yes No

Description

64 TimestampI SO

Returns a timestamp value based on date, time or timestamp argument Returns an estimated number of intervals based on the difference between two timestamps Returns the number of the week Returns the year part of a value Returns a date from a value Returns a graphic representation of a graphic string Returns a long vargraphic representation of a double-byte character string Returns a graphic string representation of a character string value or a graphic string value Returns the character that matches the specified ASCII code value

65 Value: TimestampD $Timestamp ifference duration:

Date

Yes

No

66 Week 67 Year 68 Date 69 Graphic

Date: Date: Date:

Date Date Date

Yes Yes Yes

No No No No

Character string: Alphanumeric Yes $Integer value:

70 Character string: Alphanumeric Yes LongVargrap hic

No

71 Vargraphic

Value:

Alphanumeric Yes

No

72 Chr

Value:

Alphanumeric Yes

No

Functions

Data Access Guide

333

Name

Trad/Arguments Function Type

Available Aggre in function gate list No

Description

73 Clob

Character string: Alphanumeric Yes $Integer value: Alphanumeric Yes

Returns a CLOB representation of a character string Returns the first argument that is not null Returns the number of rows or values Returns a DBCLOB representation of a graphic string Returns the difference between the SOUNDEX value of two strings Returns a characterstring representation of the absolute value of a number Returns the current state of an event monitor Returns a value which indicates whether or not a row returned in a GROUP BY is generated by a grouping set that excludes the specified column Returns a hexadecimal representation of a value

74 Coalesce Expression: $Expression: 75 CountBig Expression: 76 Dbclob Graphic expression: $Integer value:

No

Numeric

Yes

No No

Alphanumeric Yes

77 Difference

Character string: Alphanumeric Yes $Character string: Numeric expression: Alphanumeric Yes

No

78 Digits

No

79 Name of an event Alphanumeric Yes EventMonito monitor: rState 80 Grouping Column name: Alphanumeric Yes

No

No

81 Hex

Value:

Alphanumeric Yes

No

IBM DB2

334

Data Access Guide

Name

Trad/Arguments Function Type Value: Numeric

Available Aggre in function gate list Yes No

Description

82 Ln

Returns the natural logarithm of the specified value Returns the row partition number Compares two expressions Returns the partitioning map index of a row Returns the starting position of a character string within another character string Returns an integer value (1 to 4) representing the quarter of the year for the specified date Returns a singleprecision floatingpoint representation of a number Replaces all occurrences of expression2 in expression1 with expression3 Returns the first argument that is not null

83 Column name: NodeNumbe r 84 Nullif 85 Partition Expression: $Expression: Column name:

Alphanumeric Yes

No

Alphanumeric Yes Alphanumeric Yes

No No

86 Posstr

Character string: Alphanumeric Yes Character string:

No

87 Quarter

Date:

Date

Yes

No

88 Real

Numeric expression:

Numeric

Yes

No

89 Replace

Expression1: $Expression2: $Expression3:

Alphanumeric Yes

No

90 Value

Value: $Value:

Alphanumeric Yes

No

Functions

Data Access Guide

335

Name

Trad/Arguments Function Type Expression: $Precision: $Scale: Numeric

Available Aggre in function gate list Yes No

Description

91 Decimal from Numeric 92 Decimal from Character 93 Double 94 Float

Returns a decimal representation of a number. Returns a decimal representation of a character string. Returns a floatingpoint number Returns a floatingpoint representation of a number Returns an integer representation of a number Returns a LONG VARCHAR representation of a character string Returns a small integer representation of a number or character string Returns a value in which one or more characters in a string may have been translated into other characters Returns a varyinglength character string

Expression: Numeric $Precision: $Scale: $Decimal character: Expression: Numeric expression: Expression: Numeric Numeric

Yes

No

Yes Yes

No No

95 Integer

Numeric

Yes

No

96 Character string: Alphanumeric Yes LongVarchar

No

97 Smallint

Expression:

Numeric

Yes

No

98 Translate String to be Alphanumeric Yes translated: $Replacement characters: $Target characters: $Pad character: 99 Varchar Character string: Alphanumeric Yes $Length of the string:

No

No

IBM DB2

336

Data Access Guide

Name

Trad/Arguments Function Type Numeric expression: Datetime expression: $Valid format: Numeric

Available Aggre in function gate list Yes No No

Description

100 Variance 101 Datetime to character

Returns the variance of a set of numbers Returns a character string representation of a datetime value Returns a fixedlength character string representation of a character string value Returns a character string representation of a numeric value Returns a character string representation of a decimal value Converts a number to a character string Converts a date to a character string

Alphanumeric Yes

102 Character Character to expression: character $Length

Alphanumeric Yes

No

103 Numeric Numeric to character expression: 104 Decimal Numeric to character expression: $Decimal delimiter 105 Number Number: to Char 106 Date to Char Date:

Alphanumeric Yes

No

Alphanumeric Yes

No

Alphanumeric Yes Alphanumeric Yes

No No

Functions

Data Access Guide

337

Informix
Informix function table
The code for data type (Type) used in the table is as follows: A = Alphanumeric N = Numeric D = Date

Name

Trad/ Arguments Minimum of: Maximum of: Average of: Sum of: Count of:

Type

Available Aggre Description in function gate list Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Selects the minimum value Selects the maximum value Returns the average value

SQL

(0)Minimum (1)Maximum 2)Average (3)Sum (4)Count

N N N N Y

min($N) max($N) avg($N)

Returns the sum sum($N) of the values Counts the number of values Removes blank characters from the left of a character string Returns the length of a character string Removes blank characters from the right of a character string count($*)

(5)LeftRemove Character string:

Yes

No

Trim (LEADING FROM $A) LENGTH($A)

(6)Length

Character string:

Yes

No

(7)RightRemov Character e string:

Yes

No

Trim (TRAILING FROM $A)

Informix

338

Data Access Guide

Name

Trad/ Arguments

Type

Available Aggre Description in function gate list Yes No

SQL

(8)Now

Returns the CURRENT current date and YEAR TO time FRACTION(5 ) Returns the current date TODAY

(9)Curdate (10)DayOfMon Date: th (11)DayOfWee Date: k (12)Month Date:

D N N N

Yes Yes Yes Yes

No No No No

Returns the day DAY($D) of the month Returns the day WEEKDAY($ of the week D)+1 Returns the number of the month Returns the absolute value of a given expression Returns the arc cosine of a numeric expression Returns the arc sine of a numeric expression Returns the arc tangent of a numeric expression MONTH($D)

(13)Year 14)Absolute

Date: Numeric expression:

N N

Yes Yes

No No

Returns the year YEAR($D) ABS($N)

(15)Arc cosine Value:

Yes

No

ACOS($N)

(16)Arc sine

Value:

Yes

No

ASIN($N)

(17)Arc tangent

Value:

Yes

No

ATAN($N)

Functions

Data Access Guide

339

Name

Trad/ Arguments Angle 1: $Angle 2:

Type

Available Aggre Description in function gate list Yes No

SQL

(18)Angle Tangent 2

Returns the ATAN2($N,$ angle in radians N) whose tangent is angle1/angle2 Returns the cosine of a number COS($N)

(19)Cosine

Angle:

Yes

No

(20)Cotangent

Angle:

No

Yes

No

Returns the 1/TAN($N) cotangent of an angle in radians Returns the exponential value of the specified value EXP($N)

(21)Exp

Value:

Yes

No

(22)Log

Value:

Yes

No

Returns the LOGN($N) natural logarithm of the specified value Returns the remainder of a division MOD($N,$N)

(23)Mod

Value: $Divided by: Angle: Square root of: Angle:

Yes

No

(24)Sine (25)Sqrt)

Y N

Yes Yes

No N

Returns the sine SIN($N) of a number Returns the square root of a number Returns the tangent of a number Returns the base 10 logarithm of the specified value SQRT($N)

(26)Tangent

Yes

No

TAN($N)

(27)Log10

Num exp:

Yes

No

LOG10($N)

Informix

340

Data Access Guide

Name

Trad/ Arguments Num exp: $Integer:

Type

Available Aggre Description in function gate list Yes No

SQL

(28)Power

Returns a value POW($N,$N) raised to the nth power Returns a ROUND($N,$ number rounded N) to n decimal places Returns a value truncated to x decimal places TRUNC($N,$ N)

(29)Round

Num exp: $Int N exp:

Yes

No

(30)Truncate

Num exp: $Int N exp: A

Yes

No

(31)RemoveBo Character th string:

Yes

No

Removes blank TRIM (BOTH characters from FROM $A) the right and left of a character string Returns the root ROOT($N,$N value of a ) numeric expression Returns DBINFO($A) information from the database Returns the HEX($N) hexadecimal equivalent of an integer expression Returns a date type value Adjusts the precision of a date value DATE($*) EXTEND()

(32)Root

Number: $Index number: Option:

Yes

No

(33)DBInfo

No

No

(34)Hex

Number:

Yes

(35)Date (36)Extend

Date:

D D

Yes No

No No

Functions

Data Access Guide

341

Name

Trad/ Arguments Number: $Number: $Number: Question:

Type

Available Aggre Description in function gate list Yes No Returns a complete date value Prompts the user to enter a specific value Prompts the user to enter a specific value Prompts the user to enter a specific value Converts a number to a character string

SQL

(37)MonthDay Year (38)Character prompt (39)Numeric prompt (40)Date prompt 41)Number to Char (42)Date to Char

MDY($N,$N, $N) @prompt($A,' A',,,) @prompt($A,' N',,,) @prompt($A,' D',,,) CAST($N AS CHAR(30))

Yes

No

Question:

Yes

No

Question:

Yes

No

Number:

Yes

No

Date:

Yes

No

Converts a date CAST($D AS to a character CHAR(30)) string

Informix

342

Data Access Guide

Microsoft SQL Server


Microsoft SQL Server function table
Name Trad/ Arguments String: $Initial position: $Number of characters: Function Type Available Aggre in function gate list No Description

0 Substring

Alphanumeric Yes

Extracts a sequence of characters from a character string Returns a character string in upper case Returns a character string in lower case Returns a specified number of characters from the right of a character string Removes blank characters from the left of a character string Returns the absolute value of a given expression Returns a number rounded to n decimal places Returns the square root of a number Selects the minimum value Selects the maximum value

1 Uppercase String: 2 Lowercase String: 3 Rightpart

Alphanumeric Yes Alphanumeric Yes

No No No

String: $Nbr of Alphanumeric Yes char. to extract::

4 LeftRemove

String:

Alphanumeric Yes

No

5 Absolute

Numeric expression: Number to round: $Precision: Square root of: Minimum of: Maximum of:

Numeric

Yes

No

6 Round

Numeric

Yes

No

7 Sqrt 8 Minimum 9 Maximum

Numeric Numeric Numeric

Yes Yes Yes

No Yes Yes

Functions

Data Access Guide

343

Name

Trad/ Arguments Average of: Sum of: Count of: Numeric expression: Numeric expression:

Function Type Numeric Numeric Numeric Numeric

Available Aggre in function gate list Yes Yes Yes Yes Yes Yes Yes No

Description

10 Average 11 Sum 12 Count 13 Ceil

Returns the average value Returns the sum of the values Returns the number of values Returns the value of a number rounded up to the nearest integer Returns the value of a number rounded down to the nearest integer Extracts part of a date value Returns the arc cosine of a numeric expression Returns the arc sine of a numeric expression Returns the arc tangent of a numeric expression Returns the angle in radians whose tangent is angle1/ angle2 Returns the cosine of a number Returns the sine of a number

14 Floor

Numeric

Yes

No

15 DateExtract

Model: $Date Expression:

Alphanumeric Yes Numeric Yes

No No

16 Arc cosine Value:

17 Arc sine

Value:

Numeric

Yes

No

18 Arc Tangent 19 Angle Tangent 2

Value:

Numeric

Yes

No

Angle 1: $Angle 2:

Numeric

Yes

No

20 Cosine 21 Sine

Angle: Angle:

Numeric Numeric

Yes Yes

No No

Microsoft SQL Server

344

Data Access Guide

Name

Trad/ Arguments Angle: Value: Value:

Function Type Numeric Numeric Numeric

Available Aggre in function gate list Yes Yes Yes No No No

Description

22 Tangent 23 Degrees 24 Exp

Returns the tangent of a number Converts radians to degrees Returns the exponential value of the specified value Returns the natural logarithm of the specified value Returns the base 10 logarithm of the specified value Returns a value raised to the nth power Converts degrees into radians Returns a number that represents the sign of the specified number Returns a random number between 0 and 1 Returns the constant value of 3.141592653589793 2 Returns the ASCII code of the character

25 Log

Value:

Numeric

Yes

No

26 Log10

Value:

Numeric

Yes

No

27 Power

Value: $Power:

Numeric

Yes

No

28 Radians 29 Sign

Value: Value:

Numeric Numeric

No No

No No

30 Random

Value:

Numeric

No

No

31 Pi

Numeric

No

No

32 ASCII code

Character:

Alphanumeric No

No

Functions

Data Access Guide

345

Name

Trad/ Arguments

Function Type

Available Aggre in function gate list No

Description

33 Character Value of the character: 34 Charindex Expression: $Object: 35 Difference Object 1: $Object 2:

Alphanumeric No

Returns the character that corresponds to the ASCII code Returns the position of an expression in a character string Returns the difference between the SOUNDEX value of two objects Returns the position of a character in a character string Repeats a character expression n number of times Reverses a string of characters Removes blank characters from the right of a character string Returns a character string representing phonetically the word(s) in the string Returns a string with the number of blank characters Returns a value set to a specific length

Numeric

No

No

Numeric

No

No

36 Patindex

Pattern: $Object: Numeric

No

No

37 Replicate

Expression: $Number of times: Expression: Object:

Alphanumeric Yes

No

38 Reverse 39 Rtrim

Alphanumeric Yes Alphanumeric Yes

No No

40 Soundex

String:

Alphanumeric Yes

No

41 Space

Number of times:

Alphanumeric No

No

42 Str

Alphanumeric No

No

Microsoft SQL Server

346

Data Access Guide

Name

Trad/ Arguments String1: $Initial position: $Number of characters: String2:

Function Type

Available Aggre in function gate list No

Description

43 Stuff

Alphanumeric No

Replaces a sequence of characters with other characters

44 Conversion 45 Cotangent Value:

Alphanumeric No Numeric Yes

No No

Converts datatypes Returns the cotangent of an angle in radians Returns the remainder of a division Concatenates two character strings Returns a specified number of characters from the left of a character string Returns the length of a character string Returns the current date Returns the day of the week (1 equals Sunday) Returns the day of the month (1-31) Returns the day of the year (1-366) Returns the number of the week (1-52)

46 Mod

Value: $Divided by String1: $String2: String: $Length:

Numeric

Yes

No

47 Concat 48 Left

Alphanumeric Yes Alphanumeric Yes

No No

49 Length 50 Current date 51 Day of week 52 Day of month 53 Day of year

Object:

Numeric Date

Yes Yes Yes

No No No

Date:

Numeric

Date: Date:

Numeric Numeric Numeric

Yes Yes Yes

No No No

54 Number of Date: the week

Functions

Data Access Guide

347

Name

Trad/ Arguments

Function Type Numeric Numeric Numeric

Available Aggre in function gate list Yes Yes Yes Yes No No No No

Description

55 Number of Date: the month 56 Year 57 Quarter 58 Locate Date: Date:

Returns the number of the month (1-12) Returns the year Returns the quarter Returns the position of a character in a character string Returns TRUE if the expression is NULL Prompts the user to enter a specific value Prompts the user to enter a specific value Prompts the user to enter a specific value Returns a value that depends on which of the specified set of conditions is met Converts a number to a character string Converts a date to a character string

Search: $Object: Numeric

59 IsNull

Expression:

Numeric

Yes

No No No No No

60 Character Question: prompt 61 Numeric prompt 62 Date prompt 63 Case Question: Question: Value: $Expression: $Result1: $Result2:

Alphanumeric Yes Numeric Date Yes Yes

Alphanumeric No

64 Number to Number: Char 65 Date to Char Date:

Alphanumeric Yes Alphanumeric Yes

No No

Microsoft SQL Server

348

Data Access Guide

Oracle
Oracle Function table
Name Trad/ Function Arguments Type Available Aggre in gate function list No Description

0 Substring

String: Alphanumeric Yes $Initial position: $Number of characters: String: String: String: Alphanumeric Yes Alphanumeric Yes Alphanumeric Yes

Extracts a sequence of characters from a character string

1 Uppercase 2 Lowercase 3 Initial_caps

No No No

Returns a character string in upper case Returns a character string in lower case Capitalizes the first letter of a character string, while the remaining letters appear in lower case Transforms each occurrence of the old character by the new character Replaces a string of characters by a new string Returns a number rounded to n decimal places

4 Transforms

Replace in: Alphanumeric Yes $Old character: $New character: Replace in: Alphanumeric Yes $Old string: $New string: Number to Alphanumeric Yes round off: $Number of decimals

No

5 Replace

No

6 Round

No

Functions

Data Access Guide

349

Name

Trad/ Function Arguments Type

Available Aggre in gate function list Yes Yes Yes Yes Yes Yes No Yes Yes Yes Yes Yes

Description

7 Sqrt 8 Minimum 9 Maximum 10 Average 11 Sum 12 Variance

Number: Minimum of: Maximum of:

Numeric Numeric Numeric

Returns the square root of a number Selects the minimum value Selects the maximum value Returns the average value Returns the sum of the values Returns the statistical variance of a group of values Returns the standard deviation of a group of values Returns the number of values Returns the value of a number rounded up to the nearest integer Returns the value of a number rounded down to the nearest integer Returns the remainder of a division Returns a value raised to the nth power Returns a value truncated to x decimal places

Average of: Numeric Sum of: Numeric

Variance of: Numeric

13 Stddev

Stddev of:

Numeric

Yes

Yes

14 Count 15 Ceil

Number of: Value:

Numeric Numeric

Yes Yes

Yes No

16 Floor

Value:

Numeric

Yes

No

17 Mod

Value: $Divided by: Value: $Power: Value: $Decimal:

Numeric

Yes

No

18 Power 19 Trunc

Numeric Numeric

Yes Yes

No No

Oracle

350

Data Access Guide

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No

Description

20 Character

Value of the Alphanumeric Yes character: String: Numeric Yes

Returns a character corresponding to its ASCII code Returns how many bytes are necessary to store ORACLE internally Adds characters to the left of a character string as many times as necessary

21 ORACLESize

No

22 Left padding Character String: $Length: $Character s: 23 Left trim Character String: $Character s: Character String: $Length: $Character s: Character String: $Character s: String:

Alphanumeric Yes

No

Alphanumeric Yes

No

Removes characters from the left of a character string Adds characters to the right of a character string as many times as necessary Removes characters from the right of a character string Returns a character string representing phonetically the word(s) in the string Returns the ASCII code of a character Returns the position of a character in a character string

24 Right padding

Alphanumeric Yes

No

25 Right trim

Alphanumeric Yes

No

26 Soundex

Alphanumeric Yes

No

27 ASCII 28 Instr

Character: Character String: $Search:

Alphanumeric Yes Numeric Yes

No No

Functions

Data Access Guide

351

Name

Trad/ Function Arguments Type

Available Aggre in gate function list Yes No No No No No No

Description

29 Length

Object:

Numeric Numeric

Returns the length of a character string Converts a value to ROWID Converts a value to a character string Converts a date to a character string Converts a character string to a numerical value Converts a character string to a date value Adds a number of months to a date Returns the last day of the month of a defined date If Object 1 is null, returns Object 2; if Object 1 is not null, returns Object 1 If Object 1 is null, returns Object 2; if Object 1 is not null, returns Object 1 If Object 1 is null, returns Object 2; if Object 1 is not null, returns Object 1 Returns the number of months between two dates

30 Chartorowid Rowid: 31 To_char 32 Date to Char Value: Date:

Alphanumeric Yes Alphanumeric Yes Numeric Yes

33 To_number String:

34 To_date

String: $Format:

Date

Yes Yes

No No

35 Add months Date: Date $Number of month: 36 Last day 37 Character NVL 38 Numeric NVL 39 Date NVL Date: Object 1: $Object 2: Object 1: $Object 2: Object 1: $Object 2: Date

No

No No

Alphanumeric Yes

Numeric

Yes

No

Date

Yes

No

40 Months between

Source Numeric Date: $Destinatio n Date:

Yes

No

Oracle

352

Data Access Guide

Name

Trad/ Function Arguments Type

Available Aggre in gate function list Yes No No No No No

Description

41 Next_day 42 Decode 43 Greatest 44 Least 45 UID

Date: $Day: Date

Alphanumeric No Alphanumeric No Alphanumeric No Numeric No

Compares and replaces strings Returns the greatest value from a list Returns the smallest value from a list Returns the unique integer assigned to each username Returns the username of the current ORACLE user Returns the absolute value of a number Returns a number that represents the sign of the specified number Returns the date and time

46 User 47 Absolute 48 Sign Value: Value:

Alphanumeric No Numeric Numeric Yes Yes

No No No

49 New Time

Date: $Time Zone1: $Time Zone2:

Date

No

No

50 Sysdate 51 Dump

Date

No

No No

Returns the current date and time Returns a value containing the type, length and internal format of an expression Returns information about the current session

Alphanumeric No

52 UserEnv

Option:

Alphanumeric No

No

Functions

Data Access Guide

353

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No No

Description

53 Nlssort 54 Add Days

String:

Alphanumeric No Yes

Returns a string of bytes to sort a character string Adds a number of days to a date Returns the number of days between date1 and date2 Concatenates two character strings Prompts the user to enter a specific value Prompts the user to enter a specific value Prompts the user to enter a specific value Returns an ordered ranking of rows starting with a rank of one Returns the sum over a set of rows Returns the average over a set of rows Returns the quantity over a set of rows Returns the minimum over a set of rows Returns the maximum over a set of rows

Date: Date $Number of days: Date1: $Date2: String1: $String2: Question: Numeric

55 Days between 56 Concat 57 Character prompt

Yes

No

Alphanumeric Yes Alphanumeric Yes Numeric Yes

No No No

58 Question: Numeric_prom pt 59 Date prompt Question: 60 RANK OVER

Date

Yes No

No No

Rank over : Numeric

61 SUM OVER Sum over : 62 AVG OVER Average over : 63 COUNT OVER 64 MIN OVER

Numeric Numeric

No No No No No

No No No No No

Count over : Numeric Min over : Numeric Numeric

65 MAX OVER Max over :

Oracle

354

Data Access Guide

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No No

Description

66 RATIO_TO_R EPORT 67 CUME_DIST OVER

Ratio_to_re Numeric port over : Cume_dist over : Numeric

Computes the ratio of a value to the sum of a set of values Calculates the cumulative distribution of a value in a group of values Computes the rank of each row returned from a query with respect to the other rows Returns the first value in an ordered set of values Returns the last value in an ordered set of values Provides access to a row at a given physical offset prior to that position Provides access to a row at a given physical offset beyond that position Divides an ordered dataset into a number of buckets indicated by expr and assigns the appropriate bucket number to each row Calculates the rank of a row minus 1, divided by 1 less than the number of rows being evaluated

No

No

68 Dense_ran DENSE_RANK k over : OVER 69 First_value FIRST_VALUE over : OVER 70 LAST_VALUE OVER 71 LAG Last_value over : Lag :

Numeric

No

No

Alphanumeric No

No

Alphanumeric No

No

Alphanumeric No

No

72 LEAD

Lead :

Alphanumeric No

No

73 NTILE

Ntile :

Numeric

No

No

74 Percent PERCENT_RA rank : NK

Numeric

No

No

Functions

Data Access Guide

355

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No No

Description

75 PERCENTILE _CONT

Percentile cont :

Numeric

Takes a percentile value and a sort specification, and returns an interpolated value that would fall into that percentile value with respect to the sort specification Takes a percentile value and a sort specification and returns an element from the set Assigns a unique number to each row to which it is applied, in the ordered sequence of rows specified in the order_by_clause, beginning with 1 Returns the cumulative coefficient of correlation of a set of number pairs over a set of rows Returns the cumulative population covariance of a set of number pairs over a set of rows Returns the cumulative sample covariance of a set of number pairs over a set of rows

76 PERCENTILE _DISC

Percentile disc :

Numeric

No

No

77 Row ROW_NUMBE number : R

Numeric

No

No

78 CORR OVER

Corr over:

Numeric

No

No

79 COVAR_POP OVER 80 COVAR_SAM P OVER

Covar_pop over:

Numeric

No

No

Covar_sam Numeric p over:

No

No

Oracle

356

Data Access Guide

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No No

Description

81 Regr_slope Numeric REGR_SLOPE over: OVER 82 REGR_INTER CEPT OVER 83 REGR_COUN T OVER Regr intercept over: Regr count over: Numeric

Returns the cumulative slope of the regression line over a set of rows Returns the cumulative yintercept of the regression line over a set of rows Returns the cumulative number of non-null number pairs used to fit the regression line over a set of rows Returns the cumulative coefficient of determination for the regression line over a set of rows Makes the following computation AVG(expr2) over a set of rows after the elimination of null (expr1, expr2) pairs Makes the following computation AVG(expr1) over a set of rows after the elimination of null (expr1, expr2) pairs

No

No

Numeric

No

No

84 REGR_R2 OVER

Regr R2 over:

Numeric

No

No

85 REGR_AVGX OVER

Regr avgx over:

Numeric

No

No

86 REGR_AVGY OVER

Regr avgy over:

Numeric

No

No

Functions

Data Access Guide

357

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No No

Description

87 REGR_SXX Regr sxx OVER over:

Numeric

Makes the following computation REGR_COUNT(expr1, expr2) * VAR_POP(expr2) over a set of rows after the elimination of null (expr1, expr2) pairs Makes the following computation REGR_COUNT(expr1, expr2) * VAR_POP(expr1) over a set of rows after the elimination of null (expr1, expr2) pairs Makes the following computation REGR_COUNT(expr1, expr2) * COVAR_POP(expr1, expr2) over a set of rows after the elimination of null (expr1, expr2) pairs Returns the cumulative standard deviation over a set of rows Returns the cumulative population standard deviation over a set of rows

88 REGR_SYY Regr syy OVER over:

Numeric

No

No

89 REGR_SXY Regr sxy OVER over:

Numeric

No

No

90 STDDEV OVER

Stddev over:

Numeric

No

No

91 Stddev pop Numeric STDDEV_POP over: OVER

No

No

Oracle

358

Data Access Guide

Name

Trad/ Function Arguments Type

Available Aggre in gate function list No No

Description

92 Stddev STDDEV_SAM samp over: P OVER

Numeric

Returns the cumulative sample standard deviation of a set of numbers over a set of rows Returns the cumulative population variance of a set of numbers over a set of rows Returns the cumulative sample variance of a set of numbers over a set of rows Returns the cumulative variance of a set of numbers over a set of rows

93 VAR_POP OVER

Regr sxy over:

Numeric

No

No

94 VAR_SAMP Regr sxy OVER over:

Numeric

No

No

95 VARIANCE variance OVER over:

Numeric

No

No

Functions

Data Access Guide

359

Red Brick
Red Brick function table
The code for data type (Type) used in the table is as follows: A = Alphanumeric N = Numeric D = Date Name Trad/ Arguments Type Available Aggre Description in gate function list A Y N SQL

(0)Substring

String: $Initial position: $Number of characters:

Extracts a SUBSTR($A,$ sequence of N,$N) characters from a character string Selects the minimum value Selects the maximum value Returns the average value Returns the sum of the values MIN($N) MAX($N) AVG($N) SUM($N)

(1)Minimum (2)Maximum (3)Average (4)Sum (5)Count (6)Running total (7)Moving average

Minimum of: N Maximum of: N Average of: Sum of: Number of: Running total of: Moving average of: $Number of rows: N N N N

Y Y Y Y Y Y

Y Y Y Y Y Y

Returns the COUNT($*) number of values Returns the runnning total of the values CUME($N)

Returns the MOVINGAVG( average of the $N,$N) values for the last n rows

Red Brick

360

Data Access Guide

Name

Trad/ Arguments

Type Available Aggre Description in gate function list Y Y Returns the sum of the values for the last n rows

SQL

(8)Moving sum Moving sum N of: $Number of rows: (9)Rank Rank of: N

MOVINGSUM( $N,$N)

Returns the rank RANK($N) of a specified value relative to a group of values Returns the ratio RATIOTOREP of a value to the ORT($N) sum of a group of values Classifies the TERTILE($N) value of an expression into (H)igh, (M)edium, or (L)ow Trims leading blanks Removes blank characters from the right of a character string Removes blank characters from the right and left of a character string Compares and replaces strings LTRIM($A) RTRIM($A)

(10)Ratio to report

Ratio to report of:

(11)Tertile

Tertile of:

(12)LeftRemov String: e (13)RightRemo String: ve

Y A

N Y

N N

(14)Trim

String: $Set: A

TRIM($A,$A)

(15)Decode (16)Ifnull

A A

N N

N N

DECODE()

Returns a string if IFNULL() NULL

Functions

Data Access Guide

361

Name

Trad/ Arguments

Type Available Aggre Description in gate function list A Y N

SQL

(17)Current User

Returns the CURRENT_US username of the ER current Red Brick user Returns a value that depends on which of the specified set of conditions is met CASE $A WHEN $A THEN $A ELSE $A END

(18)Case

Case expression: $Case expression: $Result: $Result:

(19)Coalesce

Expression: N $Expression : Expression: A $Expression : Expression: $Substitute: N

Returns the value COALESCE($ of the first N,$N) argument that is not NULL Returns the value COALESCE($ of the first A,$A) argument that is not NULL Tests an expression for missing values and replaces each one with a specific value IFNULL($N,$N)

(20)Coalesce

(21)If Null

(22)Absolute

Numeric expression:

Returns the ABS($N) absolute value of a given expression Returns the value CEIL($N) of a number rounded up to the nearest integer

(23)Ceil

Numeric expression:

Red Brick

362

Data Access Guide

Name

Trad/ Arguments

Type Available Aggre Description in gate function list A N N

SQL

(24)Decimal

Expression: $Precision: $Scale: Expression:

Converts a DEC($N,$N,$N specified value to ) a DECIMAL value Returns a specified value into a floatingpoint value FLOAT($N)

(25)Float

(26)Floor

Value:

Returns the value FLOOR($N) of a number rounded down to the nearest integer Returns the integer portion of a number INT($N)

(27)Integer

Numeric expression: Value:

(28)Sign

Returns a number SIGN($N) that represents the sign of the specified number Concatenates two character strings CONCAT($A,$ A)

(29)Concat

String1: $String2:

(30)Uppercase String:

Returns a UPPER($A) character string in upper case Returns a LOWER($A) character string in lower case Converts a value to a character string CHAR($N,$N,$ N)

(31)Lowercase String:

(32)To char

Expression: $Length: $Scale:

Functions

Data Access Guide

363

Name

Trad/ Arguments

Type Available Aggre Description in gate function list A Y N Returns the current date and time Returns the current date Returns the current time

SQL

(33)Current date and time (34)Current Date (35)Current time (36)To date String:

CURRENT_TI MESTAMP CURRENT_DA TE CURRENT_TI ME

A A D

Y Y Y

N N N

Converts a DATE($A) character string to a date value Adds an interval to a datetime value DATEADD($D, $N,$D)

(37)Add Date

Date: $Interval: $Date:

(38)Date Difference

Date: $date: N $Date

Returns the DATEDIFF($D, difference $D,$D) between two date values Extracts part of a DATENAME($ date value A,$A) Extracts part of a EXTRACT($A date value FROM $D) Creates a time value Creates a timestamp value TIME() TIMESTAMP()

(39)CharDateE Date part: xtract $Datetime expression: (40)NumericDa Date part: teExtract $Datetime expression: (41)Time (42)TimeStamp (43)Character prompt Question:

D D A

N N Y

N N N

Prompts the user @PROMPT($A to enter a specific ,'A',,,) value

Red Brick

364

Data Access Guide

Name

Trad/ Arguments

Type Available Aggre Description in gate function list N Y N

SQL

(44)Numeric prompt (45)Date prompt

Question:

Prompts the user @PROMPT($A to enter a specific ,'N',,,) value Prompts the user @PROMPT($A to enter a specific ,'D',,,) value Converts numeric STRING($*,$A) or datetime values to character strings Converts an REAL($A) expression into a real value Converts an STRING($N, expression into a $N, $N) string Converts an STRING($D, expression into a $N, $N) string Compares two expressions Determines the rank of a value Extracts the day part of a date value Extracts the month part of a date value NULLIF($A,$A)

Question:

(46)Expression Expression: A $Expression : (47)Real Numeric expression: Expression: $Length: $Scale: Expression: $Length: $Scale: N

(48)NumberTo String (49)DateToStri ng (50)Nullif

Expression: A $Expression : Numeric: $Integer: N N

(51)Ntile (52)NumericDa yExtract (53)NumericMo nthExtract

Y Y

N N

NTILE($N,$N) EXTRACT(DA Y FROM $D) EXTRACT(MO NTH FROM $D)

Functions

Data Access Guide

365

Name

Trad/ Arguments

Type Available Aggre Description in gate function list N Y N Extracts the year part of a date value Extracts the quarter part of a date value Converts a number to a character string Converts a date to a character string

SQL

(54)NumericYe arExtract (55)NumericQu arterExtract (56)Number to Char (57)Date to Char Number:

EXTRACT(YE AR FROM $D) EXTRACT(QU ARTER FROM $D) N SQL=STRING( $N) N SQL=STRING( $D)

Date:

Red Brick

366

Data Access Guide

Sybase
Sybase function table
The code for data type (Type) used in the table is as follows: A = Alphanumeric N = Numeric D = Date

Name

Trad/ Arguments

Type

Available Aggre Description in function gate list Yes No

SQL

(0)Substring

String: $Initial A position: $Number of characters: String: A

Extracts a substring($A sequence of ,$N,$N) characters from a character string Returns a character string in upper case Returns a character string in lower case upper($A)

(1)Uppercase

Yes

No

(2)Lowercase

String

Yes

No

lower($A)

(3)Rightpart

Character String: $Nbr of char. to extract: Character String: Numeric expression:

Yes

No

Returns a right($A,$N) specified number of characters from the right of a character string Removes leading ltrim($A) blanks from the character string Returns the abs($N) absolute value of a given expression

(4)RemoveLe adBlanks (5)Absolute

Yes

No

Yes

No

Functions

Data Access Guide

367

Name

Trad/ Arguments Number to round: $Precision: Square root of: Minimum of: Maximum of: Average of: Sum of: Count of: Numeric expression:

Type

Available Aggre Description in function gate list Yes N Returns a number rounded to n decimal places Returns the square root of a number Selects the minimum value Selects the maximum value Returns the average value Returns the sum of the values

SQL

(6)Round

round($N,$N )

(7)Sqrt

Yes

No

sqrt($N)

(8)Minimum (9)Maximum (10)Average (11)Sum (12)Count (13)Ceil

N N N N N N

Yes Yes Yes Yes Yes Yes

Yes Yes Yes Yes Yes No

min($*) max($*) avg($N) sum($N)

Returns the count($*) number of values Returns the value ceiling($N) of a number rounded up to the nearest integer Returns the value floor($N) of a number rounded down to the nearest integer Extracts part of a Datename($ date value A,$D) Returns the arc cosine of a numeric expression acos($N)

(14)Floor

Numeric expression:

Yes

No

(15)DateExtra Model: $Date A ct Expression: (16)Arc cosine Value: N

Yes Yes

No No

Sybase

368

Data Access Guide

Name

Trad/ Arguments Value:

Type

Available Aggre Description in function gate list Yes No

SQL

(17)Arc sine

Returns the arc asin($N) sine of a numeric expression Returns the arc tangent of a numeric expression atan($N)

(18)Arc tangent

Value:

Yes

No

(19)Angle Tangent 2

Angle 1: $Angle 2:

Yes

No

Returns the angle atn2($N,$N) in radians whose tangent is angle1/ angle2 Returns the cosine of a number Returns the sine of a number Returns the tangent of a number cos($N)

(20)Cosine

Angle:

Yes

No

(21)Sine (22)Tangent

Angle: Angle:

N N

Yes Yes

No No

sin($N) tan($N)

(23)Degrees (24)Exp

Value: Value:

No No

Yes Yes

No No

Converts radians degrees($N) to degrees Returns the exp($N) exponential value of the specified value Returns the log($N) natural logarithm of the specified value Returns the base log10($N) 10 logarithm of the specified value

(25)Log

Value:

Yes

No

(26)Log10

Value:

Yes

No

Functions

Data Access Guide

369

Name

Trad/ Arguments Value: $Power: Value:

Type

Available Aggre Description in function gate list Yes No Returns a value raised to the nth power Converts degrees into radians

SQL

(27)Power

power($N,$ N) radians($N)

(28)Radians

No

No

(29)Sign

Value:

No

No

Returns a sign($N) number that represents the sign of the specified number Returns a random number between 0 and 1 rand($N)

(30)Random

Value:

No

No

(31)Pi

No

No

Returns the pi() constant value of 3.141592653589 7932 Returns the ASCII code of a character Returns the character that corresponds to the ASCII code Returns the position of an expression in a character string ascii($C)

(32)ASCII code (33)Character

Character:

No

No

Value of the character:

No

No

char($N)

(34)Charindex Expression: $Object:

No

No

charindex($ A,$A)

(35)Difference Object 1: $Object 2:

No

No

Returns the difference($ difference A,$A) between the SOUNDEX value of two objects

Sybase

370

Data Access Guide

Name

Trad/ Arguments Pattern: $Object:

Type

Available Aggre Description in function gate list No No Returns the position of a character in a character string Repeats a character expression n number of times

SQL

(36)Patindex

patindex($A, $A)

(37)Replicate

Expression: $Number of times: Expression:

Yes

No

replicate($A, $N)

(38)Reverse

A A

Yes Yes

No No

Reverses a string reverse($A) of characters Removes trailing rtrim($A) blanks from the character string Returns a character string representing phonetically the word(s) in the string Returns a string with the number of blank characters Returns a value set to a specific length Replaces a sequence of characters with other characters soundex($A)

(39)RemoveTr Character ailBlanks String: (40)Soundex String:

Yes

No

(41)Space

Number of times:

No

No

space($N)

(42)Str

No

No

str()

(43)Stuff

String1: $Initial position: $Number of characters: String2:

No

No

stuff($A,$N, $N,$A)

(44)Conversio n

No

No

Converts datatypes

Convert()

Functions

Data Access Guide

371

Name

Trad/ Arguments Question:

Type

Available Aggre Description in function gate list Yes No

SQL

(45)Character prompt (46)Numeric prompt (47)Date prompt (48)Case

Prompts the user @prompt($A to enter a specific ,'A',,,) value Prompts the user @prompt($A to enter a specific ,'N',,,) value Prompts the user @prompt($A to enter a specific ,'D',,,) value Returns a value that depends on which of the specified set of conditions is met Converts a number to a character string Converts a date to a character string CASE $A WHEN $A THEN $A ELSE $A END convert(char ,$N) convert(char ,$D)

Question:

Yes

No

Question:

Yes

No

Value: $Expression: $Result1: $Result2:

No

No

(49)Number to Number: Char (50)Date to Char Date:

Yes

No

Yes

No

Sybase

372

Data Access Guide

Teradata
Teradata function table
Name Trad/ arguments Type Available Aggre Description in gate function list Yes Yes Yes Yes Yes Yes Yes yes Yes No Selects the minimum value SQL

0 Minimum Minimum of: Numeric 2 Average 3 Sum 4 Count 5 Concat Average of: Sum of: Count of: String1: $String2: String: $Length: Numeric Numeric Numeric Alphanu meric Alphanu meric

min($*)

Returns the average avg($N) value Returns the sum of the values Counts the number of entries Concatenates two character strings sum($N) count($*) {fn concat($A,$ A)}

6 Left

Yes

No

Returns a specified {fn number of left($A,$N)} characters from the left of a character string Returns the length {fn of a character string length($A)} Returns the position {fn of a character in a locate($A,$A character string )} Removes blank {fn rtrim($A)} characters from the right of a character string

7 Length 8 Locate

Object: Object: $Search: Object:

Numeric Numeric

Yes Yes

No No

9 Rtrim

Alphanu meric

Yes

No

Functions

Data Access Guide

373

Name

Trad/ arguments

Type

Available Aggre Description in gate function list Yes No

SQL

10 Substring

String: Alphanu $Initial meric position: $Number of characters: Alphanu meric Numeric

Extracts a sequence {fn of characters from a substring($A, character string $N,$N)}

11 String: Uppercase 12 Absolute 13 Exp Numeric expression: Value:

Yes Yes

No No

Returns a character {fn string in upper case ucase($A)} Returns the absolute value of a given expression {fn abs($N)}

Numeric

Yes

No

Returns the {fn exp($N)} exponential value of the specified value Returns the natural logarithm of the specified value Returns the remainder of a division {fn log($N)}

14 Log

Value:

Numeric

Yes

No

15 Mod

Value: Numeric $Divided by Numeric

Yes

No

{fn mod($N,$N)}

16 Pi

No

No

Returns the {fn pi()} constant value of 3.14159265358979 32 Returns the square root of a number {fn sqrt($N)}

17 Sqrt 18 Character prompt 19 Numeric prompt

Square root Numeric of: Question: Alphanu meric Numeric

Yes Yes

No No

Prompts the user to @prompt($A enter a specific ,'A',,,) value Prompts the user to @prompt($A enter a specific ,'N',,,) value

Question:

Yes

No

Teradata

374

Data Access Guide

Name

Trad/ arguments

Type

Available Aggre Description in gate function list Yes No

SQL

20 Date prompt

Question:

Date

Prompts the user to @prompt($A enter a specific ,'D',,,) value Removes blank TRIM characters from the (TRAILING right of a character FROM $A) string Removes blank TRIM characters from the (LEADING left of a character FROM $A) string Removes blank TRIM (BOTH characters from the FROM $A) right and left of a character string Chooses different results based on the value of an expression Compares two expressions CASE $A WHEN $A THEN $A ELSE $A END NULLIF($A, $A)

21 Character RightRemo string: ve 22 Character LeftRemov string: e 23 Character RemoveBo string: th 24 Case

Alphanu meric

Yes

No

Alphanu meric

Yes

No

Alphanu meric

Yes

No

Value: Alphanu $Expressio meric n: $Result1: $Result2: Expression 1: $Expressio n2: Alphanu meric

Yes

No

25 NullIf

Yes

No

26 Coalesce

Expression: Alphanu meric Numeric

Yes

No

Returns the value of GROUP=N the first argument SQL=COAL that is not NULL ESCE($A) Extracts the year part of a date value EXTRACT(Y EAR FROM $D)

27 Date: YearExtrac t

Yes

No

Functions

Data Access Guide

375

Name

Trad/ arguments

Type

Available Aggre Description in gate function list Yes No Extracts the month part of a date value Extracts the day part of a date value Extracts the hour part of a time value Extracts the minute part of a time value

SQL

28 MonthExtr act

Date:

Numeric

EXTRACT(M ONTH FROM $D) EXTRACT(D AY FROM $D) EXTRACT(H OUR FROM $N) EXTRACT(M INUTE FROM $N)

29 Date: DayExtract 30 Time: HourExtrac t 31 Time: MinuteExtr act 32 Time: SecondExt ract 33 Add months 34 CurrentDat e 35 Value Cumulative expression: sum $Sort expression: 36 Moving average Value expression: $Width: $Sort expression:

Numeric

Yes

No

Numeric

Yes

No

Numeric

Yes

No

Numeric

Yes

No

Extracts the second EXTRACT(S part of a time value ECOND FROM $N) Adds a number of months to a date Returns the current date Returns the cumulative sum of the values ADD_MONT HS($D, $N) DATE

Date: Date $Number of months: Date

Yes

No

Yes

No

Numeric

No

No

CSUM($N,$* )

Numeric

No

No

Returns the moving MAVG($N,$ average of the N,$*) values for the last n rows

Teradata

376

Data Access Guide

Name

Trad/ arguments

Type

Available Aggre Description in gate function list No No

SQL

37 Rank

Sort expression:

Numeric

Returns the rank of RANK($*) a specified value relative to a group of values Returns the moving MSUM($N,$ sum of the values N,$*) for the last n rows

38 Moving sum

Value expression: $Width: $Sort expression list: Value expression: $Width: $Sort expression list:

Numeric

No

No

39 Moving difference

Numeric

No

No

Returns the moving MDIFF($N,$ difference of the N,$*) values for the last n rows

40 Quantile

Quantile Numeric constant: $Sort Expression: Numeric

No

No

Returns the quantile QUANTILE($ scores for the N,$*) values in a column Returns a MLINREG($ predicated value for N,$N,$*) a column

41 Moving Value linear expression: regression $Width: $Sort expression: 42 Number Number: to Char

No

No

Alphanu meric

Yes

No

Converts a number CAST($N AS to a character string CHAR(30))

Functions

Data Access Guide

377

Name

Trad/ arguments

Type

Available Aggre Description in gate function list Yes No No No

SQL

43 Date to Char 44 Rank Over

Date:

Alphanu meric

Converts a date to a CAST($D AS character string CHAR(30)) Returns an ordered ranking of rows starting with a rank of one RANK() OVER (PARTITION BY ($*) ORDER BY ($*))

Rank over: Numeric $Sort Expression:

48 Percent Percent Numeric Rank Over Rank over: $Sort Expression:

No

No

Returns the relative PERCENT_ rank of rows RANK() OVER (PARTITION BY ($*) ORDER BY ($*))

Teradata

378

Data Access Guide

Functions

General Data Access Configuration File Reference

chapter

380

Data Access Guide

Overview
This chapter provides a reference for all default parameters in driver.sbo files for the following RDBMS: IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata Other parameters
NOTE

If you are using WebIntelligence, you must make sure that any parameters modified in your driver.sbo file are also modified in the cs.cfg file. See individual parameters in this appendix for more information. For more information on configuring data access to WebIntelligence, see WebIntelligence Data Access Configuration File Reference on page 425.

General Data Access Configuration File Reference

Data Access Guide

381

IBM DB2
ArrayFetch
ArrayFetch=n

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

AsyncMode
AsyncMode=0|1

Parameter Type Syntax Default value

Boolean ASYNCMODE=value

Specifies whether or not to activate the asynchronous mode. Values 0 Asynchronous mode is deactivated. This is the default value. 1 Asynchronous mode is activated.

Cost Estimate Unit


Cost Estimate Unit = 0 | 1

Syntax Description

COST ESTIMATE UNIT=value Any RDBMS supporting the cost estimate

Specifies how the database returns a cost estimate.

IBM DB2

382

Data Access Guide

Values 0 Returns a cost estimate based on time. This is the default value. 1 Returns a cost estimate based on the number of blocks, or other unit type. The unit type depends on the RDBMS you access.

DriverLevel
DriverLevel=1|13|15|31

Parameter Type Syntax Default value

Numeric DriverLevel=value

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.
NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

InputDateFormat
InputDateFormat=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MMDD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/yyyy hh:m:s am/ pm|yyyy-mm-dd

Parameter Type Syntax Default value

Alphanumeric InputDateFormat=value 'yyyy-mm-dd HH:mm:ss'

Specifies the default date and hour formats generated in the WHERE clause of a SQL script.

General Data Access Configuration File Reference

Data Access Guide

383

Values 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats for IBM DB2 servers. Other RDBMS-specific date and time formats.

NOTE

If you are using WebIntelligence, you must also modify the Input Date Format parameter in the cs.cfg file. For more information, see InputDateFormat on page 399.

IsThreadSafe
IsThreadSafe=0|1

Parameter Type Syntax Default value

Boolean IsThreadSafe=value

Specifies if the driver is safe to accept multi-threading. Values 0 The driver accepts multi-threading. 1 The driver does not accept multi-threading.

Pool Time
Pool Time=0 | -1 | n

Parameter Type Syntax Default value Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the default value (1). Pool Time=value

IBM DB2

384

Data Access Guide

RecommendedLenTransfert
RecommendedLenTransfert=n

Parameter Type Syntax Default value Specifies the number of bytes per block. This parameter is used when exporting a document. Values RDBMS specific Note: For IBM DB2/UDB for OS/390, do not increase the default value above the buffer pool size.
NOTE

Pool Time=value

If you are using WebIntelligence, you must also modify the Binary Slice Size in the cs.cfg file. For more information, see Binary Slice Size on page 439.

RemovePV
RemovePV=0 | 1

Parameter Type Syntax Default value

Boolean RemovePV=value

Specifies that semicolons are removed at the end of SQL statements. Values 0 Specifies that semicolons are removed at the end of SQL statements. 1 Specifies that semicolons are not removed at the end of SQL statements.

Shared
Shared=1|2|4

General Data Access Configuration File Reference

Data Access Guide

385

Parameter Type Syntax Default value

Numeric Shared=value 4

Specifies the default connection type. Values 1 Specifies that Personal is the default connection type. 2 Specifies that Shared is the default connection type. 4 Specifies that Secured is the default connection type.

SQL External File


Parameter Type Syntax Default value String SQL External File=value None

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

IBM DB2

386

Data Access Guide

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value None

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

General Data Access Configuration File Reference

Data Access Guide

387

Informix
AsyncMode
AsyncMode=0|1

Parameter Type Syntax Default value

Boolean ASYNCMODE=value 0

Specifies whether or not to activate the asynchronous mode. Values 0 Asynchronous mode is deactivated. This is the default value. 1 Asynchronous mode is activated.

ArrayFetch
ArrayFetch=n

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value 10

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

Shared
Shared=1|2|4

Parameter Type Syntax Default value

Numeric Shared=value 4

Specifies the default connection type.

Informix

388

Data Access Guide

Values 1 Specifies that Personal is the default connection type. 2 Specifies that Shared is the default connection type. 4 Specifies that Secured is the default connection type.

DriverLevel
DriverLevel=1|13|15|31

Parameter Type Syntax Default value

Numeric DriverLevel=value 31

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.
NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

Pool Time
Pool Time=0|-1|n

Parameter Type Syntax Default value Pool Time=value 1

Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the

General Data Access Configuration File Reference

Data Access Guide

389

transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the default value (1).

SQL External File


Parameter Type Syntax Default value String SQL External File=value informix

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file).
NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value informix

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file).
NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

InputDateFormat
InputDateFormat=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MM-

Informix

390

Data Access Guide

DD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/yyyy hh:m:s am/ pm|yyyy-mm-dd

Parameter Type Syntax Default value

Alphanumeric InputDateFormat=value MM/DD/YYYY'

Specifies the default date and hour formats generated in the WHERE clause of a SQL script. Values {\d 'yyyy-mm-dd'} This is the default date format with ODBC. 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with Oracle. 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats with MS SQL Server and for most IBM DB2 servers. Other RDBMS-specific date and time formats.
NOTE

If you are using WebIntelligence, you must also modify the Input Date Format parameter in the cs.cfg file. For more information, see InputDateFormat on page 399.

AuditTimeStampFormat
InputDateFormat=yyyy-mm-dd HH:mm:ss

Parameter Type Syntax Default value

Alphanumeric AuditTimeStampFormat=value 'YYYY-MM-DD HH:MM:SS'

Specifies the default date and hour format generated in the WHERE clause of a SQL script used by the WebIntelligence auditing feature.

IsThreadSafe
IsThreadSafe=0|1

General Data Access Configuration File Reference

Data Access Guide

391

Parameter Type Syntax Default value

Boolean IsThreadSafe=value 1

Specifies if the driver is safe to accept multi-threading. Values 0 The driver accepts multi-threading. 1 The driver does not accept multi-threading.

RecommendedLenTransfert
RecommendedLenTransfert=n

Parameter Type Syntax Default value RecommendedLenTransfert= value 30000

Specifies the number of bytes per block. This parameter is used when exporting a document.
NOTE

If you are using WebIntelligence, you must also modify the Binary Slice Size in the cs.cfg file. For more information, see Binary Slice Size on page 439.

Informix

392

Data Access Guide

Microsoft SQL Server


ArrayFetch
ArrayFetch=n

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

AsyncMode
AsyncMode=0|1

Parameter Type Syntax Default value

Boolean ASYNCMODE=value

Specifies whether or not to activate the asynchronous mode. Values 0 Asynchronous mode is deactivated. This is the default value. 1 Asynchronous mode is activated.

DriverLevel
DriverLevel=1|13|15|31

Parameter Type Syntax Default value

Numeric DriverLevel=value

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and

General Data Access Configuration File Reference

Data Access Guide

393

to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.

NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

InputDateFormat
InputDateFormat=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MMDD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/yyyy hh:m:s am/ pm|yyyy-mm-dd

Parameter Type Syntax Default value

Alphanumeric InputDateFormat=value

Specifies the default date and hour formats generated in the WHERE clause of a SQL script. Values {\d 'yyyy-mm-dd'} This is the default date format with ODBC. 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with Oracle. 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats with MS SQL Server and for most IBM DB2 servers. Other RDBMS-specific date and time formats.
NOTE

If you are using WebIntelligence, you must also modify the Input Date Format parameter in the cs.cfg file. For more information, see InputDateFormat on page 399.

IsThreadSafe
IsThreadSafe=0|1

Microsoft SQL Server

394

Data Access Guide

Parameter Type Syntax Default value

Boolean IsThreadSafe=value

Specifies if the driver is safe to accept multi-threading. Values 0 The driver accepts multi-threading. 1 The driver does not accept multi-threading.

Pool Time
Pool Time=0|-1|n

Parameter Type Syntax Default value Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the default value (1). Pool Time=value

Shared
Shared=1|2|4

Parameter Type Syntax Default value

Numeric Shared=value 4

Specifies the default connection type.

General Data Access Configuration File Reference

Data Access Guide

395

Values 1 Specifies that Personal is the default connection type. 2 Specifies that Shared is the default connection type. 4 Specifies that Secured is the default connection type.

SQL External File


Parameter Type Syntax Default value String SQL External File=value None

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value None

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file).

Microsoft SQL Server

396

Data Access Guide

Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2 db2as400 for IBM DB2 UDB AS/400

NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

TxnIsolation
TxnIsolation=0 | 1 | 2 | 4 | 8

Parameter Type Syntax Default value

Numeric TxnIsolation=value

Specifies the isolation level for your connection. The database isolation level defines how to protect one transaction from other transactions that are executed simultaneously. Values 0=none Specifies that the isolation is not used. 1=read uncommitted Provides no isolation. 2=read committed Specifies that each row is committed once it is retrieved. 4=repeatable read Specifies that each row has a shared lock during a transaction. Another process may acquire a shared lock, but no other transaction may modify the selected row until the previous transaction is committed or rolled back. 8=serializable Specifies that each row has a shared lock during a transaction. Another process may acquire a shared lock, but no other transaction may modify the selected row until the previous transaction is committed or rolled back. Serializable is used for an ANSI-compliant database.

This parameter is in the odbc.sbo file, and appears in the connectivity Custom tab.

General Data Access Configuration File Reference

Data Access Guide

397

Oracle
ArrayFetch
ArrayFetch=n

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

AsyncMode
AsyncMode=0|1

Parameter Type Syntax Default value

Boolean ASYNCMODE=value

Specifies whether or not to activate the asynchronous mode. Values 0 Asynchronous mode is deactivated. This is the default value. 1 Asynchronous mode is activated.

AutoCommit
AutoCommit=0|1|2

Parameter Type Syntax Default value

?? AUTOCOMMIT=value

Controls when a database commits pending changes.

Oracle

398

Data Access Guide

Values 0 Specifies that the autocommit feature is deactivated. SQL statements are committed by blocks of SQL. 1 Specifies that each SQL statement is immediately committed. With this mode, a transaction contains only one SQL statement. 2 Specifies that the autocommit feature of the middleware is applied.

Cost Estimate Unit


Cost Estimate Unit = 0 | 1

Syntax Description

COST ESTIMATE UNIT=value Any RDBMS supporting the cost estimate

Specifies how the database returns a cost estimate. Values 0 Returns a cost estimate based on time. This is the default value. 1 Returns a cost estimate based on the number of blocks, or other unit type. The unit type depends on the RDBMS you access.

DriverLevel
DriverLevel=1|13|15|31

Parameter Type Syntax Default value

Numeric DriverLevel=value

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.

General Data Access Configuration File Reference

Data Access Guide

399

NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

InitDateFormat
InitDateFormat=DD-MM-YYYY HH24:MI:SS

Parameter Type Syntax Default value Specifies the default date and hour formats stored on the server. Values DD-MM-YYYY HH24:MI:SS' other default values, check with your Oracle administrator for more information. InitDateFormat=value

InitNumericSeparator
InitNumericSeparator=., | ,

Parameter Type Syntax Default value

Alphanumeric InitNumericSeparator=value '.,'

Specifies the default decimal separator stored on the server. Values '.,' ,

InputDateFormat
InputDateFormat=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MMDD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/yyyy hh:m:s am/ pm|yyyy-mm-dd

Oracle

400

Data Access Guide

Parameter Type Syntax Default value

Alphanumeric InputDateFormat=value

Specifies the default date and hour formats generated in the WHERE clause of a SQL script. Values {\d 'yyyy-mm-dd'} This is the default date format with ODBC. 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with Oracle. 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats with MS SQL Server and for most IBM DB2 servers. Other RDBMS-specific date and time formats.

NOTE

If you are using WebIntelligence, you must also modify the Input Date Format parameter in the cs.cfg file. For more information, see InputDateFormat on page 382.

IsThreadSafe
IsThreadSafe=0|1

Parameter Type Syntax Default value

Boolean IsThreadSafe=value

Specifies if the driver is safe to accept multi-threading. Values 0 The driver accepts multi-threading. 1 The driver does not accept multi-threading.

Lock Mode
Lock Mode=0 | 4

General Data Access Configuration File Reference

Data Access Guide

401

Parameter Type Syntax Default value

Boolean Lock Mode=value 4

Specifies whether to wait for resources or return with an error if they are not available. Values 0 Wait indefinitely if resources are not available. 4 Display an error message whenever a resource is requested but not available.

Pool Time
Pool Time=0 | -1 | n

Parameter Type Syntax Default value Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the default value (1). Pool Time=value

RecommendedLenTransfert
RecommendedLenTransfert=n

Parameter Type Syntax Default value Specifies the number of bytes per block. This parameter is used when exporting a document. RecommendedLenTransfert= value

Oracle

402

Data Access Guide

Values RDBMS specific Note: For IBM DB2/UDB for OS/390, do not increase the default value above the buffer pool size.
NOTE

If you are using WebIntelligence, you must also modify the Binary Slice Size in the cs.cfg file. For more information, see Binary Slice Size on page 439.

RemovePV
RemovePV=0|1

Parameter Type Syntax Default value

Boolean RemovePV=value

Specifies that semicolons are removed at the end of SQL statements. Values 0 Specifies that semicolons are removed at the end of SQL statements. 1 Specifies that semicolons are not removed at the end of SQL statements.

RunInit
RunInit=0|1

Parameter Type Syntax Default value

Boolean RunInit=value

Specifies whether or not to run an ALTER SESSION for the active connection. Values 0 Specifies that an ALTER SESSION for the active connection is not run. In this case, the InitDateFormat parameter is not used. 1 Specifies that an ALTER SESSION is run for the active connection.

Shared
Shared=1|2|4

General Data Access Configuration File Reference

Data Access Guide

403

Parameter Type Syntax Default value

Numeric Shared=value 4

Specifies the default connection type. Values 1 Specifies that Personal is the default connection type. 2 Specifies that Shared is the default connection type. 4 Specifies that Secured is the default connection type.

SQL External File


Parameter Type Syntax Default value String SQL External File=value None

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

Oracle

404

Data Access Guide

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value None

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

General Data Access Configuration File Reference

Data Access Guide

405

Red Brick
Red Brick uses the ODBC.SBO file for connection default values.

ArrayFetch
ArrayFetch=n

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value 1

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

Pool Time
Pool Time=0|-1|n

Parameter Type Syntax Default value Pool Time=value 1

Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the default value (1).

DriverLevel
DriverLevel=1|13|15|31

Red Brick

406

Data Access Guide

Parameter Type Syntax Default value

Numeric DriverLevel=value 1

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.
NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

SQL External File


Parameter Type Syntax Default value String SQL External File=value redbrick

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file).
NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

General Data Access Configuration File Reference

Data Access Guide

407

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value redbrick

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file).
NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

LongVarcharNotSupported
LOngVarCharNotSupported=1|0

Parameter Type Syntax Default value LongVarCharNotSupported=v alue 1

Specifies whether or not documents can be exported containing LONG VARCHAR and LONG VARBINARY datatypes. Values 0 Specifies that documents containing LONG VARCHAR and LONG VARBINARY datatypes can be exported. 1 Specifies that documents containing LONG VARCHAR and LONG VARBINARY datatypes cannot be exported.

RecommendedLenTransfert
RecommendedLenTransfert=n

Red Brick

408

Data Access Guide

Parameter Type Syntax Default value RecommendedLenTransfert= value 124

Specifies the number of bytes per block. This parameter is used when exporting a document.
NOTE

If you are using WebIntelligence, you must also modify the Binary Slice Size in the cs.cfg file. For more information, see Binary Slice Size on page 439.

General Data Access Configuration File Reference

Data Access Guide

409

Sybase
AutoCommit
AutoCommit=0|1|2

Parameter Type Syntax Default value AUTOCOMMIT=value 0

Controls when a database commits pending changes. Values 0 Specifies that the autocommit feature is deactivated. SQL statements are committed by blocks of SQL. 1 Specifies that each SQL statement is immediately committed. With this mode, a transaction contains only one SQL statement. 2 Specifies that the autocommit feature of the middleware is applied.

AsyncMode
AsyncMode=0|1

Parameter Type Syntax Default value

Boolean ASYNCMODE=value 0

Specifies whether or not to activate the asynchronous mode. Values 0 Asynchronous mode is deactivated. This is the default value. 1 Asynchronous mode is activated.

ArrayFetch
ArrayFetch=n

Sybase

410

Data Access Guide

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value 50

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

Shared
Shared=1|2|4

Parameter Type Syntax Default value

Numeric Shared=value 4

Specifies the default connection type. Values 1 Specifies that Personal is the default connection type. 2 Specifies that Shared is the default connection type. 4 Specifies that Secured is the default connection type.

Pool Time
Pool Time=0|-1|n

Parameter Type Syntax Default value Pool Time=value 1

Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the

General Data Access Configuration File Reference

Data Access Guide

411

default value (1).

DriverLevel
DriverLevel=1|13|15|31

Parameter Type Syntax Default value

Numeric DriverLevel=value 31

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.
NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

SQL External File


Parameter Type Syntax Default value String SQL External File=value sybase

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file).
NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

Sybase

412

Data Access Guide

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value sybase

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file).
NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

InputDateFormat
InputDateFormat=mm/dd/yyyy hh:m:s am/pm

Parameter Type Syntax Default value

Alphanumeric InputDateFormat=value mm/dd/yyyy hh:m:s am/pm

Specifies the default date and hour formats generated in the WHERE clause of a SQL script.
NOTE

If you are using WebIntelligence, you must also modify the Input Date Format parameter in the cs.cfg file. For more information, see InputDateFormat on page 399.

AuditTimeStampFormat
InputDateFormat=mm/dd/yyyy hh:mm:ss am/pm'

General Data Access Configuration File Reference

Data Access Guide

413

Parameter Type Syntax Default value

Alphanumeric AuditTimeStampFormat=value mm/dd/yyyy hh:mm:ss am/pm'

Specifies the default date and hour format generated in the WHERE clause of a SQL script used by the WebIntelligence auditing feature.

Password_Encryption
Password_Encryption=mm/dd/yyyy hh:m:s am/pm

Syntax Default value

Password_Encryption=value 1

Specifies whether or not to use the encryption password mechanism of the middleware for the password entered in the connection dialog box. Values 1 Specifies that the encryption password mechanism of the middleware is used. 0 Specifies that the encryption password mechanism of the middleware is not used.

IsThreadSafe
IsThreadSafe=0|1

Parameter Type Syntax Default value

Boolean IsThreadSafe=value 1

Specifies if the driver is safe to accept multi-threading. Values 0 The driver accepts multi-threading. 1 The driver does not accept multi-threading.

IsMdwThreadSafe
IsThreadSafe=0|1

Sybase

414

Data Access Guide

Parameter Type Syntax Default value

Boolean MdwThreadSafe=value Y

Specifies if the middleware is thread-safe. Values Y Specifies that the middleware is thread-safe. This is the default value. N Specifies that the middleware is not thread-safe.

IsParseSupported
IsparseSupported=Y|N

Parameter Type Syntax Default value

Boolean IsThreadSafe=value Y

Specifies if users are authorized to parse SQL statements. Values Y Specifies that users are authorized to parse SQL statements. This is the default value. N Specifies that users are not authorized to parse SQL statements.

This parameter is used by the MDI gateway and DirectCONNECT gateway, and is found in the sybase.sbo file.

IsBindSupported
IsBindSupported=Y|N

Parameter Type Syntax Default value

Boolean IsBindSupported=value Y

Specifies if the middleware supports binding.

General Data Access Configuration File Reference

Data Access Guide

415

Values Y Specifies that the middleware supports binding. This is the default value. N Specifies that the middleware does not supports binding.

BeginTranSyntax
BeginTransSyntax=BEGIN TRAN

Syntax Default value

BeginTransSyntax=value BEGIN TRAN

Specifies whether or not to use the Sybase BEGIN TRANSACTION command to start a transaction block. Values BEGIN TRAN Uses the Sybase BEGIN TRANSACTION command to start a transaction. This is the default value. no value Ignores the Sybase begin transaction syntax. This is necessary when a Sybase gateway accesses an IBM DB2/390 database.

RollbackTranSyntax
RollbackTranSyntax=ROLLBACK TRAN

Syntax Default value

BeginTransSyntax=value ROLLBACK TRAN

Specifies if the Sybase ROLLBACK TRANSACTION command is used to undo work done in the current transaction. Values ROLLBACK TRAN Uses the Sybase BEGIN TRANSACTION command to start a transaction. This is the default value. ROLLBACK Uses the IBM DB2/390 ROLLBACK command to undo a transaction. This value is necessary when a Sybase gateway accesses an IBM DB2/390 database.

CommitTranSyntax
CommitTranSyntax=COMMIT TRAN

Sybase

416

Data Access Guide

Syntax Default value

CommitTransSyntax=value ROLLBACK TRAN

Specifies whether or not to use the Sybase COMMIT TRANSACTION command to end a transaction and permanently accept all the defined changes in the transaction. Values COMMIT TRAN Uses the Sybase COMMIT TRANSACTION command to end a transaction. This is the default value. COMMIT Uses the IBM DB2/390 COMMIT command to end a transaction. This value is necessary when a Sybase gateway accesses an IBM DB2/390 database.

RecommendedLenTransfert
RecommendedLenTransfert=n

Parameter Type Syntax Default value RecommendedLenTransfert= value 32000

Specifies the number of bytes per block. This parameter is used when exporting a document.
NOTE

If you are using WebIntelligence, you must also modify the Binary Slice Size in the cs.cfg file. For more information, see Binary Slice Size on page 439.

General Data Access Configuration File Reference

Data Access Guide

417

Teradata
AsyncMode
AsyncMode=0|1

Parameter Type Syntax Default value

Boolean ASYNCMODE=value

Specifies whether or not to activate the asynchronous mode. Values 0 Asynchronous mode is deactivated. This is the default value. 1 Asynchronous mode is activated.

ArrayFetch
ArrayFetch=n

Parameter Type Syntax Default value

Numeric ARRAYFETCH=value

Specifies the number of rows retrieved with each fetch. Values n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated.

Shared
Shared=1|2|4

Parameter Type Syntax Default value

Numeric Shared=value 4

Specifies the default connection type.

Teradata

418

Data Access Guide

Values 1 Specifies that Personal is the default connection type. 2 Specifies that Shared is the default connection type. 4 Specifies that Secured is the default connection type.

Pool Time
Pool Time=0|-1|n

Parameter Type Syntax Default value Specifies how long a connection should remain open. Values 0 Specifies that the connection is disconnected at the end of the transaction. -1 Specifies that the connection remains open for a whole session. n Specifies that the connection remains open for n minutes. This is the default value (1). Pool Time=value

DriverLevel
DriverLevel=1|13|15|31

Parameter Type Syntax Default value

Numeric DriverLevel=value

Specifies the limitations of each driver. 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures.

General Data Access Configuration File Reference

Data Access Guide

419

NOTE

If you are using WebIntelligence, you must also modify the Driver level parameter in the cs.cfg file. For more information, see DriverLevel on page 398.

SQL External File


Parameter Type Syntax Default value String SQL External File=value None

SQL External File indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle for Oracle teradata for Teradata sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL External File parameter in the cs.cfg file. For more information, see SQL External File on page 403.

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value None

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file).

Teradata

420

Data Access Guide

Values oracle for Oracle teradata for Teradata sqlsrv for Microsoft SQL Server db2udb for IBM DB2

NOTE

If you are using WebIntelligence, you must also modify the SQL Parameter File parameter in the cs.cfg file. For more information, see SQL Parameter File on page 404.

InputDateFormat
InputDateFormat=\d yyy-mm-dd|DD-MM-YYYY HH:MM:SS|YYYY-MMDD HH:MM:SS|yyyy-mm-dd HH:mm:ss|mm/dd/yyyy hh:m:s am/ pm|yyyy-mm-dd

Parameter Type Syntax Default value

Alphanumeric InputDateFormat=value

Specifies the default date and hour formats generated in the WHERE clause of a SQL script. Values {\d 'yyyy-mm-dd'} This is the default date format with ODBC. 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with Oracle. 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats with MS SQL Server and for most IBM DB2 servers. Other RDBMS-specific date and time formats.
NOTE

If you are using WebIntelligence, you must also modify the Input Date Format parameter in the cs.cfg file. For more information, see InputDateFormat on page 399.

General Data Access Configuration File Reference

Data Access Guide

421

RecommendedLenTransfert
Specifies the number of bytes per block. This parameter is used when exporting a document. Possible Values Default Values The entered values are database specific. Check your appropriate driver.sbo file for your database default value. Notes: If RecommendedLenTransfert=0, the value will be 254. This parameter is found in most driver.sbo files, and appears in the connectivity Custom tab. Example
RecommendedLenTransfert=20480

IsThreadSafe
IsThreadSafe=0|1

Parameter Type Syntax Default value

Boolean IsThreadSafe=value

Specifies if the driver is safe to accept multi-threading. Values 0 The driver accepts multi-threading. 1 The driver does not accept multi-threading.

Cost Estimate Unit


Cost Estimate Unit = 0 | 1

Syntax Description

COST ESTIMATE UNIT=value Any RDBMS supporting the cost estimate

Specifies how the database returns a cost estimate. Values 0 Returns a cost estimate based on time. This is the default value. 1 Returns a cost estimate based on the number of blocks, or other unit

Teradata

422

Data Access Guide

type. The unit type depends on the RDBMS you access.

General Data Access Configuration File Reference

Data Access Guide

423

Other parameters
SQL DDL File
SQL DDL File= value |

Parameter Type Syntax Default value

String SQL DDL File=value

SQL DDL File indicates the name of the file which stores the SQL sentences. The extension of this file is .sql. You must ensure this file is located in the same directory as the data configuration file (.sbo file). If you want to add prefixes or suffixes to the tables created with the repository, use this parameter. Values oracle for Oracle sqlsrv for Microsoft SQL Server db2udb for IBM DB2 no value Indicates that you use the SQL script which is encapsulated in the driver.rss file.

Other parameters

424

Data Access Guide

General Data Access Configuration File Reference

WebIntelligence Data Access Configuration File Reference

chapter

426

Data Access Guide

Overview
This chapter provides a reference for all parameters you may find in configuring WebIntelligence. There are three sections: Configuration Common parameters Parameters supported by all ODBC drivers The following tables lists the parameter types: Parameter type Boolean Numeric String Enum Description Accepted values are true/false or yes/no. The value in not case sensitive. Accepted values are numbers. Accepted values are characters. Accepted values are enumerated in the guide.

WebIntelligence Data Access Configuration File Reference

Data Access Guide

427

Configuration
Connection Server connects your RDBMS to WebIntelligence. In WebIntelligence, you can configure your drivers at the global level or the driver level. For WebIntelligence global connections, the following files are in:
<BO Path>\BusinessObjects Enterprise 6\dataAccess\RDBMS\connectionServer:

File name cs.cfg

Description Stores all configuration parameters for the global configuration of Connection Server. For more information, see Global level on page 429. Stores the network layer information. This file is updated during the Business Objects installation.

driver.cfg

There are other files in this directory but they not currently modifiable. They are required for full functionality, so do not remove them.

Configuration

428

Data Access Guide

For WebIntelligence RDBMS-specific connections, the following files are in:


<BO Path>\BusinessObjects Enterprise 6 \dataAccess\RDBMS\connectionServer\<RDBMS>

where <RDBMS> is the name of your RDBMS: File name driver.sbo Description Defines all databases supported and the specific connectivity configuration for each database. Defines the informationparameters and functionsrelated to database. For more information, see the section Modifying the Parameter Files in Creating a Connection to a Database on Windows, , or . Stores information for Business Objects driver configuration and SQL sentences for repository management. Stores information related to connection definitions. Warning: Do not modify this file. There are other files in these directories but they not currently modifiable. They are required for full functionality, so do not remove them.

driver.prm

driver.rss

driver.cod

WebIntelligence Data Access Configuration File Reference

Data Access Guide

429

Global level
You can set default values for all drivers in the DRIVER DEFAULTS section of the cs.cfg file. This file is stored at:
<BO Path>\BusinessObjects Enterprise 6 \dataAccess\RDBMS\connectionServer

Structure of the cs.cfg file The cs.cfg file is an XML file. The DTD for the file is in the same directory. Make sure that, when modifying the XML file, the cs.dtd is accessible. There are five sections in the cs.cfg XML file: Locales Settings Distribution DriverDefaults Traces Locales In this section, the charset for each language is defined.
EXAMPLE Local section <Locales> <Locale> <Language>en</Language> <CharSet Platform="MSWindows">CP1252</CharSet> <CharSet Platform="Unix">ISO-8859-1</CharSet> </Locale> </Locales>

Settings There are two subsections within the Settings section, Library and Server. Server is not currently used. Only modify parameters within the Library tags. You can modify several settings in this section:

Configuration

430

Data Access Guide

Setting Load Drivers On Startup

Description Determines installation of drivers. Values: Yes All installed drivers are loaded during the initialization phase. No Drivers are loaded on demand.

Enable Failed Load

Determines the level of error incurred by a failed driver load. Yes If a driver fails to load, it is not a fatal error. No If a driver fails to load, it is a fatal error.

Config File Extension

Determines the file extension for configuration files. The default is sbo.

SQL Parameter Extension Determines the file extension for parameter files. The default is prm. SQL External Extension Determines the file extension for external SQL files. The default is rss. Strategies Extension Description Extension Determines the extension for strategy files. The default is stg. Determines the extension for the connection description files. The default is cod. Do not change this value. Charset List Extension Determines the extension for character set files. The default is crs.

WebIntelligence Data Access Configuration File Reference

Data Access Guide

431

EXAMPLE <Settings> <Parameter Name="Load Drivers On Startup">No</Parameter> <Parameter Name="Enable Failed Load">Yes</Parameter> <Library/> <Server> <Parameter Name="Load Drivers On Startup">Yes</ Parameter> </Server> </Settings>

Distribution This section is not currently used. DriverDefaults This section allows you to set default values for driver configuration parameters. The values could be overridden in driver.sbo files.
EXAMPLE <DriverDefaults> <Parameter Name="Array <Parameter Name="Array <Parameter Name="Array <Parameter Name="Array </DriverDefaults>

Fetch Available">No</Parameter> Fetch Size">10</Parameter> Bind Available">No</Parameter> Bind Size">5</Parameter>

Traces In this section, you can configure Connection Server traces. Traces are activated at the middleware level. The default value is Active=No.
<Trace Name=Oracle Active=No/>

Configuration

432

Data Access Guide

Modify the Active portion of the <Trace> tag to activate the trace. The attribute ClassID of tag Traces is for internal purposes. Do not change the ClassID tag.
EXAMPLE To activate traces for Oracle and Microsoft: <Traces ClassID="csTRACELOG"> <Trace Name="MiddleWare" Active="Yes"> <Trace Name="Oracle" Active="Yes"/> <Trace Name="DB2" Active="No"/> <Trace Name="DB2/iSeries" Active="No"/> <Trace Name="ODBC2" Active="No"/> </Trace> </Traces>

Driver level
You can set values for all database targets defined in the DEFAULTS section of the driver.sbo file. You can find this in:
<BO Path>\BusinessObjects Enterprise 6 \dataAccess\RDBMS\connectionServer\<RDBMS>

where <RDBMS> is the name of your RDBMS. The structure of the driver.sbo file The driver.sbo file is a text file. It has the same structure as the driver.sbo file for BusinessObjects, Designer, Supervisor, and other Business Objects products. The structure of the driveren.prm file This file defines the informationparameters and functionsrelated to database. The driveren.prm file is an XML file. The DTD for the file is in:
<BO Path>\BusinessObjects Enterprise 6 \dataAccess\RDBMS\connectionServer\

Make sure that, when modifying the XML file, the dbparameters_localization.dtd file is accessible. There are four sections in the driveren.prm XML file:

WebIntelligence Data Access Configuration File Reference

Data Access Guide

433

Configuration This section defines the parameters for SQL generation. Each parameter is enclosed in a <Parameter> tag. The attribute Name specifies the name of the parameter. The data of the <Parameter> tag, the value in between the tags, is the value of the parameter.
EXAMPLE <Configuration> <Parameter Name="SORT_BY_NO">NO</Parameter> <Parameter Name="GROUPBYCOL">NO</Parameter> <Parameter Name="EXT_JOIN">YES</Parameter> <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">$(+)</Parameter> </Configuration>

DateOperations This section contains date-related functions. Each parameter is enclosed in a <DateOperation> tag. The attribute Name specifies the name of the parameter.
EXAMPLE <DateOperations> <DateOperation Name="YEAR">TO_NUMBER(TO_CHAR($D,'YYYY'))</ DateOperation> <DateOperation Name="QUARTER">TO_NUMBER(TO_CHAR($D,'Q'))</ DateOperation> <DateOperation Name="MONTH">TO_NUMBER(TO_CHAR($D,'MM'))</ DateOperation> </DateOperations>

Operators This section contains the operators available in the database.

Configuration

434

Data Access Guide

Each operator is enclosed in an <Operator> tag. The following attributes are available with an <Operator> tag:

Attribute Arity Type

Description The number of arguments the operator takes. The type of operator. The following are possible values: Numeric Char String DateTime Logical All The identifier of the operator.

ID
EXAMPLE <Operators> <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="1" <Operator Arity="0" </Operators>

ID="ADD" Type="Numeric">+</Operator> ID="SUBSTRACT" Type="Numeric">-</Operator> ID="MULTIPLY" Type="Numeric">*</Operator> ID="DIVIDE" Type="Numeric">/</Operator> ID="CONCAT" Type="Char">||</Operator> ID="NULL" Type="Logical">IS NULL</Operator>

WebIntelligence Data Access Configuration File Reference

Data Access Guide

435

Functions This section contains functions. For more information about functions, see Functions on page 321. Also, there is detailed information on adding a function in Creating a Connection to a Database on Windows, , and . Each function is enclosed in a <Function> tag. The following attributes are available with a <Function> tag:

Attribute Group

Description Indicates whether the function is an aggregate function. The values are: True False

InMacro

Indicates whether the function should appear in BusinessObjects. The values are: True False

Type

Displays the type of function: String Numeric Char DateTime Logical All Displays the name of the function as it appears in BusinessObjects. This is optional in this file. Displays the name of the function as it appears in BusinessObjects.

Name ID

If the function has one or more arguments, the arguments are contained in the <Argument> tag. The SQL corresponding to the function is defined with the <SQL> tag. To specify arguments in the SQL sentence, the syntax $n is used where n is a number which corresponds to the position of the argument defined previously.

Configuration

436

Data Access Guide

EXAMPLE <Function Group="False" ID="Replace" InMacro="True" Type="String"> <Arguments> <Argument Type="String"/> <Argument Type="Char"/> <Argument Type="Char"/> </Arguments> <SQL>replace($1,$2,$3)</SQL> </Function>

WebIntelligence Data Access Configuration File Reference

Data Access Guide

437

Common parameters
Parameters in this section are supported by all drivers, regardless of your supported RDBMS. They are listed in alphabetical order.

Array Bind Available


Parameter Type Syntax Default value Boolean Array Bind Available=value False

Array Bind Available indicates the availability of the middleware array bind feature. Values True Array bind is available. False Array bind is unavailable.

Array Bind Size


Parameter Type Syntax Default value Numeric Array Bind Size=value 5

Array Bind Size indicates the size of the array bind.


NOTE

If the parameter Array Bind Available=False, it is still possible to specify an array bind size greater than 1. To improve performance, Business Objects recommends using a value greater than 1 in every case. Values positive integers 1

Common parameters

438

Data Access Guide

Array Fetch Available


Parameter Type Syntax Default value Boolean Array Fetch Available=value False

Array Fetch Available indicates the middleware implementation of the array fetch feature. Values True \to implement the middleware array fetch False -- to disable the middleware array fetch

Array Fetch Size


Parameter Type Syntax Default value Numeric Array Fetch Size=value 10

Array Fetch Size indicates the size of the array fetch.


NOTE

If the parameter Array Fetch Available=False, it is still possible to specify an array fetch size greater than 1. To improve performance, Business Objects recommends using a value greater than 1 in every case. Values positive integers 1

WebIntelligence Data Access Configuration File Reference

Data Access Guide

439

Binary Slice Size


Parameter Type Syntax Default value Numeric Binary Slice Size=value 255

Binary Slice Size was RecommendedLenTransfert in previous Data Configuration Files. Binary Slice Size indicates the size of slices for binary values in BusinessObjects. Values Any positive integer 255 -- this is the default

CharSet
Parameter Type Syntax Default value String CharSet=value Middleware dependent

CharSet indicates the name of the character set used by the middleware. The name of the CharSet is specified in your middleware standard. Values Values vary with the middleware. If this parameter is not specified, retrieve the CharSet name your middleware. If you cant retrieve this information, the current CharSet of your platform is used.

CharSet Table
Parameter Type Syntax Default value String CharSet Table=value None

CharSet Table is the name of the file which stores correspondence between middleware CharSet names and the Business Objects connection CharSet names.

Common parameters

440

Data Access Guide

Description File
Parameter Type Syntax Default value String Description File=value None

Description File indicates the name of the file which stores the connection description. The extension of this file is .cod. You must ensure this file is located in the same directory as the data configuration file (.sbo file).

Input Date Format


Parameter Type Syntax Default value String Input Date Format=value None

Input Date Format was InputDateFormat in previous Data Configuration Files. Input Date Format indicates the database date format. Values: 'DD-MM-YYYY HH:MM:SS' -- for Oracle {\d 'yyyy-mm-dd'} -- for AS 400 and Microsoft SQL Server 'yyyy-mm-dd' -- for IBM DB2

Other possibilities depend on how your RDBMS accepts date formats.

Library
Parameter Type Syntax Default value String Library=value None

Library overrides the library driver loaded for a specific network layer or database target. Only the radical name is specified. Values dbd_oci9 -- for Oracle9i dbd_mssql -- for Microsoft SQL Server

WebIntelligence Data Access Configuration File Reference

Data Access Guide

441

Max Rows Available


Parameter Type Syntax Default value Boolean Max Rows Available=value False

Max Rows Available indicates the possibility of limiting the number of rows retrieved with the middleware. Values True -- the middleware limits the number of rows retrieved False -- the middleware doesnt limit the number of rows retrieved

SQL External File


Parameter Type Syntax Default value String SQL External File=value None

SQL External indicates the name of the file which stores the SQL sentences. The extension of this file is .rss. You must ensure this file is located in the same directory as the data configuration file (.sbo file). Values oracle -- for Oracle access -- for Microsoft Access sqlsrv -- for Microsoft SQL Server db2udb -- for IBM DB2

SQL Parameter File


Parameter Type Syntax Default value String SQL Parameter File=value None

SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is .prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file).

Common parameters

442

Data Access Guide

Values oracle -- for Oracle access -- for Microsoft Access sqlsrv -- for Microsoft SQL Server db2udb -- for IBM DB2 teradata--for Teradata

Strategies File
Parameter Type Syntax Default value String Strategies File=value None

Strategies File indicates the name of the file which stores the strategies description. The extension of this file is .stg. You must ensure this file is located in the same directory as the data configuration file (.sbo file). oracle access db2 teradata

WebIntelligence Data Access Configuration File Reference

Data Access Guide

443

Parameters supported by all ODBC drivers


Parameters in this section are only available in Data Configuration files for Microsoft SQL Server.

Empty String
Parameter Type Syntax Default value Enum Empty String=value EmptyString

Empty String indicates the form used to specify an empty string, such as a null pointer, for some ODBC functions. One example of an ODBC function that needs a form for an empty string is SQLTables. Values EmptyString NullString

Native Int64 Available


Parameter Type Syntax Default value Boolean Native Int64 Available=value True

Native Int64 Available indicates that the middleware natively supports the 64 bit integer.
NOTE

This parameter is only active in ODBC3-based drivers. Values True -- the middleware natively supports the 64 bit integer False -- the middleware does not natively support the 64 bit integer

Parameters supported by all ODBC drivers

444

Data Access Guide

ODBC Cursors
Parameter Type Syntax Default value Boolean ODBC Cursors=value None

ODBC Cursors indicates the use of the ODBC cursor library. Values Yes -- the ODBC cursor library is used No -- the ODBC cursor library isnt used

Qualifiers Available
Parameter Type Syntax Default value Boolean Qualifiers Available=value None

Qualifiers Available indicates the support of qualifiers. If this parameter is not defined, retrieve the information from the function:
SQLGetInfo (ODBC)

Values True -- the database supports qualifiers False -- the database doesnt support qualifiers

WebIntelligence Data Access Configuration File Reference

Index
@Variable 60 @Variable(BOUSERPROMPT) 41

Data Access Guide

445

A
Array Bind Available 437 Array Bind Size 437 Array Fetch Available 438 Array Fetch Size 438 ARRAYFETCH IBM DB2 UDB 381 Informix 387 Microsoft SQL Server 392 Oracle 397 Sybase 409 Teradata 417 ArrayFetch Red Brick 405 ASYNCMODE IBM DB2 UDB 381 Informix 387 Microsoft SQL Server 392 Oracle 397 Sybase 409 Teradata 417 AuditTimeStampFormat Informix 390 Sybase 412 AUTOCOMMIT Oracle 397 Sybase 409

bomain.key updating 56 Business Objects consulting services 11, 13 documentation 10 Documentation Supply Store 9 support services 11 training services 11, 13 Business Objects login Oracle 44 BusinessObjects connecting with Oracle 39

C
CASE_SENSITIVE Oracle 278 cfg file 26 CharSet 439 CharSet Table 439 CHECK_OWNER_STATE Microsoft SQL Server 267 Oracle 278 Red Brick 289 Sybase 299 CHECK_QUALIFIER_STATE Microsoft SQL Server 267 Oracle 279 Red Brick 289 Sybase 299 COMBINE_WITHOUT_PARENTHESIS Red Brick 289 Teradata 310

B
BACK_QUOTE_SUPPORTED IBM DB2 244 Microsoft SQL Server 267 Teradata 310 BeginTranSyntax Sybase 415 Binary Slice Size 439 bomain key creating interactively 53

Index

446

Data Access Guide

COMMA IBM DB2 244 Informix 258 Microsoft SQL Server 268 Oracle 279 Red Brick 290 Sybase 299 Teradata 310 CommitTranSyntax Sybase 415 CONCAT IBM DB2 245 Informix 258 Microsoft SQL Server 269 Oracle 280 Red Brick 291 Sybase 301 Teradata 311 connecting with WebIntelligence 26 connection define restrictive 41, 42 consultants Business Objects 11 COST ESTIMATE UNIT Teradata 421 create restrictive connection 42 creating bomain key 53 CURSORHOLD 96 customer support 11

demo materials 9 Description File 440 Designer connecting with Oracle 36 Developer Suite 10, 12 documentation CD 9 feedback on 10 on the web 9 printed, ordering 9 roadmap 9 search 9 Documentation Supply Store 9 DRIVERLEVEL IBM DB2 UDB 382 Informix 388 Microsoft SQL Server 392 Oracle 398 Sybase 411 Teradata 418 DriverLevel Red Brick 405

E
education see training EXT_JOIN IBM DB2 245 Informix 259 Microsoft SQL Server 269 Oracle 280 Red Brick 291 Sybase 301 Teradata 312 EXT_JOIN_INVERT IBM DB2 246 Informix 259 Oracle 280 Sybase 301 Teradata 311 EXTERN_SORT_EXCLUDE_DISTINCT Oracle 281

D
data access driver defined 21 database server defined 20 datatypes Business Objects 237 of Informix 121 Teradata 237 DB2, overview 74 define restrictive connection 41

Index

Data Access Guide

447

F
feedback on documentation 10 files cs.cfg 427 driver.cfg 427 informix.sql 121 mainkey.param 53 FORCE_SORTED_LOV Informix 259 function IBM DB2 reference 326 Informix reference 337 Oracle reference 348 Red Brick reference 359 SQL Server reference 342 Sybase reference 366 Teradata reference 372

G
GROUPBY_EXCLUDE_COMPLEX IBM DB2 246 GROUPBY_WITH_ALIAS Red Brick 291 GROUPBY_WITHOUT_CONSTANT IBM DB2 247 GROUPBYCOL IBM DB2 247 Informix 260 Microsoft SQL Server 269 Oracle 281 Red Brick 292 Sybase 302 Teradata 312

I
IBM DB2 connecting on UNIX 51 CURSORHOLD parameter 96 datatypes 97 functions available 326 optimizing data performance 76 IBM DB2 UDB parameter (prm) file 244

IBM DB2, overview 74 Informix connecting to a database 101 datatypes 121 functions available 337 optimizing data performance 102 overview 100 informix.prm 103 INITDATEFORMAT Oracle 399 INITNUMERICSEPARATOR Oracle 399 Input Date Format 440 INPUTDATEFORMAT IBM DB2 UDB 382 Informix 389 Microsoft SQL Server 393 Oracle 399 Teradata 420 InputDateFormat Sybase 412 installing 19 INTERSECT IBM DB2 248 Informix 260 Microsoft SQL Server 270 Oracle 281 Red Brick 292 Sybase 302 Teradata 312 INTERSECT_IN_SUBQUERY IBM DB2 248 Informix 260 Microsoft SQL Server 270 Oracle 282 Sybase 302 Teradata 313 IsBindSupported Sybase 414 IsMdwThreadSafe Sybase 413 IsParseSupported Sybase 414

Index

448

Data Access Guide

ISTHREADSAFE IBM DB2 UDB 383 Informix 390 Microsoft SQL Server 393 Oracle 400 Sybase 413 Teradata 421

K
KEY_INFO_SUPPORTED IBM DB2 249 Informix 261 Microsoft SQL Server 270 Oracle 282 Red Brick 292 Sybase 303 Teradata 313 Knowledge Base 12

MINUS IBM DB2 249 Informix 261 Microsoft SQL Server 271 Oracle 283 Red Brick 293 Sybase 304 Teradata 314 MINUS_IN_SUBQUERY IBM DB2 249 Informix 261 Microsoft SQL Server 271 Oracle 283 Sybase 303 Teradata 313 multimedia quick tours 10

O
ODBC defined 21 OLAP_CLAUSE Red Brick 293 Teradata 314 Online Customer Support 11 Oracle configuring the Advanced tab 45 configuring the Custom tab 47 connecting on UNIX 51 connecting to a database 147 connecting with BusinessObjects 39 connecting with Designer 36 connecting with Supervisor 32 datatypes 172 defining the login parameter 44 functions available 348 optimizing data performance 148 overview 30, 146 stored procedures 169 oracle.prm 149 OUTERJOINS_COMPLEX Informix 262

L
LEFT_OUTER Microsoft SQL Server 271 Oracle 283 Red Brick 293 Sybase 303 Library 440 LNG_SQL_HELP Informix 261 LOCK MODE Oracle 400 LongVarcharNotSupported Red Brick 407

M
Max Rows Available 441 Microsoft SQL Server datatypes 143 overview 124, 218 stored procedures 141 middleware 19

Index

Data Access Guide

449

OUTERJOINS_GENERATION IBM DB2 250 Informix 262 Microsoft SQL Server 272 Oracle 284 Red Brick 294 Sybase 304 Teradata 314 OVER_CLAUSE IBM DB2 251 OWNER IBM DB2 251 Informix 263 Microsoft SQL Server 272 Oracle 284 Red Brick 294 Sybase 305 Teradata 315

R
RDBMS defined 19 RDBMS performance 96 RECOMMENDEDLENTRANSFERT IBM DB2 UDB 384 Informix 391 Oracle 401 Sybase 416 Teradata 421 RecommendedLenTransfert Red Brick 407 Red Brick connecting to a database 175 datatypes 191 functions available 359 optimizing data performance 176 overview 174 prm 176 REFRESH_COLUMNS_TYPE Microsoft SQL Server 273 Red Brick 295 Sybase 305 REMOVEPV IBM DB2 UDB 384 Oracle 402 restrictive create 42 restrictive connection advanced parameters 42 define 41 REVERSE_TABLE_WEIGHT Oracle 284 RIGHT_OUTER Microsoft SQL Server 273 Red Brick 296 Sybase 306 RISQL_FUNCTIONS IBM DB2 UDB 252 Red Brick 296 Teradata 316 RollbackTranSyntax Sybase 415 RUNINIT Oracle 402

P
Password_Encryption Sybase 413 POOL TIME IBM DB2 UDB 383 Informix 388 Microsoft SQL Server 394 Oracle 401 Pool Time Red Brick 405 POOLTIME Sybase 410 Teradata 418 PREFIX_SYS_TABLE Red Brick 294

Q
QUALIFIER IBM DB2 251 Microsoft SQL Server 273, 305 Red Brick 295 Sybase 305 Teradata 315 QUOTE_OWNER Informix 264

Index

450

Data Access Guide

S
search documentation 9 SHARED IBM DB2 UDB 384 Informix 387 Microsoft SQL Server 394 Oracle 402 Sybase 410 Teradata 417 SORT_BY_NO IBM DB2 252 Informix 264 Microsoft SQL Server 274, 306 Oracle 285 Red Brick 296 Teradata 316 SQL DDL FILE 423 SQL EXTERNAL FILE IBM DB2 UDB 385 Informix 389 Microsoft SQL Server 395 Oracle 403 Sybase 411 Teradata 419 WebIntelligence 441 SQL External File Red Brick 406 SQL PARAMETER FILE IBM DB2 UDB 386 Informix 389 Microsoft SQL Server 395 Oracle 404 Sybase 412 Teradata 419 WebIntelligence 441 SQL Parameter File Red Brick 407 SQL Server functions available 342

STG IBM DB2 253 Informix 265 Microsoft SQL Server 274 Oracle 285 Red Brick 297 Sybase 307 Teradata 316 stored procedures Microsoft SQL Server 141 Oracle 169 STRING_FORMAT_IN_SUBQUERY IBM DB2 253 Supervisor connecting with Oracle 32 support customer 11 Sybase connecting to a database 195 datatypes 215 functions available 366 optimizing data performance 196 overview 194 sybase.prm 197

T
TABLE_DELIMITER IBM DB2 254 Microsoft SQL Server 274 Oracle 285 Teradata 316 Teradata connecting on UNIX 51 connecting to a database 219 datatypes 237 functions available 372 optimizing data performance 220 teradata.prm 221 Tips & Tricks 10 training on Business Objects products 11 TXNISOLATION Microsoft SQL Server 396

Index

Data Access Guide

451

U
UDB, overview 74 UNION IBM DB2 254 Informix 265 Microsoft SQL Server 275 Oracle 286 Red Brick 297 Sybase 307 Teradata 317 UNION_IN_SUBQUERY IBM DB2 255 Informix 265 Microsoft SQL Server 275 Oracle 286 Sybase 307 Teradata 317 USER_INPUT_DATE_FORMAT IBM DB2 256 Informix 266 Microsoft SQL Server 275 Oracle 287, 308 Red Brick 297 Teradata 318 USER_INPUT_NUMERIC_SEPARATOR IBM DB2 257 Informix 266 Microsoft SQL Server 276, 308 Oracle 287 Red Brick 298 Teradata 318

WebIntelligence parameters Array Bind Available 437 Array Bind Size 437 Array Fetch Available 438 Array Fetch Size 438 Binary Slice Size 439 CharSet 439 CharSet Table 439 Description File 440 Empty String 443 Input Date Format 440 Library 440 Max Rows Available 441 Native Int64 Available 443 ODBC Cursors 444 Qualifiers Available 444 SQL External File 441 SQL Parameter File 441 Strategies File 442 Windows connecting to Oracle 31 wmainkey 51 command line 55 parameter file 54 parameters for UNIX 52

V
variables @Variable 60 DBDATABASE 60 DBPASSWORD 60 DBUSER 60

W
web customer support 11 getting documentation via 9 useful addresses 12

Index

452

Data Access Guide

Index

You might also like