Data Access Guide

BusinessObjects XI Release 2 Update, March 2006 Windows and UNIX

Patents

Business Objects owns the following U.S. patents, which may cover products that are offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and 6,289,352. Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise are trademarks or registered trademarks of Business Objects SA or its affiliated companies in the United States and other countries. All other names mentioned herein may be trademarks of their respective owners. Copyright 2006 Business Objects. All rights reserved. Last update: March 2006

Trademarks

Copyright

Part Number

320-50-650-0

Contents
Chapter 1 Data access basics 5 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 Introducing Connection Server and data access drivers . . . . . . . . . . . . . . . 6 Connecting to your data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Data access drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 What data access files are installed? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Chapter 2 Creating connections 15

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Creating a connection with the New Connection wizard . . . . . . . . . . . . . . 16 Chapter 3 Managing data access 29

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Setting dynamic SQL parameters in a universe . . . . . . . . . . . . . . . . . . . . . 30 Optimizing data access by editing data access parameter files . . . . . . . . . 32 Chapter 4 Data type conversion reference 37

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 IBM DB2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Informix . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Microsoft SQL Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Oracle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Red Brick . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41 Sybase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Teradata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43 Chapter 5 Setting universe dynamic SQL parameters 45

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Dynamic SQL parameters in a universe . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Data Access Guide

Contents

Chapter 6

Setting data access SQL parameters (PRM)

59

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Data access driver SQL parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 PRM file Configuration reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64 Chapter 7 Setting data access driver configuration parameters (SBO) 85

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Data access driver configuration parameters . . . . . . . . . . . . . . . . . . . . . . . 86 SBO file reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89 Chapter 8 Setting data access general configuration parameters (CFG) 99

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Data access general configuration file parameters . . . . . . . . . . . . . . . . . . 100 Settings reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103 Appendix A Business Objects information resources 107

Documentation and information services . . . . . . . . . . . . . . . . . . . . . . . . . 108 Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108 Customer support, consulting and training . . . . . . . . . . . . . . . . . . . . . . . . 109 Useful addresses at a glance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110 Index 113

Data Access Guide

Data access basics

chapter

Data access basics Overview

Overview
Data access for Web Intelligence, Desktop Intelligence, and Designer is managed by Connection Server. Connection Server is the Business Objects software layer that creates and manages connections used by universes between BusinessObjects data access drivers and target RDBMS middleware. Connection Server and the required data access components are automatically installed when you install , Desktop Intelligence, or Designer. This chapter introduces Connection Server. The following topics are described:

Introducing Connection Server and data access drivers Connecting to your data Data access drivers What data access files are installed?

Note: $INSTALLDIR variable in this guide In this guide the variable $INSTALLDIR is the install root path for the data access files used by Designer and Web Intelligence. This is the Business Objects installation path with the operating system sub directory that contains the Designer executable and the data access drivers. Under Windows$INSTALLDIR = \\...\Business Objects\BusinessObjects Enterprise 11.5\win32_x86. For example C:\Program Files\Business Objects\BusinessObjects Enterprise 11.5\win32_x86.

Introducing Connection Server and data access drivers

Universes access data in relational databases by using a connection to the data source middleware. A connection is a defined set of parameters between a BusinessObjects data access driver and a target middleware. A data access driver is the software layer that maps the SQL definitions and functions defined in the middleware to equivalent structures and parameters in a universe.

Data Access Guide

Data access basics Introducing Connection Server and data access drivers

Each connection between a data access driver and a RDBMS middleware is managed and controlled by a Business Objects data access management tool called Connection Server.

What is Connection Server?

Connection Server is the BusinessObjects data access management software that is installed automatically with one or more data access drivers for your RDBMS. Connection Server is installed by default with WebIntelligence and Designer. Connection Server allows InfoView and WebIntelligence users to connect to and run queries against a relational data source, whether it is a corporate database or a repository.

How do you access Connection Server features?

Connection Server does not have a user interface. You create and administer connections from the user interface of Designer.

Creating connections
You create connections using a connection wizard available from Designer. You can administer certain connection parameters from the Connection dialog box (Tools > Connections). See the chapter Creating connections on page 15 for more information on creating connections.

Optimizing data access

You can optimize the way that data is passed through Connection Server by modifying SQL and data access parameter files. These are files in XML format that are installed with Connection Server. You can edit these files to optimize values for parameters specific to a RDBMS, or general parameters that apply to all installed data access drivers. For information on data access drivers, see the section Data access drivers on page 10. For information on editing data access parameters files to optimize data access, see the sections:

Optimizing data access by editing data access parameter files on page 32 Setting data access SQL parameters (PRM) on page 59 Setting data access driver configuration parameters (SBO) on page 85

Data Access Guide

Data access basics Connecting to your data

Setting data access general configuration parameters (CFG) on page 99.

Using connection management tools with Connection Server

Connection management utilities that allow you to check and trace connection processes are installed with Connection Server. You run these applications from a command line. Using these utilities is described in the chapter Managing data access on page 29.

Connecting to your data

A connection allows WebIntelligence users to access data in a target RDBMS.

What is a connection?
A connection is a named set of parameters that defines how Desktop Intelligence, Web Intelligence, and Designer access data in a database file. It is the link between a universe, a data access driver, your middleware, and your database. You must have a valid connection between your target universe and your database in order to access your data. A connection is made up of the following elements: Connection element Data access driver Connection and login parameters Description BusinessObjects software layer that connects a universe to your middleware. Connection parameters that allow the data access driver to connect to the target database middleware. These parameters include Connection user name, password, and data source name. Type of connection that determines who can use it. A connection can be personal, shared, or secured.

Connection type

Data Access Guide

Data access basics Connecting to your data

Pre-requisites to creating a connection?

To create a connection you must have the following:

middleware information about your database server Designer installed BusinessObjects data access driver

Connection workflow overview

The following is an overview of the process that you follow to create a connection. Creating connections is fully described in the chapter Creating connections on page 15.

Ensure that you have all the information necessary to access your database. Install middleware so that you can access your database through either your computer or a server. Install Business Objects products and the appropriate data access driver. Using the New Connection wizard accessible from Designer, you connect your middleware to your data access driver. Make any necessary modifications to optimize the connection parameters. You can customize certain parameters from the Connection Wizard. Other parameters can be customized in the SQL parameter file associated with the data access driver. This file is called the <driver>.prm file. See the chapter Setting data access SQL parameters (PRM) on page 59 for information on editing the PRM file for your data access driver. Many SQL generation parameters can also be set at the universe level from Designer. See the chapter Setting universe dynamic SQL parameters on page 45 for information.

Data Access Guide

Data access basics Data access drivers

Data access drivers

A data access driver is the BusinessObjects software layer that connects a universe to your middleware. Data access drivers are shipped with Business Objects products. There is a data access driver for each supported middleware. When you install Business Objects products, your data access key determines which data access drivers are installed. When you create a new connection, you select the appropriate data access driver for the RDBMS middleware that you use to connect to the target RDBMS. 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.

IBM DB2 Informix Microsoft SQL Server and Analysis Services Oracle Red Brick Sybase Teradata MySQL SAP Business Warehouse

What data access files are installed?

This section describes the data access files that are installed when you install Business Objects products. Data access files can be divided into two levels:

Global level. These are files that apply to all installed data access drivers. Driver level. These are data access driver specific files.

Note: Not all the files installed by Connection Server are listed. Most of the files described in this section contain parameters that can be modified to optimize or customize data access. Certain files are listed to explain their function. These and other files in these directories must not be modified. They are required for full functionality, so do not remove them.

10

Data Access Guide

Data access basics What data access files are installed?

The global and driver level files are described in their respective sections below.

Global level data access files

Global files used by all data access drivers are installed here: $INSTALLDIR\dataAccess\RDBMS\connectionServer The files listed below either have parameters that apply to all installed data access drivers, or are executable utilities that are used for all data access drivers. Installed file cs.cfg Edit this file? Yes Description Stores all configuration parameters for the global configuration of Connection Server. See Setting data access general configuration parameters (CFG) on page 99 Maps the charset for each RDBMS to the charset used by BusinessObjects. Warning: Do not modify this file. List of the charset supported by BusinessObjects. Warning: Do not modify this file. Contains the information needed by the cscheck tool to verify connection configuration. See the readme for information on using this tool. Warning: Do not modify this file. Contains locale information for each language used by the cscheck tool when verifying connection configuration. Warning: Do not modify this file.

platform.crs

No

charsets.txt

No

cscheck.xml

No

cschecklocales.xml

No

Data Access Guide

11

Data access basics What data access files are installed?

Installed file

Edit this file?

Description DTD files for the corresponding XML files in the same directory.

strategy_localization. No dtd strategy.dtd sbo.dtd dbparameters_localiz ation.dtd dbparameters.dtd cscheckresults.dtd cschecklocales.dtd cs.dtd <driver><language>. No cod

Lists options that appear in the RDBMS page of the Connection wizard. Warning: Do not modify this file.

Driver level data access files

Driver level files used by specific data access drivers are installed here: $INSTALLDIR\dataAccess\RDBMS\connectionServer\<RDBMS> There are other files in these directories but they not currently modifiable. They are required for full functionality, so do not remove them.

12

Data Access Guide

Data access basics What data access files are installed?

The files listed below have parameters that apply to installed data access drivers. Driver specific file <driver><language>.stg Can be edited? Yes Description Contains the Help text for each external strategy defined in the <driver>.stg file. This text appears when the strategy is selected in Designer. Example oracleen.stg

<driver>.stg

Yes

Contains the external oracle.stg strategies available to the data access driver. See the Designers Guide for information on using external strategies. Defines all databases oracle.sbo supported and the specific connectivity configuration for each database. See the sections: Data access driver general configuration (<driver>.SBO) on page 34 Setting data access driver configuration parameters (SBO) on page 85 oracleen.prm Contains the Help text for functions that are listed in the <driver>.prm file. This text appears when the function is selected in Designer.

<driver>.sbo

Yes

<driver><language>.prm

Yes

Data Access Guide

13

Data access basics What data access files are installed?

Driver specific file <driver>.prm

Can be edited? Yes

Description

Example

oracle.prm Defines the information parameters and functions related to database. For more information, see the sections: Optimizing data access by editing data access parameter files on page 32

<driver><language>.cod No

Setting data access SQL parameters (PRM) on page 59 oracleen.cod

Stores information related to connection definitions. Warning: Do not modify this file.

14

Data Access Guide

Creating connections

chapter

Creating connections Overview

Overview
This chapter provides information about creating connections to database middleware. It describes how you create connections using the New Connection wizard, set login parameters, and optimize certain connection settings. Connection issues that are specific to RDBMS are also covered. This chapter covers the following topics:

Creating a connection with the New Connection wizard Setting login parameters Setting advanced parameters Setting custom parameters

Creating a connection with the New Connection wizard

You create a connection using the New Connection Wizard. This is a connection wizard that is accessible from Designer. The wizard allows you to select a target database and middleware, then configure the data access driver that you use to access the middleware.

What connection parameters are set in the New Connection wizard?

You use the wizard to set the following parameters: Connection wizard stage Login parameters. See Setting login parameters on page 22 for more information. Description Identify the connection and allow you to connect to the middleware. Parameters include Type, Connection name, User name, Password, and Data source or service.

16

Data Access Guide

Creating connections Creating a connection with the New Connection wizard

Connection wizard stage

Description

Advanced parameters Allow you to manage certain connection parameters. These include connection length, See Setting advanced parameters on page 24 for array fetch and bind sizes, and login time-out. more information. Custom parameters Parameters that you can add and customize to optimize your connection. See Setting custom parameters on page 26 for more information. The procedure for starting and following the New Connection wizard appears below. The parameters that you can set on each page are fully described in their respective section.

Using the New Connection wizard

You create a connection using the New Connection wizard.

Accessing the New Connection wizard

You access the New Connection in Designer as follows: From the Universe parameters dialog box 1. 2. 1. 2. Select File > Parameters Click the New button. Select Tools > Connections. Click Add

From the Connections list

The Welcome page of the New Connection wizard appears.

Creating a connection with the New Connection wizard

To create a connection with the New Connection wizard: 1. 2. Start the New Connection wizard. The wizard welcome page appears. Click Next. The Database middleware selection page appears. It lists the database and middleware that correspond to your data access licence key. 3. Do the following from the Database middleware selection page:

Expand a database node.

Data Access Guide

17

Creating connections Creating a connection with the New Connection wizard

The middleware available for the database appear under the node.

Expand a middleware node. Click the data access driver name.

The data access driver for the middleware appears under the node. The data access driver for Oracle 9 is shown below.

Click Next.

The Login parameters page appears. It lists login and connection identifying parameters for the data access driver. Login parameters are fully described in the section Setting login parameters on page 22. 4. Do the following from the Login parameters page:

Or

Select a connection type. Type connection name, user name, and database password. Select a data source from the Data source or Service drop down list box

