Deployment Data Access

Data Access Guide

BusinessObjects Enterprise 6.1 Business Intelligence

Windows and UNIX

2 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 [email protected] 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.227-7013.

Patents U.S. Patent Numbers 5,555,403, 6,247,008, and 6,578,027.

Part Number 320-50-610-01

Data Access Guide 3

Contents

ContentsContents 3

Preface Maximizing Your Information Resources 7Information resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11Useful addresses at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12About this guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Part I Creating Connections

Chapter 1 Accessing Data with Business Objects Products 17Connecting to your data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19Data Access Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23WebIntelligence connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Accessing non-RDBMS data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

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

Chapter 3 Creating a Connection to a Database on UNIX 49Creating connections to databases on UNIX . . . . . . . . . . . . . . . . . . . . . . . . 51

4 Data Access Guide

Contents

Part II Managing Connections

Chapter 4 Using Predefined Data Access Variables 59

Chapter 5 Checking your Connection Configuration 65Using the Check Tool . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Part III Configuring Specific Data Access Drivers

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

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

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

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

Data Access Guide 5

Contents

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

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

Chapter 12 Teradata Data Access 217Connecting to Business Objects products with Teradata . . . . . . . . . . . . . . 219Optimizing data access performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220Teradata datatype conversion . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 237

Part IV Optimizing Data Access

Chapter 13 Data Access Parameter File Reference 241IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 244Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278Red Brick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 289Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 310

6 Data Access Guide

Contents

Chapter 14 Functions 321Adding a function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 323IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 326Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 337Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 342Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 348Red Brick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 359Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 366Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372

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

Chapter 16 WebIntelligence Data Access Configuration File Reference 425Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427Common parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437Parameters supported by all ODBC drivers . . . . . . . . . . . . . . . . . . . . . . . 443

Index 445

preface

Maximizing Your Information Resources

8 Data Access Guide

OverviewInformation, 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 9

Information resources

Information resourcesWhatever 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 RoadmapThe 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 productsYou 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 webThe 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 documentationYou 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 CDSearch 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.

http://www.businessobjects.com/services/documentation



http://www.businessobjects.com/services/documentation.htm

http://www.businessobjects.com/services/support.htm


10 Data Access Guide

MultimediaAre 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 & TricksOpen 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 documentationWe 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 OnlineDeveloper 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 feedbackDo 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: [email protected]

NOTEIf 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

http://www.businessobjects.com

http://www.businessobjects.com/forms/tipsandtricks_login.asp

mailto:[email protected]


Data Access Guide 11

Services

ServicesA 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 SupportOur 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


http://www.businessobjects.com/services/consulting.htm

http://www.businessobjects.com/services/education.htm


Useful addresses at a glance

Address ContentBusiness Objects Documentation

www.businessobjects.com/services/documentation.htm

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

Business Objects Documentation mailbox

[email protected]

Feedback or questions about documentation.

Product documentation

www.businessobjects.com/services/support.htm

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

Business Objects product information

www.businessobjects.com

Information about the full range of Business Objects products.

Developer Suite Online

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.

Knowledge Base (KB)


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.

Tips & Tricks

www.businessobjects.com/forms/tipsandtricks_login.asp

Practical business-focused examples.


mailto:[email protected]


http://www.businessobjects.com

http://www.techsupport.businessobjects.com/


http://www.businessobjects.com/forms/tipsandtricks_login.asp


Useful addresses at a glance

Online Customer Support


www.businessobjects.com/services

Starting point for answering questions, resolving issues.

Information about registering with Worldwide Customer Support.

Business Objects Education Services

www.businessobjects.com/services/education.htm

The range of Business Objects training options and modules.

Business Objects Consulting Services

www.businessobjects.com/services/consulting.htm

Information on how Business Objects can help maximize your business intelligence investment.

Address Content


http://www.businessobjects.com/services/

http://www.businessobjects.com/services/education.htm

http://www.businessobjects.com/services/consulting.htm


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

AudienceThis 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 guideThe conventions used in this guide are described in the table below.

Convention IndicatesThis font 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.

Some code more code

Placed at the end of a line of code, the symbol ( ) indicates that the next line should be entered continuously with no carriage return.

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

part

Creating Connections

chapter

Accessing Data with Business Objects Products



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


Connecting to your data

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

Workflow informationFirst 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 DefinitionsIn 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 databaseA relational database contains tables which are groupings of data, columns which are single attributes of a table, and rows which are individual records.



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


Connecting to your data

ODBCODBC 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 driverThe driver manager displays all installed ODBC drivers.

Data Access driverA 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.



Data Access DriversA 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


Connections

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

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

Who creates connectionsAn 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 connectionIn 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



The following diagrams show the parts that make up a connection.

BusinessObjects in Two-tier modeThe following diagram shows BusinessObjects in Two-tier mode.


Connections

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



WebIntelligence connectionsWith 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).

EXAMPLEEditing an Oracle connection for both WebIntelligence and BusinessObjects1. 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.


WebIntelligence connections

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.



Accessing non-RDBMS dataInformation 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 User’s Guide.

chapter

Creating a Connection to a Database on Windows



OverviewThis 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 tabFor 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 access a database on Windows

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 See the section...Supervisor Creating connections with Supervisor

Designer Creating connections with Designer

BusinessObjects Creating connections with BusinessObjects



Creating connections with SupervisorYou 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

NOTEYou 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 connectionYou must create a repository for your BusinessObjects deployment. For more information about repositories, see the Deployment Guide and the Supervisor’s 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 Supervisor’s 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.OrSelect a data source from the Data Source Name drop down list. If you do not


Creating connections with Supervisor

have a data source available, click ODBC Admin and define one.10.Click Test.11. If your connection is successful, click OK.

OrIf your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration.

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


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



the Database text box.OrSelect 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.




Creating a connection for stored procedures or WebIntelligence auditingFor 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 User’s 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 connections with Supervisor

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


11.Click Test.12. If your connection is successful, click OK.






Creating connections with DesignerYou 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 universeEach case is described in its respective section below.

What type of connections can you create?You can create the following types of connections:

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.

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

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

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.


Creating connections with Designer

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


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


11. If your connection is successful, click OK.OrIf your connection is not successful, click Details. Contact your database administrator for information about your database or middleware configuration.




Adding a new connection to the connections available to a universeYou 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.


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


11. If your connection is successful, select your type of connection from the Type box.OrIf 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 connections with BusinessObjects

Creating connections with BusinessObjectsYou 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 EditorTo 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 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.


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



box.You can select the following types of connections:

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.

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

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


Creating Restrictive connections

Creating Restrictive connectionsA 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 SQLThe 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:

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

@Variable(’BOUSERPROMPT’)



Restrictive connections and connection timeDepending 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:

Defining a restrictive connectionYou 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

Advanced parameter Effect on connection activity when selected...Keep the connection active during the whole session

User is prompted to enter database login parameters on the first refresh of a report, but not for subsequent 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.


Creating Restrictive connections

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.



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 Supervisor’s Guide.


Configuring the Advanced tab

Configuring the Advanced tabUse 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 fetchTo set any additional connectivity options, click the Custom tab. For information on the Custom tab, see Configuring the Custom tab on page 47.

Item DescriptionConnection PropertiesKeep 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.

Keep the connection active for x minutes

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.

Connection ModeUse asynchronous mode 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

keyNote: If you are creating a connection for a universe which is accessed with WebIntelligence, do not select Use asynchronous mode.



Use synchronous mode 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 resourcesGet 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 Click if you want your connection to remain active without notifying users.

Array fetch size 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.

Item Description


Configuring the Custom tab

Configuring the Custom tabThe 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.



chapter

Creating a Connection to a Database on UNIX



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


Creating connections to databases on UNIX

Creating connections to databases on UNIXTo 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 platformOnce 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 Supervisor’s Guide.When you deploy WebIntelligence on UNIX, you may not have access to the bomain.key file. If you don’t 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 utilityThe 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 optionAccepts 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>]



wmainkey -f

wmainkey -h

ParametersThe following parameters are available:

Parameter Value Meaning-lm List available client middleware.

-le List available database engines.

-x Export a connection definition file.

-c Create a keyfile.

-t Test a connection.

-i <def_file> Specify an input connection definition file.

-k <keyfile> Specify an input keyfile.

-m <client_middleware> Specify a client middleware name.

-e <database_engine> Specify a database engine name.

-u <user> Specify a user name.

-p <password> Specify a password.

-s <source> Specify a data source name.

-d <database> Specify a database name.

-on <owner_name> Specify an owner name

-o <keyfile> Specify the output keyfile name.

-f Force overwrite of output file



Creating the bomain.key file interactivelyWhen 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/

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



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



Parameter file formatUse 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>



Updating bomain.keyYou may need to update the existing bomain.key file, for example if the repository’s 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 wmainkeyYou can use wmainkey to check your connection to your database. At the terminal prompt, enter:wmainkey -t -k bomain.key

Displaying wmainkey helpTo display help for wmainkey, enter:wmainkey -h

The help screen appears.

part

Managing Connections

chapter

Using Predefined Data Access Variables



OverviewIn 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 nameThese 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 Designer’s Guide or to the BusinessObjects User’s 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 variablesIn 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.


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')

)



Defining a condition on a query using predefined variablesIn 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.


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:



chapter

Checking your Connection Configuration



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


Using the Check Tool

Using the Check ToolThe 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 toolYou can run the Check tool at any time.

Running the Check toolTo 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 syntaxYou use the Check tool in a command editor. You use the following syntax:

Check tool syntax Descriptioncscheck (--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] [--mute|m] <function name> <function options>

Calls the function with its options.--xml: xml output--mute: no output



<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 functionsYou can run the following functions:

Drivers searchThe tool returns the list of BO access drivers that are installed on your local machine.

Syntaxcscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (driverssearch|ds)

Examplecscheck driverssearch

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

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

Syntaxcscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (list|lt)

Examplecscheck list


Using the Check Tool

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

Syntaxcscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (middleware|mw) {(-c|--clientlayer) <layername> (-d|--database) <dbname>}

Examplecscheck --xml middleware -c "Oracle Client" -d "Oracle 8.1" > c:\result.xml

Data access driverOn 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.

Syntaxcscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (accessdriver|ad) {(-c|--clientlayer) <layername> (-d|--database) <dbname>}

Examplecscheck -l English accessdriver -c "Oracle Client" -d "Oracle 8.1"

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

Syntaxcscheck [(--language|l) <lg>] [--xml|x] [--mute|m] (connectivity|ct) {(-c|--clientlayer) <layername> (-d|--database) <dbname>}

Examplecscheck -l English connectivity -c "Oracle Client" -d "Oracle 8.1">c:\result.txt



FindReturns the list of access drivers loaded by Connection Server

Syntaxcscheck (find|fd)

Examplecscheck find –m local

PingAttempts to establish a simple connection with connection server. It returns information such as the network layer, and user name.

Syntaxcscheck (ping|pg)

Examplecscheck ping -m local -c "Oracle Client" -d "Oracle 8.1" -u "efashion" -p "password" -s "Harlaxton"

part

Configuring Specific Data Access Drivers

chapter

IBM DB2 Data Access


IBM DB2 Data Access

OverviewThis chapter provides information about IBM DB2-specific connections, including:• Optimizing data access performance• Configuring the IBM DB2 server• IBM DB2 datatype conversionFor 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.


Connecting to Business Objects products with IBM DB2

Connecting to Business Objects products with IBM DB2

The following operating systems and IBM DB2 releases are supported for connection:

IBM DB2 Release MiddlewareIBM DB2 on NT/Unix DB2 Client


IBM DB2 Data Access

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

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

The parameter files are installed in two separate folders:.

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

File name Descriptiondriver.prm (XML format)driveren.prm (text format)

Contain the parameters needed to create and manage your universes, and generate SQL. For more information, see Modifying the parameter files on page 77.

driveren.prm (XML format)

Contains information about each SQL function used in the driver.prm

db2.stg (XML format)db2en.txt (text format)

Contain external strategy definitions based on SQL. For more information, see Modifying an external strategy File on page 89.

db2en.stg Contains information about the external strategies used in db2.stg

db2.sbo Contains the default connection parameters. For more information, see Modifying the data configuration files on page 88.

Connection files used by... PathAll Business Objects products except WebIntelligence

<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\db2

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\db2


Optimizing data access performance

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 filesYou can add SQL functions or modify existing parameters in the driver.prm file to optimize your connection.There are two driver.prm files:

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 WebIntelligenceIf you want to modify a connection parameter for all Business Objects products except WebIntelligence, then you only need to edit the following file:

The connection is used by WebIntelligenceIf you are using WebIntelligence you need to modify both the driver.prm files listed below:

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=

Oracle parameter file DescriptionGeneral parameter file Contains the parameters relevant to

BusinessObjects, Designer, Supervisor, and other Business Objects products

WebIntelligence parameter file

Contains the parameters relevant to WebIntelligence only.

<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\db2\driver.prm

<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


IBM DB2 Data Access

General parameter fileThe driveren.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: • RDBMS• DATE• OPERATORS• FUNCTIONS

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

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

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

OPERATORSThis section defines the SQL syntax for the operators you can access in the Query Panel when you create a condition.

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



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 Description(n) Order in which the function appears in the

driveren.prm file. n starts at 0 and each function number should be different.

NAME= function name 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.

TYPE=A Type of function: A=alphanumeric, N=numeric, and D=date.

IN_MACRO=Y Indicates whether the function should appear in BusinessObjects.

GROUP=Y Indicates whether the function is an aggregate function.

SQL=SQL function name($A,$N) 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.


IBM DB2 Data Access

Before you create your function, make sure you are using the correct driver.prm file:

Adding a function to the driveren.prm FileBusiness 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 doesn’t 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.

Your IBM DB2 server Parameter fileIBM DB2/UDB for NT db2udben.prm



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)


IBM DB2 Data Access

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 SQL=($A,$D)

Function TYPE=A



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.

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 fileThe driveren.prm file for WebIntelligence is an XML file divided into the following four sections:• Configuration• DateOperations• Operators• FunctionsYou should use an XML editor to view and modify this file.

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

Function

Function

Function

Function TRAD=

HELP=

TYPE=A

ExampleNAME=


IBM DB2 Data Access

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>

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

OperatorsThis 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" ID="ADD" Type="Numeric">+</Operator>

<Operator Arity="1" ID="SUBTRACT" Type="Numeric">-</Operator>

<Operator Arity="1" ID="MULTIPLY" Type="Numeric">*</Operator>

<Operator Arity="1" ID="DIVIDE" Type="Numeric">/</Operator>

<Operator Arity="1" ID="CONCAT" Type="Char">||</Operator>

<Operator Arity="0" ID="NULL" Type="Logical">IS NULL</Operator>

</Operators>

FunctionsThis 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• IDFor 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"/>


IBM DB2 Data Access


</Arguments>

<SQL>replace($1,$2,$3)</SQL>

</Function>



Adding a function to the driveren.prm XML fileYou 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:

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.

Function tag DescriptionGroup Indicates whether the function is an aggregate

function.The values are:• True• False

ID Displays the name of the function as it appears in BusinessObjects

InMacro Indicates whether the function should appear in BusinessObjects.The values are:• True• False

Name Displays the name of the function as it appears in BusinessObjects

Type Displays the type of function: • String• Numeric• DateTime


IBM DB2 Data Access

