data access guide xi 3.1

Data Access Guide

SAP BusinessObjects XI3.1 Service Pack 3

© 2010 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge,ByDesign, SAP Business ByDesign, and other SAP products and services

Copyright

mentioned herein as well as their respective logos are trademarks or registeredtrademarks of SAP AG in Germany and other countries. Business Objects and theBusiness Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, WebIntelligence, Xcelsius, and other Business Objects products and services mentionedherein as well as their respective logos are trademarks or registered trademarksof Business Objects S.A. in the United States and in other countries. BusinessObjects is an SAP company.All other product and service names mentioned arethe trademarks of their respective companies. Data contained in this documentserves informational purposes only. National product specifications may vary.Thesematerials are subject to change without notice. These materials are provided bySAP AG and its affiliated companies ("SAP Group") for informational purposesonly, without representation or warranty of any kind, and SAP Group shall not beliable for errors or omissions with respect to the materials. The only warranties forSAP Group products and services are those that are set forth in the expresswarranty statements accompanying such products and services, if any. Nothingherein should be construed as constituting an additional warranty.

2010-05-21

ContentsIntroducing data access 13Chapter 1

About Connection Server...........................................................................14Components of a connection.....................................................................14

About the system architecture..............................................................15About data access drivers....................................................................15About connectivities that support single sign-on..................................16

About data access configuration files........................................................16About the cs.cfg global configuration file..............................................17About the *.sbo driver configuration files..............................................17

About stored procedures...........................................................................19About supported database capabilities................................................20About Oracle stored procedures..........................................................20To create a cursor inside a package....................................................21To create an Oracle stored procedure..................................................21About Teradata stored procedures.......................................................22

Creating a connection 23Chapter 2

Connection requirements...........................................................................24Checking connection configuration............................................................24

Displaying help on the cscheck tool.....................................................25To run the cscheck tool.........................................................................26Check tool—function overview.............................................................26Check tool—list....................................................................................28Check tool—drivers search..................................................................29Check tool—find...................................................................................30Check tool—middleware......................................................................32

Data Access Guide 3

Check tool—accessdriver.....................................................................34Check tool—connectivity......................................................................35Check tool—ping .................................................................................37

About JDBC connections ..........................................................................40To create a JDBC connection ...................................................................41

JDBC SBO example file structure........................................................42To create a generic JDBC connection.......................................................42

Generic JDBC SBO example file structure..........................................44About JavaBean connections....................................................................44To create a JavaBean connection.............................................................45

JavaBean SBO example file structure ................................................46About ODBC connections..........................................................................46To create a generic ODBC connection......................................................47To create a generic ODBC3 connection....................................................49

Creating a connection to Data Federator Query Server 51Chapter 3

About Data Federator Query Server connections.....................................52Configuring the New Connection wizard for a Data Federator JDBC or ODBCconnection.................................................................................................53Configuring Data Federator JDBC connections........................................54

Configuring Connection Server for a Data Federator JDBCconnection............................................................................................54

Configuring Data Federator ODBC connections.......................................55Configuring the Data Federator ODBC middleware ............................56Configuring Connection Server for a Data Federator ODBCconnection............................................................................................57

Configuring Web Intelligence Rich Client connection definitions using DataFederator ODBC middleware....................................................................57

Configuring the Data Federator ODBC middleware for a Web IntelligenceRich Client connection..........................................................................59Configuring Connection Server for a Web Intelligence Rich Clientconnection to Data Federator...............................................................59

4 Data Access Guide

Contents

Setting the Web Intelligence Rich Client registry key ..........................60Configuring Connection Server for Web Intelligence Rich Client andUniverse Designer connections to Data Federator..............................60

Configuring data access global parameters 63Chapter 4

About global parameters............................................................................64About the cs.cfg configuration file..............................................................64To view and edit the cs.cfg file...................................................................65Configuring the driver default parameters.................................................65Configuring the global settings parameters...............................................66

Charset List Extension.........................................................................66Config File Extension...........................................................................67Description Extension...........................................................................67Enable Failed Load..............................................................................68Load Drivers On Startup.......................................................................68Max Pool Time......................................................................................69SQL External Extension.......................................................................70SQL Parameter Extension....................................................................71Strategies Extension............................................................................71Transient Object Timeout.....................................................................72

Setting the deployment mode....................................................................72Configuring the deployment mode.............................................................73Configuring the driver to load in server mode............................................74

Setting one connectivity per machine..................................................75Configuring the CORBA access protocols.................................................77

Configuring data access driver parameters 79Chapter 5

Configuring driver parameters...................................................................80Data access configuration files.............................................................80Installed SBO files................................................................................81

Data Access Guide 5

Contents

To view and edit an SBO file................................................................83Configuring data access for DataDirect ODBC branded drivers...............83

To enable the use of DataDirect branded drivers.................................84

SBO parameter reference 87Chapter 6

SBO parameter categories........................................................................88SBO file structure.......................................................................................88Default SBO parameters............................................................................90

Array Bind Available.............................................................................90Array Bind Size.....................................................................................90Array Fetch Available...........................................................................91Array Fetch Size...................................................................................91Catalog Name Max Size.......................................................................92Catalog Separator................................................................................92CharSet................................................................................................93Column Name Max Size.......................................................................93Connection Shareable..........................................................................94Cost Estimate Available.......................................................................94Description File.....................................................................................95Driver Capabilities................................................................................95Escape Character.................................................................................96Extensions............................................................................................97Family...................................................................................................97Field Size Factor..................................................................................97Force Execute......................................................................................98Identifier Case......................................................................................98Identifier Quote String..........................................................................99LIKE Escape Clause............................................................................99Locale.................................................................................................100Max Rows Available...........................................................................100Optimize Execute...............................................................................101

6 Data Access Guide

Contents

Owners Available...............................................................................101Password Encryption..........................................................................102Procedure Name Max Size................................................................103Procedure Parameter Name Max Size..............................................103Qualifiers Available.............................................................................104Query TimeOut Available...................................................................104Quoted Identifier Case.......................................................................105Schema Name Max Size....................................................................105Shared Connection.............................................................................106SQL External File...............................................................................106SQL Parameter File............................................................................107SSO Available....................................................................................107Strategies File....................................................................................108Table Name Max Size........................................................................108Transactional Available......................................................................109Transaction Mode...............................................................................109Type....................................................................................................110Version...............................................................................................110XML Max Size....................................................................................111

Informix SBO parameters........................................................................111To modify the Informix ODBC.INI file..................................................111V5toV6DriverName............................................................................112Unicode..............................................................................................113

JavaBean SBO parameters.....................................................................113JavaBean Class.................................................................................113URL Format........................................................................................114

JDBC SBO parameters............................................................................115ForeignKeys Available........................................................................115JDBC Class........................................................................................115PrimaryKey Available.........................................................................116

ODBC SBO parameters...........................................................................116

Data Access Guide 7

Contents

Connection Status Available..............................................................117Empty String.......................................................................................117Force Close Statement.......................................................................118Native Int64 Available.........................................................................118ODBC Cursors...................................................................................119SQLDescribeParam Available............................................................119SQLMoreResults Available................................................................120Use DataDirect OEM Driver...............................................................120

OLE DB SBO parameters........................................................................121Enumerator CLSID.............................................................................121Provider CLSID..................................................................................121

OLE DB OLAP SBO parameters.............................................................122MSOlap CLSID...................................................................................122

Sybase ASE/CTLIB.................................................................................122Quoted Identifier.................................................................................122

Configuring SQL generation parameters 125Chapter 7

About SQL generation parameters..........................................................126About PRM files.......................................................................................126

PRM parameter file structure.............................................................129To view and edit a PRM file.....................................................................132To view and edit a function help text file..................................................132To edit the help text for a PRM function...................................................133

PRM parameter reference 135Chapter 8

PRM file configuration reference.............................................................136BACK_QUOTE_SUPPORTED..........................................................136CASE_SENSITIVE.............................................................................137CHECK_OWNER_STATE..................................................................137CHECK_QUALIFIER_STATE.............................................................138

8 Data Access Guide

Contents

COMMA..............................................................................................138CONCAT............................................................................................139CONSTANT_SAMPLING_SUPPORTED...........................................139DATABASE_DATE_FORMAT............................................................140DATATYPE_BLOB..............................................................................140DATATYPE_DOUBLE........................................................................141DATATYPE_DTM...............................................................................141DATATYPE_INT.................................................................................141DATATYPE_NULL..............................................................................142DATATYPE_STRING .........................................................................142DATE_WITHOUT_QUOTE ...............................................................142DELIMIT_IDENTIFIERS.....................................................................143EXT_JOIN..........................................................................................143EXT_JOIN_INVERT...........................................................................144EXTERN_SORT_EXCLUDE_DISTINCT...........................................145GROUPBY_EXCLUDE_COMPLEX...................................................145GROUPBY_WITH_ALIAS..................................................................146GROUPBY_WITHOUT_CONSTANT.................................................147GROUPBYCOL..................................................................................147IDENTIFIER_DELIMITER..................................................................148IF_NULL.............................................................................................149INTERSECT.......................................................................................149KEY_INFO_SUPPORTED.................................................................150LEFT_OUTER....................................................................................150LENMAXFORCOLUMNNAME...........................................................151LENMAXFORTABLENAME...............................................................151LENMAXFORVARCHAR....................................................................152MINUS................................................................................................152NO_DISTINCT...................................................................................153NULL_IN_SELECT_SUPPORTED....................................................153OLAP_CLAUSE.................................................................................154

Data Access Guide 9

Contents

OUTERJOINS_GENERATION...........................................................155OVER_CLAUSE.................................................................................158OWNER..............................................................................................159PERCENT_RANK_SUPPORTED......................................................160PREFIX_SYS_TABLE........................................................................160QUALIFIER........................................................................................161QUOTE_OWNER...............................................................................161RANK_SUPPORTED.........................................................................162REFRESH_COLUMNS_TYPE...........................................................163REVERSE_TABLE_WEIGHT.............................................................163RIGHT_OUTER..................................................................................164RISQL_FUNCTIONS..........................................................................164SEED_SAMPLING_SUPPORTED.....................................................165SORT_BY_NO...................................................................................166UNICODE_PATTERN........................................................................166UNION................................................................................................167USER_INPUT_DATE_FORMAT........................................................168USER_INPUT_NUMERIC_SEPARATOR..........................................169

Data type conversion reference 171Chapter 9

Data type conversion ..............................................................................172IBM DB2.............................................................................................172Informix...............................................................................................174Microsoft SQL Server.........................................................................175Oracle.................................................................................................176Red Brick............................................................................................177To add TIME and TIMESTAMP support in a WHERE clause............178Sybase...............................................................................................179Teradata.............................................................................................180

10 Data Access Guide

Contents

More Information 183Appendix A

Index 187

Data Access Guide 11

Contents


Contents

Introducing data access

1

About Connection ServerConnection Server is the data access software that manages the connectionbetween an SAP BusinessObjects application and a datasource.

Connection Server allows applications such as Universe Designer and SAPBusinessObjects Web Intelligence to connect to and run queries against adatasource.

Connection Server does not have a user interface. You create and administerconnections from the user interface of these applications, or by editingConnection Server configuration files.

• Creating connections: You create connections using the Connectionwizard.

• Optimizing data access: You can optimize the way that data is passedthrough Connection Server by modifying data access configuration files.These files are in XML format, and are installed with Connection Server.You can set parameter values to apply to a specific data access driver,or to all installed data access drivers.

Components of a connectionA data access connection consists of the following components:• Connection Server is the software that manages the connection between

the application and the datasource. For example, Connection Serverhandles requests for data from the application.

• A data access driver is the database-specific software component thatmanages the connection between Connection Server and the databasemiddleware.

• Configuration files define parameters to configure the connection between:• the application and Connection Server

• the application and the data access driver

• Connection Server and the data access driver


Introducing data access1 About Connection Server

About the system architecture

The diagram below details where Connection Server and data access driversfit into an SAP BusinessObjects Enterprise configuration.

About data access drivers

Data access drivers provide the connection between Connection Server anda datasource. A database requires a data access driver in order that it canbe accessed by an SAP BusinessObjects application.

SAP BusinessObjects applications include data access drivers that you canuse to configure connections to your databases. The data access driversthat are included can depend on your licence.


1Introducing data accessComponents of a connection

Before you can create a connection to a database for which you do not havea driver, you need to obtain the required drivers. The following options areavailable for obtaining a driver:

• Contact your SAP representative to determine if there is a driver available,and if you are licenced to use it.

• Use the Driver Development Kit (DDK) to develop a driver to use. Contactyour SAP representative for details.

When you create a new connection, you select the appropriate data accessdriver for the target datasource. For example, if you access an Oracle 10gdatabase, you must install the appropriate middleware (Oracle 10g Client),then the SAP BusinessObjects Oracle data access driver.

For an up-to-date list of supported data access drivers, check the SAP ServiceMarketplace at http://service.sap.com/bosap-support, or contact your SAPrepresentative.

For more information about the DDK, refer to the Data Access Driver JavaSDK Developer Guide at http://boc.sdn.sap.com.

About connectivities that support single sign-on

SAP BusinessObjects Enterprise only provides single sign-on (SSO)authentication when installed on the following platforms and with the followingconnectivities:

• SAP BW on all platforms• MS Analysis Services on Microsoft Windows• MS SQL Server through ODBC or OLE DB on Microsoft Windows• Oracle through Oracle OCI on Microsoft Windows

Note:SSO is not available for JDBC connections. For more information about SSO,refer to SAP BusinessObjects Enterprise Administrator's Guide.

About data access configuration filesData access configuration files are installed with SAP BusinessObjectsEnterprise. The configuration files can be divided into two levels:


Introducing data access1 About data access configuration files

http://service.sap.com/bosap-support

http://boc.sdn.sap.com

• Global level: The cs.cfg configuration file applies to all connections.

• Driver level: There is a *.sbo configuration file for each specific driver.

In addition to the configuration files that control a connection, each dataaccess driver has an associated .prm configuration file. These files are usedby applications such as Universe Designer. The .prm files control the wayin which an application generates SQL depending on the database softwarecapabilities.

Note:

In this guide, the variable connectionserver-install-dir is the installroot path for the data access files used by SAP BusinessObjects applications.On Microsoft Windows, the default connectionserver-install-diris: C:\Program Files\Business Objects\BusinessObjectsEnterprise 12.0\win32_x86\dataAccess.

Caution:In the data access configuration files, use the escape sign \ with thebackslash \ in file paths if you deploy SAP BusinessObjects Enterprisesoftware on a Microsoft Windows platform.

About the cs.cfg global configuration file

The cs.cfg global configuration file used by all data access drivers isinstalled in the following location:• connectionserver-install-dir\connectionServer

The cs.cfg file contains parameters that apply to all installed data accessdrivers.Related Topics• About global parameters

About the *.sbo driver configuration files

The configuration files used by data access drivers are installed in thefollowing path:


1Introducing data accessAbout data access configuration files

• on a Windows system:

connectionserver-install-dir\connectionServer\RDBMS

• on a Unix system:

connectionserver-install-dir/RDBMS/connectionServer

where RDBMS is the name of the database technology that uses theconfiguration file.

The files listed below have parameters that apply to installed data accessdrivers.

ExampleDescriptionCan be edited?Driver specificfile

oracle.sbo

There is a .sbofile for each sup-ported networkprotocol, ordatabase middle-ware used to con-nect to adatabase. De-fines the specificconnectivity con-figuration foreach database.

Yes<driver>.sbo

oracle.prm

Defines parame-ters that affect theway that an appli-cation generatesSQL.

Yes<driver>.prm


Introducing data access1 About data access configuration files

ExampleDescriptionCan be edited?Driver specificfile

oracleen.cod

Stores informa-tion related toconnection defini-tions. Defines thefields that appearwhen you createa new connec-tion.

Note:Do not modifythese files.

No<driver><language>.cod

Related Topics• SBO parameter categories• PRM file configuration reference• About SQL generation parameters

About stored proceduresConnection Server is able to manage data from datasources that result eitherfrom SQL query or stored procedure execution.

Stored procedures are SQL scripts that are stored as executable code in anRDBMS. They can receive arguments and return data.

Stored procedures for the following databases and network layers aresupported in SAP BusinessObjects Enterprise:

• DB2 UDB and iSeries through CLI driver• Sybase Adaptive Server through CTLIB• Javabean• DB2 UDB, Derby, HSQL DB, Informix, MS SQL Server, MySQL 5, Oracle,

Sybase, and Teradata, all through JDBC


1Introducing data accessAbout stored procedures

• Oracle through OCI• DB2 iSeries, Informix, MS SQL Server, Sybase ASIQ, Sybase SQL

Anywhere, and Teradata, all through ODBC• MS SQL Server through OLE DB

About supported database capabilities

Connection Server only supports stored procedures that return data as resultsets, that is, tables. This means that the stored procedure cannot returnintegers, strings, or cursors and must always contain SELECT statements.Plus, supported stored procedures must not contain OUT or IN/OUTparameters. In addition, COMPUTE, PRINT, OUTPUT or STATUS statementscontained in stored procedures are not executed.

Remember:These restrictions are not valid for Oracle stored procedures. Refer to nextsection for learning about supported Oracle stored procedures.

Note:For more information about using stored procedures, refer to the Designer'sGuide.

About Oracle stored procedures

The supported Oracle stored procedures are the following:

• any PL/SQL procedure that returns result sets through a REF Cursor• PL/SQL stored procedures that have one IN/OUT REF cursor variable

parameter and no OUT parameter

Note:The other IN/OUT cursor parameters of the procedure are ignored.

The unsupported Oracle stored procedures are the following:

• any PL/SQL procedure that does not return result sets through a REFCURSOR parameter

• any PL/SQL procedures having at least one OUT parameter• any PL/SQL function


Introducing data access1 About stored procedures

• any PL/SQL procedure having one IN/OUT parameter of a type differentthan a REF CURSOR, for example, VARRAY

• any PL/SQL Table function

To access Oracle stored procedures, you must do a number of tasks at theserver end to allow SAP BusinessObjects Enterprise to connect to a storedprocedure. This is explained in the next sections.

To create a cursor inside a package

In Oracle databases, a package is a database object that contains relatedPL/SQL types, objects, and subprograms. You must first create a cursorinside a package before creating an Oracle stored procedure using thedefined cursor.

• In the Oracle database administration system, use the following statement:

CREATE or REPLACE PACKAGE catalog_data ASTYPE CatCurTyp IS REF CURSOR RETURNall_objects%ROWTYPE;END catalog_data;