Type the name for the database or data source that you want to access.

18

Data Access Guide

Creating connections Creating a connection with the New Connection wizard

A Login Parameters page with parameters completed appears below.

Click Next.

Note: If you want users to access the database with their CMS (repository) login, select the Use Single Sign-On when viewing reports check box. To use this feature, the CMS login must be the same as the login to the database. The Perform a test page appears. It summarizes the connection information and allows you to test the connection. 5. Click the Test Connection button. If the connection is valid then Server is responding appears under the Test Data Source button. If the connection is not valid then Server is not responding appears under the Test Data Source button. Information describing the failed connection appears in the zone to the left of the Test Data Source button.

Click Next.

Data Access Guide

19

Creating connections Creating a connection with the New Connection wizard

The Advanced Parameters page appears. It lists certain connection parameters that you can set to optimize your connection. Advanced parameters are fully described in the section Setting advanced parameters on page 24.

6.

Select values for advanced connection parameters then click Next. Or Click Next directly if you dont want to set advanced parameters.

20

Data Access Guide

Creating connections Creating a connection with the New Connection wizard

The Custom Parameters page appears. It allows you to manually set certain parameters. Custom parameters are fully described in the section Setting custom parameters on page 26.

7.

If you do not want to modify a listed parameter, click Finish. Or If you want to modify a default parameter value do the following:

Select a parameter in the list. Type a value in the text box under the parameter list and click Set. If you want to remove the value, click Remove.

Data Access Guide

21

Creating connections Creating a connection with the New Connection wizard

Click Finish. The Connections list appears. The new connection is now included in the list.

8.

Click Finish to close the Connections list. The connection is now available to the universe.

Setting login parameters

The Login Parameters page of the New Connection wizard contains the following parameters: Parameter Type Description Connection type. You can create one of three connection types: Personal

Shared Secured

See the section Connection type on page 23 for more information on the types of connections that you can create. Name User name Identifying name for the connection. Your database user name. This is normally assigned to you by the database administrator.

22

Data Access Guide

Creating connections Creating a connection with the New Connection wizard

Parameter Use Single Sign-On when refreshing reports at view time

Description When selected, the user name and password used to access the CMS are automatically used as database login parameters. See the BusinessObjects Enterprise Administrators Guide for information on setting up Single Sign-On. When selected the user is forced to enter a database user password associated with their BusinessObjects account to refresh a report. This is set using the parameters dbuser and dbpass. These are set at the administrative level. Refer to BusinessObjects Enterprise Administrators Guide for information on setting up this option. Your database password. This is normally assigned to you by the database administrator. Data source or database name. If you are using an ODBC driver the data source name identifies the target database. If you are using a native driver, the database name identifies the target database.

Use database credentials associated with BusinessObjects user account

Password Data source or Service

Connection type
The type of connection determines who can use the connection to access data. Designer automatically stores all the connections that you create during a work session. The next time you launch a session, these connections will be available to you. You can create three types of connections with Designer:

Personal Shared Secured

Each connection type is described as follows: Personal connections Restricts access to data to the universe creator and the computer on which it was created. Connection parameters are stored in the PDAC.LSI file located in the LSI folder in the Business Objects 11.5 folder in you user profile directory, for example: C:\Documents and Settings\<user name>\Application Data\Business Objects\Business Objects 11.5\lsi These parameters are static and cannot be updated.

Data Access Guide

23

Creating connections Creating a connection with the New Connection wizard

Personal connections are unsecured in terms of Business Objects products security. You do not use personal connections to distribute universes. You could use personal connections to access personal data on a local machine. Shared connections Allows access to data for all users. These connections are unsecured in terms of Business Objects products security. Connection parameters are stored in the SDAC.LSI file located in the LSI folder in the Business Objects 11.5 folder in you user profile directory, for example: C:\Documents and Settings\<user name>\Application Data\Business Objects\Business Objects 11.5\lsi Secured connections

Centralizes and controls access to data. It is the safest type of connection, and should used be to protect access to sensitive data. You can create secured connections with Designer. You must use secured connections if you want to distribute universes through the CMS. Secured connections can be used and updated at any time.

Setting advanced parameters

The Advanced page contains parameters used to over ride the following common configuration options:

Defining the duration of a connection into a pool Defining how Business Objects products respond when database resources are not available Defining the size of the array fetch

24

Data Access Guide

Creating connections Creating a connection with the New Connection wizard

You can set the following advanced parameters: Parameter Disconnect after each transaction Description Click if you want your connection to disconnect immediately after the transaction is completed. Users will have to reconnect each time they want to access data. Click if you want 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. 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. 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.

Keep the connection active for x minutes

Keep the connection active during the whole session (local mode only) Array fetch size

Data Access Guide

25

Creating connections Creating a connection with the New Connection wizard

Parameter Array bind size

Description Enter the size of the bind array that Connection Server uses before sending to the repository. The bind array is the area in memory that Connection Server stores a batch of data to be loaded (sent to the repository). When the bind array fills, it is transmitted to the database. Generally, the larger the bind array, the more rows (n) can be loaded in one operation, and the better your performance. Specifies the number of seconds that must be spent to establish a connection before an error message is displayed.

Login timeout

Setting custom parameters

Values on the Custom page should only be modified by an advanced user, DBA, or BusinessObjects administrator. It contains certain parameters that can be used to override connection settings. The following parameters are available

Binary Slice Size. This appears by default in the Advanced page for all data access drivers. This parameter specifies the size of the slice used to store the binary content of all documents sent to the repository. It is described in the section Binary Slice Size on page 91. Hint (Oracle only). This parameter is described below.

Using Hints (Oracle only)

A Hint is commented information that is embedded in a query, and used by the Oracle optimizer to choose an execution plan. You should consult your Oracle documentation for full information on the Hints that can be used, and how they can be used to optimize queries. You enter the value for a Hint as a comment. A plus sign is used at the beginning, immediately after the comment delimiter, with no space between the comment delimiter and the plus sign: /*+ <hint> */

26

Data Access Guide

Creating connections Creating a connection with the New Connection wizard

Some useful Hints that you can use are as follows. Consult your Oracle documentation for a full list: Hint FIRST_ROWS RULE FULL ROWID INDEX_FFS What it does... Optimizes response time. Use rule-based optimization and not cost. Does a full table scan on the table. Scans table by rowid. Perform a fast full scan on the index rather than on the table.

Example: FIRST_ROWS On the Custom page, click Hints and type /* FIRST_ROWS */ in the values box under the parameter list, and click on Set. The SQL is:
SELECT /* FIRST_ROWS */ RESERVATIONS.CUST_ID FROM RESERVATIONS

Data Access Guide

27

Creating connections Creating a connection with the New Connection wizard

28

Data Access Guide

Managing data access

chapter

Managing data access Overview

Overview
This chapter describes how you can use parameter files to optimize your data access driver. The following areas are described:

Setting dynamic SQL parameters in a universe Optimizing data access by editing data access parameter files

Note: Other tools in the readme: You can use command line utilities to check your RDBMS and data access driver configuration, and to create log files that trace Web Intelligence server activity. Refer to the readme for this release for instructions on the use of these utilities.

Setting dynamic SQL parameters in a universe

In Designer, you can dynamically configure certain SQL parameters that are common to most RDBMS to optimize the SQL generated in BusinessObjects and WebIntelligence products using the universe.

Using parameter (PRM) files in previous versions of Designer

In previous versions of Designer, the SQL generation parameters used by a universe were maintained and edited in a separate file called a parameters (PRM) file. The values set in the PRM file applied to all universes using the associated data access driver defined for a connection. Many of the SQL parameters that are used to optimize query generation are now controlled within an individual universe file. The PRM file is now no longer used for the query generation parameters that you can set in Designer. PRM files are still used for parameters that are database specific. Note: See the chapter Setting universe dynamic SQL parameters for a complete reference on the universe SQL parameters available in Designer.

Setting the SQL parameters dynamically in Designer

Many of the parameters common to most supported RDBMS middleware are available for editing in the Parameters tab in the universe parameters dialog box (File > Parameters > Parameter). These parameters apply only to the active universe, and are saved in the UNV file. When you modify an SQL parameter for a universe in Designer, the value defined in Designer is used, and not the value defined in the PRM file associated with the data access driver for the connection.

30

Data Access Guide

Managing data access Setting dynamic SQL parameters in a universe

Editing SQL generation parameters

You can modify the values for SQL parameters that determine SQL generation in products using the universe. See the chapter Setting universe dynamic SQL parameters for a complete reference on the universe SQL parameters available in Designer. To edit SQL generation parameters: 1. 2. Select File > Parameters. The Parameters dialog box appears. Click the Parameter tab. The Parameter page appears.

Data Access Guide

31

Managing data access Optimizing data access by editing data access parameter files

3.

Edit, add, or remove parameters as follows: Then do the following 1. 2. 3. 4. Click any parameter in the list. Type a name in the Name box Type a value in the Value box. Click Add.

To... Add a new parameter

Change name or value

The new value appears at the bottom of the list 1. Click a parameter in the list. 2. 3. 4. Type a new name in the Name box Type a new value in the Value box. Click Replace.

Delete a parameter

The value is replaced by the new definition. 1. Click the parameter that you want to remove from the list. 2. Click Delete.

4.

Click OK.

Note: The SQL generation parameter values that you set in a universe, are only available to products using that universe.

Optimizing data access by editing data access parameter files

Certain data access parameters can be modified to optimize BusinessObjects and WebIntelligence access to data for all installed data access drivers, a specific data access driver, or the SQL generation parameters for a specific data access driver. Data access parameters are listed in three XML files:

General configuration for all data access drivers (CS.CFG) Data access driver general configuration (<driver>.SBO) Data access driver SQL parameters (<driver>.PRM)

These files are all in XML format. You should use an XML editor, for example XML Spy to edit these files.

32

Data Access Guide

Managing data access Optimizing data access by editing data access parameter files

Each of these files is described briefly below. Full descriptions and editing procedures are described in the reference chapter for each file at the end of the book. Note: Certain SQL generation parameters that were set in the PRM file in previous versions of BusinessObjects products, are now available at the universe level. These parameters are edited in a universe and are available to all reporting products using the universe. See the section Setting dynamic SQL parameters in a universe on page 30 for more information.

How are the data access files used by a connection?

Connection Server uses the CFG, SBO, and PRM data access files to manage the parameters of a connection between a data access driver and the target middleware. The default parameters used by a connection are defined in these three files. Some of these parameters can be modified in the CFG file to apply to all data access drivers, or set at the driver level (SBO) to over-ride the general default value. Parameters in the PRM file can be modified to optimize the SQL generation for products using the connection. Connection Server refers to the data access files for the following purposes:

CS.CFG: Default connection and driver settings that apply to all data access drivers. SBO: Default connection and driver settings that are driver specific. these default values apply only to the target data access driver. PRM: SQL operators and functions that are available to the target data access driver. The values set for these SQL operators and functions can be modified to optimize the SQL generated in Business Objects products.

Each of these files is discussed briefly below. A list of all parameters available in each file, and the methods for viewing and editing the files are available in the reference chapters that correspond to each file at the back of this manual.

General configuration for all data access drivers (CS.CFG)

The general configuration for all data access drivers (CS.CFG) file contains parameters for the following uses:

Char set for each locale List of all files used by data access drivers to create and configure connections Driver defaults that apply to all drivers, for example array fetch size and array bind size. Activating traces for connection activity.

Data Access Guide

33

Managing data access Optimizing data access by editing data access parameter files

Values set in the CS.CFG file apply to all data access drivers listed in the DRIVER DEFAULTS section of the file. The CS.CFG file is found here: $INSTALLDIR\dataAccess\RDBMS\connectionServer\ The file uses the cs.dtd in the same directory. A description of each parameter in the CS.CFG file, and the procedure for editing the file are documented in the chapter Setting data access general configuration parameters (CFG) on page 99.

Data access driver general configuration (<driver>.SBO)

The data access driver general configuration (.SBO) file contains parameters for the following uses:

List of files used by a specific data access driver to manage connections Driver defaults that apply to a specific data access driver. List of database aliases used for connections defined with older database engines.

Values set in the <driver>.sbo file apply to the specific <driver> data access driver. The <driver>.sbo file is found here: $INSTALLDIR \dataAccess\RDBMS\connectionServer\<RDBMS>\ The file uses the sbo.dtdin the directory $INSTALLDIR \dataAccess\RDBMS\connectionServer. A description of each parameter in a SBO file, and the procedure for editing the file are documented in the chapter Setting data access driver configuration parameters (SBO) on page 85.

Data access driver SQL parameters (<driver>.PRM)

The data access driver SQL parameters (.PRM) file contains parameters that have default values set for SQL generation parameters that apply to a specific data access driver. The data access SQL parameter (.PRM) file contains parameters for the following uses:

Configuration parameters that specify how certain database operations are handled by the data access driver.

34

Data Access Guide

Managing data access Optimizing data access by editing data access parameter files

Date operators. A list of the SQl operators supported by the data access driver. A list of the database functions supported by the data access driver. These functions are available in the Functions pane in the Edit Select or Where statement dialog box for an object in Designer. You can add functions to this list in the PRM file, if the target RDBMS supports the function and it is not available by default in the PRM file.

A description of each parameter in a PRM file, and the procedure for editing the file are documented in the chapter Setting data access SQL parameters (PRM) on page 59. Any modification to this file applies only to the specified data access driver. The <driver>.prm file is found here: $INSTALLDIR \dataAccess\RDBMS\connectionServer\<RDBMS>\ The file uses the dbparameter.dtd in the directory $INSTALLDIR \dataAccess\RDBMS\connectionServer. Certain SQL parameters can be set from only the universe itself. These dynamic SQl parameters can be edited from Designer (File > Parameters > Parameter). The SQL generation parameters that can be set for a universe are described in the section Setting dynamic SQL parameters in a universe on page 30.

Data Access Guide

35

Managing data access Optimizing data access by editing data access parameter files

36

Data Access Guide

Data type conversion reference

chapter

Data type conversion reference Overview

Overview
This chapter contains data conversion tables for each supported RDBMS. Business Objects supports four datatypes: date character number long text

Data conversion tables are available for the following RDBMS: IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata Note: Data conversion tables for other supported RDBMS will be available in future updates of the Data Access guide. The Data Access guide and other Business Objects documentation is available from the product documentation page of the Business Objects Customer Support site: http://support.businessobjects.com/documentation

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

CLOB CHARACTER DATE DECIMAL DOUBLE FLOAT INTEGER LONG VARCHAR NUMERIC

LONG TEXT CHARACTER DATE NUMBER NUMBER NUMBER NUMBER LONG TEXT NUMBER

38

Data Access Guide

Data type conversion reference Informix

IBM/DB2 datatype

BusinessObjects datatype

SMALLINT TIME TIMESTAMP VARCHAR

NUMBER DATE DATE CHARACTER

Informix
The following table lists the Informix internal datatypes and the equivalent in Business Objects products:
Informix datatype BusinessObjects datatype

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

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

Microsoft SQL Server

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

BIT BOOLEAN

NUMBER NUMBER

Data Access Guide

39

Data type conversion reference Oracle

Microsoft SQL Server datatype BusinessObjects datatype

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

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

Oracle
The following table lists the Oracle internal datatypes and their equivalent in Business Objects products:
Oracle datatype BusinessObjects datatype

CHAR CLOB DATE FLOAT INTEGER LONG NUMBER VARCHAR VARCHAR2

CHARACTER LONG TEXT DATE NUMBER NUMBER LONG TEXT NUMBER CHARACTER CHARACTER

* indicates Oracle 9i datatype

40

Data Access Guide

Data type conversion reference Red Brick

Red Brick
The following table lists the Red Brick internal datatypes and their BusinessObjects equivalent Red Brick datatype CHAR DATE DECIMAL FLOAT INTEGER NUMERIC SMALLINT TIME TIMESTAMP BusinessObjects datatype CHARACTER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE DATE

TIME and TIMESTAMP support in a WHERE clause

Objects that use the TIME and TIMESTAMP datatype are not supported in a WHERE clause for queries run against a Red Brick database. You can set the properties of an object in a universe to support the use of TIME and TIMESTAMP in the WHERE clause as follows: To support TIME or TIMESTAMP datatype object in WHERE clause: 1. 2. 3. 4. 5. From Designer, double-click an object in the Universe pane. The Edit Properties of Object dialog box appears. Click the Definition tab. Select Date from the Type drop down list. Click the Advanced tab. In the Database Format textbox type the following Type HH:MM:SS MM/DD/YYYY HH:MM:SS

For... TIME support TIMESTAMP support 6. Click OK.

Data Access Guide

41

Data type conversion reference Sybase

Sybase
The following table lists the Sybase internal datatypes and their equivalent in Business Objects products
Sybase datatype BusinessObjects datatype

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

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

42

Data Access Guide

Data type conversion reference Teradata

Teradata
The following table lists the Teradata internal datatypes and their equivalent in Business Objects products: Teradata datatype DATE DECIMAL FLOAT INTEGER SMALLINT BYTEINT DATETIME VARCHAR BusinessObjects datatype DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE CHARACTER

Data Access Guide

43

Data type conversion reference Teradata

44

Data Access Guide

Setting universe dynamic SQL parameters

chapter

Setting universe dynamic SQL parameters Overview

Overview
This chapter provides an alphabetical reference for the SQL generation parameters listed in the Parameter page of the Universe Parameters dialog box in Designer. These are SQL parameters that are common to most data access drivers. Each parameter is valid for the universe in which it is set. Other RDBMS specific and connection parameters are listed in the data access parameter (PRM) file for the target data access driver. Refer to the section Setting dynamic SQL parameters in a universe on page 30 for information on how to set the dynamic SQL parameters in Designer. Other RDBMS specific SQL parameters are described in the chapter Setting universe dynamic SQL parameters on page 45.

Dynamic SQL parameters in a universe

Parameters used for SQL generation can be set for a universe. In previous versions of Business Objects products, all SQL parameters were set in the <RDBMS>.PRM file. This file was a static text file that applied to all universes using the data access driver. The PRM file is still used for many RDBMS specific SQL and connection parameters, however, SQL parameters common across RDBMS are now modified within an individual universe. These parameters apply only to the current universe, so universes using the same data access driver, can have different SQL generation behavior. These dynamic SQL parameters are saved in the .UNV file, and are accessible only from the universe. This section lists and describes the dynamic SQL generation parameters available to universes. Refer to the section Setting dynamic SQL parameters in a universe in the Managing Connections chapter for information on accessing and modifying these parameters. This parameter reference is also available in the Designers Guide.

46

Data Access Guide

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

ANSI92
ANSI92 = Yes|No Values Default Description Yes|No No Specifies whether the SQL generated complies to the ANSI92 standard. Yes: Enables the SQL generation compliant to ANSI92 standard. No: SQL generation behaves according to the PRM parameter OUTER_JOIN_GENERATION.

AUTO_UPDATE_QUERY
AUTO_UPDATE_QUERY = Yes|No Values Default Description Yes|No Yes Determines what happens when an object in a query is not available to a user profile. Yes: Query is updated and the object is removed from the query. No: Object is kept in the query.

BLOB_COMPARISON
BLOB_COMPARISON = Yes|No Values Default Can be edited? Description Yes|No No No Species if a query can be generated with a DISTINCT statement when a BLOB file is used in the SELECT statement. It is related to the setting "No Duplicate Row" in the query properties. Yes: The DISTINCT statement can be used within the query. No: The DISTINCT statement cannot be used within the query even if the query setting "No Duplicate Row" is on.

Data Access Guide

47

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

BOUNDARY_WEIGHT_TABLE
BOUNDARY_WEIGHT_TABLE = Integer 32bits [0-9] Values Default Description Integer 32bits [0-9] -1 Allows you to optimize the FROM clause when tables have many rows. If the table size is greater than the entered value, the table is declared as a subquery: A simple condition is defined as not having a subquery, and not having EXCEPT or BOTH operators. Limitations Optimization is not implemented when: the operator OR is in the query condition

FROM (SELECT col1, col2,...., coln FROM Table_Name WHERE simple condition).

only one table is involved in the SQL the query contains an outer join no condition is defined on the table that is being optimized the table being optimized is a derived table.

COLUMNS_SORT
COLUMNS_SORT=Yes|No Values YES Columns are displayed in alphabetical order NO Columns are displayed in the order they were retrieved from the database No Determines the order that columns are displayed in tables in the Structure pane.

Default Description

48

Data Access Guide

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

COMBINE_WITHOUT_PARENTHESIS
COMBINE_WITHOUT_PARENTHESIS=Yes|No Values Default Description YES Removes the parentheses. NO Leaves the parentheses. No Specifies whether or not to encapsulate a query with parentheses when it contains UNION, INTERSECT or MINUS operators. Used with RedBrick.

COMBINED_WITH_SYNCHRO
COMBINED_WITH_SYNCHRO = Y|N Values Default Description Yes|No No Specifies whether to allow a query to execute that contains UNION, INTERSECTION, or EXCEPT operators, and whose objects in each subquery are incompatible. Yes: Specifies that you do allow a query to execute that contains UNION, INTERSECTION and EXCEPT operators, and whose objects in each subquery are incompatible. This type of query generates synchronization (two blocks in the report). No: Specifies that you do not allow a query to execute that contains UNION, INTERSECTION and EXCEPT operators, and whose objects in each subquery are incompatible. When the query is executed the following error message is displayed: This query is too complex. One of the subqueries contains incompatible objects. This is the default value.

Data Access Guide

49

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

CORE_ORDER_PRIORITY
CORE_ORDER_PRIORITY = Yes|No Values Default Description Yes|No Yes Specifies in which order you want classes and objects to be organized once two or more universes are linked in Designer. Yes: Specifies that classes and objects follow the order defined in the kernel universe. No: Specifies that classes and objects follow the order defined in the derived universe. This is the default value.

CORRECT_AGGREGATED_CONDITIONS_IF_DRILL
CORRECT_AGGREGATED_CONDITIONS_IF_DRILL = Yes|No Values Default Description Yes|No No Specifies whether BusinessObjects can aggregate measures in queries and conditions. Yes: BusinessObjects can aggregate measures separately in the main query and the condition, if the query is drill enabled. No: BusinessObjects cannot aggregate measures separately in the main query and the condition, if the query is drill enabled.

50

Data Access Guide

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

CUMULATIVE_OBJECT_WHERE
CUMULATIVE_OBJECT_WHERE = Y|N Values Default Description Yes|No No Specifies the order of WHERE clauses that have the AND connective. Yes: Specifies that WHERE clauses that have the AND connective are set at the end of the condition. No: Specifies that WHERE clauses follow standard SQL syntax. Example: If the condition is find all French clients different from John or American cities different from New York, the SQL is then: WHERE (customer.first_name <> John) OR (city.city <> New York) AND customer_country.country = France AND city_country.country = USA

DECIMAL_COMMA
DECIMAL_COMMA = Yes|No Values Default Description Yes|No Yes Specifies that Business Objects products insert a comma as a decimal separator when necessary. Yes: Business Objects products insert a comma as a decimal separator when necessary. No: Business Objects products do not insert a comma as a decimal separator. This is the default value.

Data Access Guide

51

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

DISTINCT_VALUES_
DISTINCT_VALUES = GROUPBY|DISTINCT Values Default Description GROUPBY|DISTINCT DISTINCT Specifies whether SQL is generated with a DISTINCT or GROUPBY clause in a list of values and query panel when the option Do not retrieve duplicate rows is active. DISTINCT: The SQL is generated with a DISTINCT clause, for example; SELECT DISTINCT cust_name FROM Customers GROUPBY: The SQL is generated with a GROUP BY clause, for example; SELECT cust_name FROM Customers GROUPBY cust_name

END_SQL
END_SQL = String Values Default Description String <empty string> The statement specified in this parameter is added at the end of each SQL statement.

52

Data Access Guide

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

EVAL_WITHOUT_PARENTHESIS
EVAL_WITHOUT_PARENTHESIS = Yes|No Values Default Description Yes|No No By default, the function @Select(Class\object) is replaced by the Select statement for the object <Class\object> enclosed within brackets. For example, when combining two @Select statements, @select( objet1) *@select(objet2). If the SQL(objet1) = A-B and SQL(objet2) =C, then the operation is ( A-B ) * ( C ). You avoid the default adding of brackets by setting EVAL_WITHOUT_PARENTHESIS = Yes. The operation is then A - B * C. Yes: Brackets are removed from the Select statement for a function @Select(Class\object) No: Brackets are added around the Select statement for the function @Select(Class\object).

FILTER_IN_FROM
FILTER_IN_FROM = Yes|No Values Default Description Yes|No No Determines if query conditions are included in the FROM Clause. This setting is only applicable if the other universe parameter setting ANSI92 is set to Yes. Yes: When editing an outer join, the default behavior property selected in the drop down list box of the Advanced Join properties dialog box in Designer, is set to "All objects in FROM". No: When editing an outer join, the default behavior property selected in the drop down list box of the Advanced Join properties dialog box in Designer is set to "No object in FROM".

Data Access Guide

53

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

FIRST_LOCAL_CLASS_PRIORITY
FIRST_LOCAL_CLASS_PRIORITY = Yes|No Values Default Description Yes|No No Only taken into account when CORE_ORDER_PRIORITY=Yes. Yes: Classes in derived universe are placed first. No: Objects and sub classes from derived universe appear after those of the core universe.