Modifying the data configuration filesThe 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 filesThese text files, structured like a filename.ini file, are divided into three sections: [DEFAULTS], [SQL Syntax], and [Database Engine].

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



Database Engine sectionThis 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 FileWhen 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 Designer’s Guide.

Structure of the external strategy fileThis text file, structured like a filename.ini file, is divided into [STRATEGY] sections. In each section, you usually have two subsections [SQL] and [HELP].

EXAMPLEThe 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'


IBM DB2 Data Access

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 sectionThis 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 subsectionThis subsection contains the SQL statements that enable a universe designer to create classes and objects, joins, or table structure.



HELP subsectionThis subsection contains a description of the strategy. The strategy description appears in Designer when a designer creates a universe.

Creating an external strategy fileIf 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 fileOnce 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.


IBM DB2 Data Access

Modifying the driveren.sbo and driver.cfg filesThese 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.

NOTEIt 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

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

The driveren.sbo fileThe 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 SectionThis 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

layerFor example, the IBM DB2 entry is displayed below:



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

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

DB2_CAE the key name for CAE

IBM DB2 Client the name of the network layer

Allows you to access an IBM DB2 database

the description of the network layer

a

a. The registry entryb. The name of the network layerc. The network layer description

b

c


IBM DB2 Data Access

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 SectionThis 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 charactersFor 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

The driveren.cfg fileThe 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.

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

DB2 CAE the key name of the Data Access driver for Business Objects 6



NOTE

It is not recommended that you modify these files.


IBM DB2 Data Access

Configuring the IBM DB2 serverOverview

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

Modifying the CURSORHOLD parameter to improve RDBMS performanceA 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 datatype conversion

IBM DB2 datatype conversionBusiness Objects supports four datatypes:• date• character• number• long text

IBM DB2 DatatypesThe following table lists the IBM DB2 internal datatypes and their equivalent in Business Objects products:

IBM/DB2 Datatype Business Objects Suggested DatatypeCLOB LONG TEXT

CHARACTER CHARACTER

DATE DATE

DECIMAL NUMBER

DOUBLE NUMBER

FLOAT NUMBER

INTEGER NUMBER

LONG VARCHAR LONG TEXT

NUMERIC NUMBER

SMALLINT NUMBER

TIME DATE

TIMESTAMP DATE

VARCHAR CHARACTER


IBM DB2 Data Access

chapter

Informix Data Access



This chapter provides information about Informix-specific connections, including:• Optimizing data access performance• Informix datatype conversionFor 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.


Connecting to Business Objects products with Informix

Connecting to Business Objects products with Informix

The following operating systems and Informix releases are supported for connection:

Informix Release MiddlewareIBM Informix DS Informix SDK 2.81 (ODBC)




OverviewWhen 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 Descriptioninformix.prm (XML format)informixen.prm (text format)

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.

informixen.prm (XML format)

Contains information about each SQL function used in the informix.prm

informix.stg (XML format)informixen.txt (text format)

Contains external strategy definitions based on SQL. For more information, see Modifying an external strategy file on page 116.

informixen.stg Contains information about the external strategies used in informix.stg

informix.sbo Contains the default connection properties. For more information, see Modifying the data access configuration file on page 115.


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\informix

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\informix



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 filesYou can add SQL functions or modify existing parameters in the informix.prm file to optimize your connection.There are two informix.prm files:

Depending on your Business Objects products you edit either one or both informix.prm files as follows:


The connection is used by WebIntelligenceIf you are using WebIntelligence you need to modify both the informix.prm files listed below:

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

Informix parameter file DescriptionGeneral parameter file Contains the parameters relevant to




<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\informix\informix.prm

<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



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

General parameter fileThe informix.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: • RDBMS• DATE• OPERATORS• FUNCTIONS

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

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

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

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




Adding a function to the informix.prm fileBusiness 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=

TYPE=A Displays the type of function: A=alphanumericN=numericD=date



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

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.

SQL parameters Description



parameter.If the new function doesn’t have arguments, leave this parameter blank.





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




NAME= Example

TRAD= Text: $Date:


TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)

Viewing a newly added function in the Functions listTo 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



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


WebIntelligence parameter fileThe informix.prm file for WebIntelligence is an XML file divided into the following four sections:• Configuration• DateOperations• Operators• FunctionsYou should use an XML editor to view and modify this file.

Function

Function

Function

Function

Example

TRAD=

HELP=

TYPE=A




EXAMPLE

<Configuration>







</Configuration>


EXAMPLE

<DateOperations>




</DateOperations>

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







</Operators>

FunctionsThis 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• IDFor 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.



EXAMPLE


<Arguments>




</Arguments>


</Function>



Adding a function to the informix.prm XML fileYou 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.



following:

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





Name Displays the name of the function as it appears in BusinessObjects. This is optional in this file.

Type Displays the type of function: • String• Numeric• Char• DateTime• Logical• All



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.



The following is an example of a function for WebIntelligence:<Function Group="False" ID="Example" InMacro="True" Type="String">

<Arguments>


</Arguments>

<SQL>example($A,$D)</SQL>

</Function>

Modifying the data access configuration fileThe 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

NOTEYou 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 fileWhen 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





STRATEGY sectionThis 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 structureIn the preceding example, the strategy is a JOIN type:TYPE=JOIN



Creating an external strategy fileIf 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:


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.


Declaring an External Strategy FileOnce 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


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


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.



layer

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



is listed by registry key name without underscore characters



The driveren.cfg and driver.cfg fileThe 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 datatype conversion

Informix datatype conversionThe 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 CHARACTER

DATE DATE

DATETIME DATE

DECIMAL NUMBER

FLOAT NUMBER

INTEGER NUMBER

MONEY NUMBER

NCHAR CHARACTER

NVARCHAR CHARACTER

SERIAL NUMBER

SMALLINT NUMBER

SMALLFLOAT NUMBER

TEXT LONG TEXT

VARCHAR CHARACTER



chapter

Microsoft Data Access



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


Connecting to Business Objects products with Microsoft products

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 MiddlewareMicrosoft SQL Server 2000 ODBC 2000




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

Modifying the ODBC parameter filesThe parameter files are installed in two separate folders:.

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

File name Descriptiondriver.prm XML format)driveren.prm (text format)

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.

odbc.sbo This file contains the default connection parameters. For more information, see Modifying the data access configuration file on page 136.

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


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\odbc



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:

Depending on your Business Objects products you edit either one or both oracle.prm files as follows:



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=





<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc\driver.prm

<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




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

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


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



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 Descriptionn Order in which the function appears in the

driveren.prm file. The value n starts at 0. Each function number should be unique.








Adding a function to the driveren.prm fileBusiness 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=




11.Enter either Y or N in the GROUP= parameter, indicating Y if the function is an





Function Parameter Description



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.

NOTEIf you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file on page 135.


NAME= Example

TRAD= Text: $Date:


TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)



WebIntelligence parameter fileThe driveren.prm file for WebIntelligence is an XML file divided into the following four sections:• Configuration• DateOperations• Operators• Functions


EXAMPLE

<Configuration>







</Configuration>


EXAMPLE

<DateOperations>






</DateOperations>

OperatorsThis 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" ID="SUBSTRACT" Type="Numeric">-</Operator>





</Operators>

FunctionsThis 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• IDFor more information, see Adding a function to the driveren.prm XML file on page 135.



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


<Arguments>




</Arguments>


</Function>



Adding a function to the driveren.prm XML fileYou 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.



following:











Modifying the data access configuration fileThe 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



Modifying an external strategy fileWhen 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 Designer’s Guide for instructions on creating and using external strategy files.






SQL subsectionThis subsection contains the SQL statements that enables a universe designer to create classes and objects, joins, or table structure.


Creating an External Strategy FileTo 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:



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




The driveren.prm file is located by default at:<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\odbc



EXAMPLEThe 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



Modifying the driverEN.sbo and driverEN.cfg filesThese 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.


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




layer



For example, the Microsoft entry is displayed below:ODBC= ODBC Drivers,Allows you to access various databases

Alias SectionThis 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 fileThe 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>



ODBC the key name for ODBC

ODBC Drivers the name of the network layer

Allows you to access various databases



Stored procedures

Stored proceduresBusiness 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)

EXAMPLESimple stored proceduresStored 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



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 datatype conversion

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

Microsoft SQL ServerThe following table lists the Microsoft SQL Server internal datatypes and their BusinessObjects equivalent

Microsoft SQL Server Datatype Business Objects Suggested DatatypeBIT NUMBER

BOOLEAN NUMBER

CHAR CHARACTER

DATETIME DATE

DECIMAL NUMBER

FLOAT NUMBER

INT NUMBER

MONEY NUMBER

NUMERIC NUMBER

REAL NUMBER

SMALLDATETIME DATE

SMALLINT NUMBER

SMALLMONEY NUMBER

TEXT CHARACTER

TINYINT NUMBER

VARCHAR CHARACTER



chapter

Oracle Data Access


Oracle Data Access

OverviewThis chapter provides information about Oracle-specific connections, including:• Optimizing data access performance• Configuring the Oracle server• Oracle datatype conversionFor 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.


Connecting to Business Objects products with Oracle

Connecting to Business Objects products with Oracle

The following operating systems and Oracle releases are supported for connection:

Oracle Release MiddlewareOracle 8i Net8 Client 8.1.7

Oracle 9i Net9


Oracle Data Access


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


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

File name Descriptionoracle.prm (XML format)oracleen.prm (text format)

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.

oracleen.prm (XML format)

Contains information about each SQL function used in the oracle.prm

oracle.stg (XML format)oracleen.txt (text format)


oracleen.stg Contains information about the external strategies used in oracle.stg

oracle.sbo Contains the default connection properties. For more information, see Modifying the data access configuration file on page 161.


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\oracle



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 filesYou can add SQL functions or modify existing parameters in the oracle.prm file to optimize your connection.There are two oracle.prm files:

Depending on your Business Objects products you edit either one or both oracle.prm files as follows:


The connection is used by WebIntelligenceIf you are using WebIntelligence you need to modify both the oracle.prm files listed below:

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=





<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\oracle\oracle.prm

<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


Oracle Data Access

General parameter fileThe oracle.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: • RDBMS• DATE• OPERATORS• FUNCTIONS


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.

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

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



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


oracle.prm file. The value n starts at 0. Each function number should be unique.







Oracle Data Access

Adding a function to the oracle.prm fileBusiness 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=












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.

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


Oracle Data Access


NAME= Example

TRAD= Text: $Date:


TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)



Function TYPE=A





WebIntelligence parameter fileThe oracle.prm file for WebIntelligence is an XML file divided into the following four sections:• Configuration• DateOperations• Operators• FunctionsYou should use an XML editor to view and modify this file.

Function

Function

Function

Function

Example

TRAD=

HELP=

TYPE=A


Oracle Data Access


EXAMPLE

<Configuration>







</Configuration>


EXAMPLE

<DateOperations>




</DateOperations>





EXAMPLE

<Operators>







</Operators>

FunctionsThis 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• IDFor 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.


Oracle Data Access

EXAMPLE


<Arguments>




</Arguments>


</Function>



Adding a function to the oracle.prm XML fileYou 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.



following:









Oracle Data Access

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.




<Arguments>


</Arguments>


</Function>

Modifying the data access configuration fileThe 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




Oracle Data Access

Modifying an external strategy fileWhen 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





EXAMPLEHere 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),'|',


Oracle Data Access

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






Creating an external strategy fileIf 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:



SQL=SQL statements








Oracle Data Access

NOTE

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



layerFor 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 the key name for Net8 and Net9

Oracle Client the name of the network layer

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




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

a

a

a. The registry entryb. The name of the network layerc. The network layer description

a

c

b


Oracle Data Access

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.



is listed by registry key name without underscore charactersFor 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

The driveren.cfg and driver.cfg fileThe 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>



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

Oracle OCI the key name of the Data Access driver for Business Objects 6


Configuring the Oracle server

Configuring the Oracle serverOverview

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

Accessing stored procedures

NOTEModifying 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 ProceduresBusiness 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 ProceduresThe 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


Oracle Data Access

Ensure that your stored procedures are Business Objects-compatible.

Creating a Cursor inside a PackageA 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 RETURNall_objects%ROWTYPE;

END catalog_data;

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

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


Configuring the Oracle server

Accessing the Stored Procedure from BusinessObjectsAfter 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 User’s Guide.

EXAMPLEPackaged stored procedures and standalone stored proceduresThe 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.


Oracle Data Access

Oracle datatype conversionBusiness 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:

* indicates Oracle 9i datatype

Oracle Datatype BusinessObjects Suggested DatatypeCHAR CHARACTER

DATE DATE

FLOAT NUMBER

INTEGER NUMBER

LONG LONG TEXT

NUMBER NUMBER

VARCHAR CHARACTER

VARCHAR2 CHARACTER

chapter

Red Brick Data Access



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


Connecting to Business Objects products with Red Brick

Connecting to Business Objects products with Red Brick

The following operating systems and Red Brick products are supported for connection:

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

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

Red Brick product MiddlewareIBM Red Brick Decision Server IBM Red Brick ODBC




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

Modifying the Red Brick ODBC parameter filesThe parameter files are installed in two separate folders:.

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


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.



odbc.sbo This file contains the default connection parameters. For more information, see Modifying the data access configuration file on page 186.



<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\odbc



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:

Depending on your Business Objects products you edit either one or both Red Brick ODBC parameter files as follows:



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=





<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\odbc\driver.prm

<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







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



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:

























NAME= Example

TRAD= Text: $Date:


TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)





EXAMPLE

<Configuration>







</Configuration>


EXAMPLE

<DateOperations>






</DateOperations>


EXAMPLE

<Operators>







</Operators>





EXAMPLE


<Arguments>




</Arguments>


</Function>




6\dataAccess\RDBMS\connectionServer\ODBC\driveren.prm.



following:











Modifying the data access configuration fileThe 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




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 Designer’s Guide for instructions on creating and using external strategy files.






SQL subsectionThis subsection contains the SQL statements that enables a universe designer to create classes and objects, joins, or table structure.


Creating an External Strategy FileTo 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:



SQL=SQL statements


8. Save the file with a .txt file type. For example: microsften.txt




The driveren.prm file is located by default at:<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\odbc



EXAMPLEThe 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





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




layer



For example, the Microsoft entry is displayed below:ODBC= ODBC Drivers,Allows you to access various databases





The driveren.cfg fileThe 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>



ODBC the key name for ODBC

ODBC Drivers the name of the network layer

Allows you to access various databases



Red Brick datatype conversion

Red Brick datatype conversionThe BusinessObjects interface supports four datatypes:• date• character• number• long text

Red BrickThe following table lists the Red Brick internal datatypes and their BusinessObjects equivalent

Red Brick datatype Business Objects Suggested DatatypeCHAR CHARACTER

DATE DATE

DECIMAL NUMBER

FLOAT NUMBER

INTEGER NUMBER

NUMERIC NUMBER

SMALLINT NUMBER

TIME CHARACTER

TIMESTAMP DATE



chapter

Sybase Data Access


Sybase Data Access

OverviewThis chapter provides information about sybase-specific connections, including:• Optimizing data access performance• Sybase datatype conversionFor 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.


Connecting to Business Objects products with Sybase

Connecting to Business Objects products with Sybase

The following operating systems and Sybase releases are supported for connection:

Sybase Release MiddlewareSyabse Adaptive Server Open Client 12.x