Caution:SAP BusinessObjects Enterprise does not support packaged storedprocedures, only standalone.

To create an Oracle stored procedure

In the following procedure, you use catcurtyp cursor that you previouslycreated in the package, and catalog_data.catcurtyp.

• Do one of the following:a. Write the following statement:

CREATE or REPLACE PROCEDURE get_allobjects(cat_cvIN OUTcatalog_data.catcurtyp) ASBEGINOPEN cat_cv FOR SELECT * FROM all_objects;END;


1Introducing data accessAbout stored procedures

b. Write the following statement with several parameters:

CREATE or REPLACE PROCEDURE get_ownerobjects(owner_name INvarchar2, cat_cv IN OUT catalog_data.catcurtyp) AS

BEGINOPEN cat_cv FOR SELECT * FROM all_objects WHEREowner=owner_name;END;

Note:See your Oracle documentation for more information on how to createpackages and stored procedures.

About Teradata stored procedures

Connection Server supports Teradata macros and stored procedures if theconnection established uses ODBC. It only supports Teradata storedprocedures if using JDBC, because Teradata JDBC driver does not supportmacros.


Introducing data access1 About stored procedures

Creating a connection

2

Connection requirementsThis section covers the requirements for creating a connection.

• Ensure that your platform conforms to the platforms supported for SAPBusinessObjects connections.

• Ensure that the database middleware is installed correctly, and that youcan access your database through either your computer or a server.

• Ensure that you have all the information necessary to access yourdatabase, for example the database login name and password.

• Install the SAP BusinessObjects solution that you will use, including theappropriate data access driver.

• Check that all of the services have started successfully.

• Refer to the Readme notice that comes with your SAP BusinessObjectssolution to check for any configuration changes that your environmentand software might require.

• Refer to the current Data Access release notice to check for anyconfiguration changes that could affect your environment.

Note:You can use the cscheck tool to check your infrastructure and determineif it is suitable for use with SAP BusinessObjects applications.

Related Topics• Checking connection configuration

Checking connection configurationThe Connection Server software includes a command line utility that youcan use to check your datasource connection infrastructure. You can usethe cscheck tool to check your client middleware and the installed dataaccess drivers at any time.

Note:The results of all checks apply to your local machine, from which you runthe tool.


Creating a connection2 Connection requirements

The cscheck tool is installed in the following directory: connectionserver-install-dir\connectionServer\tools

You run the cscheck tool from a command console (DOS or shell). Theoutput is displayed on the screen. You can specify that the output is generatedas XML format, or you can suppress output, to use the tool in a script.

The cscheck tool can perform the following functions on your local machine:• return details of all the connectivities, that is network layers and databases,

that the installation can support

• return details of the data access drivers installed on your local machine

• return details of the connectivities installed on your local machine

• check for a valid middleware installation for a supplied network layer anddatabase client

• check for a valid data access driver installation for a supplied networklayer and database client

• check if a connection can be esbablished to a given database

Related Topics• Check tool—function overview

Displaying help on the cscheck tool

The cscheck tool provides functionality to:• display general help on the cscheck utility

• display help on each available cscheck function

The help can be displayed in any language selected when you installed yourSAP BusinessObjects solution.

To display general help on cscheck, use the following syntax:Figure 2-1: Command help syntaxcscheck --help|h --language|l { language }


2Creating a connectionChecking connection configuration

To display help on a function, use the following syntax, where functionNameis the name of the function for which you want help, and language is thelanguage in which to display the help:Figure 2-2: Function help syntaxcscheck --help|h { functionName }--language|l{ language }

Example:

To display help in English on the cscheck tool, use the following command:

cscheck --help

To display help in French on the connectivity function, use the followingcommand:

cscheck --language fr --help connectivity

To run the cscheck tool

You can run the cscheck tool at any time after you have installed your SAPBusinessObjects solution.

1. Open a command console.2. Change directory to the path where the tool is installed.3. Enter cscheck with the correct parameters to find the information that

you want.4. Review the returned information.Related Topics• Check tool—function overview

Check tool—function overview

From a command console, you use the cscheck command with theappropriate function and its arguments to return the results that you want.


Creating a connection2 Checking connection configuration

cscheck commands have the following structure. Some of the parametersare optional.

Figure 2-3: cscheck syntaxcscheck --language|l { output language }--xml|x--mute|m functionnamefunction options

The first part of the command controls the output format:• <output language> or l followed by the language specified in ISO-639

standard. This is optional. The default language is English.

• --xml or x specifies that the output is in XML format. This is optional.The default output is text displayed on the screen.

• --mute specifies that the output is not generated. You would use thisswitch if you were using the tool in a script that checked the returnedstatus. This is optional. The default is that output is generated.

The remaining part of the command consists of the function and its optionarguments.

<function name> can take the following values. Each function has a shortversion that you can use in place of the full function name:• list or lt

• driverssearch or ds

• find or fd

• middleware or mw

• accessdriver or ad

• connectivity or ct

• ping or pg

Related Topics• Check tool—accessdriver• Check tool—connectivity• Check tool—drivers search• Check tool—find• Check tool—list• Check tool—middleware



• Check tool—ping

Check tool—list

This function returns a list of the supported network layers and databaseengines. For example you could use it to determine the correct values to usewith other check tool functions.

Note:This function returns the full list of supported data access drivers andmiddleware, including those that are not necessarily installed on yourmachine.

Figure 2-4: list syntaxcscheck |list||lt|

Example:

The following command lists all network layers and database enginessupported by the SAP BusinessObjects solution installed on the currentmachine.

cscheck list

The following is an excerpt of the result list:

Oracle ClientOracle 9Oracle 10Oracle 11Sybase Open ClientSybase Adaptive Server 12Sybase Adaptive Server 15Informix ODBC DriverInformix XPS 8.4Informix XPS 8.5Informix Dynamic Server 7.3Informix Dynamic Server 2000Informix Dynamic Server 10Informix Dynamic Server 11Teradata ODBC DriverTeradata V2 R5Teradata V2 R6



Teradata 12ODBC DriversGeneric ODBC DatasourceGeneric ODBC3 Datasource...

Related Topics• Check tool—function overview• Displaying help on the cscheck tool

Check tool—drivers search

This function returns a list of the installed data access drivers.

Figure 2-5: driverssearch syntaxcscheck |driverssearch||ds|

Example:

The following command lists all data access drivers installed on the machine.

cscheck driverssearch


This access driver is installed: Oracle OCI accessdriverClient layer: Oracle ClientDatabase engine(s):Oracle 9Oracle 10Oracle 11This access driver is installed: Sybase Open Client access driverClient layer: Sybase Open ClientDatabase engine(s):Sybase Adaptive Server 12Sybase Adaptive Server 15This access driver is installed: Informix ODBC accessdriverClient layer: Informix ODBC DriverDatabase engine(s):



Informix XPS 8.4Informix XPS 8.5Informix Dynamic Server 7.3Informix Dynamic Server 2000Informix Dynamic Server 10Informix Dynamic Server 11This access driver is installed: Teradata ODBC accessdriverClient layer: Teradata ODBC DriverDatabase engine(s):Teradata V2 R5Teradata V2 R6Teradata 12...


Check tool—find

This function lists the available connectivity types, that is middleware anddatabase clients, that are available from the local machine. This includes:• connectivity types available on the local machine

• connectivity types available using the CORBA communication layer

• connectivity types available using the HTTP communication layer

• Java connectivity types available on the local machine

Figure 2-6: find syntaxcscheck |find||fd| -m { Connection Server access mode }



Table 2-1: Function input parameters

The mode in which the client applica-tion accesses Connection Server:• local: lists connectivity types

available on the local machine.

• corba: lists connectivity typesavailable using CORBA.

• http:lists connectivity types avail-able using HTTP.

• java: lists Java connectivity typesavailable on the local machine.

• extended: lists local, java, andcorba connectivity types.

Connection Server access mode(-m)

Example: Finding local connectivities

The following command returns a list of the data access drivers on the localmachine that can be loaded by Connection Server.

cscheck find –m local


Local Library ModeIBM DB2 ClientDB2 v9DB2 UDB v8DB2 UDB for z/OS v8DB2 UDB for OS/390 v7DB2 UDB for iSeries v5Essbase ProviderHyperion Essbase 7.0Hyperion Essbase 9Informix ODBC DriverInformix Dynamic Server 7.3Informix Dynamic Server 2000Informix Dynamic Server 10



Informix Dynamic Server 11Informix XPS 8.4Informix XPS 8.5ODBC DriversGeneric ODBC datasourceGeneric ODBC3 datasourceMS SQL Server 7.xMS SQL Server 2000MS SQL Server 2005Sybase ASIQ 12Sybase SQL Anywhere 10...

Example: Finding CORBA server connectivities

The following command returns a list of the data access drivers availablefrom a CORBA server.

cscheck find –m corba


Check tool—middleware

For a supplied network layer and database client, this function checks for avalid installation of the client middleware. To check both the middleware anddata access driver for a supplied network layer and database client, you canuse the connectivity function.

Figure 2-7: middleware syntaxcscheck |middleware||mw|-c { network layer }-d{ database client }




The network layer that the databasemiddleware uses, as returned by thefind function.

network layer (-c)

The database to check, as returnedby the find function.database client (-d)

Example:

The following command checks for a valid installation of the Oracle Client9 middleware on the local machine. It creates an XML file of the output:c:\result.xml

cscheck --xml middleware -c "Oracle Client" -d "Oracle9" > c:\result.xml

If the middleware is not correctly installed, the result will be the following:

Starting to check the middleware component installation...Begin AND operator...ORACLE_HOME... The environment setting does not exist.

End AND operator: failure.The middleware is not correctly installed.

Related Topics• Check tool—function overview• Displaying help on the cscheck tool• Check tool—connectivity• Check tool—accessdriver



Check tool—accessdriver

For a supplied network layer and database client, this function checks for avalid data access driver installation. To check both the middleware and dataaccess driver for a supplied network layer and database client, you can usethe connectivity function.Figure 2-8: accessdriver syntaxcscheck |accessdriver||ad|-c{ network layer }-d{ database client}



network layer ( -c )


Example:

The following command checks for a valid installation of an Oracle 9 dataaccess driver, and displays the output in French:

cscheck -l fr accessdriver -c "Oracle Client" -d "Oracle9"

If the French language is not installed, the result will be the following:

The language specified is not installed. Please use aninstalled language. English ([en]).



Example:

The following command checks for a valid installation of an Oracle 9 dataaccess driver:

cscheck ad -c "Oracle Client" -d "Oracle 9"

The result is the following:

Starting to check the access driver component installation...Begin AND operator...Config Directory... success.%SharedRoot%\ConnectionServer\Network Layers\Oracle

OCI... success.Directory... success./connectionserver-install-dir/connectionServer//ora

cle... success.Library... success./connectionserver-install-dir/connectionServer//lib

dbd_oci9.so... success./connectionserver-install-dir/connectionServer//lib


dbd_oci11.so... success.Data File Name... success./connectionserver-install-dir/connectionServer//ora

cle/oracle.sbo... success.End AND operator: success.The access driver is installed.

Related Topics• Check tool—function overview• Displaying help on the cscheck tool• Check tool—list

Check tool—connectivity

For the supplied network layer and database client, this function checks thatboth the installed middleware and the data access driver are valid.



You can check each individually using the middleware and the accessdriver functions. You can use the ping function to check if you can connectto a specific database.Figure 2-9: connectivity syntaxcscheck |connectivity||ct|-c{ network layer }-d{ database client}



network layer (-c)


Example:

The following command checks the installed Oracle client middleware, andthe Oracle 9 data access driver. The command writes the output to a textfile: c:\result.txt .

cscheck -l en connectivity -c "Oracle Client" -d "Oracle9">c:\result.txt

If the middleware is not correctly installed, the result will be the following:

Starting to check the middleware component installation...Begin AND operator...ORACLE_HOME... The environment setting does not exist.

End AND operator: failure.The middleware is not correctly installed.Starting to check the access driver component installation...Begin AND operator...Config Directory... success.%SharedRoot%\ConnectionServer\Network Layers\Oracle



OCI... success.Directory... success./connectionserver-install-dir/connectionServer//ora

cle... success.Library... success./connectionserver-install-dir/connectionServer//lib



dbd_oci11.so... success.Data File Name... success./connectionserver-install-dir/connectionServer//ora

cle/oracle.sbo... success.End AND operator: success.The access driver is installed.

Related Topics• Check tool—function overview• Displaying help on the cscheck tool• Check tool—find• Check tool—accessdriver• Check tool—middleware• Check tool—ping

Check tool—ping

This function attempts to access a given database using the supplied details.Figure 2-10: ping syntaxcscheck ping|pg|-m{ Connection Server access mode }-c{ networklayer }-d{ database client }-u{ user name }-p{ password }-s{ datasource}-t{ database }-r{ host name }-j{ PID }




The mode in which the client applica-tion accesses Connection Server:• local: Connection Server is run-

ning on the local machine.

• corba: Connection Server is run-ning on a CORBA server.

• http:Connection Server is runningon a HTTP server.

• java: Connection Server uses aJava data access driver on thelocal machine.

Connection Server access mode(-m)

The database middleware for theconnection to check, as returned bythe find function.

network layer (-c)

The database type, as returned bythe find function.database client (-d)

A valid user name for the database.user name (-u)

The password for the user name.password (-p)

The server on which the database isrunning.datasource (-s)

The database server.database (-t)



For CORBA mode, the computerhosting Connection Server.host name (-r)

For CORBA mode, the processnumber of the Connection Server toping through.

PID (-i)

Example: Pinging an Oracle database

The following command checks access for:• Connection Server access mode: local, that is, the database runs on

the local machine.

• Network layer: Oracle Client

• Database: Oracle 8.1

• Datasource: Harlaxton

• User name: efashion

• Password: X2345

cscheck ping -m local -c "Oracle Client" -d "Oracle 8.1"-u "efashion" -p "X2345" -s "Harlaxton"

Example: Pinging a Sybase database using CORBA

The following command checks access for:• Connection Server access mode: CORBA, that is, Connection Server

runs on a CORBA server.

• Network layer: Sybase

• User name: syadmin

• Password: password

• Datasource: Sybase Adaptive Server 15



• Database: SY1

• Database host: sybasehost

• Process ID: 456

cscheck ping -m corba -c "Sybase Open Client" -d syb15-u "syadmin" -p "password" -s "Sybase Adaptive Server15" -t "SY1" -r "sybasehost" -i 456

Related Topics• Check tool—function overview• Check tool—find

About JDBC connectionsA set of data access drivers are installed when you install your SAPBusinessObjects application. You can use these data access drivers to createconnections to databases.

SAP BusinessObjects software also includes configuration files for usingJDBC drivers to access your databases. To use these drivers, you:• Obtain the java driver software from your database supplier.

• Modify the supplied configuration files.

Note:JDBC connectivity is available for SAP BusinessObjects Enterprise XI 3.0and higher.

Caution:SAP BusinessObjects Web Intelligence Rich Client does not support JDBCconnectivity in 3-tier mode.

For an up-to-date list of supported JDBC drivers, check the SAP ServiceMarketplace at http://service.sap.com/bosap-support, or contact your SAPrepresentative.


Creating a connection2 About JDBC connections


Note:The Data Access layer provides the Generic JDBC connectivity to create aconnection to a datasource that SAP BusinessObjects Enterprise does notsupport explicitly.

Related Topics• To create a JDBC connection• To create a generic JDBC connection

To create a JDBC connectionIn order to create a JDBC connection:• Obtain the necessary JDBC driver software for the database, and copy

the files to your system. These files are available from the databasevendor. The driver software consists typically of one or more jar files.Note the installation path details for these files.

• Ensure that you have the database access details to hand, for examplethe login and password details.

To create a JDBC connection, use the following procedure:

1. Check if there are any additional DLLs that the driver requires, and ensurethat they are accessible by the system. For example, the SQL Server2005 JDBC driver uses addditional DLLs. The directory for these mustbe included in the PATH environment variable.

2. Navigate to the directory that contains the jdbc.sbo file. For example,on Microsoft Windows, the configuration files are located in the connectionserver-install-dir\connectionServer\jdbc directory.

3. Use an XML editor to open the jdbc.sbo file for editing.4. Add the required .jar file details to the ClassPath area. Include the

fully qualified path names when specifying these files, for example:

<Path>C:\\JDBC Drivers\\MSSQLSERVER2000\\msutil.jar</Path>

Note:These files need to be installed on the machine running the application.

Refer to the information on the jdbc.sbo example file structure fordetails.


2Creating a connectionTo create a JDBC connection

5. Locate the Driver Capabilities parameter, and check that it is setto either Procedure or Queries.If it is not, the JDBC driver is unavailable from the New Connectionwizard.

6. Save and close the .sbo file.7. Run the Connection wizard. The JDBC driver that you have configured

appears in the list of available connections. Select the JDBC driver anduse the wizard to configure the connection.

When you complete this task, the connection is available for use.Related Topics• JDBC SBO example file structure• Connection requirements

JDBC SBO example file structure

This lists an example of the section of the JDBC SBO file that you need tomodify. This SBO file is for Microsoft SQL Server 2000.

<DataBase Active="Yes" Name="MS SQL Server 2000">...<JDBCDriver><ClassPath><Path>C:\\JDBC Drivers\\MSSQLSERVER2000\\ms

base.jar</Path><Path>C:\JDBC Drivers\MSSQLSERVER2000\\msu

til.jar</Path><Path>C:\\JDBC Drivers\\MSSQLSERVER2000\\mssqlserv

er.jar</Path></ClassPath>...</JDBCDriver>...</DataBase>

To create a generic JDBC connectionThe following procedure shows how to configure a generic JDBC connectionto a database. In order to create a generic JDBC connection:


Creating a connection2 To create a generic JDBC connection

• Obtain the necessary JDBC driver software for the database, and copythe files to your system. The .jar file need to be installed on the machinerunning the SAP BusinessObjects application.

• Ensure that you have the database access details ready, for example thelogin and password details.

To create a JDBC connection, use the following procedure:

1. Navigate to the directory that contains the jdbc.sbo and jdbc.prmfiles. For example, on Microsoft Windows, the configuration files arelocated in the connectionserver-install-dir\connectionServer\jdbc directory.

2. Use an XML editor to open the jdbc.sbo file for editing.3. Add the required .jar file details to the ClassPath area. Include the

fully qualified path names when specifying these files. Set the JDBC driverclass and the URL format through the appropriate parameters.

Refer to the information on the jdbc.sbo example file structure fordetails.

