Sie sind auf Seite 1von 194

Data Access Guide

SAP BusinessObjects XI3.1 Service Pack 3


Copyright © 2010 SAP AG. All rights reserved.SAP, R/3, SAP NetWeaver, Duet, PartnerEdge,
ByDesign, SAP Business ByDesign, and other SAP products and services
mentioned herein as well as their respective logos are trademarks or registered
trademarks of SAP AG in Germany and other countries. Business Objects and the
Business Objects logo, BusinessObjects, Crystal Reports, Crystal Decisions, Web
Intelligence, Xcelsius, and other Business Objects products and services mentioned
herein as well as their respective logos are trademarks or registered trademarks
of Business Objects S.A. in the United States and in other countries. Business
Objects is an SAP company.All other product and service names mentioned are
the trademarks of their respective companies. Data contained in this document
serves informational purposes only. National product specifications may vary.These
materials are subject to change without notice. These materials are provided by
SAP AG and its affiliated companies ("SAP Group") for informational purposes
only, without representation or warranty of any kind, and SAP Group shall not be
liable for errors or omissions with respect to the materials. The only warranties for
SAP Group products and services are those that are set forth in the express
warranty statements accompanying such products and services, if any. Nothing
herein should be construed as constituting an additional warranty.

2010-05-21
Contents
Chapter 1 Introducing data access 13
About Connection Server...........................................................................14
Components of a connection.....................................................................14
About the system architecture..............................................................15
About data access drivers....................................................................15
About connectivities that support single sign-on..................................16
About data access configuration files........................................................16
About the cs.cfg global configuration file..............................................17
About the *.sbo driver configuration files..............................................17
About stored procedures...........................................................................19
About supported database capabilities................................................20
About Oracle stored procedures..........................................................20
To create a cursor inside a package....................................................21
To create an Oracle stored procedure..................................................21
About Teradata stored procedures.......................................................22

Chapter 2 Creating a connection 23


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

Data Access Guide 3


Contents

Check tool—accessdriver.....................................................................34
Check tool—connectivity......................................................................35
Check tool—ping .................................................................................37
About JDBC connections ..........................................................................40
To create a JDBC connection ...................................................................41
JDBC SBO example file structure........................................................42
To create a generic JDBC connection.......................................................42
Generic JDBC SBO example file structure..........................................44
About JavaBean connections....................................................................44
To create a JavaBean connection.............................................................45
JavaBean SBO example file structure ................................................46
About ODBC connections..........................................................................46
To create a generic ODBC connection......................................................47
To create a generic ODBC3 connection....................................................49

Chapter 3 Creating a connection to Data Federator Query Server 51


About Data Federator Query Server connections.....................................52
Configuring the New Connection wizard for a Data Federator JDBC or ODBC
connection.................................................................................................53
Configuring Data Federator JDBC connections........................................54
Configuring Connection Server for a Data Federator JDBC
connection............................................................................................54
Configuring Data Federator ODBC connections.......................................55
Configuring the Data Federator ODBC middleware ............................56
Configuring Connection Server for a Data Federator ODBC
connection............................................................................................57
Configuring Web Intelligence Rich Client connection definitions using Data
Federator ODBC middleware....................................................................57
Configuring the Data Federator ODBC middleware for a Web Intelligence
Rich Client connection..........................................................................59
Configuring Connection Server for a Web Intelligence Rich Client
connection to Data Federator...............................................................59

4 Data Access Guide


Contents

Setting the Web Intelligence Rich Client registry key ..........................60


Configuring Connection Server for Web Intelligence Rich Client and
Universe Designer connections to Data Federator..............................60

Chapter 4 Configuring data access global parameters 63


About global parameters............................................................................64
About the cs.cfg configuration file..............................................................64
To view and edit the cs.cfg file...................................................................65
Configuring the driver default parameters.................................................65
Configuring the global settings parameters...............................................66
Charset List Extension.........................................................................66
Config File Extension...........................................................................67
Description Extension...........................................................................67
Enable Failed Load..............................................................................68
Load Drivers On Startup.......................................................................68
Max Pool Time......................................................................................69
SQL External Extension.......................................................................70
SQL Parameter Extension....................................................................71
Strategies Extension............................................................................71
Transient Object Timeout.....................................................................72
Setting the deployment mode....................................................................72
Configuring the deployment mode.............................................................73
Configuring the driver to load in server mode............................................74
Setting one connectivity per machine..................................................75
Configuring the CORBA access protocols.................................................77

Chapter 5 Configuring data access driver parameters 79


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

Data Access Guide 5


Contents

To view and edit an SBO file................................................................83


Configuring data access for DataDirect ODBC branded drivers...............83
To enable the use of DataDirect branded drivers.................................84

Chapter 6 SBO parameter reference 87


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

6 Data Access Guide


Contents

Owners Available...............................................................................101
Password Encryption..........................................................................102
Procedure Name Max Size................................................................103
Procedure Parameter Name Max Size..............................................103
Qualifiers Available.............................................................................104
Query TimeOut Available...................................................................104
Quoted Identifier Case.......................................................................105
Schema Name Max Size....................................................................105
Shared Connection.............................................................................106
SQL External File...............................................................................106
SQL Parameter File............................................................................107
SSO Available....................................................................................107
Strategies File....................................................................................108
Table Name Max Size........................................................................108
Transactional Available......................................................................109
Transaction Mode...............................................................................109
Type....................................................................................................110
Version...............................................................................................110
XML Max Size....................................................................................111
Informix SBO parameters........................................................................111
To modify the Informix ODBC.INI file..................................................111
V5toV6DriverName............................................................................112
Unicode..............................................................................................113
JavaBean SBO parameters.....................................................................113
JavaBean Class.................................................................................113
URL Format........................................................................................114
JDBC SBO parameters............................................................................115
ForeignKeys Available........................................................................115
JDBC Class........................................................................................115
PrimaryKey Available.........................................................................116
ODBC SBO parameters...........................................................................116

Data Access Guide 7


Contents

Connection Status Available..............................................................117


Empty String.......................................................................................117
Force Close Statement.......................................................................118
Native Int64 Available.........................................................................118
ODBC Cursors...................................................................................119
SQLDescribeParam Available............................................................119
SQLMoreResults Available................................................................120
Use DataDirect OEM Driver...............................................................120
OLE DB SBO parameters........................................................................121
Enumerator CLSID.............................................................................121
Provider CLSID..................................................................................121
OLE DB OLAP SBO parameters.............................................................122
MSOlap CLSID...................................................................................122
Sybase ASE/CTLIB.................................................................................122
Quoted Identifier.................................................................................122

Chapter 7 Configuring SQL generation parameters 125


About SQL generation parameters..........................................................126
About PRM files.......................................................................................126
PRM parameter file structure.............................................................129
To view and edit a PRM file.....................................................................132
To view and edit a function help text file..................................................132
To edit the help text for a PRM function...................................................133

Chapter 8 PRM parameter reference 135


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

8 Data Access Guide


Contents

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

Data Access Guide 9


Contents

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

Chapter 9 Data type conversion reference 171


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

10 Data Access Guide


Contents

Appendix A More Information 183

Index 187

Data Access Guide 11


Contents

12 Data Access Guide


Introducing data access

1
1 Introducing data access
About Connection Server

About Connection Server


Connection Server is the data access software that manages the connection
between an SAP BusinessObjects application and a datasource.

Connection Server allows applications such as Universe Designer and SAP


BusinessObjects Web Intelligence to connect to and run queries against a
datasource.

Connection Server does not have a user interface. You create and administer
connections from the user interface of these applications, or by editing
Connection Server configuration files.
• Creating connections: You create connections using the Connection
wizard.
• Optimizing data access: You can optimize the way that data is passed
through 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 connection
A 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 Server
handles requests for data from the application.
• A data access driver is the database-specific software component that
manages the connection between Connection Server and the database
middleware.
• 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

14 Data Access Guide


Introducing data access
Components of a connection 1

About the system architecture

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

About data access drivers

Data access drivers provide the connection between Connection Server and
a datasource. A database requires a data access driver in order that it can
be accessed by an SAP BusinessObjects application.
SAP BusinessObjects applications include data access drivers that you can
use to configure connections to your databases. The data access drivers
that are included can depend on your licence.

Data Access Guide 15


1 Introducing data access
About data access configuration files

Before you can create a connection to a database for which you do not have
a driver, you need to obtain the required drivers. The following options are
available 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. Contact
your SAP representative for details.

When you create a new connection, you select the appropriate data access
driver for the target datasource. For example, if you access an Oracle 10g
database, 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 Service
Marketplace at http://service.sap.com/bosap-support, or contact your SAP
representative.

For more information about the DDK, refer to the Data Access Driver Java
SDK 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 following
connectivities:
• 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 files


Data access configuration files are installed with SAP BusinessObjects
Enterprise. The configuration files can be divided into two levels:

16 Data Access Guide


Introducing data access
About data access configuration files 1
• 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 data


access driver has an associated .prm configuration file. These files are used
by applications such as Universe Designer. The .prm files control the way
in which an application generates SQL depending on the database software
capabilities.

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

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

About the cs.cfg global configuration file

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

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

About the *.sbo driver configuration files

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

Data Access Guide 17


1 Introducing data access
About 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 the
configuration file.

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

Driver specific
Can be edited? Description Example
file

There is a .sbo
file for each sup-
ported network
protocol, or
database middle-
ware used to con-
<driver>.sbo Yes oracle.sbo
nect to a
database. De-
fines the specific
connectivity con-
figuration for
each database.

Defines parame-
ters that affect the
<driver>.prm Yes way that an appli- oracle.prm
cation generates
SQL.

18 Data Access Guide


Introducing data access
About stored procedures 1
Driver specific
Can be edited? Description Example
file

Stores informa-
tion related to
connection defini-
tions. Defines the
fields that appear
<driver><lan when you create oracleen.cod
No
guage>.cod a new connec-
tion.
Note:
Do not modify
these files.

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

About stored procedures


Connection Server is able to manage data from datasources that result either
from SQL query or stored procedure execution.

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

Stored procedures for the following databases and network layers are
supported 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

Data Access Guide 19


1 Introducing data access
About 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 result
sets, that is, tables. This means that the stored procedure cannot return
integers, strings, or cursors and must always contain SELECT statements.
Plus, supported stored procedures must not contain OUT or IN/OUT
parameters. In addition, COMPUTE, PRINT, OUTPUT or STATUS statements
contained in stored procedures are not executed.

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

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

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 REF
CURSOR parameter
• any PL/SQL procedures having at least one OUT parameter
• any PL/SQL function

20 Data Access Guide


Introducing data access
About stored procedures 1
• any PL/SQL procedure having one IN/OUT parameter of a type different
than a REF CURSOR, for example, VARRAY
• any PL/SQL Table function
To access Oracle stored procedures, you must do a number of tasks at the
server end to allow SAP BusinessObjects Enterprise to connect to a stored
procedure. 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 related


PL/SQL types, objects, and subprograms. You must first create a cursor
inside a package before creating an Oracle stored procedure using the
defined cursor.
• In the Oracle database administration system, use the following statement:

CREATE or REPLACE PACKAGE catalog_data AS


TYPE CatCurTyp IS REF CURSOR RETURN
all_objects%ROWTYPE;
END catalog_data;

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

To create an Oracle stored procedure

In the following procedure, you use catcurtyp cursor that you previously
created in the package, and catalog_data.catcurtyp.
• Do one of the following:
a. Write the following statement:

CREATE or REPLACE PROCEDURE get_allobjects(cat_cv


IN OUT
catalog_data.catcurtyp) AS
BEGIN
OPEN cat_cv FOR SELECT * FROM all_objects;
END;

Data Access Guide 21


1 Introducing data access
About stored procedures

b. Write the following statement with several parameters:

CREATE or REPLACE PROCEDURE get_ownerobjects(own


er_name IN
varchar2, cat_cv IN OUT catalog_data.catcurtyp) AS

BEGIN
OPEN cat_cv FOR SELECT * FROM all_objects WHERE
owner=owner_name;
END;

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

About Teradata stored procedures

Connection Server supports Teradata macros and stored procedures if the


connection established uses ODBC. It only supports Teradata stored
procedures if using JDBC, because Teradata JDBC driver does not support
macros.

22 Data Access Guide


Creating a connection

2
2 Creating a connection
Connection requirements

Connection requirements
This section covers the requirements for creating a connection.
• Ensure that your platform conforms to the platforms supported for SAP
BusinessObjects connections.
• Ensure that the database middleware is installed correctly, and that you
can access your database through either your computer or a server.
• Ensure that you have all the information necessary to access your
database, for example the database login name and password.
• Install the SAP BusinessObjects solution that you will use, including the
appropriate data access driver.
• Check that all of the services have started successfully.
• Refer to the Readme notice that comes with your SAP BusinessObjects
solution to check for any configuration changes that your environment
and software might require.
• Refer to the current Data Access release notice to check for any
configuration changes that could affect your environment.

Note:
You can use the cscheck tool to check your infrastructure and determine
if it is suitable for use with SAP BusinessObjects applications.
Related Topics
• Checking connection configuration

Checking connection configuration


The Connection Server software includes a command line utility that you
can use to check your datasource connection infrastructure. You can use
the cscheck tool to check your client middleware and the installed data
access drivers at any time.

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

24 Data Access Guide


Creating a connection
Checking connection configuration 2
The cscheck tool is installed in the following directory: connectionserv
er-install-dir\connectionServer\tools

You run the cscheck tool from a command console (DOS or shell). The
output is displayed on the screen. You can specify that the output is generated
as 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 and
database client
• check for a valid data access driver installation for a supplied network
layer 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 your
SAP BusinessObjects solution.

To display general help on cscheck, use the following syntax:


Figure 2-1: Command help syntax
cscheck --help|h --language|l { language }

Data Access Guide 25


2 Creating a connection
Checking connection configuration

To display help on a function, use the following syntax, where functionName


is the name of the function for which you want help, and language is the
language in which to display the help:
Figure 2-2: Function help syntax
cscheck --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 following


command:

cscheck --language fr --help connectivity

To run the cscheck tool

You can run the cscheck tool at any time after you have installed your SAP
BusinessObjects 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 the
appropriate function and its arguments to return the results that you want.

26 Data Access Guide


