Data Access Guide. BusinessObjects 11. Windows and UNIX

Transcription

1 Data Access Guide BusinessObjects 11 Windows and UNIX

2 1 Copyright Trademarks Use restrictions Patents Copyright 2004 Business Objects. All rights reserved. If you find any problems with this documentation, please report them to Business Objects in writing at Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise are trademarks or registered trademarks of Business Objects SA or its affiliated companies in the United States and other countries. All other names mentioned herein may be trademarks of their respective owners. Contains IBM Runtime Environment for AIX(R), Java(TM) 2 Technology Edition Runtime Modules (c) Copyright IBM Corporation 1999, All Rights Reserved. This product includes code licensed from RSA Security, Inc. Some portions licensed from IBM are available at This software and documentation is commercial computer software under Federal Acquisition regulations, and is provided only under the Restricted Rights of the Federal Acquisition Regulations applicable to commercial computer software provided at private expense. The use, duplication, or disclosure by the U.S. Government is subject to restrictions set forth in subdivision (c)(1)(ii) of the Rights in Technical Data and Computer Software clause at Business Objects owns the following U.S. patents, which may cover products that are offered and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and 6,289,352. Part Number Data Access Guide

3 Contents Chapter 1 Data access basics 3 Overview Introducing Connection Server and data access drivers Connecting to your data Data access drivers What data access files are installed? Chapter 2 Creating connections 13 Overview Creating a connection with the New Connection wizard Chapter 3 Managing data access 27 Overview Configuring unicode data access Setting dynamic SQL parameters in a universe Optimizing data access by editing data access parameter files Chapter 4 Configuring specific data access drivers 43 Overview Oracle Teradata Chapter 5 Data type conversion reference 47 Overview IBM DB Informix Microsoft SQL Server Oracle Red Brick Data Access Guide 1

4 Contents Sybase Teradata Chapter 6 Setting universe dynamic SQL parameters 55 Overview Dynamic SQL parameters in a universe Chapter 7 Setting data access SQL parameters (PRM) 69 Overview Data access driver SQL parameters PRM file Configuration reference Chapter 8 Setting data access driver configuration parameters (SBO) 95 Overview Data access driver configuration parameters SBO file reference Chapter 9 Setting data access general configuration parameters (CFG) 109 Overview Data access general configuration file parameters Settings reference Appendix A Business Objects information resources 117 Documentation and information services Documentation Customer support, consulting and training Useful addresses at a glance Index Data Access Guide

5 Data access basics chapter

6 1 Data access basics Overview Overview Data access for Web Intelligence is managed by Connection Server. Connection Server is the Business Objects software layer that creates and manages connections used by universes between BusinessObjects data access drivers and target RDBMS middleware. Connection Server and the required data access components are automatically installed when you install Web Intelligence or Designer. This chapter introduces Connection Server. The following topics are described: Introducing Connection Server and data access drivers Connecting to your data Data access drivers What data access files are installed? Note: $INSTALLDIR variable in this guide In this guide the variable $INSTALLDIR is the install root path for the data access files used by Designer and Web Intelligence. This is the Business Objects installation path with the operating system sub directory that contains the Designer executable and the data access drivers. Under Windows$INSTALLDIR = \\...\Business Objects\BusinessObjects Enterprise 11\win32_x86. For example C:\Program Files\Business Objects\BusinessObjects Enterprise 11\win32_x86. Introducing Connection Server and data access drivers Universes access data in relational databases by using a connection to the data source middleware. A connection is a defined set of parameters between a BusinessObjects data access driver and a target middleware. A data access driver is the software layer that maps the SQL definitions and functions defined in the middleware to equivalent structures and parameters in a universe. 4 Data Access Guide

7 Data access basics Introducing Connection Server and data access drivers 1 Each connection between a data access driver and a RDBMS middleware is managed and controlled by a Business Objects data access management tool called Connection Server. What is Connection Server? Connection Server is the BusinessObjects data access management software that is installed automatically with one or more data access drivers for your RDBMS. Connection Server is installed by default with WebIntelligence and Designer. Connection Server allows InfoView and WebIntelligence users to connect to and run queries against a relational data source, whether it is a corporate database or a repository. How do you access Connection Server features? Connection Server does not have a user interface. You create and administer connections from the user interface of Designer. Creating connections You create connections using a connection wizard available from Designer. You can administer certain connection parameters from the Connection dialog box (Tools > Connections). See the chapter Creating connections on page 13 for more information on creating connections. Administering connection deployment In a WebIntelligence deployment, Connection Server is installed automatically with both these products. Each node in a cluster that has either of these products installed, also includes a Connection Server layer. Optimizing data access You can optimize the way that data is passed through Connection Server by modifying SQL and data access parameter files. These are files in XML format that are installed with Connection Server. You can edit these files to optimize values for parameters specific to a RDBMS, or general parameters that apply to all installed data access drivers. For information on data access drivers, see the section Data access drivers on page 7. Data Access Guide 5

8 1 Data access basics Connecting to your data For information on editing data access parameters files to optimize data access, see the sections: Optimizing data access by editing data access parameter files on page 38 Setting data access SQL parameters (PRM) on page 69 Setting data access driver configuration parameters (SBO) on page 95 Setting data access general configuration parameters (CFG) on page 109. Using connection management tools with Connection Server Connection management utilities that allow you to check and trace connection processes are installed with Connection Server. You run these applications from a command line. Using these utilities is described in the chapter Managing data access on page 27. Connecting to your data A connection allows WebIntelligence users to access data in a target RDBMS. What is a connection? A connection is a named set of parameters that defines how Web Intelligence accesses data in a database file. It is the link between a universe, a data access driver, your middleware, and your database. You must have a valid connection between your target universe and your database in order to access your data. A connection is made up of the following elements: Connection element Data access driver Connection and login parameters Connection type BusinessObjects software layer that connects a universe to your middleware. Connection parameters that allow the data access driver to connect to the target database middleware. These parameters include Connection user name, password, and data source name. Type of connection that determines who can use it. A connection can be personal, shared, or secured. 6 Data Access Guide

9 Data access basics Data access drivers 1 Pre-requisites to creating a connection? To create a connection you must have the following: middleware information about your database server Designer installed BusinessObjects data access driver Connection workflow overview The following is an overview of the process that you follow to create a connection. Creating connections is fully described in the chapter Creating connections on page 13. Ensure that you have all the information necessary to access your database. Install middleware so that you can access your database through either your computer or a server. Install Business Objects products and the appropriate data access driver. Using the New Connection wizard accessible from Designer, you connect your middleware to your data access driver. Make any necessary modifications to optimize the connection parameters. You can customize certain parameters from the Connection Wizard. Data access drivers Other parameters can be customized in the SQL parameter file associated with the data access driver. This file is called the <driver>.prm file. See the chapter Setting data access SQL parameters (PRM) on page 69 for information on editing the PRM file for your data access driver. Many SQL generation parameters can also be set at the universe level from Designer. See the chapter Setting universe dynamic SQL parameters on page 55 for information. A data access driver is the BusinessObjects software layer that connects a universe to your middleware. Data Access Guide 7

10 1 Data access basics What data access files are installed? Data access drivers are shipped with Business Objects products. There is a data access driver for each supported middleware. When you install Business Objects products, your data access key determines which data access drivers are installed. When you create a new connection, you select the appropriate data access driver for the RDBMS middleware that you use to connect to the target RDBMS. For example, if you access an Oracle 8i database, you must install the appropriate middleware (Oracle 8i Client), then the BusinessObjects Oracle data access driver. The types of databases supported through data access drivers are listed below. Each data access driver is described in its respective chapter in this guide.and the chapters associated with the connection: IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata What data access files are installed? This section describes the data access files that are installed when you install Business Objects products. Data access files can be divided into two levels: Global level. These are files that apply to all installed data access drivers. Driver level. These are data access driver specific files. Note: Not all the files installed by Connection Server are listed. Most of the files described in this section contain parameters that can be modified to optimize or customize data access. Certain files are listed to explain their function. These and other files in these directories must not be modified. They are required for full functionality, so do not remove them. The global and driver level files are described in their respective sections below. 8 Data Access Guide

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

12 1 Data access basics What data access files are installed? Installed file strategy_localization. dtd strategy.dtd sbo.dtd dbparameters_localiz ation.dtd dbparameters.dtd cscheckresults.dtd cschecklocales.dtd cs.dtd <driver><language>. cod Edit this file? No No DTD files for the corresponding XML files in the same directory. Lists options that appear in the RDBMS page of the Connection wizard. Warning: Do not modify this file. Driver level data access files Driver level files used by specific data access drivers are installed here: $INSTALLDIR\dataAccess\RDBMS\connectionServer\<RDBMS> There are other files in these directories but they not currently modifiable. They are required for full functionality, so do not remove them. 10 Data Access Guide

13 Data access basics What data access files are installed? 1 The files listed below have parameters that apply to installed data access drivers. Driver specific file Can be edited? <driver><language>.stg Yes Contains the Help text for each external strategy defined in the <driver>.stg file. This text appears when the strategy is selected in Designer. <driver>.stg Yes Contains the external strategies available to the data access driver. See the Designer s Guide for information on using external strategies. <driver>.sbo Yes Defines all databases supported and the specific connectivity configuration for each database. See the sections: Data access driver general configuration (<driver>.sbo) on page 39 Setting data access driver configuration parameters (SBO) on page 95 <driver><language>.prm Yes Contains the Help text for functions that are listed in the <driver>.prm file. This text appears when the function is selected in Designer. Example oracleen.stg oracle.stg oracle.sbo oracleen.prm Data Access Guide 11

14 1 Data access basics What data access files are installed? Driver specific file Can be edited? <driver>.prm Yes Defines the information parameters and functions related to database. For more information, see the sections: Optimizing data access by editing data access parameter files on page 38 Setting data access SQL parameters (PRM) on page 69 <driver><language>.cod No Stores information related to connection definitions. Warning: Do not modify this file. Example oracle.prm oracleen.cod 12 Data Access Guide

15 Creating connections chapter

16 2 Creating connections Overview Overview This chapter provides information about creating connections to database middleware. It describes how you create connections using the New Connection wizard, set login parameters, and optimize certain connection settings. Connection issues that are specific to RDBMS are also covered. This chapter covers the following topics: Creating a connection with the New Connection wizard Setting login parameters Setting advanced parameters Setting custom parameters Creating a connection with the New Connection wizard You create a connection using the New Connection Wizard. This is a connection wizard that is accessible from Designer. The wizard allows you to select a target database and middleware, then configure the data access driver that you use to access the middleware. What connection parameters are set in the New Connection wizard? You use the wizard to set the following parameters: Connection wizard stage Login parameters. Identify the connection and allow you to connect See Setting login to the middleware. Parameters include Type, parameters on page 20 for Connection name, User name, Password, and more information. Data source or service. 14 Data Access Guide

17 Creating connections Creating a connection with the New Connection wizard 2 Connection wizard stage Advanced parameters See Setting advanced parameters on page 22 for more information. Custom parameters See Setting custom parameters on page 24 for more information. The procedure for starting and following the New Connection wizard appears below. The parameters that you can set on each page are fully described in their respective section. Using the New Connection wizard Allow you to manage certain connection parameters. These include connection length, array fetch and bind sizes, and login time-out. Parameters that you can add and customize to optimize your connection. You create a connection using the New Connection wizard. Accessing the New Connection wizard You access the New Connection in Designer as follows: From the Universe parameters dialog box 1. Select File > Parameters 2. Click the New button. From the Connections list 1. Select Tools > Connections. 2. Click Add The Welcome page of the New Connection wizard appears. Creating a connection with the New Connection wizard To create a connection with the New Connection wizard: 1. Start the New Connection wizard. The wizard welcome page appears. 2. Click Next. The Database middleware selection page appears. It lists the database and middleware that correspond to your data access licence key. 3. Do the following from the Database middleware selection page: Data Access Guide 15

18 2 Creating connections Creating a connection with the New Connection wizard Expand a database node. The middleware available for the database appear under the node. Expand a middleware node. The data access driver for the middleware appears under the node. Click the data access driver name. The data access driver for Oracle 9 is shown below. Click Next. The Login parameters page appears. It lists login and connection identifying parameters for the data access driver. Login parameters are fully described in the section Setting login parameters on page Do the following from the Login parameters page: Select a connection type. Type connection name, user name, and database password. 16 Data Access Guide

19 Creating connections Creating a connection with the New Connection wizard 2 Select a data source from the Data source or Service drop down list box Or Type the name for the database or data source that you want to access. A Login Parameters page with parameters completed appears below.. Click Next. Note: If you want users to access the database with their CMS (repository) login, select the Use Single Sign-On when viewing reports check box. To use this feature, the CMS login must be the same as the login to the database. The Perform a test page appears. It summarizes the connection information and allows you to test the connection. 1. Click the Test Connection button. If the connection is valid then Server is responding appears under the Test Data Source button. If the connection is not valid then Server is not responding appears under the Test Data Source button. Information describing the failed connection appears in the zone to the left of the Test Data Source button. Data Access Guide 17

20 2 Creating connections Creating a connection with the New Connection wizard Click Next. The Advanced Parameters page appears. It lists certain connection parameters that you can set to optimize your connection. Advanced parameters are fully described in the section Setting advanced parameters on page Data Access Guide

21 Creating connections Creating a connection with the New Connection wizard 2 2. Select values for advanced connection parameters then click Next. Or Click Next directly if you don t want to set advanced parameters. The Custom Parameters page appears. It allows you to manually set certain parameters. Custom parameters are fully described in the section Setting custom parameters on page If you do not want to modify a listed parameter, click Finish. Or If you want to modify a default parameter value do the following: Select a parameter in the list. Type a value in the text box under the parameter list and click Set. If you want to remove the value, click Remove. Data Access Guide 19

22 2 Creating connections Creating a connection with the New Connection wizard Click Finish. The Connections list appears. The new connection is now included in the list. 4. Click Finish to close the Connections list. The connection is now available to the universe. Setting login parameters The Login Parameters page of the New Connection wizard contains the following parameters: Parameter Type Name Connection type. You can create one of three connection types: Personal Shared Secured See the section Connection type on page 21 for more information on the types of connections that you can create. Identifying name for the connection. 20 Data Access Guide