FORCE_SORTED_LOV
FORCE_SORTED_LOV = Yes|No Values Default Description Yes|No No Retrieves a list of values that is sorted. Yes: Specifies that the list of values is sorted. No: Specifies that the list of values is not sorted.

MAX_INLIST_VALUES
MAX_INLIST_VALUES = 99] Values Default Description Integer: min 0, max 256 99 Allows you to increase to 256 the number of values you may enter in a condition when you use the IN LIST operator. 99: Specifies that you may enter up to 99 values when you create a condition using the IN LIST operator. This is the default value. 256: Specifies that you may enter up to 256 values when you create a condition using the IN LIST operator. 256 is the maximum authorized value you may enter.

54

Data Access Guide

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

PATH_FINDER_OFF
Parameter is not listed by default. You must add the parameter manually to the list and set a value. See Setting dynamic SQL parameters in a universe for information on editing parameters. PATH_FINDER_OFF= Y|N Values Default Description Y|N No default. You must manually enter the parameter. Used for HPIW because the join generation is done by the database. Y: Joins are NOT generated in the query. N: Joins are generated in the query. This is the default behaviour.

REPLACE_COMMA_BY_CONCAT
REPLACE_COMMA_BY_SEPARATOR= Yes|No Values Default Description Yes|No Yes In previous versions of Designer, a comma could be used to separate multiple fields in an object Select statement. The comma was treated as a concatenation operator. For universes that already use the comma in this way you can set REPLACE_COMMA_BY_SEPARATOR to No to keep this behavior. In the current version of Designer, this parameter is set to Yes by default, so that a expressions using a comma in this way are automatically changed to use concatenation syntax. Yes: Comma is replaced by the concatenation expression when multi field object is found. No: Keep the comma as it is.

Data Access Guide

55

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

SHORTCUT_BEHAVIOR
SHORTCUT_BEHAVIOUR = Global|Successive Values Default Description Global|Successive Successive Specifies how shortcut joins are applied. This parameter was formerly listed as GLOBAL_SHORTCUTS in the PRM files. The values have been changed to Global for Yes, and Successive for No. Global: Specifies that a shortcut joins are considered one by one. A shortcut join is applied only if it really bypasses one or more tables, and if it does not remove a table from the join path used by a following shortcut join. Successive: Specifies that all shortcut joins are applied. Note: If it generates a Cartesian product, no shortcut joins are applied.

THOROUGH_PARSE
THOROUGH_PARSE = Yes|No Values Default Description Yes|No No Specifies the methodology used for default Parsing in the Query panel and individual object parsing. Yes: PREPARE, DESCRIBE, and EXECUTE statements are used to parse SQL for objects. Prepare+DescribeCol+Execute No: PREPARE and DESCRIBE statements are used to parse SQL for objects.

56

Data Access Guide

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

TRUST_CARDINALITIES
TRUST_CARDINALITIES = Yes|No Values Default Description Yes|No No Allows you to optimize the SQL in a case of inflated results. Yes: For queries that include a measure, all conditions that inflate the measure and do not appear in the Result Objects, are transformed to sub queries to ensure that tables that may return false results for the measure are not included in the query. No: No optimization is implemented.

Data Access Guide

57

Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe

UNICODE_STRINGS
UNICODE_STRINGS = Yes|No Values Default Description Yes|No No Specifies whether the current universe can manipulate Unicode strings or not. Only applies to Microsoft SQL Server and Oracle 9. If the database character set in the SBO file is set as Unicode, then it is necessary to modify the SQL generation to handle specific Unicode column types like NCHAR and NVARCHAR. Yes: Conditions based on strings are formatted in the SQL according to the value for a parameter UNICODE_PATTERN in the PRM file, for example for MS SQL Server (sqlsrv.prm): UNICODE_PATTERN=N$ The condition Customer_name='Arai ' becomes Customer_name=N'Arai'. Note: When you create a prompt with @Prompt syntax based on Unicode value, the datatype should be 'U' not 'C'. No: All conditions based on strings are formatted in the standard SQL. For example the condition Customer_name='Arai ' remains Customer_name='Arai'

58

Data Access Guide

Setting data access SQL parameters (PRM)

chapter

Setting data access SQL parameters (PRM) Overview

Overview
This chapter provides an alphabetical reference for all SQL configuration parameters listed in <driver>.prm files. There is a <driver>.prm file for each supported RDBMS. This reference describes the SQL parameters in the Configuration section. These are the parameters you use to optimize your connection. They are described here with information on how to use these parameters to optimize your data access. You can see the date operators, other operators, and functions available for your data access driver by opening the <driver>.prm file in an XML editor. Note: Certain parameters can be set in the Parameter page of the Universe Parameters dialog box in Designer (File > Parameters > Parameter). If you modify a parameter in Designer, the new value over rides any modification that you have made to the parameter value in the PRM file. The changes made in Designer apply only to the universe they are saved in, and the value in the PRM remains unchanged. See the Designers Guide for more information.

Data access driver SQL parameters

Each data access driver is associated with a SQL parameters file (<driver>.prm). A data access SQL parameters file is a XML file that contains default SQL parameters used for query generation, date and other operators, and functions. <driver>.prm files are found in the directory \\<INSTALLDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\. The following <driver>.prm files are available: Data access driver IBM DB2 PRM files db2udb.prm db2mvs.prm db2iseries.prm informix.prm sqlsrv.prm sqlsrv_as.prm mysql.prm PRM Help text files (English) db2udben.prm db2mvsen.prm db2iseriesen.prm informixen.prm sqlsrven.prm sqlsrv_asen.prm mysqlen.prm

Informix Microsoft SQL Server MySQL

60

Data Access Guide

Setting data access SQL parameters (PRM) Data access driver SQL parameters

Data access driver ODBC Oracle Red Brick Sybase

PRM files odbc.prm access.prm oracle.prm redbrick.prm asiq.prm sybase11.prm sybase.prm sap.prm teradata.prm

PRM Help text files (English) odbcen.prm accessen.prm oracleen.prm redbricken.prm asiqen.prm sybase11en.prm sybaseen.prm sapen.prm teradataen.prm

SAP Teradata

The <driver>.prm files are in XML format. You should use a XML editor to view and modify values in these files if necessary.

Parameter file structure

There is a <driver>.prm file for each supported RDBMS middleware. Each <driver>.prm file is divided into the following sections. Each section contains parameters that have default values set: File section Configuration Description SQL parameters used to create and optimize a universe, for example, COMMA, OUTERJOINS_GENERATION, REVERSE_TABLE_WEIGHT. These parameters are not directly available to any Business Objects product. They are described in this chapter. Date operators available to Designer, Desktop Intelligence, and WebIntelligence, for example YEAR, QUARTER, MONTH. Operators available to Designer, Desktop Intelligence, and WebIntelligence, for example ADD, SUBSTRACT, MULTIPLY.

DateOperations Operators

Data Access Guide

61

Setting data access SQL parameters (PRM) Data access driver SQL parameters

File section Functions

Description Functions available to Designer, Desktop Intelligence, and WebIntelligence, for example Average, Sum, Variance. Help text that appears when functions in this section are selected in Designer, Desktop Intelligence, and WebIntelligence is listed in the file <driver><language>.prm, for example, oracleen.prm. This file is found in the same directory as the <driver>.prm file. You can open it to view descriptions of all the functions available in the <driver>.prm file. Viewing and editing function Help text is described in the section Viewing and editing function help text on page 63. The Function section has the following subsections: Group:

ID: Name of the function. This is the name that appears in the function list in Designer. InMacro: Specifies if the function appears in the function list in an objects Edit Select box in Designer. When value is True, the function is listed, when value is False, the function is not listed. If you set the value to True, it will be listed the next time Designer is started. Type: Function data type. Arguments: Arguments accepted by the function. SQL: The SQL syntax for the function.

Note: Only the Configuration section is documented here. These parameters can be edited to optimize queries run against universes using the target data access driver.

Viewing and editing PRM file parameters

You can view, edit, and add parameters to a PRM file as follows: 1. Browse to the directory that stores the PRM file for your target data access driver. PRM files are stored here: <INSTALDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\<driver>. prm 2. 3. 4. 5. Open a <driver>.prm file in a XML editor. Expand sections as required. Set values by entering the value in the appropriate tag. Save and close the file.

62

Data Access Guide

Setting data access SQL parameters (PRM) Data access driver SQL parameters

Viewing and editing function help text

The Help text that appears under each function when selected in Designer is maintained in a separate XML file. In previous versions of Business Objects products this text was maintained in the same file as the PRM parameters. You can edit and add text to describe a function by editing the file <driver>.<language>.prm. There is a Help text file for each language version of Business Objects products installed. The Help text appears as shown below when a function that is stored in the PRM file is selected in Designer:

function selected

Help text appears here

When you add a function to the PRM file, you need to add the Help text for the new function to the appropriate <driver>.<language>.prm file, for example, if you add a function to the oracle.prm file, then you also add the function name and the Help text for the function to the oracleen.prm file, of you are working with the English version of Designer.

Data Access Guide

63

Setting data access SQL parameters (PRM) PRM file Configuration reference

Editing Help text for a PRM file function

You can view, edit, and add Help text for a function listed in a PRM file as follows: 1. Browse to the directory that stores the PRM language file for your target data access driver. PRM language files are stored here: $INSTALLDIR\dataAccess\RDBMS\connectionServer\<rdbms>\<driver> <language>.prm For example, oracleen.prm. 2. 3. 4. Open a <driver><language>.prm file in a XML editor. Expand the Messages section. To add Help for a new function do the following:

5.

Add a new section for a function. The easiest way to do this is to copy an existing function entry and copy it into the Function section. You then edit the new function text. Enter Help text for the function. Expand the Function section. Expand the Message section for a function. Edit Help text as required.

To view or edit existing function Help text, do the following:

6.

Save and close the file.

PRM file Configuration reference

The Configuration SQL parameters are listed alphabetically. To view functions, date operators, and other operators available, open a <driver>.prm file in a XML editor, each parameter is defined in the following tag: <Parameter Name="parameter ">value</Parameter> where parameter is the name of the parameter, and value is the value attributed to the parameter. Each parameter is shown with the following information:

Example of how the parameter appears in the XML file Description of the parameter Possible values that can be set for the parameter Default value for the parameter

64

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

Note: Certain configuration parameters must not be edited. These parameters have values set for use internally within a Business Objects product. These parameters are described in this section but contain a warning not to edit the value. You must not edit these parameters. Before editing any other PRM file parameter, you should make a backup copy of the PRM file.

BACK_QUOTE_SUPPORTED
<Parameter Name="BACK_QUOTE_SUPPORTED">Y</Parameter>

Description Values

Specifies whether or not to enclose table or column names containing spaces or special characters with backquotes. Y: Encloses table and column name with backquotes. N: Does not insert backquotes around table and column names. Y Table name=`My Table`

Default Result

CASE_SENSITIVE
<Parameter Name="CASE_SENSITIVE">N</Parameter>

Description Values Default

Specifies if the database is case sensitive. Parameter used with Oracle. Y: Specifies that the database is case sensitive. N: Specifies that the database is not case sensitive. N

CHECK_OWNER_STATE
<Parameter Name="CHECK_OWNER_STATE">N</Parameter>

Description Values

Specifies whether or not there is a check if the database supports table classification by owner name. Y: Checks if the database supports table classification by owner name. N: Does not check if the database supports table classification by owner name. Y

Default

Data Access Guide

65

Setting data access SQL parameters (PRM) PRM file Configuration reference

CHECK_QUALIFIER_STATE
<Parameter Name="CHECK_QUALIFIER_STATE">N</Parameter>

Description Values

Specifies whether or not there is a check if the database supports table classification by qualifier. Y: Checks if the database supports table classification by qualifier. N: Does not check if the database supports table classification by qualifier. Y

Default

COMMA
<Parameter Name="COMMA">||' '||</Parameter>

Description

Specifies what database concatenation operator should be used to replaces a comma for objects that have the following syntax: Tab.Col1, Tab.Col2. Parameter is used with all data access drivers. ||' '|| +' '+ ||' '|| Tab.Col1||' '||Tab.Col2

Values Default Result

CONCAT
<Parameter Name="CONCAT">||</Parameter>

Description Values Default

Specifies the concatenation operator. Parameter is used with all data access drivers. || + ||

66

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

DATABASE_DATE_FORMAT
<Parameter Name="DATABASE_DATE_FORMAT">DD-MM-YYYY HH24:MI:SS</Parameter>

Description Values Default

Specifies the default date and hour formats stored on the server. 'DD-MM-YYYY HH24:MI:SS' See values above.

DATATYPE_BLOB
Name="Datatype_Blob">LONGVARCHAR</Parameter>

Description

Do not edit this parameter. Column database datatype for Blob object. This parameter is not implemented for this release. RDBMS specific. Oracle default is LONGVARCHAR

Default

DATATYPE_DOUBLE
<Parameter Name="Datatype_Double">DATE</Parameter>