4. Save and close the jdbc.sbo file.5. Use an XML editor to open the jdbc.prm file for editing.6. Add or update any information specific to the database.

Note:The jdbc.prm file may not contain information about specific functionsof the database.

7. Save and close the jdbc.prm file.8. Run the New Connection wizard. The JDBC driver that you have

configured appears in the list of available connections under Generic.Select the JDBC driver and use the wizard to configure the connection.

When you complete this task, the connection to the datasource is availablefor use through JDBC.

Note:You can only configure one connection through a generic JDBCimplementation.

Related Topics• About PRM files


2Creating a connectionTo create a generic JDBC connection

Generic JDBC SBO example file structure

This lists an example of the section of the JDBC SBO file that you need tomodify. This SBO file is for Generic JDBC datasource and the Ingresdatabase.

Note:The Ingres JDBC driver consists of the iijdbc.jar file. The com.ingres.jdbc.IngresDriver class implements the java.sql.DriverJDBC interface.

<DataBases><DataBase Active="Yes" Name="Generic JDBC datasource"><JDBCDriver><ClassPath><Path>c:\\jdbc\\ingres\\iijdbc.jar</Path></ClassPath><Parameter Name="JDBC Class">com.ingres.jdbc.IngresDriv

er</Parameter><Parameter Name="URL Format">jdbc:ingres://$DATA

SOURCE$</Parameter></JDBCDriver>...</DataBases>

Note:$DATASOURCE$ is either <host>:<port> or<host>:<port>/<database>.

About JavaBean connectionsDevelopers can create JavaBeans that provide access to datasources. Youcan create connections using these JavaBeans. In order to create aJavaBeans connection, the developers who create the JavaBean will supply:

• the required .jar files

• any other files that the JavaBean requires

• any specific configuration details that the JavaBeans driver requires


Creating a connection2 About JavaBean connections

Within a JavaBeans driver, data-retrieval procedures are configured as storedprocedures. When configuring a JavaBeans connection, on the NewConnection wizard 's Database Middleware Selection screen, you mustselect the Filter Stored Procedures Network Layers check-box. If you donot, the New Connection wizard does not display the JavaBeans drivers thatare available.

To create a JavaBean connectionTo create a JavaBeans connection, use the following procedure:

1. Use an XML editor to open the javabeans.sbo file for editing. For example, on Microsoft Windows, the configuration files are located in theconnectionserver-install-dir\connectionServer\javabeandirectory.

2. Add the required .jar file details to the ClassPath area. Include thefully qualified path names when specifying these files.

Note:These files need to be installed on the machine running the SAPBusinessObjects application.

Refer to the information on the JavaBean.sbo example file structure fordetails.

3. Save and close the .sbo file.4. Perform any other configuration tasks specified by the JavaBeans

developer.5. Run the Connection wizard. The JavaBeans datasource that you have

configured should appear in the list of available connections. Select theJavaBeans datasource and use the wizard to configure the connection.

When you complete this task, the connection is available for use with theapplication.Related Topics• JavaBean SBO example file structure• PrimaryKey Available


2Creating a connectionTo create a JavaBean connection

JavaBean SBO example file structure

This section contains an example of a JavaBeans SBO file.

<DataBase Active="Yes" Name="ExcelSpreadsheet"><JavaBean><ClassPath><Path>$ROOT$\\beans\\bean_excel.jar</Path>

</ClassPath><Parameter Name="JavaBean Class">com.businessobjects.beans.excel.Excel</Parameter><Parameter Name="URL Format">$DATASOURCE$</Parameter>

</JavaBean><Parameter Name="Family">Java Beans</Parameter><Parameter Name="Description File">bean_excel</Parameter><Parameter Name="Authentication Mode">Bypass</Parameter><Parameter Name="Extensions">bean_excel,javabean</Parameter>

</DataBase></DataBases>

About ODBC connectionsA set of data access drivers are installed when you install your SAPBusinessObjects application. You can use these data access drivers to createconnections to databases.

SAP BusinessObjects software also includes configuration files for usingODBC drivers to access your databases. To use these drivers, you do thefollowing:• Obtain the ODBC driver software from your database supplier.

• Modify the supplied configuration files.


Creating a connection2 About ODBC connections

For an up-to-date list of supported ODBC drivers, check the SAP ServiceMarketplace at http://service.sap.com/bosap-support, or contact your SAPrepresentative.

Note:The Data Access layer provides the Generic ODBC connectivity to create aconnection to a datasource that SAP BusinessObjects Enterprise does notsupport explicitly.

About generic ODBC connections on UNIX

The Microsoft Windows operating system comes with a standard ODBCdriver manager. In contrast, UNIX does not provide any standard way tomanage drivers. SAP BusinessObjects software allows you to use eitherDataDirect or unixODBC driver managers for generic ODBC connections onUNIX.

Before creating a generic ODBC connection on UNIX for a specific database,you must identify the following:

• the version of the ODBC driver• if the driver is able to work with DataDirect driver manager or unixODBC

You then modify the supplied configuration files and configure the relevantdatasource to enable the connection.

Note:You can configure only one connection through a generic ODBCimplementation.

Related Topics• To create a generic ODBC connection• To create a generic ODBC3 connection

To create a generic ODBC connectionThe following procedure shows how to configure a generic ODBC connectionto a database with the following assumptions:

• The driver is ODBC2• The driver supports the unixODBC driver manager1. Navigate to the directory that contains the odbc.sbo and odbc.prm

files.


2Creating a connectionTo create a generic ODBC connection


The configuration files are located in the connectionserver-install-dir/connectionServer/odbc directory.

2. Use an XML editor to open the odbc.sbo file for editing.3. Locate the following section:

<DataBases><DataBase Active="Yes" Name="Generic ODBC datasource">

<Libraries>...<Library Platform="Unix">dbd_wddodbc</Library><Library Platform="Unix">dbd_ddodbc</Library>

</Libraries><Parameter Name="Charset Table" Platform="Unix">datadirect</Parameter>...</DataBases>

4. Comment out the first two rows for DataDirect and uncomment one ofthe next two rows. Make sure you put the row you uncomment on top ofthe section, so that it can be read first. Comment out the <ParameterName="CharSet Table" Platform="Unix"> element.

Note:• dbd_wddodbc specifies the DataDirect-based ODBC2 Unicode driver• dbd_ddodbc specifies the DataDirect-based ODBC2 non-Unicode

driver• dbd_wuxodbc specifies the unixODBC-based ODBC2 Unicode driver• dbd_uxodbc specifies the unixODBC-based ODBC2 non-Unicode

driver

5. Save and close the odbc.sbo file.6. Use an XML editor to open the odbc.prm file for editing.7. Add or update any information specific to the database.

Note:The odbc.prm file may not contain information about specific functionsof the database.

8. Save and close the odbc.prm file.9. Install the relevant ODBC drivers on your UNIX machine.


Creating a connection2 To create a generic ODBC connection

10. Configure the datasource by editing the odbc.ini file.11. Save and close the odbc.ini file.12. Run the New Connection wizard. The ODBC driver that you have

configured appears in the list of available connections under Generic.Select the ODBC driver and use the wizard to configure the connection.

When you complete this task, the connection to the datasource is availablefor use through generic ODBC with unixODBC driver manager.

To create a generic ODBC3 connectionThe following procedure shows how to configure a generic ODBC connectionto a database with the following assumptions:

• The driver is ODBC3• The driver supports the unixODBC driver manager1. Navigate to the directory that contains the odbc.sbo and odbc.prm

files.The configuration files are located in the connectionserver-install-dir/connectionServer/odbc directory.

2. Use an XML editor to open the odbc.sbo file for editing.3. Locate the following section:

<DataBases><DataBase Active="Yes" Name="Generic ODBC3 datasource"><Libraries>...<Library Platform="Unix">dbd_wddodbc3</Library><Library Platform="Unix">dbd_ddodbc3</Library>

<!--Library Platform="Unix64">dbd_ux32odbc3</Library-

-></Libraries><Parameter Name="Charset Table" Platform="Unix">datadirect</Parameter>...</DataBases>


2Creating a connectionTo create a generic ODBC3 connection

4. Comment the first two rows for DataDirect and uncomment one of thenext four rows. Make sure you put the row you uncomment on top of thesection, so that it can be read first. Comment out the <Parametername="CharSet Table" Platform="Unix"> element.

Note:• dbd_wddodbc3 specifies the DataDirect-based ODBC3 Unicode

driver• dbd_ddodbc3 specifies the DataDirect-based ODBC3 non-Unicode

driver• dbd_wuxodbc3 specifies the unixODBC-based ODBC3 Unicode

driver• dbd_uxodbc3 specifies the unixODBC-based ODBC3 non-Unicode

driver• dbd_wux32odbc3 specifies the unixODBC-based ODBC3 Unicode

driver with 32bit API rather than 64bit (available only on 64bit platforms)• dbd_ux32odbc3 specifies the unixODBC-based ODBC3 non-Unicode

driver with 32bit API rather than 64bit (available only on 64bit platforms)

5. Save and close the odbc.sbo file.6. Use an XML editor to open the odbc.prm file for editing.7. Add or update any information specific to the database.

Note:The odbc.prm file may not contain information about specific functionsof the database.

8. Save and close the odbc.prm file.9. Install the relevant ODBC drivers on your UNIX machine.10. Configure the datasource by editing the odbc.ini file.11. Save and close the odbc.ini file.12. Run the New Connection wizard. The ODBC driver that you have

configured appears in the list of available connections under Generic.Select the ODBC driver and use the wizard to configure the connection.

When you complete this task, the connection to the datasource is availablefor use through ODBC3 with unixODBC driver manager.


Creating a connection2 To create a generic ODBC3 connection

Creating a connection toData Federator QueryServer

3

About Data Federator Query Serverconnections

You can create connections to tables deployed on Data Federator QueryServer, in order to use these tables with an SAP BusinessObjects application.

Note:For information on connecting to Data Federator, see the Data FederatorUser Guide, and refer to the “Connecting to Data Federator Query Serverusing JDBC/ODBC drivers” chapter.

This chapter describes additional settings you must do on Data FederatorQuery Server and configuration details you must use on Connection Serverto create connections.

The method that you use to configure the connection depends on whetheryou use JDBC or ODBC for the connection. With ODBC connections, theconfiguration depends on the SAP BusinessObjects application that you use.The process differs if you are creating a connection to use with SAPBusinessObjects Web Intelligence Rich Client.

The method that you use to create the connection depends on the applicationthat you use. Typically you use the application's New Connection wizard tocreate the connection. See your application's user documentation for moreinformation.

This chapter also indicates the configuration that must be made to the NewConnection wizard of the Universe Designer and SAP BusinessObjects WebIntelligence applications, to be able to create connections.

Caution:

SAP recommends you use a JDBC connectivity to connect SAPBusinessObjects applications to Data Federator Query Server. JDBCconnectivity is only supported in SAP BusinessObjects Enterprise XI 3.0version and higher and does not allow connections to SAP BusinessObjectsDesktop Intelligence. JDBC connectivity is available on all platforms (MicrosoftWindows, UNIX flavors, and Linux).

The minimum ODBC version that you can use with the configuration detailsthat follow is Data Federator XI Release 2 SP1 MHF1. If required, contactyour SAP sales representative for more information on the release, and how


Creating a connection to Data Federator Query Server3 About Data Federator Query Server connections

to obtain it. The Data Federator ODBC middleware can only be used onMicrosoft Windows and because of the use of an OpenAccess ODBC-JDBCbridge, has impacts on performance.

Related Topics• Configuring the New Connection wizard for a Data Federator JDBC orODBC connection• Configuring Data Federator JDBC connections• Configuring Data Federator ODBC connections• Configuring Web Intelligence Rich Client connection definitions using DataFederator ODBC middleware

Configuring theNewConnectionwizardfor a Data Federator JDBC or ODBCconnection

In order to create a connection to Data Federator Query Server, you needthe following information. See your Data Federator administrator to obtainthese details:• the server name and port on which the Data Federator server is running

• the name of the catalog on Data Federator Query Server

In the New Connection wizard, you enter this as the name of the databaseto which you are connecting.

• the authentication details for the installation of Data Federator QueryServer that serves the catalog to which you are connecting

In the New Connection wizard, from the Database Middleware Selectionscreen, you use either the SAP BusinessObjects, Data Federator Server,JDBC Drivers or ODBC Drivers middleware to create the connection.

Refer to your application documentation for information on how to use theNew Connection wizard once you have made the configuration changes.

Note:To configure a JDBC or ODBC connection to Data Federator Query Server,there are some additional configurations that you must make. If you are usingSAP BusinessObjects Web Intelligence Rich Client, the configuration changes


3Creating a connection to Data Federator Query ServerConfiguring the New Connection wizard for a Data Federator JDBC or ODBC connection

required are different to those used by other SAP BusinessObjectsapplications.

Configuring Data Federator JDBCconnections

This section contains Connection Server configuration changes for JDBCconnections to all SAP BusinessObjects applications.

The configuration details in this section refer to the following path:• data-federator-drivers-install-dir\JdbcDriver: the root

installation directory for the Data Federator JDBC middleware. Youradministrator chose this directory when running the Data Federatorinstaller.

• bo-install-dir: the root installation directory for your SAPBusinessObjects applications.

Note:Edit the files in an XML editor to make sure your files are well-formed. Afteryou make the configuration changes shown below, re-start your system forthe changes to take effect.

Configuring Connection Server for a Data FederatorJDBC connection

Note:This topic applies to all SAP BusinessObjects applications that useConnection Server.

To configure Connection Server, you need to change the configuration file:bo-install-dir\BusinessObjects Enterprise12.0\win32_x86\dataAccess\connectionServer\jdbc\jdbc.sbo


Creating a connection to Data Federator Query Server3 Configuring Data Federator JDBC connections

To configure the jdbc.sbo file, add or modify the following lines to theClassPath area, as follows:

<DataBase Active="Yes" Name="Data Federator Server"><JDBCDriver><ClassPath><Path>\\data-federator-drivers-install-dir\\JdbcDriv

er\\lib\\thindriver.jar</Path><Path>\\businessobjects-install-dir\\common\\4.0\\ja

va\\lib\\ebus405.jar</Path></ClassPath><Parameter Name="URL Format">jdbc:datafederator://$DATA

SOURCE$;catalog="$DATABASE$";commProtocol=EBUS</Parameter></JDBCDriver>...</DataBase>

where businessobjects-install-dir stands for C:\ProgramFiles\Business Objects directory on Microsoft Windows. Theebus405.jar file comes with SAP BusinessObjects Enterprise installation.

Configuring Data Federator ODBCconnections

This section contains Data Federator Query Server additional settings andConnection Server configuration changes for ODBC connections to all SAPBusinessObjects applications except SAP BusinessObjects Web IntelligenceRich Client.

The configuration details in this section refer to the following paths:• data-federator-drivers-install-dir\OaJdbcBridge: the root

installation directory for the Data Federator ODBC middleware. Youradministrator chose this directory when running the Data Federator driversinstaller.

• data-federator-drivers-install-dir\JdbcDriver: the rootinstallation directory for the Data Federator JDBC middleware. Youradministrator chose this directory when running the Data Federatorinstaller.



3Creating a connection to Data Federator Query ServerConfiguring Data Federator ODBC connections

Note:Edit the files in an XML editor to make sure your files are well-formed. Afteryou make the configuration changes shown below, re-start your system forthe changes to take effect.

Related Topics• Configuring the Data Federator ODBC middleware• Configuring Connection Server for a Data Federator ODBC connection

Configuring the Data Federator ODBC middleware

Note:This topic applies to all SAP BusinessObjects applications that useConnection Server except SAP BusinessObjects Web Intelligence RichClient.

To configure the Data Federator ODBC middleware, you need to modify theopenrda.ini file. This file is installed in the following directory:• data-federator-drivers-install-dir\OaJd

bcBridge\bin\iwinnt

To configure the openrda.ini file, set parameters in the [JavaIp] section,as follows:• CLASSPATH=data-federator-drivers-install-dir\OaJd

bcBridge\oajava\oasql.jar;data-federator-drivers-install-dir\JdbcDriver\thindriver.jar;bo-install-dir\BusinessObjects Enterprise 12.0\classes\ConnectionServer.jar

• JVM_DLL_NAME=bo-install-dir\javasdk\jre\bin\client\jvm.dll

• JVM_OPTIONS=-DODBCMode=true -Dbusinessobjects.connectivity.directory=bo-install-dir\BusinessObjects Enterprise 12.0\win32_x86\dataAccess\connectionServer


Creating a connection to Data Federator Query Server3 Configuring Data Federator ODBC connections

Note:Check the openrda.ini file to ensure that this path is not set using theDjava.endorsed.dirs parameter. If it is, then you must remove thepath from the Djava.endorsed.dirs parameter.

Configuring Connection Server for a Data FederatorODBC connection

Note:This topic applies to all SAP BusinessObjects applications that useConnection Server except SAP BusinessObjects Web Intelligence RichClient.

To configure Connection Server, you need to change the configuration file:bo-install-dir\BusinessObjects Enterprise12.0\win32_x86\dataAccess\connectionServer\cs.cfg

To configure the cs.cfg file, set parameters under the JavaVM tag, asfollows:

<ClassPath><Path>\\data-federator-drivers-install-dir\\OaJd

bcBridge\\oajava\\oasql.jar</Path><Path>\\data-federator-drivers-install-dir\\JdbcDriv

er\\thindriver.jar</Path></ClassPath>

ConfiguringWeb IntelligenceRichClientconnection definitions using DataFederator ODBC middleware

When creating SAP BusinessObjects Web Intelligence Rich Clientconnections that use Data Federator ODBC middleware, you need to makethe configuration changes described in this section. Without the correctconfiguration amendments, the connection generates errors. This type ofconnection is supported in a Windows environment only.


3Creating a connection to Data Federator Query ServerConfiguring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware

Remember:The details below relate to SAP BusinessObjects Web Intelligence RichClient only.

To create connections that use Data Federator ODBC middleware for usewith this application, you need to modify the configurations for:• The ODBC middleware

• Connection Server

• The Windows RichClient registry key

The configuration details in this section refer to the following paths:• data-federator-drivers-install-dir\OaJdbcBridge: the root

installation directory for the Data Federator ODBC middleware. Youradministrator chose this directory when running the Data Federator driversinstaller.

• data-federator-drivers-install-dir\JdbcDriver: the rootinstallation directory for the Data Federator JDBC middleware. Youradministrator chose this directory when running the Data Federatorinstaller.