Creating a connection
Checking connection configuration 2
cscheck commands have the following structure. Some of the parameters
are optional.
Figure 2-3: cscheck syntax
cscheck --language|l { output language }--xml|x--mute|m function
namefunction 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 this
switch if you were using the tool in a script that checked the returned
status. This is optional. The default is that output is generated.

The remaining part of the command consists of the function and its option
arguments.

<function name> can take the following values. Each function has a short
version 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

Data Access Guide 27


2 Creating a connection
Checking connection configuration

• Check tool—ping

Check tool—list

This function returns a list of the supported network layers and database
engines. For example you could use it to determine the correct values to use
with other check tool functions.
Note:
This function returns the full list of supported data access drivers and
middleware, including those that are not necessarily installed on your
machine.

Figure 2-4: list syntax


cscheck |list||lt|

Example:
The following command lists all network layers and database engines
supported by the SAP BusinessObjects solution installed on the current
machine.

cscheck list

The following is an excerpt of the result list:

Oracle Client
Oracle 9
Oracle 10
Oracle 11
Sybase Open Client
Sybase Adaptive Server 12
Sybase Adaptive Server 15
Informix ODBC Driver
Informix XPS 8.4
Informix XPS 8.5
Informix Dynamic Server 7.3
Informix Dynamic Server 2000
Informix Dynamic Server 10
Informix Dynamic Server 11
Teradata ODBC Driver
Teradata V2 R5
Teradata V2 R6

28 Data Access Guide


Creating a connection
Checking connection configuration 2
Teradata 12
ODBC Drivers
Generic ODBC Datasource
Generic 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 syntax


cscheck |driverssearch||ds|

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

cscheck driverssearch

The following is an excerpt of the result list:

This access driver is installed: Oracle OCI access


driver
Client layer: Oracle Client
Database engine(s):
Oracle 9
Oracle 10
Oracle 11
This access driver is installed: Sybase Open Client ac
cess driver
Client layer: Sybase Open Client
Database engine(s):
Sybase Adaptive Server 12
Sybase Adaptive Server 15
This access driver is installed: Informix ODBC access
driver
Client layer: Informix ODBC Driver
Database engine(s):

Data Access Guide 29


2 Creating a connection
Checking connection configuration

Informix XPS 8.4


Informix XPS 8.5
Informix Dynamic Server 7.3
Informix Dynamic Server 2000
Informix Dynamic Server 10
Informix Dynamic Server 11
This access driver is installed: Teradata ODBC access
driver
Client layer: Teradata ODBC Driver
Database engine(s):
Teradata V2 R5
Teradata V2 R6
Teradata 12
...

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

Check tool—find

This function lists the available connectivity types, that is middleware and
database 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 syntax


cscheck |find||fd| -m { Connection Server access mode }

30 Data Access Guide


Creating a connection
Checking connection configuration 2
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 types
available using CORBA.
Connection Server access mode
(-m) • http:lists connectivity types avail-
able using HTTP.
• java: lists Java connectivity types
available on the local machine.
• extended: lists local, java, and
corba connectivity types.

Example: Finding local connectivities


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

cscheck find –m local

The following is an excerpt of the result list:

Local Library Mode


IBM DB2 Client
DB2 v9
DB2 UDB v8
DB2 UDB for z/OS v8
DB2 UDB for OS/390 v7
DB2 UDB for iSeries v5
Essbase Provider
Hyperion Essbase 7.0
Hyperion Essbase 9
Informix ODBC Driver
Informix Dynamic Server 7.3
Informix Dynamic Server 2000
Informix Dynamic Server 10

Data Access Guide 31


2 Creating a connection
Checking connection configuration

Informix Dynamic Server 11


Informix XPS 8.4
Informix XPS 8.5
ODBC Drivers
Generic ODBC datasource
Generic ODBC3 datasource
MS SQL Server 7.x
MS SQL Server 2000
MS SQL Server 2005
Sybase ASIQ 12
Sybase SQL Anywhere 10
...

Example: Finding CORBA server connectivities


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

cscheck find –m corba

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

Check tool—middleware

For a supplied network layer and database client, this function checks for a
valid installation of the client middleware. To check both the middleware and
data access driver for a supplied network layer and database client, you can
use the connectivity function.

Figure 2-7: middleware syntax


cscheck |middleware||mw|-c { network layer }-d{ database client }

32 Data Access Guide


Creating a connection
Checking connection configuration 2
Table 2-2: Function input parameters

The network layer that the database


network layer (-c) middleware uses, as returned by the
find function.

The database to check, as returned


database client (-d)
by the find function.

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

cscheck --xml middleware -c "Oracle Client" -d "Oracle


9" > c:\result.xml

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

Starting to check the middleware component installa


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

Data Access Guide 33


2 Creating a connection
Checking connection configuration

Check tool—accessdriver

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

Table 2-3: Function input parameters

The network layer that the database


network layer ( -c ) middleware uses, as returned by the
find function.

The database to check, as returned


database client (-d)
by the find function.

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

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


9"

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

The language specified is not installed. Please use an


installed language. English ([en]).

34 Data Access Guide


Creating a connection
Checking connection configuration 2
Example:
The following command checks for a valid installation of an Oracle 9 data
access driver:
cscheck ad -c "Oracle Client" -d "Oracle 9"

The result is the following:

Starting to check the access driver component installa


tion...
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_oci10.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 that
both the installed middleware and the data access driver are valid.

Data Access Guide 35


2 Creating a connection
Checking connection configuration

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

Table 2-4: Function input parameters

The network layer that the database


network layer (-c) middleware uses, as returned by the
find function.

The database to check, as returned


database client (-d)
by the find function.

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

cscheck -l en connectivity -c "Oracle Client" -d "Oracle


9">c:\result.txt

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

Starting to check the middleware component installa


tion...
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 installa
tion...
Begin AND operator...
Config Directory... success.
%SharedRoot%\ConnectionServer\Network Layers\Oracle

36 Data Access Guide


Creating a connection
Checking connection configuration 2
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_oci10.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—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 syntax
cscheck ping|pg|-m{ Connection Server access mode }-c{ network
layer }-d{ database client }-u{ user name }-p{ password }-s{ datasource
}-t{ database }-r{ host name }-j{ PID }

Data Access Guide 37


2 Creating a connection
Checking connection configuration

Table 2-5: Function input parameters

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-
Connection Server access mode ning on a CORBA server.
(-m)
• http:Connection Server is running
on a HTTP server.
• java: Connection Server uses a
Java data access driver on the
local machine.

The database middleware for the


network layer (-c) connection to check, as returned by
the find function.

The database type, as returned by


database client (-d)
the find function.

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

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

The server on which the database is


datasource (-s)
running.

database (-t) The database server.

38 Data Access Guide


Creating a connection
Checking connection configuration 2
For CORBA mode, the computer
host name (-r)
hosting Connection Server.

For CORBA mode, the process


PID (-i) number of the Connection Server to
ping through.

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

Data Access Guide 39


2 Creating a connection
About JDBC connections

• 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 Server
15" -t "SY1" -r "sybasehost" -i 456

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

About JDBC connections


A set of data access drivers are installed when you install your SAP
BusinessObjects application. You can use these data access drivers to create
connections to databases.

SAP BusinessObjects software also includes configuration files for using


JDBC 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.0
and higher.
Caution:
SAP BusinessObjects Web Intelligence Rich Client does not support JDBC
connectivity in 3-tier mode.
For an up-to-date list of supported JDBC drivers, check the SAP Service
Marketplace at http://service.sap.com/bosap-support, or contact your SAP
representative.

40 Data Access Guide


Creating a connection
To create a JDBC connection 2
Note:
The Data Access layer provides the Generic JDBC connectivity to create a
connection to a datasource that SAP BusinessObjects Enterprise does not
support explicitly.
Related Topics
• To create a JDBC connection
• To create a generic JDBC connection

To create a JDBC connection


In 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 database
vendor. 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 example
the 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 ensure
that they are accessible by the system. For example, the SQL Server
2005 JDBC driver uses addditional DLLs. The directory for these must
be 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 connec
tionserver-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\\msu
til.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 for
details.

Data Access Guide 41


2 Creating a connection
To create a generic JDBC connection

5. Locate the Driver Capabilities parameter, and check that it is set


to either Procedure or Queries.
If it is not, the JDBC driver is unavailable from the New Connection
wizard.
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 and
use 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 to
modify. 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 connection


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

42 Data Access Guide


Creating a connection
To create a generic JDBC connection 2
• Obtain the necessary JDBC driver software for the database, and copy
the files to your system. The .jar file need to be installed on the machine
running the SAP BusinessObjects application.
• Ensure that you have the database access details ready, for example the
login and password details.

To create a JDBC connection, use the following procedure:


1. Navigate to the directory that contains the jdbc.sbo and jdbc.prm
files. For example, on Microsoft Windows, the configuration files are
located in the connectionserver-install-dir\connectionServ
er\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 driver
class and the URL format through the appropriate parameters.
Refer to the information on the jdbc.sbo example file structure for
details.

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 functions
of 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 available
for use through JDBC.
Note:
You can only configure one connection through a generic JDBC
implementation.

Related Topics
• About PRM files

Data Access Guide 43


2 Creating a connection
About JavaBean connections

Generic JDBC SBO example file structure

This lists an example of the section of the JDBC SBO file that you need to
modify. This SBO file is for Generic JDBC datasource and the Ingres
database.
Note:
The Ingres JDBC driver consists of the iijdbc.jar file. The com.in
gres.jdbc.IngresDriver class implements the java.sql.Driver
JDBC 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 connections


Developers can create JavaBeans that provide access to datasources. You
can create connections using these JavaBeans. In order to create a
JavaBeans 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

44 Data Access Guide


Creating a connection
To create a JavaBean connection 2
Within a JavaBeans driver, data-retrieval procedures are configured as stored
procedures. When configuring a JavaBeans connection, on the New
Connection wizard 's Database Middleware Selection screen, you must
select the Filter Stored Procedures Network Layers check-box. If you do
not, the New Connection wizard does not display the JavaBeans drivers that
are available.

To create a JavaBean connection


To create a JavaBeans connection, use the following procedure:
1. Use an XML editor to open the javabeans.sbo file for editing. For ex
ample, on Microsoft Windows, the configuration files are located in the
connectionserver-install-dir\connectionServer\javabean
directory.
2. Add the required .jar file details to the ClassPath area. Include the
fully qualified path names when specifying these files.
Note:
These files need to be installed on the machine running the SAP
BusinessObjects application.
Refer to the information on the JavaBean.sbo example file structure for
details.
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 the
JavaBeans datasource and use the wizard to configure the connection.
When you complete this task, the connection is available for use with the
application.
Related Topics
• JavaBean SBO example file structure
• PrimaryKey Available

Data Access Guide 45


2 Creating a connection
About ODBC connections

JavaBean SBO example file structure

This section contains an example of a JavaBeans SBO file.

<DataBase Active="Yes" Name="Excel


Spreadsheet">
<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 connections


A set of data access drivers are installed when you install your SAP
BusinessObjects application. You can use these data access drivers to create
connections to databases.

SAP BusinessObjects software also includes configuration files for using


ODBC drivers to access your databases. To use these drivers, you do the
following:
• Obtain the ODBC driver software from your database supplier.
• Modify the supplied configuration files.

46 Data Access Guide


Creating a connection
To create a generic ODBC connection 2
For an up-to-date list of supported ODBC drivers, check the SAP Service
Marketplace at http://service.sap.com/bosap-support, or contact your SAP
representative.

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

About generic ODBC connections on UNIX


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

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 relevant
datasource to enable the connection.

Note:
You can configure only one connection through a generic ODBC
implementation.
Related Topics
• To create a generic ODBC connection
• To create a generic ODBC3 connection

To create a generic ODBC connection


The following procedure shows how to configure a generic ODBC connection
to a database with the following assumptions:
• The driver is ODBC2
• The driver supports the unixODBC driver manager
1. Navigate to the directory that contains the odbc.sbo and odbc.prm
files.

Data Access Guide 47


2 Creating a connection
To 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>
<!--Library Platform="Unix">dbd_wuxodbc</Library-->

<!--Library Platform="Unix">dbd_uxodbc</Library-->
</Libraries>
<Parameter Name="Charset Table" Platform="Unix">datadi
rect</Parameter>
...
</DataBases>

4. Comment out the first two rows for DataDirect and uncomment one of
the next two rows. Make sure you put the row you uncomment on top of
the section, so that it can be read first. Comment out the <Parameter
Name="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 functions
of the database.

8. Save and close the odbc.prm file.


9. Install the relevant ODBC drivers on your UNIX machine.

48 Data Access Guide


Creating a connection
To create a generic ODBC3 connection 2
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 available
for use through generic ODBC with unixODBC driver manager.

To create a generic ODBC3 connection


The following procedure shows how to configure a generic ODBC connection
to a database with the following assumptions:
• The driver is ODBC3
• The driver supports the unixODBC driver manager
1. 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 data
source">
<Libraries>
...
<Library Platform="Unix">dbd_wddodbc3</Library>
<Library Platform="Unix">dbd_ddodbc3</Library>
<!--Library Platform="Unix">dbd_wuxodbc3</Library--
>
<!--Library Platform="Unix">dbd_uxodbc3</Library-->

<!--Library Platform="Unix64">dbd_wux32odbc3</Li
brary-->
<!--Library Platform="Unix64">dbd_ux32odbc3</Library-
->
</Libraries>
<Parameter Name="Charset Table" Platform="Unix">datadi
rect</Parameter>
...
</DataBases>

Data Access Guide 49


2 Creating a connection
To create a generic ODBC3 connection

4. Comment the first two rows for DataDirect and uncomment one of the
next four rows. Make sure you put the row you uncomment on top of the
section, so that it can be read first. Comment out the <Parameter
name="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 functions
of 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 available
for use through ODBC3 with unixODBC driver manager.

50 Data Access Guide


Creating a connection to
Data Federator Query
Server

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

About Data Federator Query Server


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

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

This chapter describes additional settings you must do on Data Federator


Query Server and configuration details you must use on Connection Server
to create connections.

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

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

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

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

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

52 Data Access Guide


Creating a connection to Data Federator Query Server
Configuring the New Connection wizard for a Data Federator JDBC or ODBC connection 3
to obtain it. The Data Federator ODBC middleware can only be used on
Microsoft Windows and because of the use of an OpenAccess ODBC-JDBC
bridge, has impacts on performance.
Related Topics
• Configuring the New Connection wizard for a Data Federator JDBC or
ODBC connection
• Configuring Data Federator JDBC connections
• Configuring Data Federator ODBC connections
• Configuring Web Intelligence Rich Client connection definitions using Data
Federator ODBC middleware