23 Creating connections Creating a connection with the New Connection wizard 2 Parameter User name Use Single Sign-On when viewing reports Password Data source or Service Your database user name. This is normally assigned to you by the database administrator. When selected, the user name and password used to access the CMS are automatically used as database login parameters. See the BusinessObjects Enterprise 11 Administrator s Guide for information on setting up Single Sign-On. Your database password. This is normally assigned to you by the database administrator. Data source or database name. If you are using an ODBC driver the data source name identifies the target database. If you are using a native driver, the database name identifies the target database. Connection type The type of connection determines who can use the connection to access data. Designer automatically stores all the connections that you create during a work session. The next time you launch a session, these connections will be available to you. You can create three types of connections with Designer: Personal Shared Secured Each connection type is described as follows: Personal connections Restricts access to data to the universe creator and the computer on which it was created. Connection parameters are stored in the PDAC.LSI file located in the LSI folder in the Business Objects installation path. An example of this path is shown below. C:\Program Files\Business Objects\BusinessObjects Enterprise 11\win32_x86\pdac.lsi These parameters are static and cannot be updated. Personal connections are unsecured in terms of Business Objects products security. You do not use personal connections to distribute universes. You could use personal connections to access personal data on a local machine. Data Access Guide 21

24 2 Creating connections Creating a connection with the New Connection wizard Shared connections Allows access to data for all users. These connections are unsecured in terms of Business Objects products security. Connection parameters are stored in the SDAC.LSI file located in the LSI folder in the Business Objects installation path. An example of this path is shown below. C:\Program Files\Business Objects\BusinessObjects Enterprise 11\win32_x86\sdac.lsi If the SDAC.SSI file is stored locally, only users having access to the local machine (through a mapped drive), can use the shared connections. Shared connections can be useful in a universe testing environment. Secured connections Centralizes and controls access to data. It is the safest type of connection, and should used be to protect access to sensitive data. You can create secured connections with Designer. You must use secured connections if you want to distribute universes through the CMS. Secured connections can be used and updated at any time. Setting advanced parameters The Advanced page contains parameters used to over ride the following common configuration options: Defining the duration of a connection into a pool Defining how Business Objects products respond when database resources are not available Defining the size of the array fetch 22 Data Access Guide

25 Creating connections Creating a connection with the New Connection wizard 2 You can set the following advanced parameters: Parameter Disconnect after each transaction Keep the connection active for x minutes Keep the connection active during the whole session (local mode only) Get error message and stop Wait for resources Array fetch size Click if you want your connection to disconnect immediately after the transaction is completed. Users will have to reconnect each time they want to access data. Click if you want your connection to stay active for a defined period of time. You must also enter a value for the number of minutes. This is the default Connection Property. Click if you want your connection to stay active during the entire session of the product. The connection ends when the user exits the application. Click if you want your connection to disconnect and notify the user that the resource is locked when a user receives an error message. This is the default Locked Resources option. Click if you want your connection to remain active without notifying users. Enter the maximum number of rows authorized with each fetch. If you enter 20, and your query retrieves 100 rows, the connection executes 5 fetches to retrieve your data. Five fetches of 20 rows each equals 100 rows of data. If you enter 1, the array fetch is deactivated and data is retrieved row by row. Note: Deactivating array fetch is the safest way of retrieving your data but row-by-row retrieval slows down server performance. The greater the value in the Array fetch size option, the faster your rows are retrieved; you must, however, ensure you have adequate client system memory. Note: If a query retrieves data containing blob or long text types, the array fetch is automatically reset to 1. The default value is 20. Data Access Guide 23

26 2 Creating connections Creating a connection with the New Connection wizard Parameter Array bind size Login timeout Enter the size of the bind array that Connection Server uses before sending to the repository. The bind array is the area in memory that Connection Server stores a batch of data to be loaded (sent to the repository). When the bind array fills, it is transmitted to the database. Generally, the larger the bind array, the more rows (n) can be loaded in one operation, and the better your performance. Specifies the number of seconds that must be spent to establish a connection before an error message is displayed. Setting custom parameters Using Hints (Oracle only) on the Custom page should only be modified by an advanced user, DBA, or BusinessObjects administrator. It contains certain parameters that can be used to override connection settings. The following parameters are available Binary Slice Size. This appears by default in the Advanced page for all data access drivers. This parameter specifies the size of the slice used to store the binary content of all documents sent to the repository. It is described in the section Binary Slice Size on page 101. Hint (Oracle only). This parameter is described below. A Hint is commented information that is embedded in a query, and used by the Oracle optimizer to choose an execution plan. You should consult your Oracle documentation for full information on the Hints that can be used, and how they can be used to optimize queries. You enter the value for a Hint as a comment. A plus sign is used at the beginning, immediately after the comment delimiter, with no space between the comment delimiter and the plus sign: /*+ <hint> */ 24 Data Access Guide

27 Creating connections Creating a connection with the New Connection wizard 2 Some useful Hints that you can use are as follows. Consult your Oracle documentation for a full list: Hint FIRST_ROWS RULE FULL ROWID INDEX_FFS What it does... Optimizes response time. Use rule-based optimization and not cost. Does a full table scan on the table. Scans table by rowid. Perform a fast full scan on the index rather than on the table. Example: FIRST_ROWS On the Custom page, click Hints and type /* FIRST_ROWS */ in the values box under the parameter list, and click on Set. The SQL is: SELECT /* FIRST_ROWS */ RESERVATIONS.CUST_ID FROM RESERVATIONS Data Access Guide 25

28 2 Creating connections Creating a connection with the New Connection wizard 26 Data Access Guide

29 Managing data access chapter

30 3 Managing data access Overview Overview This chapter describes how you can use parameter files to optimize your data access driver. The following areas are described: Configuring unicode data access Setting dynamic SQL parameters in a universe Optimizing data access by editing data access parameter files Note: Other tools in the readme:you can use command line utilities to check your RDBMS and data access driver configuration, and to create log filies that trace Web Intelligence server activity. Refer to the readme for this release for instructions on the use of these utilities. Configuring unicode data access WebIntelligence users can run queries that return data containing characters that confirm to the Unicode Standard UTF-8, or the Universal Character Set (UCS) standard. Note: Unicode characters are not supported in table or object names in a universe. Unicode data access is available to WebIntelligence when the following conditions are met: Target middleware supports unicode. The BusinessObjects data access driver for the target middleware supports Unicode. Unicode parameters have been set in the General data access (SBO) file for the appropriate data access drivers, and in the dynamic SQL parameters for the target universe. When these conditions have been met, WebIntelligence users can run queries returning data sets that contain unicode characters. What RDBMS are supported for Unicode data access? Unicode data access is supported for the following RDBMS: Oracle Microsoft SQL Server IBM DB2 UDB 28 Data Access Guide

31 Managing data access Configuring unicode data access 3 Teradata Setting up unicode data access An overview of the steps you need to follow to set up unicode data access are as follows: 1. Set a unicode parameter in the <RDBMS>.sbo file for the data access driver. Or Set a default unicode parameter for all data access drivers using the general configuration file (cs.cfg). 2. Set an environment variable to a unicode value specific for the target RDBMS. Setting the SBO and environment variable values are described in sections for the following RDBMS: Setting up unicode data access for Oracle on page 29 IBM DB2 UDB on page 32 Microsoft SQL Server 2000 on page 33 Teradata V2R5 on page For the following RDBMS, you must set a SQL parameter for a target universe in Designer to allow queries return unicode characters. Oracle with local charset Microsoft SQL Server This is described in the section Activating unicode support in a universe (SQL Server and Oracle special case) on page 35. Setting up unicode data access is described for each supported middleware. Setting up unicode data access for Oracle You can set unicode support for a particular Oracle target data access driver, or as a default setting for all Oracle data access drivers. You do this in two stages: Set a parameter in the oracle.sbo file to activate unicode support. Set the environment variable NLS_LANG parameter to activate unicode support. This is done in the Windows registry for Windows, and from the command line for UNIX. Each stage is described below. Data Access Guide 29

32 3 Managing data access Configuring unicode data access Setting unicode support for a Oracle data access driver To set unicode support for a data access driver: 1. Open the oracle.sbo file in a XML file editor. General data access configuration (SBO) files are installed by default in the following directory: $INSTALLDIR \dataaccess\rdbms\connectionserver\oracle\oracle.sbo 2. Go to the section Databases. 3. Go to section Parameters for your target database version. 4. Add the following parameter and value: <Parameter Name="Unicode">UTF8</Parameter> The Database section should appear as follows: </DataBase> <DataBase Active="Yes" Name="Oracle 9"> <Parameter Name="Library">dbd_oci9</Parameter> <Parameter Name="Unicode">UTF8</Parameter> </DataBase> Note: You can set the unicode parameter for all Oracle RDBMS using the oracle.sbo file by adding the Unicode parameter with value UTF8 to the s section of the file (<Parameter Name="Unicode">UTF8</ Parameter>). This applies for all target Oracle middleware. 1. Save and close the file. Setting the NLS_LANG variable for Windows You set the NLS_LANG variable for a Windows environment in the registry. Note: Don t take risks when editing the registry. A mistake can cause one or more applications to not function correctly. You should create a backup copy of your registry before making modifications. As an extra security measure, before modifying a key value, you can also copy the value of the original key to a new temporary key, or save it in a backup text file until you are sure the new value functions correctly. To set NLS_LANG in the Windows registry: 1. Select Start > Run. Type regedit in the Run text box and click OK. The Registry Editor appears. 30 Data Access Guide

33 Managing data access Configuring unicode data access 3 2. Browse to the following key: HKEY_LOCAL_MACHINE\SOFTWARE\ORACLE\HOMEO 3. Select the NLS_LANG value. 4. Select Edit > Modify. 5. Replace the file extension with UTF8. For example, the default value for American Engish is: AMERICAN_AMERICA.WE81SO8859P1 Replace the file extension as follows: AMERICAN_AMERICA.UTF8 6. Save and close the registry editor. Setting the NLS_LANG variable for UNIX The NLS_LANG variable for the environment language must be set to the value UTF8. You set the NLS_LANG variable from the command line in UNIX. Modifying the NLS_LANG variable for UNIX: 1. Type the following command to verify your current set up: echo $NLS_LANG The current value of your system is returned. It appears as follows: <LANGUAGE>.<extension> for example: ENGLISH_UNITED KINGDOM.WE9ISO8859P 15. To activate unicode, you must replace the <extension> with UTF8. 2. Depending on the shell, use the following command to set the variable to <value>, where <value> is <LANGUAGE>.UTF8. tcsh or korn shell SETENV NLS_LANG <value> bash or cshell EXPORT NLS_LANG = <value> For example, ENGLISH_UNITED KINGDOM.WE9ISO8859P 15 is set to ENGLISH_UNITED KINGDOM.UTF8 Setting up unicode support for Oracle using a local charset When the Oracle database charset is set as a local charset, you also need to set the unicode universe parameter for each universe that access the unicode data. This parameter generates specific SQL syntax to specify that a UTF8 string is passed as condition. The database being set as local charset usually Data Access Guide 31

34 3 Managing data access Configuring unicode data access handles local charset strings.this is described in the section Activating unicode support in a universe (SQL Server and Oracle special case) on page 35. IBM DB2 UDB You can set unicode support for a particular IBM DB2 target data access driver, or as a default setting for all IBM DB2 data access drivers. You do this in two stages: Set a parameter in the db2.sbo file to activate unicode support. Set the environment variable NLS_LANG parameter to activate unicode support. Each stage is described below. Setting unicode support for a IBM DB2 data access driver To set unicode support for a data access driver: 1. Open the db2.sbo file in a XML file editor. General data access configuration (SBO) files are installed by default in the following directory: $INSTALLDIR \dataaccess\rdbms\connectionserver\db2\db2.sbo 2. Go to the section Databases. 3. Go to section Parameters for your target database version. 4. Add the following parameter and value: <Parameter Name="Unicode">UTF8</Parameter> The Database section should appear as follows: </DataBase> <DataBase Active="Yes" Name="DB2 UDB v8"> <Parameter Name="Binary SliceSize">30000</Parameter> <Parameter Name="Max Rows Available">True</Parameter> <Parameter Name="Unicode">UTF8</Parameter> </DataBase> Note: You can set the unicode parameter for all IBM DB2 RDBMS using the db2.sbo file by adding the Unicode parameter with value UTF8 to the s section of the file (<Parameter Name="Unicode">UTF8</ Parameter>). This applies for all target IBM DB2 middleware. 1. Save and close the file. 32 Data Access Guide

35 Managing data access Configuring unicode data access 3 Setting the variable DB2CODEPAGE You now must set the DB2CODEPAGE variable for the environment variable to the value Microsoft SQL Server 2000 You can set unicode support for a Microsoft SQL Server 2000 target data access driver, or as a default setting for all ODBC data access drivers. You do this by setting a parameter in the odbc.sbo file to activate unicode support. Setting unicode support for a Microsoft SQL Server 2000 data access driver To set unicode support for Microsoft SQL Server 2000: 1. Open the odbc.sbo file in a XML file editor. General data access configuration (SBO) files are installed by default in the following directory: $INSTALLDIR \dataaccess\rdbms\connectionserver\odbc\odbc.sbo 2. Go to the section Databases for MS SQL Server Go to section Parameters for MS SQL Server Add the following parameter and value: <Parameter Name="Unicode">UCS2</Parameter> 5. Verify that the Library parameter has the correct Unicode library name. For example: <Parameter Name="Library">dbd_wmssql</Parameter> The Database section should appear as follows: <DataBase Active="Yes" Name="MS SQL Server 2000"> <Parameter Name="Family">Microsoft</Parameter> <Parameter Name="Version">rdbms_mssqlserverodbc.txt</ Parameter> <Parameter Name="SQL External File">sqlsrv</ Parameter> <Parameter Name="SQL Parameter File">sqlsrv</ Parameter> <Parameter Name="Array Bind Available">True</ Parameter> <Parameter Name="Library">dbd_wmssql</Parameter> <Parameter Name="Unicode">UCS2</Parameter> <Parameter Name="Driver Level">31</Parameter> </DataBase> Note: Data Access Guide 33

36 3 Managing data access Configuring unicode data access Teradata V2R5 You can set the unicode parameter for all data access drivers using the odbc.sbo file by adding the Unicode parameter with value UCS2 to the s section of the file (<Parameter Name="Unicode">UCS2</ Parameter>). 1. Save and close the file. Setting up unicode support in a universe For Microsoft SQL Server, once you have set up the data access driver for unicode support, you now need to set the unicode universe parameter for each universe that access the unicode data. This is described in the section Activating unicode support in a universe (SQL Server and Oracle special case) on page 35. You can set unicode support for a Teradata V2R5 target data access driver, or as a default setting for all Teradata data access drivers. You do this by setting a parameter in the teradata.sbo file to activate unicode support. Setting unicode support for a Teradata data access driver To set unicode support for a data access driver: 1. Open the teardata.sbo file in a XML file editor. General data access configuration (SBO) files are installed by default in the following directory: $INSTALLDIR \dataaccess\rdbms\connectionserver\teradata\teradata.sbo 2. Go to the section Databases. 3. Go to section Parameters for your target database version. 4. Add the following parameter and value: <Parameter Name="Unicode">UTF8</Parameter> The Database section should appear as follows: <DataBase Active="Yes" Name="Teradata V2 R5"> <Parameter Name="Unicode">UTF8</Parameter> </DataBase> Note: You can set the unicode parameter for all Teradata data access drivers using the teradata.sbo file by adding the Unicode parameter with value UTF8 to the s section of the file (<Parameter Name="Unicode">UTF8</ Parameter>). This applies for all target Teradata middleware. 1. Save and close the file. 34 Data Access Guide