Syabse ASE IQ ASIQ ODBC 7


Sybase Data Access


OverviewWhen 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 Descriptionsybase.prm (XML format)sybaseen.prm (text format)

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.

sybaseen.prm (XML format)

Contains information about each SQL function used in the sybase.prm

sybase.stg (XML format)sybaseen.txt (text format)


sybaseen.stg Contains information about the external strategies used in sybase.stg

sybase.sbo Contains the default connection properties. For more information, see Modifying the data access configuration file on page 209.


<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\sybase



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 filesYou can add SQL functions or modify existing parameters in the sybase.prm file to optimize your connection.There are two sybase.prm files:

Depending on your Business Objects products you edit either one or both sybase.prm files as follows:


The connection is used by WebIntelligenceIf you are using WebIntelligence you need to modify both the sybase.prm files listed below:

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

Sybase parameter file DescriptionGeneral parameter file Contains the parameters relevant to




<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\sybase\sybase.prm

<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


Sybase Data Access

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

General parameter fileThe sybase.prm file for BusinessObjects, Designer, Supervisor, and other Business Objects products is divided into the following four sections: • RDBMS• DATE• OPERATORS• FUNCTIONS


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

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




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.

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


sybase.prm file. The value n starts at 0. Each function number should be unique.






Sybase Data Access

Adding a function to the sybase.prm fileBusiness 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=














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


Sybase Data Access


NAME= Example

TRAD= Text: $Date:


TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)



Function TYPE=A





WebIntelligence parameter fileThe sybase.prm file for WebIntelligence is an XML file divided into the following four sections:• Configuration• DateOperations• Operators• FunctionsYou should use an XML editor to view and modify this file.

Function

Function

Function

Function

Example

TRAD=

HELP=

TYPE=A


Sybase Data Access


EXAMPLE

<Configuration>







</Configuration>


EXAMPLE

<DateOperations>




</DateOperations>





EXAMPLE

<Operators>







</Operators>

FunctionsThis 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• IDFor 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.


Sybase Data Access

EXAMPLE


<Arguments>




</Arguments>


</Function>



Adding a function to the sybase.prm XML fileYou 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.



following:









Sybase Data Access

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.




<Arguments>


</Arguments>


</Function>

Modifying the data access configuration fileThe 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




Sybase Data Access

Modifying an external strategy fileWhen 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








Creating an external strategy fileIf 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:



SQL=SQL statements




Sybase Data Access

Declaring an External Strategy FileOnce 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


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.










layerFor 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

.

NOTEThis 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

Sybase_CTL Key name for Sybase Open Client.Sybase Open Client Name of the network layer.Allows you to access Sybase SQL Server 11.x, and Adaptive Server 11.x.

Description of the network layer


Sybase Data Access


is listed by registry key name without underscore charactersFor 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 CTLOpen_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

The driveren.cfg and driver.cfg fileThe 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>


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

Sybase OCI the key name of the Data Access driver for Business Objects 6


Sybase datatype conversion

Sybase datatype conversionBusiness Objects products support four datatypes:• date• character• number• long textThe following table lists the Sybase internal datatypes and their equivalent in Business Objects products

Sybase Datatype BusinessObjects DatatypeBIT NUMBER

CHAR CHARACTER

DATETIME DATE

DECIMAL NUMBER

FLOAT NUMBER

INT NUMBER

MONEY NUMBER

NUMERIC NUMBER

REAL NUMBER

SMALLDATETIME DATE

SMALLINT NUMBER

SMALLMONEY NUMBER

TINYINT NUMBER

VARCHAR CHARACTER


Sybase Data Access

chapter

Teradata Data Access



OverviewThis chapter provides information about Microsoft-specific connections, including:• Optimizing data access performance• Teradata datatype conversionFor 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.


Connecting to Business Objects products with Teradata

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 MiddlewareTeradata Teradata ODBC Driver




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


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.



driver.sbo This file contains the default connection parameters. For more information, see Modifying the data access configuration file on page 230.


driver.stg (XML format)driveren.txt (text format)




Modifying the Teradata parameter filesThe parameter files are installed in two separate folders:.

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:

Depending on your Business Objects products you edit either one or both teradata.prm files as follows:



<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\teradata

WebIntelligence only <BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionserver\teradata





<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\legacy\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=




<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




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















IN_MACRO=Y Indicates whether the function appears in the list of available functions when defining a user defined object.










NAME= Example

TRAD= Text: $Date:


TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)





EXAMPLE

<Configuration>







</Configuration>


EXAMPLE

<DateOperations>






</DateOperations>


EXAMPLE

<Operators>







</Operators>





EXAMPLE


<Arguments>




</Arguments>


</Function>




6\dataAccess\RDBMS\connectionServer\teradata\driveren.prm.



following:





InMacro Indicates whether the function should appear in the list of available functions when defining user defined objects.The values are:• True• False





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




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





EXAMPLEHere 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.DataBaseName)

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






Creating an external strategy fileIf 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:



SQL=SQL statements











The driveren.cfg file for WebIntelligence is an XML file at:<BO Path>\BusinessObjects Enterprise 6\data access\RDBMS\connectionServer\driveren.cfg




layerFor example, the Teradata entry is displayed below:Teradata=Teradata ODBC Driver,Allows you to access Teradata



databases





The driveren.cfg fileThe 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>


NOTE

It is not recommended that you modify these files.

Teradata the key name for Teradata

Teradata ODBC Driver the name of the network layer

Allows you to access Teradata databases



Teradata datatype conversion

Teradata datatype conversionBusiness Objects products support three datatypes:• date• character• numberThe following table lists the Teradata internal datatypes and their equivalent in Business Objects products:

Teradata Datatype Business Objects DatatypeDATE DATE

DECIMAL NUMBER

FLOAT NUMBER

INTEGER NUMBER

SMALLINT NUMBER

BYTEINT NUMBER

DATETIME DATE

VARCHAR CHARACTER



part

Optimizing Data Access

chapter

Data Access Parameter File Reference



OverviewThis 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• FunctionsThe 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.

NOTEIf 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


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 Designer’s Guide for more information.



IBM DB2The following parameters are included by default in the following files:• db2udben.prm• db2iseriesen.prm• db2mvsen.prmNot 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.


BACK_QUOTE_SUPPORTEDBack_Quote_Supported=Y | N

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.

ResultTable name=`My Table`

COMMAComma=|| ‘ ‘|| | +’ ‘+

Syntax BACK_QUOTE_SUPPORTED=value

Default value db2udben.prm

Y

Default value db2iseriesen.prm

not available

Default value db2mvsen.prm

Y


IBM DB2

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 +’ ‘+

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

CONCATConcat=|| | +

Specifies the concatenation operator.

Values:• ||• +

EXT_JOINExt_Join=YES | NO

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.

Syntax COMMA=value

Default value ||' '||

Syntax CONCAT=value

Default value ||

Syntax EXT_JOIN=value

Default value YES



EXT_JOIN_INVERTExt_Join_Invert=YES|NO

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_COMPLEXGroupby_Exclude_Complex=Y | N

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

Syntax EXT_JOIN_INVERT=value


YES


YES


not available

Syntax GROUPBY_EXCLUDE_COMPLEX=value


N


Y


Y


IBM DB2

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_CONSTANTGroupby_Without_Constant=Y | N

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.

GROUPBYCOLGroupByCol=YES|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.

Syntax GROUPBY_WITHOUT_COMPLEX=value


N


Y


Y

Syntax GROUPBYCOL=value

Default value NO



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

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

Syntax INTERSECT=value


INTERSECT


no value


no value

Syntax INTERSECT_IN_SUBQUERY=value


INTERSECT


no value


no value


IBM DB2

KEY_INFO_SUPPORTEDKEY_INFO_SUPPORTED=Y | N

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.

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

MINUS_IN_SUBQUERYMINUS_IN_SUBQUERY=EXCEPT |

Syntax KEY_INFO_SUPPORTED=value

Default value Y

Syntax MINUS=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


OUTERJOINS_GENERATIONOuterjoins_Generation= AINSI_92 | DB2| NO

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.

ResultFROM T2 LEFT OUTER JOIN T1

ON T1.col1 = T2.col2

Syntax MINUS_IN_SUBQUERY=value


EXCEPT


no value


no value

Syntax OUTERJOINS_GENERATION=value

Default value DB2


IBM DB2

OVER_CLAUSEOVER_CLAUSE= Y | N

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.

OWNEROwner=Y|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.

QUALIFIERQualifier=Y | N

Syntax OVER_CLAUSE=value


Y


not available


not available

Syntax OWNER=value

Default 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


qualifier name.

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

Lists RISQL functions supported by database.

SORT_BY_NOSort_By_No=YES|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

Syntax QUALIFIER=value

Default value N

Syntax RISQL_FUNCTION=value


RANK,SUM,AVG,COUNT,MIN,MAX


not available


not available

Syntax SORT_BY_NO=value

Default value YES


IBM DB2

included in the SELECT statement.

STGStg=filename

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_SUBQUERYSTRING_FORMAT_IN_SUBQUERY= YES

Syntax STG=value

Default value db2en

Syntax STRING_FORMAT_IN_SUBQUERY=value


not available


not available


YES



TABLE_DELIMITERTABLE_DELIMITER=”

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”

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

Syntax TABLE_DELIMITER=value


“


not available


“

Syntax UNION=value

Default value UNION


IBM DB2

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

Syntax UNION_IN_SUBQUERY=value

Default value UNION



USER_INPUT_DATE_FORMATUser_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’

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

Syntax User_Input_Date_Format=value


‘yyyy-mm-dd’


\d ‘yyyy-mm-dd’


‘yyyy-mm-dd’


IBM DB2

USER_INPUT_NUMERIC_SEPARATORUser_Input_Numeric_Separator= , | .|

NOTEThis 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 , value100,00 is One hundred

Result with . value100.00 is One hundred

Syntax User_Input_Numeric_Separator=value

Default value



InformixThe following parameters are included by default in the informixen.prm file.


COMMAComma=|| ‘ ‘|| | +’ ‘+|




CONCATConcat=|| | +


Values:• ||• +

EVAL_WITHOUT_PARENTHESIS=Y

Syntax COMMA=value


Syntax CONCAT=value

Default value ||


Informix



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.




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_LOVForce_sorted_lov= Y | N

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.


Default value YES


Default value YES

Syntax FORCE_SORTED_LOV=value

Default value Y













Specifies if the database supports the INTERSECT set operator in a subquery.





Default value YES


Default value


Default value


Informix






LNG_SQL_HELP=80

MINUSMINUS=MINUS | EXCEPT |


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_SUBQUERYMINUS_IN_SUBQUERY=MINUS | EXCEPT |


Default value Y

Syntax MINUS=value

Default value




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_COMPLEXOuterjoins_Complex= Y | N

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.

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

OUTERJOINS_GENERATIONOuterjoins_Generation=INFORMIX | NO | ANSI_92



Default value

Syntax OUTERJOINS_COMPLEX=value

Default value Y


Default value INFORMIX


Informix

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.

ResultFROM T1, T2

WHERE T1.col1(+) = T2.col2

OWNEROwner=Y|N




owner name.




Syntax OWNER=value

Default value Y


Default value N




qualifier name.

QUOTE_OWNEROuterjoins_Generation= Y | N

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.

ResultSELECT Alias.col (<Alias> is a local Alias)

FROM 'Owner'.table.col Alias

SORT_BY_NOSort_By_No=YES | NO



NO — Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

Syntax QUOTE_OWNER=value

Default value Y


Default value YES


Informix

STGStg=filename

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


UNIONUnion=UNION|








Syntax STG=value

Default value informixen

Syntax UNION=value

Default value UNION


Default value



USER_INPUT_DATE_FORMATUser_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'


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.







Syntax USER_INPUT_DATE_FORMAT=value

Default value 'MM/DD/YYYY'


Default value


Microsoft SQL Server

Microsoft SQL ServerThe following parameters are included by default in the sqlsrven.prm file.






CHECK_OWNER_STATECheck_Owner_State=Y | 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_STATECheck_Qualifier_State=Y | N


Default value Y

Syntax CHECK_OWNER_STATE=value

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

COMMAComma=|| ‘ ‘|| | +’ ‘+



ResultTab.Col1+' '+Tab.Col2

Syntax CHECK_QUALIFIER_STATE=value

Default value N

Syntax COMMA=value

Default value +' +



CONCATConcat=|| | +


Values:• ||• +










Syntax CONCAT=value

Default value +


Default value YES


Default value NO








Specifies if the database supports the INTERSECT set operator in a subquery.







definitions from the database account. This parameter enables Designer to


Default value


Default value


Default value Y



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_OUTERLeft_Outer=$(+) | $*

Specifies the left outer join syntax.

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

MINUSMINUS=MINUS | EXCEPT |


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





Syntax LEFT_OUTER=value

Default value $*

Syntax MINUS=value

Default value


Default value





operator within a subquery. If you choose this value, two queries are generated.

OWNEROwner=Y|N




owner name.

OUTERJOINS_GENERATIONOuterjoins_Generation=USUAL | FULL_ODBC | NO


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.

ResultFROM T1, T2


Syntax OWNER=value

Default value Y


Default value USUAL







qualifier name.

REFRESH_COLUMNS_TYPERefresh_Columns_Type=O | Q | T

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_OUTERRight_Outer=$(+) | *$

Specifies the right outer join syntax.

Values• *$ — This syntax is used with Microsoft SQL Server.• $ — This represents a join expression.


Default value Y

Syntax REFRESH_COLUMNS_TYPE=value

Default value Q

Syntax RIGHT_OUTER=value

Default value *$






• NO — Specifies that you are authorized to sort columns even if they are not included in the SELECT statement.

STGStg=filename

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


TABLE_DELIMITERTABLE_DELIMITER=” | ‘



Default value NO

Syntax STG=value

Default value sqlsrven


Default value “




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.


UNIONUnion=UNION|




UNION_iN_SUBQUERYUnion_in_Subquery=UNION|




USER_INPUT_DATE_FORMATUser_Input_Date_Format=\d ‘yyy-mm-dd’|’DD-MM-YYYY

Syntax UNION=value

Default value UNION


Default value UNION



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’


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.




Values• , — Numbers are separated with a comma (,)

. — Numbers are separated with a period (.)Result with , value100,00 is One hundred


Default value 'yyyy-mm-dd HH:mm:ss'


Default value






OracleThe following parameters are included by default in the oracleen.prm file.






CASE_SENSITIVECase_Sensitive=Y | 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.



Default value Y

Syntax CASE_SENSITIVE=value

Default value N


Oracle


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.




COMMAComma=|| ‘ ‘|| | +’ ‘+|





Default value N


Default value N

Syntax COMMA=value




CONCATConcat=|| | +


Values:• ||• +









Syntax CONCAT=value

Default value ||


Default value YES


Default value YES


Oracle

EXTERN_SORT_EXCLUDE_DISTINCTExtern_Sort_Exclude_Distinct=Y | N

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.








Syntax EXTERN_SORT_EXCLUDE_DISTINCT=value

Default value Y


Default value NO


Default value INTERSECT


















Default value Y


Oracle



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

MINUSMINUS=MINUS |


Values• MINUS — Specifies that the database supports the MINUS set operator.• no value — Specifies that the database does not support the MINUS set


MINUS_IN_SUBQUERYMINUS_IN_SUBQUERY=MINUS |