Configuring the New Connection wizard


for a Data Federator JDBC or ODBC
connection
In order to create a connection to Data Federator Query Server, you need
the following information. See your Data Federator administrator to obtain
these 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 database
to which you are connecting.
• the authentication details for the installation of Data Federator Query
Server that serves the catalog to which you are connecting

In the New Connection wizard, from the Database Middleware Selection


screen, 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 the


New 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 using
SAP BusinessObjects Web Intelligence Rich Client, the configuration changes

Data Access Guide 53


3 Creating a connection to Data Federator Query Server
Configuring Data Federator JDBC connections

required are different to those used by other SAP BusinessObjects


applications.

Configuring Data Federator JDBC


connections
This section contains Connection Server configuration changes for JDBC
connections 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. Your
administrator chose this directory when running the Data Federator
installer.
• bo-install-dir: the root installation directory for your SAP
BusinessObjects applications.

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

Configuring Connection Server for a Data Federator


JDBC connection

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

To configure Connection Server, you need to change the configuration file:


bo-install-dir\BusinessObjects Enterprise
12.0\win32_x86\dataAccess\connectionServer\jdbc\jdbc.sbo

54 Data Access Guide


Creating a connection to Data Federator Query Server
Configuring Data Federator ODBC connections 3
To configure the jdbc.sbo file, add or modify the following lines to the
ClassPath 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=&quot;$DATABASE$&quot;;commProto
col=EBUS</Parameter>
</JDBCDriver>
...
</DataBase>
where businessobjects-install-dir stands for C:\Program
Files\Business Objects directory on Microsoft Windows. The
ebus405.jar file comes with SAP BusinessObjects Enterprise installation.

Configuring Data Federator ODBC


connections
This section contains Data Federator Query Server additional settings and
Connection Server configuration changes for ODBC connections to all SAP
BusinessObjects applications except SAP BusinessObjects Web Intelligence
Rich 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. Your
administrator chose this directory when running the Data Federator drivers
installer.
• data-federator-drivers-install-dir\JdbcDriver: the root
installation directory for the Data Federator JDBC middleware. Your
administrator chose this directory when running the Data Federator
installer.
• bo-install-dir: the root installation directory for your SAP
BusinessObjects applications.

Data Access Guide 55


3 Creating a connection to Data Federator Query Server
Configuring Data Federator ODBC connections

Note:
Edit the files in an XML editor to make sure your files are well-formed. After
you make the configuration changes shown below, re-start your system for
the 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 use
Connection Server except SAP BusinessObjects Web Intelligence Rich
Client.

To configure the Data Federator ODBC middleware, you need to modify the
openrda.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-in
stall-dir\JdbcDriver\thindriver.jar;bo-install-
dir\BusinessObjects Enterprise 12.0\classes\Connection
Server.jar
• JVM_DLL_NAME=bo-install-dir\javas
dk\jre\bin\client\jvm.dll
• JVM_OPTIONS=-DODBCMode=true -Dbusinessobjects.connec
tivity.directory=bo-install-dir\BusinessObjects Enter
prise 12.0\win32_x86\dataAccess\connectionServer

56 Data Access Guide


Creating a connection to Data Federator Query Server
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware 3
Note:
Check the openrda.ini file to ensure that this path is not set using the
Djava.endorsed.dirs parameter. If it is, then you must remove the
path from the Djava.endorsed.dirs parameter.

Configuring Connection Server for a Data Federator


ODBC connection

Note:
This topic applies to all SAP BusinessObjects applications that use
Connection Server except SAP BusinessObjects Web Intelligence Rich
Client.

To configure Connection Server, you need to change the configuration file:


bo-install-dir\BusinessObjects Enterprise
12.0\win32_x86\dataAccess\connectionServer\cs.cfg

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

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

Configuring Web Intelligence Rich Client


connection definitions using Data
Federator ODBC middleware
When creating SAP BusinessObjects Web Intelligence Rich Client
connections that use Data Federator ODBC middleware, you need to make
the configuration changes described in this section. Without the correct
configuration amendments, the connection generates errors. This type of
connection is supported in a Windows environment only.

Data Access Guide 57


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

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

To create connections that use Data Federator ODBC middleware for use
with 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. Your
administrator chose this directory when running the Data Federator drivers
installer.
• data-federator-drivers-install-dir\JdbcDriver: the root
installation directory for the Data Federator JDBC middleware. Your
administrator chose this directory when running the Data Federator
installer.
• bo-install-dir: the root installation directory for your SAP
BusinessObjects applications.

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 Intelligence
Rich Client connection
• Configuring Connection Server for a Web Intelligence Rich Client connection
to Data Federator
• Setting the Web Intelligence Rich Client registry key
• Configuring Connection Server for Web Intelligence Rich Client and Universe
Designer connections to Data Federator

58 Data Access Guide


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

Configuring the Data Federator ODBC middleware


for a Web Intelligence Rich Client connection

To configure the Data Federator ODBC middleware, you need to modify the
openrda.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-in
stall-dir\JdbcDriver\thindriver.jar;bo-install-
dir\BusinessObjects Enterprise 12.0\classes\Connection
Server.jar
• JVM_DLL_NAME=bo-install-dir\javas
dk\jre6\bin\client\jvm.dll

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

• JVM_OPTIONS=-DODBCMode=true -Dbusinessobjects.connec
tivity.directory=bo-install-dir\BusinessObjects Enter
prise 12.0\win32_x86\dataAccess\connectionServer

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

Configuring Connection Server for a Web


Intelligence Rich Client connection to Data Federator

To configure Connection Server for an SAP BusinessObjects Web Intelligence


Rich Client connection to Data Federator, you need to change the

Data Access Guide 59


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

configuration file: bo-install-dir\BusinessObjects Enterprise


12.0\win32_x86\dataAccess\connectionServer\cs.cfg

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

<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 the Web Intelligence Rich Client 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\RichClient
key.
2. In this key, add the following values to the classpath value. As with all
registry 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\thin
driver.jar

Configuring Connection Server for Web Intelligence


Rich Client and Universe Designer connections to
Data Federator

It is possible to use a single configuration for creating an ODBC connection


to Data Federator from Universe Designer as well as SAP BusinessObjects
Web Intelligence Rich Client. In addition to the configuration settings
described previously, do one of the following sets of instructions:
• Do the following:

60 Data Access Guide


Creating a connection to Data Federator Query Server
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware 3
1. Run regedit tool.
2. In the registry, locate the
HKEY_LOCAL_MACHINE\SOFTWARE\Business Objects\Suite
12.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-in
stall-dir\\javasdk\\jre6\\bin\\client\\jvm.dll</Li
braryName>
</JavaVM>

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

Data Access Guide 61


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

62 Data Access Guide


Configuring data access
global parameters

4
4 Configuring data access global parameters
About global parameters

About global parameters


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

Data access global parameters are maintained in the cs.cfg file. This is
an XML file that contains Connection Server configuration parameters, and
default 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 file


On 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 sections
only:
• <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 the


data 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 local
or remote Connection Server.
• <Distribution>

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

64 Data Access Guide


Configuring data access global parameters
To view and edit the cs.cfg file 4
• <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 connection
activity through Connection Server in log files. Refer to the release notes
for information on generating traces.

The remaining section, <Locales>, defines the operating system charset


for each available language. The parameters in this section must not be
modified.

To view and edit the cs.cfg file


You can view and edit parameters in cs.cfg as follows:
1. Browse to the directory that stores the cs.cfg file. For example, on a
Windows system:
connectionserver-install-dir\connectionServer\cs.cfg
where connectionserver-install-dir is the path where your
Connection 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 the driver default parameters


The <DriverDefaults> section of the cs.cfg file contains the default values
that apply to all data access drivers. These default values are overridden for
a specific driver by corresponding values set in the <driver>.sbo file.

Data Access Guide 65


4 Configuring data access global parameters
Configuring the global settings parameters

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

Configuring the global settings


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


parameters, open cs.cfg in an XML editor, and go to the Settings section,
then Parameters section. In the file, each parameter is defined in the
following tag:

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

where parameter is the name of the parameter, and value is the value to
which the parameter is set.

Each parameter is shown with the following information:


• example of how the parameter appears in the XML file—when the
parameter is available in library and server mode, an example of each is
shown
• description of the parameter
• possible values that can be set for the parameter (where applicable)
• default value for the parameter

Charset List Extension

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

66 Data Access Guide


Configuring data access global parameters
Configuring the global settings parameters 4
Note:
Description Do not change this setting.
Sets the file extension for character set files.

Default crs

Config File Extension

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

Note:
Description Do not change this setting.
Sets the file extension for general configuration files.

Default sbo

Description Extension

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

Note:
Do not change this setting.
Description
Sets the file extension for the connection description
files.

Default cod

Data Access Guide 67


4 Configuring data access global parameters
Configuring 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 want
Description a usable connection possibly without all drivers oper-
ating, or a fatal error and no functionality when a
driver fails to load.

Yes: Connection Server generates a warning message


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

Default Yes

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

68 Data Access Guide


Configuring data access global parameters
Configuring the global settings parameters 4
Server

<Server>
<Parameter Name="Load Drivers On Startup">Yes</Parameter>
...
</Server>
These are described below.

Description Determines how driver libraries are loaded.

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


tialization phase.
Values
• No: Drivers are loaded on demand.

Library mode: No
Default
Server mode: Yes

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>

Data Access Guide 69


4 Configuring data access global parameters
Configuring the global settings parameters

Determines the maximum length of time that an un-


used connection can remain idle in the connection
pool. This represents an upper bound for connection
lifetimes. A connection pool is a mechanism used by
data 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-
Description tion Server deployments:

Library: Value applies to nodes that have Connection


Server installed with desktop or other server products.

Server: Value applies to Connection Server stand


alone server installations. For information on deploying
Connection Server on a dedicated node see the SAP
BusinessObjects Enterprise Deployment Planning
Guide.

Library mode: -1
Default
Server: 60

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


Values 0: Connection not managed by the pool.

>0: Idle lifetime (in minutes).

SQL External Extension

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

70 Data Access Guide


Configuring data access global parameters
Configuring the global settings parameters 4
Note:
Description Do not change this setting.
Sets the file extension for external SQL files.

Default rss

SQL Parameter Extension

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

Note:
Description Do not change this setting.
Sets the file extension for SQL parameter files.

Default prm

Strategies Extension

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

Note:
Description Do not change this setting.
Sets the extension for strategy files.

Default stg

Data Access Guide 71


4 Configuring data access global parameters
Setting the deployment mode

Transient Object Timeout

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

Note:
Do not change this setting directly. You can change
it from the Central Management Console. See the
SAP BusinessObjects Enterprise Administrator's
Description
Guide.

Specifies how many minutes to keep unused tempo-


rary objects.

Default 60 (in minutes)

Setting the deployment mode


The Capabilities section helps you specify the deployment mode of
Connection Server to be used at runtime.

Beneath Capabilities section, Local name means connectivity service


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


tive attribute. Specific to Local capability, the MixedMode attribute enables
the use of Java Native Interface (JNI).

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

72 Data Access Guide


Configuring data access global parameters
Configuring the deployment mode 4
Example:
The following example shows the default values of <Capabilities> in
the cs.cfg file:

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

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


</Capabilities>

Configuring the deployment mode


Parameters defined in the <Settings> section of the cs.cfg file control
the access method.

• Parameters in the <Library> section control library mode. In this mode,


Connection Server is included in the client process. Most SAP
BusinessObjects applications use Connection Server in library mode.
• Parameters in the <Server> section control CORBA access. In this
mode, Connection Server is a CORBA server and is accessed remotely.
Connection Server serves two different kinds of clients: HTTP and CORBA
clients.

These parameters take precedence over any parameter definitions set in


other parts of the <Settings> section. Consequently, the settings defined
in the <Server> section override parameters set in other areas for
applications that use <Library> access. These are the following:

• Load Drivers On Startup


The default value of this parameter is Yes. This means all data access
drivers are loaded at Connection Server startup.
Caution:
To avoid connection failures, you must make sure your environment
provides all the necessary middleware, otherwise you need to modify the
<Settings> section by including the network layers and databases you
only need under <ActiveDataSources>. You can also set Enable
Failed Load to No.

Data Access Guide 73


4 Configuring data access global parameters
Configuring the driver to load in server 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 server


mode
You configure the cs.cfg file to address complex deployment scenarios
involving multiple Connection Servers in server mode. Specify the active
datasources to help client applications determine the drivers that each
Connection Server loads and uses. For more information about complex
deployment scenarios, see the SAP BusinessObjects Enterprise Deployment
Planning Guide.

The <ActiveDataSources> section helps you specify the network layers


and associated datasources you want Connection Server to use and expose.
This section works as a filter for drivers. Beneath the <ActiveData
Sources> section, the <NetworkLayer> elements list the drivers available
for connection. For each driver, the <DataBase> elements list the names
of the databases Connection Server is able to connect.

If you do not provide any <ActiveDataSources> section or if you leave


it empty, then no filtering is processed. Connection Server loads all the
available drivers.

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

74 Data Access Guide


Configuring data access global parameters
Configuring the driver to load in server mode 4
In addition to these settings, you must configure settings in the <Distribu
tion> section.

Example:
The example illustrates a configuration where Connection Server makes
the 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 connectivity


per type of machine, for example you want to connect SAP BusinessObjects
Enterprise applications to an MS SQL Server database installed on Microsoft
Windows and to an Oracle database installed on a UNIX machine.

Data Access Guide 75


4 Configuring data access global parameters
Configuring 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 Enterprise
software, specify the connectivities you want to deploy for each type of
database you require, as described on the image below.

• when configuring Connection Server in the cs.cfg file, set the <Active
DataSources> section for the library mode (<Library> section) as
you do for the server mode (<Server> section).
Because applications first try to establish connections through drivers
installed locally, you should configure the driver filter for both modes in
the 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>

76 Data Access Guide


Configuring data access global parameters
Configuring the CORBA access protocols 4
</Library>
<Server>
<Parameter Name="Load Drivers On Startup">Yes</Param
eter>
<Parameter Name="Max Pool Time">60</Parameter>
<Parameter Name="Transient Object Timeout">60</Param
eter>
<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 the CORBA access protocols