37 Managing data access Configuring unicode data access 3 Activating unicode support in a universe (SQL Server and Oracle special case) For Microsoft SQL Server, and the case when an Oracle database charset is set as a local charset, once you have set unicode support in the SBO file for the target data access driver, you must activate the SQL parameter UNICODE in each universe that uses the data access driver to access unicode data. The setting UNICODE_STRINGS in Designer for SQL generation indicates that specific SQL generation is required because of NVARCH, NCHAR columns in the universe. The UNICODE_STRINGS parameter ensures that specific SQL syntax is generated to specify that a UTF8 string is passed as condition. The string is specified by another parameter, the UNICODE_PATTERN parameter in the PRM file. Once you have set UNICODE_STRINGS to Yes, you then set the string condition in for the UNICODE_PATTERN parameter in the PRM file. The database being set as local charset usually handles local charset strings. You set the UNICODE_STRINGS parameter in Designer. See the section Setting dynamic SQL parameters in a universe on page 36 for complete information on setting dynamic SQL parameters for a universe in Designer. You set the UNICODE_PATTERN parameter in the PRM file for the target RDBMS. See the chapter Setting data access SQL parameters (PRM) on page 69 for information on setting PRM parameters. Setting unicode support for a universe in Designer To set unicode support for a universe in Designer: 1. Start Designer. 2. Open the universe that you want to access unicode enabled middleware. 3. Select File > Parameters. 4. Click the Parameter tab. 5. Scroll down the list of SQL parameters to UNICODE_STRINGS parameter. 6. Click UNICODE_STRINGS. 7. Remove No in the Value box, and type Yes. 8. Click the Replace button. 9. Click OK. Data Access Guide 35

38 3 Managing data access Setting dynamic SQL parameters in a universe 10. Save and export the universe. Setting dynamic SQL parameters in a universe In Designer, you can dynamically configure certain SQL parameters that are common to most RDBMS to optimize the SQL generated in BusinessObjects and WebIntelligence products using the universe. Using parameter (PRM) files in previous versions of Designer In previous versions of Designer, the SQL generation parameters used by a universe were maintained and edited in a separate file called a parameters (PRM) file. The values set in the PRM file applied to all universes using the associated data access driver defined for a connection. Many of the SQL parameters that are used to optimize query generation are now controlled within an individual universe file. The PRM file is now no longer used for the query generation parameters that you can set in Designer. PRM files are still used for parameters that are database specific. Note: See the chapter Setting universe dynamic SQL parameters for a complete reference on the universe SQL parameters available in Designer. Setting the SQL parameters dynamically in Designer Many of the parameters common to most supported RDBMS middleware are available for editing in the Parameters tab in the universe parameters dialog box (File > Parameters > Parameter). These parameters apply only to the active universe, and are saved in the UNV file. When you modify an SQL parameter for a universe in Designer, the value defined in Designer is used, and not the value defined in the PRM file associated with the data access driver for the connection. Editing SQL generation parameters You can modify the values for SQL parameters that determine SQL generation in products using the universe. See the chapter Setting universe dynamic SQL parameters for a complete reference on the universe SQL parameters available in Designer. To edit SQL generation parameters: 36 Data Access Guide

39 Managing data access Setting dynamic SQL parameters in a universe 3 1. Select File > Parameters. The Parameters dialog box appears. 2. Click the Parameter tab. The Parameter page appears. 3. Edit, add, or remove parameters as follows: To... Then do the following Add a new parameter 1. Click any parameter in the list. 2. Type a name in the Name box 3. Type a value in the Value box. 4. Click Add. The new value appears at the bottom of the list Change name or value 1. Click a parameter in the list. 2. Type a new name in the Name box 3. Type a new value in the Value box. 4. Click Replace. The value is replaced by the new definition. Delete a parameter 1. Click the parameter that you want to remove from the list. 2. Click Delete. Data Access Guide 37

40 3 Managing data access Optimizing data access by editing data access parameter files 4. Click OK. Note: The SQL generation parameter values that you set in a universe, are only available to products using that universe. Optimizing data access by editing data access parameter files Certain data access parameters can be modified to optimize BusinessObjects and WebIntelligence access to data for all installed data access drivers, a specific data access driver, or the SQL generation parameters for a specific data access driver. Data access parameters are listed in three XML files: General configuration for all data access drivers (CS.CFG) Data access driver general configuration (<driver>.sbo) Data access driver SQL parameters (<driver>.prm) These files are all in XML format. You should use an XML editor, for example XML Spy to edit these files. Each of these files is described briefly below. Full descriptions and editing procedures are described in the reference chapter for each file at the end of the book. Note: Certain SQL generation parameters that were set in the PRM file in previous versions of BusinessObjects products, are now available at the universe level. These parameters are edited in a universe and are available to all reporting products using the universe. See the section Setting dynamic SQL parameters in a universe on page 36 for more information. How are the data access files used by a connection? Connection Server uses the CFG, SBO, and PRM data access files to manage the parameters of a connection between a data access driver and the target middleware. The default parameters used by a connection are defined in these three files. Some of these parameters can be modified in the CFG file to apply to all data access drivers, or set at the driver level (SBO) to over-ride the general default value. Parameters in the PRM file can be modified to optimize the SQL generation for products using the connection. Connection Server refers to the data access files for the following purposes: 38 Data Access Guide

41 Managing data access Optimizing data access by editing data access parameter files 3 CS.CFG: connection and driver settings that apply to all data access drivers. SBO: connection and driver settings that are driver specific. these default values apply only to the target data access driver. PRM: SQL operators and functions that are available to the target data access driver. The values set for these SQL operators and functions can be modified to optimize the SQL generated in Business Objects products. Each of these files is discussed briefly below. A list of all parameters available in each file, and the methods for viewing and editing the files are available in the reference chapters that correspond to each file at the back of this manual. General configuration for all data access drivers (CS.CFG) The general configuration for all data access drivers (CS.CFG) file contains parameters for the following uses: Char set for each locale List of all files used by data access drivers to create and configure connections Driver defaults that apply to all drivers, for example array fetch size and array bind size. Activating traces for connection activity. set in the CS.CFG file apply to all data access drivers listed in the DRIVER DEFAULTS section of the file. The CS.CFG file is found here: $INSTALLDIR\dataAccess\RDBMS\connectionServer\ The file uses the cs.dtd in the same directory. A description of each parameter in the CS.CFG file, and the procedure for editing the file are documented in the chapter Setting data access general configuration parameters (CFG) on page 109. Data access driver general configuration (<driver>.sbo) The data access driver general configuration (.SBO) file contains parameters for the following uses: Data Access Guide 39

42 3 Managing data access Optimizing data access by editing data access parameter files List of files used by a specific data access driver to manage connections Driver defaults that apply to a specific data access driver. List of database aliases used for connections defined with older database engines. set in the <driver>.sbo file apply to the specific <driver> data access driver. The <driver>.sbo file is found here: $INSTALLDIR \dataaccess\rdbms\connectionserver\<rdbms>\ The file uses the sbo.dtdin the directory $INSTALLDIR \dataaccess\rdbms\connectionserver. A description of each parameter in a SBO file, and the procedure for editing the file are documented in the chapter Setting data access driver configuration parameters (SBO) on page 95. Data access driver SQL parameters (<driver>.prm) The data access driver SQL parameters (.PRM) file contains parameters that have default values set for SQL generation parameters that apply to a specific data access driver. The data access SQL parameter (.PRM) file contains parameters for the following uses: Configuration parameters that specify how certain database operations are handled by the data access driver. Date operators. A list of the SQl operators supported by the data access driver. A list of the database functions supported by the data access driver. These functions are available in the Functions pane in the Edit Select or Where statement dialog box for an object in Designer. You can add finctions to this list in the PRM file, if the target RDBMS supports the function and it is not available by default in the PRM file. A description of each parameter in a PRM file, and the procedure for editing the file are documented in the chapter Setting data access SQL parameters (PRM) on page 69. Any modification to this file applies only to the specified data access driver. The <driver>.prm file is found here: $INSTALLDIR \dataaccess\rdbms\connectionserver\<rdbms>\ 40 Data Access Guide

43 Managing data access Optimizing data access by editing data access parameter files 3 The file uses the dbparameter.dtd in the directory $INSTALLDIR \dataaccess\rdbms\connectionserver. Certain SQL parameters can be set from only the universe itself. These dynamic SQl parameters can be editied from Designer (File > Parameters > Parameter). The SQL generation parameters that can be set for a universe are described in the section Setting dynamic SQL parameters in a universe on page 36. Data Access Guide 41

44 3 Managing data access Optimizing data access by editing data access parameter files 42 Data Access Guide

45 Configuring specific data access drivers chapter

46 4 Configuring specific data access drivers Overview Overview Oracle This chapter contains data access information specific to each supported RDBMS. Consult the BusinessObjects 11 readme for the latest release issues. Data access driver specific information is available for the following RDBMS: Oracle Teradata This section lists connection and data access issues that are specific to Oracle. WebIntelligence Web Intelligence Oracle connection configuration The default Oracle middleware to server configuration is as follows: Oracle client middleware version 8.1.x to Oracle DB Server 8i. Oracle client middleware version 9x to Oracle DB Server 9i. 44 Data Access Guide

47 Configuring specific data access drivers Teradata 4 If your configuration is... Oracle client middleware version 8.1.x to Oracle DB Server 9i Oracle client middleware version 9x to Oracle DB Server 8i Teradata If your client middleware to Oracle server is not as listed above; for example, if you are using client middleware version 8 and accessing an Oracle server 9, then depending on your configuration, you must perform the following steps to ensure that your connection to an Oracle RDBMS can function: Then you must Open the oracle.sbo in a text or xml editor. This file is here: $INSTALLDIR /dataaccess/ RDBMS/connectionServer/oracle/oracle.sbo 2. Go to the section Databases. 3. Set The your connection database engine to "Oracle 9" and modify the.sbo parameter file as follows: 4. Comment out the Library line. [Oracle 9] ; Library=dbd_oci9 The.sbo file is found in the directory $INSTALLDIR /dataaccess/rdbms/ connectionserver/oracle/oracle.sbo Set your connection database engine to "Oracle 8.1" and modify the.sbo parameter file as follows: Add a Library parameter and set it as follows: [Oracle 8.1] Library=dbd_oci9 The.sbo file is found in the directory $INSTALLDIR/dataAccess/RDBMS/ connectionserver/oracle/oracle.sbo This section lists connection and data access issues that are specific to Teradata. Data Access Guide 45

48 4 Configuring specific data access drivers Teradata Using Run in Quiet mode to avoid query freeze up on client Queries run and then cancelled against a Teradata source can become blocked due to a Cancel query message that appears at the server end, and blocks the query until the message is cleared. To ensure that an end user does not receive a Cancel Query message when they cancel a query from a browser, you should ensure that the option Run in quiet mode is selected in the the Advanced tab of the Teradata ODBC Driver dialog box. If Run in quiet mode is not selected, then the Cancel query message appears at the Web Intelligence server end, and the query remains blocked until OK is clicked at the server end. This option is not selected by default. 46 Data Access Guide

49 Data type conversion reference chapter

50 5 Data type conversion reference Overview Overview IBM DB2 This chapter contains data conversion tables for each supported RDBMS. Business Objects supports four datatypes: date character number long text Data conversion tables are available for the following RDBMS: IBM DB2 Informix Microsoft SQL Server Oracle Red Brick Sybase Teradata The following table lists the IBM DB2 internal datatypes and their equivalent in Business Objects products: IBM/DB2 datatype CLOB CHARACTER DATE DECIMAL DOUBLE FLOAT INTEGER LONG VARCHAR NUMERIC SMALLINT TIME BusinessObjects datatype LONG TEXT CHARACTER DATE NUMBER NUMBER NUMBER NUMBER LONG TEXT NUMBER NUMBER DATE 48 Data Access Guide

51 Data type conversion reference Informix 5 IBM/DB2 datatype TIMESTAMP VARCHAR BusinessObjects datatype DATE CHARACTER Informix The following table lists the Informix internal datatypes and the equivalent in Business Objects products: Informix datatype CHAR DATE DATETIME DECIMAL FLOAT INTEGER MONEY NCHAR NVARCHAR SERIAL SMALLINT SMALLFLOAT TEXT VARCHAR BusinessObjects datatype CHARACTER DATE DATE NUMBER NUMBER NUMBER NUMBER CHARACTER CHARACTER NUMBER NUMBER NUMBER LONG TEXT CHARACTER Microsoft SQL Server The following table lists the Microsoft SQL Server internal datatypes and their BusinessObjects equivalent Microsoft SQL Server datatype BIT BOOLEAN CHAR DATETIME BusinessObjects datatype NUMBER NUMBER CHARACTER DATE Data Access Guide 49

52 5 Data type conversion reference Oracle Microsoft SQL Server datatype DECIMAL FLOAT INT MONEY NUMERIC REAL SMALLDATETIME SMALLINT SMALLMONEY TEXT TINYINT VARCHAR BusinessObjects datatype NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER CHARACTER NUMBER CHARACTER Oracle The following table lists the Oracle internal datatypes and their equivalent in Business Objects products: Oracle datatype CHAR CHARACTER CLOB LONG TEXT DATE DATE FLOAT NUMBER INTEGER NUMBER LONG LONG TEXT NUMBER NUMBER VARCHAR CHARACTER VARCHAR2 CHARACTER BusinessObjects datatype * indicates Oracle 9i datatype 50 Data Access Guide

53 Data type conversion reference Red Brick 5 Red Brick The following table lists the Red Brick internal datatypes and their BusinessObjects equivalent Red Brick datatype CHAR DATE DECIMAL FLOAT INTEGER NUMERIC SMALLINT TIME TIMESTAMP BusinessObjects datatype CHARACTER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE DATE TIME and TIMESTAMP support in a WHERE clause Objects that use the TIME and TIMESTAMP datatype are not supported in a WHERE clause for queries run against a Red Brick database. You can set the properties of an object in a universe to support the use of TIME and TIMESTAMP in the WHERE clause as follows: To support TIME or TIMESTAMP datatype object in WHERE clause: 1. From Designer, double-click an object in the Universe pane. The Edit Properties of Object dialog box appears. 2. Click the Definition tab. 3. Select Date from the Type drop down list. 4. Click the Advanced tab. 5. In the Database Format textbox type the following For... TIME support TIMESTAMP support Type HH:MM:SS MM/DD/YYYY HH:MM:SS 6. Click OK. Data Access Guide 51