within a subquery.• no value — Specifies that the database does not support the MINUS set



Default value $(+)

Syntax MINUS=value

Default value MINUS


Default value MINUS



OUTERJOINS_GENERATIONOuterjoins_Generation=USUAL | NO


Values• USUAL — Outer joins are supported. This is a generic, non-RDBMS-specific

value.• NO — Outer joins are not supported.

ResultFROM T1, T2


OWNEROwner=Y | N




owner name.

REVERSE_TABLE_WEIGHTReverse_Table_Weight=Y | N

Specifies in which order tables should be generated.


Default value USUAL

Syntax OWNER=value

Default value Y

Syntax REVERSE_TABLE_WEIGHT=value

Default value Y


Oracle

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.





STGStg=filename

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




Default value NO

Syntax STG=value

Default value oracleen









UNIONUnion=UNION|







Default value “

Syntax UNION=value

Default value UNION


Default value UNION


Oracle






Values• 'DD-MM-YYYY HH:MM:SS' — This is the default date and hour formats with

Oracle.• Other RDBMS-specific date and time formats.




Default value 'DD-MM-YYYY HH:MM:SS'


Default value








Red Brick

Red BrickThe following parameters are included by default in the redbricken.prm file.

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



ValuesY — Checks if the database supports table classification by owner name.




COMBINE_WITHOUT_PARENTHESISCOMBINE_WITHOUT_PARENTHESIS=Y | N

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


Default value N


Default value N



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

COMMAComma=|| ‘ ‘|| | +’ ‘+




Syntax COMMA=value

Default value +' '+


Red Brick

CONCATConcat=|| | +


Values:• ||





GROUPBY_WITH_ALIASGROUPBY_WITH_ALIAS= Y | N

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.

Syntax CONCAT=value

Default value +


Default value YES

Syntax GROUP_BY_ALIAS=value

Default value Y















definitions from the database account. This parameter enables Designer to


Default value NO




Default value Y


Red Brick

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.



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

MINUSMINUS=EXCEPT


Values• EXCEPT— Specifies that the database supports the MINUS set operator.• no value — Specifies that the database does not support the MINUS set


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


Default value $*

Syntax MINUS=value

Default value EXCEPT



OUTERJOINS_GENERATIONOuterjoins_Generation= AINSI_92 | USUAL | NO




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

OWNEROwner=Y|N




owner name.

PREFIX_SYS_TABLEPREFIX_SYS_TABLE= RBW_


Default value USUAL

Syntax OWNER=value

Default value N

Syntax PREFIX_SYS_TABLE=value

Default value RBW_


Red Brick

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

REFRESH_COLUMNS_TYPEREFRESH_COLUMNS_TYPE= O | Q | T


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.


Default value N


Default value Q



RIGHT_OUTERRight_Outer=*$


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

RISQL_FUNCTIONSRISQL_FUNCTION=CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTOREPORT,TERTILE,NTILE

Lists the RISQL functions supported by the database.

ValuesCUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTOREPORT,TERTILE,NTILE






Default value *$


Default value NO


Red Brick

STGSTG=filename

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


UNIONUnion=UNION|


Values• UNION — The database supports the UNION set operator.• no value — The database does not support the



Specifies the default date and hour formats input by users in WebIntelligence.

Syntax STG=value

Default value redbricken

Syntax UNION=value

Default value UNION


Default value \d 'yyyy-mm-dd'



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_SEPERATORUser_Input_Numeric_Separator= , | .|



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


Default value .


Sybase

SybaseThe following parameters are included by default in the sybaseen.prm file.




Values• Y — Checks if the database supports table classification by owner name.




COMMAComma=|| ‘ ‘|| | +’ ‘+


Default value N


Default value N






Syntax COMMA=value

Default value +' +


Sybase

CONCATConcat=|| | +


Values:• ||



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.





Syntax CONCAT=value

Default value +


Default value YES


Default value YES






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




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.




Default value NO






Sybase










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




Default value Y


Default value $*


Default value







MINUSMINUS=MINUS |


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_GENERATIONOuterjoins_Generation= AINSI_92 | USUAL | NO




• OuterJoins_Generation default value = AINSI_92.• USUAL — Outer joins are supported. This is a generic, non-RDBMS-specific

Syntax MINUS=value

Default value MINUS


Default value ANSI_92


Sybase

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

ResultFROM T1, T2


OWNEROwner=Y|N




owner name.





qualifier name.

REFRESH_COLUMNS_TYPERefresh_Columns_Type=O | Q | T

Syntax OWNER=value

Default value Y


Default value Y




Values• O — Columns are refreshed by owner name. • Q — Columns are refreshed by qualifier name.• T — Columns are refreshed by table name.

RIGHT_OUTERRight_Outer=$(+)


Values• $ — This represents a join expression.






Default value Q


Default value


Default value NO


Sybase

STGSTG=filename

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






UNIONUnion=UNION|




Syntax STG=value

Default value sqlsrven


Default value UNION

Syntax UNION=value

Default value UNION






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_SEPERATORUser_Input_Numeric_Separator= , | .|

NOTE

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


Values• , — Numbers are separated with a comma (,)


Default value 'DD-MM-YYYY HH:MM:SS'


Default value


Sybase

. — Numbers are separated with a period (.)Result with , value100,00 is One hundred




TeradataThe following parameters are included by default in the teradataen.prm file.






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

COMMAComma=|| ‘ ‘|| | +’ ‘+


Default value Y


Teradata

|




CONCATConcat=|| | +


Values:• ||• +




• 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

Syntax COMMA=value


Syntax CONCAT=value

Default value ||


Default value YES



created the outer join.














Default value YES


Default value NO




Teradata












MINUS_IN_SUBQUERYMINUS_IN_SUBQUERY=MINUS |





Default value Y


Default value MINUS




within a subquery.• no value — Specifies that the database does not support the MINUS set


MINUSMINUS=MINUS |


Values• MINUS — Specifies that the database supports the MINUS set operator.• no value — Specifies that the database does not support the MINUS set


OLAP_CLAUSEOLAP_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_GENERATIONOuterjoins_Generation=Ingres



Syntax MINUS=value

Default value MINUS


Default value USUAL


Teradata

Values• INGRES— Outer joins are supported.• NO — Outer joins are not supported.

ResultFROM T1 LEFT JOIN T2

ON T1.col1 = T2.col2

OWNEROwner=Y | N




owner name.




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

Syntax OWNER=value

Default value Y


Default value Y



RISQL_FUNCTIONSRISQL_FUNCTION=CSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANTILE,PERCENT_RANK

Lists the RISQL functions supported by the database.

ValuesCSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANTILE





STGStg=filename

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




Default value NO

Syntax STG=value

Default value teradataen


Teradata











UNIONUnion=UNION|



Default value “


Default value UNION

Syntax UNION=value

Default value UNION



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.




Values• ''yyyy-mm-dd' — This is the default date and hour formats with Teradata.• Other RDBMS-specific date and time formats.




Default value ''yyyy-mm-dd'


Default value


Teradata







chapter

Functions


Functions

OverviewThe 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• TeradataFor information on the parameters, see Data Access Parameter File Reference on page 241.


Adding a function

Adding a functionBusiness 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.





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.


NOTEIf you also use WebIntelligence, you must also complete the procedure described in Adding a function to the driveren.prm XML file.


NAME= Example

TRAD= Text: $Date:



Functions

TYPE=A

IN_MACRO=Y

GROUP=N

SQL=example($A,$D)

Adding a function to the driveren.prm XML fileYou 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.



following:




InMacro Indicates whether the function appears in the list of available functions when you define a user defined object.The values are:• True• False




Adding a function


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>


</Arguments>


</Function>


Functions

IBM DB2IBM DB2 function table

Name Trad/Arguments Function Type

Available in function list

Aggregate

Description

0 Minimum Minimum of: Numeric Yes Yes Selects the minimum value

1 Maximum Maximum of: Numeric Yes Yes Selects the maximum value

2 Average Average of: Numeric Yes Yes Returns the average value

3 Sum Sum of: Numeric Yes Yes Returns the sum of the values

4 Count Count of: Numeric Yes Yes Returns the number of values

5 ASCII code Character: Alphanumeric No No Returns the ASCII code of a character

6 Character Value of the character:

Alphanumeric No No Returns the value entered in its corresponding ASCII code

7 Concat String1: $String2: Alphanumeric Yes No Concatenates two character strings

8 Left String: $Length: Alphanumeric Yes No Returns a specified number of characters from the left of a character string

9 LeftTrim String: Alphanumeric Yes No Removes blank characters from the left of a character string


IBM DB2

10 Length Object: Numeric Yes No Returns the length of a character string

11 Locate Object: $Search: Numeric Yes No Returns the position of a character in a character string

12 Lowercase

String: Alphanumeric Yes No Returns a character string in lower case

13 Repeat Expression: $Number of times:

Alphanumeric Yes No Repeats a character expression n number of times

14 Right String: $Nbr of char. to extract:

Alphanumeric Yes No Returns a specified number of characters from the right of a character string

15 RightTrim Object: Alphanumeric Yes No Removes blank characters from the right of a character string

16 Substring String: $Initial position: $Number of characters:

Alphanumeric Yes No Extracts a sequence of characters from a character string

17 Uppercase

String: Alphanumeric Yes No Returns a character string in upper case

18 Space Nbr space char: Alphanumeric Yes No Returns a string consisting of blank characters

19 Insert String: $String_exp1: $Start: $Length:

Alphanumeric Yes No Returns a character string in which a number of character were replaced by new characters



Aggregate

Description


Functions

20 Absolute Numeric expression:

Numeric Yes No Returns the absolute value of a given expression

21 Arc cosine

Value: Numeric Yes No Returns the arc cosine of a numeric expression

22 Arc sine Value: Numeric Yes No Returns the arc sine of a numeric expression

23 Arc tangent

Value: Numeric Yes No Returns the arc tangent of a numeric expression

24 Angle Tangent 2

Angle 1: $Angle 2: 2

Numeric Yes No Returns the angle in radians whose tangent is angle1/angle2

25 Cosine Angle: Numeric Yes No Returns the cosine of a number

26 Ceil Numeric expression:

Numeric Yes No Returns the value of a number rounded up to the nearest integer

27 Exp Value: Numeric Yes No Returns the exponential value of the specified value

28 Floor Numeric expression:

Numeric Yes No Returns the value of a number rounded down to the nearest integer

29 Log Value: Numeric Yes No Returns the natural logarithm of the specified value



Aggregate

Description


IBM DB2

30 Mod Value: $Divided by

Numeric Yes No Returns the remainder of a division

31 Pi Numeric No No Returns the constant value of 3.1415926535897932

32 Random Value: Numeric No No Returns a random number between 0 and 1

33 Sign Value: Numeric No No Returns a number that represents the sign of the specified number

34 Sine Angle: Numeric Yes No Returns the sine of a number

35 Sqrt Square root of: Numeric Yes No Returns the square root of a number

36 Tangent Angle: Numeric Yes No Returns the tangent of a number

37 Cotangent

Angle: Numeric Yes No Returns the cotangent of a number

38 Degrees Angle: Numeric Yes No Converts radians to degrees

39 Log10 num exp: Numeric Yes No Returns the base 10 logarithm of the specified value

40 Power num exp: $int exp:

Numeric Yes No Returns a value raised to the nth power



Aggregate

Description


Functions

41 Radians num exp: Numeric Yes No Converts degrees to radians

42 Round num exp: $int exp:

Numeric Yes No Returns a number rounded to n decimal places

43 Truncate num exp: $int exp:

Numeric Yes No Returns a value truncated to x decimal places

44 Database Alphanumeric Yes No Returns the name of the current database

45 User Alphanumeric Yes No Returns the username of the current DB2 user

46 Case Alphanumeric No No Allows an expression to be selected based on one or more conditions

47 Character prompt

Question: Alphanumeric Yes No Prompts the user to enter a specific value

48 Numeric prompt

Question: Numeric Yes No Prompts the user to enter a specific value

49 Date prompt

Question: Date Yes No Prompts the user to enter a specific value

50 DayOfWeek

Date: Date Yes No Returns the day of the week (1 equals Sunday)

51 DayName Date: Date Yes No Returns a character string containing the name of the day

52 DayOfYear

Date: Date Yes No Returns the day of the year (1-366)



Aggregate

Description


IBM DB2

53 Days Date: Date Yes No Returns an integer representation of a date

54 Hour Value: Date Yes No Returns the hour part of a value

55 JulianDay Date: Date Yes No Returns the number of days between the date value and the start of the Julian date calendar

56 Microsecond

Value: Date Yes No Returns the microsecond part of a value

57 MidnightSeconds

Value: Date Yes No Returns the number of seconds between midnight and the specified time value

58 Minute Value: Date Yes No Returns the minute part of a value

59 Month Value: Date Yes No Returns the month part of a value

60 MonthName

Date: Date Yes No Returns a character string containing the name of the month

61 Second Value: Date Yes No Returns the second part of a value

62 Time Value: Date Yes No Returns time from a value

63 Timestamp

Value: $Value Date Yes No Returns a timestamp from a value or a pair of values



Aggregate

Description


Functions

64 TimestampISO

Date: Date Yes No Returns a timestamp value based on date, time or timestamp argument

65 TimestampDifference

Value: $Timestamp duration:

Date Yes No Returns an estimated number of intervals based on the difference between two timestamps

66 Week Date: Date Yes No Returns the number of the week

67 Year Date: Date Yes No Returns the year part of a value

68 Date Date: Date Yes No Returns a date from a value

69 Graphic Character string: $Integer value:

Alphanumeric Yes No Returns a graphic representation of a graphic string

70 LongVargraphic

Character string: Alphanumeric Yes No Returns a long vargraphic representation of a double-byte character string

71 Vargraphic

Value: Alphanumeric Yes No Returns a graphic string representation of a character string value or a graphic string value

72 Chr Value: Alphanumeric Yes No Returns the character that matches the specified ASCII code value



Aggregate

Description


IBM DB2

73 Clob Character string: $Integer value:

Alphanumeric Yes No Returns a CLOB representation of a character string

74 Coalesce Expression: $Expression:

Alphanumeric Yes No Returns the first argument that is not null

75 CountBig Expression: Numeric Yes No Returns the number of rows or values

76 Dbclob Graphic expression: $Integer value:

Alphanumeric Yes No Returns a DBCLOB representation of a graphic string

77 Difference

Character string: $Character string:

Alphanumeric Yes No Returns the difference between the SOUNDEX value of two strings

78 Digits Numeric expression:

Alphanumeric Yes No Returns a character-string representation of the absolute value of a number

79 EventMonitorState

Name of an event monitor:

Alphanumeric Yes No Returns the current state of an event monitor

80 Grouping Column name: Alphanumeric Yes No 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

81 Hex Value: Alphanumeric Yes No Returns a hexadecimal representation of a value



Aggregate

Description


Functions

82 Ln Value: Numeric Yes No Returns the natural logarithm of the specified value

83 NodeNumber

Column name: Alphanumeric Yes No Returns the row partition number

84 Nullif Expression: $Expression:

Alphanumeric Yes No Compares two expressions

85 Partition Column name: Alphanumeric Yes No Returns the partitioning map index of a row

86 Posstr Character string: Character string:

Alphanumeric Yes No Returns the starting position of a character string within another character string