You set the following parameters in the <Distribution> section of cs.cfg
when using Connection Server with CORBA.

The <Protocols> section contains the default values that Connection


Server 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"/>

Data Access Guide 77


4 Configuring data access global parameters
Configuring the CORBA access protocols

78 Data Access Guide


Configuring data access
driver parameters

5
5 Configuring data access driver parameters
Configuring driver parameters

Configuring driver parameters


To configure data access for a particular data access driver, you can edit
the 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 utilities
that 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 for
each 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. These
files are named <driver>.sbo, where <driver> is the database
network layer to which the configuration file applies.

The parameters set in the Settings section of cs.cfg are overridden


by corresponding settings in the data access driver configuration files:
<driver>.sbo

The configuration files are located in the following paths, where connection
server-install-dir is the directory where the Connection Server
software is installed.

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

connectionserver-install-dir\connectionServer\

80 Data Access Guide


Configuring data access driver parameters
Configuring driver parameters 5
• Each .sbo file is in a sub-directory of this directory, where the
sub-directory is named after the database network layer, for example for
Oracle 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 Service


Marketplace website at service.sap.com/bosap-support, or contact your SAP
representative.

Data access driver SBO file

Essbase essbase.sbo

db2.sbo
IBM DB2
iseries.sbo

Informix informix.sbo

JDBC provides JDBC drivers for


databases. Check the SAP Service
MarketPlace website, or the jd
jdbc.sbo
bc.sbo file for details of the
databases supported for JDBC con-
nections.

Data Access Guide 81


5 Configuring data access driver parameters
Configuring driver parameters

Data access driver SBO file

Microsoft SQL Server odbc.sbo and oledb.sbo

Microsoft Analysis Services oledb_olap.sbo

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

ODBC odbc.sbo

Oracle oracle.sbo

Red Brick odbc.sbo

SAP sap.sbo

Sybase sybase.sbo

Teradata teradata.sbo

82 Data Access Guide


Configuring data access driver parameters
Configuring data access for DataDirect ODBC branded drivers 5
Data access driver SBO file

Various drivers
Note:
When developing a CSV driver using open.sbo
the Java Driver Development Kit, you
must locate all your configuration files
in this directory.

To view and edit an SBO file

Caution:
Before opening an SBO file, make a backup copy of the file. Some
configuration parameters must not be edited. If you change or delete them
it 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 access
driver.
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="parame
ter">value</Parameter> where parameter is the name of the
parameter, 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 DataDirect


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

Data Access Guide 83


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

drivers are provided as part of SAP BusinessObjects Enterprise software


and can only be used with SAP BusinessObjects applications such as SAP
BusinessObjects Web Intelligence, SAP BusinessObjects Desktop
Intelligence, 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 ODBC
5.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 installation
directory and platform-name for the UNIX platform name.

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

To enable the use of DataDirect branded drivers

Note:
The following section is only related to MS SQL Server 7.x, MS SQL Server
2000 SP4 and MS SQL Server 2005 SP2 databases.
Data Access supports the use of DataDirect ODBC 5.3 drivers for MS SQL
Server 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 driver
to work seamlessly with your current configuration settings. If you have
already deployed a driver in your environment, you will be able to install the
non-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.

84 Data Access Guide


Configuring data access driver parameters
Configuring data access for DataDirect ODBC branded drivers 5
3. Locate the appropriate DataBase section.
The Use DataDirect OEM Driver parameter of the DataBase section
is set to No by default. This means the data access is configured by default
to work for non-branded drivers.
4. Set the Use DataDirect OEM Driver parameter of the appropriate
DataBase 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/"defaultod
bc.ini
Export DEFAULT_ODBCFILE
ODBC_HOME="${BINDIR}/odbc"
Export ODBC_HOME
ODBCINI="${BOBJEDIR}enterprise120/"defaultodbc.ini
Export ODBCINI
Note:
DEFAULT_ODBCFILE can point to any file which holds the connection
details 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/so
laris_sparc/odbc/lib/CRmsss23.so
Description=DataDirect 5.3 SQLServer Wire Protocol
Driver
Address=10.6.61.197,1433
Database=bodb01
QuotedId=Yes
AnsiNPW=No
LogonID=evalkit
QEWSD=2454745
Password=evalkit

8. Start Connection Server from the CMC.

Data Access Guide 85


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

Connection Server is able to establish a connection to MS SQL Server


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

86 Data Access Guide


SBO parameter reference

6
6 SBO parameter reference
SBO parameter categories

SBO parameter categories


The configuration parameters in this guide are listed in the following
categories. Each category represents a database that has a separate sbo
file.
• Defaults
• Informix
• JavaBean
• JDBC
• ODBC
• OLE DB
• OLE DB OLAP
• Sybase ASE/CTLIB

Each parameter is shown with the following information:


• example of how the parameter appears in the XML file
• description of the parameter
• possible values that can be set for the parameter
• default value for the parameter

SBO file structure


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

88 Data Access Guide


SBO parameter reference
SBO file structure 6
File section Description

This section contains the default configuration


parameters that apply to all database middleware
Defaults that uses the data access driver. These parame-
ters override any corresponding values set in the
database middleware.

This section contains a sub-section for each


database middleware that is supported by the data
access driver. The Active parameter specifies if
middleware support is activated or not.

Values are YES or NO.

Each middleware section can contain the following


parameters:
• Name: Names of the middleware supported by
the data access driver. The middleware name
values set here appear in the Database Middle-
ware page of the new connection wizard.
• Aliases: Names of older middleware versions
Databases no longer officially supported by the data ac-
cess driver, but that are still in use. You can
add an alias parameter for an older middleware
version so that existing connections use the
current data access driver instead. You can set
configuration parameters specific to the old
middleware as parameters of the new alias.
You can create new connections using the
alias.
• Parameters: Configuration parameters with
values that apply specifically to a middleware.
Values set for parameters listed here override
the values set for the same parameters in the
Defaults section.

Data Access Guide 89


6 SBO parameter reference
Default SBO parameters

Default SBO parameters


The default SBO parameters are defined in cs.cfg, or under the Defaults
section 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 Array


Description
Binds.

True: the database supports Array Binds.


Values
False: the database does not support Array Binds.

Default False

Array Bind Size

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

Specifies the number of rows exported with each IN


Description
SERT command.

An integer that specifies the number of rows that are


Values
exported with each INSERT.

90 Data Access Guide


SBO parameter reference
Default SBO parameters 6
Default The value set in the cs.cfg file.

Array Fetch Available

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

Specifies whether or not the Array Fetch method is


Description
supported.

True: the Array Fetch method is supported.


Values
False: the Array Fetch method is not supported.

Default The value set in the cs.cfg file.

Array Fetch Size

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

Specifies the number of rows of data retrieved with


each 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-
Description
formance.
• If the number is high, the system performs fewer
retrieval operations, but it requires more memory
for each.

Data Access Guide 91


6 SBO parameter reference
Default SBO parameters

An integer that specifies the number of rows that are


Values retrieved with each Array Fetch.

1 : specifies that Array Fetch is deactivated.

Default Value set in the cs.cfg file.

Catalog Name Max Size

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

Specifies the maximum length in characters of a


Description
database catelog name.

An integer that specifies the maximum database cat-


Values
alog name length in characters.

Default The value set in the database middleware.

Catalog Separator

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

Specifies the separator character that is used between


Description
identifiers.

Values The separator character to use.

92 Data Access Guide


SBO parameter reference
Default SBO parameters 6
If not specified, Connection Server uses the separator
Default
specified in the database middleware.

CharSet

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

Specifies the character set of the data returned by the


Description
database middleware.

UTF8: 8-bit UCS/Unicode Transformation Format


Values
UCS2: 2-byte Universal Character Set

If not specified, Connection Server uses the separator


Default
specified in the database middleware.

Column Name Max Size

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

Specifies the maximum length in characters of a


Description
database column name.

An integer that specifies the maximum database col-


Values
umn name length in characters.

Default The value set in the database middleware.

Data Access Guide 93


6 SBO parameter reference
Default SBO parameters

Connection Shareable

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

Note:
Do not edit this parameter.
Description Specifies if a connection is shareable between differ-
ent requesters. Operates in conjunction with the
Shared Connection parameter.

True: the connection can be shared between multiple


users.
Values
False: the connection cannot be shared between
users.

Default False

Related Topics
• Shared Connection

Cost Estimate Available

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


ter>

Specifies if the database middleware supports cost


Description
estimation.

94 Data Access Guide


SBO parameter reference
Default SBO parameters 6
True: the middleware supports cost estimation.
Values False: the middleware does not support cost estima-
tion.

Default False

Description File

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

Note:
Do not edit this parameter.
Description
Specifies the name of the file that holds the connection
wizard input field labels.

Driver Capabilities

<Parameter Name="Driver Capabilities">Procedures ,


Query</Parameter>

Data Access Guide 95


6 SBO parameter reference
Default SBO parameters

The capabilities of the driver, that is whether it can


access stored procedures and queries available in
the database software. This parameter is set typically
using the New Connection wizard. You can include
both values in the parameter.
Description
Note:
This parameter must be set to Procedures for a Jav-
aBeans driver. The functionality of a JavaBeans driver
is defined as stored procedures as far as SAP Busi-
nessObjects applications are concerned.

Procedures: the driver can access the data retrieval


procedures that are defined in the database software.
Values
Query: the driver can access the data retrieval queries
that are defined in the database software.

Default Procedures

Escape Character

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

Specifies the character to use to escape strings of


Description
special characters, for example patterns.

Values The character to use as the escape character.

If not specified, Connection Server retrieves the value


Default
from the middleware.

96 Data Access Guide


SBO parameter reference
Default SBO parameters 6

Extensions

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

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

Family

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

Note:
Do not edit this parameter.
Specifies the family of the database engine that is
Description displayed in the Database Middleware Selection page
of the New Connection wizard. The set of middleware
that corresponds to your license is displayed on this
page in a tree view.

Field Size Factor

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

Note:
Do not change this value.
Description The value to use to compute the size of returned
content expressed as field characters when the con-
tent is returned as bytes. This is used for DB2 only.

Data Access Guide 97


6 SBO parameter reference
Default SBO parameters

Force Execute

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

Specifies whether or not the SQL query is executed


before retrieving results. Supported by the following:
• ODBC
Description
• OLE
• DB
• JDBC

Never: The SQL query is never executed before re-


trieving results.

Values Procedures: Execute only for stored procedures.

Always: The SQL query is always executed before


retrieving the results.

Default Never

Identifier Case

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

Specifies how the database handles the case behavior


Description
of simple identifers.

98 Data Access Guide


SBO parameter reference
Default SBO parameters 6
LowerCase: identifiers must be in lower case.

UpperCase: identifiers must be in upper case.


Values
MixedCase: identifiers can be in mixed case.

SensitiveCase: identifiers are case sensitive.

If this setting is not specified, Connection Server re-


Default
trieves the information from the database middleware.

Identifier Quote String

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

Description Specifies the character used to quote identifiers.

Values The character used to quote identifiers.

If this setting is not specified, Connection Server re-


Default
trieves the information from the database middleware.

LIKE Escape Clause

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

Specifies if escape character use is supported in the


Description
LIKE clause.

Data Access Guide 99


6 SBO parameter reference
Default SBO parameters

True: escape character use is supported in the LIKE


clause.
Values
False: escape character use is not supported in the
LIKE clause.

If this setting is not specified, Connection Server re-


Default
trieves the information from the database middleware.

Locale

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

Description Specifies the locale of the middleware.

The locale of the middleware.


• language is specified in ISO-639 standard
Values
• country is specified in ISO-3166 standard
For example: en_US for English United States.

If this setting is not specified, Connection Server re-


Default
trieves the information from the database middleware.

Max Rows Available

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

100 Data Access Guide


SBO parameter reference
Default SBO parameters 6
Specifies if the driver supports the Max Rows function
Description to limit the maximum number of rows that can be re-
trieved from a datasource.

True: The driver supports the Max Rows function .


Values False: The driver does not support the Max Rows
function.

Default False

Optimize Execute

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

Specifies whether or not Connection Server optimizes


Description the execution of SQL queries. This parameter is sup-
ported by Oracle and ODBC drivers only.

True: specifies that where possible, SQL queries are


Values optimized on execution.

False: SQL queries are not optimized for execution.

Default False

Owners Available

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

Data Access Guide 101


6 SBO parameter reference
Default SBO parameters

Specifies whether or not Owners are supported by


Description
the target database.

True: Specifies that owners are supported by the tar-


get database.
Values
False: Specifies that owners are not supported by the
target database.

Not specified: value retrieved from the database mid-


Default
dleware.

Password Encryption

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

Specifies whether or not to use the encryption pass-


word mechanism specified in the middleware for the
Description password entered in the Connection details dialog
box. This parameter is used only with Sybase. It is
included in the Defaults section for future compatibility.

True: Specifies that the encryption password mecha-


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

Default True

102 Data Access Guide


SBO parameter reference
Default SBO parameters 6

Procedure Name Max Size

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


ter>

Specifies the maximum length in characters of a


Description
database procedure name.

An integer that specifies the maximum database pro-


Values
cedure name length in characters.

Default The value set in the database middleware.

Procedure Parameter Name Max Size

<Parameter Name="Procedure Parameter Name Max


Size">1024</Parameter>

Specifies the maximum length in characters of a


Description
database procedure parameter name.

An integer that specifies the maximum database pro-


Values
cedure parameter name length in characters.

Default The value set in the database middleware.

Data Access Guide 103


6 SBO parameter reference
Default SBO parameters

Qualifiers Available

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

Description Specifies whether or not Qualifiers are supported.

True: Specifies that Qualifiers are supported.


Values
False: Specifies that Qualifiers are not supported.

Not specified. Connection Server retrieves this infor-


Default
mation from the database middleware.

Query TimeOut Available

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


ter>

Specifies whether or not Query TimeOut is supported


by the database middleware, that is if a query that is
Description
running can be cancelled after a time period has ex-
pired.

True: Specifies that Query TimeOut is supported by


the database middleware.
Values
False: Specifies that Query TimeOut is not supported
by the database middleware.

Default False

104 Data Access Guide


SBO parameter reference
Default SBO parameters 6

Quoted Identifier Case

<Parameter Name="Quoted Identifier Case Avail


able">True</Parameter>

Specifies how the database treats the case of quoted