54 5 Data type conversion reference Sybase Sybase The following table lists the Sybase internal datatypes and their equivalent in Business Objects products Sybase datatype BIT CHAR DATETIME DECIMAL FLOAT INT MONEY NUMERIC REAL SMALLDATETIME SMALLINT SMALLMONEY TINYINT VARCHAR BusinessObjects datatype NUMBER CHARACTER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER CHARACTER Teradata The following table lists the Teradata internal datatypes and their equivalent in Business Objects products: Teradata datatype DATE DECIMAL FLOAT INTEGER SMALLINT BYTEINT BusinessObjects datatype DATE NUMBER NUMBER NUMBER NUMBER NUMBER 52 Data Access Guide

55 Data type conversion reference Teradata 5 Teradata datatype DATETIME VARCHAR BusinessObjects datatype DATE CHARACTER Data Access Guide 53

56 5 Data type conversion reference Teradata 54 Data Access Guide

57 Setting universe dynamic SQL parameters chapter

58 6 Setting universe dynamic SQL parameters Overview Overview This chapter provides an alphabetical reference for the SQL generation parameters listed in the Parameter page of the Universe Parameters dialog box in Designer. These are SQL parameters that are common to most data access drivers. Each parameter is valid for the universe in which it is set. Other RDBMS specific and connection parameters are listed in the data access parameter (PRM) file for the target data access driver. Refer to the section Setting dynamic SQL parameters in a universe on page 36 for information on how to set the dynamic SQL parameters in Designer. Other RDBMS specific SQL parameters are described in the chapter Setting universe dynamic SQL parameters on page 55. Dynamic SQL parameters in a universe ANSI92 Parameters used for SQL generation can be set for a universe. In previous versions of Business Objects products, all SQL parameters were set in the <RDBMS>.PRM file. This file was a static text file that applied to all universes using the data access driver. The PRM file is still used for many RDBMS specific SQL and connection parameters, however, SQL parameters common across RDBMS are now modified within an individual universe. These parameters apply only to the current universe, so universes using the same data access driver, can have different SQL generation behavior. These dynamic SQL parameters are saved in the.unv file, and are accessible only from the universe. This section lists and describes the dynamic SQL generation parameters available to universes. Refer to the section Setting dynamic SQL parameters in a universe in the Managing Connections chapter for information on accessing and modifying these parameters. This parameter reference is also available in the Designer s Guide. ANSI92 = Yes No Yes No 56 Data Access Guide

59 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 6 No Specifies whether the SQL generated complies to the ANSI92 standard. Yes: Enables the SQL generation compliant to ANSI92 standard. No: SQL generation behaves according to the PRM parameter OUTER_JOIN_GENERATION. AUTO_UPDATE_QUERY AUTO_UPDATE_QUERY = Yes No Yes No Yes Determines what happens when an object in a query is not available to a user profile. Yes: Query is updated and the object is removed from the query. No: Object is kept in the query. BLOB_COMPARISON BLOB_COMPARISON = Yes No Can be edited? Yes No No No Species if a query can be generated with a DISTINCT statement when a BLOB file is used in the SELECT statement. It is related to the setting "No Duplicate Row" in the query properties. Yes: The DISTINCT statement can be used within the query. No: The DISTINCT statement cannot be used within the query even if the query setting "No Duplicate Row" is on. Data Access Guide 57

60 6 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe BOUNDARY_WEIGHT_TABLE COLUMNS_SORT BOUNDARY_WEIGHT_TABLE = Integer 32bits [0-9] Integer 32bits [0-9] -1 Allows you to optimize the FROM clause when tables have many rows. If the table size is greater than the entered value, the table is declared as a subquery: FROM (SELECT col1, col2,..., coln FROM Table_Name WHERE simple condition). A simple condition is defined as not having a subquery, and not having EXCEPT or BOTH operators. Limitations COLUMNS_SORT=Yes No Optimization is not implemented when: the operator OR is in the query condition only one table is involved in the SQL the query contains an outer join no condition is defined on the table that is being optimized the table being optimized is a derived table. YES Columns are displayed in alphabetical order NO Columns are displayed in the order they were retrieved from the database No Determines the order that columns are displayed in tables in the Structure pane. 58 Data Access Guide

61 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 6 COMBINE_WITHOUT_PARENTHESIS COMBINE_WITHOUT_PARENTHESIS=No YES Removes the parentheses. NO Leaves the parentheses. No Specifies whether or not to encapsulate a query with parentheses when it contains UNION, INTERSECT or MINUS operators. Used with RedBrick. COMBINED_WITH_SYNCHRO COMBINED_WITH_SYNCHRO = Y N Yes No No Specifies whether to allow a query to execute that contains UNION, INTERSECTION, or EXCEPT operators, and whose objects in each subquery are incompatible. Yes: Specifies that you do allow a query to execute that contains UNION, INTERSECTION and EXCEPT operators, and whose objects in each subquery are incompatible. This type of query generates synchronization (two blocks in the report). No: Specifies that you do not allow a query to execute that contains UNION, INTERSECTION and EXCEPT operators, and whose objects in each subquery are incompatible. When the query is executed the following error message is displayed: This query is too complex. One of the subqueries contains incompatible objects. This is the default value. CORE_ORDER_PRIORITY CORE_ORDER_PRIORITY = Yes No Yes No Data Access Guide 59

62 6 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe Yes Specifies in which order you want classes and objects to be organized once two or more universes are linked in Designer. Yes: Specifies that classes and objects follow the order defined in the kernel universe. No: Specifies that classes and objects follow the order defined in the derived universe. This is the default value. CORRECT_AGGREGATED_CONDITIONS_IF_DRI LL CORRECT_AGGREGATED_CONDITIONS_IF_DRILL = Yes No Yes No No Specifies whether BusinessObjects can aggregate measures in queries and conditions. Yes: BusinessObjects can aggregate measures separately in the main query and the condition, if the query is drill enabled. No: BusinessObjects cannot aggregate measures separately in the main query and the condition, if the query is drill enabled. CUMULATIVE_OBJECT_WHERE CUMULATIVE_OBJECT_WHERE = Y N Yes No 60 Data Access Guide

63 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 6 No Specifies the order of WHERE clauses that have the AND connective. Yes: Specifies that WHERE clauses that have the AND connective are set at the end of the condition. No: Specifies that WHERE clauses follow standard SQL syntax. Example: If the condition is find all French clients different from John or American cities different from New York, the SQL is then: WHERE (customer.first_name <> John ) OR (city.city <> New York ) AND customer_country.country = France AND city_country.country = USA DECIMAL_COMMA DECIMAL_COMMA = Yes No Yes No Yes Specifies that Business Objects products insert a comma as a decimal separator when necessary. Yes: Business Objects products insert a comma as a decimal separator when necessary. No: Business Objects products do not insert a comma as a decimal separator. This is the default value. DISTINCT_VALUES_ DISTINCT_VALUES = GROUPBY DISTINCT GROUPBY DISTINCT Data Access Guide 61

64 6 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe DISTINCT Specifies whether SQL is generated with a DISTINCT or GROUPBY clause in a list of values and query panel when the option Do not retrieve duplicate rows is active. DISTINCT: The SQL is generated with a DISTINCT clause, for example; SELECT DISTINCT cust_name FROM Customers GROUPBY: The SQL is generated with a GROUP BY clause, for example; SELECT cust_name FROM Customers GROUPBY cust_name END_SQL END_SQL = String String <empty string> The statement specified in this parameter is added at the end of each SQL statement. EVAL_WITHOUT_PARENTHESIS EVAL_WITHOUT_PARENTHESIS = Yes No Yes No 62 Data Access Guide

65 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 6 No By default, the is replaced by the Select statement for the object <Class\object> enclosed within brackets. For example, when combining objet1) *@select(objet2). If the SQL(objet1) = A-B and SQL(objet2) =C, then the operation is ( A-B ) * ( C ). You avoid the default adding of brackets by setting EVAL_WITHOUT_PARENTHESIS = Yes. The operation is then A - B * C. Yes: Brackets are removed from the Select statement for a No: Brackets are added around the Select statement for the FILTER_IN_FROM FILTER_IN_FROM = Yes No Yes No No Determines if query conditions are included in the FROM Clause. This setting is only applicable if the other universe parameter setting ANSI92 is set to Yes. Yes: When editing an outer join, the default behavior property selected in the drop down list box of the Advanced Join properties dialog box in Designer, is set to "All objects in FROM". No: When editing an outer join, the default behavior property selected in the drop down list box of the Advanced Join properties dialog box in Designer is set to "No object in FROM". Data Access Guide 63

66 6 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe FIRST_LOCAL_CLASS_PRIORITY FIRST_LOCAL_CLASS_PRIORITY = Yes No Yes No No Only taken into account when CORE_ORDER_PRIORITY=Yes. Yes: Classes in derived universe are placed first. No: Objects and sub classes from derived universe appear after those of the core universe. FORCE_SORTED_LOV FORCE_SORTED_LOV = Yes No Yes No No Retrieves a list of values that is sorted. Yes: Specifies that the list of values is sorted. No: Specifies that the list of values is not sorted. MAX_INLIST_VALUES MAX_INLIST_VALUES = 99] Integer: min 0, max Allows you to increase to 256 the number of values you may enter in a condition when you use the IN LIST operator. 99: Specifies that you may enter up to 99 values when you create a condition using the IN LIST operator. This is the default value. 256: Specifies that you may enter up to 256 values when you create a condition using the IN LIST operator. 256 is the maximum authorized value you may enter. 64 Data Access Guide

67 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 6 PATH_FINDER_OFF Parameter is not listed by default. You must add the parameter manually to the lust and set a value. See Setting dynamic SQL parameters in a universe for information on editing parameters. PATH_FINDER_OFF= Y N Y N No default. You must manually enter the parameter. Used for HPIW because the join generation is done by the database. Y: Joins are NOT generated in the query. N: Joins are generated in the query. This is the default behaviour. REPLACE_COMMA_BY_CONCAT REPLACE_COMMA_BY_SEPARATOR= Yes No Yes No Yes In previous versions of Designer, a comma could be used to separate multiple fields in an object Select statement. The comma was treated as a concatenation operator. For universes that already use the comma in this way you can set REPLACE_COMMA_BY_SEPARATOR to No to keep this behavior. In the current version of Designer, this parameter is set to Yes by default, so that a expressions using a comma in this way are automatically changed to use concatenation syntax. Yes: Comma is replaced by the concatenation expression when multi field object is found. No: Keep the comma as it is. Data Access Guide 65

68 6 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe SHORTCUT_BEHAVIOR SHORTCUT_BEHAVIOUR = Global Successive Global Successive Successive Specifies how shortcut joins are applied. This parameter was formerly listed as GLOBAL_SHORTCUTS in the PRM files. The values have been changed to Global for Yes, and Successive for No. Global: Specifies that a shortcut joins are considered one by one. A shortcut join is applied only if it really bypasses one or more tables, and if it does not remove a table from the join path used by a following shortcut join. This is the default value. Successive: Specifies that all shortcut joins are applied. Note: If it generates a Cartesian product, no shortcut joins are applied. THOROUGH_PARSE THOROUGH_PARSE = Yes No Yes No No Specifies the methodology used for default Parsing in the Query panel and individual object parsing. Yes: PREPARE, DESCRIBE, and EXECUTE statements are used to parse SQL for objects. Prepare+DescribeCol+Execute No: PREPARE and DESCRIBE statements are used to parse SQL for objects. UNICODE_STRINGS UNICODE_STRINGS = Yes No Yes No 66 Data Access Guide

69 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 6 No Specifies whether the current universe can manipulate Unicode strings or not. Only applies to Microsoft SQL Server and Oracle 9. If the database character set in the SBO file is set as Unicode, then it is necessary to modify the SQL generation to handle specific Unicode column types like NCHAR and NVARCHAR. Yes: Conditions based on strings are formatted in the SQL according to the value for a parameter UNICODE_PATTERN in the PRM file, for example for MS SQL Server (sqlsrv.prm): UNICODE_PATTERN=N$ The condition Customer_name='Arai ' becomes Customer_name=N'Arai'. No: All conditions based on strings are formatted in the standard SQL. For example the condition Customer_name='Arai ' remains Customer_name='Arai' Data Access Guide 67

70 6 Setting universe dynamic SQL parameters Dynamic SQL parameters in a universe 68 Data Access Guide

71 Setting data access SQL parameters (PRM) chapter

72 7 Setting data access SQL parameters (PRM) Overview Overview This chapter provides an alphabetical reference for all SQL configuration parameters listed in <driver>.prm files. There is a <driver>.prm file for each supported RDBMS. This reference describes the SQL parameters in the Configuration section. These are the parameters you use to optimize your connection. They are described here with information on how to use these parameters to optimize your data access. You can see the date operators, other operators, and functions available for your data access driver by opening the <driver>.prm file in an XML editor. Note: Certain parameters can be set in the Parameter page of the Universe Parameters dialog box in Designer (File > Parameters > Parameter). If you modify a parameter in Designer, the new value over rides any modification that you have made to the parameter value in the PRM file. The changes made in Designer apply only to the universe they are saved in, and the value in the PRM remains unchanged. See the Designer s Guide for more information. Data access driver SQL parameters Each data access driver is associated with a SQL parameters file (<driver>.prm). A data access SQL parameters file is a XML file that contains default SQL parameters used for query generation, date and other operators, and functions. <driver>.prm files are found in the directory \\<INSTALLDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\. The following <driver>.prm files are available: Data access driver PRM files PRM Help text files (English) IBM DB2 db2udb.prm db2mvs.prm db2iseries.prm db2udben.prm db2mvsen.prm db2iseriesen.prm Informix informix.prm informixen.prm Microsoft SQL Server sqlsrv.prm sqlsrven.prm 70 Data Access Guide

73 Setting data access SQL parameters (PRM) Data access driver SQL parameters 7 Data access driver PRM files PRM Help text files (English) ODBC The <driver>.prm files are in XML format. You should use a XML editor to view and modify values in these files if necessary. Parameter file structure odbc.prm access.prm odbcen.prm accessen.prm Oracle oracle.prm oracleen.prm Red Brick redbrick.prm redbricken.prm Sybase asiq.prm sybase11.prm sybase.prm asiqen.prm sybase11en.prm sybaseen.prm Teradata teradata.prm teradataen.prm There is a <driver>.prm file for each supported RDBMS middleware. Each <driver>.prm file is divided into the following sections. Each section contains parameters that have default values set.: File section Configuration DateOperations SQL parameters used to create and optimize a universe, for example, COMMA, OUTERJOINS_GENERATION, REVERSE_TABLE_WEIGHT. These parameters are not directly available to any Business Objects product. They are described in this chapter. Date operators available to Designer, BusinessObjects, and WebIntelligence, for example YEAR, QUARTER, MONTH. Data Access Guide 71