87 Quarter Date: Date Yes No Returns an integer value (1 to 4) representing the quarter of the year for the specified date

88 Real Numeric expression:

Numeric Yes No Returns a single-precision floating-point representation of a number

89 Replace Expression1: $Expression2: $Expression3:

Alphanumeric Yes No Replaces all occurrences of expression2 in expression1 with expression3

90 Value Value: $Value: Alphanumeric Yes No Returns the first argument that is not null



Aggregate

Description


IBM DB2

91 Decimal from Numeric

Expression: $Precision: $Scale:

Numeric Yes No Returns a decimal representation of a number.

92 Decimal from Character

Expression: $Precision: $Scale: $Decimal character:

Numeric Yes No Returns a decimal representation of a character string.

93 Double Expression: Numeric Yes No Returns a floating-point number

94 Float Numeric expression:

Numeric Yes No Returns a floating-point representation of a number

95 Integer Expression: Numeric Yes No Returns an integer representation of a number

96 LongVarchar

Character string: Alphanumeric Yes No Returns a LONG VARCHAR representation of a character string

97 Smallint Expression: Numeric Yes No Returns a small integer representation of a number or character string

98 Translate String to be translated: $Replacement characters: $Target characters: $Pad character:

Alphanumeric Yes No Returns a value in which one or more characters in a string may have been translated into other characters

99 Varchar Character string: $Length of the string:

Alphanumeric Yes No Returns a varying-length character string



Aggregate

Description


Functions

100 Variance

Numeric expression:

Numeric Yes No Returns the variance of a set of numbers

101 Datetime to character

Datetime expression: $Valid format:

Alphanumeric Yes No Returns a character string representation of a datetime value

102 Character to character

Character expression: $Length

Alphanumeric Yes No Returns a fixed-length character string representation of a character string value

103 Numeric to character

Numeric expression:

Alphanumeric Yes No Returns a character string representation of a numeric value

104 Decimal to character

Numeric expression: $Decimal delimiter

Alphanumeric Yes No Returns a character string representation of a decimal value

105 Number to Char

Number: Alphanumeric Yes No Converts a number to a character string

106 Date to Char

Date: Alphanumeric Yes No Converts a date to a character string



Aggregate

Description


Informix

InformixInformix 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 in function list

Aggregate

Description SQL

(0)Minimum Minimum of: N Yes Yes Selects the minimum value

min($N)

(1)Maximum Maximum of: N Yes Yes Selects the maximum value

max($N)

2)Average Average of: N Yes Yes Returns the average value

avg($N)

(3)Sum Sum of: N Yes Yes Returns the sum of the values

sum($N)

(4)Count Count of: Y Yes Yes Counts the number of values

count($*)

(5)LeftRemove Character string:

A Yes No Removes blank characters from the left of a character string

Trim (LEADING FROM $A)

(6)Length Character string:

N Yes No Returns the length of a character string

LENGTH($A)

(7)RightRemove

Character string:

A Yes No Removes blank characters from the right of a character string

Trim (TRAILING FROM $A)


Functions

(8)Now D Yes No Returns the current date and time

CURRENT YEAR TO FRACTION(5)

(9)Curdate D Yes No Returns the current date

TODAY

(10)DayOfMonth

Date: N Yes No Returns the day of the month

DAY($D)

(11)DayOfWeek

Date: N Yes No Returns the day of the week

WEEKDAY($D)+1

(12)Month Date: N Yes No Returns the number of the month

MONTH($D)

(13)Year Date: N Yes No Returns the year YEAR($D)

14)Absolute Numeric expression:

N Yes No Returns the absolute value of a given expression

ABS($N)

(15)Arc cosine Value: N Yes No Returns the arc cosine of a numeric expression

ACOS($N)

(16)Arc sine Value: N Yes No Returns the arc sine of a numeric expression

ASIN($N)

(17)Arc tangent

Value: N Yes No Returns the arc tangent of a numeric expression

ATAN($N)

Name Trad/Arguments


Aggregate

Description SQL


Informix

(18)Angle Tangent 2

Angle 1: $Angle 2:

N Yes No Returns the angle in radians whose tangent is angle1/angle2

ATAN2($N,$N)

(19)Cosine Angle: N Yes No Returns the cosine of a number

COS($N)

(20)Cotangent Angle: No Yes No Returns the cotangent of an angle in radians

1/TAN($N)

(21)Exp Value: N Yes No Returns the exponential value of the specified value

EXP($N)

(22)Log Value: N Yes No Returns the natural logarithm of the specified value

LOGN($N)

(23)Mod Value: $Divided by:

N Yes No Returns the remainder of a division

MOD($N,$N)

(24)Sine Angle: Y Yes No Returns the sine of a number

SIN($N)

(25)Sqrt) Square root of:

N Yes N Returns the square root of a number

SQRT($N)

(26)Tangent Angle: N Yes No Returns the tangent of a number

TAN($N)

(27)Log10 Num exp: N Yes No Returns the base 10 logarithm of the specified value

LOG10($N)

Name Trad/Arguments


Aggregate

Description SQL


Functions

(28)Power Num exp: $Integer:

N Yes No Returns a value raised to the nth power

POW($N,$N)

(29)Round Num exp: $Int exp:

N Yes No Returns a number rounded to n decimal places

ROUND($N,$N)

(30)Truncate Num exp: $Int exp:

N Yes No Returns a value truncated to x decimal places

TRUNC($N,$N)

(31)RemoveBoth

Character string:

A Yes No Removes blank characters from the right and left of a character string

TRIM (BOTH FROM $A)

(32)Root Number: $Index number:

N Yes No Returns the root value of a numeric expression

ROOT($N,$N)

(33)DBInfo Option: A No No Returns information from the database

DBINFO($A)

(34)Hex Number: N Yes N Returns the hexadecimal equivalent of an integer expression

HEX($N)

(35)Date Date: D Yes No Returns a date type value

DATE($*)

(36)Extend D No No Adjusts the precision of a date value

EXTEND()

Name Trad/Arguments


Aggregate

Description SQL


Informix

(37)MonthDayYear

Number: $Number: $Number:

D Yes No Returns a complete date value

MDY($N,$N,$N)

(38)Character prompt

Question: A Yes No Prompts the user to enter a specific value

@prompt($A,'A',,,)

(39)Numeric prompt

Question: N Yes No Prompts the user to enter a specific value

@prompt($A,'N',,,)

(40)Date prompt

Question: D Yes No Prompts the user to enter a specific value

@prompt($A,'D',,,)

41)Number to Char

Number: A Yes No Converts a number to a character string

CAST($N AS CHAR(30))

(42)Date to Char

Date: A Yes No Converts a date to a character string

CAST($D AS CHAR(30))

Name Trad/Arguments


Aggregate

Description SQL


Functions

Microsoft SQL ServerMicrosoft SQL Server function table

Name Trad/Arguments

Function Type


Aggregate

Description



1 Uppercase String: Alphanumeric Yes No Returns a character string in upper case

2 Lowercase String: Alphanumeric Yes No Returns a character string in lower case

3 Rightpart String: $Nbr of char. to extract::

Alphanumeric Yes No Returns a specified number of characters from the right of a character string

4 LeftRemove

String: Alphanumeric Yes No Removes blank characters from the left of a character string

5 Absolute Numeric expression:


6 Round Number to round: $Precision:

Numeric Yes No Returns a number rounded to n decimal places

7 Sqrt Square root of: Numeric Yes No Returns the square root of a number


9 Maximum Maximum of: Numeric Yes Yes Selects the maximum value





12 Count Count of: Numeric Yes Yes Returns the number of values

13 Ceil Numeric expression:

Numeric Yes No Returns the value of a number rounded up to the nearest integer

14 Floor Numeric expression:

Numeric Yes No Returns the value of a number rounded down to the nearest integer

15 DateExtract

Model: $Date Expression:

Alphanumeric Yes No Extracts part of a date value

16 Arc cosine Value: Numeric Yes No Returns the arc cosine of a numeric expression

17 Arc sine Value: Numeric Yes No Returns the arc sine of a numeric expression

18 Arc Tangent

Value: Numeric Yes No Returns the arc tangent of a numeric expression

19 Angle Tangent 2

Angle 1: $Angle 2:

Numeric Yes No Returns the angle in radians whose tangent is angle1/angle2

20 Cosine Angle: Numeric Yes No Returns the cosine of a number

21 Sine Angle: Numeric Yes No Returns the sine of a number

Name Trad/Arguments

Function Type


Aggregate

Description


Functions

22 Tangent Angle: Numeric Yes No Returns the tangent of a number

23 Degrees Value: Numeric Yes No Converts radians to degrees



26 Log10 Value: Numeric Yes No Returns the base 10 logarithm of the specified value

27 Power Value: $Power: Numeric Yes No Returns a value raised to the nth power

28 Radians Value: Numeric No No Converts degrees into radians

29 Sign Value: Numeric No No Returns a number that represents the sign of the specified number

30 Random Value: Numeric No No Returns a random number between 0 and 1


32 ASCII code

Character: Alphanumeric No No Returns the ASCII code of the character

Name Trad/Arguments

Function Type


Aggregate

Description




Alphanumeric No No Returns the character that corresponds to the ASCII code

34 Charindex Expression: $Object:

Numeric No No Returns the position of an expression in a character string

35 Difference Object 1: $Object 2:

Numeric No No Returns the difference between the SOUNDEX value of two objects

36 Patindex Pattern: $Object: Numeric No No Returns the position of a character in a character string

37 Replicate Expression: $Number of times:

Alphanumeric Yes No Repeats a character expression n number of times

38 Reverse Expression: Alphanumeric Yes No Reverses a string of characters

39 Rtrim Object: Alphanumeric Yes No Removes blank characters from the right of a character string

40 Soundex String: Alphanumeric Yes No Returns a character string representing phonetically the word(s) in the string

41 Space Number of times:

Alphanumeric No No Returns a string with the number of blank characters

42 Str Alphanumeric No No Returns a value set to a specific length

Name Trad/Arguments

Function Type


Aggregate

Description


Functions

43 Stuff String1: $Initial position: $Number of characters: String2:

Alphanumeric No No Replaces a sequence of characters with other characters

44 Conversion

Alphanumeric No No Converts datatypes

45 Cotangent Value: Numeric Yes No Returns the cotangent of an angle in radians



47 Concat String1: $String2:

Alphanumeric Yes No Concatenates two character strings

48 Left String: $Length: Alphanumeric Yes No Returns a specified number of characters from the left of a character string


50 Current date

Date Yes No Returns the current date

51 Day of week

Date: Numeric Yes No Returns the day of the week (1 equals Sunday)

52 Day of month

Date: Numeric Yes No Returns the day of the month (1-31)

53 Day of year

Date: Numeric Yes No Returns the day of the year (1-366)

54 Number of the week

Date: Numeric Yes No Returns the number of the week (1-52)

Name Trad/Arguments

Function Type


Aggregate

Description



55 Number of the month

Date: Numeric Yes No Returns the number of the month (1-12)

56 Year Date: Numeric Yes No Returns the year

57 Quarter Date: Numeric Yes No Returns the quarter

58 Locate Search: $Object: Numeric Yes No Returns the position of a character in a character string

59 IsNull Expression: Numeric Yes No Returns TRUE if the expression is NULL

60 Character prompt


61 Numeric prompt


62 Date prompt


63 Case Value: $Expression: $Result1: $Result2:

Alphanumeric No No Returns a value that depends on which of the specified set of conditions is met

64 Number to Char

Number: Alphanumeric Yes No Converts a number to a character string

65 Date to Char


Name Trad/Arguments

Function Type


Aggregate

Description


Functions

OracleOracle Function table

Name Trad/Arguments

Function Type


Aggregate

Description



1 Uppercase String: Alphanumeric Yes No Returns a character string in upper case

2 Lowercase String: Alphanumeric Yes No Returns a character string in lower case

3 Initial_caps String: Alphanumeric Yes No Capitalizes the first letter of a character string, while the remaining letters appear in lower case

4 Transforms Replace in: $Old character: $New character:

Alphanumeric Yes No Transforms each occurrence of the old character by the new character

5 Replace Replace in: $Old string: $New string:

Alphanumeric Yes No Replaces a string of characters by a new string

6 Round Number to round off: $Number of decimals

Alphanumeric Yes No Returns a number rounded to n decimal places


Oracle

7 Sqrt Number: Numeric Yes No Returns the square root of a number

8 Minimum Minimum of:

Numeric Yes Yes Selects the minimum value

9 Maximum Maximum of:

Numeric Yes Yes Selects the maximum value



12 Variance Variance of: Numeric Yes Yes Returns the statistical variance of a group of values

13 Stddev Stddev of: Numeric Yes Yes Returns the standard deviation of a group of values

14 Count Number of: Numeric Yes Yes Returns the number of values

15 Ceil Value: Numeric Yes No Returns the value of a number rounded up to the nearest integer

16 Floor Value: Numeric Yes No Returns the value of a number rounded down to the nearest integer

17 Mod Value: $Divided by:


18 Power Value: $Power:

Numeric Yes No Returns a value raised to the nth power

19 Trunc Value: $Decimal:

Numeric Yes No Returns a value truncated to x decimal places

Name Trad/Arguments

Function Type


Aggregate

Description


Functions


Alphanumeric Yes No Returns a character corresponding to its ASCII code

21 ORACLESize

String: Numeric Yes No Returns how many bytes are necessary to store ORACLE internally

22 Left padding Character String: $Length: $Characters:

Alphanumeric Yes No Adds characters to the left of a character string as many times as necessary

23 Left trim Character String: $Characters:

Alphanumeric Yes No Removes characters from the left of a character string

24 Right padding

Character String: $Length: $Characters:

Alphanumeric Yes No Adds characters to the right of a character string as many times as necessary

25 Right trim Character String: $Characters:

Alphanumeric Yes No Removes characters from the right of a character string

26 Soundex String: Alphanumeric Yes No Returns a character string representing phonetically the word(s) in the string

27 ASCII Character: Alphanumeric Yes No Returns the ASCII code of a character

28 Instr Character String: $Search:

Numeric Yes No Returns the position of a character in a character string

Name Trad/Arguments

Function Type


Aggregate

Description


Oracle


30 Chartorowid Rowid: Numeric No No Converts a value to ROWID

31 To_char Value: Alphanumeric Yes No Converts a value to a character string

32 Date to Char


33 To_number String: Numeric Yes No Converts a character string to a numerical value

34 To_date String: $Format:

Date Yes No Converts a character string to a date value

35 Add months Date: $Number of month:

Date Yes No Adds a number of months to a date

36 Last day Date: Date No No Returns the last day of the month of a defined date

37 Character NVL

Object 1: $Object 2:

Alphanumeric Yes No If Object 1 is null, returns Object 2; if Object 1 is not null, returns Object 1

38 Numeric NVL

Object 1: $Object 2:

Numeric Yes No If Object 1 is null, returns Object 2; if Object 1 is not null, returns Object 1

39 Date NVL Object 1: $Object 2:

Date Yes No If Object 1 is null, returns Object 2; if Object 1 is not null, returns Object 1

40 Months between

Source Date: $Destination Date:

Numeric Yes No Returns the number of months between two dates

Name Trad/Arguments

Function Type


Aggregate

Description


Functions

41 Next_day Date: $Day: Date Yes No

42 Decode Alphanumeric No No Compares and replaces strings