Description
identifiers.

LowerCase: quoted identifiers must be in lower case.

UpperCase: quoted identifiers must be in upper case.


Values
MixedCase: quoted identifiers can be in mixed case.

SensitiveCase: quoted identifiers are case sensitive.

Not specified. Connection Server retrieves the infor-


Default
mation from the middleware.

Schema Name Max Size

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

Specifies the maximum length in characters of the


Description
database schema name.

An integer that specifies the maximum database


Values
schema name length in characters.

Default The value set in the database middleware.

Data Access Guide 105


6 SBO parameter reference
Default SBO parameters

Shared Connection

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

Specifies whether or not the requested connection of


a connection pool is shared. Operates in conjunction
Description with the Connection Shareable parameter. Is not
taken into account if the Max Pool Time parameter
of cs.cfg is set to 0.

True: the connection is shared.


Values
False: the connection is not shared.

Default False

Related Topics
• Max Pool Time
• Connection Shareable

SQL External File

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

Note:
Do not edit this value.
Description
The SQL External file file holds configuration details
used by the data access layer.

106 Data Access Guide


SBO parameter reference
Default SBO parameters 6

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
Description
You must ensure that this file is located in the same
directory as the data configuration file (.sbo file).

Values See the list of values in the SBO file.

Default The listed values.

SSO Available

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

Specifies whether or not Single Sign-On (SSO) is


Description
supported.

True: SSO is supported.


Values
False: SSO is not supported.

Default False

Data Access Guide 107


6 SBO parameter reference
Default SBO parameters

Strategies File

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

Specifies the name, with no extension, of the Strategy


file (.stg). This file contains the external strategies
Description that Universe Designer uses for automatic universe
creation. Strategy files are stored in the same directory
as the .sbo file.

db2 for DB2 data access drivers.

informix for Informxix.

Values oracle for Oracle.

sybase for Sybase.

teradata for Teradata.

Default See values above.

Table Name Max Size

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

Specifies the maximum length in characters of a


Description
database table name.

An integer that specifies the maximum database table


Values
name length in characters.

108 Data Access Guide


SBO parameter reference
Default SBO parameters 6
Default The value set in the database middleware.

Transactional Available

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

Specifies if SQL operations run against the database


are run as block transactions or individually.
Description This parameter is not listed by default in the .sbo file.
Add it to the .sbo file if your data access driver does
not support transactional mode.

Yes: operations against the database are run as a


block when committed.

No: each SQL statement is immediately committed.


That is, Autocommit is de-activated.
Values
Note:
Do not use a driver with Transactional Avail
able=No to access the SAP BusinessObjects repos-
itory.

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

Transaction Mode

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

Data Access Guide 109


6 SBO parameter reference
Default SBO parameters

Specifies the transaction mode that the database us-


Description
es.

AutoCommit: statements are committed automatically


on completion of a request.
Values
Transactional: on competion, an explicit call either
completes or rolls back the statement.

If not specified, the value is retrieved from the


Default
database middleware.

Type

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

Specifies the data source type.


Description Note:
This parameter must not be modified.

Version

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

Specifies the database version.


Description Note:
This parameter must not be modified.

110 Data Access Guide


SBO parameter reference
Informix SBO parameters 6

XML Max Size

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

Description Specifies the maximum size allowed for XML data.

Values The maximum allowed XML size, in bytes.

Default This varies depending on the database.

Informix SBO parameters


These parameters apply to the Informix SBO file. They are used to define
the 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, you
must 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 UNIX
environment, you need to modify the unicode configuration. This configuration
information can be in either of the following locations:
• The .odbc.ini file located in your home directory.

Data Access Guide 111


6 SBO parameter reference
Informix SBO parameters

• The file specified by the ODBCINI environment variable.

1. Locate the ODBC.INI file or the file specified by the ODBCINI environment
variable, 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 information
added:

[ODBC]
UNICODE=UTF-8

V5toV6DriverName

<Parameter Name="V5toV6DriverName">{Informix 3.34 32


BIT}</Parameter>

Specifies the conversion rule from Informix Connect


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

The exact name of the Informix driver installed on the


Values
machine.

Default The value set in the cs.cfg file.

112 Data Access Guide


SBO parameter reference
JavaBean SBO parameters 6

Unicode

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

Specifies if the access driver can benefit from the


Unicode configuration of the client middleware. This
parameter appears as a driver default in the cs.cfg
file. Its value applies to all data access drivers. It is
Description
not listed by default in the SBO file. If you want to
over-ride the default value you add it to the Defaults
section of the SBO file for the target data access
driver.

UTF8: 8-bit UCS/Unicode Transformation Format


coding.
Values
CharSet: Character Set coding.

UCS2: 2-byte Universal Character Set coding

Default The value set in the cs.cfg file.

JavaBean SBO parameters


These parameters apply to the JavaBean SBO file. They are used to define
a JavaBean connection.

These parameters are defined in the \\connectionserver-install-


dir\connectionServer\javabean\javaean.sbo file.

JavaBean Class

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

Data Access Guide 113


6 SBO parameter reference
JavaBean SBO parameters

Defines the entry point of the JavaBean that the SAP


BusinessObjects application uses. The entry point is
Description the definition of a java class extending from the Bean
interface specified through the com.businessobjects
package.

Values A fully-qualified class JavaBean class name.

Default None.

URL Format

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

Specifies the URL Format.

The JDBC specification does not specify the format


of the connection string that it requires. Vendors use
different kinds of URL format, for example:
• MySQL vendor :
Description
jdbc:mysql://$DATASOURCE$/$DATABASE$
• Oracle vendor :

jdbc:oracle:thin:@$DATA
SOURCE$:$DATABASE$

Values The URL Format

Default None

114 Data Access Guide


SBO parameter reference
JDBC SBO parameters 6
JDBC SBO parameters
These parameters apply to the JDBC SBO file. They are used to define a
JDBC 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-


Description
trieved.

True: ForeignKeys can be retrieved.


Values False: ForeignKeys cannot be re-
trieved.

Default True

JDBC Class

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

Description The JDBC driver's fully qualified Java class.

Data Access Guide 115


6 SBO parameter reference
ODBC SBO parameters

Depends on the vendor/datasource, for example :


• oracle.jdbc: OracleDriver for Oracle
Values
• com.ibm.db2.jcc.DB2Driver: for DB2

Default None.

PrimaryKey Available

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

Specifies whether or not the primary keys can be re-


Description
trieved.

True: Primary keys can be retrieved.


Values
False: Primary keys cannot be retrieved.

Default True

ODBC SBO parameters


These parameters apply to the ODBC SBO file. They are used to define an
ODBC SBO connection.
These parameters are defined in the \\connectionserver-install-
dir\connectionServer\odbc\odbc.sbo file.

116 Data Access Guide


SBO parameter reference
ODBC SBO parameters 6

Connection Status Available

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


rameter>

Specifies whether or not the middleware can detect


Description
a bad connection.

True: The middleware can detect a bad connection.


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

Default The value set in the middleware.

Empty String

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

Specifies that certain functions, for example SQL ta-


Description bles, receive either an empty string or a null pointer
to replace missing parameters.

NullString: Specifies that a null string is used.


Values
EmptyString: Specifies that an empty string used.

Default EmptyString

Data Access Guide 117


6 SBO parameter reference
ODBC SBO parameters

Force Close Statement

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

Specifies that the SQL statement is closed after it


Description
completes execution.

True: the SQL statement is closed after it executes.


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

Native Int64 Available

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


ter>

Indicates if 64 bit integers can be handled directly by


Description
middleware.

True: Specifies that 64-bit integers can be handled


by the middleware.
Values
False: The Data Access Layer emulates the Int64
methods.

Default True

118 Data Access Guide


SBO parameter reference
ODBC SBO parameters 6

ODBC Cursors

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

Specifies if the ODBC cursor library is used by the


Description
data access driver.

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


cess driver.
Values
No: the ODBC cursor library is not used by the data
access driver.

Default The value set in the cs.cfg file.

SQLDescribeParam Available

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


eter>

Specifies whether or not the SQLDescribeParam


Description
Available mechanism is available.

True: Specifies that the SQLDescribeParam Available


mechanism is available.
Values
False: Specifies that the SQLDescribeParam Available
mechanism is not available.

Default The value set in the database middleware.

Data Access Guide 119


6 SBO parameter reference
ODBC SBO parameters

SQLMoreResults Available

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


ter>

Specifies whether or not the SQLMoreResults Avail-


Description
able mechanism is supported.

True: Specifies that the SQLMoreResults Available


mechanism is supported.
Values
False: Specifies that the SQLMoreResults Available
Available mechanism is not supported.

Default The value set in the middleware.

Use DataDirect OEM Driver

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


ter>

Specifies whether connections to MS SQL Server


Description
databases use DataDirect ODBC branded drivers.

Yes: The connection uses the branded driver.


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

Default No

120 Data Access Guide


SBO parameter reference
OLE DB SBO parameters 6
Related Topics
• Configuring data access for DataDirect ODBC branded drivers

OLE DB SBO parameters


These parameters apply to the OLE DB SBO file. They are used to define
an 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</Pa


rameter>

Note:
Do not edit this parameter.
Description
Specifies class ID of OLEDB enumerator. This param-
eter is used with OLEDB only.

Provider CLSID

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

Note:
Do not edit this parameter.
Description
Specifies class ID of OLEDB provider. This parameter
is used with OLEDB only.

Data Access Guide 121


6 SBO parameter reference
OLE DB OLAP SBO parameters

OLE DB OLAP SBO parameters


These parameters apply to the OLE_DB OLAP SBO file. They are used to
define 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>

Note:
Do not edit this parameter.
Description
Specifies class ID of OLEDB provider. This parameter
is used with OLEDB OLAP only.

Sybase ASE/CTLIB
These parameters apply to the Sybase ASE/CTLIB SBO file. These
parameters 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-


Description
ed.

122 Data Access Guide


SBO parameter reference
Sybase ASE/CTLIB 6
True: quoted identifiers are supported.
Values
False: quoted identifiers are not supported.

Default The value set in the middleware.

Data Access Guide 123


6 SBO parameter reference
Sybase ASE/CTLIB

124 Data Access Guide


Configuring SQL generation
parameters

7
7 Configuring SQL generation parameters
About SQL generation parameters

About SQL generation parameters


SQL generation parameters control the SQL queries that are generated to
retrieve 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 corresponding
Universe-level PRM file settings

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

About PRM files


The .prm files contain parameters to control the way SAP BusinessObjects
applications generate SQL. There is a .prm file corresponding to each
database driver. The .prm files allow database-dependent factors to control
how a Universe generates SQL, based on the connection and the database
that it is attached to.

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

The .prm file for each driver is found in the connectionserver-install-


dir\connectionServer\<RDBMS> directory, where <RDBMS> is the
database name.

The following <driver>.prm files are available:

126 Data Access Guide


Configuring SQL generation parameters
About PRM files 7
PRM Help text files
Data access driver PRM files
(English)

datafedera
Datafederator datafederator.prm
toren.prm

Essbase essbase.prm essbaseen.prm

HSQLDB hsqldn.prm hsqldben.prm

db2udb.prm db2udben.prm

IBM DB2 db2mvs.prm db2mvsen.prm

db2iseries.prm db2iseriesen.prm

Informix informix.prm informixen.prm

Javabean javabean.prm javabeanen.prm

JDBC jdbc.prm jdbcen.prm

sqlsrv7.prm for SQL


Server 7 and 2000.

sqlsrv.prm for SQL sqlsrv7en.prm


Microsoft SQL Server
Server 2005. sqlsrven.prm
sqlsrv_as.rm
for analysis services.

Microsoft Jet msjet.prm msjeten.prm

Data Access Guide 127


7 Configuring SQL generation parameters
About PRM files

PRM Help text files


Data access driver PRM files
(English)

MySQL mysql.prm mysqlen.prm

Neoview neoview.prm neoviewen.prm

Netezza netezza.prm netezzaen.prm

odbc.prm odbcen.prm
ODBC
access.prm accessen.prm

Open open.prm openen.prm

Open Access openaccess.prm openaccessen.prm

oracle9.prm for Ora-


cle 9. oracle9en.prm
Oracle
oracle.prm for Oracle oracleen.prm
10 and higher.

PostgreSQL postgresql.prm postgresqlen.prm

Progress progress.prm progressen.prm

Red Brick redbrick.prm redbricken.prm

128 Data Access Guide


Configuring SQL generation parameters
About PRM files 7
PRM Help text files
Data access driver PRM files
(English)

asiq.prm asiqen.prm

Sybase sybase11.prm sybase11en.prm

sybase.prm sybaseen.prm

SAP sap.prm sapen.prm

Teradata teradata.prm teradataen.prm

The <driver>.prm files are in XML format. You should use an XML editor to
view 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 contains
parameters that have default values set:

File section Description

SQL parameters used to create and optimize a universe,


for example, COMMA, OUTERJOINS_GENERATION,
Configuration REVERSE_TABLE_WEIGHT. These parameters are not
directly available to any SAP BusinessObjects product.
They are described in this chapter.

Data Access Guide 129


7 Configuring SQL generation parameters
About PRM files

File section Description

Date operators available to Universe Designer, SAP


BusinessObjects Desktop Intelligence and SAP Busines-
DateOperations
sObjects Web Intelligence, for example YEAR, QUARTER,
MONTH.

Operators available to Universe Designer, SAP Busines-


sObjects Desktop Intelligence and SAP BusinessObjects
Operators
Web Intelligence, for example ADD, SUBSTRACT, MUL-
TIPLY.

130 Data Access Guide


Configuring SQL generation parameters
About PRM files 7
File section Description

Functions available to Universe Designer, SAP Busines-


sObjects Desktop Intelligence and SAP BusinessObjects
Web Intelligence, for example Average, Sum, Variance.

Help text that appears when functions in this section are


selected in Universe Designer, SAP BusinessObjects
Desktop Intelligence and SAP BusinessObjects Web In-
telligence is listed in the file <driver><language>.prm, for
example, oracleen.prm. This file is found in the same di-
rectory as the <driver>.prm file. You can open it to view
descriptions 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
Functions clause.
• False sets that the query does not generate a
group by clause.

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


function list.
• InMacro: In Reporter, if this value is True, then the
function is listed in the User Objects function list and
if it is False then the function is not listed.
• Type: Function data type.
• Arguments: Arguments accepted by the function. A
function 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.