Note:Edit the files in an XML editor to make sure your files are well-formed.

Related Topics• Configuring the Data Federator ODBC middleware for a Web IntelligenceRich Client connection•Configuring Connection Server for aWeb Intelligence Rich Client connectionto Data Federator• Setting the Web Intelligence Rich Client registry key•Configuring Connection Server forWeb Intelligence Rich Client and UniverseDesigner connections to Data Federator


Creating a connection to Data Federator Query Server3 Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware

Configuring the Data Federator ODBC middlewarefor a Web Intelligence Rich Client connection

To configure the Data Federator ODBC middleware, you need to modify theopenrda.ini file. This file is installed in the following directory:• data-federator-drivers-install-dir\OaJd

bcBridge\bin\iwinnt

To configure the openrda.ini file, set parameters in the [JavaIp] section,as follows:• CLASSPATH=data-federator-drivers-install-dir\OaJd

bcBridge\oajava\oasql.jar;data-federator-drivers-install-dir\JdbcDriver\thindriver.jar;bo-install-dir\BusinessObjects Enterprise 12.0\classes\ConnectionServer.jar

• JVM_DLL_NAME=bo-install-dir\javasdk\jre6\bin\client\jvm.dll

Note:SAP BusinessObjects Web Intelligence Rich Client requires JDK 6.

• JVM_OPTIONS=-DODBCMode=true -Dbusinessobjects.connectivity.directory=bo-install-dir\BusinessObjects Enterprise 12.0\win32_x86\dataAccess\connectionServer

Note:Check the openrda.ini file to ensure that this path is not set using theDjava.endorsed.dirs parameter. If it is, then you must remove thepath from the Djava.endorsed.dirs parameter.

Configuring Connection Server for a WebIntelligenceRichClient connectiontoData Federator

To configure Connection Server for an SAP BusinessObjects Web IntelligenceRich Client connection to Data Federator, you need to change the



configuration file: bo-install-dir\BusinessObjects Enterprise12.0\win32_x86\dataAccess\connectionServer\cs.cfg

To configure the cs.cfg file, set parameters under the JavaVM tag, asfollows:

<ClassPath><Path>\\data-federator-drivers-install-dir\\OaJd

bcBridge\\oajava\\oasql.jar</Path><Path>\\data-federator-drivers-install-dir\\JdbcDriv

er\\thindriver.jar</Path></ClassPath>

Setting theWeb Intelligence RichClient registry key

To modify the Windows RichClient registry key, use a tool such as regedit.1. In the registry, locate the HKEY_LOCAL_MACHINE\SOFTWARE\Business

Objects\Suite 12.0\default\WebIntelligence\RichClientkey.

2. In this key, add the following values to the classpath value. As with allregistry key values, the values must be separated with a semicolon.• data-federator-drivers-install-dir\OaJdbcBridge\oa

java\oasql.jar

• data-federator-drivers-install-dir\JdbcDriver\thindriver.jar

ConfiguringConnection Server forWeb IntelligenceRich Client and Universe Designer connections toData Federator

It is possible to use a single configuration for creating an ODBC connectionto Data Federator from Universe Designer as well as SAP BusinessObjectsWeb Intelligence Rich Client. In addition to the configuration settingsdescribed previously, do one of the following sets of instructions:• Do the following:



Run regedit tool.1.

2. In the registry, locate theHKEY_LOCAL_MACHINE\SOFTWARE\Business Objects\Suite12.0\default\ConnectionServer\Configuration key.

3. In this key, add the following value to the JVM Library value: bo-install-dir\javasdk\jre6\bin\client\jvm.dll.

• Do the following:1. Open the cs.cfg file for editing.2. Locate the JavaVM tag.3. Set LibraryName to the same JVM directory path specified in the

openrda.ini file:

...<JavaVM><LibraryName JNIVersion="JNI_VERSION_1_4">\\bo-install-dir\\javasdk\\jre6\\bin\\client\\jvm.dll</LibraryName></JavaVM>

Caution:Universe Designer and OpenEdge bridge must specify the same JVMdirectory path.



Configuring data accessglobal parameters

4

About global parametersYou can configure the global parameter values that apply to all connections.You can do this to improve performance, or to resolve issues with theconnection that arise.

Data access global parameters are maintained in the cs.cfg file. This isan XML file that contains Connection Server configuration parameters, anddefault configuration parameters that apply to all data access drivers.

To override these global settings, you can configure settings in each driver's.sbo file.

Related Topics• Configuring driver parameters

About the cs.cfg configuration fileOn a Windows system, the cs.cfg file is stored in the following location:• connectionserver-install-dir\connectionServer

In the cs.cfg file, you can configure parameters in the following sectionsonly:• <Settings>

This section defines Connection Server global configuration parameters,including client access types such as CORBA.

These parameters can be overridden by corresponding settings in thedata access driver configuration file: <driver>.sbo, where <driver>is the name of the data access driver to which the .sbo file relates.

• <Capabilities>

This section defines parameters that allow you to specify the use of localor remote Connection Server.

• <Distribution>

You configure the settings in this section if you use CORBA.


Configuring data access global parameters4 About global parameters

• <JavaVM>

This section defines the default library of the Java Virtual Machine (JVM)used by the data access layer.

• <DriverDefaults>

These parameters apply to all data access drivers.

• <Traces>

You can set trace parameters that allow the recording of connectionactivity through Connection Server in log files. Refer to the release notesfor information on generating traces.

The remaining section, <Locales>, defines the operating system charsetfor each available language. The parameters in this section must not bemodified.

To view and edit the cs.cfg fileYou can view and edit parameters in cs.cfg as follows:

1. Browse to the directory that stores the cs.cfg file. For example, on aWindows system:

connectionserver-install-dir\connectionServer\cs.cfgwhere connectionserver-install-dir is the path where yourConnection Server software is installed.

2. Open cs.cfg in an XML editor.3. Expand sections as required.4. Set parameters by either adding new parameters and values, or modifying

existing parameter values.5. Check that the document is valid against the DTD, then save and close

the file.

Configuring thedriver default parametersThe <DriverDefaults> section of the cs.cfg file contains the default valuesthat apply to all data access drivers. These default values are overridden fora specific driver by corresponding values set in the <driver>.sbo file.


4Configuring data access global parametersTo view and edit the cs.cfg file

Refer to the SBO file parameter reference for information on the parametersthat you can set.Related Topics• Data access configuration files• Configuring driver parameters• SBO parameter categories

Configuring the global settingsparameters

The <Settings> section of cs.cfg defines settings that apply to all drivers,and cannot be customized for individual data access drivers.

The <Settings> parameters are listed alphabetically. To view or editparameters, open cs.cfg in an XML editor, and go to the Settings section,then Parameters section. In the file, each parameter is defined in thefollowing tag:

<Parameter Name="parameter">value</Parameter>

where parameter is the name of the parameter, and value is the value towhich the parameter is set.

Each parameter is shown with the following information:

• example of how the parameter appears in the XML file—when theparameter is available in library and server mode, an example of each isshown

• description of the parameter

• possible values that can be set for the parameter (where applicable)

• default value for the parameter

Charset List Extension

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


Configuring data access global parameters4 Configuring the global settings parameters

Note:Do not change this setting.

Sets the file extension for character set files.Description

crsDefault

Config File Extension

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


Sets the file extension for general configuration files.Description

sboDefault

Description Extension

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


Sets the file extension for the connection descriptionfiles.

Description

codDefault


4Configuring data access global parametersConfiguring the global settings parameters

Enable Failed Load

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

Determines action taken when a driver fails to load.The parameter lets you choose whether you wanta usable connection possibly without all drivers oper-ating, or a fatal error and no functionality when adriver fails to load.

Description

Yes: Connection Server generates a warning messagewhen a driver fails to load.

No: Connection Server generates a fatal error whena driver fails to load.

Values

YesDefault

Related Topics• Load Drivers On Startup

Load Drivers On Startup

Load Drivers On startup applies to both Library and Server modes.

Library

<Settings><Parameter Name="Load Drivers On Startup">No</Parameter>...<Library/>



Server

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

These are described below.

Determines how driver libraries are loaded.Description

• Yes: All installed drivers are loaded during the ini-tialization phase.

• No: Drivers are loaded on demand.Values

Library mode: No

Server mode: YesDefault

Max Pool Time

Max Pool Time is available for Library mode and Server mode.

Library

<Settings><Parameter Name="Max Pool Time">-1</Parameter><Library/>

Server

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

. . .</Server>



Determines the maximum length of time that an un-used connection can remain idle in the connectionpool. This represents an upper bound for connectionlifetimes. A connection pool is a mechanism used bydata access drivers to re-use database connections,to make the best use of system resources.

You can set Max Pool Time for two types of Connec-tion Server deployments:

Library: Value applies to nodes that have ConnectionServer installed with desktop or other server products.

Server: Value applies to Connection Server standalone server installations. For information on deployingConnection Server on a dedicated node see the SAPBusinessObjects Enterprise Deployment PlanningGuide.

Description

Library mode: -1

Server: 60Default

-1: No timeout, keep alive for the whole session.

0: Connection not managed by the pool.

>0: Idle lifetime (in minutes).

Values

SQL External Extension

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




Sets the file extension for external SQL files.Description

rssDefault

SQL Parameter Extension

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


Sets the file extension for SQL parameter files.Description

prmDefault

Strategies Extension

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


Sets the extension for strategy files.Description

stgDefault



Transient Object Timeout

<Parameter Name="Transient Object Timeout">60</Parameter>

Note:Do not change this setting directly. You can changeit from the Central Management Console. See theSAP BusinessObjects Enterprise Administrator'sGuide.

Specifies how many minutes to keep unused tempo-rary objects.

Description

60 (in minutes)Default

Setting the deployment modeThe Capabilities section helps you specify the deployment mode ofConnection Server to be used at runtime.

Beneath Capabilities section, Local name means connectivity serviceis locally provided, as an in-proc library embedded in the client process.CORBA name means Connection Server is provided on a remote server.

You can enable these deployment modes independently by setting the Active attribute. Specific to Local capability, the MixedMode attribute enablesthe use of Java Native Interface (JNI).

Note:A two-way JNI embedded in Connection Server allows APIs to work withConnection Server core developed in a different language. This means youcan use the Java API to work with the C++ core and vice-versa.


Configuring data access global parameters4 Setting the deployment mode

Example:

The following example shows the default values of <Capabilities> inthe cs.cfg file:

<Capabilities><Capability Name="Local" MixedMode="Yes" Active="Yes"/>

<Capability Name="CORBA" Active="Yes"/></Capabilities>

Configuring the deployment modeParameters defined in the <Settings> section of the cs.cfg file controlthe access method.

• Parameters in the <Library> section control library mode. In this mode,Connection Server is included in the client process. Most SAPBusinessObjects applications use Connection Server in library mode.

• Parameters in the <Server> section control CORBA access. In thismode, Connection Server is a CORBA server and is accessed remotely.Connection Server serves two different kinds of clients: HTTP and CORBAclients.

These parameters take precedence over any parameter definitions set inother parts of the <Settings> section. Consequently, the settings definedin the <Server> section override parameters set in other areas forapplications that use <Library> access. These are the following:

• Load Drivers On Startup

The default value of this parameter is Yes. This means all data accessdrivers are loaded at Connection Server startup.

Caution:To avoid connection failures, you must make sure your environmentprovides all the necessary middleware, otherwise you need to modify the<Settings> section by including the network layers and databases youonly need under <ActiveDataSources>. You can also set EnableFailed Load to No.


4Configuring data access global parametersConfiguring the deployment mode

• Max Pool Time• Transient Object Timeout

Related Topics• Configuring the driver to load in server mode• Load Drivers On Startup• Enable Failed Load• Max Pool Time• Transient Object Timeout

Configuring the driver to load in servermode

You configure the cs.cfg file to address complex deployment scenariosinvolving multiple Connection Servers in server mode. Specify the activedatasources to help client applications determine the drivers that eachConnection Server loads and uses. For more information about complexdeployment scenarios, see the SAP BusinessObjects Enterprise DeploymentPlanning Guide.

The <ActiveDataSources> section helps you specify the network layersand associated datasources you want Connection Server to use and expose.This section works as a filter for drivers. Beneath the <ActiveDataSources> section, the <NetworkLayer> elements list the drivers availablefor connection. For each driver, the <DataBase> elements list the namesof the databases Connection Server is able to connect.

If you do not provide any <ActiveDataSources> section or if you leaveit empty, then no filtering is processed. Connection Server loads all theavailable drivers.

Note:You can find the list of available network layers in the driver.cfg file,which is located in the connectionserver-install-dir\connectionServer\ directory. Database names are regular expressions that use GNUregexp syntax. Use the .* pattern to match any character. For moreinformation about regular expressions, refer to the PERL website athttp://www.perl.com/doc/manual/html/pod/perlre.html#Regular_Expressions.


Configuring data access global parameters4 Configuring the driver to load in server mode

http://www.perl.com/doc/manual/html/pod/perlre.html#Regular_Expressions

In addition to these settings, you must configure settings in the <Distribution> section.

Example:

The example illustrates a configuration where Connection Server makesthe following databases available:• any MS SQL Server version through ODBC network layer• any MS Access version through ODBC network layer• Oracle 9 and Oracle 10 through Oracle OCI network layer

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

rameter><Parameter Name="Max Pool Time">60</Parameter><Parameter Name="Transient Object Timeout">60</Pa

rameter><ActiveDataSources><NetworkLayer Name="ODBC"><DataBase Name="MS SQL Server.*$"/><DataBase Name="MS Access.*$"/>

</NetworkLayer><NetworkLayer Name="Oracle OCI"><DataBase Name="Oracle 9"/><DataBase Name="Oracle 10"/>

</NetworkLayer></ActiveDataSources>

</Server>

Related Topics• Configuring the CORBA access protocols

Setting one connectivity per machine

In complex deployment scenarios, you may want to set up one connectivityper type of machine, for example you want to connect SAP BusinessObjectsEnterprise applications to an MS SQL Server database installed on MicrosoftWindows and to an Oracle database installed on a UNIX machine.


4Configuring data access global parametersConfiguring the driver to load in server mode

To avoid connection failures, you need to do one of the following:

• when doing a custom installation of SAP BusinessObjects Enterprisesoftware, specify the connectivities you want to deploy for each type ofdatabase you require, as described on the image below.

• when configuring Connection Server in the cs.cfg file, set the <ActiveDataSources> section for the library mode (<Library> section) asyou do for the server mode (<Server> section).

Because applications first try to establish connections through driversinstalled locally, you should configure the driver filter for both modes inthe same way. For example:

<Library><ActiveDataSources><NetworkLayer Name="ODBC"><DataBase Name="MS SQL Server.*$"/></NetworkLayer><NetworkLayer Name="Oracle OCI"><DataBase Name="Oracle 9"/><DataBase Name="Oracle 8"/></NetworkLayer></ActiveDataSources>


Configuring data access global parameters4 Configuring the driver to load in server mode

</Library><Server><Parameter Name="Load Drivers On Startup">Yes</Parameter><Parameter Name="Max Pool Time">60</Parameter><Parameter Name="Transient Object Timeout">60</Parameter><ActiveDataSources><NetworkLayer Name="ODBC"><DataBase Name="MS SQL Server.*$"/></NetworkLayer><NetworkLayer Name="Oracle OCI"><DataBase Name="Oracle 9"/><DataBase Name="Oracle 8"/></NetworkLayer></ActiveDataSources></Server>

Configuring theCORBAaccess protocolsYou set the following parameters in the <Distribution> section of cs.cfgwhen using Connection Server with CORBA.

The <Protocols> section contains the default values that ConnectionServer uses to process requests coming from CORBA clients or HTTP clients.For CORBA access, configure the section as follows:

<Protocol Name="CORBA" Active="Yes"/><Protocol Name="HTTP" Active="No"/>


4Configuring data access global parametersConfiguring the CORBA access protocols


Configuring data access global parameters4 Configuring the CORBA access protocols

Configuring data accessdriver parameters

5

Configuring driver parametersTo configure data access for a particular data access driver, you can editthe driver's XML parameter files to adjust the parameter settings.

Note:For each SAP BusinessObjects application that uses Connection Server,the associated Readme file contains information on command line utilitiesthat you can use to check your RDBMS and data access driver configuration.These utilities can create log files that trace Web Intelligence server activity.Refer to the readme for the release for instructions on the use of these utilities.

Related Topics• About global parameters

Data access configuration files

The following configuration files control data access driver configurations foreach defined connection:

• The cs.cfg file defines global parameters that apply to all connections.

• There is a separate configuration file for each data access driver. Thesefiles are named <driver>.sbo, where <driver> is the databasenetwork layer to which the configuration file applies.

The parameters set in the Settings section of cs.cfg are overriddenby corresponding settings in the data access driver configuration files:<driver>.sbo

The configuration files are located in the following paths, where connectionserver-install-dir is the directory where the Connection Serversoftware is installed.

• The cs.cfg file is in the following directory:

connectionserver-install-dir\connectionServer\


Configuring data access driver parameters5 Configuring driver parameters

• Each .sbo file is in a sub-directory of this directory, where thesub-directory is named after the database network layer, for example forOracle databases:

connectionserver-install-dir\connectionServer\oracle

Related Topics• About global parameters• Installed SBO files• Configuring the driver default parameters

Installed SBO files

The following <driver>.sbo files are installed by default.

For an up-to-date list of supported drivers, check the SAP ServiceMarketplace website at service.sap.com/bosap-support, or contact your SAPrepresentative.

SBO fileData access driver

essbase.sboEssbase

db2.sbo

iseries.sboIBM DB2

informix.sboInformix

jdbc.sbo

JDBC provides JDBC drivers fordatabases. Check the SAP ServiceMarketPlace website, or the jdbc.sbo file for details of thedatabases supported for JDBC con-nections.


5Configuring data access driver parametersConfiguring driver parameters



odbc.sbo and oledb.sbo

oledb_olap.sbo

Microsoft SQL Server

Microsoft Analysis Services

odbc.sbo

MySQL

Note:MySQL 5 database is available on allplatforms, with Unicode support. Makesure you use the MySQL Connec-tor/ODBC 5.1.4 or higher to connect tothis database. If you use an older ver-sion of the driver on UNIX, you will en-counter errors at runtime.

odbc.sboODBC

oracle.sboOracle

odbc.sboRed Brick

sap.sboSAP

sybase.sboSybase

teradata.sboTeradata


Configuring data access driver parameters5 Configuring driver parameters


open.sbo

Various drivers