74 7 Setting data access SQL parameters (PRM) Data access driver SQL parameters File section Operators Functions Operators available to Designer, BusinessObjects, and WebIntelligence, for example ADD, SUBSTRACT, MULTIPLY. Functions available to Designer, BusinessObjects, and WebIntelligence, for example Average, Sum, Variance. Help text that appears when functions in this section are selected in Designer, BusinessObjects, and WebIntelligence is listed in the file <driver><language>.prm, for example, oracleen.prm. This file is found in the same directory as the <driver>.prm file. You can open it to view descriptions of all the functions available in the <driver>.prm file. Viewing and editing function Help text is described in the section Viewing and editing function help text on page 73. The Function section has the following subsections: Group: ID: Name of the function. This is the name that appears in the function list in Designer. InMacro: Specifies if the function appears in the function list in an object s Edit Select box in Designer. When value is True, the function is listed, when value is False, the function is not listed. If you set the value to True, it will be listed the next time Designer is started. Type: Function data type. Arguments: Arguments accepted by the function. SQL: The SQL syntax for the function. Note: Only the Configuration section is documented here. These parameters can be edited to optimize queries run against universes using the target data access driver. Viewing and editing PRM file parameters You can view, edit, and add parameters to a PRM file as follows: 1. Browse to the directory that stores the PRM file for your target data access driver. PRM files are stored here: <INSTALDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\<driver>. prm 2. Open a <driver>.prm file in a XML editor. 3. Expand sections as required. 4. Set values by entering the value in the appropriate tag. 72 Data Access Guide

75 Setting data access SQL parameters (PRM) Data access driver SQL parameters 7 5. Save and close the file. Viewing and editing function help text The Help text that appears under each function when selected in Designer is maintained in a separate XML file. In previous versions of Business Objects products this text was maintained in the same file as the PRM parameters. You can edit and add text to describe a function by editing the file <driver>.<language>.prm. There is a Help text file for each language version of Business Objects products installed. The Help text appears as shown below when a function that is stored in the PRM file is selected in Designer: function selected Help text appears here When you add a function to the PRM file, you need to add the Help text for the new function to the appropriate <driver>.<language>.prm file, for example, if you add a function to the oracle.prm file, then you also add the function name and the Help text for the function to the oracleen.prm file, of you are working with the English version of Designer. Editing Help text for a PRM file function You can view, edit, and add Help text for a function listed in a PRM file as follows: Data Access Guide 73

76 7 Setting data access SQL parameters (PRM) PRM file Configuration reference 1. Browse to the directory that stores the PRM language file for your target data access driver. PRM language files are stored here: $INSTALLDIR\dataAccess\RDBMS\connectionServer\<rdbms>\<driver> <language>.prm For example, oracleen.prm. 2. Open a <driver><language>.prm file in a XML editor. 3. Expand the Messages section. 4. To add Help for a new function do the following: Add a new section for a function. The easiest way to do this is to copy an existing function entry and copy it into the Function section. You then edit the new function text. Enter Help text for the function. 5. To view or edit existing function Help text, do the following: Expand the Function section. Expand the Message section for a function. Edit Help text as required. 6. Save and close the file. PRM file Configuration reference The Configuration SQL parameters are listed alphabetically. To view functions, date operators, and other operators available, open a <driver>.prm file in a XML editor, each parameter is defined in the following tag: <Parameter Name="parameter ">value</parameter> where parameter is the name of the parameter, and value is the value attributed to the parameter. Each parameter is shown with the following information: Example of how the parameter appears in the XML file of the parameter Possible values that can be set for the parameter value for the parameter Note: 74 Data Access Guide

77 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 Certain configuration parameters must not be edited. These parameters have values set for use internally within a Business Objects product. These parameters are described in this section but contain a warning not to edit the value. You must not edit these parameters. Before editing any other PRM file parameter, you should make a backup copy of the PRM file. BACK_QUOTE_SUPPORTED <Parameter Name="BACK_QUOTE_SUPPORTED">Y</Parameter> Result Specifies whether or not to enclose table or column names containing spaces or special characters with backquotes. Y: Encloses table and column name with backquotes. N: Does not insert backquotes around table and column names. Y Table name=`my Table` CASE_SENSITIVE <Parameter Name="CASE_SENSITIVE">N</Parameter> Specifies if the database is case sensitive. Parameter used with Oracle. Y: Specifies that the database is case sensitive. N: Specifies that the database is not case sensitive. N CHECK_OWNER_STATE <Parameter Name="CHECK_OWNER_STATE">N</Parameter> Specifies whether or not there is a check if the database supports table classification by owner name. Data Access Guide 75

78 7 Setting data access SQL parameters (PRM) PRM file Configuration reference Y: Checks if the database supports table classification by owner name. N: Does not check if the database supports table classification by owner name. Y CHECK_QUALIFIER_STATE <Parameter Name="CHECK_QUALIFIER_STATE">N</Parameter> Specifies whether or not there is a check if the database supports table classification by qualifier. Y: Checks if the database supports table classification by qualifier. N: Does not check if the database supports table classification by qualifier. Y COMMA <Parameter Name="COMMA"> ' ' </Parameter> Result Specifies what database concatenation operator should be used to replaces a comma for objects that have the following syntax: Tab.Col1, Tab.Col2. Parameter is used with all data access drivers. ' ' +' '+ ' ' Tab.Col1 ' ' Tab.Col2 76 Data Access Guide

79 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 CONCAT <Parameter Name="CONCAT"> </Parameter> Specifies the concatenation operator. Parameter is used with all data access drivers. + DATABASE_DATE_FORMAT <Parameter Name="DATABASE_DATE_FORMAT">DD-MM-YYYY HH24:MI:SS</Parameter> Specifies the default date and hour formats stored on the server. 'DD-MM-YYYY HH24:MI:SS' See values above. DATATYPE_BLOB Name="Datatype_Blob">LONGVARCHAR</Parameter> Do not edit this parameter. Column database datatype for Blob object. This parameter is not implemented for this release. RDBMS specific. Oracle default is LONGVARCHAR DATATYPE_DOUBLE <Parameter Name="Datatype_Dtm">DATE</Parameter> Do not edit this parameter. Column database datatype for Date object (CREATE table command) RDBMS specific. Oracle default is DATE Data Access Guide 77

80 7 Setting data access SQL parameters (PRM) PRM file Configuration reference DATATYPE_DTM <Parameter Name="Datatype_Dtm">DATE</Parameter> Do not edit this parameter. Column database datatype for Date object (CREATE table command) RDBMS specific. Oracle default is DATE DATATYPE_INT <Parameter Name="Datatype_Int">NUMBER</Parameter> Do not edit this parameter. Column database datatype for Numeric object (CREATE table command) RDBMS specific. Oracle default is NUMBER DATATYPE_NULL <Parameter Name="Datatype_Null"/> Do not edit this parameter. Database SQL syntax for Null values (INSERT command) RDBMS specific. Oracle default is no value. DATATYPE_STRING <Parameter Name="Datatype_String">VARCHAR2</Parameter> Do not edit this parameter. Column database datatype for Character and Long object (CREATE table command). VARCHAR2 78 Data Access Guide

81 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 DATE_WITHOUT_QUOTE <Parameter Name="DATE_WITHOUT_QUOTE">Y</Parameter> Specifies support for dates without single-quotes in the SQL syntax. Parameter is used with MS Access. Y: Dates are not surrounded by single-quotes. N: Dates are surrounded by single-quotes. Y EXT_JOIN <Parameter Name="EXT_JOIN">YES</Parameter> Specifies whether or not outer joins are supported. Parameter is used by all data access drivers. YES: Specifies that the database supports outer joins. NO: Specifies that the database does not support outer joins. The Outer join check boxes in the Edit Join dialog box of Designer are dimmed. YES EXT_JOIN_INVERT <Parameter Name="EXT_JOIN_INVERT">YES</Parameter> Specifies how to display an outer join symbol in a join expression. Parameter is used with IBM DB2, Informix, Oracle, and Teradata. YES: When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears reversed in position in a join expression. NO: When you click an Outer join check box in the Edit Join dialog box of Designer, the outer join symbol appears on the same side on which you created the outer join. YES Data Access Guide 79

82 7 Setting data access SQL parameters (PRM) PRM file Configuration reference EXTERN_SORT_EXCLUDE_DISTINCT <Parameter Name="EXTERN_SORT_EXCLUDE_DISTINCT">Y</Parameter> Specifies whether or not to generate a SELECT DISTINCT when a query contains an ORDER BY. Parameter is used with Oracle. Y: Specifies that a SELECT DISTINCT is not generated as the query contains an ORDER BY. N: Specifies that a DISTINCT is generated even though the query contains an ORDER BY. Y GROUPBY_EXCLUDE_COMPLEX Parameter Name="GROUPBY_EXCLUDE_COMPLEX">N</Parameter> Specifies whether the database allows you to enter formulas, aliases or indexes in GROUP BY clauses. Parameter is used with IBM DB2. Y: Specifies that the database does not allow you to enter formulas, aliases or indexes in GROUP BY clauses. If you run a query containing measure objects and complex objects (e.g. with the substring function or the concatenation operator), your Business Objects product displays the following error message: Your database does not allow you to do aggregations with the <object name> object. N: Specifies that the database does allow you to enter formulas, aliases or indexes in GROUP BY clauses. N 80 Data Access Guide

83 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 GROUPBY_WITH_ALIAS <Parameter Name="GROUPBY_WITH_ALIAS">Y</Parameter> Specifies whether the database can create a GROUP BY clause in the SELECT statement. Parameter is used with Red Brick. Y: Allows you to create a GROUP BY clause in the SELECT statement. This is possible using an internal alias which references a concatenated T1.col+T2.col+...+Tn.col statement. N: Does not let you to create a GROUP BY clause in the SELECT statement. Y GROUPBY_WITHOUT_CONSTANT <Parameter Name="GROUPBY_WITHOUT_CONSTANT">Y</Parameter> Specifies whether or not you authorize the addition of objects whose SQL definition is a constant in a GROUP BY clause. Parameter is used by IBM DB2 and Microsoft SQL Server Y: Specifies that you can add any constant object to the query but it will not be present in the GROUP BY clause. N: Specifies that you can insert all the objects of a query (i.e. without aggregate functions) in a GROUP BY clause. Y GROUPBYCOL <Parameter Name="GROUPBYCOL">NO</Parameter> Specifies whether a GROUP BY clause accepts integers for column names. YES: Specifies that a GROUP BY clause followed by an integer is supported by the database. NO: Specifies that a GROUP BY clause followed by an integer is not supported by the database. NO Data Access Guide 81

84 7 Setting data access SQL parameters (PRM) PRM file Configuration reference INTERSECT <Parameter Name="INTERSECT">INTERSECT</Parameter>t Specifies if the database supports the INTERSECT set operator. INTERSECT: The database supports the INTERSECT set operator. no value: The database does not support the INTERSECT set operator. In such a case, two queries are generated. INTERSECT KEY_INFO_SUPPORTED <Parameter Name="KEY_INFO_SUPPORTED">Y</Parameter> Specifies if you can retrieve primary and secondary key definitions from the database account. Y: Specifies that the database lets you retrieve primary and secondary key definitions from the database account. This parameter enables Designer to display the keys in the Structure window. N: Specifies that the database does not let you retrieve primary and secondary key definitions from the database account. Y LEFT_OUTER <Parameter Name="LEFT_OUTER">$(+)</Parameter> <Parameter Name="LEFT_OUTER">$*</Parameter> Specifies the left outer join syntax. $(+) This syntax is used with Oracle. $ represents a join expression. $* This syntax is used with Sybase, MS SQL Server and Red Brick. $ represents a join expression. See values above. 82 Data Access Guide

85 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 LENMAXFORCOLUMNNAME <Parameter Name="LenMaxForColumnName">30</Parameter> LENMAXFORTABLENAME <Parameter Name="LenMaxForTableName">30</Parameter> LENMAXFORVARCHAR MINUS Do not edit this parameter. Maximum length for column name (by default the object name is proposed) (CREATE table command) RDBMS specific. Oracle default is 30 Do not edit this parameter. Maximum length for VARCHAR column datatype (CREATE table command). RDBMS specific. Oracle default is 254 <Parameter Name="LenMaxForVarchar">254</Parameter> Do not edit this parameter. Maximum length for VARCHAR column datatype (CREATE table command). RDBMS specific. Oracle default is 254 <Parameter Name="MINUS">MINUS</Parameter> Specifies if the database supports the MINUS set operator. MINUS Specifies that the database supports the MINUS set operator. EXCEPT Specifies that the database supports the MINUS set operator. no value Specifies that the database does not support the MINUS set operator. In such a case, two queries are generated. MINUS Data Access Guide 83

86 7 Setting data access SQL parameters (PRM) PRM file Configuration reference NO_DISTINCT <Parameter Name="NO_DISTINCT">Y</Parameter> Specifies if the database supports the DISTINCT keyword. Parameter is used with MS Access. Y: Specifies that the database does not support the DISTINCT keyword. This behavior disables: The Distinct option that appears when you click the View button in the Quick Design wizard The Countdistinct function that appears when you create a condition with the Calculation operand in the Query Panel N: Specifies that the database does support the DISTINCT keyword. Y OLAP_CLAUSE <Parameter Name="OLAP_CLAUSE">WHEN</Parameter> Specifies whether Business Objects products generate a WHEN or QUALIFY clause if a function listed in the RISQL_Functions parameter is used in a condition. This parameter must be used with the GROUPBY clause. WHEN: Generates a WHEN clause if a function listed in the RISQL_Functions parameter is used in a condition. This is the default value for Red Brick databases. QUALIFY: Generates a QUALIFY clause if a function listed in the RISQL_Functions parameter is used in a condition. This is the default value for Teradata databases. See values above. OUTERJOINS_GENERATION This parameter is only used for compatibility with previous versions of Designer. the ability to create outer joins that conform to the ANSI 92 standard can be set at the universe level by setting the universe parameter ANSI92 to Yes. See the section ANSI92 on page 56 for more information. 84 Data Access Guide