Description Default

Do not edit this parameter. Column database datatype for Date object (CREATE table command) RDBMS specific. Oracle default is DATE

DATATYPE_DTM
<Parameter Name="Datatype_Dtm">DATE</Parameter>

Description Default

Do not edit this parameter. Column database datatype for Date object (CREATE table command) RDBMS specific. Oracle default is DATE

Data Access Guide

67

Setting data access SQL parameters (PRM) PRM file Configuration reference

DATATYPE_INT
<Parameter Name="Datatype_Int">NUMBER</Parameter>

Description Default

Do not edit this parameter. Column database datatype for Numeric object (CREATE table command) RDBMS specific. Oracle default is NUMBER

DATATYPE_NULL
<Parameter Name="Datatype_Null"/>

Description Default

Do not edit this parameter. Database SQL syntax for Null values (INSERT command) RDBMS specific. Oracle default is no value.

DATATYPE_STRING
<Parameter Name="Datatype_String">VARCHAR2</Parameter>

Description Default

Do not edit this parameter. Column database datatype for Character and Long object (CREATE table command). VARCHAR2

DATE_WITHOUT_QUOTE
<Parameter Name="DATE_WITHOUT_QUOTE">Y</Parameter>

Description

Specifies support for dates without single-quotes in the SQL syntax. Parameter is used with MS Access. Y: Dates are not surrounded by single-quotes. N: Dates are surrounded by single-quotes. Y

Values Default

68

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

EXT_JOIN
<Parameter Name="EXT_JOIN">YES</Parameter>

Description Values

Specifies whether or not outer joins are supported. Parameter is used by all data access drivers. 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 dimmed. YES

Default

EXT_JOIN_INVERT
<Parameter Name="EXT_JOIN_INVERT">YES</Parameter>

Description

Specifies how to display an outer join symbol in a join expression. Parameter is used with IBM DB2, Informix, Oracle, and Teradata. 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. YES

Values

Default

EXTERN_SORT_EXCLUDE_DISTINCT
<Parameter Name="EXTERN_SORT_EXCLUDE_DISTINCT">Y</Parameter>

Description

Specifies whether or not to generate a SELECT DISTINCT when a query contains an ORDER BY. Parameter is used with Oracle. 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. Y

Values

Default

Data Access Guide

69

Setting data access SQL parameters (PRM) PRM file Configuration reference

GROUPBY_EXCLUDE_COMPLEX
Parameter Name="GROUPBY_EXCLUDE_COMPLEX">N</Parameter>

Description

Specifies whether the database allows you to enter formulas, aliases or indexes in GROUP BY clauses. Parameter is used with IBM DB2. 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 (e.g. with the substring function or the concatenation operator), your Business Objects product displays the following error message: Your database does not allow you to do aggregations with the <object name> object. N: Specifies that the database does allow you to enter formulas, aliases or indexes in GROUP BY clauses. N

Values

Default

GROUPBY_WITH_ALIAS
<Parameter Name="GROUPBY_WITH_ALIAS">Y</Parameter>

Description

Specifies whether the database can create a GROUP BY clause in the SELECT statement. Parameter is used with Red Brick. 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. Y

Values

Default

70

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

GROUPBY_WITHOUT_CONSTANT
<Parameter Name="GROUPBY_WITHOUT_CONSTANT">Y</Parameter>

Description

Specifies whether or not you authorize the addition of objects whose SQL definition is a constant in a GROUP BY clause. Parameter is used by IBM DB2 and Microsoft SQL Server 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 (i.e. without aggregate functions) in a GROUP BY clause. Y

Values

Default

GROUPBYCOL
<Parameter Name="GROUPBYCOL">NO</Parameter>

Description Values

Specifies whether a GROUP BY clause accepts integers for column names. 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. NO

Default

INTERSECT
<Parameter Name="INTERSECT">INTERSECT</Parameter>t

Description Values

Specifies if the database supports the INTERSECT set operator. INTERSECT: The database supports the INTERSECT set operator. no value: The database does not support the INTERSECT set operator. In such a case, two queries are generated. INTERSECT

Default

Data Access Guide

71

Setting data access SQL parameters (PRM) PRM file Configuration reference

KEY_INFO_SUPPORTED
<Parameter Name="KEY_INFO_SUPPORTED">Y</Parameter>

Description Values

Specifies if you can retrieve primary and secondary key definitions from the database account. 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.

Default

LEFT_OUTER
<Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="LEFT_OUTER">$*</Parameter>

Description Values

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

Default

LENMAXFORCOLUMNNAME
<Parameter Name="LenMaxForColumnName">30</Parameter>

Description

Do not edit this parameter. Maximum length for column name (by default the object name is proposed) (CREATE table command) RDBMS specific. Oracle default is 30

Default

72

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

LENMAXFORTABLENAME
<Parameter Name="LenMaxForTableName">30</Parameter>

Description Default

Do not edit this parameter. Maximum length for VARCHAR column datatype (CREATE table command). RDBMS specific. Oracle default is 254

LENMAXFORVARCHAR
<Parameter Name="LenMaxForVarchar">254</Parameter>

Description Default

Do not edit this parameter. Maximum length for VARCHAR column datatype (CREATE table command). RDBMS specific. Oracle default is 254

MINUS
<Parameter Name="MINUS">MINUS</Parameter>

Description Values

Specifies if the database supports the MINUS set operator. 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. In such a case, two queries are generated. MINUS

Default

Data Access Guide

73

Setting data access SQL parameters (PRM) PRM file Configuration reference

NO_DISTINCT
<Parameter Name="NO_DISTINCT">Y</Parameter>

Description Values

Specifies if the database supports the DISTINCT keyword. Parameter is used with MS Access. Y: Specifies that the database does not support the DISTINCT keyword. This behavior disables: The Distinct Values option that appears when you click the View Values button in the Quick Design wizard The Countdistinct function that appears when you create a condition with the Calculation operand in the Query Panel N: Specifies that the database does support the DISTINCT keyword. Y

Default

OLAP_CLAUSE
<Parameter Name="OLAP_CLAUSE">WHEN</Parameter>

Description

Specifies whether Business Objects products generate a WHEN or QUALIFY clause if a function listed in the RISQL_Functions parameter is used in a condition. This parameter must be used with the GROUPBY clause. WHEN: Generates a WHEN clause if a function listed in the RISQL_Functions parameter is used in a condition. This is the default value for Red Brick databases. QUALIFY: Generates a QUALIFY clause if a function listed in the RISQL_Functions parameter is used in a condition. This is the default value for Teradata databases. See values above.

Values

Default

74

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

OUTERJOINS_GENERATION
This parameter is only used for compatibility with previous versions of Designer. the ability to create outer joins that conform to the ANSI 92 standard can be set at the universe level by setting the universe parameter ANSI92 to Yes. See the section ANSI92 on page 47 for more information.
<Parameter Name="OUTERJOINS_GENERATION">USUAL</Parameter>

Description

Specifies the SQL syntax for outer joins. The value ANSI 92 generates an outer join in the FROM clause. Other values generate the outer join in the WHERE clause. When you modify this setting, you should check join properties to verify that the outer join expression is valid, and that the cardinalities are correct. MS SQL Server database engine, the sqlsrv.prm file uses standard outer join generation (in WHERE clause). To use ANSI 92 outer join generation with MS SQL Server, modify the sqlsrv.prm file as follows: EXT_JOIN_INVERT=YES MODIFY: LEFT_OUTER= RIGHT_OUTER= OUTERJOINS_GENERATION=ANSI_92 USUAL: Default value with Oracle, Sybase 11, and Red Brick. DB2: Default value for IBM DB2. ODBC: Default value for ODBC. FULL_ODBC: Can be used with MS SQL Server INFORMIX Default value for Informix. NO: Outer joins are not supported. ANSI_92: Generates the ANSI92 syntax. Default value for Sybase. See values above

Values

Default

Results of values applied for OUTERJOINS parameters above

Value = USUAL FROM T1, T2 WHERE T1.col1(+) = T2.col2 DB2: FROM T2 LEFT OUTER JOIN T1 ON T1.col1 = T2.col2 ODBC: FROM {oj T1 LEFT OUTER JOIN T2 ON T1.col1=T2.col2} INFORMIX: FROM T2 OUTER T1

Data Access Guide

75

Setting data access SQL parameters (PRM) PRM file Configuration reference

WHERE T1.col1=T2.col2 FULL_ODBC: FROM {oj T1 RIGHT OUTER JOIN T2 ON T2.col2=T1.col1} Value = ANSI_92: SELECT DISTINCT t1.col1, t2.col2 FROM

(t1 RIGHT OUTER JOIN t2 ON (t1.col1=t2.col2) )

OVER_CLAUSE
<Parameter Name="OVER_CLAUSE">Y</Parameter>

Description

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. Y: BusinessObjects products can include RISQL functions when generating SQL. N: BusinessObjects products cannot include RISQL functions when generating SQL. Y

Values

Default

OWNER
<Parameter Name="OWNER">Y</Parameter>

Description Values

Specifies if the database authorizes to prefix tables by the owner name. 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. Y

Default

76

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

PATH_FINDER_4x
This parameter is not in any <driver>.prm file by default. To use it, you must add it as a parameter in the Configuration section. Description Values Specifies if users can choose a context if all the proposed contexts use the same joins. Y: Specifies that users can choose a context even if all the proposed contexts use the same joins. N: Specifies that users cannot choose a context if all the proposed contexts use the same joins. No default value.

Default

PREFIX_SYS_TABLE
<Parameter Name="PREFIX_SYS_TABLE">RBW_</Parameter> <Parameter Name="PREFIX_SYS_TABLE">MSys</Parameter>

Description

Specifies if the system tables are displayed in Designer. This parameter is found in the access.prm file and redbrick.prm file. MSys: Specifies that the MS Access system tables are hidden in the Designer table browser. Default value for MS Access. RBW_ :Specifies that the Red Brick system tables are hidden in the Designer table browser. Default value for Red Brick. no value Specifies that the database system tables are displayed in the Designer table browser. See values above.

Values

Default

QUALIFIER
<Parameter Name="QUALIFIER">N</Parameter>

Description Values

Specifies whether the database authorizes to prefix tables by the qualifier name Y: Specifies that the database does support prefixing tables by the qualifier name. N: Specifies that the database does not support prefixing tables by the qualifier name. RDBMS dependant.

Default

Data Access Guide

77

Setting data access SQL parameters (PRM) PRM file Configuration reference

QUOTE_OWNER
<Parameter Name="QUOTE_OWNER">Y</Parameter>

Description Values

Specifies whether or not an owner name should be in single quotes. Used by Informix only. 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. Y SELECT Alias.col (<Alias> is a local Alias) FROM 'Owner'.table.col Alias

Default Result

REFRESH_COLUMNS_TYPE
<Parameter Name="REFRESH_COLUMNS_TYPE">O</Parameter>

Description Values

Indicates how columns are refreshed. 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. See Values above.

Default

78

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

REVERSE_TABLE_WEIGHT
<Parameter Name="REVERSE_TABLE_WEIGHT">Y</Parameter>

Description

Specifies in which order tables should be generated. This parameter is used with Oracle. This parameter can also be used with some other databases, possibly with the Y and N reversed. This parameter is not supported for Teradata. N: Specifies that tables are generated from the largest to the smallest. Y: Specifies that tables are generated from the smallest to the largest. Y

Values

Default

RIGHT_OUTER
<Parameter Name="RIGHT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">*$</Parameter>

Description Values

Specifies the right outer join syntax. $(+): Used with Oracle. $ represents a join expression. *$: Used with Sybase, MS SQL Server and Red Brick. $ represents a join expression. See values above.

Default

Data Access Guide

79

Setting data access SQL parameters (PRM) PRM file Configuration reference

RISQL_FUNCTIONS
<Parameter Name="RISQL_FUNCTIONS">RANK,SUM,AVG,COUNT,MIN,MAX</ Parameter>

Description Values

Lists the RISQL functions supported by the database. Oracle default list: RANK,SUM,AVG,COUNT,MIN,MAX,RATIO_TO_REP ORT,CUME_DIST,CORR,DENSE_RANK,FIRST_VAL UE,LAST_VALUE,LAG,LEAD,NTILE,PERCENT_RAN K,PERCENTILE_CONT,PERCENTILE_DISC,ROW_N UMBER,CORR,COVAR_POP,COVAR_SAMP,REGR_ SLOPE,REGR_INTERCEPT,REGR_COUNT,REGR_ R2,REGR_AVGX,REGR_AVGY,REGR_SXX,REGR_S YY,REGR_SXY,STDDEV,STDDEV_POP,STDDEV_S AMP,VAR_POP,VAR_SAMP,VARIANCE IBM DB2 default list: RANK,SUM,AVG,COUNT,MIN,MAX Teradata default list: CSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANT ILE Red Brick default list: CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTO REPORT,TERTILE. See values above.