Note:When developing a CSV driver usingthe Java Driver Development Kit, youmust locate all your configuration filesin this directory.

To view and edit an SBO file

Caution:Before opening an SBO file, make a backup copy of the file. Someconfiguration parameters must not be edited. If you change or delete themit could affect the operation of your applications.

You can open an SBO file for viewing or editing as follows:

1. Browse to the directory that stores the SBO file for your target data accessdriver.

2. Open the SBO file in an XML editor.3. Expand sections as required.4. Locate the appropriate tag for the value to change, and change the value.

Parameters appear in the format: <Parameter Name="parameter">value</Parameter> where parameter is the name of theparameter, and value is the value attributed to the parameter.

5. Check that the file is valid against the DTD, save and close the file.

Configuring data access for DataDirectODBC branded drivers

Data Access supports the use of branded DataDirect ODBC 5.3 drivers forMS SQL Server databases on all UNIX platforms. These branded DataDirect


5Configuring data access driver parametersConfiguring data access for DataDirect ODBC branded drivers

drivers are provided as part of SAP BusinessObjects Enterprise softwareand can only be used with SAP BusinessObjects applications such as SAPBusinessObjects Web Intelligence, SAP BusinessObjects DesktopIntelligence, and Crystal Reports.

The following middleware and drivers are available for UNIX platforms only:

• MS SQL Server 7.x• MS SQL Server 2000 SP4• MS SQL Server 2005 SP2

These can work with either DataDirect ODBC 5.3 driver or DataDirect ODBC5.3 branded driver.

You can find the DataDirect branded driver files in boe-install-dir/enterprise120/platform-name/odbc/lib directory, where boe-install-dir stands for the SAP BusinessObjects Enterprise installationdirectory and platform-name for the UNIX platform name.

Caution:To use the branded driver, you must make sure the data access is configuredcorrectly.

To enable the use of DataDirect branded drivers

Note:The following section is only related to MS SQL Server 7.x, MS SQL Server2000 SP4 and MS SQL Server 2005 SP2 databases.

Data Access supports the use of DataDirect ODBC 5.3 drivers for MS SQLServer databases on all UNIX platforms. These drivers can be either non-branded or branded drivers.

The Connection Server default settings allow the non-branded ODBC driverto work seamlessly with your current configuration settings. If you havealready deployed a driver in your environment, you will be able to install thenon-branded driver without any configuration change.

1. Navigate to the directory that contains the odbc.sbo file.On UNIX, this configuration file is located in the connectionserver-install-dir/connectionServer/odbc directory.

2. Use an XML editor to open the odbc.sbo file for editing.


Configuring data access driver parameters5 Configuring data access for DataDirect ODBC branded drivers

3. Locate the appropriate DataBase section.The Use DataDirect OEM Driver parameter of the DataBase sectionis set to No by default. This means the data access is configured by defaultto work for non-branded drivers.

4. Set the Use DataDirect OEM Driver parameter of the appropriateDataBase section to Yes and save the file.

5. Add the following path to LD_LIBRARY_PATH environment variable:boe-install-dir/enterprise120/platform-name/odbc/lib

6. Configure the environment by editing the env.sh file in boe-install-dir/setup directory and source it.For example:

DEFAULT_ODBCFILE="${BOBJEDIR}enterprise120/"defaultodbc.iniExport DEFAULT_ODBCFILEODBC_HOME="${BINDIR}/odbc"Export ODBC_HOMEODBCINI="${BOBJEDIR}enterprise120/"defaultodbc.iniExport ODBCINI

Note:DEFAULT_ODBCFILE can point to any file which holds the connectiondetails for the branded drivers.

7. Configure the datasource by editing the defaultodbc.ini file.For example:

[ODBC Data Sources]sql2005=DataDirect 5.3 SQLServer Wire Protocol Driver[sql2005]Driver=/.../enterprise120/solaris_sparc/odbc/lib/CRmsss23.soDescription=DataDirect 5.3 SQLServer Wire ProtocolDriverAddress=10.6.61.197,1433Database=bodb01QuotedId=YesAnsiNPW=NoLogonID=evalkitQEWSD=2454745Password=evalkit

8. Start Connection Server from the CMC.


5Configuring data access driver parametersConfiguring data access for DataDirect ODBC branded drivers

Connection Server is able to establish a connection to MS SQL Serverdatabases with DataDirect ODBC branded drivers.

Example:

The following is an excerpt of the default odbc.sbo file.

<DataBases><DataBase Active="Yes" Name="MS SQL Server 2005"><Libraries>...</Libraries><Parameter Name="Family">Microsoft</Parameter>...<Parameter Name="Use DataDirect OEM Driver" Plat

form="Unix">No</Parameter>...</DataBase></DataBases>


Configuring data access driver parameters5 Configuring data access for DataDirect ODBC branded drivers

SBO parameter reference

6

SBO parameter categoriesThe configuration parameters in this guide are listed in the followingcategories. Each category represents a database that has a separate sbofile.• Defaults

• Informix

• JavaBean

• JDBC

• ODBC

• OLE DB

• OLE DB OLAP

• Sybase ASE/CTLIB


• example of how the parameter appears in the XML file


• possible values that can be set for the parameter


SBO file structureThere is a <driver>.sbo file for each supported database network layer.Each <driver>.sbo file is divided into the following sections:


SBO parameter reference6 SBO parameter categories

DescriptionFile section

This section contains the default configurationparameters that apply to all database middlewarethat uses the data access driver. These parame-ters override any corresponding values set in thedatabase middleware.

Defaults

This section contains a sub-section for eachdatabase middleware that is supported by the dataaccess driver. The Active parameter specifies ifmiddleware support is activated or not.

Values are YES or NO.

Each middleware section can contain the followingparameters:• Name: Names of the middleware supported by

the data access driver. The middleware namevalues set here appear in the Database Middle-ware page of the new connection wizard.

• Aliases: Names of older middleware versionsno longer officially supported by the data ac-cess driver, but that are still in use. You canadd an alias parameter for an older middlewareversion so that existing connections use thecurrent data access driver instead. You can setconfiguration parameters specific to the oldmiddleware as parameters of the new alias.You can create new connections using thealias.

• Parameters: Configuration parameters withvalues that apply specifically to a middleware.Values set for parameters listed here overridethe values set for the same parameters in theDefaults section.

Databases


6SBO parameter referenceSBO file structure

Default SBO parametersThe default SBO parameters are defined in cs.cfg, or under the Defaultssection of the SBO file.Related Topics• SBO parameter categories

Array Bind Available

<Parameter Name="Array Bind Available">True</Parameter>

Specifies whether or not the database supports ArrayBinds.Description

True: the database supports Array Binds.

False: the database does not support Array Binds.Values

FalseDefault

Array Bind Size

<Parameter Name="Array Bind Size">5</Parameter>

Specifies the number of rows exported with each INSERT command.Description

An integer that specifies the number of rows that areexported with each INSERT.Values


SBO parameter reference6 Default SBO parameters

The value set in the cs.cfg file.Default

Array Fetch Available

<Parameter Name="Array Fetch Available">True</Parameter>

Specifies whether or not the Array Fetch method issupported.Description

True: the Array Fetch method is supported.

False: the Array Fetch method is not supported.Values


Array Fetch Size

<Parameter Name="Array Fetch Size">10</Parameter>

Specifies the number of rows of data retrieved witheach Array Fetch method. The optimum number de-pends on your system's performance:• If the number is low, the system retrieves small

amounts of data many times. This can affect per-formance.

• If the number is high, the system performs fewerretrieval operations, but it requires more memoryfor each.

Description


6SBO parameter referenceDefault SBO parameters

An integer that specifies the number of rows that areretrieved with each Array Fetch.

1 : specifies that Array Fetch is deactivated.Values

Value set in the cs.cfg file.Default

Catalog Name Max Size

<Parameter Name="Catalog Name Max Size">1024</Parameter>

Specifies the maximum length in characters of adatabase catelog name.Description

An integer that specifies the maximum database cat-alog name length in characters.Values

The value set in the database middleware.Default

Catalog Separator

<Parameter Name="Catalog Separator">-</Parameter>

Specifies the separator character that is used betweenidentifiers.Description

The separator character to use.Values



If not specified, Connection Server uses the separatorspecified in the database middleware.Default

CharSet

<Parameter Name="CharSet">UTF8</Parameter>

Specifies the character set of the data returned by thedatabase middleware.Description

UTF8: 8-bit UCS/Unicode Transformation Format

UCS2: 2-byte Universal Character SetValues

If not specified, Connection Server uses the separatorspecified in the database middleware.Default

Column Name Max Size

<Parameter Name="Column Name Max Size">1024</Parameter>

Specifies the maximum length in characters of adatabase column name.Description

An integer that specifies the maximum database col-umn name length in characters.Values




Connection Shareable

<Parameter Name="Connection Shareable">False</Parameter>

Note:Do not edit this parameter.

Specifies if a connection is shareable between differ-ent requesters. Operates in conjunction with theShared Connection parameter.

Description

True: the connection can be shared between multipleusers.

False: the connection cannot be shared betweenusers.

Values

FalseDefault

Related Topics• Shared Connection

Cost Estimate Available

<Parameter Name="Cost Estimate Available">False</Parameter>

Specifies if the database middleware supports costestimation.Description



True: the middleware supports cost estimation.

False: the middleware does not support cost estima-tion.

Values

FalseDefault

Description File

<Parameter Name="Description File">oracle</Parameter>


Specifies the name of the file that holds the connectionwizard input field labels.

Description

Driver Capabilities

<Parameter Name="Driver Capabilities">Procedures ,Query</Parameter>



The capabilities of the driver, that is whether it canaccess stored procedures and queries available inthe database software. This parameter is set typicallyusing the New Connection wizard. You can includeboth values in the parameter.

Note:This parameter must be set to Procedures for a Jav-aBeans driver. The functionality of a JavaBeans driveris defined as stored procedures as far as SAP Busi-nessObjects applications are concerned.

Description

Procedures: the driver can access the data retrievalprocedures that are defined in the database software.

Query: the driver can access the data retrieval queriesthat are defined in the database software.

Values

ProceduresDefault

Escape Character

<Parameter Name="Escape Character">-</Parameter>

Specifies the character to use to escape strings ofspecial characters, for example patterns.Description

The character to use as the escape character.Values

If not specified, Connection Server retrieves the valuefrom the middleware.Default



Extensions

<Parameter Name="Extensions"></Parameter>

Note:Do not modify the settings in this parameter.Description

Family

<Parameter Name="Family">Sybase</Parameter>


Specifies the family of the database engine that isdisplayed in the Database Middleware Selection pageof the New Connection wizard. The set of middlewarethat corresponds to your license is displayed on thispage in a tree view.

Description

Field Size Factor

<Parameter Name="Field Size Factor ">1</Parameter>

Note:Do not change this value.

The value to use to compute the size of returnedcontent expressed as field characters when the con-tent is returned as bytes. This is used for DB2 only.

Description



Force Execute

<Parameter Name="Force Execute">Never</Parameter>

Specifies whether or not the SQL query is executedbefore retrieving results. Supported by the following:• ODBC• OLE• DB• JDBC

Description

Never: The SQL query is never executed before re-trieving results.

Procedures: Execute only for stored procedures.

Always: The SQL query is always executed beforeretrieving the results.

Values

NeverDefault

Identifier Case

<Parameter Name="Identifier Case">LowerCase</Parameter>

Specifies how the database handles the case behaviorof simple identifers.Description



LowerCase: identifiers must be in lower case.

UpperCase: identifiers must be in upper case.

MixedCase: identifiers can be in mixed case.

SensitiveCase: identifiers are case sensitive.

Values

If this setting is not specified, Connection Server re-trieves the information from the database middleware.Default

Identifier Quote String

<Parameter Name="Identifier Quote String">-</Parameter>

Specifies the character used to quote identifiers.Description

The character used to quote identifiers.Values


LIKE Escape Clause

<Parameter Name="Identifier Case">True</Parameter>

Specifies if escape character use is supported in theLIKE clause.Description



True: escape character use is supported in the LIKEclause.

False: escape character use is not supported in theLIKE clause.

Values


Locale

<Parameter Name="Locale">en_us</Parameter>

Specifies the locale of the middleware.Description

The locale of the middleware.• language is specified in ISO-639 standard• country is specified in ISO-3166 standardFor example: en_US for English United States.

Values


Max Rows Available

<Parameter Name="Max Rows Available">True</Parameter>



Specifies if the driver supports the Max Rows functionto limit the maximum number of rows that can be re-trieved from a datasource.

Description

True: The driver supports the Max Rows function .

False: The driver does not support the Max Rowsfunction.

Values

FalseDefault

Optimize Execute

<Parameter Name="Optimize Execute">False</Parameter>

Specifies whether or not Connection Server optimizesthe execution of SQL queries. This parameter is sup-ported by Oracle and ODBC drivers only.

Description

True: specifies that where possible, SQL queries areoptimized on execution.

False: SQL queries are not optimized for execution.Values

FalseDefault

Owners Available

<Parameter Name="Owners Available">True</Parameter>



Specifies whether or not Owners are supported bythe target database.Description

True: Specifies that owners are supported by the tar-get database.

False: Specifies that owners are not supported by thetarget database.

Values

Not specified: value retrieved from the database mid-dleware.Default

Password Encryption

<Parameter Name="Password Encryption">True</Parameter>

Specifies whether or not to use the encryption pass-word mechanism specified in the middleware for thepassword entered in the Connection details dialogbox. This parameter is used only with Sybase. It isincluded in the Defaults section for future compatibility.

Description

True: Specifies that the encryption password mecha-nism of the middleware is used.

False: Specifies that the encryption password mech-anism of the middleware is not used.

Values

TrueDefault



Procedure Name Max Size

<Parameter Name="Procedure Name Max Size">1024</Parameter>

Specifies the maximum length in characters of adatabase procedure name.Description

An integer that specifies the maximum database pro-cedure name length in characters.Values


Procedure Parameter Name Max Size

<Parameter Name="Procedure Parameter Name MaxSize">1024</Parameter>

Specifies the maximum length in characters of adatabase procedure parameter name.Description

An integer that specifies the maximum database pro-cedure parameter name length in characters.Values




Qualifiers Available

<Parameter Name="Qualifiers Available">True</Parameter>

Specifies whether or not Qualifiers are supported.Description

True: Specifies that Qualifiers are supported.

False: Specifies that Qualifiers are not supported.Values

Not specified. Connection Server retrieves this infor-mation from the database middleware.Default

Query TimeOut Available

<Parameter Name="Query TimeOut Available">True</Parameter>

Specifies whether or not Query TimeOut is supportedby the database middleware, that is if a query that isrunning can be cancelled after a time period has ex-pired.

Description

True: Specifies that Query TimeOut is supported bythe database middleware.

False: Specifies that Query TimeOut is not supportedby the database middleware.

Values

FalseDefault



Quoted Identifier Case

<Parameter Name="Quoted Identifier Case Available">True</Parameter>

Specifies how the database treats the case of quotedidentifiers.Description

LowerCase: quoted identifiers must be in lower case.

UpperCase: quoted identifiers must be in upper case.

MixedCase: quoted identifiers can be in mixed case.

SensitiveCase: quoted identifiers are case sensitive.

Values

Not specified. Connection Server retrieves the infor-mation from the middleware.Default

Schema Name Max Size

<Parameter Name="Schema Name Max Size">1024</Parameter>

Specifies the maximum length in characters of thedatabase schema name.Description

An integer that specifies the maximum databaseschema name length in characters.Values




Shared Connection

<Parameter Name="Shared Connection">True</Parameter>

Specifies whether or not the requested connection ofa connection pool is shared. Operates in conjunctionwith the Connection Shareable parameter. Is nottaken into account if the Max Pool Time parameterof cs.cfg is set to 0.

Description

True: the connection is shared.

False: the connection is not shared.Values

FalseDefault

Related Topics• Max Pool Time• Connection Shareable

SQL External File

<Parameter Name="SQL External File">filename</Parameter>

Note:Do not edit this value.

The SQL External file file holds configuration detailsused by the data access layer.

Description



SQL Parameter File

<Parameter Name="SQL Parameter File">oracle</Parameter>

The name of the file that stores database parameters.The extension of this file is: .prm

You must ensure that this file is located in the samedirectory as the data configuration file (.sbo file).

Description

See the list of values in the SBO file.Values

The listed values.Default

SSO Available

<Parameter Name="SSO Available">False</Parameter>

Specifies whether or not Single Sign-On (SSO) issupported.Description

True: SSO is supported.

False: SSO is not supported.Values

FalseDefault



Strategies File

<Parameter Name="Strategies File">oracle</Parameter>

Specifies the name, with no extension, of the Strategyfile (.stg). This file contains the external strategiesthat Universe Designer uses for automatic universecreation. Strategy files are stored in the same directoryas the .sbo file.

Description

db2 for DB2 data access drivers.

informix for Informxix.

oracle for Oracle.

sybase for Sybase.

teradata for Teradata.

Values

See values above.Default

Table Name Max Size

<Parameter Name="Table Name Max Size">1024</Parameter>

Specifies the maximum length in characters of adatabase table name.Description

An integer that specifies the maximum database tablename length in characters.Values




Transactional Available

<Parameter Name="Transactional Available">Yes</Parameter>

Specifies if SQL operations run against the databaseare run as block transactions or individually.

This parameter is not listed by default in the .sbo file.Add it to the .sbo file if your data access driver doesnot support transactional mode.

Description

Yes: operations against the database are run as ablock when committed.

No: each SQL statement is immediately committed.That is, Autocommit is de-activated.

Note:Do not use a driver with Transactional Available=No to access the SAP BusinessObjects repos-itory.

Values

Yes. This is set in the cs.cfg file.Default

Transaction Mode

<Parameter Name="Transaction Mode">AutoCommit</Parameter>



Specifies the transaction mode that the database us-es.Description

AutoCommit: statements are committed automaticallyon completion of a request.

Transactional: on competion, an explicit call eithercompletes or rolls back the statement.

Values

If not specified, the value is retrieved from thedatabase middleware.Default

Type

<Parameter Name="Type">Relational</Parameter>

Specifies the data source type.

Note:This parameter must not be modified.

Description

Version

<Parameter Name="Version">Relational</Parameter>

Specifies the database version.

Note:This parameter must not be modified.

Description



XMLMax Size

<Parameter Name="XML Max Size">2048</Parameter>

Specifies the maximum size allowed for XML data.Description

The maximum allowed XML size, in bytes.Values

This varies depending on the database.Default