43 Greatest Alphanumeric No No Returns the greatest value from a list

44 Least Alphanumeric No No Returns the smallest value from a list

45 UID Numeric No No Returns the unique integer assigned to each username

46 User Alphanumeric No No Returns the username of the current ORACLE user

47 Absolute Value: Numeric Yes No Returns the absolute value of a number

48 Sign Value: Numeric Yes No Returns a number that represents the sign of the specified number

49 New Time Date: $Time Zone1: $Time Zone2:

Date No No Returns the date and time

50 Sysdate Date No No Returns the current date and time

51 Dump Alphanumeric No No Returns a value containing the type, length and internal format of an expression

52 UserEnv Option: Alphanumeric No No Returns information about the current session

Name Trad/Arguments

Function Type


Aggregate

Description


Oracle

53 Nlssort String: Alphanumeric No No Returns a string of bytes to sort a character string

54 Add Days Date: $Number of days:

Date Yes No Adds a number of days to a date

55 Days between

Date1: $Date2:

Numeric Yes No Returns the number of days between date1 and date2


Alphanumeric Yes No Concatenates two character strings

57 Character prompt


58 Numeric_prompt


59 Date prompt Question: Date Yes No Prompts the user to enter a specific value

60 RANK OVER

Rank over : Numeric No No Returns an ordered ranking of rows starting with a rank of one

61 SUM OVER Sum over : Numeric No No Returns the sum over a set of rows

62 AVG OVER Average over :

Numeric No No Returns the average over a set of rows

63 COUNT OVER

Count over : Numeric No No Returns the quantity over a set of rows

64 MIN OVER Min over : Numeric No No Returns the minimum over a set of rows

65 MAX OVER Max over : Numeric No No Returns the maximum over a set of rows

Name Trad/Arguments

Function Type


Aggregate

Description


Functions

66 RATIO_TO_REPORT

Ratio_to_report over :

Numeric No No Computes the ratio of a value to the sum of a set of values

67 CUME_DIST OVER

Cume_dist over :

Numeric No No Calculates the cumulative distribution of a value in a group of values

68 DENSE_RANK OVER

Dense_rank over :

Numeric No No Computes the rank of each row returned from a query with respect to the other rows

69 FIRST_VALUE OVER

First_value over :

Alphanumeric No No Returns the first value in an ordered set of values

70 LAST_VALUE OVER

Last_value over :

Alphanumeric No No Returns the last value in an ordered set of values

71 LAG Lag : Alphanumeric No No Provides access to a row at a given physical offset prior to that position

72 LEAD Lead : Alphanumeric No No Provides access to a row at a given physical offset beyond that position

73 NTILE Ntile : Numeric No No Divides an ordered dataset into a number of buckets indicated by expr and assigns the appropriate bucket number to each row

74 PERCENT_RANK

Percent rank :

Numeric No No Calculates the rank of a row minus 1, divided by 1 less than the number of rows being evaluated

Name Trad/Arguments

Function Type


Aggregate

Description


Oracle

75 PERCENTILE_CONT

Percentile cont :

Numeric No No 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

76 PERCENTILE_DISC

Percentile disc :

Numeric No No Takes a percentile value and a sort specification and returns an element from the set

77 ROW_NUMBER

Row number :

Numeric No No 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

78 CORR OVER

Corr over: Numeric No No Returns the cumulative coefficient of correlation of a set of number pairs over a set of rows

79 COVAR_POP OVER

Covar_pop over:

Numeric No No Returns the cumulative population covariance of a set of number pairs over a set of rows

80 COVAR_SAMP OVER

Covar_samp over:

Numeric No No Returns the cumulative sample covariance of a set of number pairs over a set of rows

Name Trad/Arguments

Function Type


Aggregate

Description


Functions

81 REGR_SLOPE OVER

Regr_slope over:

Numeric No No Returns the cumulative slope of the regression line over a set of rows

82 REGR_INTERCEPT OVER

Regr intercept over:

Numeric No No Returns the cumulative y-intercept of the regression line over a set of rows

83 REGR_COUNT OVER

Regr count over:

Numeric No No Returns the cumulative number of non-null number pairs used to fit the regression line over a set of rows

84 REGR_R2 OVER

Regr R2 over:

Numeric No No Returns the cumulative coefficient of determination for the regression line over a set of rows

85 REGR_AVGX OVER

Regr avgx over:

Numeric No No Makes the following computation AVG(expr2) over a set of rows after the elimination of null (expr1, expr2) pairs

86 REGR_AVGY OVER

Regr avgy over:

Numeric No No Makes the following computation AVG(expr1) over a set of rows after the elimination of null (expr1, expr2) pairs

Name Trad/Arguments

Function Type


Aggregate

Description


Oracle

87 REGR_SXX OVER

Regr sxx over:

Numeric No No Makes the following computation REGR_COUNT(expr1, expr2) * VAR_POP(expr2) over a set of rows after the elimination of null (expr1, expr2) pairs

88 REGR_SYY OVER

Regr syy over:

Numeric No No Makes the following computation REGR_COUNT(expr1, expr2) * VAR_POP(expr1) over a set of rows after the elimination of null (expr1, expr2) pairs

89 REGR_SXY OVER

Regr sxy over:

Numeric No No 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

90 STDDEV OVER

Stddev over:

Numeric No No Returns the cumulative standard deviation over a set of rows

91 STDDEV_POP OVER

Stddev pop over:

Numeric No No Returns the cumulative population standard deviation over a set of rows

Name Trad/Arguments

Function Type


Aggregate

Description


Functions

92 STDDEV_SAMP OVER

Stddev samp over:

Numeric No No Returns the cumulative sample standard deviation of a set of numbers over a set of rows

93 VAR_POP OVER

Regr sxy over:

Numeric No No Returns the cumulative population variance of a set of numbers over a set of rows

94 VAR_SAMP OVER

Regr sxy over:

Numeric No No Returns the cumulative sample variance of a set of numbers over a set of rows

95 VARIANCE OVER

variance over:

Numeric No No Returns the cumulative variance of a set of numbers over a set of rows

Name Trad/Arguments

Function Type


Aggregate

Description


Red Brick

Red BrickRed Brick function tableThe code for data type (Type) used in the table is as follows:• A = Alphanumeric• N = Numeric• D = Date

Name Trad/Arguments


Aggregate

Description SQL

(0)Substring String: $Initial position: $Number of characters:

A Y N Extracts a sequence of characters from a character string

SUBSTR($A,$N,$N)

(1)Minimum Minimum of: N Y Y Selects the minimum value

MIN($N)

(2)Maximum Maximum of: N Y Y Selects the maximum value

MAX($N)

(3)Average Average of: N Y Y Returns the average value

AVG($N)

(4)Sum Sum of: N Y Y Returns the sum of the values

SUM($N)

(5)Count Number of: N Y Y Returns the number of values

COUNT($*)

(6)Running total

Running total of:

N Y Y Returns the runnning total of the values

CUME($N)

(7)Moving average

Moving average of: $Number of rows:

N Y Y Returns the average of the values for the last n rows

MOVINGAVG($N,$N)


Functions

(8)Moving sum Moving sum of: $Number of rows:

N Y Y Returns the sum of the values for the last n rows

MOVINGSUM($N,$N)

(9)Rank Rank of: N Y Y Returns the rank of a specified value relative to a group of values

RANK($N)

(10)Ratio to report

Ratio to report of:

N Y Y Returns the ratio of a value to the sum of a group of values

RATIOTOREPORT($N)

(11)Tertile Tertile of: A Y Y Classifies the value of an expression into (H)igh, (M)edium, or (L)ow

TERTILE($N)

(12)LeftRemove

String: Y N N Trims leading blanks

LTRIM($A)

(13)RightRemove

String: A Y N Removes blank characters from the right of a character string

RTRIM($A)

(14)Trim String: $Set: A Y N Removes blank characters from the right and left of a character string

TRIM($A,$A)

(15)Decode A N N Compares and replaces strings

DECODE()

(16)Ifnull A N N Returns a string if NULL

IFNULL()

Name Trad/Arguments


Aggregate

Description SQL


Red Brick

(17)Current User

A Y N Returns the username of the current Red Brick user

CURRENT_USER

(18)Case Case expression: $Case expression: $Result: $Result:

A Y N Returns a value that depends on which of the specified set of conditions is met

CASE $A WHEN $A THEN $A ELSE $A END

(19)Coalesce Expression: $Expression:

N Y N Returns the value of the first argument that is not NULL

COALESCE($N,$N)

(20)Coalesce Expression: $Expression:

A Y N Returns the value of the first argument that is not NULL

COALESCE($A,$A)

(21)If Null Expression: $Substitute:

N Y N Tests an expression for missing values and replaces each one with a specific value

IFNULL($N,$N)

(22)Absolute Numeric expression:

N Y N Returns the absolute value of a given expression

ABS($N)

(23)Ceil Numeric expression:

N Y N Returns the value of a number rounded up to the nearest integer

CEIL($N)

Name Trad/Arguments


Aggregate

Description SQL


Functions

(24)Decimal Expression: $Precision: $Scale:

A N N Converts a specified value to a DECIMAL value

DEC($N,$N,$N)

(25)Float Expression: N Y N Returns a specified value into a floating-point value

FLOAT($N)

(26)Floor Value: N Y N Returns the value of a number rounded down to the nearest integer

FLOOR($N)

(27)Integer Numeric expression:

N Y N Returns the integer portion of a number

INT($N)

(28)Sign Value: N Y N Returns a number that represents the sign of the specified number

SIGN($N)

(29)Concat String1: $String2:

A Y N Concatenates two character strings

CONCAT($A,$A)

(30)Uppercase String: A Y N Returns a character string in upper case

UPPER($A)

(31)Lowercase String: A Y N Returns a character string in lower case

LOWER($A)

(32)To char Expression: $Length: $Scale:

A Y N Converts a value to a character string

CHAR($N,$N,$N)

Name Trad/Arguments


Aggregate

Description SQL


Red Brick

(33)Current date and time

A Y N Returns the current date and time

CURRENT_TIMESTAMP

(34)Current Date

A Y N Returns the current date

CURRENT_DATE

(35)Current time

A Y N Returns the current time

CURRENT_TIME

(36)To date String: D Y N Converts a character string to a date value

DATE($A)

(37)Add Date Date: $Interval: $Date:

D Y N Adds an interval to a datetime value

DATEADD($D,$N,$D)

(38)Date Difference

Date: $date: $Date

N N N Returns the difference between two date values

DATEDIFF($D,$D,$D)

(39)CharDateExtract

Date part: $Datetime expression:

A Y N Extracts part of a date value

DATENAME($A,$A)

(40)NumericDateExtract

Date part: $Datetime expression:

N Y N Extracts part of a date value

EXTRACT($A FROM $D)

(41)Time D N N Creates a time value

TIME()

(42)TimeStamp D N N Creates a timestamp value

TIMESTAMP()


Question: A Y N Prompts the user to enter a specific value

@PROMPT($A,'A',,,)

Name Trad/Arguments


Aggregate

Description SQL


Functions

(44)Numeric prompt

Question: N Y N Prompts the user to enter a specific value

@PROMPT($A,'N',,,)

(45)Date prompt

Question: D Y N Prompts the user to enter a specific value

@PROMPT($A,'D',,,)

(46)Expression Expression: $Expression:

A Y N Converts numeric or datetime values to character strings

STRING($*,$A)

(47)Real Numeric expression:

N Y N Converts an expression into a real value

REAL($A)

(48)NumberToString

Expression: $Length: $Scale:

A Y N Converts an expression into a string

STRING($N, $N, $N)

(49)DateToString

Expression: $Length: $Scale:

A Y N Converts an expression into a string

STRING($D, $N, $N)

(50)Nullif Expression: $Expression:

A N N Compares two expressions

NULLIF($A,$A)

(51)Ntile Numeric: $Integer:

N Y N Determines the rank of a value

NTILE($N,$N)

(52)NumericDayExtract

N Y N Extracts the day part of a date value

EXTRACT(DAY FROM $D)

(53)NumericMonthExtract

N Y N Extracts the month part of a date value

EXTRACT(MONTH FROM $D)

Name Trad/Arguments


Aggregate

Description SQL


Red Brick

(54)NumericYearExtract

N Y N Extracts the year part of a date value

EXTRACT(YEAR FROM $D)

(55)NumericQuarterExtract

N Y N Extracts the quarter part of a date value

EXTRACT(QUARTER FROM $D)

(56)Number to Char

Number: A Y N Converts a number to a character string

NSQL=STRING($N)

(57)Date to Char

Date: A Y N Converts a date to a character string

NSQL=STRING($D)

Name Trad/Arguments


Aggregate

Description SQL


Functions

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


Aggregate

Description SQL

(0)Substring String: $Initial position: $Number of characters:

A Yes No Extracts a sequence of characters from a character string

substring($A,$N,$N)

(1)Uppercase String: A Yes No Returns a character string in upper case

upper($A)

(2)Lowercase String A Yes No Returns a character string in lower case

lower($A)

(3)Rightpart Character String: $Nbr of char. to extract:

A Yes No Returns a specified number of characters from the right of a character string

right($A,$N)

(4)RemoveLeadBlanks

Character String:

A Yes No Removes leading blanks from the character string

ltrim($A)

(5)Absolute Numeric expression:

N Yes No Returns the absolute value of a given expression

abs($N)


Sybase

(6)Round Number to round: $Precision:

N Yes N Returns a number rounded to n decimal places

round($N,$N)

(7)Sqrt Square root of:

N Yes No Returns the square root of a number

sqrt($N)

(8)Minimum Minimum of: N Yes Yes Selects the minimum value

min($*)

(9)Maximum Maximum of: N Yes Yes Selects the maximum value

max($*)

(10)Average Average of: N Yes Yes Returns the average value

avg($N)

(11)Sum Sum of: N Yes Yes Returns the sum of the values

sum($N)

(12)Count Count of: N Yes Yes Returns the number of values

count($*)

(13)Ceil Numeric expression:

N Yes No Returns the value of a number rounded up to the nearest integer

ceiling($N)

(14)Floor Numeric expression:

N Yes No Returns the value of a number rounded down to the nearest integer

floor($N)

(15)DateExtract

Model: $Date Expression:

A Yes No Extracts part of a date value

Datename($A,$D)

(16)Arc cosine Value: N Yes No Returns the arc cosine of a numeric expression

acos($N)

Name Trad/Arguments


Aggregate

Description SQL


Functions

(17)Arc sine Value: N Yes No Returns the arc sine of a numeric expression

asin($N)

(18)Arc tangent

Value: N Yes No Returns the arc tangent of a numeric expression

atan($N)

(19)Angle Tangent 2

Angle 1: $Angle 2:

N Yes No Returns the angle in radians whose tangent is angle1/angle2

atn2($N,$N)

(20)Cosine Angle: N Yes No Returns the cosine of a number

cos($N)

(21)Sine Angle: N Yes No Returns the sine of a number

sin($N)

(22)Tangent Angle: N Yes No Returns the tangent of a number

tan($N)

(23)Degrees Value: No Yes No Converts radians to degrees

degrees($N)

(24)Exp Value: No Yes No Returns the exponential value of the specified value

exp($N)

(25)Log Value: N Yes No Returns the natural logarithm of the specified value

log($N)

(26)Log10 Value: N Yes No Returns the base 10 logarithm of the specified value

