Data Access Guide
BusinessObjects Connection Server XI 3.1
Copyright
© 2008 Business Objects, an SAP company. All rights reserved. Business Objects
owns the following U.S. patents, which may cover products that are offered and
licensed by Business Objects: 5,295,243; 5,339,390; 5,555,403; 5,590,250;
5,619,632; 5,632,009; 5,857,205; 5,880,742; 5,883,635; 6,085,202; 6,108,698;
6,247,008; 6,289,352; 6,300,957; 6,377,259; 6,490,593; 6,578,027; 6,581,068;
6,628,312; 6,654,761; 6,768,986; 6,772,409; 6,831,668; 6,882,998; 6,892,189;
6,901,555; 7,089,238; 7,107,266; 7,139,766; 7,178,099; 7,181,435; 7,181,440;
7,194,465; 7,222,130; 7,299,419; 7,320,122 and 7,356,779. Business Objects and
its logos, BusinessObjects, Business Objects Crystal Vision, Business Process
On Demand, BusinessQuery, Cartesis, Crystal Analysis, Crystal Applications,
Crystal Decisions, Crystal Enterprise, Crystal Insider, Crystal Reports, Crystal
Vision, Desktop Intelligence, Inxight and its logos , LinguistX, Star Tree, Table
Lens, ThingFinder, Timewall, Let There Be Light, Metify, NSite, Rapid Marts,
RapidMarts, the Spectrum Design, Web Intelligence, Workmail and Xcelsius are
trademarks or registered trademarks in the United States and/or other countries
of Business Objects and/or affiliated companies. SAP is the trademark or registered
trademark of SAP AG in Germany and in several other countries. All other names
mentioned herein may be trademarks of their respective owners.
Third-party
Contributors
Business Objects products in this release may contain redistributions of software
licensed from third-party contributors. Some of these individual components may
also be available under alternative licenses. A partial listing of third-party
contributors that have requested or permitted acknowledgments, as well as required
notices, can be found at: http://www.businessobjects.com/thirdparty
2008-09-02
Contents
Introducing data access 11Chapter 1
About Connection Server...........................................................................12
Components of a connection.....................................................................12
About data access configuration files........................................................14
Creating a connection 19Chapter 2
Connection requirements...........................................................................20
Checking connection configuration............................................................20
About JDBC connections ..........................................................................32
To create a JDBC connection ...................................................................32
About JavaBean connections....................................................................34
About the system architecture..............................................................13
About data access drivers....................................................................13
About the cs.cfg global configuration file..............................................15
About the *.sbo driver configuration files..............................................15
Displaying help on the cscheck tool.....................................................21
To run the cscheck tool.........................................................................22
Check tool—function overview.............................................................22
Check tool—list....................................................................................24
Check tool—drivers search..................................................................24
Check tool—find...................................................................................25
Check tool—middleware......................................................................26
Check tool—accessdriver.....................................................................27
Check tool—connectivity......................................................................28
Check tool—ping .................................................................................29
JDBC SBO example file structure........................................................34
Data Access Guide 3
Contents
To create a JavaBean connection.............................................................35
JavaBean SBO example file structure ................................................35
Creating a connection to Data Federator Query Server 37Chapter 3
About Data Federator Query Server connections.....................................38
Configuring the New Connection wizard for a Data Federator JDBC or ODBC
connection.................................................................................................39
Configuring Data Federator JDBC connections........................................40
Configuring Connection Server for a Data Federator JDBC
connection............................................................................................40
Configuring Data Federator ODBC connections.......................................41
Configuring the Data Federator ODBC middleware ............................42
Configuring Connection Server for a Data Federator ODBC
connection............................................................................................43
Configuring Web Intelligence Rich Client connection definitions using Data
Federator ODBC middleware....................................................................44
Configuring the Data Federator ODBC middleware for a Web Intelligence
Rich Client connection..........................................................................45
Configuring Connection Server for a Web Intelligence Rich Client
connection to Data Federator...............................................................46
Setting the Web Intelligence Rich Client registry key ..........................46
Configuring data access global parameters 49Chapter 4
About global parameters............................................................................50
About the cs.cfg configuration file..............................................................50
To view and edit the cs.cfg file...................................................................51
Configuring the driver default parameters.................................................51
Configuring the global settings parameters...............................................52
4 Data Access Guide
Charset List Extension.........................................................................52
Config File Extension...........................................................................53
Description Extension...........................................................................53
Contents
Enable Failed Load..............................................................................54
Load Drivers On Startup.......................................................................54
Max Pool Time......................................................................................55
SQL External Extension.......................................................................56
SQL Parameter Extension....................................................................57
Strategies Extension............................................................................57
Configuring the access method.................................................................57
Configuring the driver filter.........................................................................58
Setting one connectivity per machine..................................................60
Configuring the CORBA access protocols.................................................62
Configuring data access driver parameters 63Chapter 5
Configuring driver parameters...................................................................64
Data access configuration files.............................................................64
Installed SBO files................................................................................65
To view and edit an SBO file................................................................67
SBO parameter reference 69Chapter 6
SBO parameter categories........................................................................70
SBO file structure.......................................................................................70
Default SBO parameters............................................................................72
Array Bind Available.............................................................................72
Array Bind Size.....................................................................................72
Array Fetch Available...........................................................................73
Array Fetch Size...................................................................................73
Catalog Name Max Size.......................................................................74
Catalog Separator................................................................................74
CharSet................................................................................................75
Column Name Max Size.......................................................................75
Connection Shareable..........................................................................76
Data Access Guide 5
Contents
Cost Estimate Available.......................................................................76
Description File.....................................................................................77
Driver Capabilities................................................................................77
Escape Character.................................................................................78
Extensions............................................................................................78
Family...................................................................................................79
Field Size Factor..................................................................................79
Force Execute......................................................................................79
Identifier Case......................................................................................80
Identifier Quote String..........................................................................81
LIKE Escape Clause............................................................................81
Locale...................................................................................................82
Max Rows Available.............................................................................82
Optimize Execute.................................................................................83
Owners Available.................................................................................83
Password Encryption............................................................................84
Procedure Name Max Size..................................................................84
Procedure Parameter Name Max Size................................................85
Qualifiers Available...............................................................................85
Query TimeOut Available.....................................................................86
Quoted Identifier Case.........................................................................86
Schema Name Max Size......................................................................87
Shared Connection...............................................................................87
SQL External File.................................................................................88
SQL Parameter File..............................................................................88
SSO Available......................................................................................90
Strategies File......................................................................................90
Table Name Max Size..........................................................................91
Transactional Available........................................................................91
Transaction Mode.................................................................................92
Type......................................................................................................92
6 Data Access Guide
Contents
Version.................................................................................................93
XML Max Size......................................................................................93
Informix SBO parameters..........................................................................93
To modify the Informix ODBC.INI file....................................................94
V5toV6DriverName..............................................................................95
Unicode................................................................................................95
JavaBean SBO parameters.......................................................................96
JavaBean Class...................................................................................96
URL Format..........................................................................................97
JDBC SBO parameters..............................................................................97
ForeignKeys Available..........................................................................97
JDBC Class..........................................................................................98
PrimaryKey Available...........................................................................98
ODBC SBO parameters.............................................................................99
Empty String.........................................................................................99
Force Close Statement.......................................................................100
ODBC Cursors...................................................................................100
SQLDescribeParam Available............................................................101
SQLMoreResults Available................................................................101
ODBC3 SBO parameters.........................................................................102
Connection Status Available..............................................................102
Native Int64 Available.........................................................................102
OLE DB SBO parameters........................................................................103
Provider CLSID..................................................................................103
Sybase ASE/CTLIB.................................................................................103
Quoted Identifier.................................................................................104
Configuring SQL generation parameters 105Chapter 7
About SQL generation parameters..........................................................106
About PRM files.......................................................................................106
PRM parameter file structure.............................................................109
Data Access Guide 7
Contents
To view and edit a PRM file.....................................................................111
To view and edit a function help text file..................................................111
To edit the help text for a PRM function...................................................111
PRM parameter reference 113Chapter 8
PRM file configuration reference.............................................................114
BACK_QUOTE_SUPPORTED..........................................................114
CASE_SENSITIVE.............................................................................115
CHECK_OWNER_STATE..................................................................115
CHECK_QUALIFIER_STATE.............................................................116
COMMA..............................................................................................116
CONCAT............................................................................................117
CONSTANT_SAMPLING_SUPPORTED...........................................117
DATABASE_DATE_FORMAT............................................................118
DATATYPE_BLOB..............................................................................118
DATATYPE_DOUBLE........................................................................119
DATATYPE_DTM...............................................................................119
DATATYPE_INT.................................................................................119
DATATYPE_NULL..............................................................................120
DATATYPE_STRING .........................................................................120
DATE_WITHOUT_QUOTE ...............................................................120
DELIMIT_IDENTIFIERS.....................................................................121
EXT_JOIN..........................................................................................121
EXT_JOIN_INVERT...........................................................................122
EXTERN_SORT_EXCLUDE_DISTINCT...........................................123
GROUPBY_EXCLUDE_COMPLEX...................................................123
GROUPBY_WITH_ALIAS..................................................................124
GROUPBY_WITHOUT_CONSTANT.................................................125
GROUPBYCOL..................................................................................125
IDENTIFIER_DELIMITER..................................................................126
IF_NULL.............................................................................................127
8 Data Access Guide
Contents
INTERSECT.......................................................................................127
KEY_INFO_SUPPORTED.................................................................128
LEFT_OUTER....................................................................................128
LENMAXFORCOLUMNNAME...........................................................129
LENMAXFORTABLENAME...............................................................129
LENMAXFORVARCHAR....................................................................130
MINUS................................................................................................130
NO_DISTINCT...................................................................................131
NULL_IN_SELECT_SUPPORTED....................................................131
OLAP_CLAUSE.................................................................................132
OUTERJOINS_GENERATION...........................................................133
OVER_CLAUSE.................................................................................136
OWNER..............................................................................................136
PERCENT_RANK_SUPPORTED......................................................137
PREFIX_SYS_TABLE........................................................................137
QUALIFIER........................................................................................138
QUOTE_OWNER...............................................................................138
RANK_SUPPORTED.........................................................................139
REFRESH_COLUMNS_TYPE...........................................................140
REVERSE_TABLE_WEIGHT.............................................................140
RIGHT_OUTER..................................................................................141
RISQL_FUNCTIONS..........................................................................141
SEED_SAMPLING_SUPPORTED.....................................................142
SORT_BY_NO...................................................................................143
UNICODE_PATTERN........................................................................143
UNION................................................................................................144
USER_INPUT_DATE_FORMAT........................................................145
USER_INPUT_NUMERIC_SEPARATOR..........................................146
Data type conversion reference 147Chapter 9
Data type conversion ..............................................................................148
Data Access Guide 9
Contents
IBM DB2.............................................................................................148
Informix...............................................................................................150
Microsoft SQL Server.........................................................................151
Oracle.................................................................................................152
Red Brick............................................................................................153
To add TIME and TIMESTAMP support in a WHERE clause............154
Sybase...............................................................................................155
Teradata.............................................................................................156
Business Objects information resources 159Chapter 10
Documentation and support....................................................................160
Useful addresses at a glance..................................................................160
Documentation.........................................................................................161
What's in the documentation set?......................................................161
Where is the documentation?.............................................................162
Send us your feedback.......................................................................162
Customer support, consulting and training..............................................162
How can we support you?..................................................................163
Looking for the best deployment solution for your company?............163
Looking for training options?..............................................................164
Get More Help 165Appendix A
Index 169
10 Data Access Guide
Introducing data access
1
Introducing data access
1
About Connection Server
About Connection Server
Connection Server is the Business Objects data access software that
manages the connection between the application and the datasource.
Connection Server allows Business Objects applications such as Designer
and 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 Business Objects applications such
as Designer, or by editing Connection Server configuration files.
• Creating connections: You create connections using the Business Objects
application 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 Business Objects data access connection consists of the following
components:
• Connection Server is the software that manages the connection between
the Business Objects application and the data source. For example,
Connection Server handles requests for data from the Business Objects
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 Business Objects application and Connection Server
• the Business Objects application and the data access driver
• Connection Server and the data access driver
12 Data Access Guide
About the system architecture
The diagram below details where Connection Server and data access drivers
fit into a Business Objects configuration.
Introducing data access
Components of a connection
1
About data access drivers
Data access drivers provide the connection between Connection Server and
a data source. A database requires a data access driver in order that it can
be accessed by a Business Objects application.
Business Objects 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 13
Introducing data access
1
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 Business Objects 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 Business Objects 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 Business Objects 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
BusinessObjects representative.
About data access configuration files
Data access configuration files are installed when you install Business Objects
products. The configuration files can be divided into two levels:
• 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 Business Objects applications such as Designer. The .prm files control
the way in which a Business Objects application generates SQL depending
on the database software capabilities.
Note:
connectionserver-install-dir variable in this guide
In this guide, the variable connectionserver-install-dir is the install
root path for the data access files used by Business Objects applications.
Under Windows, the default connectionserver-install-dir =
:C:\Program Files\Business Objects\BusinessObjects Enterprise
12.0\win32_x86\dataAccess
14 Data Access Guide
About data access configuration files
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 on page 50
About the *.sbo driver configuration files
The configuration files used by data access drivers are installed in the
following path:
• on a Windows system:
Introducing data access
1
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.
Data Access Guide 15
Introducing data access
1
About data access configuration files
Driver specific
file
<driver>.sbo
<driver>.prm
Yes
Yes
There is a .sbo
file for each supported network
protocol, or
database middleware used to connect to a
database. Defines the specific
connectivity configuration for
each database.
Defines parameters that affect the
way that a Business Objects application generates SQL.
ExampleDescriptionCan be edited?
oracle.sbo
oracle.prm
<driver><lan
guage>.cod
16 Data Access Guide
No
Stores information related to
connection definitions. Defines the
fields that appear
when you create
a new connection.
Note:
Do not modify
these files.
oracleen.cod
About data access configuration files
Related Topics
• SBO parameter categories on page 70
• PRM file configuration reference on page 114
• About SQL generation parameters on page 106
Introducing data access
1
Data Access Guide 17
Introducing data access
About data access configuration files
1
18 Data Access Guide
Creating a connection
2
Creating a connection
2
Connection requirements
Connection requirements
This section covers the requirements for creating a connection.
Note:
You can use the cscheck tool to check your infrastructure and determine if
it is suitable for use with Business Objects applications. See the
documentation for more details.
• Ensure that your platform conforms to the platforms supported for
Business Objects connections.
• Ensure that the database middleware is installed correctly, and that you
can access your database through either your computer or a server.
You can use the cscheck tool to check your configuration. See the
cscheck tool documentation for details.
• Ensure that you have all the information necessary to access your
database, for example the database login name and password.
• Install the Business Objects product that you will use, including the
appropriate data access driver.
• Check that all of the Business Objects services have started successfully.
• Refer to the Readme notice that comes with your Business Objects
product 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.
Related Topics
• Checking connection configuration on page 20
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 Business
Objects data access drivers at any time.
20 Data Access Guide
Creating a connection
Checking connection configuration
Note:
The results of all checks apply to your local machine, from which you run
the tool.
The cscheck tool is installed in the following directory: connectionserver-
install-dir/connectionServer/tools
You run the cscheck tool from a command console (DOS or shell). 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
2
• check if a connection can be esbablished to a given database
Related Topics
• Check tool—function overview on page 22
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
Business Objects applications.
To display general help on cscheck, use the following syntax:
Figure 2-1: Command help syntax
Data Access Guide 21
Creating a connection
2
Checking connection configuration
cscheck --help|h --language|l { language }
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
Business Objects application software.
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 on page 22
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.
22 Data Access Guide
Creating a connection
Checking connection configuration
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
2
• driverssearch, or ds
• find, or fd
• middleware, or mw
• accessdriver, or ad
• connectivity, or ct
• ping, or pg
Related Topics
• Check tool—accessdriver on page 27
• Check tool—connectivity on page 28
• Check tool—drivers search on page 24
• Check tool—find on page 25
• Check tool—list on page 24
• Check tool—middleware on page 26
Data Access Guide 23
Creating a connection
2
Checking connection configuration
• Check tool—ping on page 29
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 Business Objects installation on the current machine.
cscheck list
Related Topics
• Check tool—function overview on page 22
• Displaying help on the cscheck tool on page 21
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
24 Data Access Guide
Related Topics
• Check tool—function overview on page 22
• Displaying help on the cscheck tool on page 21
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 }
Table 2-1: Function input parameters
Creating a connection
Checking connection configuration
2
Connection Server access mode
(-m)
The mode in which the client application accesses Connection Server:
• local: lists connectivity types
available on the local machine.
• corba: lists connectivity types
available using CORBA.
• 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.
Data Access Guide 25
Creating a connection
2
Checking connection configuration
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
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 on page 22
• Displaying help on the cscheck tool on page 21
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 }
Table 2-2: Function input parameters
network layer (-c)
database client (-d)
26 Data Access Guide
The network layer that the database
middleware uses, as returned by the
find function.
The database to check, as returned
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
Related Topics
• Check tool—function overview on page 22
• Displaying help on the cscheck tool on page 21
• Check tool—connectivity on page 28
• Check tool—accessdriver on page 27
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 }
Creating a connection
Checking connection configuration
2
Table 2-3: Function input parameters
network layer ( -c )
database client (-d)
The network layer that the database
middleware uses, as returned by the
find function.
The database to check, as returned
by the find function.
Data Access Guide 27
Creating a connection
2
Checking connection configuration
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"
Related Topics
• Check tool—function overview on page 22
• Displaying help on the cscheck tool on page 21
• Check tool—list on page 24
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.
You can check each individually using the middleware and the accessdriver
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
network layer (-c)
database client (-d)
28 Data Access Guide
The network layer that the database
middleware uses, as returned by the
find function.
The database to check, as returned
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
Related Topics
• Check tool—function overview on page 22
• Displaying help on the cscheck tool on page 21
• Check tool—find on page 25
• Check tool—accessdriver on page 27
• Check tool—middleware on page 26
• Check tool—ping on page 29
Check tool—ping
Creating a connection
Checking connection configuration
2
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 29
Creating a connection
2
Checking connection configuration
Table 2-5: Function input parameters
Connection Server access mode
(-m)
network layer (-c)
The mode in which the client application accesses Connection Server:
• local: Connection Server is run-
ning on the local machine.
• corba: Connection Server is run-
ning on a CORBA server.
• http:Connection Server is running
on a HTTP server.
• java: Connection Server uses a
Java data access driver on the
local machine.
The database middleware for the
connection to check, as returned by
the find function.
database client (-d)
user name (-u)
password (-p)
datasource (-s)
database (-t)
30 Data Access Guide
The database type, as returned by
the find function.
A valid user name for the database.
The password for the user name.
The server on which the database is
running.
The database server.
Creating a connection
Checking connection configuration
2
host name (-r)
PID (-i)
Example: Pinging an Oracle database
The following command checks access for:
• Connection Server access mode: local, that is, the database runs on
the local machine.
• Network layer: Oracle Client
• Database: Oracle 8.1
• Datasource: Harlaxton
• User name: efashion
• Password: X2345
For CORBA mode, the computer
hosting Connection Server.
For CORBA mode, the process
number of the Connection Server to
ping through.
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 31
Creating a connection
2
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 on page 22
• Check tool—find on page 25
About JDBC connections
A set of data access drivers are installed when you install your Business
Objects application software. You can use these data access drivers to create
connections to databases.
Business Objects 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.
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
BusinessObjects representative.
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.
32 Data Access Guide
Creating a connection
To create a JDBC connection
• 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 SQLServer 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 a Windows system, the configuration files are located in the following
paths, where connectionserver-install-dir is the directory
where the Connection Server software is installed: connectionserver-
install-dir \connectionServer\jdbc
3. Use an XML editor to open the jdbc.sbo file for editing.
4. Add the required .jar file details to the ClassPath area. Include the fully
qualified path names when specifying these files, for example:
<Path>C:\JDBC Drivers\MSSQLSERVER2000\ msutil.jar</Path>
Note:
These files need to be installed on the machine running the Business
Objects application.
2
Refer to the information on the JDBC sbo example file structure for details.
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 and configure the connection .
When you complete this task, the connection is available for use.
Related Topics
• JDBC SBO example file structure on page 34
• Connection requirements on page 20
Data Access Guide 33
Creating a connection
2
About JavaBean connections
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 SQLServer 2000 and Microsoft
SQLServer 2005.
<JDBCDriver>
<ClassPath>
<Path>C:\JDBC Drivers\MSSQLSERVER2000\
msbase.jar</Path>
<Path>C:\JDBC Drivers\MSSQLSERVER2000\
msutil.jar</Path>
<Path>C:\JDBC Drivers\MSSQLSERVER2000\
mssqlserver.jar</Path>
</ClassPath>
< . . . >
<JDBCDriver>
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
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.
34 Data Access Guide
To create a JavaBean connection
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 exam
ple, on a Windows system, the configuration files are located in the follow
ing paths, where connectionserver-install-dir is the directory
where the Connection Server software is installed: connectionserver-
install-dir\connectionServer\javabean
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 Business
Objects 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.
Creating a connection
2
When you complete this task, the connection is available for use with a
Business Objects application.
Related Topics
• JavaBean SBO example file structure on page 35
• PrimaryKey Available on page 98
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
Data Access Guide 35
Creating a connection
2
To create a JavaBean connection
</JavaBean>
<Parameter Name="Family">Java Beans
</Parameter>
</DataBase>
</DataBases>
</Path>
</ClassPath>
<Parameter Name="JavaBean Class">com.
businessobjects.beans.excel.Excel
</Parameter>
<Parameter Name="URL Format">$DATASOURCE$
</Parameter>
<Parameter Name="Description File">
bean_excel</Parameter>
<Parameter Name="Authentication Mode">
Bypass</Parameter>
<Parameter Name="Extensions">bean_excel,
javabean</Parameter>
36 Data Access Guide
Creating a connection to Data Federator Query Server
3
Creating a connection to Data Federator Query Server
3
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 a Business Objects 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 Business Objects application that you use.
The process differs if you are creating a connection to use with Web
Intelligence Rich Client.
The method that you use to create the connection depends on the Business
Objects 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 Designer and Web Intelligence applications, to be
able to create connections.
The minimum Data Federator ODBC version that you can use with the
configuration details that follow is:
• Data Federator XI Release 2 SP1 MHF1
If required, contact your Business Objects sales representative for more
information on the release, and how to obtain it.
Note:
Business Objects recommends you use a JDBC connectivity to connect
Business Objects applications to Data Federator Query Server. The Data
38 Data Access Guide
Creating a connection to Data Federator Query Server
Configuring the New Connection wizard for a Data Federator JDBC or ODBC connection
Federator ODBC middleware can only be used on Microsoft Windows and
because of the use of an ODBC-JDBC bridge, has impacts on performance.
Related Topics
• Configuring the New Connection wizard for a Data Federator JDBC or
ODBC connection on page 39
• Configuring Data Federator JDBC connections on page 40
• Configuring Data Federator ODBC connections on page 41
• Configuring Web Intelligence Rich Client connection definitions using
Data Federator ODBC middleware on page 44
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
3
• 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 Business Objects, Data Federator Server,
JDBC Drivers or ODBC Drivers middleware to create the connection.
Refer to your Business Objects 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
Data Access Guide 39
Creating a connection to Data Federator Query Server
3
Configuring Data Federator JDBC connections
Web Intelligence Rich Client, the configuration changes required are different
to those used by other Business Objects applications.
Related Topics
• Configuring Data Federator ODBC connections on page 41
• Configuring the Data Federator ODBC middleware on page 42
• Configuring Connection Server for a Data Federator ODBC connection
on page 43
• Configuring Web Intelligence Rich Client connection definitions using
Data Federator ODBC middleware on page 44
Configuring Data Federator JDBC
connections
This section contains Connection Server configuration changes for JDBC
connections to all Business Objects 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 Data
Federator administrator chose this directory when running the Data
Federator installer.
• bo-install-dir: the root installation directory for your Business Objects
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 Business Objects applications that use Connection
Server.
40 Data Access Guide
Creating a connection to Data Federator Query Server
Configuring Data Federator ODBC connections
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
To configure the jdbc.sbo file, add the following lines to the ClassPath
area, as follows:
<ClassPath>
<Path>data-federator-drivers-install-dir\JdbcDriver\lib\log4j-
1.2.8.jar</Path>
<Path>data-federator-drivers-install-dir\JdbcDriver\lib\logkit-
1.2.jar</Path>
<Path>data-federator-drivers-install-dir\JdbcDriver\lib\thin
driver.jar</Path>
<Path>data-federator-drivers-install-dir\JdbcDriver\lib\avalon-
framework-4.1.5.jar</Path>
<Path>data-federator-drivers-install-dir\JdbcDriver\lib\back
port-util-concurrent.jar</Path>
<Path>data-federator-drivers-install-dir\JdbcDriv
er\lib\jacorb.jar</Path>
</ClassPath>
Configuring Data Federator ODBC
3
connections
This section contains Data Federator Query Server additional settings and
Connection Server configuration changes for ODBC connections to all
Business Objects applications except 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 Data
Federator 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 Data
Federator administrator chose this directory when running the Data
Federator installer.
• bo-install-dir: the root installation directory for your Business Objects
applications.
Data Access Guide 41
Creating a connection to Data Federator Query Server
3
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 on page 42
• Configuring Connection Server for a Data Federator ODBC connection
on page 43
• Configuring Web Intelligence Rich Client connection definitions using
Data Federator ODBC middleware on page 44
Configuring the Data Federator ODBC middleware
Note:
This topic applies to all Business Objects applications that use Connection
Server except Web Intelligence Rich Client. See the section that covers Web
Intelligence Rich Client for more information.
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\OaJdbcBridge\bin\iwinnt
To configure the openrda.ini file, set parameters in the [JavaIp] section,
as follows:
• CLASSPATH=data-federator-drivers-install-dir\OaJdbcBridge\oa
java\oasql.jar;data-federator-drivers-install-dir\JdbcDriv
er\thindriver.jar;bo-install-dir\BusinessObjects Enterprise
12.0\classes\ConnectionServer.jar
• JVM_OPTIONS=-DODBCMode=true -Dbusinessobjects.connectivity.di
rectory=bo-install-dir\BusinessObjects Enterprise
12.0\win32_x86\dataAccess\connectionServer
Note:
Check the openrda.ini file to ensure that this path is not set using the
Djava.endorsed.dirs parameter. If it is, then you must remove the path
from the Djava.endorsed.dirs parameter.
42 Data Access Guide
Creating a connection to Data Federator Query Server
Configuring Data Federator ODBC connections
• JVM_DLL_NAME=bo-install-dir\javasdk\jre\bin\client\jvm.dll
Note:
The setting above is for use with standard Business Objects applications.
If you are using Web Intelligence Rich Client, set the parameter as follows:
JVM_DLL_NAME=bo-install-dir\javasdk\jre6\bin\client\jvm.dll
Related Topics
• Configuring Data Federator ODBC connections on page 41
• Configuring Connection Server for a Data Federator ODBC connection
on page 43
Configuring Connection Server for a Data Federator ODBC connection
Note:
This topic applies to all Business Objects applications that use Connection
Server except Web Intelligence Rich Client. See the section that covers Web
Intelligence Rich Client for more information.
3
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\\OaJdbcBridge\\oa
java\\oasql.jar</Path>
<Path>\\data-federator-drivers-install-dir\\JdbcDriver\\thin
driver.jar</Path>
</ClassPath>
Related Topics
• Configuring Data Federator ODBC connections on page 41
• Configuring the Data Federator ODBC middleware on page 42
Data Access Guide 43
Creating a connection to Data Federator Query Server
3
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware
Configuring Web Intelligence Rich Client
connection definitions using Data
Federator ODBC middleware
When creating 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.
Note:
The details below relate to Web Intelligence Rich Client only. For information
on creating connections that use Data Federator ODBC middleware for other
Business Objects applications, refer to the section on configuring Data
Federator ODBC connections.
To create connections that use Data Federator ODBC middleware for use
with Web Intelligence, you need to modify the configurations for:
• The Data Federator 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 Data
Federator 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 Data
Federator administrator chose this directory when running the Data
Federator installer.
• bo-install-dir: the root installation directory for your Business Objects
applications.
Note:
Edit the files in an XML editor to make sure your files are well-formed.
44 Data Access Guide
Creating a connection to Data Federator Query Server
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware
Related Topics
• Configuring the Data Federator ODBC middleware for a Web Intelligence
Rich Client connection on page 45
• Configuring Connection Server for a Web Intelligence Rich Client
connection to Data Federator on page 46
• Setting the Web Intelligence Rich Client registry key on page 46
• Configuring Data Federator ODBC connections on page 41
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\OaJdbcBridge\bin\iwinnt
To configure the openrda.ini file, set parameters in the [JavaIp] section,
as follows:
• CLASSPATH=data-federator-drivers-install-dir\OaJdbcBridge\oa
java\oasql.jar;data-federator-drivers-install-dir\JdbcDriv
er\thindriver.jar;bo-install-dir\BusinessObjects Enterprise
12.0\classes\ConnectionServer.jar
3
• JVM_DLL_NAME=bo-install-dir\javasdk\jre6\bin\client\jvm.dll
• JVM_OPTIONS=-DODBCMode=true -Dbusinessobjects.connectivity.di
rectory=bo-install-dir\BusinessObjects Enterprise
12.0\win32_x86\dataAccess\connectionServer
Note:
Check the openrda.ini file to ensure that this path is not set using the
Djava.endorsed.dirs parameter. If it is, then you must remove the path
from the Djava.endorsed.dirs parameter.
Related Topics
• Configuring Web Intelligence Rich Client connection definitions using
Data Federator ODBC middleware on page 44
• Configuring Connection Server for a Web Intelligence Rich Client
connection to Data Federator on page 46
Data Access Guide 45
Creating a connection to Data Federator Query Server
3
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware
• Setting the Web Intelligence Rich Client registry key on page 46
Configuring Connection Server for a Web IntelligenceRich Client connection to Data Federator
To configure Connection Server for a Web Intelligence Rich Client connection
to Data Federator, 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\\OaJdbcBridge\\oa
java\\oasql.jar</Path>
<Path>\\data-federator-drivers-install-dir\\JdbcDriver\\thin
driver.jar</Path>
</ClassPath>
Related Topics
• Configuring Web Intelligence Rich Client connection definitions using
Data Federator ODBC middleware on page 44
• Configuring the Data Federator ODBC middleware for a Web Intelligence
Rich Client connection on page 45
• Setting the Web Intelligence Rich Client registry key on page 46
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\oaja
va\oasql.jar
• data-federator-drivers-install-dir\JdbcDriver\thindriv
er.jar
46 Data Access Guide
Creating a connection to Data Federator Query Server
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware
Related Topics
• Configuring Web Intelligence Rich Client connection definitions using
Data Federator ODBC middleware on page 44
• Configuring the Data Federator ODBC middleware for a Web Intelligence
Rich Client connection on page 45
• Configuring Connection Server for a Web Intelligence Rich Client
connection to Data Federator on page 46
3
Data Access Guide 47
Creating a connection to Data Federator Query Server
Configuring Web Intelligence Rich Client connection definitions using Data Federator ODBC middleware
3
48 Data Access Guide
Configuring data access global parameters
4
Configuring data access global parameters
4
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 on page 64
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.
• DriverDefaults
These parameters apply to all data access drivers.
• Distribution
You configure the settings in this section if you use CORBA.
• Traces
50 Data Access Guide
Configuring data access global parameters
To view and edit the cs.cfg file
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.
4
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.
Refer to the SBO file parameter reference for information on the parameters
that you can set.
Related Topics
• Data access configuration files on page 64
• Configuring driver parameters on page 64
• SBO parameter categories on page 70
Data Access Guide 51
Configuring data access global parameters
4
Configuring the global settings parameters
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. Some settings
can be defined either for library version or server version of Connection
Server:
• Library: In this mode, Connection Server is included in the client process.
• CORBA: In this mode, Connection Server is a CORBA server and is
accessed remotely. In this mode, Connection Server serves two different
kinds of clients: HPPT and CORBA clients.
If your environment uses CORBA, you must configure some parameters
in the <Server> section of cs.cfg.
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>
52 Data Access Guide
Description
Configuring data access global parameters
Configuring the global settings parameters
Note:
Do not change this setting.
Sets the file extension for character set files.
4
Default
Config File Extension
<Parameter Name="Config File Extension">sbo</Parameter>
Description
Default
Description Extension
<Parameter Name="Description Extension">cod</Parameter>
crs
Note:
Do not change this setting.
Sets the file extension for general configuration files.
sbo
Description
Default
Note:
Do not change this setting.
Sets the file extension for the connection description
files.
cod
Data Access Guide 53
Configuring data access global parameters
4
Configuring the global settings parameters
Enable Failed Load
<Parameter Name="Enable Failed Load">Yes</Parameter>
Description
Values
Determines action taken when a driver fails to load.
The parameter lets you choose whether you want a
usable connection possibly without all drivers operating, or a fatal error and no functionality when a driver
fails to load.
Yes: Connection Server generates a fatal error when
a driver fails to load.
No: Connection Server generates a non-fatal error
when a driver fails to load.
YesDefault
Related Topics
• Load Drivers On Startup on page 54
Load Drivers On Startup
Load Drivers On startup applies to both Library and Server modes.
Library
<Settings>
<Parameter Name="Load Drivers On Startup">No</Parameter>
...
<Library/>
Server
<Server>
<Parameter Name="Load Drivers On Startup">Yes</Parameter>
54 Data Access Guide
...
</Server>
These are described below.
Values
Default
Max Pool Time
Configuring data access global parameters
Configuring the global settings parameters
Determines how driver libraries are loaded.Description
•
Yes: All installed drivers are loaded during the initialization phase.
•
No: Drivers are loaded on demand.
Library mode: No
Server mode: Yes
4
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 55
Configuring data access global parameters
4
Configuring the global settings parameters
Description
Default
Determines the maximum length of time that an unused connection can remain idle in the connection
pool. 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 Connection Server deployments:
Library: Value applies to nodes that have Connection
Server installed with desktop or other server products.
Server: Value applies to Connection Server stand
alone server installations. For information on deploying
Connection Server on a dedicated node see the De-
ployment guide.
Library mode: -1
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>
Note:
Description
56 Data Access Guide
Do not change this setting.
Sets the file extension for external SQL files.
Configuring data access global parameters
Configuring the access method
4
Default
rss
SQL Parameter Extension
<Parameter Name="SQL Parameter Extension">prm</Parameter>
Note:
Description
Default
Do not change this setting.
Sets the file extension for SQL parameter files.
prm
Strategies Extension
<Parameter Name="Strategies Extension">stg</Parameter>
Note:
Description
Default
Do not change this setting.
Sets the extension for strategy files.
stg
Configuring the access method
In cs.cfg, parameters in the <Settings> section control the access method.
In the <Settings> section:
Data Access Guide 57
Configuring data access global parameters
4
Configuring the driver filter
• Parameters in the <Library> section control Library mode. Most Business
Objects products use Connection Server in Library mode.
• Parameters in the <Server> section control CORBA access.
Parameters defined in <Library> or <Server> take precedence over any
parameter definitions set in other parts of the <Settings> section. For
example, with CORBA, parameters defined in the <Server> section can
override parameters set in other areas for applications that use <Library>
access.
The settings that apply to Library mode are:
• Load Drivers On Startup
• Max Pool Time
The settings that apply to CORBA access are:
• Load Drivers On Startup
• Max Pool Time
• Transient Object Timeout
You cannot modify the value of the Transient Object Timeout
parameter in the cs.cfg file. However, you can modify it from the
BusinessObjects Central Management Console. See the BusinessObjects
Enterprise Administrator's Guide.
Optionally, you can also configure settings in the <ActiveDataSources>
section.
Related Topics
• Configuring the driver filter on page 58
• Load Drivers On Startup on page 54
• Max Pool Time on page 55
Configuring the driver filter
You configure the <ActiveDataSources> section 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 of the architecture loads and uses. For
58 Data Access Guide
Configuring data access global parameters
Configuring the driver filter
more information about complex deployment scenarios, see the
BusinessObjects Enterprise Deployment and Configuration Guide.
In cs.cfg, 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.
You specify the active datasources for the access method you have defined.
That is, either the Library, the CORBA server access mode, or both.
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\connectionServer\
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.
4
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
In addition to these settings, you must configure settings in the <Distribu
tion> section.
<Server>
<Parameter Name="Load Drivers On Startup">Yes</Parameter>
<Parameter Name="Max Pool Time">60</Parameter>
<Parameter Name="Transient Object Timeout">60</Parameter>
<ActiveDataSources>
<NetworkLayer Name="ODBC">
<DataBase Name="MS SQL Server.*$"/>
<DataBase Name="MS Access.*$"/>
</NetworkLayer>
<NetworkLayer Name="Oracle OCI">
Data Access Guide 59
Configuring data access global parameters
4
Configuring the driver filter
<DataBase Name="Oracle 9"/>
<DataBase Name="Oracle 10"/>
</NetworkLayer>
</ActiveDataSources>
</Server>
Related Topics
• Configuring the CORBA access protocols on page 62
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 BusinessObjects
Enterprise applications to an MS SQL Server database installed on Microsoft
Windows and to an Oracle database installed on a UNIX machine.
To avoid connection failures, you need to do one of the following:
• when installing the BusinessObjects Enterprise suite, specify the
connectivities you want to deploy for each type of database you require,
as described on the image below.
60 Data Access Guide
Configuring data access global parameters
Configuring the driver filter
4
• 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 BusinessObjects Enterprise 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>
</Library>
<Server>
<Parameter Name="Load Drivers On Startup">Yes</Parameter>
<Parameter Name="Max Pool Time">60</Parameter>
<Parameter Name="Transient Object Timeout">60</Parameter>
<ActiveDataSources>
<NetworkLayer Name="ODBC">
<DataBase Name="MS SQL Server.*$"/>
Data Access Guide 61
Configuring data access global parameters
4
Configuring the CORBA access protocols
</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"/>
62 Data Access Guide
Configuring data access driver parameters
5
Configuring data access driver parameters
5
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 Business Objects 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 on page 50
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\
• 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:
64 Data Access Guide
connectionserver-install-dir\connectionServer\oracle
Related Topics
• About global parameters on page 50
• Installed SBO files on page 65
• Configuring the driver default parameters on page 51
Installed SBO files
The following <driver>.sbo files are installed by default.
For an up-to-date list of supported drivers, check the Business Objects
Support Site at www.businessobjects.com, or contact your BusinessObjects
representative.
Configuring data access driver parameters
Configuring driver parameters
SBO fileData access driver
5
Essbase
IBM DB2
Informix
JDBC provides JDBC drivers for
databases. Check the Business Objects support website, or the jd
bc.sbo file for details of the
databases supported for JDBC connections.
essbase.sbo
db2.sbo
iseries.sbo
informix.sbo
jdbc.sbo
Data Access Guide 65
Configuring data access driver parameters
5
Configuring driver parameters
SBO fileData access driver
Microsoft SQL Server
Microsoft Analysis Services
MySQL
Note:
MySQL 5 database is available on all
platforms, with Unicode support. Make
sure you use the MySQL Connector/ODBC 5.1.4 or higher to connect to
this database. If you use an older version of the driver on Unix, you will encounter errors at runtime.
ODBC
Oracle
Red Brick
odbc.sbo
oledb_olap.sbo
odbc.sbo
odbc.sbo
oracle.sbo
odbc.sbo
SAP
Sybase
Teradata
66 Data Access Guide
sap.sbo
sybase.sbo
teradata.sbo
To view and edit an SBO file
You can open an SBO file for viewing or editing as follows:
Note:
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 Business Objects applications.
1. Browse to the directory that stores the SBO file for your target data access
driver. SBO files are stored in the following location, where <driver> is
the name of the database software that the connection uses:
\\<INSTALDIR>\win32_x86\dataAccess\connectionServer\\<driv
er>.sbo
2. Open the <driver>.sbo file in a XML editor.
3. Expand sections as required.
4. Locate the appropriate tag for the value to change, and change the value.
Parameters appear in the format: <Parameter Name="parameter">val
ue</Parameter> where parameter is the name of the parameter, and
value is the value attributed to the parameter.
Configuring data access driver parameters
Configuring driver parameters
5
5. Check that the file is valid against the DTD, save and close the file.
Data Access Guide 67
Configuring data access driver parameters
Configuring driver parameters
5
68 Data Access Guide
SBO parameter reference
6
SBO parameter reference
6
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
• ODBC3
• OLE DB
• 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:
70 Data Access Guide
Defaults
SBO parameter reference
SBO file structure
DescriptionFile section
This section contains the default configuration
parameters that apply to all database middleware
that uses the data access driver. These parameters 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 Middleware page of the new connection wizard.
6
Databases
•
Aliases: Names of older middleware versions
no longer officially supported by the data access 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 71
SBO parameter reference
6
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 on page 70
Array Bind Available
<Parameter Name="Array Bind Available">True</Parameter>
Description
Values
Array Bind Size
<Parameter Name="Array Bind Size">5</Parameter>
Description
Values
Specifies whether or not the database supports Array
Binds.
True: the database supports Array Binds.
False: the database does not support Array Binds.
FalseDefault
Specifies the number of rows exported with each IN
SERT command.
An integer that specifies the number of rows that are
exported with each INSERT.
72 Data Access Guide
SBO parameter reference
Default SBO parameters
6
Default
Array Fetch Available
<Parameter Name="Array Fetch Available">True</Parameter>
Description
Values
Default
Array Fetch Size
The value set in the cs.cfg file.
Specifies whether or not the Array Fetch method is
supported.
True: the Array Fetch method is supported.
False: the Array Fetch method is not supported.
The value set in the cs.cfg file.
<Parameter Name="Array Fetch Size">10</Parameter>
Specifies the number of rows of data retrieved with
each Array Fetch method. The optimum number depends on your system's performance:
• If the number is low, the system retrieves small
Description
amounts of data many times. This can affect performance.
• If the number is high, the system performs fewer
retrieval operations, but it requires more memory
for each.
Data Access Guide 73
SBO parameter reference
6
Default SBO parameters
Values
An integer that specifies the number of rows that are
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>
Description
Values
Specifies the maximum length in characters of a
database catelog name.
An integer that specifies the maximum database catalog name length in characters.
The value set in the database middleware.Default
Catalog Separator
<Parameter Name="Catalog Separator">-</Parameter>
Description
74 Data Access Guide
Specifies the separator character that is used between
identifiers.
The separator character to use.Values
SBO parameter reference
Default SBO parameters
6
CharSet
Default
<Parameter Name="CharSet">UTF8</Parameter>
Description
Values
Default
If not specified, Connection Server uses the separator
specified in the database middleware.
Specifies the character set of the data returned by the
database middleware.
UTF8: 8-bit UCS/Unicode Transformation Format
UCS2: 2-byte Universal Character Set
If not specified, Connection Server uses the separator
specified in the database middleware.
Column Name Max Size
<Parameter Name="Column Name Max Size">1024</Parameter>
Description
Values
Specifies the maximum length in characters of a
database column name.
An integer that specifies the maximum database column name length in characters.
The value set in the database middleware.Default
Data Access Guide 75
SBO parameter reference
6
Default SBO parameters
Connection Shareable
<Parameter Name="Connection Shareable">False</Parameter>
Description
Values
Note:
Do not edit this parameter.
Specifies if a connection is shareable between different requesters. Operates in conjunction with the
Shared Connection parameter.
True: the connection can be shared between multiple
users.
False: the connection cannot be shared between
users.
FalseDefault
Related Topics
• Shared Connection on page 87
Cost Estimate Available
<Parameter Name="Cost Estimate Available">False</Parameter>
Description
Values
76 Data Access Guide
Specifies if the database middleware supports cost
estimation.
True: the middleware supports cost estimation.
False: the middleware does not support cost estimation.
Description File
<Parameter Name="Description File">oracle</Parameter>
Description
Driver Capabilities
SBO parameter reference
Default SBO parameters
FalseDefault
Note:
Do not edit this parameter.
Specifies the name of the file that holds the connection
wizard input field labels.
6
<Parameter Name="Driver Capabilities">Procedures , Query</Pa
rameter>
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 JavaBeans driver. The functionality of a JavaBeans driver
is defined as stored procedures as far as Business
Objects applications are concerned.
Data Access Guide 77
SBO parameter reference
6
Default SBO parameters
Values
Escape Character
<Parameter Name="Escape Character">-</Parameter>
Procedures: the driver can access the data retrieval
procedures that are defined in the database software.
Query: the driver can access the data retrieval queries
that are defined in the database software.
ProceduresDefault
Extensions
Description
Default
<Parameter Name="Extensions"></Parameter>
Description
Specifies the character to use to escape strings of
special characters, for example patterns.
The character to use as the escape character.Values
If not specified, Connection Server retrieves the value
from the middleware.
Note:
Do not modify the settings in this parameter.
78 Data Access Guide
Family
<Parameter Name="Family">Sybase</Parameter>
Note:
Do not edit this parameter.
SBO parameter reference
Default SBO parameters
6
Description
Field Size Factor
<Parameter Name="Field Size Factor ">1</Parameter>
Description
Force Execute
Specifies the family of the database engine that is
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.
Note:
Do not change this value.
The value to use to compute the size of returned
content expressed as field characters when the content is returned as bytes. This is used for DB2 only.
<Parameter Name="Force Execute">Never</Parameter>
Data Access Guide 79
SBO parameter reference
6
Default SBO parameters
Description
Specifies whether or not the SQL query is executed
before retrieving results. Supported by the following:
• ODBC
• OLE
• DB
• JDBC
Never: The SQL query is never executed before retrieving results.
Values
Identifier Case
<Parameter Name="Identifier Case">LowerCase</Parameter>
Description
Values
Procedures: Execute only for stored procedures.
Always: The SQL query is always executed before
retrieving the results.
NeverDefault
Specifies how the database handles the case behavior
of simple identifers.
LowerCase: identifiers must be in lower case.
UpperCase: identifiers must be in upper case.
MixedCase: identifiers can be in mixed case.
80 Data Access Guide
SensitiveCase: identifiers are case sensitive.
SBO parameter reference
Default SBO parameters
6
Default
If this setting is not specified, Connection Server retrieves the information from the database middleware.
Identifier Quote String
<Parameter Name="Identifier Quote String">-</Parameter>
Specifies the character used to quote identifiers.Description
The character used to quote identifiers.Values
Default
If this setting is not specified, Connection Server retrieves the information from the database middleware.
LIKE Escape Clause
<Parameter Name="Identifier Case">True</Parameter>
Description
Values
Specifies if escape character use is supported in the
LIKE clause.
True: escape character use is supported in the LIKE
clause.
False: escape character use is not supported in the
LIKE clause.
Data Access Guide 81
SBO parameter reference
6
Default SBO parameters
Locale
Default
<Parameter Name="Locale">en_us</Parameter>
Values
Default
If this setting is not specified, Connection Server retrieves the information from the database middleware.
Specifies the locale of the middleware.Description
The locale of the middleware.
• language is specified in ISO-639 standard
• country is specified in ISO-3166 standard
For example: en_US for English United States.
If this setting is not specified, Connection Server retrieves the information from the database middleware.
Max Rows Available
<Parameter Name="Max Rows Available">True</Parameter>
Description
82 Data Access Guide
Specifies if the driver supports the Max Rows function
to limit the maximum number of rows that can be retrieved from a datasource.
Values
Optimize Execute
<Parameter Name="Optimize Execute">False</Parameter>
Description
SBO parameter reference
Default SBO parameters
True: The driver supports the Max Rows function .
False: The driver does not support the Max Rows
function.
FalseDefault
Specifies whether or not Connection Server optimizes
the execution of SQL queries. This parameter is supported by Oracle and ODBC drivers only.
6
Values
Owners Available
<Parameter Name="Owners Available">True</Parameter>
Description
True: specifies that where possible, SQL queries are
optimized on execution.
False: SQL queries are not optimized for execution.
FalseDefault
Specifies whether or not Owners are supported by
the target database.
Data Access Guide 83
SBO parameter reference
6
Default SBO parameters
True: Specifies that owners are supported by the target database.
Values
False: Specifies that owners are not supported by the
target database.
Default
Password Encryption
<Parameter Name="Password Encryption">True</Parameter>
Description
Values
Not specified: value retrieved from the database middleware.
Specifies whether or not to use the encryption password mechanism specified in the middleware for the
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 mechanism of the middleware is used.
False: Specifies that the encryption password mechanism of the middleware is not used.
TrueDefault
Procedure Name Max Size
<Parameter Name="Procedure Name Max Size">1024</Parameter>
84 Data Access Guide
SBO parameter reference
Default SBO parameters
6
Description
Values
Specifies the maximum length in characters of a
database procedure name.
An integer that specifies the maximum database procedure name length in characters.
The value set in the database middleware.Default
Procedure Parameter Name Max Size
<Parameter Name="Procedure Parameter Name Max Size">1024</Pa
rameter>
Description
Values
Specifies the maximum length in characters of a
database procedure parameter name.
An integer that specifies the maximum database procedure parameter name length in characters.
Qualifiers Available
<Parameter Name="Qualifiers Available">True</Parameter>
The value set in the database middleware.Default
Specifies whether or not Qualifiers are supported.Description
Data Access Guide 85
SBO parameter reference
6
Default SBO parameters
True: Specifies that Qualifiers are supported.
Values
False: Specifies that Qualifiers are not supported.
Default
Not specified. Connection Server retrieves this information from the database middleware.
Query TimeOut Available
<Parameter Name="Query TimeOut Available">True</Parameter>
Specifies whether or not Query TimeOut is supported
Description
Values
by the database middleware, that is if a query that is
running can be cancelled after a time period has expired.
True: Specifies that Query TimeOut is supported by
the database middleware .
False: Specifies that Query TimeOut is not supported
by the database middleware .
FalseDefault
Quoted Identifier Case
<Parameter Name="Quoted Identifier Case Available">True</Param
eter>
86 Data Access Guide
SBO parameter reference
Default SBO parameters
6
Description
Values
Default
Specifies how the database treats the case of quoted
identifiers.
LowerCase: quoted identifiers must be in lower case.
UpperCase: quoted identifiers must be in upper case.
MixedCase: quoted identifiers can be in mixed case.
SensitiveCase: quoted identifiers are case sensitive.
Not specified. Connection Server retrieves the information from the middleware.
Schema Name Max Size
<Parameter Name="Schema Name Max Size">1024</Parameter>
Description
Specifies the maximum length in characters of the
database schema name.
Values
Shared Connection
<Parameter Name="Shared Connection">True</Parameter>
An integer that specifies the maximum database
schema name length in characters.
The value set in the database middleware.Default
Data Access Guide 87
SBO parameter reference
6
Default SBO parameters
Specifies whether or not the requested connection of
a connection pool is shared. Operates in conjunction
Description
Values
Related Topics
• Max Pool Time on page 55
• Connection Shareable on page 76
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.
False: the connection is not shared.
FalseDefault
SQL External File
<Parameter Name="SQL External File">filename</Parameter>
Description
SQL Parameter File
<Parameter Name="SQL Parameter File">oracle</Parameter>
88 Data Access Guide
Note:
Do not edit this value.
The SQL External file file holds configuration details
used by the data access layer.
Description
SBO parameter reference
Default SBO parameters
The name of the file that stores database parameters.
The extension of this file is: .prm
You must ensure that this file is located in the same
directory as the data configuration file (.sbo file).
datafederator for BusinessObjects Data Federator
neoview for HP Neoview
essbase for Hyperion Essbase
db2iseries for IBM DB2 iSeries
db2udb for IBM DB2
informix for Informix
access for Microsoft Access
sqlsrv for Microsoft SQL Server 2000
6
Values
mysql for MySQL
netezza for Netezza Server
openaccess for OpenAccess
oracle for Oracle
progress for Progress 10
redbrick for Red Brick Decision Server
sybase for Sybase
asiq for Sybase ASIQ
ssa for Sybase SQL Anywhere
teradata for Teradata
The listed values.Default
Data Access Guide 89
SBO parameter reference
6
Default SBO parameters
SSO Available
Strategies File
<Parameter Name="SSO Available">False</Parameter>
Specifies whether or not Single Sign On is supported.Description
True: Single Sign On is supported.
Values
False: Single Sign On is not supported .
FalseDefault
<Parameter Name="Strategies File">oracle</Parameter>
Description
Values
90 Data Access Guide
Specifies the name, with no extension, of the Strategy
file (.stg). This file contains the external strategies
that 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.
oracle for Oracle.
sybase for Sybase.
teradata for Teradata.
Table Name Max Size
<Parameter Name="Table Name Max Size">1024</Parameter>
SBO parameter reference
Default SBO parameters
See values above.Default
6
Description
Values
Specifies the maximum length in characters of a
database table name.
An integer that specifies the maximum database table
name length in characters.
The value set in the database middleware.Default
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.
Data Access Guide 91
SBO parameter reference
6
Default SBO parameters
Values
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.
Note:
Do not use a driver with Transactional Avail
able=No to access the Business Objects repository.
Default
Transaction Mode
<Parameter Name="Transaction Mode">AutoCommit</Parameter>
Description
Values
Default
Yes. This is set in the cs.cfg file.
Specifies the transaction mode that the database uses.
AutoCommit: statements are committed automatically
on completion of a request.
Transactional: on competion, an explicit call either
completes or rolls back the statement.
If not specified, the value is retrieved from the
database middleware.
Type
<Parameter Name="Type">Relational</Parameter>
92 Data Access Guide
Version
SBO parameter reference
Informix SBO parameters
Specifies the Business Objects data source type.
Description
<Parameter Name="Version">Relational</Parameter>
Description
Note:
This parameter must not be modified.
Specifies the database version.
Note:
This parameter must not be modified.
6
XML Max Size
<Parameter Name="XML Max Size">2048</Parameter>
Specifies the maximum size allowed for XML data.Description
The maximum allowed XML size, in bytes.Values
This varies depending on the database.Default
Informix SBO parameters
These parameters apply to the Informix SBO file. They are used to define
the connection to an Informix database.
Data Access Guide 93
SBO parameter reference
6
Informix SBO parameters
These parameters are defined in the \\<INSTALDIR>\win32_x86\dataAc
cess\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 on page 95
• To modify the Informix ODBC.INI file on page 94
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.
• 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
94 Data Access Guide
V5toV6DriverName
<Parameter Name="V5toV6DriverName">{Informix 3.34 32 BIT}</Pa
rameter>
Description
SBO parameter reference
Informix SBO parameters
Specifies the conversion rule from Informix Connect
to Informix ODBC. The value of this parameter determines which Informix Driver is used to define the
ODBC Data Source Name (DSN) without the connection string..
6
Unicode
Values
Default
<Parameter Name="Unicode">CharSet</Parameter>
Description
The exact name of the Informix driver installed on the
machine.
The value set in the cs.cfg file.
Specifies if the access driver can benefit from the
Unicode configuration of the client middleware. This
parameter appears as a driver default in the cs.cfg
file. Its value applies to all data access drivers. It is
not listed by default in the SBO file. If you want to
over-ride the default value you add it to the Defaults
section of the SBO file for the target data access
driver.
Data Access Guide 95
SBO parameter reference
6
JavaBean SBO parameters
Values
UTF8: 8-bit UCS/Unicode Transformation Format
coding.
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 \\<INSTALDIR>\win32_x86\dataAc
cess\connectionServer\javaean\javaean.sbo file.
JavaBean Class
<Parameter Name="JavaBean Class">string</Parameter>
Defines the entry point of the JavaBean that the
Business Objects application uses. The entry point is
Description
the definition of a java class extending from the Bean
interface specified through the com.businessobjects
package.
96 Data Access Guide
A fully-qualified class JavaBean class name.Values
None.Default
URL Format
<Parameter Name="URL Format ">string</Parameter>
Description
SBO parameter reference
JDBC SBO parameters
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 :
jdbc:mysql://$DATASOURCE$/$DATABASE$
• Oracle vendor :
jdbc:oracle:thin:@$DATASOURCE$:$DATABASE$
The URL FormatValues
6
NoneDefault
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 \\<INSTALDIR>\win32_x86\dataAc
cess\connectionServer\jdbc\jdbc.sbo file.
ForeignKeys Available
<Parameter Name="ForeignKeys Available">True</Parameter>
Data Access Guide 97
SBO parameter reference
6
JDBC SBO parameters
Description
Values
JDBC Class
<Parameter Name="JDBC Class">string</Parameter>
Values
Specifies if ForeignKeys can be retrieved.
True: ForeignKeys can be retrieved.
False: ForeignKeys cannot be retrieved.
TrueDefault
The JDBC driver's fully qualified Java class.Description
Depends on the vendor/datasource, for example :
• oracle.jdbc: OracleDriver for Oracle
• com.ibm.db2.jcc.DB2Driver: for DB2
Default
PrimaryKey Available
<Parameter Name="PrimaryKey Available">True</Parameter>
98 Data Access Guide
None.
SBO parameter reference
ODBC SBO parameters
6
Description
Values
Specifies whether or not the primary keys can be retrieved.
True: Primary keys can be retrieved.
False: Primary keys cannot be retrieved.
TrueDefault
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 \\<INSTALDIR>\win32_x86\dataAc
cess\connectionServer\odbc\odbc.sbo file.
Empty String
<Parameter Name="Empty String">NullString</Parameter>
Specifies that certain functions, for example SQL ta-
Description
Values
bles, receive either an empty string or a null pointer
to replace missing parameters.
NullString: Specifies that a null string is used.
EmptyString: Specifies that an empty string used.
EmptyStringDefault
Data Access Guide 99
SBO parameter reference
6
ODBC SBO parameters
Force Close Statement
<Parameter Name="Force Close Statement">True</Parameter>
Description
Values
ODBC Cursors
<Parameter Name="ODBC Cursors">No</Parameter>
Description
Values
Specifies that the SQL statement is closed after it
completes execution.
True: the SQL statement is closed after it executes.
False: the SQL statement is not closed after it executes.
Specifies if the ODBC cursor library is used by the
data access driver.
Yes: the ODBC cursor library is used by the data access driver.
No: the ODBC cursor library is not used by the data
access driver.
Default
100 Data Access Guide
The value set in the cs.cfg file.
Loading...