Data Access Guide 131


7 Configuring SQL generation parameters
To view and edit a PRM file

Note:
Only the Configuration section is documented here. The Configuration section
parameters can be edited to optimize queries run against universes using
the target data access driver.
Related Topics
• To view and edit a function help text file

To view and edit a PRM file


You can view, edit, and add parameters to a PRM file as follows:
1. Browse to the directory that stores the PRM file for your target data access
driver. PRM files are stored here:
connectionserver-install-dir\connectionServ
er\<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 file


The Help text that appears under each function when selected in Universe
Designer is maintained in a separate XML file. You can edit and add text to
describe a function by editing the file <driver><language>.prm. There is a
Help text file for each language version of SAP BusinessObjects products
installed.

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

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

132 Data Access Guide


Configuring SQL generation parameters
To edit the help text for a PRM function 7
To edit the help text for a PRM function
1. 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 copy
an existing function entry and copy it into the Function section. You
then edit the new function text.
• Enter Help text for the function.

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.

Data Access Guide 133


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

134 Data Access Guide


PRM parameter reference

8
8 PRM parameter reference
PRM file configuration reference

PRM file configuration reference


The Configuration SQL parameters are listed alphabetically. To view
functions, date operators, and other operators available, open a <driver>.prm
file in a XML editor, each parameter is defined in the following tag:

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

where parameter is the name of the parameter, and value is the value
attributed to the parameter.

Each parameter is shown with the following information:


• example of how the parameter appears in the XML file
• description of the parameter
• possible values that can be set for the parameter
• default value for the parameter

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

BACK_QUOTE_SUPPORTED

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

Specifies whether or not to enclose table or column


Description names containing spaces or special characters with
backquotes.

Y : Encloses table and column name with backquotes.


Values N : Does not insert quotes around table and column
names.

136 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
Default Y

Result Table name=`My Table`

CASE_SENSITIVE

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

Specifies if the database is case sensitive. Parameter


Description
used with Oracle.

Y : Specifies that the database is case sensitive.


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

Default N

CHECK_OWNER_STATE

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

Specifies if the SQL checks if the database supports


Description
table classification by owner name.

Y: The SQL checks if the database supports table


classification by owner name.
Values
N: The SQL does not check if the database supports
table classification by owner name.

Data Access Guide 137


8 PRM parameter reference
PRM file configuration reference

Default Y

CHECK_QUALIFIER_STATE

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

Specifies if the SQL checks if the database supports


Description
table classification by qualifier.

Y: Checks if the database supports table classification


by qualifier.
Values
N: Does not check if the database supports table
classification by qualifier.

Default Y

COMMA

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

Specifies what database concatenation operator


should be used to replaces a comma for objects that
have the following syntax:
Description
Tab.Col1, Tab.Col2.

Parameter is used with all data access drivers.

138 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
||' '||
Values
+' '+

Default ||' '||

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

CONCAT

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

Specifies the concatenation operator. The parameter


Description
is used with all data access drivers.

||
Values
+

Default ||

CONSTANT_SAMPLING_SUPPORTED

CONSTANT_SAMPLING_SUPPORTED

Description Specifies if the database supports random sampling.

Data Access Guide 139


8 PRM parameter reference
PRM file configuration reference

Yes: The database supports random sampling.


Values
No: The database does not support random sampling.

Default Yes

DATABASE_DATE_FORMAT

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

For Oracle only. Specifies the default date and hour


Description
formats stored on the server.

Values DD-MM-YYYY HH24:MI:SS

Default DD-MM-YYYY HH24:MI:SS

DATATYPE_BLOB

Name="Datatype_Blob">LONGVARCHAR</Parameter>

Note:
Do not edit this parameter.
Description Column database datatype for Blob object. This pa-
rameter is not used for this release. It is included for
future compatibility.

140 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

DATATYPE_DOUBLE

<Parameter Name="Datatype_Double">: Value depends on the


database.

Note:
Do not edit this parameter.
Description
Column database datatype for Date object (CREATE
table command)

DATATYPE_DTM

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

Note:
Do not edit this parameter.
Description
Column database datatype for Date object (CREATE
table command)

DATATYPE_INT

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

Note:
Do not edit this parameter.
Description
Column database datatype for Numeric object (CRE-
ATE table command)

Data Access Guide 141


8 PRM parameter reference
PRM file configuration reference

DATATYPE_NULL

<Parameter Name="Datatype_Null"/>

Note:
Do not edit this parameter.
Description
Database SQL syntax for Null values (INSERT com-
mand)

DATATYPE_STRING

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

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

DATE_WITHOUT_QUOTE

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

Specifies support for dates without single-quotes in


Description the SQL syntax.

Parameter is used with MS Access.

142 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
Y: Dates are not surrounded by single-quotes.
Values
N: Dates are surrounded by single-quotes.

Default Y

DELIMIT_IDENTIFIERS

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

Specifies if the quotation marks set in the IDENTIFI-


Description ER_DELIMITER parameter are used to enclose table
and column names.

YES: The delimiter specified in IDENTIFIER_DELIM-


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

Default YES

Result Table name="my_table"

EXT_JOIN

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

Data Access Guide 143


8 PRM parameter reference
PRM file configuration reference

Specifies if outer joins are supported.


Description
This parameter is used by all data access drivers.

YES: The database supports outer joins.

Values NO: The database does not support outer joins. The
Outer join check boxes in the Edit Join dialog box
of Universe Designer are dimmed.

Default YES

EXT_JOIN_INVERT

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

Specifies how to display an outer join symbol in a join


expression.
Description
This parameter is used with IBM DB2, Informix, Ora-
cle, and Teradata.

YES: When you click an Outer join check box in the


Edit Join dialog box of Universe Designer, the outer
join symbol appears reversed in position in a join ex-
pression.
Values
NO: When you click an Outer join check box in the
Edit Join dialog box of Universe Designer, the outer
join symbol appears on the same side on which you
created the outer join.

Default YES

144 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

EXTERN_SORT_EXCLUDE_DISTINCT

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

Specifies whether or not the application generates a


Description SELECT DISTINCT when a query contains an OR-
DER BY.

Y: A SELECT DISTINCT is not generated when the


query contains an ORDER BY.
Values
N: A DISTINCT is generated when the query contains
an ORDER BY.

Default Y

GROUPBY_EXCLUDE_COMPLEX

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

Specifies whether the database allows you to enter


Description formulas, aliases or indexes in GROUP BY clauses.

Parameter is used with IBM DB2.

Data Access Guide 145


8 PRM parameter reference
PRM file configuration reference

Y: Specifies that the database does not allow you to


enter formulas, aliases or indexes in GROUP BY
clauses. If you run a query containing measure objects
and complex objects (e.g. with the substring function
or the concatenation operator), your application dis-
Values plays the following error message: Your database
does not allow you to do aggregations
with the <object name> object.

N: Specifies that the database does allow you to enter


formulas, aliases or indexes in GROUP BY clauses.

Default N

GROUPBY_WITH_ALIAS

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

Specifies whether the database can create a GROUP


Description BY clause in the SELECT statement.

Parameter is used with Red Brick.

Y: Allows you to create a GROUP BY clause in the


SELECT statement. An alias would be used for exam-
ple to replace a T1.col + T2.col +...Tn.col n .col
Values statement.

N: Does not let you to create a GROUP BY clause in


the SELECT statement.

Default Y

146 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

GROUPBY_WITHOUT_CONSTANT

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

Specifies whether or not you authorize the addition of


objects whose SQL definition is a constant in a
Description
GROUP BY clause. Parameter is used by IBM DB2
and Microsoft SQL Server

Y: Specifies that you can add any constant object to


the query but it will not be present in the GROUP BY
clause.
Values
N: Specifies that you can insert all the objects of a
query (i.e. without aggregate functions) in a GROUP
BY clause.

Default Y

GROUPBYCOL

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

Specifies whether a GROUP BY clause accepts inte-


Description
gers for column names.

Data Access Guide 147


8 PRM parameter reference
PRM file configuration reference

YES: Specifies that a GROUP BY clause accepts a


column's index from the SELECT instead of column's
name.
Values
NO: Specifies that a GROUP BY clause does not ac-
cepts a column's index from the SELECT instead of
column's name.

Default NO

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 the
parameter BACK_QUOTE_SUPPORTED is activated.
• tables or column names regardless of their characters
Description are enclosed within quotation marks if the parameter
DELIMIT_IDENTIFIERS is activated.
To use this parameter, either BACK_QUOTE_SUP-
PORTED or DELIMIT_IDENTIFIERS must be set to
YES. This is the default value of both parameters.

": Table or column names that contain spaces or


special characters are enclosed in double quotation
marks.
Values
': 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.

148 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
Default "

Result Table name="My Table"

IF_NULL

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

Specifies a function that takes two parameters. If the


Description first parameter returns NULL, the second parameter
value is used.

Values Database-dependent.

Default Database-dependent.

INTERSECT

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

Specifies if the database supports the INTERSECT


Description
set operator.

Data Access Guide 149


8 PRM parameter reference
PRM file configuration reference

INTERSECT: The database supports the INTERSECT


set operator.
Values No value: The database does not support the INTER
SECT set operator. In this case, two queries are
generated.

Default INTERSECT

KEY_INFO_SUPPORTED

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

Specifies if you can retrieve primary and secondary


Description
key definitions from the database account.

Y: Specifies that the database lets you retrieve primary


and secondary key definitions from the database ac-
count. This parameter enables Universe Designer to
Values display the keys in the Structure window.

N: Specifies that the database does not let you retrieve


primary and secondary key definitions from the
database account.

Default Y

LEFT_OUTER

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

150 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
<Parameter Name="LEFT_OUTER">$*</Parameter>

Description Specifies the left outer join syntax.

$(+) This syntax is used with Oracle. $ represents a


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

Default See values above.

LENMAXFORCOLUMNNAME

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

Note:
Do not edit this parameter.
Description
Maximum length for column name (by default the ob-
ject name is proposed) (CREATE table command)

LENMAXFORTABLENAME

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

Note:
Do not edit this parameter.
Description
Maximum length for VARCHAR column datatype
(CREATE table command).

Data Access Guide 151


8 PRM parameter reference
PRM file configuration reference

LENMAXFORVARCHAR

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

Note:
Do not edit this parameter.
Description
Maximum length for VARCHAR column datatype
(CREATE table command).

MINUS

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

Specifies if the database supports the MINUS set


Description
operator.

MINUS Specifies that the database supports the MI-


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

no value Specifies that the database does not support


the MINUS set operator. In this case, two queries are
generated.

Default MINUS

152 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

NO_DISTINCT

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

Specifies if the database supports the DISTINCT


Description keyword.

This parameter is used with MS Access.

Y: Specifies that the database does not support the


DISTINCT keyword. This behavior disables:
• The Distinct Values option that appears when
you click the View Values button in the Quick
Design wizard.
Values • The Countdistinct function that appears when you
create a condition with the Calculation operand in
the Query Panel.

N: Specifies that the database does support the DIS


TINCT keyword.

Default Y

NULL_IN_SELECT_SUPPORTED

<Parameter Name="NULL_IN_SELECT_SUPPORTED">Yes</Parame
ter>

Specifies if the database supports NULL as a column


Description
in the SELECT statement.

Data Access Guide 153


8 PRM parameter reference
PRM file configuration reference

Yes: NULL is supported as a column in the SELECT


statement.
Values
No: NULL is not supported as a column in the SE
LECT statement.

Yes

Default No for Teradata, DB2, Informix and Red Brick


databases, which do not support the NULL value as
column.

OLAP_CLAUSE

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

Specifies whether SAP BusinessObjects applications


generate a WHEN or QUALIFY clause if a function
Description listed in the RISQL_Functions parameter is used in
a condition. This parameter must be used with the
GROUPBY clause.

WHEN: Generates a WHEN clause if a function listed


in the RISQL_Functions parameter is used in a condi-
tion. This is the default value for Red Brick databases.
Values QUALIFY: Generates a QUALIFY clause if a function
listed in the RISQL_Functions parameter is used in a
condition. This is the default value for Teradata
databases.

Default See values above.

154 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

OUTERJOINS_GENERATION

<Parameter Name="OUTERJOINS_GENERATION">ANSI92</Parame
ter>

This parameter controls the default outer join generation behavior. You can
set that
• Outer join generation conforms to the ANSI92 specification.
• Outer join generation remains the same as for previous versions of
Universe Designer.

Note:
The PRM file OUTERJOINS_GENERATION parameter relates to the universe
ANSI92 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 parameter
overrides 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 joins
conform to ANSI92 depending on whether the universe ANSI92 setting
is YES or NO.

Remember:
The ANSI92 value makes REVERSE_TABLE_WEIGHT parameter not useful
for optimization of SQL generation. Outer joins that conform to ANSI92
behavior leads the order of the tables in the SQL sentence.

Data Access Guide 155


8 PRM parameter reference
PRM file configuration reference

Specifies the SQL syntax for outer joins.

The ANSI92 value generates an outer join in the


FROM clause. Other values generate the outer join
in the WHERE clause.
Description
When you modify this setting, you should check join
properties to verify that the outer join expression is
valid, and that the cardinalities are correct. ANSI92
does not support any manual customization in the join
syntax.

The primary values for OUTERJOINS_GENERATION


are:
• ANSI92: The default outer join behavior conforms
to the ANSI92 standard no matter what the ANSI92
parameter value of Universe Designer.
• No: Outer joins are not supported.
Values
• USUAL: The default outer join behavior is the same
as with previous versions of Universe Designer.
This behavior is overridden if ANSI92 parameter
of Universe Designer is set to Yes.

Other settings are available depending on the


database. See the defaults below.

156 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
ANSI_92: Default value for Oracle, SQL Server 2005
and Sybase.

DB2: Default value for IBM DB2.

FULL_ODBC: Can be used with Microsoft SQL Server

Default INFORMIX: Default value for Informix.

INGRES: Default value for Teradata.

NO: Default value for ODBC.

USUAL: Default value for Neoview, Netezza, Red


Brick, SQL Server 2000.

Examples of OUTERJOINS_GENERATION parameter settings


Setting = USUAL:

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

FROM T2 LEFT OUTER JOIN T1


ON 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 T2
OUTER T1
WHERE T1.col1=T2.col2

Data Access Guide 157


8 PRM parameter reference
PRM file configuration reference

Setting = FULL-ODBC