87 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 <Parameter Name="OUTERJOINS_GENERATION">USUAL</Parameter> Specifies the SQL syntax for outer joins. The value ANSI 92 generates an outer join in the FROM clause. Other values generate the outer join in the WHERE clause. When you modify this setting, you should check join properties to verify that the outer join expression is valid, and that the cardinalities are correct. MS SQL Server database engine, the sqlsrv.prm file uses standard outer join generation (in WHERE clause). To use ANSI 92 outer join generation with MS SQL Server, modify the sqlsrv.prm file as follows: EXT_JOIN_INVERT=YES MODIFY: LEFT_OUTER= RIGHT_OUTER= OUTERJOINS_GENERATION=ANSI_92 USUAL: value with Oracle, Sybase 11, and Red Brick. DB2: value for IBM DB2. ODBC: value for ODBC. FULL_ODBC: Can be used with MS SQL Server INFORMIX value for Informix. NO: Outer joins are not supported. ANSI_92: Generates the ANSI92 syntax. value for Sybase. See values above Results of values applied for OUTERJOINS parameters above Value = USUAL FROM T1, T2 WHERE T1.col1(+) = T2.col2 DB2: FROM T2 LEFT OUTER JOIN T1 ON T1.col1 = T2.col2 ODBC: FROM {oj T1 LEFT OUTER JOIN T2 ON T1.col1=T2.col2} INFORMIX: FROM T2 OUTER T1 WHERE T1.col1=T2.col2 FULL_ODBC: FROM {oj T1 RIGHT OUTER JOIN T2 ON T2.col2=T1.col1} Value = ANSI_92: SELECT DISTINCT t1.col1, t2.col2 Data Access Guide 85

88 7 Setting data access SQL parameters (PRM) PRM file Configuration reference OVER_CLAUSE FROM (t1 RIGHT OUTER JOIN t2 ON (t1.col1=t2.col2) ) <Parameter Name="OVER_CLAUSE">Y</Parameter> Allows Business Objects products to include RISQL functions when generating SQL. The supported RISQL functions for the database are listed in the RISQL_FUNCTIONS parameter. Y: BusinessObjects products can include RISQL functions when generating SQL. N: BusinessObjects products cannot include RISQL functions when generating SQL. Y OWNER <Parameter Name="OWNER">Y</Parameter> Specifies if the database authorizes to prefix tables by the owner name. Y: Specifies that the database does support prefixing tables by the owner name. N: Specifies that the database does not support prefixing tables by the owner name. Y PATH_FINDER_4x This parameter is not in any <driver>.prm file by default. To use it, you must add it as a parameter in the Configuration section. Specifies if users can choose a context if all the proposed contexts use the same joins. 86 Data Access Guide

89 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 Y: Specifies that users can choose a context even if all the proposed contexts use the same joins. N: Specifies that users cannot choose a context if all the proposed contexts use the same joins. No default value. PREFIX_SYS_TABLE <Parameter Name="PREFIX_SYS_TABLE">RBW_</Parameter> <Parameter Name="PREFIX_SYS_TABLE">MSys</Parameter> Specifies if the system tables are displayed in Designer. This parameter is found in the access.prm file and redbrick.prm file. MSys: Specifies that the MS Access system tables are hidden in the Designer table browser. value for MS Access. RBW_ :Specifies that the Red Brick system tables are hidden in the Designer table browser. value for Red Brick. no value Specifies that the database system tables are displayed in the Designer table browser. See values above. QUALIFIER <Parameter Name="QUALIFIER">N</Parameter> Specifies whether the database authorizes to prefix tables by the qualifier name Y: Specifies that the database does support prefixing tables by the qualifier name. N: Specifies that the database does not support prefixing tables by the qualifier name. RDBMS dependant. Data Access Guide 87

90 7 Setting data access SQL parameters (PRM) PRM file Configuration reference QUOTE_OWNER <Parameter Name="QUOTE_OWNER">Y</Parameter> Result Specifies whether or not an owner name should be in single quotes. Used by Informix only. Y: Specifies that table names are prefixed by an owner name in single quotes. This is mandatory for an ANSI compliant Informix database. If not, Informix converts the owner name in upper case characters. N: Specifies that table names are not prefixed by an owner name in single quotes. Y SELECT Alias.col (<Alias> is a local Alias) FROM 'Owner'.table.col Alias REFRESH_COLUMNS_TYPE <Parameter Name="REFRESH_COLUMNS_TYPE">O</Parameter> Indicates how columns are refreshed. O: Columns are refreshed by owner name. This is the default value with Oracle. Q: Columns are refreshed by qualifier name. This is the default value with Red Brick, Sybase, MS SQL Server and MS Access. T: Columns are refreshed by table name. See above. 88 Data Access Guide

91 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 REVERSE_TABLE_WEIGHT <Parameter Name="REVERSE_TABLE_WEIGHT">Y</Parameter> Specifies in which order tables should be generated. This parameter is used with Oracle. This parameter can also be used with some other databases, possibly with the Y and N reversed. This parameter is not supported for Teradata. N: Specifies that tables are generated from the largest to the smallest. Y: Specifies that tables are generated from the smallest to the largest. Y RIGHT_OUTER <Parameter Name="RIGHT_OUTER">$(+)</Parameter> <Parameter Name="RIGHT_OUTER">*$</Parameter> Specifies the right outer join syntax. $(+): Used with Oracle. $ represents a join expression. *$: Used with Sybase, MS SQL Server and Red Brick. $ represents a join expression. See values above. Data Access Guide 89

92 7 Setting data access SQL parameters (PRM) PRM file Configuration reference RISQL_FUNCTIONS <Parameter Name="RISQL_FUNCTIONS">RANK,SUM,AVG,COUNT,MIN,MAX</ Parameter> Lists the RISQL functions supported by the database. Oracle default list: RANK,SUM,AVG,COUNT,MIN,MAX,RATIO_TO_REP ORT,CUME_DIST,CORR,DENSE_RANK,FIRST_VAL UE,LAST_VALUE,LAG,LEAD,NTILE,PERCENT_RAN K,PERCENTILE_CONT,PERCENTILE_DISC,ROW_N UMBER,CORR,COVAR_POP,COVAR_SAMP,REGR_ SLOPE,REGR_INTERCEPT,REGR_COUNT,REGR_ R2,REGR_AVGX,REGR_AVGY,REGR_SXX,REGR_S YY,REGR_SXY,STDDEV,STDDEV_POP,STDDEV_S AMP,VAR_POP,VAR_SAMP,VARIANCE IBM DB2 default list: RANK,SUM,AVG,COUNT,MIN,MAX Teradata default list: CSUM,MAVG,MDIFF,MLINREG,MSUM,RANK,QUANT ILE Red Brick default list: CUME,MOVINGAVG,MOVINGSUM,RANK,RATIOTO REPORT,TERTILE. See values above. SHORTCUTS_4X This parameter is not in any <driver>.prm file by default. To use it, you must enter it in the [Parameters] section under DBParameters and Configuration in the XML file. Specifies whether shortcuts are applied according to the number of paths they resolve. N: Specifies that the shortcut join that resolves the most number of paths is applied first. O: Specifies that the shortcut joins are not applied in a set order. No default value. 90 Data Access Guide

93 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 SORT_BY_NO <Parameter Name="SORT_BY_NO">NO</Parameter> Specifies if users are authorized to sort on columns (represented as objects in the universe) that are not included in the SELECT statement. YES: Specifies that users are not authorized to sort on columns if they are not included in the SELECT statement. When the parameter is set to YES, the Manage Sorts button is dimmed in the Query Panel. NO: Specifies that you are authorized to sort on columns even if they are not included in the SELECT statement. NO TABLE_DELIMITER <Parameter Name="TABLE_DELIMITER">"</Parameter> Specifies that table or column names that contain spaces or special characters are enclosed within quotation marks if the parameter BACK_QUOTE_SUPPORTED is activated. To use this parameter, BACK_QUOTE_SUPPORTED must be set to BACK_QUOTE_SUPPORTED=Y. This is the default value. : Table or column names that contain spaces or special characters are enclosed in double quotation marks. : Table or column names that contain spaces or special characters are enclosed in single quotation marks. This value can be used only with Microsoft Access. Result Table name= My Table Data Access Guide 91

94 7 Setting data access SQL parameters (PRM) PRM file Configuration reference UNICODE_PATTERN UNION <Parameter Name="UNICODE_PATTERN">UNISTR($)</Parameter> SQL Server and Oracle only. Only applies when the universe SQL generation parameter UNICODE_STRINGS is set to Y. All conditions based on strings are then formatted with this string value. See the section UNICODE_STRINGS on page 66 for information on setting the UNICODE_STRINGS parameter See the section Activating unicode support in a universe (SQL Server and Oracle special case) on page 35 for information on unicode support in a universe. Microsoft SQL Server: N$ Oracle: UNISTR($) Example UNICODE_PATTERN=N* COL1 = N'abcd' <Parameter Name="UNION">UNION</Parameter> Specifies if the database supports the UNION set operator. UNION: The database supports the UNION set operator. no value: The database does not support the UNION set operator. In such a case, two queries are generated. UNION 92 Data Access Guide

95 Setting data access SQL parameters (PRM) PRM file Configuration reference 7 USER_INPUT_DATE_FORMAT <Parameter Name="USER_INPUT_DATE_FORMAT">'dd-MM-yyyy HH:mm:ss'</Parameter> Specifies the default date and hour formats generated in the WHERE clause of a SQL script. {\d 'yyyy-mm-dd'} This is the default date format with ODBC. 'DD-MM-YYYY HH:MM:SS' This is the default date and hour formats with Oracle. 'YYYY-MM-DD HH:MM:SS' This is the default date and hour formats with Informix. 'yyyy-mm-dd HH:mm:ss' This is the default date and hour formats with MS SQL Server and for most IBM DB2 servers. 'mm/dd/yyyy hh:m:s am/pm' This is the default date and hour formats with Sybase. 'yyyy-mm-dd' This is the default date format with a Sybase gateway. Note: f you need to use time or timestamp variables with ODBC, you must replace the default date format value with: {\t 'hh:mm:ss'} or {\t\s 'yyyy-mm-dd hh:mm:ss'} in the odbc.sbo file. See values above. USER_INPUT_NUMERIC_SEPARATOR <Parameter Name="USER_INPUT_NUMERIC_SEPARATOR">.</Parameter> Specifies the default decimal separator stored on the server. '.' '.' Data Access Guide 93

96 7 Setting data access SQL parameters (PRM) PRM file Configuration reference 94 Data Access Guide

97 Setting data access driver configuration parameters (SBO) chapter

98 8 Setting data access driver configuration parameters (SBO) Overview Overview This chapter provides a reference for all default configuration parameters in <driver>.sbo files for the supported RDBMS. It also describes how a data access driver configuration file is structured, and how you edit the SBO file to set new values for the driver parameters. Data access driver configuration parameters A data access driver confguration file (<driver>.sbo) is a file in XML format that contains default configuration parameters for a specific data access driver. There is a configuration file for each data access driver. Note: Driver defaults in SBO over-ride same driver defaults in CFG file Certain parameters that appear in the Driver s section of the cs.cfg file also appear in the Driver Configuration defaults section of the SBO file. The values in the CFG file apply to all drivers loaded by Connection Server. The value set in a <driver>.sbo file over rides that set in the CFG file. This allows you to set driver defaults that apply to an individual data access driver, while leaving a default setting to apply to other drivers. A data access configuration file (SBO) contains the following: parameters that apply to all connections using the data access driver. A list of database middleware that the driver supports. This list can also contain aliases for middleware versions that are no longer suppoprted, but which are still used by connections defined with the data access driver. Each middleware entry can have default parameters set that apply only to that database middleware. Data access configuration files (<driver>.sbo) are found in the directory \\<INSTALDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\ The following <driver>.sbo files are available Data access driver IBM DB2 Informix Microsoft SQL Server SBO file db2.sbo iseries.sbo informix.sbo odbc.sbo 96 Data Access Guide

99 Setting data access driver configuration parameters (SBO) Data access driver configuration parameters 8 Data access driver ODBC Oracle Red Brick Sybase Teradata SBO file odbc.sbo oracle.sbo odbc.sbo sybase.sbo teradata.sbo Note: The <driver>.sbo files are in XML format. You should use a XML editor to view and modify values in these files if necessary. Data Access Guide 97

100 8 Setting data access driver configuration parameters (SBO) Data access driver configuration parameters Configuration file structure There is a <driver>.sbo file for each supported RDBMS. Each <driver>.sbo file is divided into the following sections: File section s Databases configuration parameters that apply to all database middleware using the data access driver. These are listed in the section Database described below. Certain of these parameters can also be set for a specific middleware. In this case, the value set for the target middleware in the Databases section, over rides the default value set in the s section. Database middleware supported by the data access driver. Each middleware is listed with the following parameters: Active Specifies if middleware support is activated or not. are YES or NO. Name Names of the middleware supported by the data access driver. The middleware name values set here appear in the Database Middleware page of the new connection wizard. Aliases Names of older middleware versions no longer officially supported by the data access driver, but that are still used by exisiting connections. You can add an alias parameter for an older middleware using the current data access driver, and set configuration parameters specific to the middleware as parameters of the new alias. Connections can still be created and used using the alias specified. Parameters Configuration parameters with values that apply specifically to a middleware. set for parameters listed here, over ride the values set for the same parameters in the s section. Viewing and editing a SBO file You can view and edit parameters in a SBO file as follows: 98 Data Access Guide

101 Setting data access driver configuration parameters (SBO) SBO file reference 8 1. Browse to the directory that stores the SBO file for your target data access driver. SBO files are stored here: <INSTALDIR>\dataAccess\RDBMS\connectionServer\<rdbms>\ <driver>.sbo. 2. Open a <driver>.sbo file in a XML editor. 3. Expand sections as required. 4. Set values by entering the value in the appropriate tag. 5. Save and close the file. SBO file reference The SBO parameters are listed alphabetically. To view parameters available, open a <driver>.sbo file in a XML editor. In the file, each parameter is defined in the following tag: <Parameter Name="parameter ">value</parameter> where parameter is the name of the parameter, and value is the value attributed to the parameter. Each parameter is shown with the following information: Example of how the parameter appears in the XML file of the parameter Possible values that can be set for the parameter value for the parameter Parameters can be set at the s or Databases section Configuration parameters can be set in the s or Databases sections of the SBO file. If they are set for a specific middleware in the Databases section, then for the specific middleware, this value over rides the value set at the s level. Note: Certain configuration parameters must not be edited. These parameters have values set for use internally within a Business Objects product. These parameters are described in this section but contain a warning not to edit the value. You must not edit these parameters. Before editing any other SBO file parameter, you should make a backup copy of the SBO file. Data Access Guide 99

102 8 Setting data access driver configuration parameters (SBO) SBO file reference Array Bind Available <Parameter Name="Array Bind Available">True</Parameter> Specifies if the database supports this method True False True Array Bind Size <Parameter Name="Array Bind Size">5</Parameter> Specifies the number of rows exported with each INSERT command. Used with all Data Access drivers, default value set in cs.cfg n Specifies that n number of rows are exported with each INSERT. Value set in the cs.cfg file. Array Fetch Size <Parameter Name="Array Fetch Size">10</Parameter> Specifies the number of rows retrieved with each fetch. Used with all data access drivers and is available in all <driver>.sbo files. n Specifies that n number of rows are retrieved with each fetch. 1 Specifies that the array fetch is deactivated. Value set in the cs.cfg file. Array Fetch Available <Parameter Name="Array Fetch Available">True</Parameter> Specifies whether the Array Fetch is natively supported. 100 Data Access Guide