log10($N)

Name Trad/Arguments


Aggregate

Description SQL


Sybase

(27)Power Value: $Power:

N Yes No Returns a value raised to the nth power

power($N,$N)

(28)Radians Value: N No No Converts degrees into radians

radians($N)

(29)Sign Value: N No No Returns a number that represents the sign of the specified number

sign($N)

(30)Random Value: N No No Returns a random number between 0 and 1

rand($N)

(31)Pi N No No Returns the constant value of 3.1415926535897932

pi()

(32)ASCII code

Character: A No No Returns the ASCII code of a character

ascii($C)

(33)Character Value of the character:

A No No Returns the character that corresponds to the ASCII code

char($N)

(34)Charindex Expression: $Object:

N No No Returns the position of an expression in a character string

charindex($A,$A)

(35)Difference Object 1: $Object 2:

N No No Returns the difference between the SOUNDEX value of two objects

difference($A,$A)

Name Trad/Arguments


Aggregate

Description SQL


Functions

(36)Patindex Pattern: $Object:

N No No Returns the position of a character in a character string

patindex($A,$A)

(37)Replicate Expression: $Number of times:

A Yes No Repeats a character expression n number of times

replicate($A,$N)

(38)Reverse Expression: A Yes No Reverses a string of characters

reverse($A)

(39)RemoveTrailBlanks

Character String:

A Yes No Removes trailing blanks from the character string

rtrim($A)

(40)Soundex String: A Yes No Returns a character string representing phonetically the word(s) in the string

soundex($A)

(41)Space Number of times:

A No No Returns a string with the number of blank characters

space($N)

(42)Str A No No Returns a value set to a specific length

str()

(43)Stuff String1: $Initial position: $Number of characters: String2:

A No No Replaces a sequence of characters with other characters

stuff($A,$N,$N,$A)

(44)Conversion

A No No Converts datatypes

Convert()

Name Trad/Arguments


Aggregate

Description SQL


Sybase


Question: A Yes No Prompts the user to enter a specific value

@prompt($A,'A',,,)

(46)Numeric prompt

Question: N Yes No Prompts the user to enter a specific value

@prompt($A,'N',,,)

(47)Date prompt

Question: D Yes No Prompts the user to enter a specific value

@prompt($A,'D',,,)

(48)Case Value: $Expression: $Result1: $Result2:

A No No Returns a value that depends on which of the specified set of conditions is met


(49)Number to Char

Number: A Yes No Converts a number to a character string

convert(char,$N)

(50)Date to Char

Date: A Yes No Converts a date to a character string

convert(char,$D)

Name Trad/Arguments


Aggregate

Description SQL


Functions

TeradataTeradata function table

Name Trad/arguments


Aggregate

Description SQL


min($*)


avg($N)

3 Sum Sum of: Numeric Yes yes Returns the sum of the values

sum($N)

4 Count Count of: Numeric Yes Yes Counts the number of entries

count($*)


Alphanumeric

Yes No Concatenates two character strings

{fn concat($A,$A)}

6 Left String: $Length:

Alphanumeric

Yes No Returns a specified number of characters from the left of a character string

{fn left($A,$N)}


{fn length($A)}

8 Locate Object: $Search:

Numeric Yes No Returns the position of a character in a character string

{fn locate($A,$A)}

9 Rtrim Object: Alphanumeric

Yes No Removes blank characters from the right of a character string

{fn rtrim($A)}


Teradata

10 Substring

String: $Initial position: $Number of characters:

Alphanumeric

Yes No Extracts a sequence of characters from a character string

{fn substring($A,$N,$N)}

11 Uppercase

String: Alphanumeric

Yes No Returns a character string in upper case

{fn ucase($A)}

12 Absolute

Numeric expression:


{fn abs($N)}


{fn exp($N)}


{fn log($N)}



{fn mod($N,$N)}


{fn pi()}

17 Sqrt Square root of:

Numeric Yes No Returns the square root of a number

{fn sqrt($N)}

18 Character prompt

Question: Alphanumeric

Yes No Prompts the user to enter a specific value

@prompt($A,'A',,,)

19 Numeric prompt


@prompt($A,'N',,,)

Name Trad/arguments


Aggregate

Description SQL


Functions

20 Date prompt


@prompt($A,'D',,,)

21 RightRemove

Character string:

Alphanumeric

Yes No Removes blank characters from the right of a character string

TRIM (TRAILING FROM $A)

22 LeftRemove

Character string:

Alphanumeric

Yes No Removes blank characters from the left of a character string

TRIM (LEADING FROM $A)

23 RemoveBoth

Character string:

Alphanumeric

Yes No Removes blank characters from the right and left of a character string

TRIM (BOTH FROM $A)

24 Case Value: $Expression: $Result1: $Result2:

Alphanumeric

Yes No Chooses different results based on the value of an expression


25 NullIf Expression1: $Expression2:

Alphanumeric

Yes No Compares two expressions

NULLIF($A, $A)

26 Coalesce

Expression: Alphanumeric

Yes No Returns the value of the first argument that is not NULL

GROUP=NSQL=COALESCE($A)

27 YearExtract

Date: Numeric Yes No Extracts the year part of a date value

EXTRACT(YEAR FROM $D)

Name Trad/arguments


Aggregate

Description SQL


Teradata

28 MonthExtract

Date: Numeric Yes No Extracts the month part of a date value

EXTRACT(MONTH FROM $D)

29 DayExtract

Date: Numeric Yes No Extracts the day part of a date value

EXTRACT(DAY FROM $D)

30 HourExtract

Time: Numeric Yes No Extracts the hour part of a time value

EXTRACT(HOUR FROM $N)

31 MinuteExtract

Time: Numeric Yes No Extracts the minute part of a time value

EXTRACT(MINUTE FROM $N)

32 SecondExtract

Time: Numeric Yes No Extracts the second part of a time value

EXTRACT(SECOND FROM $N)

33 Add months

Date: $Number of months:

Date Yes No Adds a number of months to a date

ADD_MONTHS($D, $N)

34 CurrentDate

Date Yes No Returns the current date

DATE

35 Cumulative sum

Value expression: $Sort expression:

Numeric No No Returns the cumulative sum of the values

CSUM($N,$*)

36 Moving average

Value expression: $Width: $Sort expression:

Numeric No No Returns the moving average of the values for the last n rows

MAVG($N,$N,$*)

Name Trad/arguments


Aggregate

Description SQL


Functions

37 Rank Sort expression:

Numeric No No Returns the rank of a specified value relative to a group of values

RANK($*)

38 Moving sum

Value expression: $Width: $Sort expression list:

Numeric No No Returns the moving sum of the values for the last n rows

MSUM($N,$N,$*)

39 Moving difference

Value expression: $Width: $Sort expression list:

Numeric No No Returns the moving difference of the values for the last n rows

MDIFF($N,$N,$*)

40 Quantile

Quantile constant: $Sort Expression:

Numeric No No Returns the quantile scores for the values in a column

QUANTILE($N,$*)

41 Moving linear regression

Value expression: $Width: $Sort expression:

Numeric No No Returns a predicated value for a column

MLINREG($N,$N,$*)

42 Number to Char

Number: Alphanumeric

Yes No Converts a number to a character string

CAST($N AS CHAR(30))

Name Trad/arguments


Aggregate

Description SQL


Teradata

43 Date to Char

Date: Alphanumeric

Yes No Converts a date to a character string

CAST($D AS CHAR(30))

44 Rank Over

Rank over: $Sort Expression:

Numeric No No Returns an ordered ranking of rows starting with a rank of one

RANK() OVER (PARTITION BY ($*) ORDER BY ($*))

48 Percent Rank Over

Percent Rank over: $Sort Expression:

Numeric No No Returns the relative rank of rows

PERCENT_RANK() OVER (PARTITION BY ($*) ORDER BY ($*))

Name Trad/arguments


Aggregate

Description SQL


Functions

chapter

General Data Access Configuration File Reference



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


IBM DB2

IBM DB2ArrayFetch

ArrayFetch=n

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.

AsyncModeAsyncMode=0|1

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 UnitCost Estimate Unit = 0 | 1

Specifies how the database returns a cost estimate.

Parameter Type Numeric

Syntax ARRAYFETCH=value

Default value

Parameter Type Boolean

Syntax ASYNCMODE=value

Default value

Syntax COST ESTIMATE UNIT=value

Description Any RDBMS supporting the 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.

DriverLevelDriverLevel=1|13|15|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.

InputDateFormatInputDateFormat=\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’

Specifies the default date and hour formats generated in the WHERE clause of a SQL script.


Syntax DriverLevel=value

Default value

Parameter Type Alphanumeric

Syntax InputDateFormat=value

Default value 'yyyy-mm-dd HH:mm:ss'


IBM DB2

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.

IsThreadSafeIsThreadSafe=0|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.

Pool TimePool Time=0 | -1 | n

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


Syntax IsThreadSafe=value

Default value

Parameter Type

Syntax Pool Time=value

Default value



RecommendedLenTransfertRecommendedLenTransfert=n

Specifies the number of bytes per block. This parameter is used when exporting a document.

ValuesRDBMS specificNote: For IBM DB2/UDB for OS/390, do not increase the default value above the buffer pool size.

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

RemovePVRemovePV=0 | 1

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.

SharedShared=1|2|4

Parameter Type


Default value


Syntax RemovePV=value

Default value


IBM DB2

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

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

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


Syntax Shared=value

Default value 4

Parameter Type String

Syntax SQL External File=value

Default value None



SQL Parameter File

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

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


Syntax SQL Parameter File=value

Default value None


Informix

InformixAsyncMode

AsyncMode=0|1



ArrayFetchArrayFetch=n



SharedShared=1|2|4




Default value 0



Default value 10


Syntax Shared=value

Default value 4









NOTEIf 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 TimePool Time=0|-1|n





Default value 31

Parameter Type


Default value 1


Informix


default value (1).

SQL External File



SQL Parameter File



InputDateFormatInputDateFormat=\d ‘yyy-mm-dd’|’DD-MM-YYYY HH:MM:SS’|’YYYY-MM-



Default value informix



Default value informix



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

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.

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

AuditTimeStampFormatInputDateFormat=’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.




Default value MM/DD/YYYY'


Syntax AuditTimeStampFormat=value

Default value 'YYYY-MM-DD HH:MM:SS'


Informix








Default value 1

Parameter Type

Syntax RecommendedLenTransfert=value

Default value 30000



Microsoft SQL ServerArrayFetch

ArrayFetch=n










Default value



Default value



Default value











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.




Default value









default value (1).

SharedShared=1|2|4




Default value

Parameter Type


Default value


Syntax Shared=value

Default value 4




SQL External File




SQL Parameter File




Default value None



Default value None



Values• oracle — for Oracle• sqlsrv — for Microsoft SQL Server• db2udb — for IBM DB2• db2as400 — for IBM DB2 UDB AS/400


TxnIsolationTxnIsolation=0 | 1 | 2 | 4 | 8

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.


Syntax TxnIsolation=value

Default value


Oracle

OracleArrayFetch

ArrayFetch=n






AutoCommitAutoCommit=0|1|2

Controls when a database commits pending changes.



Default value



Default value

Parameter Type ??

Syntax AUTOCOMMIT=value

Default value



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.














Default value


Oracle

NOTE


InitDateFormatInitDateFormat=’DD-MM-YYYY HH24:MI:SS’

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.

InitNumericSeparatorInitNumericSeparator=’.,’ | ‘,’

Specifies the default decimal separator stored on the server.

Values• '.,'• ‘,’


Parameter Type

Syntax InitDateFormat=value

Default value


Syntax InitNumericSeparator=value

Default value '.,'




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







Lock ModeLock Mode=0 | 4



Default value



Default value


Oracle

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 TimePool Time=0 | -1 | n




default value (1).




Syntax Lock Mode=value

Default value 4

Parameter Type


Default value

Parameter Type


Default value



ValuesRDBMS specificNote: For IBM DB2/UDB for OS/390, do not increase the default value above the buffer pool size.


RemovePVRemovePV=0|1

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.

RunInitRunInit=0|1

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.

SharedShared=1|2|4


Syntax RemovePV=value

Default value


Syntax RunInit=value

Default value


Oracle



SQL External File





Syntax Shared=value

Default value 4



Default value None



SQL Parameter File


Values• oracle — for Oracle• sqlsrv — for Microsoft SQL Server• db2udb — for IBM DB2




Default value None


Red Brick

Red BrickRed Brick uses the ODBC.SBO file for connection default values.








default value (1).




Default value 1

Parameter Type


Default value 1








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



Default value 1



Default value redbrick


Red Brick

SQL Parameter File



LongVarcharNotSupportedLOngVarCharNotSupported=1|0

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.




Default value redbrick

Parameter Type

Syntax LongVarCharNotSupported=value

Default value 1





Parameter Type


Default value 124


Sybase

SybaseAutoCommit

AutoCommit=0|1|2

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.





Parameter Type

Syntax AUTOCOMMIT=value

Default value 0



Default value 0





SharedShared=1|2|4









Default value 50


Syntax Shared=value

Default value 4

Parameter Type


Default value 1


Sybase

default value (1).







SQL External File





Default value 31



Default value sybase



SQL Parameter File



InputDateFormatInputDateFormat=’mm/dd/yyyy hh:m:s am/pm’



AuditTimeStampFormatInputDateFormat=mm/dd/yyyy hh:mm:ss am/pm'



Default value sybase



Default value mm/dd/yyyy hh:m:s am/pm


Sybase

Specifies the default date and hour format generated in the WHERE clause of a SQL script used by the WebIntelligence auditing feature.

Password_EncryptionPassword_Encryption=’mm/dd/yyyy hh:m:s am/pm’

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.




IsMdwThreadSafeIsThreadSafe=0|1


Syntax AuditTimeStampFormat=value

Default value mm/dd/yyyy hh:mm:ss am/pm'

Syntax Password_Encryption=value

Default value 1



Default value 1



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.

IsParseSupportedIsparseSupported=Y|N

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.

IsBindSupportedIsBindSupported=Y|N

Specifies if the middleware supports binding.


Syntax MdwThreadSafe=value

Default value Y



Default value Y


Syntax IsBindSupported=value

Default value Y


Sybase

Values• Y— Specifies that the middleware supports binding. This is the default value.• N— Specifies that the middleware does not supports binding.

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

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

CommitTranSyntaxCommitTranSyntax=COMMIT TRAN

Syntax BeginTransSyntax=value

Default value BEGIN TRAN

Syntax BeginTransSyntax=value

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




Syntax CommitTransSyntax=value

Default value ROLLBACK TRAN

Parameter Type


Default value 32000


Teradata

TeradataAsyncMode

AsyncMode=0|1






SharedShared=1|2|4




Default value



Default value


Syntax Shared=value

Default value 4








default value (1).






Parameter Type


Default value



Default value


Teradata

NOTE


SQL External File


Values• oracle — for Oracle• teradata — for Teradata• sqlsrv — for Microsoft SQL Server • db2udb — for IBM DB2


SQL Parameter File




Default value None



Default value None



Values• oracle — for Oracle• teradata — for Teradata• sqlsrv — for Microsoft SQL Server• db2udb — for IBM DB2









Default value


Teradata

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

ExampleRecommendedLenTransfert=20480









Default value







Other parameters

Other parametersSQL DDL File

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.


Syntax SQL DDL File=value