Informix SBO parametersThese parameters apply to the Informix SBO file. They are used to definethe connection to an Informix database.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\informix\informix.sbo file.

Note:In addition to the SBO parameters, for Informix, in a Unix environment, youmust modify the ODBC.INI file.

Related Topics• V5toV6DriverName• To modify the Informix ODBC.INI file

To modify the Informix ODBC.INI file

In order to use the data access layer with an Informix database in a UNIXenvironment, you need to modify the unicode configuration. This configurationinformation can be in either of the following locations:• The .odbc.ini file located in your home directory.


6SBO parameter referenceInformix SBO parameters

• The file specified by the ODBCINI environment variable.

1. Locate the ODBC.INI file or the file specified by the ODBCINI environmentvariable, and open it in a text editor.

2. In the file, locate the [ODBC] section.3. Add the following line to the [ODBC] section:

UNICODE=UTF-8

4. Close the file and save it.

Example: ODBC section with the configuration added

This code is an example of the ODBC section with the correct informationadded:

[ODBC]UNICODE=UTF-8

V5toV6DriverName

<Parameter Name="V5toV6DriverName">{Informix 3.34 32BIT}</Parameter>

Specifies the conversion rule from Informix Connectto Informix ODBC. The value of this parameter deter-mines which Informix Driver is used to define theODBC Data Source Name (DSN) without the connec-tion string..

Description

The exact name of the Informix driver installed on themachine.Values



SBO parameter reference6 Informix SBO parameters

Unicode

<Parameter Name="Unicode">CharSet</Parameter>

Specifies if the access driver can benefit from theUnicode configuration of the client middleware. Thisparameter appears as a driver default in the cs.cfgfile. Its value applies to all data access drivers. It isnot listed by default in the SBO file. If you want toover-ride the default value you add it to the Defaultssection of the SBO file for the target data accessdriver.

Description

UTF8: 8-bit UCS/Unicode Transformation Formatcoding.

CharSet: Character Set coding.

UCS2: 2-byte Universal Character Set coding

Values


JavaBean SBO parametersThese parameters apply to the JavaBean SBO file. They are used to definea JavaBean connection.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\javabean\javaean.sbo file.

JavaBean Class

<Parameter Name="JavaBean Class">string</Parameter>


6SBO parameter referenceJavaBean SBO parameters

Defines the entry point of the JavaBean that the SAPBusinessObjects application uses. The entry point isthe definition of a java class extending from the Beaninterface specified through the com.businessobjectspackage.

Description

A fully-qualified class JavaBean class name.Values

None.Default

URL Format

<Parameter Name="URL Format ">string</Parameter>

Specifies the URL Format.

The JDBC specification does not specify the formatof the connection string that it requires. Vendors usedifferent kinds of URL format, for example:• MySQL vendor :

jdbc:mysql://$DATASOURCE$/$DATABASE$

• Oracle vendor :

jdbc:oracle:thin:@$DATASOURCE$:$DATABASE$

Description

The URL FormatValues

NoneDefault


SBO parameter reference6 JavaBean SBO parameters

JDBC SBO parametersThese parameters apply to the JDBC SBO file. They are used to define aJDBC connection.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\jdbc\jdbc.sbo file.

ForeignKeys Available

<Parameter Name="ForeignKeys Available">True</Parameter>

Specifies if ForeignKeys can be re-trieved.Description

True: ForeignKeys can be retrieved.

False: ForeignKeys cannot be re-trieved.

Values

TrueDefault

JDBC Class

<Parameter Name="JDBC Class">string</Parameter>

The JDBC driver's fully qualified Java class.Description


6SBO parameter referenceJDBC SBO parameters

Depends on the vendor/datasource, for example :• oracle.jdbc: OracleDriver for Oracle

• com.ibm.db2.jcc.DB2Driver: for DB2Values

None.Default

PrimaryKey Available

<Parameter Name="PrimaryKey Available">True</Parameter>

Specifies whether or not the primary keys can be re-trieved.Description

True: Primary keys can be retrieved.

False: Primary keys cannot be retrieved.Values

TrueDefault

ODBC SBO parametersThese parameters apply to the ODBC SBO file. They are used to define anODBC SBO connection.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\odbc\odbc.sbo file.


SBO parameter reference6 ODBC SBO parameters

Connection Status Available

<Parameter Name="Connection Status Available">True</Parameter>

Specifies whether or not the middleware can detecta bad connection.Description

True: The middleware can detect a bad connection.

False: The middleware cannot detect a bad connec-tion.

Values

The value set in the middleware.Default

Empty String

<Parameter Name="Empty String">NullString</Parameter>

Specifies that certain functions, for example SQL ta-bles, receive either an empty string or a null pointerto replace missing parameters.

Description

NullString: Specifies that a null string is used.

EmptyString: Specifies that an empty string used.Values

EmptyStringDefault


6SBO parameter referenceODBC SBO parameters

Force Close Statement

<Parameter Name="Force Close Statement">True</Parameter>

Specifies that the SQL statement is closed after itcompletes execution.Description

True: the SQL statement is closed after it executes.

False: the SQL statement is not closed after it exe-cutes.

Values

Native Int64 Available

<Parameter Name="Native Int64 Available">False</Parameter>

Indicates if 64 bit integers can be handled directly bymiddleware.Description

True: Specifies that 64-bit integers can be handledby the middleware.

False: The Data Access Layer emulates the Int64methods.

Values

TrueDefault



ODBC Cursors

<Parameter Name="ODBC Cursors">No</Parameter>

Specifies if the ODBC cursor library is used by thedata access driver.Description

Yes: the ODBC cursor library is used by the data ac-cess driver.

No: the ODBC cursor library is not used by the dataaccess driver.

Values


SQLDescribeParam Available

<Parameter Name="SQLDescribeParam Available">True</Parameter>

Specifies whether or not the SQLDescribeParamAvailable mechanism is available.Description

True: Specifies that the SQLDescribeParam Availablemechanism is available.

False: Specifies that the SQLDescribeParam Availablemechanism is not available.

Values



6SBO parameter referenceODBC SBO parameters

SQLMoreResults Available

<Parameter Name="SQLMoreResults Available">True</Parameter>

Specifies whether or not the SQLMoreResults Avail-able mechanism is supported.Description

True: Specifies that the SQLMoreResults Availablemechanism is supported.

False: Specifies that the SQLMoreResults AvailableAvailable mechanism is not supported.

Values


Use DataDirect OEM Driver

<Parameter Name="Use DataDirect OEM Driver">No</Parameter>

Specifies whether connections to MS SQL Serverdatabases use DataDirect ODBC branded drivers.Description

Yes: The connection uses the branded driver.

No: The connection do not use the branded driver.Values

NoDefault



Related Topics• Configuring data access for DataDirect ODBC branded drivers

OLE DB SBO parametersThese parameters apply to the OLE DB SBO file. They are used to definean OLE DB SBO connection.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\oledb\oledb.sbo file.

Enumerator CLSID

<Parameter Name="Enumerator CLSID">MSDASQL Enumerator</Parameter>


Specifies class ID of OLEDB enumerator. This param-eter is used with OLEDB only.

Description

Provider CLSID

<Parameter Name="Provider CLSID">MSDASQL</Parameter>


Specifies class ID of OLEDB provider. This parameteris used with OLEDB only.

Description


6SBO parameter referenceOLE DB SBO parameters

OLE DB OLAP SBO parametersThese parameters apply to the OLE_DB OLAP SBO file. They are used todefine an OLE DB SBO connection for OLAP.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\sqlsrv_as\oledb_olap.sbo file.

MSOlap CLSID

<Parameter Name="MSOlap CLSID">msolap.4</Parameter>


Specifies class ID of OLEDB provider. This parameteris used with OLEDB OLAP only.

Description

Sybase ASE/CTLIBThese parameters apply to the Sybase ASE/CTLIB SBO file. Theseparameters are used to define a Sybase ASE/CTLIB connection.

These parameters are defined in the \\connectionserver-install-dir\connectionServer\sybase\sybase.sbo file.

Quoted Identifier

<Parameter Name="Quoted Identifier">True</Parameter>

Specifies whether or not quoted identifiers are support-ed.Description


SBO parameter reference6 OLE DB OLAP SBO parameters

True: quoted identifiers are supported.

False: quoted identifiers are not supported.Values



6SBO parameter referenceSybase ASE/CTLIB


SBO parameter reference6 Sybase ASE/CTLIB

Configuring SQL generationparameters

7

About SQL generation parametersSQL generation parameters control the SQL queries that are generated toretrieve the contents of a Universe.

You can set these SQL generation parameters to operate at:• the Universe level: you set these parameters when you create or modify

a Universe• the database level: you set these parameters in the PRM file for the

database—these parameters are overriden by any correspondingUniverse-level PRM file settings

To view the date operators, other operators, and functions available for yourdata access driver, open the <driver>.prm file in an XML editor.

About PRM filesThe .prm files contain parameters to control the way SAP BusinessObjectsapplications generate SQL. There is a .prm file corresponding to eachdatabase driver. The .prm files allow database-dependent factors to controlhow a Universe generates SQL, based on the connection and the databasethat it is attached to.

You can also configure some SQL generation parameters from inside auniverse. The settings that you define from within a universe override .prmfile settings.

The .prm file for each driver is found in the connectionserver-install-dir\connectionServer\<RDBMS> directory, where <RDBMS> is thedatabase name.

The following <driver>.prm files are available:


Configuring SQL generation parameters7 About SQL generation parameters

PRM Help text files(English)PRM filesData access driver

datafederatoren.prm

datafederator.prmDatafederator

essbaseen.prmessbase.prmEssbase

hsqldben.prmhsqldn.prmHSQLDB

db2udben.prm

db2mvsen.prm

db2iseriesen.prm

db2udb.prm

db2mvs.prm

db2iseries.prm

IBM DB2

informixen.prminformix.prmInformix

javabeanen.prmjavabean.prmJavabean

jdbcen.prmjdbc.prmJDBC

sqlsrv7en.prm

sqlsrven.prm

sqlsrv7.prm for SQLServer 7 and 2000.

sqlsrv.prm for SQLServer 2005.

sqlsrv_as.rm

for analysis services.


msjeten.prmmsjet.prmMicrosoft Jet


7Configuring SQL generation parametersAbout PRM files


mysqlen.prmmysql.prmMySQL

neoviewen.prmneoview.prmNeoview

netezzaen.prmnetezza.prmNetezza

odbcen.prm

accessen.prm

odbc.prm

access.prmODBC

openen.prmopen.prmOpen

openaccessen.prmopenaccess.prmOpen Access

oracle9en.prm

oracleen.prm

oracle9.prm for Ora-cle 9.

oracle.prm for Oracle10 and higher.

Oracle

postgresqlen.prmpostgresql.prmPostgreSQL

progressen.prmprogress.prmProgress

redbricken.prmredbrick.prmRed Brick


Configuring SQL generation parameters7 About PRM files


asiqen.prm

sybase11en.prm

sybaseen.prm

asiq.prm

sybase11.prm

sybase.prm

Sybase

sapen.prmsap.prmSAP

teradataen.prmteradata.prmTeradata

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

PRM 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 containsparameters that have default values set:


SQL parameters used to create and optimize a universe,for example, COMMA, OUTERJOINS_GENERATION,REVERSE_TABLE_WEIGHT. These parameters are notdirectly available to any SAP BusinessObjects product.They are described in this chapter.

Configuration




Date operators available to Universe Designer, SAPBusinessObjects Desktop Intelligence and SAP Busines-sObjects Web Intelligence, for example YEAR, QUARTER,MONTH.

DateOperations

Operators available to Universe Designer, SAP Busines-sObjects Desktop Intelligence and SAP BusinessObjectsWeb Intelligence, for example ADD, SUBSTRACT, MUL-TIPLY.

Operators


Configuring SQL generation parameters7 About PRM files


Functions available to Universe Designer, SAP Busines-sObjects Desktop Intelligence and SAP BusinessObjectsWeb Intelligence, for example Average, Sum, Variance.

Help text that appears when functions in this section areselected in Universe Designer, SAP BusinessObjectsDesktop Intelligence and SAP BusinessObjects Web In-telligence is listed in the file <driver><language>.prm, forexample, oracleen.prm. This file is found in the same di-rectory as the <driver>.prm file. You can open it to viewdescriptions of all the functions available in the <driv-er>.prm file.

The Function section has the following subsections:• Group: whether the usage of this function in a query

generates a group by clause.• True sets that the query generates a group by

clause.

• False sets that the query does not generate agroup by clause.

• ID: In Reporter, this is the name that appears in thefunction list.

• InMacro: In Reporter, if this value is True, then thefunction is listed in the User Objects function list andif it is False then the function is not listed.

• Type: Function data type.

• Arguments: Arguments accepted by the function. Afunction can have a maximum of only four arguments,and any additional arguments are not taken into ac-count.

• SQL: The SQL syntax for the function.

Functions



Note:Only the Configuration section is documented here. The Configuration sectionparameters can be edited to optimize queries run against universes usingthe target data access driver.

Related Topics• To view and edit a function help text file

To view and edit a PRM fileYou 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 accessdriver. PRM files are stored here:

connectionserver-install-dir\connectionServer\<rdbms>\<driver>.prm

2. Open a <driver>.prm file in a XML editor.3. Expand sections as required.4. Set values by entering the value in the appropriate tag.5. Save and close the file.

To view and edit a function help text fileThe Help text that appears under each function when selected in UniverseDesigner is maintained in a separate XML file. You can edit and add text todescribe a function by editing the file <driver><language>.prm. There is aHelp text file for each language version of SAP BusinessObjects productsinstalled.

The Help text appears when a function that is stored in the PRM file isselected in Universe Designer:

When you add a function to the PRM file, you need to add the Help text forthe 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 functionname and the Help text for the function to the oracleen.prm file, if you areworking with the English version of Universe Designer.


Configuring SQL generation parameters7 To view and edit a PRM file

To edit the help text for a PRM function1. Browse to the directory that stores the PRM language file for your target

data access driver. PRM language files are stored here:

connectionserver-install-dir\connectionServer\<rdbms>\<driver><language>.prm

For example, oracleen.prm.

2. Open a <driver><language>.prm file in a XML editor.3. Expand the Messages section.4. To add Help for a new function do the following:

• Add a new section for a function. The easiest way to do this is to copyan existing function entry and copy it into the Function section. Youthen edit the new function text.

• Enter Help text for the function.

5. To view or edit existing function Help text, do the following:• Expand the Function section.

• Expand the Message section for a function.

• Edit Help text as required.

6. Save and close the file.


7Configuring SQL generation parametersTo edit the help text for a PRM function


Configuring SQL generation parameters7 To edit the help text for a PRM function

PRM parameter reference

8

PRM file configuration referenceThe Configuration SQL parameters are listed alphabetically. To viewfunctions, date operators, and other operators available, open a <driver>.prmfile 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 valueattributed to the parameter.


• example of how the parameter appears in the XML file


• possible values that can be set for the parameter


Note:Certain configuration parameters must not be edited. These parametershave values set for use internally within SAP BusinessObjects solutions.These parameters are described in this section but contain a warning not toedit the value. You must not edit these parameters. Before editing any otherPRM file parameter, you should make a backup copy of the PRM file.

BACK_QUOTE_SUPPORTED

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

Specifies whether or not to enclose table or columnnames containing spaces or special characters withbackquotes.

Description

Y : Encloses table and column name with backquotes.

N : Does not insert quotes around table and columnnames.

Values


PRM parameter reference8 PRM file configuration reference

YDefault

Table name=`My Table`Result

CASE_SENSITIVE

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

Specifies if the database is case sensitive. Parameterused with Oracle.Description

Y : Specifies that the database is case sensitive.

N : Specifies that the database is not case sensitive.Values

NDefault

CHECK_OWNER_STATE

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

Specifies if the SQL checks if the database supportstable classification by owner name.Description

Y: The SQL checks if the database supports tableclassification by owner name.

N: The SQL does not check if the database supportstable classification by owner name.

Values


8PRM parameter referencePRM file configuration reference

YDefault

CHECK_QUALIFIER_STATE

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

Specifies if the SQL checks if the database supportstable classification by qualifier.Description

Y: Checks if the database supports table classificationby qualifier.

N: Does not check if the database supports tableclassification by qualifier.

Values

YDefault

COMMA

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

Specifies what database concatenation operatorshould be used to replaces a comma for objects thathave the following syntax:

Tab.Col1, Tab.Col2.

Parameter is used with all data access drivers.

Description



||' '||

+' '+Values

||' '||Default

Tab.Col1||' '||Tab.Col2Result

CONCAT

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

Specifies the concatenation operator. The parameteris used with all data access drivers.Description

||

+Values

||Default

CONSTANT_SAMPLING_SUPPORTED

CONSTANT_SAMPLING_SUPPORTED

Specifies if the database supports random sampling.Description



Yes: The database supports random sampling.

No: The database does not support random sampling.Values

YesDefault

DATABASE_DATE_FORMAT

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

For Oracle only. Specifies the default date and hourformats stored on the server.Description

DD-MM-YYYY HH24:MI:SSValues

DD-MM-YYYY HH24:MI:SSDefault

DATATYPE_BLOB

Name="Datatype_Blob">LONGVARCHAR</Parameter>


Column database datatype for Blob object. This pa-rameter is not used for this release. It is included forfuture compatibility.

Description



DATATYPE_DOUBLE

<Parameter Name="Datatype_Double">: Value depends on thedatabase.


Column database datatype for Date object (CREATEtable command)

Description

DATATYPE_DTM

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


Column database datatype for Date object (CREATEtable command)

Description

DATATYPE_INT

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


Column database datatype for Numeric object (CRE-ATE table command)

Description



DATATYPE_NULL

<Parameter Name="Datatype_Null"/>


Database SQL syntax for Null values (INSERT com-mand)

Description

DATATYPE_STRING

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


Column database datatype for Character and Longobject (CREATE table command).

Description

DATE_WITHOUT_QUOTE

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

Specifies support for dates without single-quotes inthe SQL syntax.

Parameter is used with MS Access.Description



Y: Dates are not surrounded by single-quotes.

N: Dates are surrounded by single-quotes.Values

YDefault

DELIMIT_IDENTIFIERS

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

Specifies if the quotation marks set in the IDENTIFI-ER_DELIMITER parameter are used to enclose tableand column names.

Description

YES: The delimiter specified in IDENTIFIER_DELIM-ITER is used.

NO: The delimiter specified in IDENTIFIER_DELIM-ITER is not used.

Values

YESDefault

Table name="my_table"Result

EXT_JOIN

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