103 Setting data access driver configuration parameters (SBO) SBO file reference 8 True False Value set in the cs.cfg file. Binary Slice Size CharSet Table <Parameter Name="Binary Slice Size">32000</Parameter> Specifies the number of bytes of the slice that stores the document in OBJ_X_DOCUMENTS. This is the only table in the document domain. It stores the binary content of all documents sent to the repository. These are stored as BLOBs (Binary Large OBjects) stored in slices. n Specifies that slice size is n bytes. Oracle, Sybase: Informix: Teradata: <Parameter Name="CharSet Table">oracle</Parameter> Specifies the Charset file (.CRS) for the data access driver with no extension. This setting is specific to each.sbo file. The CRS file is in the same directory as the SBO file. oracle, db2, sybase, iseries, informix, odbc, teradata. Data Access driver dependant. See the above. DescribeParam Available <Parameter Name="DescribeParam Available">False</Parameter> Informix only. Specifies if the database supports the DescribeParam method for Stored Procedures. This parameter is set in the Parameter section of the Databases section of the SBO file. True False False. Data Access Guide 101

104 8 Setting data access driver configuration parameters (SBO) SBO file reference File Do not edit this parameter <Parameter Name=" File">oracle</Parameter> Do not edit this parameter. It specifies the name of the description file (<driver><language>.cod) with no extension. This file contains the labels of the connection dialog boxes used in the new connection wizard. The COD file is in the same directory as the SBO file. oracle, db2, sybase, iseries, informix, odbc, teradata See above. DriverLevel <Parameter Name="Driver Level">31</Parameter>l Specifies the limitations of each driver. This setting is specific to each <driver>.sbo file 1 Specifies that you can only use the driver to create and execute queries. 13 Specifies that you can use the driver to create and execute queries, and to create universe and security domains. 15 Specifies that you can use the driver to create the Business Objects repository, and to create and execute queries. 31 Specifies that you can use the driver to create the Business Objects repository, to create and execute queries, and to access stored procedures. values are data access driver specific. 102 Data Access Guide

105 Setting data access driver configuration parameters (SBO) SBO file reference 8 Empty String <Parameter Name="Empty String">EmptyString</Parameter> Specifies that certain functions, for example SQL Tables, receive an empty string or a null pointer to replace missing parameters. Used by all ODBC data access drivers. EmptyString Missing parameters are replaced by an empty string. no value Missing parameters are not replaced. EmptyString Family Do not edit this parameter <Parameter Name="Family">Sybase</Parameter> Specifies the family of database engine to be displayed in the Database Middleware Selection page of the new connection wizard. The middleware that correspond to your data access key are displayed on this page in a tree view. Oracle for Oracle IBM for IBM databases Informix for Informix Sybase for Sybase Generic for ODBC, ODBC3, and Red Brick ODBC NCR for Teradata Microsoft for Microsoft SQL Server and Access. Microsoft is set in the MS SQL Server section of the Databases section. See values above. Data Access Guide 103

106 8 Setting data access driver configuration parameters (SBO) SBO file reference Native Int64 Available <Parameter Name="Native Int64 Available">False</Parameter> Specifies the availability of native Int64 support. Parameter is available to all ODBC3 and Red Brick data access drivers. The parameter is available for a specified data access driver in the Database section of the SBO file. False Specifies that Int64 is not supported, so Connection Server can emulate Int64 methods. True Specifies that native Int64 support is available so integers are coded in 64 bits. False ODBC Cursors <Parameter Name="ODBC Cursors">No</Parameter> Specifies availibility of the cursor library by the data access driver. Applies to all ODBC drivers. This parameter is not listed by default in the SBO file. The default value is set in the cs.cfg file. You can add it to the SBO file. The value set in the SBO file over rides the value in the cs.cfg file. Do not change the default value in the CFG file. No Yes Set in the cs.cfg file. Optimize Execute <Parameter Name="Optimize Execute">False</Parameter> Specifies the optimization method for executing queries. True Specifies that SQLExecDirect is performed. False SQLPrepare+SQLExecute is performed. False 104 Data Access Guide

107 Setting data access driver configuration parameters (SBO) SBO file reference 8 Password_Encryption <Parameter Name="Password Encryption">True</Parameter> Specifies whether or not to use the encryption password mechanism of the middleware for the password entered in the connection dialog box. This parameter is used with Sybase. True Specifies that the encryption password mechanism of the middleware is used. False Specifies that the encryption password mechanism of the middleware is not used. True Provider CLSID Do not edit this parameter <Parameter Name="Provider CLSID">MSDASQL</Parameter> Specifies name of OLEDB provider. This parameter is used with OLEDB only. MSDASQL Data Access Guide 105

108 8 Setting data access driver configuration parameters (SBO) SBO file reference SQL Parameter File <Parameter Name="SQL Parameter File">oracle</Parameter> SQL Parameter File indicates the name of the file which stores database parameters. The extension of this file is.prm. You must ensure this file is located in the same directory as the data configuration file (.sbo file). db2iseries for IBM DB2 iseries db2udb for IBM DB2 informix for Informix sqlsrv for Microsoft SQL Server 2000 oracle for Oracle redbrick for Red Brick sybase for Sybase asiq for Sybase ASIQ teradata for Teradata See values above. Strategies File <Parameter Name="Strategies File">oracle</Parameter> Specifies the name with no extension of the Strategy file (.STG). This is the file that contains external strategies that are available for Designer for automatic universe creation. Strategy files are stored in the same directory as the SBO file. db2 for DB2 data access drivers. informix for Informxi oracle for Oracle sybase for Sybase teradata for Teradata See values above. 106 Data Access Guide

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

110 8 Setting data access driver configuration parameters (SBO) SBO file reference V5toV6DriverName <Parameter Name="V5toV6DriverName">{Informix BIT}</ Parameter> Specifies the conversion rule from Informix Connect to Informix ODBC. Found in Informix.sbo. The value of this parameter determines which Informix Driver is used to define the ODBC DSN less connection string.the value of this parameter must be the exact name of the Informix driver installed on the machine. {Informix BIT} This is set in the cs.cfg file. 108 Data Access Guide

111 Setting data access general configuration parameters (CFG) chapter

112 9 Setting data access general configuration parameters (CFG) Overview Overview This chapter provides a reference for all default parameters in the Settings section of the data access general configuration file cs.cfg. It also describes how the CFG file is structured, and how you can edit the file to set new values for the parameters listed. Data access general configuration file parameters A data access general confguration file (cs.cfg) is a file in XML format that contains default configuration parameters that apply to all data access drivers. Certain default parameters can be over-ridden for a specific data access driver when the same parameter is set to a different value in the data access configuraion file (<driver>.sbo). The cs.cfg file is an XML file. The DTD for the file is in the same directory. Make sure that, when modifying the XML file, the cs.dtd is accessible. The CFG file is stored here: $INSTALLDIR \dataaccess\rdbms\connectionserver General configuration file structure There are five sections in the cs.cfg XML file: Locales Settings Distribution Driver defaults Traces Each of these sections is described briefly as follows: Locales Defines the usual operating system charset for a given language. BusinessObjects recommends that you do not modify these values. Example: <Locales> <Locale> 110 Data Access Guide

113 Setting data access general configuration parameters (CFG) Data access general configuration file parameters 9 <Language>en</Language> <CharSet Platform="MSWindows">CP1252</CharSet> <CharSet Platform="Unix">ISO </CharSet> </Locale> </Locales> Settings Distribution Defines parameters that apply to all data access drivers, for example the file extensions of files used by Connection Server to manage data access. Some settings can be defined either for library version or server version of Connection Server. These parameters are described in the section Settings reference on page 113. Parameters used when Connection Server is used in a stand alone server mode. See the following guides for information on installing and using Connection Server as a stand alone server: Deploying the Business Objects System Installation and Configuration Guide This section contains the following sub sections: Protocols Lookup Protocols Contains the default values that Connection Server uses to process requests coming from CORBA clients or HTTP clients, for example; <Protocol Name="HTTP" Active="No"/> Lookup Allows you to expose the target RDBMS that corresponds to a specific ODBC network layer to Connection Server. This applies when Connection Server is using two different data access drivers, for example Microsoft SQL Server and Microsoft Access, through a common ODBC network layer. By default, Lookup is set to No, so Connection Server associates a target RDBMS to its ODBC network layer. However, if Connection Server is being used as a standalone server, and has two databases that are accessed by the same ODBC network layer, the specific target database information must be exposed to Connection Server to allow queries to be routed through ODBC to the correct data account. Data Access Guide 111

114 9 Setting data access general configuration parameters (CFG) Data access general configuration file parameters You expose the database information to Connection Server by setting the Lookup parameter to Yes. This ensures that the target database information for queries using ODBC are routed to the correct server, for example ODBC_SQLSERVER and ODBC_ACCESS. You only set Lookup to Yes when Connection Server is being used as a stand alone server, dedicated to connection activity only. Example: Lookup set to Yes to expose two RDBMS using the same ODBC network layer <LookUp Active="Yes"> <NetworkLayer Name="ODBC"> <Property Name="ODBC_SQLServer"> <DataBase Pattern="^MS SQL Server.*$"/> </Property> <Property Name="ODBC_Access"> <DataBase Pattern="^MS Access.*$"/> </Property> Driver defaults Data access driver parameters that are also found in driver specific SBO files. The values set for these parameters apply to all data access drivers, but these can be set in a <driver>.sbo file to over-ride the default value. See the chapter Setting data access driver configuration parameters (SBO) on page 95 for information in the parameters listed here. Traces You can set trace parameters that allow the recording of connection activity through Connection Server in log files. Refer to the readme for information on generating traces. Viewing and editing a cs.cfg file You can view and edit parameters in a CFG file as follows: 1. Browse to the directory that stores the cs.cfg file: $INSTALLDIR\dataAccess\RDBMS\connectionServer\cs.cfg 2. Open the cs.cfg file in a XML editor. 3. Expand sections as required. 4. Set values by entering the value in the appropriate tag. 5. Save and close the file. 112 Data Access Guide

115 Setting data access general configuration parameters (CFG) Settings reference 9 Settings reference The CFG setting parameters are listed alphabetically. To view parameters available, open the CFG file in a XML editor, and go to the Settings section, then Parameters section. In the file, each parameter is defined in the following tag: <Parameter Name="parameter ">value</parameter> where parameter is the name of the parameter, and value is the value attributed to the parameter. Each parameter is shown with the following information: Example of how the parameter appears in the XML file. When the parameter is available in library and server mode, an example of each is shown. of the parameter Possible values that can be set for the parameter (where applicable) value for the parameter Parameters can be set at the library or server level CFG settings parameters can be set at the following data access levels: Setting set at this level library server Parameters apply to a standard Connection Server installation. It is installed with other BusinessObjects desktop or server software. This is the default mode when you install a BusinessObjects product that is installed automatically with Connection Server. Parameters apply to a Connection Server stand alone server installation. It is installed alone with no other BusinessObjects desktop or server product. You select this mode in the choice of custom installation options when you install BusinessObjects 6.5. You set parameters in this mode when you are using a node for connection management only. Data Access Guide 113

116 9 Setting data access general configuration parameters (CFG) Settings reference Load Drivers On Startup Load Drivers On startup is available in library and server mode. Library <Settings> <Parameter Name="Load Drivers On Startup">No</Parameter>... <Library/> Server <Server> <Parameter Name="Load Drivers On Startup">Yes</Parameter>... </Server> Both are described below. Determines loading of driver libraries. You can set values for Load Drivers On Startup for two types of Connection Server deployments: Library: Value applies to nodes that have Connection Server installed with desktop or other server products. Server: Value applies to Connection Server stand alone server installations. For information on deploying Connection Server on a dedicated node see the Deployment guide. Yes All installed drivers are loaded during the initialization phase. No Drivers are loaded on demand. Library mode: No Server mode: Yes Enable Failed Load <Parameter Name="Enable Failed Load">Yes</Parameter> Determines the level of error incurred by a failed driver load. Yes If a driver fails to load, it is not a fatal error. No If a driver fails to load, it is a fatal error. Yes 114 Data Access Guide

117 Setting data access general configuration parameters (CFG) Settings reference 9 Config File Extension <Parameter Name="Config File Extension">sbo</Parameter> Determines the file extension for general configuration files. sbo SQL Parameter Extension <Parameter Name="SQL Parameter Extension">prm</Parameter> Determines the file extension for SQL parameter files. prm SQL External Extension <Parameter Name="SQL External Extension">rss</Parameter> Determines the file extension for external SQL files. rss Strategies Extension <Parameter Name="Strategies Extension">stg</Parameter> Determines the extension for strategy files. stg Extension <Parameter Name=" Extension">cod</Parameter> Determines the extension for the connection description files. Do not change the default value for this parameter. cod Data Access Guide 115

118 9 Setting data access general configuration parameters (CFG) Settings reference Charset List Extension <Parameter Name="CharSet List Extension">crs</Parameter> Determines the extension for character set files. crs Max Pool Time Max Pool Time is available in library and server mode. Library <Settings> <Parameter Name="Max Pool Time">-1</Parameter>... <Library/> Server <Server> <Parameter Name="Max Pool Time">60</Parameter>... </Server> <Parameter Name="Max Pool Time">-1</Parameter> Determines the maximum connection idle lifetime in the connection pool regardless of the value defined in the connection. You can set Max Pool Time for two types of Connection Server deployments: Library: Value applies to nodes that have Connection Server installed with desktop or other server products. Server: Value applies to Connection Server stand alone server installations. For information on deploying Connection Server on a dedicated node see the Deployment guide. Library mode: -1 Server: 60-1 No timeout, keep alive for the whole session. 0 Connection not managed by the pool. >0 Idle lifetime (in minutes). 116 Data Access Guide

119 Business Objects information resources appendix

120 10 Documentation and information services Documentation and information services Documentation Business Objects offers a full documentation set covering its products and their deployment. Additional support and services are also available to help maximize the return on your business intelligence investment. The following sections detail where to get Business Objects documentation and how to use the resources at Business Objects to meet your needs for technical support, education, and consulting. You can find answers to your questions on how to install, configure, deploy, and use Business Objects products from the documentation. What s in the documentation set? View or download the Business Objects Documentation Roadmap, available with the product documentation at The Documentation Roadmap references all Business Objects guides and lets you see at a glance what information is available, from where, and in what format. Where is the documentation? You can access electronic documentation at any time from the product interface, the web, or from your product CD. Documentation from the products Online help and guides in Adobe PDF format are available from the product Help menus. Where only online help is provided, the online help file contains the entire contents of the PDF version of the guide. Documentation on the web The full electronic documentation set is available to customers on the web from support website at: Documentation on the product CD Look in the docs directory of your product CD for versions of guides in Adobe PDF format. 118Data Access Guide