Default

SHORTCUTS_4X
This parameter is not in any <driver>.prm file by default. To use it, you must enter it in the [Parameters] section under DBParameters and Configuration in the XML file. Description Values Specifies whether shortcuts are applied according to the number of paths they resolve. N: Specifies that the shortcut join that resolves the most number of paths is applied first. O: Specifies that the shortcut joins are not applied in a set order. No default value.

Default

80

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

SORT_BY_NO
<Parameter Name="SORT_BY_NO">NO</Parameter>

Description

Specifies if users are authorized to sort on columns (represented as objects in the universe) that are not included in the SELECT statement. YES: Specifies that users are not authorized to sort on columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is dimmed in the Query Panel. NO: Specifies that you are authorized to sort on columns even if they are not included in the SELECT statement. NO

Values

Default

TABLE_DELIMITER
<Parameter Name="TABLE_DELIMITER">&quot;</Parameter>

Description

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. To use this parameter, BACK_QUOTE_SUPPORTED must be set to BACK_QUOTE_SUPPORTED=Y. This is the default value. : Table or column names that contain spaces or special characters are enclosed in double quotation marks. : Table or column names that contain spaces or special characters are enclosed in single quotation marks. This value can be used only with Microsoft Access. Table name=My Table

Values

Default Result

Data Access Guide

81

Setting data access SQL parameters (PRM) PRM file Configuration reference

UNICODE_PATTERN
<Parameter Name="UNICODE_PATTERN">UNISTR($)</Parameter>

Description

SQL Server and Oracle only. Only applies when the universe SQL generation parameter UNICODE_STRINGS is set to Y. All conditions based on strings are then formatted with this string value. See the section UNICODE_STRINGS on page 58 for information on setting the UNICODE_STRINGS parameter Microsoft SQL Server: N$ Oracle: UNISTR($) UNICODE_PATTERN=N* COL1 = N'abcd'

Default Example

UNION
<Parameter Name="UNION">UNION</Parameter>

Description Values

Specifies if the database supports the UNION set operator. UNION: The database supports the UNION set operator. no value: The database does not support the UNION set operator. In such a case, two queries are generated. UNION

Default

82

Data Access Guide

Setting data access SQL parameters (PRM) PRM file Configuration reference

USER_INPUT_DATE_FORMAT
<Parameter Name="USER_INPUT_DATE_FORMAT">'dd-MM-yyyy HH:mm:ss'</Parameter>

Description Values

Specifies the default date and hour formats generated in the WHERE clause of a SQL script. {\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 Informix. 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats with MS SQL Server and for most IBM DB2 servers. 'mm/dd/yyyy hh:m:s am/pm' This is the default date and hour formats with Sybase. 'yyyy-mm-dd' This is the default date format with a Sybase gateway. Note: f you need to use time or timestamp variables with ODBC, you must replace the default date format value with: {\t 'hh:mm:ss'} or {\t\s 'yyyy-mm-dd hh:mm:ss'} in the odbc.sbo file. See values above.

Default

USER_INPUT_NUMERIC_SEPARATOR
<Parameter Name="USER_INPUT_NUMERIC_SEPARATOR">.</Parameter>

Description Values Default

Specifies the default decimal separator stored on the server. '.' '.'

Data Access Guide

83

Setting data access SQL parameters (PRM) PRM file Configuration reference

84

Data Access Guide

Setting data access driver configuration parameters (SBO)

chapter

Setting data access driver configuration parameters (SBO) Overview

Overview
This chapter provides a reference for all default configuration parameters in <driver>.sbo files for the supported RDBMS. It also describes how a data access driver configuration file is structured, and how you edit the SBO file to set new values for the driver parameters.

Data access driver configuration parameters

A data access driver configuration file (<driver>.sbo) is a file in XML format that contains default configuration parameters for a specific data access driver. There is a configuration file for each data access driver. Note: Driver defaults in SBO over-ride same driver defaults in CFG file Certain parameters that appear in the Driver Defaults section of the cs.cfg file also appear in the Driver Configuration defaults section of the SBO file. The values in the CFG file apply to all drivers loaded by Connection Server. The value set in a <driver>.sbo file over rides that set in the CFG file. This allows you to set driver defaults that apply to an individual data access driver, while leaving a default setting to apply to other drivers. A data access configuration file (SBO) contains the following:

Default parameters that apply to all connections using the data access driver. A list of database middleware that the driver supports. This list can also contain aliases for middleware versions that are no longer supported, but which are still used by connections defined with the data access driver. Each middleware entry can have default parameters set that apply only to that database middleware.

Data access configuration files (<driver>.sbo) are found in the directory \\<INSTALDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\ The following <driver>.sbo files are available Data access driver IBM DB2 Informix Microsoft SQL Server Microsoft Analysis Services SBO file db2.sbo iseries.sbo informix.sbo odbc.sbo oledb_olap.sbo

86

Data Access Guide

Setting data access driver configuration parameters (SBO) Data access driver configuration parameters

Data access driver MySQL ODBC Oracle Red Brick SAP Sybase Teradata

SBO file odbc.sbo odbc.sbo oracle.sbo odbc.sbo sap.sbo sybase.sbo teradata.sbo

Note: The <driver>.sbo files are in XML format. You should use a XML editor to view and modify values in these files if necessary.

Data Access Guide

87

Setting data access driver configuration parameters (SBO) Data access driver configuration parameters

Configuration file structure

There is a <driver>.sbo file for each supported RDBMS. Each <driver>.sbo file is divided into the following sections: File section Defaults Description Default configuration parameters that apply to all database middleware using the data access driver. These are listed in the section Database described below. Certain of these parameters can also be set for a specific middleware. In this case, the value set for the target middleware in the Databases section, over rides the default value set in the Defaults section. Database middleware supported by the data access driver. Each middleware is listed with the following parameters: Active Specifies if middleware support is activated or not. Values are YES or NO.

Databases

Name Names of the middleware supported by the data access driver. The middleware name values set here appear in the Database Middleware page of the new connection wizard. Aliases Names of older middleware versions no longer officially supported by the data access driver, but that are still used by existing connections. You can add an alias parameter for an older middleware using the current data access driver, and set configuration parameters specific to the middleware as parameters of the new alias. Connections can still be created and used using the alias specified. Parameters Configuration parameters with values that apply specifically to a middleware. Values set for parameters listed here, over ride the values set for the same parameters in the Defaults section.

88

Data Access Guide

Setting data access driver configuration parameters (SBO) SBO file reference

Viewing and editing a SBO file

You can view and edit parameters in a SBO file as follows: 1. Browse to the directory that stores the SBO file for your target data access driver. SBO files are stored here: <INSTALDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\ <driver>.sbo. 2. 3. 4. 5. Open a <driver>.sbo file in a XML editor. Expand sections as required. Set values by entering the value in the appropriate tag. Save and close the file.

SBO file reference

The SBO parameters are listed alphabetically. To view parameters available, open a <driver>.sbo file in a XML editor. In the file, each parameter is defined in the following tag: <Parameter Name="parameter ">value</Parameter> where parameter is the name of the parameter, and value is the value attributed to the parameter. Each parameter is shown with the following information:

Example of how the parameter appears in the XML file Description of the parameter Possible values that can be set for the parameter Default value for the parameter

Parameters can be set at the Defaults or Databases section

Configuration parameters can be set in the Defaults or Databases sections of the SBO file. If they are set for a specific middleware in the Databases section, then for the specific middleware, this value over rides the value set at the Defaults level. Note: Certain configuration parameters must not be edited. These parameters have values set for use internally within a Business Objects product. These parameters are described in this section but contain a warning not to edit the value. You must not edit these parameters. Before editing any other SBO file parameter, you should make a backup copy of the SBO file.

Data Access Guide

89

Setting data access driver configuration parameters (SBO) SBO file reference

Array Bind Available

<Parameter Name="Array Bind Available">True</Parameter> Description Values Default Specifies if the database supports this method True False True

Array Bind Size

<Parameter Name="Array Bind Size">5</Parameter> Description Specifies the number of rows exported with each INSERT command. Used with all Data Access drivers, default value set in cs.cfg n Specifies that n number of rows are exported with each INSERT. Value set in the cs.cfg file.

Values Default

Array Fetch Size

<Parameter Name="Array Fetch Size">10</Parameter> Description Specifies the number of rows retrieved with each fetch. Used with all data access drivers and is available in all <driver>.sbo files. n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated. Value set in the cs.cfg file.

Values

Default

Array Fetch Available

<Parameter Name="Array Fetch Available">True</Parameter> Description Values Default Specifies whether the Array Fetch is natively supported. True False Value set in the cs.cfg file.

90

Data Access Guide

Setting data access driver configuration parameters (SBO) SBO file reference

Binary Slice Size

<Parameter Name="Binary Slice Size">32000</Parameter> Description Specifies the number of bytes of the slice that stores the document in OBJ_X_DOCUMENTS. This is the only table in the document domain. It stores the binary content of all documents sent to the repository. These are stored as BLOBs (Binary Large OBjects) stored in slices. n Specifies that slice size is n bytes. Oracle, Sybase: 32000 Informix: 30000 Teradata: 20480

Values Default

CharSet Table
<Parameter Name="CharSet Table">oracle</Parameter> Description Specifies the Charset file (.CRS) for the data access driver with no extension. This setting is specific to each .sbo file. The CRS file is in the same directory as the SBO file. oracle, db2, sybase, iseries, informix, odbc, teradata. Data Access driver dependant. See the Values above.

Values Default

DescribeParam Available
<Parameter Name="DescribeParam Available">False</Parameter> Description Informix only. Specifies if the database supports the DescribeParam method for Stored Procedures. This parameter is set in the Parameter section of the Databases section of the SBO file. True False False.

Values Default

Data Access Guide

91

Setting data access driver configuration parameters (SBO) SBO file reference

Description File
Do not edit this parameter <Parameter Name="Description File">oracle</Parameter> Description Do not edit this parameter. It specifies the name of the description file (<driver><language>.cod) with no extension. This file contains the labels of the connection dialog boxes used in the new connection wizard. The COD file is in the same directory as the SBO file. oracle, db2, sybase, iseries, informix, odbc, teradata See Values above.

Values Default

DriverLevel
<Parameter Name="Driver Level">31</Parameter>l Description Values Specifies the limitations of each driver. This setting is specific to each <driver>.sbo file 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. Default values are data access driver specific.

Default

92

Data Access Guide

Setting data access driver configuration parameters (SBO) SBO file reference

Empty String
<Parameter Name="Empty String">EmptyString</Parameter> Description Specifies that certain functions, for example SQL Tables, receive an empty string or a null pointer to replace missing parameters. Used by all ODBC data access drivers. EmptyString Missing parameters are replaced by an empty string. no value Missing parameters are not replaced. EmptyString

Values

Default

Family
Do not edit this parameter <Parameter Name="Family">Sybase</Parameter> Description Specifies the family of database engine to be displayed in the Database Middleware Selection page of the new connection wizard. The middleware that correspond to your data access key are displayed on this page in a tree view. Oracle for Oracle IBM for IBM databases Informix for Informix Sybase for Sybase Generic for ODBC, ODBC3, and Red Brick ODBC NCR for Teradata Microsoft for Microsoft SQL Server and Access. Microsoft is set in the MS SQL Server section of the Databases section. See values above.

Values

Default

Data Access Guide

93

Setting data access driver configuration parameters (SBO) SBO file reference

Native Int64 Available

<Parameter Name="Native Int64 Available">False</Parameter> Description Specifies the availability of native Int64 support. Parameter is available to all ODBC3 and Red Brick data access drivers. The parameter is available for a specified data access driver in the Database section of the SBO file. False Specifies that Int64 is not supported, so Connection Server can emulate Int64 methods. True Specifies that native Int64 support is available so integers are coded in 64 bits. False

Values

Default

ODBC Cursors
<Parameter Name="ODBC Cursors">No</Parameter> Description Specifies availability of the cursor library by the data access driver. Applies to all ODBC drivers. This parameter is not listed by default in the SBO file. The default value is set in the cs.cfg file. You can add it to the SBO file. The value set in the SBO file over rides the value in the cs.cfg file. Do not change the default value in the CFG file. No Yes Set in the cs.cfg file.

Values Default

Optimize Execute
<Parameter Name="Optimize Execute">False</Parameter> Description Values Default Specifies the optimization method for executing queries. True Specifies that SQLExecDirect is performed. False SQLPrepare+SQLExecute is performed. False

94

Data Access Guide

Setting data access driver configuration parameters (SBO) SBO file reference

Password_Encryption
<Parameter Name="Password Encryption">True</Parameter> Description Specifies whether or not to use the encryption password mechanism of the middleware for the password entered in the connection dialog box. This parameter is used with Sybase. True Specifies that the encryption password mechanism of the middleware is used. False Specifies that the encryption password mechanism of the middleware is not used. True

Values

Default

Provider CLSID
Do not edit this parameter <Parameter Name="Provider CLSID">MSDASQL</Parameter> Description Values Default MSDASQL Specifies name of OLEDB provider. This parameter is used with OLEDB only.

Data Access Guide

95

Setting data access driver configuration parameters (SBO) SBO file reference

SQL Parameter File

<Parameter Name="SQL Parameter File">oracle</Parameter> Description 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). db2iseries for IBM DB2 iSeries db2udb for IBM DB2 informix for Informix sqlsrv for Microsoft SQL Server 2000 oracle for Oracle redbrick for Red Brick sybase for Sybase asiq for Sybase ASIQ teradata for Teradata See values above.