Specifies if outer joins are supported.

This parameter is used by all data access drivers.Description

YES: The database supports outer joins.

NO: The database does not support outer joins. TheOuter join check boxes in the Edit Join dialog boxof Universe Designer are dimmed.

Values

YESDefault

EXT_JOIN_INVERT

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

Specifies how to display an outer join symbol in a joinexpression.

This parameter is used with IBM DB2, Informix, Ora-cle, and Teradata.

Description

YES: When you click an Outer join check box in theEdit Join dialog box of Universe Designer, the outerjoin symbol appears reversed in position in a join ex-pression.

NO: When you click an Outer join check box in theEdit Join dialog box of Universe Designer, the outerjoin symbol appears on the same side on which youcreated the outer join.

Values

YESDefault



EXTERN_SORT_EXCLUDE_DISTINCT

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

Specifies whether or not the application generates aSELECT DISTINCT when a query contains an OR-DER BY.

Description

Y: A SELECT DISTINCT is not generated when thequery contains an ORDER BY.

N: A DISTINCT is generated when the query containsan ORDER BY.

Values

YDefault

GROUPBY_EXCLUDE_COMPLEX

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

Specifies whether the database allows you to enterformulas, aliases or indexes in GROUP BY clauses.

Parameter is used with IBM DB2.Description



Y: Specifies that the database does not allow you toenter formulas, aliases or indexes in GROUP BYclauses. If you run a query containing measure objectsand complex objects (e.g. with the substring functionor the concatenation operator), your application dis-plays the following error message: Your databasedoes not allow you to do aggregationswith the <object name> object.

N: Specifies that the database does allow you to enterformulas, aliases or indexes in GROUP BY clauses.

Values

NDefault

GROUPBY_WITH_ALIAS

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

Specifies whether the database can create a GROUPBY clause in the SELECT statement.

Parameter is used with Red Brick.Description

Y: Allows you to create a GROUP BY clause in theSELECT statement. An alias would be used for exam-ple to replace a T1.col + T2.col +...Tn.col n .colstatement.

N: Does not let you to create a GROUP BY clause inthe SELECT statement.

Values

YDefault



GROUPBY_WITHOUT_CONSTANT

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

Specifies whether or not you authorize the addition ofobjects whose SQL definition is a constant in aGROUP BY clause. Parameter is used by IBM DB2and Microsoft SQL Server

Description

Y: Specifies that you can add any constant object tothe query but it will not be present in the GROUP BYclause.

N: Specifies that you can insert all the objects of aquery (i.e. without aggregate functions) in a GROUPBY clause.

Values

YDefault

GROUPBYCOL

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

Specifies whether a GROUP BY clause accepts inte-gers for column names.Description



YES: Specifies that a GROUP BY clause accepts acolumn's index from the SELECT instead of column'sname.

NO: Specifies that a GROUP BY clause does not ac-cepts a column's index from the SELECT instead ofcolumn's name.

Values

NODefault

IDENTIFIER_DELIMITER

<Parameter Name="IDENTIFIER_DELIMITER">"</Parameter>

Specifies that:• table or column names that contain spaces or special

characters are enclosed within quotation marks if theparameter BACK_QUOTE_SUPPORTED is activated.

• tables or column names regardless of their charactersare enclosed within quotation marks if the parameterDELIMIT_IDENTIFIERS is activated.

To use this parameter, either BACK_QUOTE_SUP-PORTED or DELIMIT_IDENTIFIERS must be set toYES. This is the default value of both parameters.

Description

": Table or column names that contain spaces orspecial characters are enclosed in double quotationmarks.

': Table or column names that contain spaces or spe-cial characters are enclosed in single quotation marks.This value can be used only with Microsoft Access.

Values



"Default

Table name="My Table"Result

IF_NULL

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

Specifies a function that takes two parameters. If thefirst parameter returns NULL, the second parametervalue is used.

Description

Database-dependent.Values

Database-dependent.Default

INTERSECT

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

Specifies if the database supports the INTERSECTset operator.Description



INTERSECT: The database supports the INTERSECTset operator.

No value: The database does not support the INTERSECT set operator. In this case, two queries aregenerated.

Values

INTERSECTDefault

KEY_INFO_SUPPORTED

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

Specifies if you can retrieve primary and secondarykey definitions from the database account.Description

Y: Specifies that the database lets you retrieve primaryand secondary key definitions from the database ac-count. This parameter enables Universe Designer todisplay the keys in the Structure window.

N: Specifies that the database does not let you retrieveprimary and secondary key definitions from thedatabase account.

Values

YDefault

LEFT_OUTER

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



<Parameter Name="LEFT_OUTER">$*</Parameter>

Specifies the left outer join syntax.Description

$(+) This syntax is used with Oracle. $ represents ajoin expression.

$* This syntax is used with Sybase, MS SQL Serverand Red Brick. $ represents a join expression.

Values


LENMAXFORCOLUMNNAME

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


Maximum length for column name (by default the ob-ject name is proposed) (CREATE table command)

Description

LENMAXFORTABLENAME

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


Maximum length for VARCHAR column datatype(CREATE table command).

Description



LENMAXFORVARCHAR

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


Maximum length for VARCHAR column datatype(CREATE table command).

Description

MINUS

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

Specifies if the database supports the MINUS setoperator.Description

MINUS Specifies that the database supports the MI-NUS set operator.

EXCEPT Specifies that the database supports theMINUS set operator.

no value Specifies that the database does not supportthe MINUS set operator. In this case, two queries aregenerated.

Values

MINUSDefault



NO_DISTINCT

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

Specifies if the database supports the DISTINCTkeyword.

This parameter is used with MS Access.Description

Y: Specifies that the database does not support theDISTINCT keyword. This behavior disables:• The Distinct Values option that appears when

you click the View Values button in the QuickDesign wizard.

• The Countdistinct function that appears when youcreate a condition with the Calculation operand inthe Query Panel.

N: Specifies that the database does support the DISTINCT keyword.

Values

YDefault

NULL_IN_SELECT_SUPPORTED

<Parameter Name="NULL_IN_SELECT_SUPPORTED">Yes</Parameter>

Specifies if the database supports NULL as a columnin the SELECT statement.Description



Yes: NULL is supported as a column in the SELECTstatement.

No: NULL is not supported as a column in the SELECT statement.

Values

Yes

No for Teradata, DB2, Informix and Red Brickdatabases, which do not support the NULL value ascolumn.

Default

OLAP_CLAUSE

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

Specifies whether SAP BusinessObjects applicationsgenerate a WHEN or QUALIFY clause if a functionlisted in the RISQL_Functions parameter is used ina condition. This parameter must be used with theGROUPBY clause.

Description

WHEN: Generates a WHEN clause if a function listedin the RISQL_Functions parameter is used in a condi-tion. This is the default value for Red Brick databases.

QUALIFY: Generates a QUALIFY clause if a functionlisted in the RISQL_Functions parameter is used in acondition. This is the default value for Teradatadatabases.

Values




OUTERJOINS_GENERATION

<Parameter Name="OUTERJOINS_GENERATION">ANSI92</Parameter>

This parameter controls the default outer join generation behavior. You canset that• Outer join generation conforms to the ANSI92 specification.

• Outer join generation remains the same as for previous versions ofUniverse Designer.

Note:The PRM file OUTERJOINS_GENERATION parameter relates to the universeANSI92 setting in the following way:• If the PRM file OUTERJOINS_GENERATION parameter is set to ANSI92

and the universe ANSI92 setting is set to NO, the PRM parameteroverrides the universe setting and outer joins conform to ANSI92 behavior.

• If the PRM file OUTERJOINS_GENERATION parameter is set to USUAL,then the universe ANSI92 setting takes precedence, and outer joinsconform to ANSI92 depending on whether the universe ANSI92 settingis YES or NO.

Remember:The ANSI92 value makes REVERSE_TABLE_WEIGHT parameter not usefulfor optimization of SQL generation. Outer joins that conform to ANSI92behavior leads the order of the tables in the SQL sentence.



Specifies the SQL syntax for outer joins.

The ANSI92 value generates an outer join in theFROM clause. Other values generate the outer joinin the WHERE clause.

When you modify this setting, you should check joinproperties to verify that the outer join expression isvalid, and that the cardinalities are correct. ANSI92does not support any manual customization in the joinsyntax.

Description

The primary values for OUTERJOINS_GENERATIONare:• ANSI92: The default outer join behavior conforms

to the ANSI92 standard no matter what the ANSI92parameter value of Universe Designer.

• No: Outer joins are not supported.

• USUAL: The default outer join behavior is the sameas with previous versions of Universe Designer.This behavior is overridden if ANSI92 parameterof Universe Designer is set to Yes.

Other settings are available depending on thedatabase. See the defaults below.

Values



ANSI_92: Default value for Oracle, SQL Server 2005and Sybase.

DB2: Default value for IBM DB2.

FULL_ODBC: Can be used with Microsoft SQL Server

INFORMIX: Default value for Informix.

INGRES: Default value for Teradata.

NO: Default value for ODBC.

USUAL: Default value for Neoview, Netezza, RedBrick, SQL Server 2000.

Default

Examples of OUTERJOINS_GENERATION parameter settings

Setting = USUAL:

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

Setting = DB2:

FROM T2 LEFT OUTER JOIN T1ON T1.col1 = T2.col2

Setting = ODBC:

FROM {oj T1 LEFT OUTER JOIN T2 ON T1.col1=T2.col2}Where (T2.col3 = T3.col1)

Setting = INFORMIX

FROM T2OUTER T1WHERE T1.col1=T2.col2



Setting = FULL-ODBC

FROM {oj T1 RIGHT OUTER JOIN T2 ON T2.col2=T1.col1T2 INNER JOIN 3 on T2.col3 = T3.col1}

Setting = ANSI_92:

SELECT DISTINCTt1.col1,t2.col2

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

Using OUTERJOINS with Oracle

The default OUTERJOINS_GENERATION setting (ANSI92) can affect thebehavior of existing universes irrespective of the universe-level setting forthe ANSI92 parameter.

To set that your existing Oracle universes behave as with the previousUniverse Designer versions:1. In the PRM file, ensure that the OUTERJOINS_GENERATION parameter

is set to USUAL.

2. In the PRM file , set the LEFT_OUTER and RIGHT_OUTER parameters to$(+)

For more information about universe SQL parameters and PRM files inprevious versions of Universe Designer, see the Designer's Guide.Related Topics• LEFT_OUTER• RIGHT_OUTER• REVERSE_TABLE_WEIGHT• About SQL generation parameters

OVER_CLAUSE

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



Allows SAP BusinessObjects applications to includeRISQL functions when generating SQL. The supportedRISQL functions for the database are listed in theRISQL_FUNCTIONS parameter.

Description

Y: applications can include RISQL functions whengenerating SQL.

N: applications cannot include RISQL functions whengenerating SQL.

Values

YDefault

OWNER

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

Specifies if the database authorizes to prefix tablesby the owner name.Description

Y: Specifies that the database supports prefixing ta-bles by the owner name.

N: Specifies that the database does not support pre-fixing tables by the owner name.

Values

YDefault



PERCENT_RANK_SUPPORTED

<Parameter Name="PERCENT_RANK_SUPPORTED">Yes</Parameter>

Specifies if the Percent Rank analytical function issupported by the database.Description

Yes: the Percent Rank analytical function is supportedby the database.

No: the Percent Rank analytical function is not sup-ported by the database.

Values

YesDefault

PREFIX_SYS_TABLE

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

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

Specifies if the system tables are displayed in Uni-verse Designer. This parameter is found in the access.prm file and redbrick.prm file.

Description



MSys: Specifies that the MS Access system tablesare hidden in the Universe Designer table browser.Default value for MS Access.

RBW_ :Specifies that the Red Brick system tables arehidden in the Universe Designer table browser. Defaultvalue for Red Brick.

no value Specifies that the database system tablesare displayed in the Universe Designer table browser.

Values


QUALIFIER

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

Specifies whether the database authorizes to prefixtables by the qualifier name.Description

Y: Specifies that the database does support prefixingtables by the qualifier name.

N: Specifies that the database does not support pre-fixing tables by the qualifier name.

Values

RDBMS dependant.Default

QUOTE_OWNER

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



Specifies whether or not an owner name should bein single quotes. Used by Informix only.Description

Y: Specifies that table names are prefixed by anowner name in single quotes. This is mandatory foran ANSI compliant Informix database. If not, Informixconverts the owner name to upper case characters.

N: Specifies that table names are not prefixed by anowner name in single quotes.

Values

YDefault

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

FROM 'Owner'.table.col AliasResult

RANK_SUPPORTED

<Parameter Name="RANK_SUPPORTED">Yes</Parameter>

Specifies if the Rank analytical function is supportedby the database.Description

Yes: the Rank analytical function is supported by thedatabase.

No: the Rank analytical function is not supported bythe database.

Values

YesDefault



REFRESH_COLUMNS_TYPE

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

Indicates how columns are refreshed.Description

O: Columns are refreshed by owner name. This is thedefault value with Oracle.

Q: Columns are refreshed by qualifier name. This isthe default value with Red Brick, Sybase, MS SQLServer and MS Access.

T: Columns are refreshed by table name.

Values

See Values above.Default

REVERSE_TABLE_WEIGHT

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

Specifies in which order tables are to be generated.This parameter is used with Oracle. This parametercan also be used with some other databases, possiblywith the Y and N reversed.

This parameter is not supported for Teradata.

Note:If OUTERJOINS_GENERATION parameter is set to ANSI92 or if the universe ANSI92 setting is set to YES,then REVERSE_TABLE_WEIGHT parameter does notaffect the optimization of SQL generation.

Description



N: Specifies that tables are generated from the largestto the smallest.

Y: Specifies that tables are generated from thesmallest to the largest.

Values

YDefault

Related Topics• OUTERJOINS_GENERATION

RIGHT_OUTER

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

<Parameter Name="RIGHT_OUTER">*$</Parameter>

Specifies the right outer join syntax.Description

$(+): Used with Oracle. $ represents a join expression.

*$:Used with Sybase, MS SQL Server and Red Brick.$ represents a join expression.

Values


RISQL_FUNCTIONS

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



Lists the RISQL functions supported by the database.Description

• Oracle default list:RANK,SUM,AVG,COUNT,MIN,MAX,RATIO_TO_REPORT,CUME_DIST,CORR,DENSE_RANK,FIRST_VALUE,LAST_VALUE,LAG,LEAD,NTILE,PERCENT_RANK,PERCENTILE_CONT,PERCENTILE_DISC,ROW_NUMBER,CORR,COVAR_POP,COVAR_SAMP,REGR_SLOPE,REGR_INTERCEPT,REGR_COUNT,REGR_R2,REGR_AVGX,REGR_AVGY,REGR_SXX,REGR_SYY,REGR_SXY,STDDEV,STDDEV_POP,STDDEV_SAMP,VAR_POP,VAR_SAMP,VARIANCE

• BM DB2 default list:RANK,SUM,AVG,COUNT,MIN,MAX

• Teradata default list: CSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANTILE

• Red Brick default list: CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTOREPORT,TERTILE

Values


SEED_SAMPLING_SUPPORTED

<Parameter Name="SEED_SAMPLING_SUPPORTED">Yes</Parameter>

Specifies if seed-based random sampling capabilityis supported by the database.Description



Yes: seed-based sampling is supported by thedatabase.

No: seed-based sampling is not supported by thedatabase.

Values

NoDefault

SORT_BY_NO

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

Specifies if users are authorized to sort on columns(represented as objects in the universe) that are notincluded in the SELECT statement.

Description

YES: Specifies that users are not authorized to sorton columns if they are not included in the SELECTstatement. When the parameter is set to YES, theManage Sorts button is dimmed in the Query Panel.

NO: Specifies that you are authorized to sort oncolumns even if they are not included in the SELECTstatement.

Values

NODefault

UNICODE_PATTERN

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



SQL Server and Oracle only.

Only applies when the universe SQL generation pa-rameter UNICODE_STRINGS is set to Y. All condi-tions based on strings are then formatted with thisstring value.

Description

Microsoft SQL Server: N$

Oracle: UNISTR($)Default

UNICODE_PATTERN=N$Example

UNION

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

Specifies if the database supports the UNION setoperator.Description

UNION: The database supports the UNION set oper-ator.

no value : The database does not support the UNIONset operator. In this case, two queries are generated.

Values

UNIONDefault



USER_INPUT_DATE_FORMAT

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

Specifies the default date and hour formats generatedin the WHERE clause of a SQL script.Description

{\d 'yyyy-mm-dd'} This is the default date format withODBC.

'DD-MM-YYYY HH:MM:SS' This is the default dateand hour formats with Oracle.

'MM/DD/YYYY' This is the default date format withInformix.

'yyyy-mm-dd HH:mm:ss' This is the default date andhour formats with MS SQL Server and for most IBMDB2 servers.

'mm/dd/yyyy hh:m:s am/pm' This is the default dateand hour formats with Sybase.

'yyyy-mm-dd' This is the default date format with aSybase gateway.

Note:If you need to use time or timestamp variables withODBC, you must replace the default date format valuewith: {\t 'hh:mm:ss'} or {\t\s 'yyyy-mm-dd hh:mm:ss'} inthe odbc.sbo file.

Values




USER_INPUT_NUMERIC_SEPARATOR

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

Specifies the default decimal separator that is usedin the generated SQL script.Description

'.'Values

'.'Default



Data type conversionreference

9

Data type conversionThis chapter contains data conversion tables for each supported RDBMS.SAP BusinessObjects 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 futureupdates of the Data Access guide.

IBM DB2

The following table lists the IBM DB2 internal data types and their equivalentin SAP BusinessObjects solutions:

SAP BusinessObjects datatypeIBM DB2 datatype

LONG TEXTCLOB


Data type conversion reference9 Data type conversion

SAP BusinessObjects datatypeIBM DB2 datatype

CHARACTERCHARACTER

DATEDATE

NUMBERDECIMAL

NUMBERDOUBLE

NUMBERFLOAT

NUMBERINTEGER

LONG TEXTLONG VARCHAR

NUMBERNUMERIC

NUMBERSMALLINT

DATETIME

DATETIMESTAMP

CHARACTERVARCHAR


9Data type conversion referenceData type conversion

Informix

The following table lists the Informix internal data types and the equivalentin SAP BusinessObjects solutions:

SAP BusinessObjects datatypeInformix datatype

CHARACTERCHAR

DATEDATE

DATEDATETIME

NUMBERDECIMAL

NUMBERFLOAT

NUMBERINTEGER