121 Customer support, consulting and training 10 Send us your feedback Do you have a suggestion on how we can improve our documentation? Is there something you particularly like or have found useful? Drop us a line, and we will do our best to ensure that your suggestion is included in the next release of our documentation: [email protected]. Note: If your issue concerns a Business Objects product and not the documentation, please contact our Customer Support experts. For information about Customer Support visit: support. Customer support, consulting and training A global network of Business Objects technology experts provides customer support, education, and consulting to ensure maximum business intelligence benefit to your business. How can we support you? Business Objects offers customer support plans to best suit the size and requirements of your deployment. We operate customer support centers in the following countries: USA Australia Canada United Kingdom Japan Online Customer Support The Business Objects Customer Support website contains information about Customer Support programs and services. It also has links to a wide range of technical information including knowledgebase articles, downloads, and support forums. Data Access Guide 119

122 10 Customer support, consulting and training Looking for the best deployment solution for your company? Business Objects consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in relational and multidimensional databases, in connectivities, database design tools, customized embedding technology, and more. For more information, contact your local sales office, or contact us at: Looking for training options? From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. Find more information on the Business Objects Education website: 120Data Access Guide

123 Useful addresses at a glance 10 Useful addresses at a glance Address Business Objects product information Product documentation support Business Objects Documentation mailbox [email protected] Online Customer Support support/ Business Objects Consulting Services services/consulting/ Business Objects Education Services services/training Content Information about the full range of Business Objects products. Business Objects product documentation, including the Business Objects Documentation Roadmap. Send us feedback or questions about documentation. Information on Customer Support programs, as well as links to technical articles, downloads, and online forums. Information on how Business Objects can help maximize your business intelligence investment. Information on Business Objects training options and modules. Data Access Guide 121

124 10 Useful addresses at a glance 122Data Access Guide

125 Index Symbols $INSTALLDIR use of variable in guide 4 A access Connection Server 5 New Connection wizard 15 advanced parameters connection 22 ANSI92 universe parameter 56, 65 Array Bind Available 100 Array Bind Size 100, 100 Array Fetch Available 100 Array Fetch Size 100 AUTO_UPDATE_QUERY universe parameter 57, 57 B BACK_QUOTE_SUPPORTED 75 Bca_Bursting_Size 101 BeginTranSyntax 101 Binary Slice Size 101 BLOB_COMPARISON universe parameter 57 Blob_Comparison 75 BOUNDARY_WEIGHT_TABLE universe parameter 58 Boundary_Weight_Table 75, 75 Business Objects consulting services 120, 121 support services 119 training services 120, 121 C CASE_SENSITIVE 75 Case_Sensitive 75 CFG file Charset List Extension 116 Config File Extension 115 Extension 115 Distribution parameters 110 Distribution section 111 Driver parameters 110 Driver defaults section 112 editing 112 Enable Failed Load 114 Load Drivers On Startup 114 Locales parameters 110 Locales section 110 Lookup parameters 111 Max Pool Time 116 Protocols parameters 111 Settings parameters 110 settings parameters reference 113 Settings section 111 SQL External Extension 115 SQL Parameter Extension 115 Strategies Extension 115 structure 110 Traces section 112 viewing 112 cfg file description 39 Charset List Extension CFG file 116 CharSet Table 101 CHECK_OWNER_STATE 75 CHECK_QUALIFIER_STATE 76 COLUMNS_SORT universe parameter 58 COMBINED_WITH_SYNCHRO universe parameter 59 COMBINED_WITHOUT_PARENTHESIS universe parameter 59 Data Access Guide 123

126 Index COMMA 76 CONCAT 77 Config File Extension CFG file 115 connection advanced parameters 22 create new 15 creating 14 creation pre-requisites 7 creation process overview 7 custom parameters 24 definition 6 management tools 6 parameters overview 14 personal 21 secured 21 shared 21 start creating 15 using wizard 15 utilities 6 Connection Server accessing 5 administering deployment 5 creating connections 5 definition 5 in standalone server mode 111 management tools 6 optimize data access 5 consultants, Business Objects 120 CORE_ORDER_PRIORITY universe parameter 59 CORRECT_AGGREGATED_CONDITIONS_IF_D RILL universe parameter 60 Cost Estimate Unit 79 create connection overview 7 connection pre-requisites 7 connection with wizard 14 dynamic SQl parameters 36 new connection 15 CUMULATIVE_OBJECT_WHERE universe parameter 60 Cumulative_Object_Where 79, 102 CursorForward 79 custom parameter Hint 24 custom parameters connection 24 customer support 119 D data access driver level files 10 files installed 8 global files 9 installed files 8 optimizing 5 unicode 29 data access driver definition 7 files used by 10 DATABASE_DATE_FORMAT 77 datatype IBM DB2 48 Informix 49 Oracle 50 Red Brick 51 SQL Server 49 Sybase 52 Teradata 52 DATATYPE_BLOB 77 DATATYPE_DOUBLE 77 DATATYPE_DTM 78 DATATYPE_INT 78 DATATYPE_NULL 78 DATATYPE_STRING 78 DATE_WITHOUT_QUOTE 79 Date_Without_Quote 79 DECIMAL_COMMA universe parameter 61 define new connection 15 delete SQL parameters 36 deployment Connection Server 5 Describe Param Available 101 DescribeParam Available 101 Extension 124 Data Access Guide

127 Index CFG file 115 File 102 DISTINCT_VALUES universe parameter 61 Distribution CFG file 111 documentation feedback on 119 on product CD 118 on the web 118 roadmap 118 Driver defaults CFG file 112 driveren.prm parameters Blob_Comparison 75 Boundary_Weight_Table 75, 75 Case_Sensitive 75 Cumulative_Object_Where 79, 102 Ext_Join 79 Intersect 82 Left_Outer 82 Max_Inlist_ 83 Minus 83 OLAP_Clause 84 Quote_Owner 88 Refresh_Columns_Type 88 DriverLevel 102 driver.sbo parameters Bca_Bursting_Size 101 BeginTranSyntax 101 Cost Estimate Unit 79 CursorForward 79 Date_Without_Quote 79 Lock Mode 104 LongVarcharNotSupported 104 Shared 90 Shortcuts_4x 90 dynamic SQL parameters 36 dynamic SQL setting parameters in universe 36 E edit dynamic SQL parameters 36 PRM file parameters 72 PRM function Help text 73 editing 38 editing data access files 38 education. See training Empty String 103, 103 Enable Failed Load CFG file 114 END_SQL universe parameter 62 EVAL_WITHOUT_PARENTHESIS universe parameter 62 EXT_JOIN 79 Ext_Join 79 EXT_JOIN_INVERT 79 EXTERN_SORT_EXCLUDE_DISTINCT 80 F Family 103 feedback, on documentation 119 FILTER_IN_FROM universe parameter 63, 66 FIRST_LOCAL_CLASS_PRIORITY universe parameter 64 FORCE_SORTED_LOV universe parameter 64 function editing Help text 73 G generate dynamic SQL parameters 36 global data access files 9 GROUPBY_EXCLUDE_COMPLEX 80 GROUPBY_WITH_ALIAS 81 GROUPBY_WITHOUT_CONSTANT 81 GROUPBYCOL 81 H Help text editing function Help text 73 Hints custom parameter Oracle 24 Data Access Guide 125

128 Index I IBM DB2 datatypes 48 information resources 118 Informix datatypes 49 installation files installed 8 INTERSECT 82 Intersect 82 K KEY_INFO_SUPPORTED 82 L LEFT_OUTER 82 Left_Outer 82 LENMAXFORCOLUMNNAME 83 LENMAXFORTABLENAME 83 LENMAXFORVARCHAR 83 Load Drivers On Startup CFG file 114 Locales CFG file 110 Lock Mode 104 login setting parameters 20 login parameters 20 LongVarcharNotSupported 104 Lookup CFG file 111 M Max Pool Time CFG file 116 MAX_INLIST_VALUES universe parameter 64 Max_Inlist_ 83 MINUS 83 Minus 83 N Native Int64 Available 104 new connection create 15 New Connection wizard 14 accessing 15 using 15 niverse parameter PATH_FINDER_OFF 65 NO_DISTINCT 84 O ODBC exposing database layer in server mode 111 Lookup parameters 111 ODBC Cursors 104 OLAP_CLAUSE 84 OLAP_Clause 84 Online Customer Support 119 optimize data access 5, 38 Optimize Execute 104 Oracle activate unicode support 35 datatypes 50 middleware to server configuration 44 specific data access issues 44 OUTERJOINS_GENERATION 84 OVER_CLAUSE 86 overview connection parameters 14 creating a connection 7 OWNER 86 P parameter files 38 Password_Encryption 105, 105 PATH_FINDER_4x 86 PATH_FINDER_OFF universe parameter 65 personal connection 21 PREFIX_SYS_TABLE 87 PRM file BACK_QUOTE_SUPPORTED 75 CASE_SENSITIVE Data Access Guide

129 Index CHECK_OWNER_STATE 75 CHECK_QUALIFIER_STATE 76 COMMA 76 CONCAT 77 DATABASE_DATE_FORMAT 77 DATATYPE_BLOB 77 DATATYPE_DOUBLE 77 DATATYPE_DTM 78 DATATYPE_INT 78 DATATYPE_NULL 78 DATATYPE_STRING 78 DATE_WITHOUT_QUOTE 79 edit parameters 72 EXT_JOIN 79 EXT_JOIN_INVERT 79 EXTERN_SORT_EXCLUDE_DISTINCT 80 GROUPBY_EXCLUDE_COMPLEX 80 GROUPBY_WITH_ALIAS 81 GROUPBY_WITHOUT_CONSTANT 81 GROUPBYCOL 81 INTERSECT 82 KEY_INFO_SUPPORTED 82 LEFT_OUTER 82 LENMAXFORCOLUMNNAME 83 LENMAXFORTABLENAME 83 LENMAXFORVARCHAR 83 list of files 70 MINUS 83 NO_DISTINCT 84 OLAP_CLAUSE 84 OUTERJOINS_GENERATION 84 OVER_CLAUSE 86 OWNER 86 PATH_FINDER_4x 86 PREFIX_SYS_TABLE 87 QUALIFIER 87 QUOTE_OWNER 88 reference 70 reference list 74 REFRESH_COLUMNS_TYPE 88 REVERSE_TABLE_WEIGHT 89 RIGHT_OUTER=$(+) 89 RISQL_FUNCTIONS 90 SHORTCUTS_4X 90 SORT_BY_NO 91 TABLE_DELIMITER 91 UNICODE_PATTERN 92 UNION 92 USER_INPUT_DATE_FORMAT 93 USER_INPUT_NUMERIC_SEPARATOR 93 view parameters 72 prm file description 40 PRM language file edit function Help text 73 view function Help text 73 Protocols CFG file 111 Provider CLSID 105 Q QUALIFIER 87 QUOTE_OWNER 88 Quote_Owner 88 R Red Brick datatypes 51 TIME support in WHERE 51 TIMESTAMP support in WHERE 51 REFRESH_COLUMNS_TYPE 88 Refresh_Columns_Type 88 REPLACE_COMMA_BY_CONCAT universe parameter 65, 65 resources 118 REVERSE_TABLE_WEIGHT 89 RIGHT_OUTER=$(+) 89 RISQL_FUNCTIONS 90 Run in Quiet Mode use in Teradata 46 S SBO file 100, 103 Array Bind Available 100 Array Fetch Available 100 Array Fetch Size 100 Binary Slice Size 101 CharSet Table 101 Databases parameters 98 Data Access Guide 127

130 Index s parameters 98 Describe Param Available 101 DescribeParam Available 101 File 102 DriverLevel 102 editing 98 Family 103 Native Int64 Available 104 ODBC Cursors 104 Optimize Execute 104 Password_Encryption 105, 105 Provider CLSID 105 SQL Parameter File 106 Strategies File 106 structure 98 Transaction Available 107 Unicode 107 V5toV6DriverName 108 viewing 98 sbo file description 39 secured connection 21 setting login parameters 20 Settings CFG file 111 settings CFG parameter reference 113 Shared 90 shared connection 21 SHORTCUT_BEHAVIOR universe parameter 66 SHORTCUTS_4X 90 Shortcuts_4x 90 SORT_BY_NO 91 SQL External Extension CGF file 115 SQL parameter PRM file list 74 SQL Parameter Extension CFG file 115 SQL Parameter File 106 SQL parameters setting in universe 36 SQL Server datatypes 49 start creating a connection 15 Strategies Extension CFG file 115 Strategies File 106 support customer 119 locations 119 technical 119 web site 119 Sybase datatypes 52 T TABLE_DELIMITER 91 technical support 119 Teradata activate unicode support 35 avoiding query freeze on cancel query 46 datatypes 52 specific data access issues 45 THOROUGH_PARSE universe parameter 66, 66 traces CFG file 112 training, on Business Objects products 120 Transaction Available 107 U Unicode SBO file 107 unicode activate support in universe 35 data access 28 set up data access 29 supported RDBMS 28 UNICODE_PATTERN 92 UNICODE_STRINGS universe parameter 66 UNION 92 universe 128 Data Access Guide

131 Index setting SQL parameters 36 universe parameter AUTO_UPDATE_QUERY 57 BLOB_COMPARISON 57 BOUNDARY_WEIGHT_TABLE 58 COLUMNS_SORT 58 COMBINED_WITH_SYNCHRO 59 COMBINED_WITHOUT_PARENTHESIS 59 CORE_ORDER_PRIORITY 59 CORRECT_AGGREGATED_CONDITIONS_I F_DRILL 60 CUMULATIVE_OBJECT_WHERE 60 DECIMAL_COMMA 61 DISTINCT_VALUES 61 END_SQL 62 EVAL_WITHOUT_PARENTHESIS 62 FILTER_IN_FROM 63 FIRST_LOCAL_CLASS_PRIORITY 64 FORCE_SORTED_LOV 64 MAX_INLIST_VALUES 64 REPLACE_COMMA_BY_CONCAT 65 SHORTCUT_BEHAVIOR 66 THOROUGH_PARSE 66 UNICODE_STRINGS 66 USER_INPUT_DATE_FORMAT 93 USER_INPUT_NUMERIC_SEPARATOR 93 V V5toV6DriverName 108 view PRM file parameters 72 PRM function Help text 73 W web customer support 119 getting documentation via 118 useful addresses 121 web sites support 119 training 120 Data Access Guide 129

132 Index 130 Data Access Guide