FROM {oj T1 RIGHT OUTER JOIN T2 ON T2.col2=T1.col1


T2 INNER JOIN 3 on T2.col3 = T3.col1}

Setting = ANSI_92:

SELECT DISTINCT
t1.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 the
behavior of existing universes irrespective of the universe-level setting for
the ANSI92 parameter.

To set that your existing Oracle universes behave as with the previous
Universe 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 in
previous 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>

158 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
Allows SAP BusinessObjects applications to include
RISQL functions when generating SQL. The supported
Description
RISQL functions for the database are listed in the
RISQL_FUNCTIONS parameter.

Y: applications can include RISQL functions when


generating SQL.
Values
N: applications cannot include RISQL functions when
generating SQL.

Default Y

OWNER

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

Specifies if the database authorizes to prefix tables


Description
by the owner name.

Y: Specifies that the database supports prefixing ta-


bles by the owner name.
Values
N: Specifies that the database does not support pre-
fixing tables by the owner name.

Default Y

Data Access Guide 159


8 PRM parameter reference
PRM file configuration reference

PERCENT_RANK_SUPPORTED

<Parameter Name="PERCENT_RANK_SUPPORTED">Yes</Parameter>

Specifies if the Percent Rank analytical function is


Description
supported by the database.

Yes: the Percent Rank analytical function is supported


by the database.
Values
No: the Percent Rank analytical function is not sup-
ported by the database.

Default Yes

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-


Description verse Designer. This parameter is found in the ac
cess.prm file and redbrick.prm file.

160 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
MSys: Specifies that the MS Access system tables
are hidden in the Universe Designer table browser.
Default value for MS Access.

RBW_ :Specifies that the Red Brick system tables are


Values
hidden in the Universe Designer table browser. Default
value for Red Brick.

no value Specifies that the database system tables


are displayed in the Universe Designer table browser.

Default See values above.

QUALIFIER

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

Specifies whether the database authorizes to prefix


Description
tables by the qualifier name.

Y: Specifies that the database does support prefixing


tables by the qualifier name.
Values
N: Specifies that the database does not support pre-
fixing tables by the qualifier name.

Default RDBMS dependant.

QUOTE_OWNER

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

Data Access Guide 161


8 PRM parameter reference
PRM file configuration reference

Specifies whether or not an owner name should be


Description
in single quotes. Used by Informix only.

Y: Specifies that table names are prefixed by an


owner name in single quotes. This is mandatory for
an ANSI compliant Informix database. If not, Informix
Values converts the owner name to upper case characters.

N: Specifies that table names are not prefixed by an


owner name in single quotes.

Default Y

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


Result
FROM 'Owner'.table.col Alias

RANK_SUPPORTED

<Parameter Name="RANK_SUPPORTED">Yes</Parameter>

Specifies if the Rank analytical function is supported


Description
by the database.

Yes: the Rank analytical function is supported by the


database.
Values
No: the Rank analytical function is not supported by
the database.

Default Yes

162 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

REFRESH_COLUMNS_TYPE

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

Description Indicates how columns are refreshed.

O: Columns are refreshed by owner name. This is the


default value with Oracle.

Q: Columns are refreshed by qualifier name. This is


Values
the default value with Red Brick, Sybase, MS SQL
Server and MS Access.

T: Columns are refreshed by table name.

Default See Values above.

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 parameter
can also be used with some other databases, possibly
with the Y and N reversed.

This parameter is not supported for Teradata.


Description
Note:
If OUTERJOINS_GENERATION parameter is set to AN
SI92 or if the universe ANSI92 setting is set to YES,
then REVERSE_TABLE_WEIGHT parameter does not
affect the optimization of SQL generation.

Data Access Guide 163


8 PRM parameter reference
PRM file configuration reference

N: Specifies that tables are generated from the largest


to the smallest.
Values
Y: Specifies that tables are generated from the
smallest to the largest.

Default Y

Related Topics
• OUTERJOINS_GENERATION

RIGHT_OUTER

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

<Parameter Name="RIGHT_OUTER">*$</Parameter>

Description Specifies the right outer join syntax.

$(+): Used with Oracle. $ represents a join expression.


Values *$:Used with Sybase, MS SQL Server and Red Brick.
$ represents a join expression.

Default See values above.

RISQL_FUNCTIONS

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

164 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
Description Lists the RISQL functions supported by the database.

• Oracle default list:


RANK,SUM,AVG,COUNT,MIN,MAX,RATIO_TO_RE
PORT,CUME_DIST,CORR,DENSE_RANK,FIRST_VAL
UE,LAST_VALUE,LAG,LEAD,NTILE,PER
CENT_RANK,PERCENTILE_CONT,PER
CENTILE_DISC,ROW_NUMBER,CORR,CO
VAR_POP,COVAR_SAMP,REGR_SLOPE,REGR_IN
TERCEPT,REGR_COUNT,REGR_R2,RE
GR_AVGX,REGR_AVGY,REGR_SXX,REGR_SYY,RE
Values GR_SXY,STDDEV,STDDEV_POP,STD
DEV_SAMP,VAR_POP,VAR_SAMP,VARIANCE
• BM DB2 default list:
RANK,SUM,AVG,COUNT,MIN,MAX
• Teradata default list: CSUM,MAVG,MDIFF,MLIN
REG,MSUM,RANK,QUANTILE
• Red Brick default list: CUME,MOVINGAVG,MOVING
SUM,RANK,RATIOTOREPORT,TERTILE

Default See values above.

SEED_SAMPLING_SUPPORTED

<Parameter Name="SEED_SAMPLING_SUPPORTED">Yes</Parameter>

Specifies if seed-based random sampling capability


Description
is supported by the database.

Data Access Guide 165


8 PRM parameter reference
PRM file configuration reference

Yes: seed-based sampling is supported by the


database.
Values
No: seed-based sampling is not supported by the
database.

Default No

SORT_BY_NO

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

Specifies if users are authorized to sort on columns


Description (represented as objects in the universe) that are not
included in the SELECT statement.

YES: Specifies that users are not authorized to sort


on columns if they are not included in the SELECT
statement. When the parameter is set to YES, the
Values Manage Sorts button is dimmed in the Query Panel.

NO: Specifies that you are authorized to sort on


columns even if they are not included in the SELECT
statement.

Default NO

UNICODE_PATTERN

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

166 Data Access Guide


PRM parameter reference
PRM file configuration reference 8
SQL Server and Oracle only.

Only applies when the universe SQL generation pa-


Description rameter UNICODE_STRINGS is set to Y. All condi-
tions based on strings are then formatted with this
string value.

Microsoft SQL Server: N$


Default
Oracle: UNISTR($)

Example UNICODE_PATTERN=N$

UNION

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

Specifies if the database supports the UNION set


Description
operator.

UNION: The database supports the UNION set oper-


ator.
Values
no value : The database does not support the UNION
set operator. In this case, two queries are generated.

Default UNION

Data Access Guide 167


8 PRM parameter reference
PRM file configuration reference

USER_INPUT_DATE_FORMAT

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

Specifies the default date and hour formats generated


Description
in the WHERE clause of a SQL script.

{\d 'yyyy-mm-dd'} This is the default date format with


ODBC.

'DD-MM-YYYY HH:MM:SS' This is the default date


and hour formats with Oracle.

'MM/DD/YYYY' This is the default date format with


Informix.

'yyyy-mm-dd HH:mm:ss' This is the default date and


hour formats with MS SQL Server and for most IBM
Values DB2 servers.

'mm/dd/yyyy hh:m:s am/pm' This is the default date


and hour formats with Sybase.

'yyyy-mm-dd' This is the default date format with a


Sybase gateway.
Note:
If you need to use time or timestamp variables with
ODBC, you must replace the default date format value
with: {\t 'hh:mm:ss'} or {\t\s 'yyyy-mm-dd hh:mm:ss'} in
the odbc.sbo file.

Default See values above.

168 Data Access Guide


PRM parameter reference
PRM file configuration reference 8

USER_INPUT_NUMERIC_SEPARATOR

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

Specifies the default decimal separator that is used


Description
in the generated SQL script.

Values '.'

Default '.'

Data Access Guide 169


8 PRM parameter reference
PRM file configuration reference

170 Data Access Guide


Data type conversion
reference

9
9 Data type conversion reference
Data type conversion

Data type conversion


This 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 future
updates of the Data Access guide.

IBM DB2

The following table lists the IBM DB2 internal data types and their equivalent
in SAP BusinessObjects solutions:

IBM DB2 datatype SAP BusinessObjects datatype

CLOB LONG TEXT

172 Data Access Guide


Data type conversion reference
Data type conversion 9
IBM DB2 datatype SAP BusinessObjects datatype

CHARACTER CHARACTER

DATE DATE

DECIMAL NUMBER

DOUBLE NUMBER

FLOAT NUMBER

INTEGER NUMBER

LONG VARCHAR LONG TEXT

NUMERIC NUMBER

SMALLINT NUMBER

TIME DATE

TIMESTAMP DATE

VARCHAR CHARACTER

Data Access Guide 173


9 Data type conversion reference
Data type conversion

Informix

The following table lists the Informix internal data types and the equivalent
in SAP BusinessObjects solutions:

Informix datatype SAP BusinessObjects datatype

CHAR CHARACTER

DATE DATE

DATETIME DATE

DECIMAL NUMBER

FLOAT NUMBER

INTEGER NUMBER

MONEY NUMBER

NCHAR CHARACTER

NVARCHAR CHARACTER

SERIAL NUMBER

SMALLINT NUMBER

174 Data Access Guide


Data type conversion reference
Data type conversion 9
Informix datatype SAP BusinessObjects datatype

SMALLFLOAT NUMBER

TEXT LONG TEXT

VARCHAR CHARACTER

Microsoft SQL Server

The following table lists the Microsoft SQL Server internal data types and
their SAP BusinessObjects equivalent.

Microsoft SQL Server datatype SAP BusinessObjects datatype

BIT NUMBER

BOOLEAN NUMBER

CHAR CHARACTER

DATETIME DATE

DECIMAL NUMBER

FLOAT NUMBER

Data Access Guide 175


9 Data type conversion reference
Data type conversion

Microsoft SQL Server datatype SAP BusinessObjects datatype

INT NUMBER

MONEY NUMBER

NUMERIC NUMBER

REAL NUMBER

SMALLDATETIME DATE

SMALLINT NUMBER

SMALLMONEY NUMBER

TEXT CHARACTER

TINYINT NUMBER

VARCHAR CHARACTER

Oracle

The following table lists the Oracle internal datatypes and their equivalent in
SAP BusinessObjects solutions.

176 Data Access Guide


Data type conversion reference
Data type conversion 9
Oracle datatype SAP BusinessObjects datatype

CHAR CHARACTER

CLOB LONG TEXT

DATE DATE

FLOAT NUMBER

INTEGER NUMBER

LONG LONG TEXT

NUMBER NUMBER

VARCHAR CHARACTER

VARCHAR2 CHARACTER

Red Brick

The following table lists the Red Brick internal data types and their SAP
BusinessObjects equivalent.

Data Access Guide 177


9 Data type conversion reference
Data type conversion

Red Brick datatype SAP BusinessObjects datatype

CHAR CHARACTER

DATE DATE

DECIMAL NUMBER

FLOAT NUMBER

INTEGER NUMBER

NUMERIC NUMBER

SMALLINT NUMBER

TIME DATE

TIMESTAMP DATE

To add TIME and TIMESTAMP support in a WHERE


clause

Objects that use the TIME and TIMESTAMP data type are not supported in
a WHERE clause for queries run against a Red Brick database. You can set
the properties of an object in a universe to support the use of TIME and
TIMESTAMP in the WHERE clause as follows:

To support TIME or TIMESTAMP datatype object in WHERE clause:

178 Data Access Guide


Data type conversion reference
Data type conversion 9
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:

For... Type

TIME support HH:MM:SS

TIMESTAMP support MM/DD/YYYY HH:MM:SS

6. Click OK.

Sybase

The following table lists the Sybase internal datatypes and their equivalent
in SAP BusinessObjects solutions.

Sybase datatype SAP BusinessObjects datatype

BIT NUMBER

CHAR CHARACTER

DATETIME DATE

DECIMAL NUMBER

Data Access Guide 179


9 Data type conversion reference
Data type conversion

Sybase datatype SAP BusinessObjects datatype

FLOAT NUMBER

INT NUMBER

MONEY NUMBER

NUMERIC NUMBER

REAL NUMBER

SMALLDATETIME DATE

SMALLINT NUMBER

SMALLMONEY NUMBER

TINYINT NUMBER

VARCHAR CHARACTER

Teradata

The following table lists the Teradata internal datatypes and their equivalent
in SAP BusinessObjects solutions.

180 Data Access Guide


Data type conversion reference
Data type conversion 9
Teradata datatype SAP BusinessObjects datatype

DATE DATE

DECIMAL NUMBER

FLOAT NUMBER

INTEGER NUMBER

SMALLINT NUMBER

BYTEINT NUMBER

DATETIME DATE

VARCHAR CHARACTER

Data Access Guide 181


9 Data type conversion reference
Data type conversion

182 Data Access Guide


More Information

A
A More Information

Information Resource Location

SAP BusinessObjects product


http://www.sap.com
information

Select http://help.sap.com > SAP BusinessObjects.

You can access the most up-to-date documentation cover-


ing all SAP BusinessObjects products and their deployment
at the SAP Help Portal. You can download PDF versions
or installable HTML libraries.
SAP Help Portal Certain guides are stored on the SAP Service Marketplace
and are not available from the SAP Help Portal. These
guides are listed on the Help Portal accompanied by a link
to the SAP Service Marketplace. Customers with a mainte-
nance agreement have an authorized user ID to access
this site. To obtain an ID, contact your customer support
representative.

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 installation
guides, upgrade and migration guides, deployment guides,
SAP Service Marketplace
release notes and Supported Platforms documents. Cus-
tomers with a maintenance agreement have an authorized
user ID to access this site. Contact your customer support
representative to obtain an ID. If you are redirected to the
SAP Service Marketplace from the SAP Help Portal, use
the menu in the navigation pane on the left to locate the
category containing the documentation you want to access.

https://boc.sdn.sap.com/
Developer resources
https://www.sdn.sap.com/irj/sdn/businessobjects-sdklibrary

184 Data Access Guide


More Information
A
Information Resource Location