Default value



chapter

WebIntelligence Data Access Configuration File Reference



OverviewThis 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 driversThe following tables lists the parameter types:

Parameter type DescriptionBoolean Accepted values are true/false or yes/no.

The value in not case sensitive.

Numeric Accepted values are numbers.

String Accepted values are characters.

Enum Accepted values are enumerated in the guide.


Configuration

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

There are other files in this directory but they not currently modifiable. They are required for full functionality, so do not remove them.

File name Descriptioncs.cfg Stores all configuration parameters for the global

configuration of Connection Server. For more information, see Global level on page 429.

driver.cfg Stores the network layer information. This file is updated during the Business Objects installation.



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:

There are other files in these directories but they not currently modifiable. They are required for full functionality, so do not remove them.

File name Descriptiondriver.sbo Defines all databases supported and

the specific connectivity configuration for each database.

driver.prm Defines the information—parameters and functions—related to database. For more information, see the section Modifying the Parameter Files in Creating a Connection to a Database on Windows, , or .

driver.rss Stores information for Business Objects driver configuration and SQL sentences for repository management.

driver.cod Stores information related to connection definitions.Warning: Do not modify this file.


Configuration

Global levelYou 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 fileThe 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

LocalesIn this section, the charset for each language is defined.

EXAMPLELocal section<Locales>

<Locale>

<Language>en</Language>

<CharSet Platform="MSWindows">CP1252</CharSet>

<CharSet Platform="Unix">ISO-8859-1</CharSet>

</Locale>

</Locales>

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



Setting DescriptionLoad Drivers On Startup 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 Determines the extension for strategy files.The default is stg.

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


Configuration

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>

DistributionThis section is not currently used.

DriverDefaultsThis 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 Fetch Available">No</Parameter>

<Parameter Name="Array Fetch Size">10</Parameter>

<Parameter Name="Array Bind Available">No</Parameter>

<Parameter Name="Array Bind Size">5</Parameter>

</DriverDefaults>

TracesIn 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”/>



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.

EXAMPLETo 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 levelYou 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 fileThe 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 fileThis file defines the information—parameters and functions—related 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:


Configuration

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







</Configuration>

DateOperationsThis section contains date-related functions. Each parameter is enclosed in a <DateOperation> tag. The attribute Name specifies the name of the parameter.

EXAMPLE

<DateOperations>




</DateOperations>

OperatorsThis section contains the operators available in the database.



Each operator is enclosed in an <Operator> tag. The following attributes are available with an <Operator> tag:

EXAMPLE

<Operators>







</Operators>

Attribute DescriptionArity The number of arguments the operator

takes.

Type The type of operator. The following are possible values:• Numeric• Char• String• DateTime• Logical• All

ID The identifier of the operator.


Configuration

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

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.

Attribute DescriptionGroup Indicates whether the function is an aggregate





ID Displays the name of the function as it appears in BusinessObjects.



EXAMPLE


<Arguments>




</Arguments>


</Function>


Common parameters

Common parametersParameters in this section are supported by all drivers, regardless of your supported RDBMS. They are listed in alphabetical order.

Array Bind Available

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

Array Bind Size indicates the size of the array bind.

NOTEIf 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


Syntax Array Bind Available=value

Default value False


Syntax Array Bind Size=value

Default value 5



Array Fetch Available

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

Array Fetch Size indicates the size of the array fetch.

NOTEIf 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


Syntax Array Fetch Available=value

Default value False


Syntax Array Fetch Size=value

Default value 10


Common parameters

Binary Slice Size

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

CharSet indicates the name of the character set used by the middleware. The name of the CharSet is specified in your middleware standard.

ValuesValues vary with the middleware.If this parameter is not specified, retrieve the CharSet name your middleware. If you can’t retrieve this information, the current CharSet of your platform is used.

CharSet Table

CharSet Table is the name of the file which stores correspondence between middleware CharSet names and the Business Objects connection CharSet names.


Syntax Binary Slice Size=value

Default value 255


Syntax CharSet=value

Default value Middleware dependent


Syntax CharSet Table=value

Default value None



Description File

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

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 DB2Other possibilities depend on how your RDBMS accepts date formats.

Library

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


Syntax Description File=value

Default value None


Syntax Input Date Format=value

Default value None


Syntax Library=value

Default value None


Common parameters

Max Rows Available

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 doesn’t limit the number of rows retrieved

SQL External File

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



Syntax Max Rows Available=value

Default value False



Default value None



Default value None



Values• oracle -- for Oracle• access -- for Microsoft Access• sqlsrv -- for Microsoft SQL Server• db2udb -- for IBM DB2• teradata--for Teradata

Strategies File

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


Syntax Strategies File=value

Default value None


Parameters supported by all ODBC drivers

Parameters supported by all ODBC driversParameters in this section are only available in Data Configuration files for Microsoft SQL Server.

Empty String

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

Native Int64 Available indicates that the middleware natively supports the 64 bit integer.

NOTEThis 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

Parameter Type Enum

Syntax Empty String=value

Default value EmptyString


Syntax Native Int64 Available=value

Default value True



ODBC Cursors

ODBC Cursors indicates the use of the ODBC cursor library.

Values• Yes -- the ODBC cursor library is used• No -- the ODBC cursor library isn’t used

Qualifiers Available

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 doesn’t support qualifiers


Syntax ODBC Cursors=value

Default value None


Syntax Qualifiers Available=value

Default value None


Index

@Variable 60@Variable(’BOUSERPROMPT’) 41

AArray Bind Available 437Array Bind Size 437Array Fetch Available 438Array Fetch Size 438ARRAYFETCH

IBM DB2 UDB 381Informix 387Microsoft SQL Server 392Oracle 397Sybase 409Teradata 417

ArrayFetchRed Brick 405

ASYNCMODEIBM DB2 UDB 381Informix 387Microsoft SQL Server 392Oracle 397Sybase 409Teradata 417

AuditTimeStampFormatInformix 390Sybase 412

AUTOCOMMITOracle 397Sybase 409

BBACK_QUOTE_SUPPORTED

IBM DB2 244Microsoft SQL Server 267Teradata 310

BeginTranSyntaxSybase 415

Binary Slice Size 439bomain key

creating interactively 53

bomain.keyupdating 56

Business Objectsconsulting services 11, 13documentation 10Documentation Supply Store 9support services 11training services 11, 13

Business Objects loginOracle 44

BusinessObjectsconnecting with Oracle 39

CCASE_SENSITIVE

Oracle 278cfg file 26CharSet 439CharSet Table 439CHECK_OWNER_STATE

Microsoft SQL Server 267Oracle 278Red Brick 289Sybase 299

CHECK_QUALIFIER_STATEMicrosoft SQL Server 267Oracle 279Red Brick 289Sybase 299

COMBINE_WITHOUT_PARENTHESISRed Brick 289Teradata 310

Index


Index

COMMAIBM DB2 244Informix 258Microsoft SQL Server 268Oracle 279Red Brick 290Sybase 299Teradata 310

CommitTranSyntaxSybase 415

CONCATIBM DB2 245Informix 258Microsoft SQL Server 269Oracle 280Red Brick 291Sybase 301Teradata 311

connecting with WebIntelligence 26connection

define restrictive 41, 42consultants

Business Objects 11COST ESTIMATE UNIT

Teradata 421create

restrictive connection 42creating

bomain key 53CURSORHOLD 96customer support 11

Ddata access driver

defined 21database server

defined 20datatypes

Business Objects 237of Informix 121Teradata 237

DB2, overview 74define

restrictive connection 41

demomaterials 9

Description File 440Designer

connecting with Oracle 36Developer Suite 10, 12documentation

CD 9feedback on 10on the web 9printed, ordering 9roadmap 9search 9

Documentation Supply Store 9DRIVERLEVEL


DriverLevelRed Brick 405

Eeducation see trainingEXT_JOIN

IBM DB2 245Informix 259Microsoft SQL Server 269Oracle 280Red Brick 291Sybase 301Teradata 312

EXT_JOIN_INVERTIBM DB2 246Informix 259Oracle 280Sybase 301Teradata 311

EXTERN_SORT_EXCLUDE_DISTINCTOracle 281


Index

Ffeedback

on documentation 10files

cs.cfg 427driver.cfg 427informix.sql 121mainkey.param 53

FORCE_SORTED_LOVInformix 259

functionIBM DB2 reference 326Informix reference 337Oracle reference 348Red Brick reference 359SQL Server reference 342Sybase reference 366Teradata reference 372

GGROUPBY_EXCLUDE_COMPLEX

IBM DB2 246GROUPBY_WITH_ALIAS

Red Brick 291GROUPBY_WITHOUT_CONSTANT

IBM DB2 247GROUPBYCOL


IIBM DB2

connecting on UNIX 51CURSORHOLD parameter 96datatypes 97functions available 326optimizing data performance 76

IBM DB2 UDBparameter (prm) file 244

IBM DB2, overview 74Informix

connecting to a database 101datatypes 121functions available 337optimizing data performance 102overview 100

informix.prm 103INITDATEFORMAT

Oracle 399INITNUMERICSEPARATOR

Oracle 399Input Date Format 440INPUTDATEFORMAT

IBM DB2 UDB 382Informix 389Microsoft SQL Server 393Oracle 399Teradata 420

InputDateFormatSybase 412

installing 19INTERSECT


INTERSECT_IN_SUBQUERYIBM DB2 248Informix 260Microsoft SQL Server 270Oracle 282Sybase 302Teradata 313

IsBindSupportedSybase 414

IsMdwThreadSafeSybase 413

IsParseSupportedSybase 414


Index

ISTHREADSAFEIBM DB2 UDB 383Informix 390Microsoft SQL Server 393Oracle 400Sybase 413Teradata 421

KKEY_INFO_SUPPORTED


Knowledge Base 12

LLEFT_OUTER

Microsoft SQL Server 271Oracle 283Red Brick 293Sybase 303

Library 440LNG_SQL_HELP

Informix 261LOCK MODE

Oracle 400LongVarcharNotSupported

Red Brick 407

MMax Rows Available 441Microsoft SQL Server

datatypes 143overview 124, 218stored procedures 141

middleware 19

MINUSIBM DB2 249Informix 261Microsoft SQL Server 271Oracle 283Red Brick 293Sybase 304Teradata 314

MINUS_IN_SUBQUERYIBM DB2 249Informix 261Microsoft SQL Server 271Oracle 283Sybase 303Teradata 313

multimediaquick tours 10

OODBC

defined 21OLAP_CLAUSE

Red Brick 293Teradata 314

Online Customer Support 11Oracle

configuring the Advanced tab 45configuring the Custom tab 47connecting on UNIX 51connecting to a database 147connecting with BusinessObjects 39connecting with Designer 36connecting with Supervisor 32datatypes 172defining the login parameter 44functions available 348optimizing data performance 148overview 30, 146stored procedures 169

oracle.prm 149OUTERJOINS_COMPLEX

Informix 262


Index

OUTERJOINS_GENERATIONIBM DB2 250Informix 262Microsoft SQL Server 272Oracle 284Red Brick 294Sybase 304Teradata 314

OVER_CLAUSEIBM DB2 251

OWNERIBM DB2 251Informix 263Microsoft SQL Server 272Oracle 284Red Brick 294Sybase 305Teradata 315

PPassword_Encryption

Sybase 413POOL TIME

IBM DB2 UDB 383Informix 388Microsoft SQL Server 394Oracle 401

Pool TimeRed Brick 405

POOLTIMESybase 410Teradata 418

PREFIX_SYS_TABLERed Brick 294

QQUALIFIER

IBM DB2 251Microsoft SQL Server 273, 305Red Brick 295Sybase 305Teradata 315

QUOTE_OWNERInformix 264

RRDBMS

defined 19RDBMS performance 96RECOMMENDEDLENTRANSFERT

IBM DB2 UDB 384Informix 391Oracle 401Sybase 416Teradata 421

RecommendedLenTransfertRed Brick 407

Red Brickconnecting to a database 175datatypes 191functions available 359optimizing data performance 176overview 174prm 176

REFRESH_COLUMNS_TYPEMicrosoft SQL Server 273Red Brick 295Sybase 305

REMOVEPVIBM DB2 UDB 384Oracle 402

restrictivecreate 42

restrictive connectionadvanced parameters 42define 41

REVERSE_TABLE_WEIGHTOracle 284

RIGHT_OUTERMicrosoft SQL Server 273Red Brick 296Sybase 306

RISQL_FUNCTIONSIBM DB2 UDB 252Red Brick 296Teradata 316

RollbackTranSyntaxSybase 415

RUNINITOracle 402


Index

Ssearch

documentation 9SHARED


SORT_BY_NOIBM DB2 252Informix 264Microsoft SQL Server 274, 306Oracle 285Red Brick 296Teradata 316

SQL DDL FILE 423SQL EXTERNAL FILE

IBM DB2 UDB 385Informix 389Microsoft SQL Server 395Oracle 403Sybase 411Teradata 419WebIntelligence 441

SQL External FileRed Brick 406

SQL PARAMETER FILEIBM DB2 UDB 386Informix 389Microsoft SQL Server 395Oracle 404Sybase 412Teradata 419WebIntelligence 441

SQL Parameter FileRed Brick 407

SQL Serverfunctions available 342

STGIBM DB2 253Informix 265Microsoft SQL Server 274Oracle 285Red Brick 297Sybase 307Teradata 316

stored proceduresMicrosoft SQL Server 141Oracle 169

STRING_FORMAT_IN_SUBQUERYIBM DB2 253

Supervisorconnecting with Oracle 32

supportcustomer 11

Sybaseconnecting to a database 195datatypes 215functions available 366optimizing data performance 196overview 194

sybase.prm 197

TTABLE_DELIMITER

IBM DB2 254Microsoft SQL Server 274Oracle 285Teradata 316

Teradataconnecting on UNIX 51connecting to a database 219datatypes 237functions available 372optimizing data performance 220

teradata.prm 221Tips & Tricks 10training

on Business Objects products 11TXNISOLATION

Microsoft SQL Server 396


Index

UUDB, overview 74UNION


UNION_IN_SUBQUERYIBM DB2 255Informix 265Microsoft SQL Server 275Oracle 286Sybase 307Teradata 317

USER_INPUT_DATE_FORMATIBM DB2 256Informix 266Microsoft SQL Server 275Oracle 287, 308Red Brick 297Teradata 318

USER_INPUT_NUMERIC_SEPARATORIBM DB2 257Informix 266Microsoft SQL Server 276, 308Oracle 287Red Brick 298Teradata 318

Vvariables

@Variable 60DBDATABASE 60DBPASSWORD 60DBUSER 60

Wweb

customer support 11getting documentation via 9useful addresses 12

WebIntelligence parametersArray Bind Available 437Array Bind Size 437Array Fetch Available 438Array Fetch Size 438Binary Slice Size 439CharSet 439CharSet Table 439Description File 440Empty String 443Input Date Format 440Library 440Max Rows Available 441Native Int64 Available 443ODBC Cursors 444Qualifiers Available 444SQL External File 441SQL Parameter File 441Strategies File 442

Windowsconnecting to Oracle 31

wmainkey 51command line 55parameter file 54parameters for UNIX 52


Index

Date post:	25-Apr-2015
Category:	Documents
Upload:	bhaskar-thammisetty
View:	571 times
Download:	2 times

Deployment Data Access

Documents