NUMBERMONEY

CHARACTERNCHAR

CHARACTERNVARCHAR

NUMBERSERIAL

NUMBERSMALLINT



SAP BusinessObjects datatypeInformix datatype

NUMBERSMALLFLOAT

LONG TEXTTEXT

CHARACTERVARCHAR


The following table lists the Microsoft SQL Server internal data types andtheir SAP BusinessObjects equivalent.

SAP BusinessObjects datatypeMicrosoft SQL Server datatype

NUMBERBIT

NUMBERBOOLEAN

CHARACTERCHAR

DATEDATETIME

NUMBERDECIMAL

NUMBERFLOAT



SAP BusinessObjects datatypeMicrosoft SQL Server datatype

NUMBERINT

NUMBERMONEY

NUMBERNUMERIC

NUMBERREAL

DATESMALLDATETIME

NUMBERSMALLINT

NUMBERSMALLMONEY

CHARACTERTEXT

NUMBERTINYINT

CHARACTERVARCHAR

Oracle

The following table lists the Oracle internal datatypes and their equivalent inSAP BusinessObjects solutions.



SAP BusinessObjects datatypeOracle datatype

CHARACTERCHAR

LONG TEXTCLOB

DATEDATE

NUMBERFLOAT

NUMBERINTEGER

LONG TEXTLONG

NUMBERNUMBER

CHARACTERVARCHAR

CHARACTERVARCHAR2

Red Brick

The following table lists the Red Brick internal data types and their SAPBusinessObjects equivalent.



SAP BusinessObjects datatypeRed Brick datatype

CHARACTERCHAR

DATEDATE

NUMBERDECIMAL

NUMBERFLOAT

NUMBERINTEGER

NUMBERNUMERIC

NUMBERSMALLINT

DATETIME

DATETIMESTAMP

ToaddTIMEandTIMESTAMPsupport in aWHEREclause

Objects that use the TIME and TIMESTAMP data type are not supported ina WHERE clause for queries run against a Red Brick database. You can setthe properties of an object in a universe to support the use of TIME andTIMESTAMP in the WHERE clause as follows:

To support TIME or TIMESTAMP datatype object in WHERE clause:



1. From Universe Designer, double-click an object in the Universe pane.

The Edit Properties of Object dialog box appears.

2. Click the Definition tab.3. Select Date from the Type drop down list.4. Click the Advanced tab.5. In the Database Format text box type the following information:

TypeFor...

HH:MM:SSTIME support

MM/DD/YYYY HH:MM:SSTIMESTAMP support

6. Click OK.

Sybase

The following table lists the Sybase internal datatypes and their equivalentin SAP BusinessObjects solutions.

SAP BusinessObjects datatypeSybase datatype

NUMBERBIT

CHARACTERCHAR

DATEDATETIME

NUMBERDECIMAL



SAP BusinessObjects datatypeSybase datatype

NUMBERFLOAT

NUMBERINT

NUMBERMONEY

NUMBERNUMERIC

NUMBERREAL

DATESMALLDATETIME

NUMBERSMALLINT

NUMBERSMALLMONEY

NUMBERTINYINT

CHARACTERVARCHAR

Teradata

The following table lists the Teradata internal datatypes and their equivalentin SAP BusinessObjects solutions.



SAP BusinessObjects datatypeTeradata datatype

DATEDATE

NUMBERDECIMAL

NUMBERFLOAT

NUMBERINTEGER

NUMBERSMALLINT

NUMBERBYTEINT

DATEDATETIME

CHARACTERVARCHAR



More Information

A

LocationInformation Resource

http://www.sap.comSAP BusinessObjects productinformation

Select http://help.sap.com > SAP BusinessObjects.

You can access the most up-to-date documentation cover-ing all SAP BusinessObjects products and their deploymentat the SAP Help Portal. You can download PDF versionsor installable HTML libraries.

Certain guides are stored on the SAP Service Marketplaceand are not available from the SAP Help Portal. Theseguides are listed on the Help Portal accompanied by a linkto the SAP Service Marketplace. Customers with a mainte-nance agreement have an authorized user ID to accessthis site. To obtain an ID, contact your customer supportrepresentative.

SAP Help Portal

http://service.sap.com/bosap-support > Documentation• Installation guides: https://service.sap.com/bosap-inst

guides• Release notes: http://service.sap.com/releasenotes

The SAP Service Marketplace stores certain installationguides, upgrade and migration guides, deployment guides,release notes and Supported Platforms documents. Cus-tomers with a maintenance agreement have an authorizeduser ID to access this site. Contact your customer supportrepresentative to obtain an ID. If you are redirected to theSAP Service Marketplace from the SAP Help Portal, usethe menu in the navigation pane on the left to locate thecategory containing the documentation you want to access.

SAP Service Marketplace

https://boc.sdn.sap.com/

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibraryDeveloper resources


More InformationA

http://www.sap.com

http://help.sap.com/


https://service.sap.com/bosap-instguides

https://service.sap.com/bosap-instguides

http://service.sap.com/releasenotes

https://boc.sdn.sap.com/

https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary

LocationInformation Resource

https://www.sdn.sap.com/irj/boc/businessobjects-articles

These articles were formerly known as technical papers.

SAP BusinessObjects articleson the SAP Community Net-work

https://service.sap.com/notes

These notes were formerly known as Knowledge Base ar-ticles.

Notes

https://www.sdn.sap.com/irj/scn/forumsForums on the SAP Communi-ty Network

http://www.sap.com/services/education

From traditional classroom learning to targeted e-learningseminars, we can offer a training package to suit yourlearning needs and preferred learning style.

Training


The SAP Support Portal contains information about Cus-tomer Support programs and services. It also has links toa wide range of technical information and downloads.Customers with a maintenance agreement have an autho-rized user ID to access this site. To obtain an ID, contactyour customer support representative.

Online customer support

http://www.sap.com/services/bysubject/businessobjectsconsulting

Consultants can accompany you from the initial analysisstage to the delivery of your deployment project. Expertiseis available in topics such as relational and multidimensionaldatabases, connectivity, database design tools, and customized embedding technology.

Consulting


AMore Information

https://www.sdn.sap.com/irj/boc/businessobjects-articles

https://service.sap.com/notes

https://www.sdn.sap.com/irj/scn/forums

http://www.sap.com/services/education





More InformationA

IndexAANSI92 SQL syntax 155architecture, system 15Array Bind Available 90Array Bind Size 90Array Fetch Available 91Array Fetch Size 91

BBACK_QUOTE_SUPPORTED 136Blob_Comparison 137Boundary_Weight_Table 137branded drivers 83

CC++ drivers 46Case_Sensitive 137CASE_SENSITIVE 137Catalog Name Max Size 92Catalog Separator 92CFG file

ActiveDataSources section 74Capabilities section 72Charset List Extension 66Config File Extension 67DataBase element 74Description Extension 67Distribution section 77DriverDefaults section 65editing 65Enable Failed Load 68Library section 73

CFG file (continued)Load Drivers On Startup 68Max Pool Time 69NetworkLayer element 74Protocols parameters 77Server section 73settings parameters reference 66SQL External Extension 70SQL Parameter Extension 71Strategies Extension 71Transient Object Timeout 72viewing 65

CharSet 93Charset List Extension 66CHECK_OWNER_STATE 137CHECK_QUALIFIER_STATE 138checking database access 37ClassPath

creating a JavaBean connection 45creating a JDBC connection 41

Column Name Max Size 93COMMA 138CONCAT 139Config File Extension 67configuration files

installed SBO files 81JavaBean SBO example 46parameter categories 88

connection components 14Connection Server

about global parameters 64choosing the deployment mode 72configuring data access for DataDirect

branded drivers 84configuring deplyment mode 73configuring driver defaults 65


Connection Server (continued)configuring for complex deployment 74configuring for JDBC connection to Data

Federator 54configuring for ODBC connection to Data

Federator 57configuring for ODBC connection to

Universe Designer and Web IntelligenceRich Client 60

configuring for Web Intelligence connectionto Data Federator 59

configuring global settings 66creating a JavaBean connection 45creating generic JDBC connections 42creating generic ODBC connections 47creating generic ODBC3 connections 49creating JDBC connections 41debugging at startup 73definition 14in standalone server mode 77

Connection Shareable 94Connection Status Available 117connections

creating Data Federator 52requirements for creating 24

Conversion tables 172Cost Estimate Available 94cs.cfg

about 64cscheck

function list 26getting help 25running 26syntax 26

Cumulative_Object_Where 95

Ddata access

driver level files 17files installed 16global files 17

data access (continued)installed files 16

data access driversabout 15checking availability on a machine 34checking for validation 34configuring parameters 80files used by 17PRM files 126searching for installed 29selecting 74

Data Federatorabout creating connections 52configuring for ODBC connection 56configuring for ODBC connection to Web

Intelligence Rich Client 59installation directory 55required version 52

database accessconfiguring 74installation 75

database access, checking 37DATABASE_DATE_FORMAT 140databases

listing supported 28supporting stored procedures 19

DataDirect 83DATATYPE_BLOB 140DATATYPE_DOUBLE 141DATATYPE_DTM 141DATATYPE_INT 141DATATYPE_NULL 142DATATYPE_STRING 142datatypes

IBM DB2 172Informix 174Oracle 176Red Brick 177SQL Server 175Sybase 179Teradata 180

DATE_WITHOUT_QUOTE 142


Index

DELIMIT_IDENTIFIERS 143Description Extension 67Description File 95Distribution

CFG file 77Driver Capabilities 95Driver defaults

CFG file 65driver.sbo parameters

Lock Mode 119LongVarcharNotSupported 119

driveren.prm parametersBlob_Comparison 137Boundary_Weight_Table 137Case_Sensitive 137Cumulative_Object_Where 95Ext_Join 143Intersect 149Left_Outer 150Max_Inlist_Values 152Minus 152OLAP_Clause 154Quote_Owner 161Refresh_Columns_Type 163

driverschecking availability on a machine 34checking for validation 34DataDirect 83

EEBUS 54Empty String 117Enable Failed Load 68Enumerator CLSID 121Escape Character 96Ext_Join 143EXT_JOIN 143EXT_JOIN_INVERT 144Extensions 97EXTERN_SORT_EXCLUDE_DISTINCT 145

FFamily 97Field Size Factor 97Force Close Statement 118Force Execute 98FORCE_SORTED_LOV

universe parameter 139ForeignKeys Available 115

Ggeneric JDBC datasource 42generic ODBC datasource 47generic ODBC3 datasource 49global

data access files 17GROUPBY_EXCLUDE_COMPLEX 145GROUPBY_WITH_ALIAS 146GROUPBY_WITHOUT_CONSTANT 147GROUPBYCOL 147, 149, 153, 160, 162, 165

Hhelp

PRM files 132help, cscheck 25

IIBM DB2

datatypes 172Identifier Case 98Identifier Quote String 99IDENTIFIER_DELIMITER 148Informix

datatypes 174Modifying the ODBC.ini file 111Unicode 113V5toV6DriverName 112

Informix configuration parameters 111


Index

installationchecking data access driver 34Data Federator directory 55files installed 16

installation directorylocation 64

Intersect 149INTERSECT 149

JJava drivers 40JavaBean

JavaBean Class 113URL Format 114

JavaBean Class 113JavaBean connections

about 44creating 45

JavaBean SBO example 46JavaBean SBO parameters 113JDBC

ForeignKeys Available 115generic 42JDBC Class 115Primary Key Available 116

JDBC Class 115JDBC connections

about 40creating 41

jdbc.sbo 41JNI usage 72

KKEY_INFO_SUPPORTED 150

LLeft_Outer 150LEFT_OUTER 150

LENMAXFORCOLUMNNAME 151LENMAXFORTABLENAME 151LENMAXFORVARCHAR 152library mode 73LIKE Escape Clause 99limitations of stored procedures 20Load Drivers On Startup 68Locale 100Lock Mode 119LongVarcharNotSupported 119

MMax Pool Time 69Max Rows Available 100Max_Inlist_Values 152middleware

checking availability on a machine 32checking connectivity with network layer 35

Minus 152MINUS 152MS SQL Server 83MSOlap CLSID 122

NNative Int64 Available 118network layers

checking available middleware 32checking connectivity with middleware 35listing supported 28selecting 74

New Connection Wizardconfiguring for Data Federator 53

NO_DISTINCT 153

OODBC

Connection Status Available 117DataDirect drivers 83


Index

ODBC (continued)Empty String 117exposing database layer in server mode 77Force Close Statement 118generic ODBC2 47generic ODBC3 49Native Int64 Available 118ODBC Cursors 119SQLDescribeParam Available 119SQLMoreResults Available 120Use DataDirect OEM Driver 120

ODBC connectionsabout 46

ODBC Cursors 119OLAP_Clause 154OLAP_CLAUSE 154OLE DB

Enumerator CLSID 121Provider CLSID 121

OLE DB OLAPMSOlap CLSID 122

Optimize Execute 101Oracle

connectivity check example 37datatypes 176stored procedures 20

OUTERJOINS_GENERATION 155OVER_CLAUSE 158OWNER 159Owners Available 101

Pparameter types, configuration 64Password Encryption 102ping, checking database access 37PREFIX_SYS_TABLE 160PrimaryKey Available 116PRM file

list of files 126reference 126reference list 136

PRM filesabout function help text 132BACK_QUOTE_SUPPORTED 136CASE_SENSITIVE 137CHECK_OWNER_STATE 137CHECK_QUALIFIER_STATE 138COMMA 138CONCAT 139DATABASE_DATE_FORMAT 140DATATYPE_BLOB 140DATATYPE_DOUBLE 141DATATYPE_DTM 141DATATYPE_INT 141DATATYPE_NULL 142DATATYPE_STRING 142DATE_WITHOUT_QUOTE 142DELIMIT_IDENTIFIERS 143editing 132editing help text 133EXT_JOIN 143EXT_JOIN_INVERT 144EXTERN_SORT_EXCLUDE_DISTINCT

145GROUPBY_EXCLUDE_COMPLEX 145GROUPBY_WITH_ALIAS 146GROUPBY_WITHOUT_CONSTANT 147GROUPBYCOL 147, 149, 153, 160, 162,

165IDENTIFIER_DELIMITER 148INTERSECT 149KEY_INFO_SUPPORTED 150LEFT_OUTER 150LENMAXFORCOLUMNNAME 151LENMAXFORTABLENAME 151LENMAXFORVARCHAR 152MINUS 152NO_DISTINCT 153OLAP_CLAUSE 154OUTERJOINS_GENERATION 155OVER_CLAUSE 158OWNER 159PREFIX_SYS_TABLE 160


Index

PRM files (continued)QUALIFIER 161QUOTE_OWNER 161REFRESH_COLUMNS_TYPE 163REVERSE_TABLE_WEIGHT 163RIGHT_OUTER=$(+) 164RISQL_FUNCTIONS 164SORT_BY_NO 166structure 129UNICODE_PATTERN 166UNION 167USER_INPUT_DATE_FORMAT 168USER_INPUT_NUMERIC_SEPARATOR

169viewing 132

Procedure Name Max Size 103Procedure Parameter Name Max Size 103Protocols

CFG file 77Provider CLSID 121

QQUALIFIER 161Qualifiers Available 104Query TimeOut Available 104Quote_Owner 161QUOTE_OWNER 161Quoted Identifier 122Quoted Identifier Case 105

RRed Brick

datatypes 177TIME support in WHERE 178TIMESTAMP support in WHERE 178

Refresh_Columns_Type 163REFRESH_COLUMNS_TYPE 163requirements

connections 24Data Federator minimum version 52

REVERSE_TABLE_WEIGHT 163RIGHT_OUTER=$(+) 164RISQL_FUNCTIONS 164

SSBO files

Array Bind Available 90Array Bind Size 90Array Fetch Available 91Array Fetch Size 91Catalog Name Max Size 92Catalog Separator 92CharSet 93Column Name Max Size 93configuring a JDBC connection 41Connection Shareable 94Connection Status Available 117Cost Estimate Available 94Databases parameters 88Defaults parameters 88Description File 95Driver Capabilities 95editing 83Empty String 117Enumerator CLSID 121Escape Character 96Extensions 97Family 97Field Size Factor 97Force Close Statement 118Force Execute 98ForeignKeys Available 115Identifier Case 98Identifier Quote String 99installed 81JavaBean Class 113JDBC Class 115LIKE Escape Clause 99Locale 100Max Rows Available 100MSOlap CLSID 122


Index

SBO files (continued)Native Int64 Available 118ODBC Cursors 119Optimize Execute 101Owners Available 101parameter categories 88Password Encryption 102Primary Key Available 116Procedure Name Max Size 103Procedure Parameter Name Max Size 103Provider CLSID 121Qualifiers Available 104Query TimeOut Available 104Quoted Identifier 122Quoted Identifier Case 105Schema Name Max Size 105Shared Connection 106SQL External File 106SQL Parameter File 107SQLDescribeParam Available 119SQLMoreResults Available 120SSO Available 107Strategies File 108structure 88Table Name Max Size 108Transaction Available 109Transaction Mode 109Type 110Unicode 113URL Format 114Use DataDirect OEM Driver 120V5toV6DriverName 112Version 110viewing 83XML Max Size 111

Schema Name Max Size 105server mode 73settings

CFG parameter reference 66Shared Connection 106single sign-on 16SORT_BY_NO 166

SQL External Extension 70SQL External File 106SQL parameter

PRM file list 136SQL Parameter Extension 71SQL Parameter File 107SQL Server

datatypes 175SQLDescribeParam Available 119SQLMoreResults Available 120SSO 16SSO Available 107stored procedures

about 19about JavaBean connections 44creating a cursor inside an Oracle package

21creating Oracle 21limitations 20Oracle 20Teradata 22

Strategies Extension 71Strategies File 108supported databases, listing 28supported network layers, listing 28Sybase

connectivity check example 37datatypes 179Quoted Identifier 122

system architecture 15

TTable Name Max Size 108Teradata

datatypes 180stored procedures 22

Transaction Available 109Transaction Mode 109Transient Object Timeout 72, 73Type 110


Index

UUnicode 113UNICODE_PATTERN 166UNION 167universe parameter

FORCE_SORTED_LOV 139URL Format 114Use DataDirect OEM Driver 120USER_INPUT_DATE_FORMAT 168USER_INPUT_NUMERIC_SEPARATOR 169

VV5toV6DriverName 112Version 110

WWeb Intelligence Rich Client

about creating connections to 57setting registry key 60

XXML Max Size 111


Index

data access guide xi 3.1

Documents