SAP BusinessObjects articles https://www.sdn.sap.com/irj/boc/businessobjects-articles


on the SAP Community Net-
work These articles were formerly known as technical papers.

https://service.sap.com/notes
Notes These notes were formerly known as Knowledge Base ar-
ticles.

Forums on the SAP Communi-


https://www.sdn.sap.com/irj/scn/forums
ty Network

http://www.sap.com/services/education

Training From traditional classroom learning to targeted e-learning


seminars, we can offer a training package to suit your
learning needs and preferred learning style.

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

The SAP Support Portal contains information about Cus-


tomer Support programs and services. It also has links to
Online customer support a 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, contact
your customer support representative.

http://www.sap.com/services/bysubject/businessobjectscon
sulting

Consultants can accompany you from the initial analysis


Consulting stage to the delivery of your deployment project. Expertise
is available in topics such as relational and multidimensional
databases, connectivity, database design tools, and cus
tomized embedding technology.

Data Access Guide 185


A More Information

186 Data Access Guide


Index
A CFG file (continued)
Load Drivers On Startup 68
ANSI92 SQL syntax 155 Max Pool Time 69
architecture, system 15 NetworkLayer element 74
Array Bind Available 90 Protocols parameters 77
Array Bind Size 90 Server section 73
Array Fetch Available 91 settings parameters reference 66
Array Fetch Size 91 SQL External Extension 70
SQL Parameter Extension 71
Strategies Extension 71
B Transient Object Timeout 72
BACK_QUOTE_SUPPORTED 136 viewing 65
Blob_Comparison 137 CharSet 93
Boundary_Weight_Table 137 Charset List Extension 66
branded drivers 83 CHECK_OWNER_STATE 137
CHECK_QUALIFIER_STATE 138
checking database access 37
C ClassPath
creating a JavaBean connection 45
C++ drivers 46 creating a JDBC connection 41
Case_Sensitive 137 Column Name Max Size 93
CASE_SENSITIVE 137 COMMA 138
Catalog Name Max Size 92 CONCAT 139
Catalog Separator 92 Config File Extension 67
CFG file configuration files
ActiveDataSources section 74 installed SBO files 81
Capabilities section 72 JavaBean SBO example 46
Charset List Extension 66 parameter categories 88
Config File Extension 67 connection components 14
DataBase element 74 Connection Server
Description Extension 67 about global parameters 64
Distribution section 77 choosing the deployment mode 72
DriverDefaults section 65 configuring data access for DataDirect
editing 65 branded drivers 84
Enable Failed Load 68 configuring deplyment mode 73
Library section 73 configuring driver defaults 65

Data Access Guide 187


Index

Connection Server (continued) data access (continued)


configuring for complex deployment 74 installed files 16
configuring for JDBC connection to Data data access drivers
Federator 54 about 15
configuring for ODBC connection to Data checking availability on a machine 34
Federator 57 checking for validation 34
configuring for ODBC connection to configuring parameters 80
Universe Designer and Web Intelligence files used by 17
Rich Client 60 PRM files 126
configuring for Web Intelligence connection searching for installed 29
to Data Federator 59 selecting 74
configuring global settings 66 Data Federator
creating a JavaBean connection 45 about creating connections 52
creating generic JDBC connections 42 configuring for ODBC connection 56
creating generic ODBC connections 47 configuring for ODBC connection to Web
creating generic ODBC3 connections 49 Intelligence Rich Client 59
creating JDBC connections 41 installation directory 55
debugging at startup 73 required version 52
definition 14 database access
in standalone server mode 77 configuring 74
Connection Shareable 94 installation 75
Connection Status Available 117 database access, checking 37
connections DATABASE_DATE_FORMAT 140
creating Data Federator 52 databases
requirements for creating 24 listing supported 28
Conversion tables 172 supporting stored procedures 19
Cost Estimate Available 94 DataDirect 83
cs.cfg DATATYPE_BLOB 140
about 64 DATATYPE_DOUBLE 141
cscheck DATATYPE_DTM 141
function list 26 DATATYPE_INT 141
getting help 25 DATATYPE_NULL 142
running 26 DATATYPE_STRING 142
syntax 26 datatypes
Cumulative_Object_Where 95 IBM DB2 172
Informix 174
Oracle 176
D Red Brick 177
data access SQL Server 175
driver level files 17 Sybase 179
files installed 16 Teradata 180
global files 17 DATE_WITHOUT_QUOTE 142

188 Data Access Guide


Index

DELIMIT_IDENTIFIERS 143 F
Description Extension 67
Description File 95 Family 97
Distribution Field Size Factor 97
CFG file 77 Force Close Statement 118
Driver Capabilities 95 Force Execute 98
Driver defaults FORCE_SORTED_LOV
CFG file 65 universe parameter 139
driver.sbo parameters ForeignKeys Available 115
Lock Mode 119
LongVarcharNotSupported 119
driveren.prm parameters
G
Blob_Comparison 137 generic JDBC datasource 42
Boundary_Weight_Table 137 generic ODBC datasource 47
Case_Sensitive 137 generic ODBC3 datasource 49
Cumulative_Object_Where 95 global
Ext_Join 143 data access files 17
Intersect 149 GROUPBY_EXCLUDE_COMPLEX 145
Left_Outer 150 GROUPBY_WITH_ALIAS 146
Max_Inlist_Values 152 GROUPBY_WITHOUT_CONSTANT 147
Minus 152 GROUPBYCOL 147, 149, 153, 160, 162, 165
OLAP_Clause 154
Quote_Owner 161
Refresh_Columns_Type 163 H
drivers
checking availability on a machine 34 help
checking for validation 34 PRM files 132
DataDirect 83 help, cscheck 25

E I
EBUS 54 IBM DB2
Empty String 117 datatypes 172
Enable Failed Load 68 Identifier Case 98
Enumerator CLSID 121 Identifier Quote String 99
Escape Character 96 IDENTIFIER_DELIMITER 148
Ext_Join 143 Informix
EXT_JOIN 143 datatypes 174
EXT_JOIN_INVERT 144 Modifying the ODBC.ini file 111
Extensions 97 Unicode 113
EXTERN_SORT_EXCLUDE_DISTINCT 145 V5toV6DriverName 112
Informix configuration parameters 111

Data Access Guide 189


Index

installation LENMAXFORCOLUMNNAME 151


checking data access driver 34 LENMAXFORTABLENAME 151
Data Federator directory 55 LENMAXFORVARCHAR 152
files installed 16 library mode 73
installation directory LIKE Escape Clause 99
location 64 limitations of stored procedures 20
Intersect 149 Load Drivers On Startup 68
INTERSECT 149 Locale 100
Lock Mode 119
LongVarcharNotSupported 119
J
Java drivers 40 M
JavaBean
JavaBean Class 113 Max Pool Time 69
URL Format 114 Max Rows Available 100
JavaBean Class 113 Max_Inlist_Values 152
JavaBean connections middleware
about 44 checking availability on a machine 32
creating 45 checking connectivity with network layer 35
JavaBean SBO example 46 Minus 152
JavaBean SBO parameters 113 MINUS 152
JDBC MS SQL Server 83
ForeignKeys Available 115 MSOlap CLSID 122
generic 42
JDBC Class 115
Primary Key Available 116
N
JDBC Class 115 Native Int64 Available 118
JDBC connections network layers
about 40 checking available middleware 32
creating 41 checking connectivity with middleware 35
jdbc.sbo 41 listing supported 28
JNI usage 72 selecting 74
New Connection Wizard
K configuring for Data Federator 53
NO_DISTINCT 153
KEY_INFO_SUPPORTED 150
O
L
ODBC
Left_Outer 150 Connection Status Available 117
LEFT_OUTER 150 DataDirect drivers 83

190 Data Access Guide


Index

ODBC (continued) PRM files


Empty String 117 about function help text 132
exposing database layer in server mode 77 BACK_QUOTE_SUPPORTED 136
Force Close Statement 118 CASE_SENSITIVE 137
generic ODBC2 47 CHECK_OWNER_STATE 137
generic ODBC3 49 CHECK_QUALIFIER_STATE 138
Native Int64 Available 118 COMMA 138
ODBC Cursors 119 CONCAT 139
SQLDescribeParam Available 119 DATABASE_DATE_FORMAT 140
SQLMoreResults Available 120 DATATYPE_BLOB 140
Use DataDirect OEM Driver 120 DATATYPE_DOUBLE 141
ODBC connections DATATYPE_DTM 141
about 46 DATATYPE_INT 141
ODBC Cursors 119 DATATYPE_NULL 142
OLAP_Clause 154 DATATYPE_STRING 142
OLAP_CLAUSE 154 DATE_WITHOUT_QUOTE 142
OLE DB DELIMIT_IDENTIFIERS 143
Enumerator CLSID 121 editing 132
Provider CLSID 121 editing help text 133
OLE DB OLAP EXT_JOIN 143
MSOlap CLSID 122 EXT_JOIN_INVERT 144
Optimize Execute 101 EXTERN_SORT_EXCLUDE_DISTINCT
Oracle 145
connectivity check example 37 GROUPBY_EXCLUDE_COMPLEX 145
datatypes 176 GROUPBY_WITH_ALIAS 146
stored procedures 20 GROUPBY_WITHOUT_CONSTANT 147
OUTERJOINS_GENERATION 155 GROUPBYCOL 147, 149, 153, 160, 162,
OVER_CLAUSE 158 165
OWNER 159 IDENTIFIER_DELIMITER 148
Owners Available 101 INTERSECT 149
KEY_INFO_SUPPORTED 150
LEFT_OUTER 150
P LENMAXFORCOLUMNNAME 151
parameter types, configuration 64 LENMAXFORTABLENAME 151
Password Encryption 102 LENMAXFORVARCHAR 152
ping, checking database access 37 MINUS 152
PREFIX_SYS_TABLE 160 NO_DISTINCT 153
PrimaryKey Available 116 OLAP_CLAUSE 154
PRM file OUTERJOINS_GENERATION 155
list of files 126 OVER_CLAUSE 158
reference 126 OWNER 159
reference list 136 PREFIX_SYS_TABLE 160

Data Access Guide 191


Index

PRM files (continued) REVERSE_TABLE_WEIGHT 163


QUALIFIER 161 RIGHT_OUTER=$(+) 164
QUOTE_OWNER 161 RISQL_FUNCTIONS 164
REFRESH_COLUMNS_TYPE 163
REVERSE_TABLE_WEIGHT 163
RIGHT_OUTER=$(+) 164
S
RISQL_FUNCTIONS 164 SBO files
SORT_BY_NO 166 Array Bind Available 90
structure 129 Array Bind Size 90
UNICODE_PATTERN 166 Array Fetch Available 91
UNION 167 Array Fetch Size 91
USER_INPUT_DATE_FORMAT 168 Catalog Name Max Size 92
USER_INPUT_NUMERIC_SEPARATOR Catalog Separator 92
169 CharSet 93
viewing 132 Column Name Max Size 93
Procedure Name Max Size 103 configuring a JDBC connection 41
Procedure Parameter Name Max Size 103 Connection Shareable 94
Protocols Connection Status Available 117
CFG file 77 Cost Estimate Available 94
Provider CLSID 121 Databases parameters 88
Defaults parameters 88
Q Description File 95
Driver Capabilities 95
QUALIFIER 161 editing 83
Qualifiers Available 104 Empty String 117
Query TimeOut Available 104 Enumerator CLSID 121
Quote_Owner 161 Escape Character 96
QUOTE_OWNER 161 Extensions 97
Quoted Identifier 122 Family 97
Quoted Identifier Case 105 Field Size Factor 97
Force Close Statement 118
Force Execute 98
R ForeignKeys Available 115
Red Brick Identifier Case 98
datatypes 177 Identifier Quote String 99
TIME support in WHERE 178 installed 81
TIMESTAMP support in WHERE 178 JavaBean Class 113
Refresh_Columns_Type 163 JDBC Class 115
REFRESH_COLUMNS_TYPE 163 LIKE Escape Clause 99
requirements Locale 100
connections 24 Max Rows Available 100
Data Federator minimum version 52 MSOlap CLSID 122

192 Data Access Guide


Index

SBO files (continued) SQL External Extension 70


Native Int64 Available 118 SQL External File 106
ODBC Cursors 119 SQL parameter
Optimize Execute 101 PRM file list 136
Owners Available 101 SQL Parameter Extension 71
parameter categories 88 SQL Parameter File 107
Password Encryption 102 SQL Server
Primary Key Available 116 datatypes 175
Procedure Name Max Size 103 SQLDescribeParam Available 119
Procedure Parameter Name Max Size 103 SQLMoreResults Available 120
Provider CLSID 121 SSO 16
Qualifiers Available 104 SSO Available 107
Query TimeOut Available 104 stored procedures
Quoted Identifier 122 about 19
Quoted Identifier Case 105 about JavaBean connections 44
Schema Name Max Size 105 creating a cursor inside an Oracle package
Shared Connection 106 21
SQL External File 106 creating Oracle 21
SQL Parameter File 107 limitations 20
SQLDescribeParam Available 119 Oracle 20
SQLMoreResults Available 120 Teradata 22
SSO Available 107 Strategies Extension 71
Strategies File 108 Strategies File 108
structure 88 supported databases, listing 28
Table Name Max Size 108 supported network layers, listing 28
Transaction Available 109 Sybase
Transaction Mode 109 connectivity check example 37
Type 110 datatypes 179
Unicode 113 Quoted Identifier 122
URL Format 114 system architecture 15
Use DataDirect OEM Driver 120
V5toV6DriverName 112
Version 110
T
viewing 83 Table Name Max Size 108
XML Max Size 111 Teradata
Schema Name Max Size 105 datatypes 180
server mode 73 stored procedures 22
settings Transaction Available 109
CFG parameter reference 66 Transaction Mode 109
Shared Connection 106 Transient Object Timeout 72, 73
single sign-on 16 Type 110
SORT_BY_NO 166

Data Access Guide 193


Index

U V
Unicode 113 V5toV6DriverName 112
UNICODE_PATTERN 166 Version 110
UNION 167
universe parameter
FORCE_SORTED_LOV 139
W
URL Format 114 Web Intelligence Rich Client
Use DataDirect OEM Driver 120 about creating connections to 57
USER_INPUT_DATE_FORMAT 168 setting registry key 60
USER_INPUT_NUMERIC_SEPARATOR 169

X
XML Max Size 111

194 Data Access Guide