Values

Default

Strategies File
<Parameter Name="Strategies File">oracle</Parameter> Description Specifies the name with no extension of the Strategy file (.STG). This is the file that contains external strategies that are available for Designer for automatic universe creation. Strategy files are stored in the same directory as the SBO file. db2 for DB2 data access drivers. informix for Informxi oracle for Oracle sybase for Sybase teradata for Teradata See values above.

Values

Default

96

Data Access Guide

Setting data access driver configuration parameters (SBO) SBO file reference

Transaction Available
<Parameter Name="Transactional Available">Yes</Parameter> Description Specifies if operations run against the database occur within transactions. This parameter appears as a driver default in the cs.cfg file. Its value applies to all data access drivers. It is not listed by default in the SBO file. If you want to over-ride the default value you add it to the Defaults section of the SBO file for the target data access driver. You would do this if your data access driver does not support transaction mode. In this case, Business Objects tries to set off the autocommit which is not supported by certain drivers. See the note below concerning the value No for this parameter. Yes Specifies that operations against the database are run as transactions and are run as a block when committed. No Specifies that each SQL statement is immediately committed Note: When you set the value to No, ensure that you use this driver to access the data account only. Do not use this driver (with Transactional Available=No) to access the Business Objects repository. Yes. This is set in the cs.cfg file.

Values

Default

Unicode
<Parameter Name="Unicode">CharSet</Parameter> Description Specifies if the access driver can benefit from the Unicode configuration of the client middleware. This parameter appears as a driver default in the cs.cfg file. Its value applies to all data access drivers. It is not listed by default in the SBO file. If you want to over-ride the default value you add it to the Defaults section of the SBO file for the target data access driver. UTF8 CharSet UCS2 This is set in the cs.cfg file.

Values

Default

Data Access Guide

97

Setting data access driver configuration parameters (SBO) SBO file reference

V5toV6DriverName
<Parameter Name="V5toV6DriverName">{Informix 3.34 32 BIT}</ Parameter> Description Specifies the conversion rule from Informix Connect to Informix ODBC. Found in Informix.sbo. The value of this parameter determines which Informix Driver is used to define the ODBC DSN less connection string.The value of this parameter must be the exact name of the Informix driver installed on the machine. {Informix 3.34 32 BIT} This is set in the cs.cfg file.

Values Default

98

Data Access Guide

Setting data access general configuration parameters (CFG)

chapter

Setting data access general configuration parameters (CFG) Overview

Overview
This chapter provides a reference for all default parameters in the Settings section of the data access general configuration file cs.cfg. It also describes how the CFG file is structured, and how you can edit the file to set new values for the parameters listed.

Data access general configuration file parameters

A data access general configuration file (cs.cfg) is a file in XML format that contains default configuration parameters that apply to all data access drivers. Certain default parameters can be over-ridden for a specific data access driver when the same parameter is set to a different value in the data access configuring file (<driver>.sbo). The cs.cfg file is an XML file. The DTD for the file is in the same directory. Make sure that, when modifying the XML file, the cs.dtd is accessible. The CFG file is stored here: $INSTALLDIR \dataAccess\RDBMS\connectionServer

General configuration file structure

There are five sections in the cs.cfg XML file:

Locales

Locales Settings Distribution Driver defaults Traces

Each of these sections is described briefly as follows:

<Locales> <Locale> <Language>en</Language>

Defines the usual operating system charset for a given language. BusinessObjects recommends that you do not modify these values. Example:

100

Data Access Guide

Setting data access general configuration parameters (CFG) Data access general configuration file parameters

<CharSet Platform="MSWindows">CP1252</CharSet> <CharSet Platform="Unix">ISO-8859-1</CharSet> </Locale>

</Locales>

Settings
Defines parameters that apply to all data access drivers, for example the file extensions of files used by Connection Server to manage data access. Some settings can be defined either for library version or server version of Connection Server. These parameters are described in the section Settings reference on page 103.

Distribution
Parameters used when Connection Server is used in a stand alone server mode. See the following guides for information on installing and using Connection Server as a stand alone server: Deploying the Business Objects System

Installation and Configuration Guide

This section contains the following sub sections: Protocols Lookup

Protocols Contains the default values that Connection Server uses to process requests coming from CORBA clients or HTTP clients, for example; <Protocol Name="HTTP" Active="No"/> Lookup Allows you to expose the target RDBMS that corresponds to a specific ODBC network layer to Connection Server. This applies when Connection Server is using two different data access drivers, for example Microsoft SQL Server and Microsoft Access, through a common ODBC network layer. By default, Lookup is set to No, so Connection Server associates a target RDBMS to its ODBC network layer. However, if Connection Server is being used as a standalone server, and has two databases that are accessed by the same ODBC network layer, the specific target database information must be exposed to Connection Server to allow queries to be routed through ODBC to the correct data account.

Data Access Guide

101

Setting data access general configuration parameters (CFG) Data access general configuration file parameters

You expose the database information to Connection Server by setting the Lookup parameter to Yes. This ensures that the target database information for queries using ODBC are routed to the correct server, for example ODBC_SQLSERVER and ODBC_ACCESS. You only set Lookup to Yes when Connection Server is being used as a stand alone server, dedicated to connection activity only. Example: Lookup set to Yes to expose two RDBMS using the same ODBC network layer
<LookUp Active="Yes"> <NetworkLayer Name="ODBC"> <Property Name="ODBC_SQLServer"> <DataBase Pattern="^MS SQL Server.*$"/> </Property> <Property Name="ODBC_Access"> <DataBase Pattern="^MS Access.*$"/> </Property>

Driver defaults
Data access driver parameters that are also found in driver specific SBO files. The values set for these parameters apply to all data access drivers, but these can be set in a <driver>.sbo file to over-ride the default value. See the chapter Setting data access driver configuration parameters (SBO) on page 85 for information in the parameters listed here.

Traces
You can set trace parameters that allow the recording of connection activity through Connection Server in log files. Refer to the release notes for information on generating traces.

Viewing and editing a cs.cfg file

You can view and edit parameters in a CFG file as follows: 1. 2. 3. 4. 5. Browse to the directory that stores the cs.cfg file: $INSTALLDIR\dataAccess\RDBMS\connectionServer\cs.cfg Open the cs.cfg file in a XML editor. Expand sections as required. Set values by entering the value in the appropriate tag. Save and close the file.

102

Data Access Guide

Setting data access general configuration parameters (CFG) Settings reference

Settings reference
The CFG setting parameters are listed alphabetically. To view parameters available, open the CFG file in a XML editor, and go to the Settings section, then Parameters section. In the file, each parameter is defined in the following tag: <Parameter Name="parameter ">value</Parameter> where parameter is the name of the parameter, and value is the value attributed to the parameter. Each parameter is shown with the following information:

Example of how the parameter appears in the XML file. When the parameter is available in library and server mode, an example of each is shown. Description of the parameter Possible values that can be set for the parameter (where applicable) Default value for the parameter

Parameters can be set at the library or server level

CFG settings parameters can be set at the following data access levels: Setting set at this level library Description Parameters apply to a standard Connection Server installation. It is installed with other BusinessObjects desktop or server software. This is the default mode when you install a BusinessObjects product that is installed automatically with Connection Server. Parameters apply to a Connection Server stand alone server installation. It is installed alone with no other BusinessObjects desktop or server product. You select this mode in the choice of custom installation options when you install BusinessObjects 6.5. You set parameters in this mode when you are using a node for connection management only.

server

Data Access Guide

103

Setting data access general configuration parameters (CFG) Settings reference

Load Drivers On Startup

Load Drivers On startup is available in library and server mode. Library
<Settings> <Parameter Name="Load Drivers On Startup">No</Parameter> ... <Library/>

Server
<Server> <Parameter Name="Load Drivers On Startup">Yes</Parameter> ... </Server>

Both are described below. Description Determines loading of driver libraries. You can set values for Load Drivers On Startup for two types of Connection Server deployments: Library: Value applies to nodes that have Connection Server installed with desktop or other server products. Server: Value applies to Connection Server stand alone server installations. For information on deploying Connection Server on a dedicated node see the Deployment guide. Yes All installed drivers are loaded during the initialization phase. No Drivers are loaded on demand. Library mode: No Server mode: Yes

Values

Default

Enable Failed Load

<Parameter Name="Enable Failed Load">Yes</Parameter>

Description Values Default

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

104

Data Access Guide

Setting data access general configuration parameters (CFG) Settings reference

Config File Extension

<Parameter Name="Config File Extension">sbo</Parameter>

Description Default

Determines the file extension for general configuration files. sbo

SQL Parameter Extension

<Parameter Name="SQL Parameter Extension">prm</Parameter>

Description Default

Determines the file extension for SQL parameter files. prm

SQL External Extension

<Parameter Name="SQL External Extension">rss</Parameter>

Description Default

Determines the file extension for external SQL files. rss

Strategies Extension
<Parameter Name="Strategies Extension">stg</Parameter>

Description Default

Determines the extension for strategy files. stg

Description Extension
<Parameter Name="Description Extension">cod</Parameter>

Description Values Default

Determines the extension for the connection description files. Do not change the default value for this parameter. cod

Data Access Guide

105

Setting data access general configuration parameters (CFG) Settings reference

Charset List Extension

<Parameter Name="CharSet List Extension">crs</Parameter>

Description Default

Determines the extension for character set files. crs

Max Pool Time

Max Pool Time is available in library and server mode. Library
<Settings> <Parameter Name="Max Pool Time">-1</Parameter> ... <Library/>

Server
<Server> <Parameter Name="Max Pool Time">60</Parameter> ... </Server> <Parameter Name="Max Pool Time">-1</Parameter>

Description

Determines the maximum connection idle lifetime in the connection pool regardless of the value defined in the connection. You can set Max Pool Time for two types of Connection Server deployments: Library: Value applies to nodes that have Connection Server installed with desktop or other server products. Server: Value applies to Connection Server stand alone server installations. For information on deploying Connection Server on a dedicated node see the Deployment guide. Library mode: -1 Server: 60 -1 No timeout, keep alive for the whole session. 0 Connection not managed by the pool. >0 Idle lifetime (in minutes).

Default Values

106

Data Access Guide

Business Objects information resources

appendix

Business Objects information resources Documentation and information services

Documentation and information services

Business Objects offers a full documentation set covering its products and their deployment. Additional support and services are also available to help maximize the return on your business intelligence investment. The following sections detail where to get Business Objects documentation and how to use the resources at Business Objects to meet your needs for technical support, education, and consulting.

Documentation
You can find answers to your questions on how to install, configure, deploy, and use Business Objects products from the documentation.

Whats in the documentation set?

View or download the Business Objects Documentation Roadmap, available with the product documentation at http://www.businessobjects.com/support/. The Documentation Roadmap references all Business Objects guides and lets you see at a glance what information is available, from where, and in what format.

Where is the documentation?

You can access electronic documentation at any time from the product interface, the web, or from your product CD.

Documentation from the products

Online help and guides in Adobe PDF format are available from the product Help menus. Where only online help is provided, the online help file contains the entire contents of the PDF version of the guide.

Documentation on the web

The full electronic documentation set is available to customers on the web from support website at: http://www.businessobjects.com/support/.

Documentation on the product CD

Look in the docs directory of your product CD for versions of guides in Adobe PDF format.

108

Data Access Guide

Business Objects information resources Customer support, consulting and training

Send us your feedback

Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: [email protected]. Note: If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: http://www.businessobjects.com/ support.

Customer support, consulting and training

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

How can we support you?

Business Objects offers customer support plans to best suit the size and requirements of your deployment. We operate customer support centers in the following countries:

USA Australia Canada United Kingdom Japan

Online Customer Support

The Business Objects Customer Support website contains information about Customer Support programs and services. It also has links to a wide range of technical information including knowledgebase articles, downloads, and support forums. http://www.businessobjects.com/support/

Data Access Guide

109

Business Objects information resources Useful addresses at a glance

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: http://www.businessobjects.com/services/consulting/

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: http://www.businessobjects.com/services/training

Useful addresses at a glance

Address Business Objects product information http://www.businessobjects.com Product documentation http://www.businessobjects.com/ support Business Objects Documentation mailbox [email protected] Online Customer Support http://www.businessobjects.com/ support/ Content Information about the full range of Business Objects products. Business Objects product documentation, including the Business Objects Documentation Roadmap. Send us feedback or questions about documentation. Information on Customer Support programs, as well as links to technical articles, downloads, and online forums.

110

Data Access Guide

Business Objects information resources Useful addresses at a glance

Address Business Objects Consulting Services http://www.businessobjects.com/ services/consulting/ Business Objects Education Services http://www.businessobjects.com/ services/training

Content Information on how Business Objects can help maximize your business intelligence investment. Information on Business Objects training options and modules.

Data Access Guide

111

Business Objects information resources Useful addresses at a glance

112

Data Access Guide

Index

Symbols
$INSTALLDIR use of variable in guide 6

A
access Connection Server 7 New Connection wizard 17 advanced parameters connection 24 ANSI92 universe parameter 47, 55 Array Bind Available 90 Array Bind Size 90, 90 Array Fetch Available 90 Array Fetch Size 90 AUTO_UPDATE_QUERY universe parameter 47, 47

B
BACK_QUOTE_SUPPORTED 65 Bca_Bursting_Size 91 BeginTranSyntax 91 Binary Slice Size 91 BLOB_COMPARISON universe parameter 47 Blob_Comparison 65 BOUNDARY_WEIGHT_TABLE universe parameter 48 Boundary_Weight_Table 65, 65 Business Objects consulting services 110, 111 support services 109 training services 110, 111

C
CASE_SENSITIVE 65

Case_Sensitive 65 CFG file Charset List Extension 106 Config File Extension 105 Description Extension 105 Distribution section 101 Driver Default parameters 100 Driver defaults section 102 editing 102 Enable Failed Load 104 Load Drivers On Startup 104 Locales parameters 100 Locales section 100 Lookup parameters 101 Max Pool Time 106 Protocols parameters 101 settings parameters reference 103 Settings section 101 SQL External Extension 105 SQL Parameter Extension 105 Strategies Extension 105 structure 100 Traces section 102 viewing 102 cfg file description 33 Charset List Extension CFG file 106 CharSet Table 91 CHECK_OWNER_STATE 65 CHECK_QUALIFIER_STATE 66 COLUMNS_SORT universe parameter 48 COMBINED_WITH_SYNCHRO universe parameter 49 COMBINED_WITHOUT_PARENTHESIS universe parameter 49 COMMA 66 CONCAT 66

Data Access Guide 113

Index

Config File Extension CFG file 105 connection advanced parameters 24 create new 17 creating 16 creation pre-requisites 9 creation process overview 9 custom parameters 26 definition 8 management tools 8 parameters overview 16 personal 23 secured 23 shared 23 start creating 17 using wizard 17 utilities 8 Connection Server accessing 7 creating connections 7 definition 7 management tools 8 optimize data access 7 consultants, Business Objects 110 CORE_ORDER_PRIORITY universe parameter 50 CORRECT_AGGREGATED_CONDITIONS_IF_D RILL universe parameter 50 Cost Estimate Unit 68 create connection overview 9 connection pre-requisites 9 connection with wizard 16 new connection 17 CUMULATIVE_OBJECT_WHERE universe parameter 51 Cumulative_Object_Where 68, 92 CursorForward 68 custom parameter Hint 26 custom parameters connection 26 customer support 109

D
data access driver level files 12 files installed 10 global files 11 installed files 10 optimizing 7 data access driver definition 10 files used by 12 DATABASE_DATE_FORMAT 67 datatype IBM DB2 38 Informix 39 Oracle 40 Red Brick 41 SQL Server 39 Sybase 42 Teradata 43 DATATYPE_BLOB 67 DATATYPE_DOUBLE 67 DATATYPE_DTM 67 DATATYPE_INT 68 DATATYPE_NULL 68 DATATYPE_STRING 68 DATE_WITHOUT_QUOTE 68 Date_Without_Quote 68 DECIMAL_COMMA universe parameter 51 define new connection 17 Describe Param Available 91 DescribeParam Available 91 Description Extension CFG file 105 Description File 92 DISTINCT_VALUES universe parameter 52 Distribution CFG file 101 documentation feedback on 109 on product CD 108 on the web 108 roadmap 108

114

Data Access Guide

Index

Driver defaults CFG file 102 driveren.prm parameters Blob_Comparison 65 Boundary_Weight_Table 65, 65 Case_Sensitive 65 Cumulative_Object_Where 68, 92 Ext_Join 69 Intersect 71 Left_Outer 72 Max_Inlist_Values 73 Minus 73 OLAP_Clause 74 Quote_Owner 78 Refresh_Columns_Type 78 DriverLevel 92 driver.sbo parameters Bca_Bursting_Size 91 BeginTranSyntax 91 Cost Estimate Unit 68 CursorForward 68 Date_Without_Quote 68 Lock Mode 94 LongVarcharNotSupported 94 Shared 80 Shortcuts_4x 80 dynamic SQL parameters 31 dynamic SQL setting parameters in universe 30

Ext_Join 69 EXT_JOIN_INVERT 69 EXTERN_SORT_EXCLUDE_DISTINCT 69

F
Family 93 feedback, on documentation 109 FILTER_IN_FROM universe parameter 53, 58 FIRST_LOCAL_CLASS_PRIORITY universe parameter 54 FORCE_SORTED_LOV universe parameter 54

G
global data access files 11 GROUPBY_EXCLUDE_COMPLEX 70 GROUPBY_WITH_ALIAS 70 GROUPBY_WITHOUT_CONSTANT 71 GROUPBYCOL 71

H
Hints custom parameter Oracle 26

I
IBM DB2 datatypes 38 information resources 108 Informix datatypes 39 installation files installed 10 INTERSECT 71 Intersect 71

E
edit dynamic SQL parameters 31 editing 32 editing data access files 32 education. See training Empty String 93, 93 Enable Failed Load CFG file 104 END_SQL universe parameter 52 EVAL_WITHOUT_PARENTHESIS universe parameter 53 EXT_JOIN 69

K
KEY_INFO_SUPPORTED 72

L
LEFT_OUTER 72

Data Access Guide 115

Index

Left_Outer 72 LENMAXFORCOLUMNNAME 72 LENMAXFORTABLENAME 73 LENMAXFORVARCHAR 73 Load Drivers On Startup CFG file 104 Locales CFG file 100 Lock Mode 94 login setting parameters 22 login parameters 22 LongVarcharNotSupported 94 Lookup CFG file 101

Oracle datatypes 40 OUTERJOINS_GENERATION 75 OVER_CLAUSE 76 overview connection parameters 16 creating a connection 9 OWNER 76

P
parameter files 32 Password_Encryption 95, 95 PATH_FINDER_4x 77 PATH_FINDER_OFF universe parameter 55 personal connection 23 PREFIX_SYS_TABLE 77 PRM file BACK_QUOTE_SUPPORTED 65 CASE_SENSITIVE 65 CHECK_OWNER_STATE 65 CHECK_QUALIFIER_STATE 66 COMMA 66 CONCAT 66 DATABASE_DATE_FORMAT 67 DATATYPE_BLOB 67 DATATYPE_DOUBLE 67 DATATYPE_DTM 67 DATATYPE_INT 68 DATATYPE_NULL 68 DATATYPE_STRING 68 DATE_WITHOUT_QUOTE 68 edit parameters 62 EXT_JOIN 69 EXT_JOIN_INVERT 69 EXTERN_SORT_EXCLUDE_DISTINCT 69 GROUPBY_EXCLUDE_COMPLEX 70 GROUPBY_WITH_ALIAS 70 GROUPBY_WITHOUT_CONSTANT 71 GROUPBYCOL 71 INTERSECT 71 KEY_INFO_SUPPORTED 72 LEFT_OUTER 72 LENMAXFORCOLUMNNAME 72

M
Max Pool Time CFG file 106 MAX_INLIST_VALUES universe parameter 54 Max_Inlist_Values 73 MINUS 73 Minus 73

N
Native Int64 Available 94 new connection create 17 New Connection wizard 16 accessing 17 using 17 niverse parameter PATH_FINDER_OFF 55 NO_DISTINCT 74

O
ODBC Cursors 94 OLAP_CLAUSE 74 OLAP_Clause 74 Online Customer Support 109 optimize data access 7, 32 Optimize Execute 94

116

Data Access Guide

Index

LENMAXFORTABLENAME 73 LENMAXFORVARCHAR 73 list of files 60 MINUS 73 NO_DISTINCT 74 OLAP_CLAUSE 74 OUTERJOINS_GENERATION 75 OVER_CLAUSE 76 OWNER 76 PATH_FINDER_4x 77 PREFIX_SYS_TABLE 77 QUALIFIER 77 QUOTE_OWNER 78 reference 60 reference list 64 REFRESH_COLUMNS_TYPE 78 REVERSE_TABLE_WEIGHT 79 RIGHT_OUTER=$(+) 79 RISQL_FUNCTIONS 80 SHORTCUTS_4X 80 SORT_BY_NO 81 TABLE_DELIMITER 81 UNICODE_PATTERN 82 UNION 82 USER_INPUT_DATE_FORMAT 83 USER_INPUT_NUMERIC_SEPARATOR 83 view parameters 62 prm file description 34 PRM language file edit function Help text 63 view function Help text 63 Protocols CFG file 101 Provider CLSID 95

TIME support in WHERE 41 TIMESTAMP support in WHERE 41 REFRESH_COLUMNS_TYPE 78 Refresh_Columns_Type 78 REPLACE_COMMA_BY_CONCAT universe parameter 55, 55 resources 108 REVERSE_TABLE_WEIGHT 79 RIGHT_OUTER=$(+) 79 RISQL_FUNCTIONS 80

S
SBO file 90, 93 Array Bind Available 90 Array Fetch Available 90 Array Fetch Size 90 Binary Slice Size 91 CharSet Table 91 Databases parameters 88 Defaults parameters 88 Describe Param Available 91 DescribeParam Available 91 Description File 92 DriverLevel 92 editing 89 Family 93 Native Int64 Available 94 ODBC Cursors 94 Optimize Execute 94 Password_Encryption 95, 95 Provider CLSID 95 SQL Parameter File 96 Strategies File 96 structure 88 Transaction Available 97 Unicode 97 V5toV6DriverName 98 viewing 89 sbo file description 34 secured connection 23 setting login parameters 22 Settings

Q
QUALIFIER 77 QUOTE_OWNER 78 Quote_Owner 78

R
Red Brick datatypes 41

Data Access Guide 117

Index

CFG file 101 settings CFG parameter reference 103 Shared 80 shared connection 23 SHORTCUT_BEHAVIOR universe parameter 56 SHORTCUTS_4X 80 Shortcuts_4x 80 SORT_BY_NO 81 SQL External Extension CGF file 105 SQL parameter PRM file list 64 SQL Parameter Extension CFG file 105 SQL Parameter File 96 SQL parameters setting in universe 30 SQL Server datatypes 39 start creating a connection 17 Strategies Extension CFG file 105 Strategies File 96 support customer 109 locations 109 technical 109 web site 109 Sybase datatypes 42

Transaction Available 97 TRUST_CARDINALITIES universe parameter 57

U
Unicode SBO file 97 UNICODE_PATTERN 82 UNICODE_STRINGS universe parameter 58 UNION 82 universe setting SQL parameters 30 universe parameter AUTO_UPDATE_QUERY 47 BLOB_COMPARISON 47 BOUNDARY_WEIGHT_TABLE 48 COLUMNS_SORT 48 COMBINED_WITH_SYNCHRO 49 COMBINED_WITHOUT_PARENTHESIS 49 CORE_ORDER_PRIORITY 50 CORRECT_AGGREGATED_CONDITIONS_I F_DRILL 50 CUMULATIVE_OBJECT_WHERE 51 DECIMAL_COMMA 51 DISTINCT_VALUES 52 END_SQL 52 EVAL_WITHOUT_PARENTHESIS 53 FILTER_IN_FROM 53 FIRST_LOCAL_CLASS_PRIORITY 54 FORCE_SORTED_LOV 54 MAX_INLIST_VALUES 54 REPLACE_COMMA_BY_CONCAT 55 SHORTCUT_BEHAVIOR 56 THOROUGH_PARSE 56 TRUST_CARDINALITIES 57 UNICODE_STRINGS 58 USER_INPUT_DATE_FORMAT 83 USER_INPUT_NUMERIC_SEPARATOR 83

T
TABLE_DELIMITER 81 technical support 109 Teradata datatypes 43 THOROUGH_PARSE universe parameter 56, 56 traces CFG file 102 training, on Business Objects products 110

V
V5toV6DriverName 98

118

Data Access Guide

Index

W
web customer support 109 getting documentation via 108 useful addresses 110 web sites support 109 training 110

Data Access Guide 119

Index

120

Data Access Guide