You are on page 1of 112

Data Federator Installation Guide SAP BusinessObjects Data Federator XI 3.

0 Service Pack 3

2010-11-19

Copyright

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

Contents

Chapter 1

Installing Data Federator.........................................................................................................7 Overview..................................................................................................................................7 Installation requirements..........................................................................................................7 Hardware Requirements...........................................................................................................8 Software Requirements............................................................................................................8 Differences between 32- and 64-bit architectures....................................................................9 Before You Install Data Federator..........................................................................................10 Components installed by the Data Federator installer and the Data Federator driver installer..10 Starting the Data Federator installer.......................................................................................11 Starting the Data Federator installer in graphical mode...........................................................11 Starting the Data Federator installer in console mode............................................................12 What happens during installation............................................................................................13 Description of install sets in the Data Federator installer........................................................15 Starting the Data Federator installer in silent mode................................................................16 Creating a configuration file for silent mode installation..........................................................18 Starting the Data Federator Drivers installer..........................................................................18 Starting the Data Federator Drivers installer in graphical mode..............................................18 Starting the Data Federator Drivers installer in console mode................................................19 What happens during installation of the Data Federator Drivers installer ...............................20 Description of install sets in the Data Federator Drivers installer............................................22 Starting the Data Federator Drivers installer in silent mode....................................................23 Creating a configuration file for silent mode drivers installation...............................................25 Uninstalling Data Federator....................................................................................................25 Uninstalling Data Federator Drivers........................................................................................27 Configuring BusinessObjects Enterprise versions XI 3.0 SP2 and lower to use SAP NetWeaver BI Universe Strategy..............................................................................................................28 Configuring connectors to third-party sources of data............................................................29 Configuring Access connectors.............................................................................................29 Configuring DB2 connectors..................................................................................................30 Configuring Informix connectors.............................................................................................31 Configuring MySQL connectors.............................................................................................37 Configuring Netezza connectors............................................................................................38 Configuring Oracle connectors...............................................................................................44

1.1 1.2 1.2.1 1.2.2 1.2.3 1.2.4 1.3 1.4 1.4.1 1.4.2 1.4.3 1.4.4 1.4.5 1.4.6 1.5 1.5.1 1.5.2 1.5.3 1.5.4 1.5.5 1.5.6 1.6 1.7 1.8 1.9 1.9.1 1.9.2 1.9.3 1.9.4 1.9.5 1.9.6

2010-11-19

Contents

1.9.7 1.9.8 1.9.9 1.9.10 1.9.11 1.9.12 1.9.13 1.9.14 1.9.15 1.10 1.10.1
Chapter 2

Configuring SAP NetWeaver BW connectors........................................................................47 Configuring Progress connectors...........................................................................................59 Configuring Red Brick connectors..........................................................................................63 Configuring SAS connectors..................................................................................................64 Configuring SQL Server connectors......................................................................................66 Configuring Sybase connectors.............................................................................................69 Configuring Sybase IQ connectors.........................................................................................77 Configuring Teradata connectors...........................................................................................83 About connectors in Data Federator......................................................................................90 Installing Connection Dispatcher............................................................................................91 Installing Connection Dispatcher............................................................................................91 Starting Data Federator.........................................................................................................93 Starting Data Federator servers on Windows.........................................................................93 Starting servers when Data Federator Windows Services are installed..................................93 Starting servers when Data Federator Windows Services are not installed............................94 Starting Data Federator servers on AIX, Solaris or Linux........................................................94 Starting servers manually.......................................................................................................94 Shutting down Data Federator servers on Windows...............................................................95 Shutting down servers when Data Federator Windows Services are installed........................95 Shutting down servers when Data Federator Windows Services are not installed..................95 Shutting down Data Federator servers on AIX, Solaris or Linux..............................................96 Shutting down servers manually.............................................................................................96 Login and passwords.............................................................................................................97 Ports used by Data Federator................................................................................................97 Starting and stopping Connection Dispatcher........................................................................97 Starting Connection Dispatcher when Data Federator Windows Services are installed..........98 Starting Connection Dispatcher when Data Federator Windows Services are not installed.....98 Starting Connection Dispatcher on AIX or Solaris..................................................................99 Shutting down Connection Dispatcher when Data Federator Windows Services are installed.99 Shutting down Connection Dispatcher when Data Federator Windows Services are not installed................................................................................................................................100 Shutting down Connection Dispatcher on AIX or Solaris......................................................100 Backing up and restoring data............................................................................................103 About backing up and restoring data....................................................................................103 Starting the Data Federator Backup and Restore tool..........................................................103 Starting the Backup and Restore tool...................................................................................103 Backing up your Data Federator data...................................................................................104 Restoring your Data Federator data.....................................................................................105

2.1 2.1.1 2.1.2 2.2 2.2.1 2.3 2.3.1 2.3.2 2.4 2.4.1 2.5 2.6 2.7 2.7.1 2.7.2 2.7.3 2.7.4 2.7.5 2.7.6
Chapter 3

3.1 3.2 3.2.1 3.3 3.4

2010-11-19

Contents

Chapter 4

Updating licenses...............................................................................................................107 Updating your license...........................................................................................................107 More Information.................................................................................................................109 111

4.1
Appendix A Index

2010-11-19

Contents

2010-11-19

Installing Data Federator

Installing Data Federator

You can run the Data Federator installer in either graphical mode or console mode. Use the console mode if your AIX, Solaris or Linux environment lacks the graphic libraries to launch the installer in graphical mode. Console mode follows the same steps as graphical mode.

1.1 Overview
This document presents the installation instructions, and hardware and software requirements for Data Federator. You should consult this document and the release notes xi3_sp2_df_releasenotes_en.pdf file in the installation filesystem before you install Data Federator. Once you have installed and started Data Federator, you can find the Data Federator User Guide PDF as follows. On Windows, click Start > Programs > BusinessObjects XI 3.0 > BusinessObjects Data Federator > Data Federator Documentation Or: Look in the directory data-federator-install-dir\doc . On AIX, Solaris or Linux, look in the directory data-federator-links-dir/Data_Federa tor_Documentation , where data-federator-links-dir is the links directory that you chose for Data Federator. Or: Look in the directory data-federator-install-dir/doc .

1.2 Installation requirements

2010-11-19

Installing Data Federator

1.2.1 Hardware Requirements


To install the application, you need: any IBM-compatible machine with a Pentium III 500 MHZ processor or higher The designer client requires 512 Mb. The query server requires 512Mb. The repository requires 256Mb. If you want to install one or more secondary query servers, you first need to install a secondary multi-server repository (dedicated to the secondary servers). The secondary multi-server repository requires 256Mb. Each secondary query server requires 512Mb. a hard disk a CD-ROM drive The connection dispatcher requires 64Mb (installation is optional).

Example: If you are installing a designer and a query server automatically and then installing N secondary servers manually, you need: memory=512+256+512+256+N*512 Mb. If N=6, MEMORY=4608Mb => 4.5Gb. If the designer is not installed => 4Gb. Data Federator is available in both 32-bit and 64-bit architecture, but note that: 32-bit architecture does not include the Open Access Bridge. 64-bit architecture does not include the Connection Server nor Data Access.

1.2.2 Software Requirements


The following software is required on your system: One of the following operating systems: Microsoft Windows: Microsoft Windows XP Service Pack 2

2010-11-19

Installing Data Federator

Windows 2003 Server Windows 2000 Server IBM AIX SunSolaris Linux

For Data Federator Designer: Microsoft IE6 or IE7 browser Note: Data Federator Designer is not supported on IE plugins that are running in other applications. For Data Federator Administrator: Microsoft IE6 or IE7 browser or MozillaFirefox

This release supports JDK 1.4 and JDK 1.5 for applications that use Data Federator JDBC driver.

1.2.3 Differences between 32- and 64-bit architectures


Data Federator is available in both 32-bit and 64-bit architecture. Their differences are listed in the table below: 32-bit 64-bit ODBC or OLEDB connectivities are not supported for the following connectors: Informix, Netezza, Red Brick, Sybase, Sybase IQ, Access, SQL Server 2008 and Teradata. Only JDBC connectivity is supported for these. JREs installed with 64-bit architecture are: IBM JRE 1.5_6b AIX 64-bit for AIX Sun JRE 1.5.0_14 Linux AMD 64-bit for Linux Sun JRE 1.5.0_14 Solaris SPARC 64-bit for Solaris Sun JRE 1.5.0_14 Win64 AMD 64-bit for Windows

Both JDBC and ODBC connectivity.

JREs installed with 32-bit architecture are: IBM JRE 1.5_6b AIX 32-bit for AIX Sun JRE 1.5.0_14 Linux i586 32-bit for Linux Sun JRE 1.5.0_14 Solaris SPARC 32-bit for Solaris Sun JRE 1.5.0_14 Win32 i586 32-bit for Windows

2010-11-19

Installing Data Federator

Related Topics Description of install sets in the Data Federator installer

1.2.4 Before You Install Data Federator

1.2.4.1 No multiple spaces in paths on Windows


On Windows, your Data Federator installation and Data Federator links paths must not contain multiple spaces.

1.2.4.2 No spaces in paths on AIX, Solaris or Linux


On AIX, Solaris and Linux, your Data Federator installation and Data Federator links paths must not contain any spaces. If you change the default installation path or default links path on AIX, Solaris or Linux, make sure that you do not use any spaces.

1.2.4.3 Administrator rights


On Windows, you must be defined as Administrator to install the Data Federator servers as Windows services.

1.3 Components installed by the Data Federator installer and the Data Federator driver installer
Data Federator installer Data Federator Query Server Data Federator Designer

10

2010-11-19

Installing Data Federator

Data Federator Windows Services Data Federator JDBC Driver

Data Federator driver installer Data Federator JDBC driver Open Access ODBC to JDBC Bridge for Data Federator ODBC Data Access driver for Progress OpenEdge 10.0B connector.

1.4 Starting the Data Federator installer

1.4.1 Starting the Data Federator installer in graphical mode


1. In the installation filesystem, browse to and double click the file Install.htm. The install start page appears. 2. Click the link that corresponds to the architecture (32 bit or 64 bit) on which you want to install. The Data Federator installer start page appears. 3. Click the View link beside your listed OS to read important installation information before you install. 4. Read the installation information and click the Download link for your OS to start the Data Federator installation wizard. A "File Download" box appears. 5. Click Open. The install wizard "Introduction" window appears.

11

2010-11-19

Installing Data Federator

Follow the instructions on-screen to complete the installation. Related Topics What happens during installation

1.4.2 Starting the Data Federator installer in console mode


You can use the Data Federator installer in console mode if your AIX, Solaris or Linux environment lacks the graphic libraries to launch the installer in graphical mode. You can launch the installer in console mode with one of the following commands, from the root directory of the installation filesystem.

12

2010-11-19

Installing Data Federator

Table 1-2: Starting the Data Federator installer in console mode


on AIX
sh InstData/AIX/VM/install.bin i console

on Solaris
sh InstData/Solaris/VM/in stall.bin -i console

on Linux
sh InstData/Linux/VM/install.bin -i console

The install wizard Introduction message appears in a console. Follow the instructions on-screen to complete the installation. Related Topics What happens during installation

1.4.3 What happens during installation


This section lists the windows and choices that appear when you use the Data Federator installer. The installation procedure is the same on Windows, AIX, Solaris and Linux. 1. The Data Federator installer starts with the Introduction window. 2. The License Agreement window displays the license text and asks you to confirm the terms of the License Agreement if you want to continue the installation. 3. The Registration window lets you enter your license key. 4. The Choose Install Set window lets you choose the set of components that you want to install.

13

2010-11-19

Installing Data Federator

You can choose to install Data Federator as a Typical or Custom installation, or you can install only the Data Federator Connection Dispatcher, or only the Data Federator JDBC driver. 5. If you chose the Custom install set, the Choose Install Set window lets you select the components that you want to install. Select check boxes for components that you want to install. Clear check boxes for components that you do not want to install. 6. The Choose Install Folder window lets you choose an installation directory. You can type in a file path, or click Choose to browse to the installation directory. On AIX, Solaris and Linux, your Data Federator installation path must not contain any spaces. If you change the default installation path on AIX, Solaris or Linux, make sure that you do not use any spaces. 7. The Choose Shortcut Folder window lists options for the placement of icons and shortcuts. If required, you can type or browse to a directory to put the shortcut icons. If you change the default directory for shortcuts on AIX, Solaris Linux, make sure that you do not use any spaces in the path to the directory. 8. The Pre-Installation Summary window lets you review your install options and launch the installation. 9. The Installing BusinessObjects Data Federator XI Release 3 window displays the installation progress. 10. The Install Complete window indicates the installation status. 11. The installation creates an install log at data-federator-install-dir/install.log

14

2010-11-19

Installing Data Federator

The installer creates a silent mode installation response file, which you can use to re-run the same installation in silent mode. This file is located at data-federator-install-dir/in stall/silent/install.silent.properties . Related Topics Differences between 32- and 64-bit architectures Starting the Data Federator installer in graphical mode Starting the Data Federator installer in console mode Starting the Data Federator installer in silent mode

1.4.4 Description of install sets in the Data Federator installer

Install type

Description The following Data Federator components are installed: Data Federator Query Server Data Federator Designer Data Federator Windows Services On Windows, Data Federator Query Server and Data Federator Designer are installed as Windows services. Data Federator JDBC Driver

Typical

Note: You must be logged in with an administrator account to install Windows services. Data Federator Connection Dispatcher is installed. On Windows, this component is installed as a Windows service. Use this option if you already have multiple installations of Query Server on different machines and you want to install Connection Dispatcher to dispatch connections between them. For details, see the User Guide. Note: You must be logged in with an administrator account to install Windows services.

Dispatcher

15

2010-11-19

Installing Data Federator

Install type

Description Only the Data Federator JDBC driver is installed. Select this option if you already have Data Federator Query Server on a different machine and you want to access it from a client machine through the JDBC driver.

JDBC Driver

Install the Data Federator JDBC driver on the client machine. Note: Data Federator Query Server can also be accessed remotely using the web interface (Data Federator Administrator) without requiring any client installation. You can choose which Data Federator components are installed. You can install the following components: Data Federator Query Server Data Federator Designer Data Federator Connection Dispatcher Data Federator Windows Services On Windows, you can choose to install Data Federator Query Server, Data Federator Designer or Data Federator Connection Dispatcher as Windows services by selecting the Data Federator Windows Services component. Data Federator JDBC Driver

Custom

When you click on each component's option, a description appears in the Description box. Note: You must be logged in with an administrator account to install Windows services.

1.4.5 Starting the Data Federator installer in silent mode


You can run the Data Federator installer in silent mode if you want to repeat a previous installation with the same configuration. You can create a configuration file for silent mode installation by using the provided template file, or by simply running a graphical or console installation first. The graphical and console installations automatically create a configuration file that lets you repeat the same installation on another machine.

16

2010-11-19

Installing Data Federator

1. Create a configuration file for the silent mode installation. If you have not previously completed an installation, create a new configuration file for the silent mode installation. If you have previously completed an installation using graphical mode or console mode, copy the configuration file that the installer created. This file contains the settings that you chose during the previous installation. You can use this file to re-run the same installation on a different machine. This file is located at data-federator-install-dir/install/silent/in stall.silent.properties . Copy this file to a new location, your-silent-mode-installation-configuration-file 2. Run the silent mode installation from a command line, using the -f option to point to your configuration file. If you are installing on Windows, type the following in a command line.
installation-filesystem-root\InstData\Windows\VM\install.exe -f " your-silent-mode-installation-configuration-file"

For example:
D:\InstData\Windows\VM\install.exe -f "C:\My Documents\Previous Installations\Data Federator\in stall.silent.properties"

If you are installing on AIX, type the following in a command line.


sh installation-filesystem-root/InstData/AIX/VM/install.bin -f " your-silent-mode-installation-configuration-file"

For example:
sh /mnt/cd/InstData/AIX/VM/install.bin -f "/home/jill/previous_installations/data_federator/in stall.silent.properties"

If you are installing on Solaris, type the following in a command line.


sh installation-filesystem-root/InstData/Solaris/VM/install.bin -f " your-silent-mode-installation-configuration-file"

For example:
sh /mnt/cd/InstData/Solaris/VM/install.bin -f "/home/anil/previous_installations/data_federator/in stall.silent.properties"

If you are installing on Linux, type the following in a command line.


sh installation-filesystem-root/InstData/Linux/VM/install.bin -f " your-silent-mode-installation-configuration-file"

For example:
sh /mnt/cd/InstData/Linux/VM/install.bin -f "/home/jill/previous_installations/data_federator/in stall.silent.properties"

17

2010-11-19

Installing Data Federator

The silent mode installation installs Data Federator according to the properties you set in the configuration file. Caution: Note the following items when you install in silent mode. After you install Data Federator in silent mode, you should check if you need to restart your machine. Open the file data-federator-install-dir/install/install.properties ; if the property RESTART_NEEDED=yes, then you should reboot. If you install Data Federator in silent mode, the uninstaller also runs in silent mode. On Windows, if you install in silent mode, and then uninstall, you should reboot the machine after uninstallation. If you try to run the silent mode installation when there is an existing installation on your system, the silent mode installation will abort. You will know that the installation aborted if the install.log file appears on your Desktop on Windows, or in your home directory on AIX, Solaris or Linux.

Related Topics Creating a configuration file for silent mode installation

1.4.6 Creating a configuration file for silent mode installation


Create a configuration file for the installer by copying and editing the template file. 1. Copy the file data-federator-cd-dir/InstData/silent_install/install.silent.tem plate.properties to a new location, your-silent-mode-installation-configurationfile 2. Edit your-silent-mode-installation-configuration-file and complete the missing properties, as documented inside the file.

1.5 Starting the Data Federator Drivers installer

1.5.1 Starting the Data Federator Drivers installer in graphical mode


1. In the installation filesystem, browse to and double click the file drivers/install.htm.

18

2010-11-19

Installing Data Federator

2. Click the link Drivers Installer. The start page for the Data Federator Drivers installer appears. 3. Click the View link beside your listed OS to read important installation information before you install. 4. Read the installation information and click the Download link for your OS to start the Data Federator installation wizard. A "File Download" box appears. 5. Click Open. The install wizard "Introduction" window appears.

Follow the instructions on-screen to complete the installation. Related Topics Description of install sets in the Data Federator Drivers installer

1.5.2 Starting the Data Federator Drivers installer in console mode


You can use the Data Federator Drivers installer in console mode if your AIX, Solaris or Linux environment lacks the graphic libraries to launch the installer in graphical mode.

19

2010-11-19

Installing Data Federator

You can launch the installer in console mode with one of the following commands, from the root directory of the installation filesystem.

Table 1-4: Starting the Data Federator Drivers installer in console mode
on AIX
sh Drivers/InstData/AIX/VM/in stall_drivers.bin -i console

on Solaris
sh Drivers/InstData/Solaris/VM/in stall_drivers.bin -i console

on Linux
sh Drivers/InstData/Linux/VM/in stall_drivers.bin -i console

The install wizard Introduction message appears in a console. Related Topics What happens during installation of the Data Federator Drivers installer

1.5.3 What happens during installation of the Data Federator Drivers installer
This section lists the windows and choices that appear when you use the Data Federator Drivers installer. The installation procedure is the same on Windows, AIX, Solaris and Linux. 1. The Data Federator Drivers installer starts with the Introduction window. 2. The License Agreement window displays the license text and asks you to confirm the terms of the License Agreement if you want to continue the installation. 3. The Registration window lets you enter your license key. 4. The Choose Install Set window lets you choose the set of components that you want to install.

20

2010-11-19

Installing Data Federator

You can choose to install Data Federator drivers as a Complete or Custom installation, or you can install only the JDBC / ODBC drivers, or only the Data Access drivers. 5. If you chose the Custom install set, the Choose Install Set window lets you select the driver components you want to install. Select check boxes for the drivers you want to install. Clear check boxes for components you do not want to install. 6. The Choose Install Folder window lets you choose an installation directory. You can type in a file path, or click Choose to browse to the installation directory. On AIX, Solaris and Linux, your Data Federator installation path must not contain any spaces. If you change the default installation path on AIX, Solaris or Linux, make sure that you do not use any spaces. 7. The Choose Shortcut Folder window lists options for the placement of icons and shortcuts. If required, you can type or browse to a directory to put the shortcut icons. If you change the default directory for shortcuts on AIX, Solaris Linux, make sure that you do not use any spaces in the path to the directory. 8. The Pre-Installation Summary window lets you review your install options and launch the installation. 9. The Installing BusinessObjects Data Federator XI 3.0 window displays the installation progress. 10. The Install Complete window indicates the installation status. 11. The installation creates an install log at data-federator-install-dir/install.log

21

2010-11-19

Installing Data Federator

The installer creates a silent mode installation response file, which you can use to re-run the same installation in silent mode. This file is located at data-federator-install-dir/in stall/silent/install.silent.properties . Related Topics Description of install sets in the Data Federator Drivers installer Starting the Data Federator Drivers installer in graphical mode Starting the Data Federator Drivers installer in console mode Starting the Data Federator Drivers installer in silent mode

1.5.4 Description of install sets in the Data Federator Drivers installer

Install type

Description The following Data Federator driver components are installed: Data Federator JDBC Driver - enables client applications to connect to Data Federator Query Server through JDBC. Open Access ODBC to JDBC Bridge for Data Federator - enables client applications to connect to Data Federator Query Server through JDBC. Note: Open Access Bridge is only available for Windows platforms. Data Access Drivers for Data Federator Connectors - this installs an ODBC Data Access driver for Progress OpenEdge 10.0B connector. Note: This is only available for Windows platforms.

Complete

JDBC / ODBC Drivers

Data Federator JDBC driver. Open Access ODBC to JDBC Bridge for Data Federator

Note: Open Access Bridge is only available for Windows platforms. ODBC Data Access driver for Progress OpenEdge 10.0B connector.

Data Access Drivers

Note: This is only available for Windows platforms.

22

2010-11-19

Installing Data Federator

Install type

Description You can choose which Data Federator driver components are installed. You can install the following components: Data Federator JDBC Driver OpenAccess ODBC to JDBC Bridge for Data Federator Note: This can only be installed with the Data Federator JDBC driver Data Access Drivers for Data Federator Connectors

Custom

When you click on each component's option, a description appears in the Description box.

1.5.5 Starting the Data Federator Drivers installer in silent mode


You can run the Data Federator Drivers installer in silent mode if you want to repeat a previous installation with the same configuration. You can create a configuration file for silent mode installation by using the provided template file, or by simply running a graphical or console installation first. The graphical and console installations automatically create a configuration file that lets you repeat the same installation on another machine. 1. Create a configuration file for the silent mode installation. If you have not previously completed an installation, create a new configuration file for the silent mode installation. If you have previously completed an installation using graphical mode or console mode, copy the configuration file that the installer created. This file contains the settings that you chose during the previous installation. You can use this file to re-run the same installation on a different machine. This file is located at data-federator-drivers-install-dir/install/silent/in stall.silent.properties . Copy this file to a new location, your-silent-mode-installation-configuration-file 2. Run the silent mode installation from a command line, using the -f option to point to your configuration file. If you are installing on Windows, type the following in a command line.
installation-filesystem-root\drivers\InstData\Windows\VM\install_drivers.exe -f "

23

2010-11-19

Installing Data Federator

your-silent-mode-installation-configuration-file"

For example:
D:\drivers\InstData\Windows\VM\install_drivers.exe -f "C:\My Documents\Previous Installations\Data Federator\install.silent.properties"

If you are installing on AIX, type the following in a command line.


sh installation-filesystem-root/drivers/InstData/AIX/VM/install.bin -f " your-silent-mode-installation-configuration-file"

For example:
sh /mnt/cd/drivers/InstData/AIX/VM/install.bin -f "/home/jill/previous_installations/data_federator/in stall.silent.properties"

If you are installing on Solaris, type the following in a command line.


sh installation-filesystem-root/InstData/Solaris/VM/install_drivers.bin -f " your-silent-mode-installation-configuration-file"

For example:
sh /mnt/cd/drivers/InstData/Solaris/VM/install_drivers.bin -f "/home/anil/previous_installations/da ta_federator/install.silent.properties"

If you are installing on Linux, type the following in a command line.


sh installation-filesystem-root/drivers/InstData/Linux/VM/install_drivers.bin -f " your-silent-mode-installation-configuration-file"

For example:
sh /mnt/cd/drivers/InstData/Linux/VM/install_drivers.bin -f "/home/jill/previous_installations/da ta_federator/install.silent.properties"

The silent mode installation installs Data Federator Drivers according to the properties you set in the configuration file. Caution: Note the following items when you install in silent mode. After you install Data Federator Drivers in silent mode, you should check if you need to restart your machine. Open the file data-federator-drivers-install-dir/install/install.prop erties ; if the property RESTART_NEEDED=yes, then you should reboot. If you install Data Federator Drivers in silent mode, the uninstaller also runs in silent mode. On Windows, if you install in silent mode, and then uninstall, you should reboot the machine after uninstallation. If you try to run the silent mode installation when there is an existing installation on your system, the silent mode installation will abort. You will know that the installation aborted if the install.log file appears on your Desktop on Windows, or in your home directory on AIX, Solaris or Linux.

24

2010-11-19

Installing Data Federator

Related Topics Creating a configuration file for silent mode installation

1.5.6 Creating a configuration file for silent mode drivers installation


Create a configuration file for the installer by copying and editing the template file. 1. Copy the file data-federator-cd-dir/drivers/InstData/silent_install/in stall.silent.template.properties to a new location, your-silent-mode-installa tion-configuration-file 2. Edit your-silent-mode-installation-configuration-file and complete the missing properties, as documented inside the file.

1.6 Uninstalling Data Federator


You should manually stop the Data Federator servers before you uninstall, in the following cases. If you installed on AIX, Solaris or Linux. If you installed on Windows without the Data Federator Windows Services.

1. Start the Data Federator uninstallation. On Windows, click Start > BusinessObjects XI 3.0 > BusinessObjects Data Federator > Uninstall. On AIX, Solaris or Linux run Uninstall_Data_Federator from the links directory that you chose for Data Federator. Or, if you did not create a links directory, run the following command.
sh data-federator-install-dir/Uninstall_Data_Federator/Uninstall

The "Uninstall BusinessObjects Data Federator XI 3.0" window appears.

25

2010-11-19

Installing Data Federator

Click Complete Uninstall to uninstall all components. Or Click Uninstall Specific Features to choose which installed components you want to remove. 2. Choose an uninstall type and click Next. 3. Click Uninstall. The uninstall process removes the Data Federator components from your machine. 4. Click Done at the end of the uninstallation. The uninstallation removes Data Federator components from your system. After uninstalling on AIX or Solaris, some files may remain undeleted in the Data Federator installation directory. On Solaris, after uninstallation, the directory data-federator-install-dir/hsqldb may not be removed. On AIX, after uninstallation, some files in the directory data-federator-install-dir may not be removed.

You can remove the installation directory completely with the command rm-rfdata-federator-in stall-dir. Note: If you are asked to reboot after uninstalling, you should reboot before reinstalling a new version.

26

2010-11-19

Installing Data Federator

On Windows, if you ran the installation in silent mode, then you should always reboot after uninstalling. The silent mode uninstallation does not warn you if you need to reboot. Related Topics Shutting down servers when Data Federator Windows Services are not installed

1.7 Uninstalling Data Federator Drivers


1. Start the Data Federator Drivers uninstallation. On Windows, click Start > BusinessObjects XI 3.0 > BusinessObjects Data Federator Drivers > Uninstall. On AIX, Solaris or Linux run Uninstall_Data_Federator_Drivers from the links directory that you chose for Data Federator. Or, if you did not create a links directory, run the following command.
sh data-federator-drivers-install-dir/Uninstall_Data_Federator_Drivers/Uninstall

The "Uninstall BusinessObjects Data Federator XI 3.0 Drivers" window appears.

Click Complete Uninstall to uninstall all components.

27

2010-11-19

Installing Data Federator

Or Click Uninstall Specific Features to choose which installed components you want to remove. 2. Choose an uninstall type and click Next. 3. Click Uninstall. The uninstall process removes the Data Federator components from your machine. 4. Click Done at the end of the uninstallation. The uninstallation removes Data Federator components from your system. Caution: If you are asked to reboot after uninstalling, you should reboot before reinstalling a new version. On Windows, if you ran the installation in silent mode, then you should always reboot after uninstalling. The silent mode uninstallation does not warn you if you need to reboot. Related Topics Shutting down servers when Data Federator Windows Services are not installed

1.8 Configuring BusinessObjects Enterprise versions XI 3.0 SP2 and lower to use SAP NetWeaver BI Universe Strategy
If you have BusinessObjects Enterprise version XI 3.0 SP3 or higher, you only need to configure it to connect to Data Federator. You do not need to do anything special to connect through Data Federator to SAP NetWeaver BI. This procedure assumes that BusinessObjects Enterprise has been already configured to connect to Data Federator using JDBC. For information, see Creating a connection to Data Federator Query Server in the Data Access Guide. Note: If you have BusinessObjects Enterprise version XI 3.0 SP2 or lower, you need to copy the Data Federator strategy file to the BusinessObjects configuration folder. 1. Copy the Data Federator strategy file from the Data Federator installation filesystem, from the direc tory BOE-Add-ons/datafederator.stg to boe-install-dir/win32_x86/dataAccess/con nectionServer/jdbc 2. Add the link to the Data Federator strategy file. a. Edit the file boe-install-dir/win32_x86/dataAccess/connectionServer/jdbc/jd bc.sbo

28

2010-11-19

Installing Data Federator

b. Find the section <DataBase Active="Yes" Name="Data Federator Server"> and add the link to the strategy file.
>DataBase Active="Yes" Name="Data Federator Server"< >JDBCDriver< ... >/JDBCDriver< ... >Parameter Name="Strategies File"<datafederator>/Parameter< >/DataBase<

1.9 Configuring connectors to third-party sources of data

1.9.1 Configuring Access connectors

1.9.1.1 Requirements for connecting Data Federator to Access


It is not possible to retrieve primary key or foreign key values from MS Access databases using an ODBC driver. If you need Data Federator to recognize primary keys or foreign keys, use the JDBC driver to connect to MS Access. MS Access is only supported on Windows. For details on supported versions of Access, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.1.2 Configuring Access (odbc) connectors


In order to configure a connector for Access, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for Access. 2. Open your operating system's "ODBC Data Source Administrator".

29

2010-11-19

Installing Data Federator

To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for Access.
Parameter Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.2 Configuring DB2 connectors

1.9.2.1 Requirements for connecting Data Federator to DB2


For details on supported versions of DB2, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.2.2 Configuring DB2 connectors


In order to configure a connector for DB2, you must install JDBC drivers. These drivers are usually available from the DB2 website. 1. Download the JDBC driver for DB2. You get a driver in the form of a .jar file or several .jar files. Use the following link to download the IBM DB2 JDBC Universal Driver. The product is called IBM Cloudscape. To complete this download, you must register on the IBM website. Registration is free. After you install IBM Cloudscape, you can find the driver file in ibm-cloudscape-install-di rectory/lib/db2jcc.jar. The file db2jcc.jar is the driver you can use for DB2.

30

2010-11-19

Installing Data Federator

http://www14.software.ibm.com/webapp/download/ 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.3 Configuring Informix connectors

1.9.3.1 Requirements for connecting Data Federator to Informix (odbc)


For details on supported versions of Informix, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.3.2 Configuring Informix (odbc) connectors


In order to configure a connector for Informix, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for Informix. Use the Informix Client SDK. 2. Open your operating system's "ODBC Data Source Administrator". To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for Informix.

31

2010-11-19

Installing Data Federator

Parameter

Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.3.3 List of Informix resource properties


The table below lists the properties that you can configure in Informix resources.
Type Parameter Description

BOOLEAN

addCatalog

Set to True if you want to see the catalog as a prefix for table names. Set to True if you want to see the schema as a prefix for table names. Lists table types to take into consideration metadata that is retrieved by the underlying database. Special case: if this attribute is empty (' '), all table types are allowed. example: 'TABLE;SYSTEM TABLE;VIEW'

BOOLEAN

addSchema

Separated list of allowTableType values (semicolon)

one of {configure authenticationMode dIdentity, caller Impersonation, principalMapping}

configuredIdentity: authentication in the database is done using the value of the parameters user name and password. callerImpersonation: authentication in the database is done using the same credential as the one used to connect to the Query Server. principalMapping: authentication in the database is done using a mapping from Data Federator user to the user of the database. In this case, the parameter loginDomain should be set to a registered login domain.

32

2010-11-19

Installing Data Federator

Type

Parameter

Description

Mapping

capabilities

Defines what the data source supports in terms of relational operators. It lists all capabilities supported by the database. Depending on the supported relational operators, Data Federator manages the queries differently. For example if you specify outerjoin=false, that tells Data Federator Query Server to execute this operator within Data Federator Query Server engine. An example is: isjdbc=true;outer join=false;rightouterjoin=true. The Data Federator documentation has a full list of capabilities.

Default value

defaultFetchSize

This parameter gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If the value specified is negative, then the hint is ignored. The default value is -1.

BOOLEAN

ignoreKeys

Set to True if you do not want the connector to query the data source to get keys and foreign keys metadata. Set to True if the password is encrypted. The password is defined by the password parameter. The maximum time an idle connection is kept in the pool of connections. Unit is milliseconds. The default is 60000 ms (60 s). 0 means no limit.

BOOLEAN

isPasswordEncrypted

INTEGER

maxConnectionIdleTime

INTEGER

nbPreparedState mentsPerQuery

Maximum number of prepared statements in the query pool.

33

2010-11-19

Installing Data Federator

Type

Parameter

Description

pre-defined value networkLayer

Specifies the network layer of the database that you want to connect to. When you create a resource, choose the value that corresponds to the database to which you are connecting. For Informix, this should be: Informix CLI

STRING

password

Defines the password of the corresponding user. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "password".

separated list of schema values (semicolon)

Defines the schema names or patterns that you access. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "schema". You can specify several schemas. You can also specify wildcards for schemas. example:
'T%' = T followed by zero or more characters 'S_' = S followed by any single character

BOOLEAN

setFetchSize

Defines if the connector should set the default fetch size. Identifies the version of the database. For Informix, possible values are: Informix XPS 8.4 Informix XPS 8.5 Informix Dynamic Server 2000 Informix Dynamic Server 10

Predefined value

sourceType

34

2010-11-19

Installing Data Federator

Type

Parameter

Description

Predefined value

sqlStringType

Defines the syntax used to generate the SQL string. This parameter lets Data Federator Query Server translate the queries expressed in the Data Federator SQL Syntax to the syntax specific to the database. According to the query language of the database, the possible list of values is: sql92, sql99, jdbc3 example: jdbc3 format: SELECT * from {oj T1 LEFT OUTERJOIN T2 on T1.A1=T2.A2} SQL92 format: SELECT * from T1 LEFTOUTERJOIN T2 ON T1.A1=T2.A2

Predefined value

transactionIsolation

Attempts to change the transaction isolation level for connections to the database. The transaction Isolation parameter is used by the connector to set the transaction isolation level of each connection made to the underlying database. The Data Federator documentation has more details about the transactionIsolation property.

STRING

user

Defines the username of the database account. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "user". example: ALTER RESOURCE "jdbc.myresource" SET " user" ' newuser'

35

2010-11-19

Installing Data Federator

Type

Parameter

Description

True/Yes False/No supportsboolean

Specifies if the middleware or database supports BOOLEANS as first-class objects. The default value for this parameter depends on the database. For pre-defined resources, this parameter is already set to its correct value, but you can override it. Default: No. lets you define the maximum number of rows you want returned from the database (default value 0: no limit)

integer

maxRows

boolean

allowPartialResults

must be yes to allow partial results if maxRows is set ( yes/ no, true/ false, default value is no)

1.9.3.4 Requirements for connecting Data Federator to Informix (jdbc)


For details on supported versions of Informix, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.3.5 Configuring Informix (jdbc) connectors


In order to configure a connector for Informix, you must install JDBC drivers. These drivers are usually available from the Informix website. 1. Download the JDBC driver for Informix. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

36

2010-11-19

Installing Data Federator

1.9.4 Configuring MySQL connectors

1.9.4.1 Requirements for connecting Data Federator to MySQL


For details on supported versions of MySQL, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.4.2 Configuring MySQL connectors


In order to configure a connector for MySQL, you must install JDBC drivers. These drivers are usually available from the MySQL website. 1. Download the JDBC driver for MySQL. You get a driver in the form of a .jar file or several .jar files. http://dev.mysql.com/downloads/connector/j/3.1.html 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.4.3 Specific collation parameters for MySQL

37

2010-11-19

Installing Data Federator

Property Value

Property Description

datasourceSortCollation datasourceCompCollation datesourceBinaryCollation

the source collation for sort operations the source collation for comparisons the source collation for binary comparisons

Resource properties for setting collation parameters on MySQL Three JDBC resource properties let you force the specific collation to use for MySQL, even if your source of data has a different default collation. To force a collation value for MySQL, change the value of the datasourceSortCollation, datasourceCom pCollation or datesourceBinaryCollation JDBC resource properties. Example: Setting specific collation parameters for MySQL datasourceCompCollation="utf8_swedish_ci "

1.9.5 Configuring Netezza connectors

1.9.5.1 Requirements for connecting Data Federator to Netezza (odbc)


For details on supported versions of Netezza, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.5.2 Configuring Netezza (odbc) connectors


In order to configure a connector for Netezza, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for Netezza. 2. Open your operating system's "ODBC Data Source Administrator".

38

2010-11-19

Installing Data Federator

To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for Netezza.
Parameter Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.5.3 List of Netezza resource properties


The table below lists the properties that you can configure in Netezza resources.

39

2010-11-19

Installing Data Federator

Type

Parameter

Description

BOOLEAN

addCatalog

Set to True if you want to see the catalog as a prefix for table names. Set to True if you want to see the schema as a prefix for table names. Lists table types to take into consideration metadata that is retrieved by the underlying database. Special case: if this attribute is empty (' '), all table types are allowed. example: 'TABLE;SYSTEM TABLE;VIEW'

BOOLEAN

addSchema

Separated list of allowTableType values (semicolon)

one of {configure authenticationMode dIdentity, caller Impersonation, principalMapping}

configuredIdentity: authentication in the database is done using the value of the parameters user name and password. callerImpersonation: authentication in the database is done using the same credential as the one used to connect to the Query Server. principalMapping: authentication in the database is done using a mapping from Data Federator user to the user of the database. In this case, the parameter loginDomain should be set to a registered login domain.

Mapping

capabilities

Defines what the data source supports in terms of relational operators. It lists all capabilities supported by the database. Depending on the supported relational operators, Data Federator manages the queries differently. For example if you specify outerjoin=false, that tells Data Federator Query Server to execute this operator within Data Federator Query Server engine. An example is: isjdbc=true;outer join=false;rightouterjoin=true. The Data Federator documentation has a full list of capabilities.

40

2010-11-19

Installing Data Federator

Type

Parameter

Description

Default value

defaultFetchSize

This parameter gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If the value specified is negative, then the hint is ignored. The default value is -1.

BOOLEAN

ignoreKeys

Set to True if you do not want the connector to query the data source to get keys and foreign keys metadata. Set to True if the password is encrypted. The password is defined by the password parameter. The maximum time an idle connection is kept in the pool of connections. Unit is milliseconds. The default is 60000 ms (60 s). 0 means no limit.

BOOLEAN

isPasswordEncrypted

INTEGER

maxConnectionIdleTime

INTEGER

nbPreparedState mentsPerQuery

Maximum number of prepared statements in the query pool. Specifies the network layer of the database that you want to connect to. When you create a resource, choose the value that corresponds to the database to which you are connecting. For Netezza, this should be ODBC.

pre-defined value networkLayer

STRING

password

Defines the password of the corresponding user. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "password".

41

2010-11-19

Installing Data Federator

Type

Parameter

Description

separated list of schema values (semicolon)

Defines the schema names or patterns that you access. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "schema". You can specify several schemas. You can also specify wildcards for schemas. example:
'T%' = T followed by zero or more characters 'S_' = S followed by any single character

BOOLEAN

setFetchSize

Defines if the connector should set the default fetch size. Identifies the version of the database. For Netezza, possible values are: Netezza Server

Predefined value

sourceType

Predefined value

sqlStringType

Defines the syntax used to generate the SQL string. This parameter lets Data Federator Query Server translate the queries expressed in the Data Federator SQL Syntax to the syntax specific to the database. According to the query language of the database, the possible list of values is: sql92, sql99, jdbc3 example: jdbc3 format: SELECT * from {oj T1 LEFT OUTERJOIN T2 on T1.A1=T2.A2} SQL92 format: SELECT * from T1 LEFTOUTERJOIN T2 ON T1.A1=T2.A2

42

2010-11-19

Installing Data Federator

Type

Parameter

Description

Predefined value

transactionIsolation

Attempts to change the transaction isolation level for connections to the database. The transaction Isolation parameter is used by the connector to set the transaction isolation level of each connection made to the underlying database. The Data Federator documentation has more details about the transactionIsolation property.

STRING

user

Defines the username of the database account. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "user". example: ALTER RESOURCE "jdbc.myresource" SET " user" ' newuser'

True/Yes False/No supportsboolean

Specifies if the middleware or database supports BOOLEANS as first-class objects. The default value for this parameter depends on the database. For pre-defined resources, this parameter is already set to its correct value, but you can override it. Default: No. lets you define the maximum number of rows you want returned from the database (default value 0: no limit)

integer

maxRows

boolean

allowPartialResults

must be yes to allow partial results if maxRows is set ( yes/ no, true/ false, default value is no)

1.9.5.4 Requirements for connecting Data Federator to Netezza (jdbc)

43

2010-11-19

Installing Data Federator

For details on supported versions of Netezza, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.5.5 Configuring Netezza (jdbc) connectors


In order to configure a connector for Netezza, you must install JDBC drivers. These drivers are usually available from the Netezza website. 1. Download the JDBC driver for Netezza. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.6 Configuring Oracle connectors

1.9.6.1 Requirements for connecting Data Federator to Oracle


For details on supported versions of Oracle, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.6.2 Configuring Oracle connectors


In order to configure a connector for Oracle, you must install JDBC drivers. These drivers are usually available from the Oracle website. 1. Download the JDBC driver for Oracle. You get a driver in the form of a .jar file or several .jar files.

44

2010-11-19

Installing Data Federator

http://www.oracle.com/technology/software/tech/java/sqlj_jdbc/index.html 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.6.3 Requirements for connecting Data Federator to Oracle 11 (oci)


For details on supported versions of Oracle 11, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.6.4 Configuring Oracle 11 (oci) connectors


Oracle OCI connectors are configured in the Oracle client software. 1. Use the Oracle client software to define a TNS name tns-name to point to your database. Please refer to the vendor documentation for details on this configuration step. 2. Provide the following information to users of Data Federator Designer who want to create a datasource for Oracle 11.
Parameter Description

tns-name

The name of the TNS that you defined in the Oracle client software.

1.9.6.5 Requirements for connecting Data Federator to Oracle 11 (jdbc)


For details on supported versions of Oracle 11, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

45

2010-11-19

Installing Data Federator

1.9.6.6 Configuring Oracle 11 (jdbc) connectors


In order to configure a connector for Oracle 11, you must install JDBC drivers. These drivers are usually available from the Oracle 11 website. 1. Download the JDBC driver for Oracle 11. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.6.7 Specific collation parameters for Oracle


Resource properties for setting collation parameters on Oracle A JDBC resource property lets you force the specific collation to use for Oracle, even if your source of data has a different default collation. The default setting is sessionProperties: NLS_TERRITORY=AMERICA;NLS_LANGUAGE=EN GLISH;NLS_SORT=BINARY;NLS_COMP=BINARY The NLS_COMP and NLS_SORT parameters are used by Oracle to define the collation for comparison and sort operations. By default both NLS_COMP and NLS_SORT are set to BINARY. To force a specific collation on Oracle, change the value of the sessionProperties JDBC resource property.

1.9.6.8 How Data Federator transforms wildcards in names of Oracle tables


Certain wildcards in Oracle table names do not appear in Data Federator. For example, when searching for all tables in an object type, a table with the name abc/table1 appears as abc?22ftable1. The table below describes how wildcards appear in Data Federator:

46

2010-11-19

Installing Data Federator

The Oracle character ... % / \ . # ?

Is replaced by ... ?225 ?22f ?25c ?22e ?223 ?23f

1.9.7 Configuring SAP NetWeaver BW connectors

1.9.7.1 Requirements for connecting Data Federator to SAP NetWeaver BW


To let Data Federator connect to SAP NetWeaver BW, you must: have SAP Logon installed on the same machine where you installed Data Federator Query Server have the correct release of SAP NetWeaver BW, as well as the appropriate SAP notes.

For details on supported versions of SAP NetWeaver BW, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.7.2 Configuring SAP NetWeaver BW connectors


When you install Data Federator, the driver for SAP NetWeaver BW is already installed, and the connector for SAP NetWeaver BW is already configured.

47

2010-11-19

Installing Data Federator

Users can connect to SAP NetWeaver BW by entering the correct connection parameters in Data Federator Designer.

1.9.7.3 Manually setting the callback ID that SAP NetWeaver BW uses to contact Data Federator
SAP NetWeaver BW uses a callback ID in order to contact the query server. A callback is registered automatically when the first query on the SAP NetWeaver BW connector is executed, but you may want to change it, for example to comply with your organization's security policy. 1. Open SAP Logon and log on to the SAP system. 2. Enter se37 in the transaction text field and click execute.

3. Enter function module RSDRI_DF_CONFIGURE click execute.

48

2010-11-19

Installing Data Federator

This opens the parameter panel as below.

4. Set the parameters as follows. I_ONLY_CHECK I_RFC_DESTINATION I_REMOVE_CONFIGURATION '' (empty) DF_JCO_ some-hostname_ some-sid '' (empty)

For the second parameter, replace some-hostname by the hostname of the machine where you installed Data Federator Query Server. Use _ some-sid as a unique system identifier, to differentiate between potential multiple connections with the same some-hostname value. In this case, we define DF_JCO_ MYHOST as a unique identifier which we have to reuse in Data Federator Administrator. 5. Execute the module. Note: It is acceptable to receive the message: RFC Destination already exists. Make sure you that you clear the I_ONLY_CHECK check box. 6. Click System, then Logoff. 7. Open Data Federator Administrator, and log on using the administrator credentials. sysadmin / sysadmin in this example. 8. Click the Administration tab, then click Connector Settings in the menu on the left. Choose the SAP NetWeaver BW connector.

49

2010-11-19

Installing Data Federator

9. Set the property callbackServerProgramID to the same string I_RFC_DESTINATION that you used in SAP NetWeaver BW. DF_JCO_ MYHOST in this case.

10. Click OK. 11. Test that the data are available by opening a table. a. Click the Objects tab b. Select a datasource table in the list in the tree view on the left. The datasource tables are in DF_PROJECT_NAME/sources/ DATASOURCE_NAME. The "Information" and "Content" tables should show the metadata and the data of the chosen table respectively.

1.9.7.4 List of SAP NetWeaver BW resource properties


The table below lists the properties that you can configure in SAP NetWeaver BW resources.

50

2010-11-19

Installing Data Federator

Parameter

Description

packageSize

package size for callbacks This is the number of rows returned by SAP NetWeaver BW to Query Server, per package. The default value is 200. Example
300

jcoDestinationProperties

A list of JCO destination properties. Use the character ; to separate properties (do not type spaces). The properties you can use are documented in the API reference for the JCo API, in the interface DestinationDataProvider.

jcoServerProperties

A list of JCO server properties. Use the character ; to separate properties (do not type spaces). The properties you can use are documented in the API reference for the JCo API, in the interface ServerDataProvider.

callbackServerProgramID

ID for the callback that SAP NetWeaver BW uses to contact Data Federator This must match the ID of the callback that you registered on SAP NetWeaver BW. The format of the callbackProgramID is DF_JCO_ + hostname + _ + counter. The hostname is the name of the local host and the counter goes from 0 to 9. However the maximal length of host name is 23. If the name of local host is bigger than 23 only a prefix of 23 characters is used in the callbackProgramID. In case that no callbackServerProgramID is specified one is automatically generated and registered by the wrapper. Example DF_JCO_some-hostname_some-sid

51

2010-11-19

Installing Data Federator

Parameter

Description

checkUnits

When set to true, a query using a measure without its unit is refused, and an error is raised. By default the value is true and using of measure without its unit is not allowed. Example false

forcedCapabilities

lets you artificially limit the capabilities of the SAP NetWeaver BW connector, if you want Data Federator Query Server to perform operations instead of SAP NetWeaver BW Enter the capabilities that you want Query Server to delegate to SAP NetWeaver BW. The valid values are as follows: SCAN_ONLY Query Server only delegates scans to SAP NetWeaver BW. PROJECTIONS_ONLY Query Server only delegates projections to SAP NetWeaver BW. empty - Query Server delegates all vaild operations to SAP NetWeaver BW.

Example
SCAN_ONLY

maxTablePathLength

maximum length of table paths when join strategies are exposed to BusinessObjects Universe Designer; The default value is 1. Example
1

authorityCheck

sets the parameter in SAP NetWeaver BW that indicates whether or not to check authorizations The parameter in SAP NetWeaver BW specifies whether SAP NetWeaver BW should do the following. Should it check whether the user account is authorized to see the requested data (read) or should authorizations not be checked at all (none)? true (default): SAP NetWeaver BW checks read authorizations. false: SAP NetWeaver BW checks no authorizations.

52

2010-11-19

Installing Data Federator

Parameter

Description

enableAuthorizationsFiltering

When set to true, authorizations filtering is enabled: the connector will ensure that filters are automatically added to satisfy the SAP BI authorizations defined for the current user. When the authorization filtering is disabled, the user will get an error if he tries to get unauthorized data. By default the value is false. Example enableAuthorizationsFiltering=true

maxConnections

Represents the maximal number of SapNWBI wrapper connections that can be created. There is a one-to-one relation between a wrapper connection and a JCO destination so this property also controls the maximum number of JCO destinations that can be created by a wrapper instance. If this value is not given it defaults to 32767 . Example
5

disableSNC

When set to true disables the SNC communication even if SNC configuration information is provided. By default the value is false meaning that the SNC is used if the SNC configuration parameters are provided. Example
true

sncLib

Represents the path to the SNC Cryptographic Library to be used. Example


C:\SAP\Crypto\sapcrypto.dll

sncPartnerName

Represents the SNC name of the target SAP server. Is is used also to identify the SAP server's public certificate in the local PSE repository as to establish the trust in the remote SAP server. Example
p:CN=R60 BI3, OU=TD, O=SAP-AG, C=CA

53

2010-11-19

Installing Data Federator

Parameter

Description

sncMyName

Represents the SNC name of the client of the SAP server. It can be the Data Federator server SNC name when mutual server trust was configured between Data Federator server and remote SAP server. The remote SAP server should have the public certificate of the Data Federator server with this SNC name added in its SNC PSE repository. The SAP user account should also have this SNC name as its own SNC name in order to be able to do the client authentication. Example
p:CN=DF, OU=PG, O=BOBJ, C=FR

sncQOP

Represents the SNC Quality of Protection as defined in JCO documentation. Example


1 (SNC used for authentication only)

useBinaryXML

When set to true, the data exchanged between the connector and the SAP Netweaver BW server is compressed in binary XML format instead of plain text format. This improves performance. By default the value is true. Example useBinaryXML=true

1.9.7.5 Leveraging SAP analysis authorizations to filter data automatically


A query executed in SAP NetWeaver BW always selects a set of data from the database. If authorization-relevant characteristics are part of this data, you have to make sure that the user who is executing the query has sufficient authorization for the complete selection. Otherwise, an error message is returned indicating that the authorization is not sufficient. Starting with Data Federator XI 3.0 SP3, you can instruct Data Federator to leverage analysis authorizations and add automatically filters for the authorized values on each characteristic that is part of your cube. This feature is especially useful when you are using the single sign on authentication

54

2010-11-19

Installing Data Federator

mode to connect to Data Federator and SAP NetWeaver BW: you can easily filter data based on each user connecting to Data Federator. Activating the feature You can activate this feature setting the following SAP NetWeaver BW connector resource property: enableAuthorizationsFiltering: true / false

Use Data Federator Administrator to configure the resource used by your datasource. Pre-requisites This feature relies on a component in SAP NetWeaver BW called the Data Federator facade. Read the following SAP note to check the pre-requisites on SAP NetWeaver BW side: "https://service.sap.com/sap/support/notes/1500945" Principle All characteristics declared as authorization-relevant in SAP NetWeaver BW Data Warehousing Workbench are taken into consideration to compute the set of filters to add automatically. If a query contains an explicit filter, then no extra authorization filter is added. If a query does not contain a filter for a given characteristic (column) and this characteristic is authorization-relevant, then filters are automatically added to return authorized values. Hierarchy authorizations Data Federator does not expose hierachies. However, analysis authorizations on hierarchies are taken into account to filter data and return authorized values. Colon authorizations If aggregation authorizations (also called colon authorizations) are defined in addition to value based authorizations, Data Federator will always take into account the value based authorizations, even if the column is not in the SELECT clause of the SQL query. For more information about aggregation authorization logic, see the SAP Note 1140831 - Colon authorization during query execution: "https://service.sap.com/sap/support/notes/114083" Authorizations on multiple hierarchies When a characteristic has multiple hierarchies on its values, with authorizations on each of these hierarchies, a merge will be performed to return all authorized values from all hierarchies. Comparison with SAP Business Explorer (BEx) The SAP NetWeaver BW desktop application BEx Query Designer allows you to define queries and add filters based on analysis authorizations. However, there are some differences between BEx Query Designer and Data Federator: Using BEx Query Designer, the query designer can selectively specifiy on which characteristic to apply an authorization filter (using authorization variables). With Data Federator, authorizations

55

2010-11-19

Installing Data Federator

filtering is applied on all characteristics declared as authorization-relevant in SAP NetWeaver BW Data Warehousing Workbench. Using Data Federator, when an SQL query contains explicitly a filter on a given characteristic, the authorization filtering is not done on this characteristic and only the explicit filter is used. With BEx Query Designer, you can combine an authorization filter and an explicit filter added by the user.

Example: Authorization Filtering An infocube ZCUBE1 in BW contains only 6 rows and the datasource BW_ZCUBE1 is configured in Data Federator to access it with SSO enabled. When a user with full authorization is used to read fact table, he executes this SQL query:
select ZCHA1, ZCHA2, ZCHA3, ZKYF1 from /DF_PROJECT/sources/BW_ZCUBE1/IZCUBE1

And the result is:


ZCHA1 ZCHA2 ZCHA3 ZKYF1

A A B B C C

69226 69226 69190 69190 69115 69115

2001 2000 2001 2000 2001 2000

250.0 300.0 150.0 450.0 200.0 100.0

Now suppose another user JOE has full authorization on ZCHA1 and ZCHA3 but has access to a single value 69190 for characteristic ZCHA2. If he executes the same SQL query without activating the feature, he will get an error User JOE does not have authorization for InfoProvider ZCUBE1. When the feature is activated, Data Federator will return all authorized data and thus the result of the SQL query above is:
ZCHA1 ZCHA2 ZCHA3 ZKYF1

B B

69190 69190

2001 2000

150.0 450.0

Actually the result is exactly the same as the result of SQL with explicit filter on ZCHA2:
select ZCHA1, ZCHA2, ZCHA3, ZKYF1 from /DF_PROJECT/sources/BW_ZCUBE1/IZCUBE1 where ZCHA2 = 69190

56

2010-11-19

Installing Data Federator

1.9.7.6 Cleaning the IDs of callbacks for SAP NetWeaver BW connections


Currently, the maximum number of callbackProgramIDs is ten. During normal execution (the data federator server is not stopped abruptly), the callbackProgramIDs are automatically cleaned from the SAP server. An error occurs when you cannot generate any more callbackProgramIDs on the server (you used them all). The following is a procedure to delete callback names if, due to an abrupt system stop, they were not deleted automatically. 1. Log in to the SAP NetWeaver BW server. 2. Enter the transaction sm59. 3. Click TCP/IP Connections. 4. Click on each corresponding connection (DF_JCO_MYHOST_0 to DF_JCO_MYHOST_9) then click the delete icon.

1.9.7.7 Configuring Data Federator to support Secure Network Communication (SNC) on SAP NetWeaver BW Connectors
Pre-requisite Configure your BusinessObject Entreprise server to use Secure Network Communication (SNC) . Please refer to the BOE Administration Guide. Starting with Data Federator XI 3.0 SP3, it is possible to use Secure Network Communication (SNC) to connect to SAP NetWeaver BW. This mode is officially supported only in single sign-on (SSO) based workflows with Data Federator configured for BusinessObjects Enterprise authentication, more precisely: 1. Data Federator is installed on the same machine as your BusinessObjects Enterprise servers 2. You have configured BOE authentication in Data Federator Administrator 3. You create your SAP data sources using the SSO authentication mode with SNC enabled in Data Federator Designer. Data Federator will use SNC parameters from your BusinessObjects Entreprise Central Management Server to configure SNC communications to SAP NetWeaver BW. However, you have the ability to overwrite all or some of these parameters using connector properties. Steps to configure SNC In order to use SNC in Data Federator, the following requirements should be met by the configured deployment:

57

2010-11-19

Installing Data Federator

Each SAP user account used to connect to the SAP NetWeaver BW server should have an SNC name attached to it. Refer to the SNC User's Guide or SAP User Administration Guide for more details. On the Data Federator server system there should be a Personal Security Environment (PSE) repository attached to the SAP user's SNC name. Each PSE repository has a private key corresponding to its attached SNC name and is encrypted with a PIN code. The PSE repository should be configured and registered on the Data Federator server side. This procedure is dependent on the third-party GSS cryptographic subsystem you are using. Please refer to its documentation for more details. For instance, an SSO login credential that allows to open/decrypt the PSE repository should be attached to the OS user used to run the Data Federator server instance. This is the System user by default on Windows operating systems. Result: A screen opens with a list of existing projects. The public certificate corresponding to the PSE repository should be recorded in the PSE repository of the SAP Netweaver BW server which is dedicated to SNC configuration. The public certificate of the PSE repository used for SNC configuration in SAP NetWeather BWserver should be recorded in the PSE repositories available on the Data Federator server system and which should be used for SNC-based connections to this SAP Netweaver BW server.

1.9.7.7.1 Configuring an SAP Netweaver BW user account to set a Secure Network Communication (SNC) name
1. Using your SAP Logon, execute transaction su01. Administrator privileges may be required to do this. 2. Enter the relevant SAP user ID and open the Edit pane. 3. In the SNC tab, provide an SNC name to the SAP user account. This SNC name can be shared by multiple SAP users. In this case only one PSE repository is required on remote server side.

1.9.7.7.2 Overwriting SNC parameters


It is possible to overwrite all or some of the SNC parameters of your Central Management Server. This can be achieved by configuring the connector resource selected when creating your SAP NetWeaver BW datasource (jco.sap.netweaverBI by default): sncLib: Full path to the 3rd party GSS Cryptographic Library to be used with SNC sncPartnerName: SNC name of the SAP NetWeaver BW server sncMyName: SNC name that will identify your connection to the remote SAP NetWeaver BW server. SAP users should have this SNC name in order to work in SNC mode with Data Federator. sncQOP: Quality of protection

Use Data Federator Administrator to configure your connector resource.

58

2010-11-19

Installing Data Federator

1.9.7.7.3 Creating an SNC-enabled datasource


Creating an SNC-enabled datasource In Data Federator Designer, you can now create an SAP datasource simply activating the option Use SNC if enabled

1.9.7.7.4 Fallback
When using an SNC-enabled datasource, If the SNC parameters are not available, Data Federator will log a warning and will try to fallback to a non-SNC connection.

1.9.8 Configuring Progress connectors

1.9.8.1 Requirements for connecting Data Federator to Progress


For details on supported versions of Progress, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.8.2 Configuring connectors for Progress


Summary of the connection from Data Federator to Progress In order to use a Progress connector, you must install the Progress middleware and a driver that lets Data Federator connect to the Progress middleware. Details of the connection from Data Federator to Progress In order to connect to Progress databases, you must do the following: install the OEM SequeLink Server for ODBC Socket 5.5 from the Data Federator Drivers DVD (directory drivers/sl550socket). For Windows platforms only. install the OEM ODBC driver for Progress OpenEdge (Data Federator DataDirect Progress OpenEdge ODBC driver) using the Data Federator Drivers installer. For Windows platforms only. install the Progress OpenEdge 10.0B client configure DSN entries to point to your Progress databases

59

2010-11-19

Installing Data Federator

Data Federator loads the JDBC driver for Progress OpenEdge. The JDBC driver for Progress connects to the OEM SequeLink Server. The OEM SequeLink Server connects to Data Federator DataDirect Progress OpenEdge ODBC driver. The ODBC driver connects to the Progress OpenEdge 10.0B client. Finally, the Progress OpenEdge 10.0B client connects to the Progress database. The OEM SequeLink Server and the Data Federator DataDirect Progress OpenEdge ODBC driver should be on the same Windows machine as the Progress OpenEdge 10.0B client. The connection from the Progress OpenEdge 10.0B client to the Progress database is covered in your Progress documentation.

Figure 1-1: Architecture of an connection from Data Federator to Progress

Related Topics Installing OEM SequeLink Server for Progress connections Configuring middleware for Progress connections

1.9.8.3 Installing OEM SequeLink Server for Progress connections


In order to bridge the JDBC driver for Progress to the Data Federator DataDirect Progress OpenEdge ODBC driver, you must install the SequeLink Server for ODBC Socket 5.5 OEM version. The SequeLink Server installation is provided on the Data Federator DVD. Run the following script from the Data Federator DVD. drivers/sl550socket/oemsetup.bat You can find documentation on the SequeLink Server in the directory drivers/sl550socket/doc on the Data Federator DVD.

60

2010-11-19

Installing Data Federator

1.9.8.4 Configuring middleware for Progress connections


1. Install a Progress OpenEdge 10.0B client. See the Progress documentation for details. 2. Set your environment variables to point to the Progress OpenEdge installation as follows.
DLC=C:\Progress\OpenEdge PATH=%PATH%;%DLC%\bin

3. Run the Data Federator Driver installer and choose an install set that contains the connector driver for Progress OpenEdge 10.0B. 4. Open your operating system's "ODBC Data Source Administrator". On Windows, you configure DSN entries in the "ODBC Data Source Administrator". To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 5. Add a DSN entry of the type Data Federator DataDirect Progress OpenEdge, and configure it as follows. For the parameter... Enter... a name of your choice: your-progress-da ta-source-name Data source name for example, accounts-progress-datasource a description of your choice, to describe this Progress data source the name of the machine where your Progress database is installed the port of the Progress database the name of the Progress database to which you want to connect

Description

Host

Port

Database name

61

2010-11-19

Installing Data Federator

For the parameter...

Enter... a username that has at least read privileges on the Progress database to which you want to connect for example, progress-username

User

6. Use the Data Federator DVD and install the SequeLink Server OEM version ( drivers/sl550socket/oemsetup.bat). The SequeLink Server is a bridge between the JDBC driver for Progress and the Data Federator DataDirect OpenEdge driver. 7. Open the administration interface of the SequeLink Server. 8. Add a data source, and configure it as follows. For the parameter... Enter... a name of your choice: your-sequelinkdata-source-name the text DNS= followed by the name that you chose in the DSN entry for your ODBC driver, your-progress-data-source-name For example, for the attribute DataSource SOCODBCConnStr, enter DSN=accountsprogress-data-source

data source name (in tree list)

the attribute DataSourceSOCODBCConnStr, in the term DSN

When you complete the above steps, any connections that users create of type jdbc.progress.openedge will connect to Progress through the SequeLink Server. Give the following information to users of Data Federator Designer that want to connect to this Progress server.
Parameter Description

SequeLink data source name

The name you defined as the data source name in the administration interface of SequeLink Server: your-sequelink-data-source-name

62

2010-11-19

Installing Data Federator

Parameter

Description

SequeLink server host name

The name of the host where you installed the SequeLink Server. The port of the host where you installed the SequeLink Server.

SequeLink server port

Related Topics Installing OEM SequeLink Server for Progress connections

1.9.9 Configuring Red Brick connectors

1.9.9.1 Requirements for connecting Data Federator to Red Brick


For details on supported versions of Red Brick, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.9.2 Configuring Red Brick connectors


In order to configure a connector for Red Brick, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for Red Brick. 2. Open your operating system's "ODBC Data Source Administrator". To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for Red Brick.

63

2010-11-19

Installing Data Federator

Parameter

Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.10 Configuring SAS connectors

1.9.10.1 Requirements for connecting Data Federator to SAS


To let Data Federator connect to your SAS database, you must install a driver that lets Data Federator connect to a SAS/SHARE server. A SAS/SHARE server is a server that allows you to connect to SAS data sets. For more information about SAS/SHARE, see the SAS website. The driver is a JDBC driver. You can install it as you would install any JDBC driver in Data Federator. For details on supported versions of SAS, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.10.2 Configuring connectors for SAS


In order to use a SAS connector, you must install a driver that lets Data Federator connect to a SAS/SHARE server. A SAS/SHARE server is a server that allows you to connect to SAS data sets. For more information about SAS/SHARE, see the SAS website. You can install the driver as you would install any other JDBC driver for Data Federator. Related Topics http://www.sas.com/products/share/index.html

64

2010-11-19

Installing Data Federator

1.9.10.3 Installing drivers for SAS connections


In order to connect to SAS sources from Data Federator, you must install a SAS/SHARE driver for JDBC. The SAS/SHARE driver lets Data Federator connect to a SAS/SHARE server. The SAS/SHARE server accesses your SAS data sets. The SAS/SHARE driver for JDBC should be on the same machine as Data Federator. To set up your SAS/SHARE server, see your SAS documentation.

Figure 1-2: Architecture of an installation from Data Federator to SAS

Install a driver for a JDBC connection to SAS, as you would install a regular JDBC driver in Data Federator.

Users can now add a datasource of type SAS.

1.9.10.4 Optimizing SAS queries by ordering tables in the from clause by their cardinality
SAS is sensitive to the ordering of tables in the from clause. For the fastest response from the SAS/Share server, the table names in the from should appear in descending order with respect to their cardinalities. You can ensure that Data Federator generates tables in this order by keeping the statistics in Data Federator accurate. You can do this using Data Federator Administrator. To control the order of tables manually, you can also set the sasWeights resource property for the SAS JDBC connector.

65

2010-11-19

Installing Data Federator

1.9.11 Configuring SQL Server connectors

1.9.11.1 Requirements for connecting Data Federator to SQL Server 2000 and 2005
To connect to SQL Server versions 2000 or 2005, the query server uses JDBC drivers. You must configure the JDBC connector. For details on supported versions of SQL Server 2000 and 2005, see the Product Availability Report (PAR) for Data Federator. 1. Go to http://service.sap.com/bosap-support. 2. In the tree view, click Documentation, then Supported Platforms. 3. Click BusinessObjects XI 3.0 / Crystal Reports 2008. 4. In the pane on the right side, click BusinessObjects Data Federator. The PAR documents appear. Click the one for your platform.

1.9.11.2 Configuring SQL Server 2000 and 2005 connectors


In order to configure a connector for SQL Server 2000 and 2005, you must install JDBC drivers. These drivers are usually available from the SQL Server 2000 and 2005 website. 1. Download the JDBC driver for SQL Server 2000 and 2005. You get a driver in the form of a .jar file or several .jar files. Note: The recommended driver for SQL Server 2000 is SQL Server JDBC driver SP3 (the version is 2.2.0040) The recommended driver for SQL Server 2005 is version v1.0.809.102. http://www.microsoft.com/downloads/details.aspx?familyid=07287b11-0502-461a-b1382aa54bfdc03a&displaylang=en 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers

66

2010-11-19

Installing Data Federator

This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.11.3 Requirements for connecting Data Federator to SQL Server 2008 (odbc)
To connect to SQL Server version 2008, the query server uses ODBC or OLEDB. To configure SQL Server 2008 through ODBC, install the native client and then configure the ODBC driver. For details on supported versions of SQL Server 2008, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.11.4 Configuring SQL Server 2008 (odbc) connectors


In order to configure a connector for SQL Server 2008, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for SQL Server 2008. 2. Open your operating system's "ODBC Data Source Administrator". To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for SQL Server 2008.

67

2010-11-19

Installing Data Federator

Parameter

Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.11.5 Requirements for connecting Data Federator to SQL Server 2008 (jdbc)
For details on supported versions of SQL Server 2008, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.11.6 Configuring SQL Server 2008 (jdbc) connectors


In order to configure a connector for SQL Server 2008, you must install JDBC drivers. These drivers are usually available from the SQL Server 2008 website. 1. Download the JDBC driver for SQL Server 2008. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.11.7 Requirements for connecting Data Federator to SQL Server 2008 (oledb)
To connect to SQL Server version 2008, the query server uses ODBC or OLEDB. To configure SQL Server 2008 through OLEDB, just install the native client. For details on supported versions of SQL Server 2008, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

68

2010-11-19

Installing Data Federator

1.9.11.8 Configuring SQL Server 2008 (oledb) connectors


OLEDB connectors are configured by the client software. Once you run the client software for your OLEDB data source, you do not need to configure anything else in Data Federator.

1.9.11.9 Specific collation parameters for SQL Server

Property Value

Property Description

datasourceSortCollation datasourceCompCollation datesourceBinaryCollation

the source collation for sort operations the source collation for comparisons the source collation for binary comparisons

Resource properties for setting collation parameters on SQL Server Three JDBC resource properties let you force the specific collation to use for SQL Server, even if your source of data has a different default collation. To force a collation value for SQL Server, change the value of the datasourceSortCollation, datasource CompCollation or datesourceBinaryCollation JDBC resource properties. Example: Setting specific collation parameters for SQL Server datasourceBinaryCollation="Latin1_general_bin" datasourceSortCollation="french_ci_ai"

1.9.12 Configuring Sybase connectors

1.9.12.1 Requirements for connecting Data Federator to Sybase (open client)

69

2010-11-19

Installing Data Federator

For details on supported versions of Sybase, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.12.2 Configuring Sybase (open client) connectors


Sybase Open Client connectors are configured by the client software. Once you run the client software for your Open Client data source, you do not need to configure anything else in Data Federator.

1.9.12.3 Requirements for connecting Data Federator to Sybase (jdbc)


For details on supported versions of Sybase, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.12.4 Configuring Sybase (jdbc) connectors


In order to configure a connector for Sybase, you must install JDBC drivers. These drivers are usually available from the Sybase website. 1. Download the JDBC driver for Sybase. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

1.9.12.5 Installing middleware to let Data Federator connect to Sybase


To let Data Federator connect to your Sybase database, you must have the following configuration.

70

2010-11-19

Installing Data Federator

Data Federator Query Server and Sybase Open Client library, 12.5 or 15.0, must be installed on the same machine the Sybase Open Client library must be included in the environment variable the defines the library path On Windows, this variable is called PATH. Make sure that your PATH variable contains: C:\sybase\Shared\Sybase Central 4.3;C:\sybase\ua\bin;C:\sybase\OCS-15_0\lib3p;C:\sybase\OCS15_0\dll;C:\sybase\OCS-15_0\bin; On Linux and Solaris, this variable is called LD_LIBRARY_PATH:
$ export SYBASE=/opt/sybase $ export SYBASE_OCS=OCS-15_0 $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:${SYBASE}/${SYBASE_OCS}/lib:${SYBASE}/${SYBASE_OCS}/lib3p

On AIX, this variable is called LIB_PATH:


$ export SYBASE=/opt/sybase $ export SYBASE_OCS=OCS-15_0 $ export LIB_PATH=$LIB_PATH:${SYBASE}/${SYBASE_OCS}/lib:${SYBASE}/${SYBASE_OCS}/lib3p

1. Make sure Sybase Open Client is configured to connect to your Sybase server, where the Server name is defined as sybase-server-name. For example, you can install Open Client Directory Server Editor ( dsedit). Then, use dsedit to add a Server Object and choose a name for this object, sybase-server-name. For details on installing the Sybase middleware, see your vendor's documentation. http://infocen ter.sybase.com/help/index.jsp 2. In Data Federator Designer, when adding a datasource to your Sybase database, use sybaseserver-name as the value of the Server name field. Give the following information to users of Data Federator Designer that want to connect to this Sybase server.
Parameter Description

Server name

the name defined in the Server name field of the Server object in Sybase Open Client: sybaseserver-name the name of the database running on the Sybase server: sybase-database the name of the user account used to connect to the Sybase database: sybase-password

Default database

Password

71

2010-11-19

Installing Data Federator

Parameter

Description

User Name

the password for the user account used to connect to the Sybase database: sybase-username

Related Topics http://infocenter.sybase.com/help/index.jsp

1.9.12.6 List of Sybase resource properties


The table below lists the properties that you can configure in Sybase resources.

72

2010-11-19

Installing Data Federator

Type

Parameter

Description

BOOLEAN

addCatalog

Set to True if you want to see the catalog as a prefix for table names. Set to True if you want to see the schema as a prefix for table names. Lists table types to take into consideration metadata that is retrieved by the underlying database. Special case: if this attribute is empty (' '), all table types are allowed. example: 'TABLE;SYSTEM TABLE;VIEW'

BOOLEAN

addSchema

Separated list of allowTableType values (semicolon)

one of {configure authenticationMode dIdentity, caller Impersonation, principalMapping}

configuredIdentity: authentication in the database is done using the value of the parameters user name and password. callerImpersonation: authentication in the database is done using the same credential as the one used to connect to the Query Server. principalMapping: authentication in the database is done using a mapping from Data Federator user to the user of the database. In this case, the parameter loginDomain should be set to a registered login domain.

Mapping

capabilities

Defines what the data source supports in terms of relational operators. It lists all capabilities supported by the database. Depending on the supported relational operators, Data Federator manages the queries differently. For example if you specify outerjoin=false, that tells Data Federator Query Server to execute this operator within Data Federator Query Server engine. An example is: isjdbc=true;outer join=false;rightouterjoin=true. The Data Federator documentation has a full list of capabilities.

73

2010-11-19

Installing Data Federator

Type

Parameter

Description

STRING

database

Sybase only the name of the default database

Default value

defaultFetchSize

This parameter gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If the value specified is negative, then the hint is ignored. The default value is -1.

BOOLEAN

ignoreKeys

Set to True if you do not want the connector to query the data source to get keys and foreign keys metadata. Set to True if the password is encrypted. The password is defined by the password parameter. The maximum time an idle connection is kept in the pool of connections. Unit is milliseconds. The default is 60000 ms (60 s). 0 means no limit.

BOOLEAN

isPasswordEncrypted

INTEGER

maxConnectionIdleTime

INTEGER

nbPreparedState mentsPerQuery

Maximum number of prepared statements in the query pool. Specifies the network layer of the database that you want to connect to. When you create a resource, choose the value that corresponds to the database to which you are connecting. For Sybase, this should be SybaseOpenClient.

pre-defined value networkLayer

STRING

password

Defines the password of the corresponding user. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "password".

74

2010-11-19

Installing Data Federator

Type

Parameter

Description

separated list of schema values (semicolon)

Defines the schema names or patterns that you access. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "schema". You can specify several schemas. You can also specify wildcards for schemas. example:
'T%' = T followed by zero or more characters 'S_' = S followed by any single character

BOOLEAN

setFetchSize

Defines if the connector should set the default fetch size. Sybase only specifies if the character quote (") is used around identifiers If true, Data Federator puts quotes around table and column identifiers when it sends queries to Sybase. If false, Data Federator does not put quotes around identifiers, but this means that identifiers with any complex characters will fail. The setting setQuotedIdentifier=true corresponds to the statement set quoted_identifi er=on in Sybase.

BOOLEAN

setQuotedIdentifier

Predefined value

sourceType

Identifies the version of the database. For Sybase, possible values are: Sybase Adaptive Server 12 Sybase Adaptive Server 15

75

2010-11-19

Installing Data Federator

Type

Parameter

Description

Predefined value

sqlStringType

Defines the syntax used to generate the SQL string. This parameter lets Data Federator Query Server translate the queries expressed in the Data Federator SQL Syntax to the syntax specific to the database. According to the query language of the database, the possible list of values is: sql92, sql99, jdbc3 example: jdbc3 format: SELECT * from {oj T1 LEFT OUTERJOIN T2 on T1.A1=T2.A2} SQL92 format: SELECT * from T1 LEFTOUTERJOIN T2 ON T1.A1=T2.A2

Predefined value

transactionIsolation

Attempts to change the transaction isolation level for connections to the database. The transaction Isolation parameter is used by the connector to set the transaction isolation level of each connection made to the underlying database. The Data Federator documentation has more details about the transactionIsolation property.

STRING

user

Defines the username of the database account. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "user". example: ALTER RESOURCE "jdbc.myresource" SET " user" ' newuser'

76

2010-11-19

Installing Data Federator

Type

Parameter

Description

True/Yes False/No supportsboolean

Specifies if the middleware or database supports BOOLEANS as first-class objects. The default value for this parameter depends on the database. For pre-defined resources, this parameter is already set to its correct value, but you can override it. Default: No. lets you define the maximum number of rows you want returned from the database (default value 0: no limit)

integer

maxRows

boolean

allowPartialResults

must be yes to allow partial results if maxRows is set ( yes/ no, true/ false, default value is no)

1.9.13 Configuring Sybase IQ connectors

1.9.13.1 Requirements for connecting Data Federator to Sybase IQ (odbc)


To let Data Federator connect to your Sybase Adaptive Server IQ database, you must install Sybase ODBC for Adaptive Server IQ. For details on supported versions of Sybase IQ, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.13.2 Configuring Sybase IQ (odbc) connectors


In order to configure a connector for Sybase IQ, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for Sybase IQ.

77

2010-11-19

Installing Data Federator

2. Open your operating system's "ODBC Data Source Administrator". To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for Sybase IQ.
Parameter Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.13.3 Requirements for connecting Data Federator to Sybase IQ (jdbc)


For details on supported versions of Sybase IQ, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.13.4 Configuring Sybase IQ (jdbc) connectors


In order to configure a connector for Sybase IQ, you must install JDBC drivers. These drivers are usually available from the Sybase IQ website. 1. Download the JDBC driver for Sybase IQ. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

78

2010-11-19

Installing Data Federator

1.9.13.5 List of Sybase IQ resource properties


The table below lists the properties that you can configure in Sybase IQ resources.
Type Parameter Description

BOOLEAN

addCatalog

Set to True if you want to see the catalog as a prefix for table names. Set to True if you want to see the schema as a prefix for table names. Lists table types to take into consideration metadata that is retrieved by the underlying database. Special case: if this attribute is empty (' '), all table types are allowed. example: 'TABLE;SYSTEM TABLE;VIEW'

BOOLEAN

addSchema

Separated list of allowTableType values (semicolon)

one of {configure authenticationMode dIdentity, caller Impersonation, principalMapping}

configuredIdentity: authentication in the database is done using the value of the parameters user name and password. callerImpersonation: authentication in the database is done using the same credential as the one used to connect to the Query Server. principalMapping: authentication in the database is done using a mapping from Data Federator user to the user of the database. In this case, the parameter loginDomain should be set to a registered login domain.

79

2010-11-19

Installing Data Federator

Type

Parameter

Description

Mapping

capabilities

Defines what the data source supports in terms of relational operators. It lists all capabilities supported by the database. Depending on the supported relational operators, Data Federator manages the queries differently. For example if you specify outerjoin=false, that tells Data Federator Query Server to execute this operator within Data Federator Query Server engine. An example is: isjdbc=true;outer join=false;rightouterjoin=true. The Data Federator documentation has a full list of capabilities.

STRING

database

Sybase only the name of the default database

Default value

defaultFetchSize

This parameter gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If the value specified is negative, then the hint is ignored. The default value is -1.

BOOLEAN

ignoreKeys

Set to True if you do not want the connector to query the data source to get keys and foreign keys metadata. Set to True if the password is encrypted. The password is defined by the password parameter. The maximum time an idle connection is kept in the pool of connections. Unit is milliseconds. The default is 60000 ms (60 s). 0 means no limit.

BOOLEAN

isPasswordEncrypted

INTEGER

maxConnectionIdleTime

80

2010-11-19

Installing Data Federator

Type

Parameter

Description

INTEGER

nbPreparedState mentsPerQuery

Maximum number of prepared statements in the query pool. Specifies the network layer of the database that you want to connect to. When you create a resource, choose the value that corresponds to the database to which you are connecting. For Sybase IQ, this should be ODBC.

pre-defined value networkLayer

STRING

password

Defines the password of the corresponding user. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "password".

separated list of schema values (semicolon)

Defines the schema names or patterns that you access. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "schema". You can specify several schemas. You can also specify wildcards for schemas. example:
'T%' = T followed by zero or more characters 'S_' = S followed by any single character

BOOLEAN

setFetchSize

Defines if the connector should set the default fetch size. Identifies the version of the database. For Sybase, possible values are: Sybase ASIQ 12

Predefined value

sourceType

81

2010-11-19

Installing Data Federator

Type

Parameter

Description

Predefined value

sqlStringType

Defines the syntax used to generate the SQL string. This parameter lets Data Federator Query Server translate the queries expressed in the Data Federator SQL Syntax to the syntax specific to the database. According to the query language of the database, the possible list of values is: sql92, sql99, jdbc3 example: jdbc3 format: SELECT * from {oj T1 LEFT OUTERJOIN T2 on T1.A1=T2.A2} SQL92 format: SELECT * from T1 LEFTOUTERJOIN T2 ON T1.A1=T2.A2

Predefined value

transactionIsolation

Attempts to change the transaction isolation level for connections to the database. The transaction Isolation parameter is used by the connector to set the transaction isolation level of each connection made to the underlying database. The Data Federator documentation has more details about the transactionIsolation property.

STRING

user

Defines the username of the database account. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "user". example: ALTER RESOURCE "jdbc.myresource" SET " user" ' newuser'

82

2010-11-19

Installing Data Federator

Type

Parameter

Description

True/Yes False/No supportsboolean

Specifies if the middleware or database supports BOOLEANS as first-class objects. The default value for this parameter depends on the database. For pre-defined resources, this parameter is already set to its correct value, but you can override it. Default: No. lets you define the maximum number of rows you want returned from the database (default value 0: no limit)

integer

maxRows

boolean

allowPartialResults

must be yes to allow partial results if maxRows is set ( yes/ no, true/ false, default value is no)

1.9.14 Configuring Teradata connectors

1.9.14.1 Requirements for connecting Data Federator to Teradata (odbc)


To let Data Federator connect to your Teradata database, you must install a Teradata ODBC driver. For details on supported versions of Teradata, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.14.2 Configuring Teradata (odbc) connectors


In order to configure a connector for Teradata, you must install an ODBC driver and create an entry in your operating system's ODBC data source administrator. 1. Install the ODBC driver for Teradata. 2. Open your operating system's "ODBC Data Source Administrator".

83

2010-11-19

Installing Data Federator

To open the "ODBC Data Source Administrator" on a standard installation of Windows, click Start > Programs > Administrative Tools > Data Sources (ODBC). 3. Create a DSN (Data Source Name entry) to point to your database. Please refer to the vendor documentation for details on this configuration step. Provide the following information to users of Data Federator Designer who want to create a datasource for Teradata.
Parameter Description

data-sourcename

The name that you defined in your operating system's data source manager, in the field Data Source Name.

1.9.14.3 Requirements for connecting Data Federator to Teradata (jdbc)


For details on supported versions of Teradata, see the Supported Platforms document for SAP BusinessObjects Enterprise on the Support Portal.

1.9.14.4 Configuring Teradata (jdbc) connectors


In order to configure a connector for Teradata, you must install JDBC drivers. These drivers are usually available from the Teradata website. 1. Download the JDBC driver for Teradata. You get a driver in the form of a .jar file or several .jar files. 2. Copy the driver .jar files to data-federator-install-dir/LeSelect/drivers This directory is the default directory where Data Federator looks for JDBC drivers. If you want to put the drivers in a different directory, you must enter this directory name in the corresponding resource. When Data Federator starts, it loads your JDBC drivers, and it can access the corresponding JDBC data source.

84

2010-11-19

Installing Data Federator

1.9.14.5 Using the maxRows property to limit the number of rows returned from Teradata
You can use the maxRows property with Teradata databases to limit the number of rows returned when you are working in a testing environment. If you want to do this, use Data Federator Administrator to copy the Teradata resource, and set the value of the maxRows property to 100. You can tell users of Data Federator Designer that they can use a deployment context variable to switch between the two resources without editing the datasource. You must give them the name of the resource that you use in your test environment, and the name of the resource to use in the production environment.

1.9.14.6 List of Teradata resource properties


The table below lists the properties that you can configure in Teradata resources.

85

2010-11-19

Installing Data Federator

Type

Parameter

Description

BOOLEAN

addCatalog

Set to True if you want to see the catalog as a prefix for table names. Set to True if you want to see the schema as a prefix for table names. Lists table types to take into consideration metadata that is retrieved by the underlying database. Special case: if this attribute is empty (' '), all table types are allowed. example: 'TABLE;SYSTEM TABLE;VIEW'

BOOLEAN

addSchema

Separated list of allowTableType values (semicolon)

one of {configure authenticationMode dIdentity, caller Impersonation, principalMapping}

configuredIdentity: authentication in the database is done using the value of the parameters user name and password. callerImpersonation: authentication in the database is done using the same credential as the one used to connect to the Query Server. principalMapping: authentication in the database is done using a mapping from Data Federator user to the user of the database. In this case, the parameter loginDomain should be set to a registered login domain.

Mapping

capabilities

Defines what the data source supports in terms of relational operators. It lists all capabilities supported by the database. Depending on the supported relational operators, Data Federator manages the queries differently. For example if you specify outerjoin=false, that tells Data Federator Query Server to execute this operator within Data Federator Query Server engine. example:
'isjdbc=true;outerjoin=false;rightouter join=true'

86

2010-11-19

Installing Data Federator

Type

Parameter

Description

Default value

defaultFetchSize

This parameter gives the driver a hint as to the number of rows that should be fetched from the database when more rows are needed. If the value specified is negative, then the hint is ignored. The default value is -1.

BOOLEAN

ignoreKeys

Set to True if you do not want the connector to query the data source to get keys and foreign keys metadata. Set to True if the password is encrypted. The password is defined by the password parameter. The maximum time an idle connection is kept in the pool of connections. Unit is milliseconds. The default is 60000 ms (60 s). 0 means no limit.

BOOLEAN

isPasswordEncrypted

INTEGER

maxConnectionIdleTime

INTEGER

nbPreparedState mentsPerQuery

Maximum number of prepared statements in the query pool. Specifies the network layer of the database that you want to connect to. When you create a resource, choose the value that corresponds to the database to which you are connecting. For Teradata, the value should be: Teradata

pre-defined value networkLayer

STRING

password

Defines the password of the corresponding user. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "password".

87

2010-11-19

Installing Data Federator

Type

Parameter

Description

separated list of schema values (semicolon)

Defines the schema names or patterns that you access. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "schema". You can specify several schemas. You can also specify wildcards for schemas. example:
'T%' = T followed by zero or more characters 'S_' = S followed by any single character

BOOLEAN

setFetchSize

Defines if the connector should set the default fetch size. Identifies the version of the database. For Teradata, possible values are: Teradata V2 R5 (deprecated) Teradata V2 R6 Teradata 12 Teradata 13

Predefined value

sourceType

88

2010-11-19

Installing Data Federator

Type

Parameter

Description

Predefined value

sqlStringType

Defines the syntax used to generate the SQL string. This parameter lets Data Federator Query Server translate the queries expressed in the Data Federator SQL Syntax to the syntax specific to the database. According to the query language of the database, the possible list of values is: sql92, sql99, jdbc3 example: jdbc3 format: SELECT * from {oj T1 LEFT OUTERJOIN T2 on T1.A1=T2.A2} SQL92 format: SELECT * from T1 LEFTOUTERJOIN T2 ON T1.A1=T2.A2

Predefined value

transactionIsolation

Attempts to change the transaction isolation level for connections to the database. The transaction Isolation parameter is used by the connector to set the transaction isolation level of each connection made to the underlying database. For details, see "bo-df-jdbc-resources-propertiestransactionisolation.dita#bo-df-jdbc-resourcesproperties-transactionisolation-eim-titan".

STRING

user

Defines the username of the database account. Note: This property is a keyword, so you must enclose it in quotes when using the ALTER RESOURCE statement, e.g. "user". example: ALTER RESOURCE "jdbc.myresource" SET " user" ' newuser'

89

2010-11-19

Installing Data Federator

Type

Parameter

Description

True/Yes False/No supportsboolean

Specifies if the middleware or database supports BOOLEANS as first-class objects. The default value for this parameter depends on the database. For pre-defined resources, this parameter is already set to its correct value, but you can override it. Default: No. lets you define the maximum number of rows you want returned from the database (default value 0: no limit)

integer

maxRows

integer

sampleSize

lets you define the maximum number of rows to return in a random sample from the database (Teradata only) (default value 0: no limit)

boolean

allowPartialResults

must be yes to allow partial results if maxRows is set ( yes/ no, true/ false, default value is no)

1.9.15 About connectors in Data Federator


In Data Federator, configuring a connector means installing drivers or middleware, and then setting parameters so that Data Federator can connect to a source of data. In general, Data Federator connects to sources of data in one of two ways. JDBC For most sources of data that support JDBC, you just copy the JDBC driver to a directory where Data Federator can find it, and there is nothing more to configure. proprietary middleware For sources of data that do not support JDBC, you must install the vendor's middleware, and point Data Federator to the middleware. In most cases, you have already installed the middleware, and you just need to tell Data Federator where to find it.

90

2010-11-19

Installing Data Federator

1.10 Installing Connection Dispatcher


You can install Connection Dispatcher using the Data Federator installer.

1.10.1 Installing Connection Dispatcher


1. Launch the Data Federator installer. 2. Choose an install set that contains the Connection Dispatcher. Connection Dispatcher can only be installed as part of Windows services on the Windows platform. It can, however, be installed on all platforms, including Windows, when not as part of Windows services. Connection Dispatcher installs on the machine where you ran the installer. Related Topics What happens during installation Description of install sets in the Data Federator installer

91

2010-11-19

Installing Data Federator

92

2010-11-19

Starting Data Federator

Starting Data Federator

2.1 Starting Data Federator servers on Windows


Data Federator runs servers for Data Federator Designer, Data Federator Query Server and Data Federator Repository. On Windows, you can start Data Federator servers using Windows services or using scripts.

2.1.1 Starting servers when Data Federator Windows Services are installed
If you installed the Data Federator Windows Services component in the Data Federator installer, Data Federator servers start automatically. Specifically, the Data Federator Windows Services start the Data Federator servers. The following table lists the names of the Data Federator Windows Services that run the Data Federator servers.

Table 2-1: List of Windows services


Run the service in this order... 1 2 3

name of service is...

the service runs...

DataFederator.Repository DataFederator.QueryServer DataFederator.Designer

Data Federator Repository Data Federator Query Server Data Federator Designer

93

2010-11-19

Starting Data Federator

2.1.2 Starting servers when Data Federator Windows Services are not installed
If you did not install the Data Federator Windows Services component in the Data Federator installer, you can use the startup scripts to start Data Federator servers. The following table lists the names of the scripts that run Data Federator servers.

Table 2-2: List of scripts that run Data Federator servers on Windows
Run the script in this order... name of script is... data-federator-installdir\hsqldb\bin\start up.bat data-federator-installdir\LeSelect\bin\start up.bat data-federator-installdir\tomcat\bin\start up.bat the script runs...

Data Federator Repository

Data Federator Query Server

Data Federator Designer

2.2 Starting Data Federator servers on AIX, Solaris or Linux


Data Federator runs servers for Data Federator Designer, Data Federator Query Server and Data Federator Repository. On AIX, Solaris or Linux, you can start Data Federator servers using scripts.

2.2.1 Starting servers manually


There are two methods of starting the Data Federator servers manually: If you installed Data Federator shortcuts, you can click the Data_Federator_Servers_Startup icon in the Data_Federator_Links_Dir directory (the links directory you selected when you installed Data Federator shortcuts).

94

2010-11-19

Starting Data Federator

If you did not install Data Federator shortcuts, you can run the following script: data-federator-install-dir/bin/startup.sh

Related Topics What happens during installation

2.3 Shutting down Data Federator servers on Windows


Data Federator runs servers for Data Federator Designer, Data Federator Query Server and the Data Federator repository. On Windows, you can shut down Data Federator servers using Windows services or using scripts.

2.3.1 Shutting down servers when Data Federator Windows Services are installed
You can stop the following Data Federator Windows Services in order to shut down the Data Federator servers.

Table 2-3: List of Windows services


stop the service in this order... 1 2 3

name of service is...

the service controls...

DataFederator.Designer DataFederator.QueryServer DataFederator.Repository

Data Federator Designer Data Federator Query Server Data Federator Repository

2.3.2 Shutting down servers when Data Federator Windows Services are not installed

95

2010-11-19

Starting Data Federator

If you did not install the Data Federator Windows Services component in the Data Federator installer, you can use the shutdown scripts to shut down Data Federator servers. The following table lists the names of the scripts that shut down Data Federator servers.

Table 2-4: List of scripts that stop Data Federator servers on Windows
Run the script in this order... name of script is... data-federator-installdir\tomcat\bin\shut down.bat data-federator-installdir\LeSelect\bin\shut down.bat data-federator-installdir\hsqldb\bin\shut down.bat the script shuts down...

Data Federator Designer

Data Federator Query Server

Data Federator Repository

2.4 Shutting down Data Federator servers on AIX, Solaris or Linux


Data Federator runs servers for Data Federator Designer, Data Federator Query Server and the Data Federator repository. On AIX, Solaris or Linux, you can shut down Data Federator servers using scripts.

2.4.1 Shutting down servers manually


There are two methods of shutting down the Data Federator servers manually: If you installed Data Federator shortcuts, you can click the Data_Federator_Servers_Shutdown icon in the Data_Federator_Links_Dir directory (the links directory you selected when you installed Data Federator shortcuts). If you did not install Data Federator shortcuts, you can run the following script: data-federator-install-dir/bin/shutdown.sh Related Topics What happens during installation

96

2010-11-19

Starting Data Federator

2.5 Login and passwords


The default user name is sysadmin. The default password is sysadmin. You should use Data Federator Administrator to change the login parameters after installation. Starting Data Federator Administrator is described in the Data Federator User Guide.

2.6 Ports used by Data Federator


The following list shows the ports that are opened by default when you install Data Federator. Data Federator Designer: 3081 (HTTP) 3005 (shutdown server)

Data Federator Query Server: 3080 (HTTP, needed for Data Federator Administrator) 5512 (Corba, needed for jdbc driver communication) 5014 (Corba secured SSL) 3055 (proprietary protocol, needed for jdbc driver communication) 3334 (proprietary protocol, accessible from local machine only, used for internal management)

Data Federator Repository: 9009 (hsqldb proprietary protocol, needed only for local access, can be firewalled to enhance security) Data Federator Connection Dispatcher 3555 (proprietary protocol) 3344 (proprietary protocol, accessible from local machine only, used for internal management)

2.7 Starting and stopping Connection Dispatcher


If you install Connection Dispatcher with the Data Federator Windows Services component, you can use Windows services to start Connection Dispatcher.

97

2010-11-19

Starting Data Federator

Once Connection Dispatcher is started, you can connect to it by opening a telnet session to localhost (port: 3344). You can enter commands to Connection Dispatcher directly in its telnet console.

2.7.1 Starting Connection Dispatcher when Data Federator Windows Services are installed
If you installed the Data Federator Windows Services component in the Data Federator installer, the Connection Dispatcher server starts automatically. Specifically, the Data Federator Windows Services start the Connection Dispatcher server. The table below shows the Windows service that runs the Connection Dispatcher server.

Table 2-5: List of Windows services


name of service is... DataFederator.ConnectionDispatcher the service runs... Data Federator Connection Dispatcher

2.7.2 Starting Connection Dispatcher when Data Federator Windows Services are not installed
If you did not install the Data Federator Windows Services component in the Data Federator installer, you can use the startup scripts to start Connection Dispatcher. The following table shows the script that runs Connection Dispatcher.

Table 2-6: List of scripts that run Connection Dispatcher on Windows


name of script is... data-federator-install-dir\dispatch er\bin\startup.bat the script runs... Data Federator Connection Dispatcher

98

2010-11-19

Starting Data Federator

2.7.3 Starting Connection Dispatcher on AIX or Solaris


The following table lists the names of the script that runs Connection Dispatcher.

Table 2-7: List of scripts that run Connection Dispatcher on AIX or Solaris
name of script is... data-federator-install-dir/dispatch er/bin/startup.sh the script runs... Data Federator Connection Dispatcher

2.7.4 Shutting down Connection Dispatcher when Data Federator Windows Services are installed
Stop the following Data Federator Windows Service in order to shut down Data Federator Connection Dispatcher.

Table 2-8: List of Windows services


name of service is... DataFederator.ConnectionDispatcher the service controls... Data Federator Connection Dispatcher

Note: When you shut down Connection Dispatcher, any new connections requests of any clients that are pointing to Connection Dispatcher will fail. Make sure to either restart Connection Dispatcher or point the clients to a different server. All connections that were already acquired may still be used. The shutdown operation and status are noted in the configured log.

99

2010-11-19

Starting Data Federator

2.7.5 Shutting down Connection Dispatcher when Data Federator Windows Services are not installed
If you did not install the Data Federator Windows Services component in the Data Federator installer, you can use the shutdown scripts to shut down Connection Dispatcher. The following table shows the name of the script that shuts down Connection Dispatcher:

Table 2-9: List of scripts that stop Connection Dispatcher on Windows


name of script is... data-federator-install-dir\dispatch er\bin\shutdown.bat the script shuts down... Data Federator Connection Dispatcher

Note: When you shut down Connection Dispatcher, any new connections requests of any clients that are pointing to Connection Dispatcher will fail. Make sure to either restart Connection Dispatcher or point the clients to a different server. All connections that were already acquired may still be used. The shutdown operation and status are noted in the configured log.

2.7.6 Shutting down Connection Dispatcher on AIX or Solaris


The following table lists the name of the script that shuts down Connection Dispatcher.

Table 2-10: List of scripts that shut down Connection Dispatcher on AIX or Solaris
name of script is... data-federator-install-dir/dispatch er/bin/shutdown.sh the script shuts down... Data Federator Connection Dispatcher

100

2010-11-19

Starting Data Federator

Note: When you shut down Connection Dispatcher, any new connections requests of any clients that are pointing to Connection Dispatcher will fail. Make sure to either restart Connection Dispatcher or point the clients to a different server. All connections that were already acquired may still be used. The shutdown operation and status are noted in the configured log.

101

2010-11-19

Starting Data Federator

102

2010-11-19

Backing up and restoring data

Backing up and restoring data

3.1 About backing up and restoring data


Data Federator provides a tool for administrators to back up and restore all Data Federator data at once. This is useful for example when moving to a new server. Once the administrator has entered their username and password, the Data Federator Backup and Restore tool backs up and restores the following data: projects, including datasource definitions, targets, mappings, lookup tables and domain tables connector resources usernames and authorizations

3.2 Starting the Data Federator Backup and Restore tool


Data Federator administrators can start the Data Federator Backup and Restore Tool in two modes: graphical or console. Both modes offer the same functionality.

3.2.1 Starting the Backup and Restore tool


Data Federator Administrators can start the Data Federator Backup and Restore Tool as follows. 1. Ensure you are logged out of your Data Federator applications. 2. Use one of the following methods to start the Backup and Restore Tool.

103

2010-11-19

Backing up and restoring data

To start the Backup and Restore Tool on this platform...

in GUI mode

in console mode

In the Start menu, click Programs > BusinessObjects Data Federator XI 3.0 > Data Federator Backup and Restore Tool. Windows You can also run the Backup and Restore Tool with the following batch script.
datafederator-install-dir\bin\backup toolgui.bat

Run the following batch script.


datafederator-install-dir\bin\backup toolcon.bat

Run Data_Federator_Back up_and_Restore_Tool_GUI from the links directory that you chose for Data Federator. AIX, Solaris or Linux You can also run the Backup and Restore Tool with the following shell script.
datafederator-install-dir/bin/backup toolgui.sh

Run Data_Federator_Back up_and_Restore_Tool_Console from the links directory that you chose for Data Federator. You can also run the Backup and Restore Tool with the following shell script.
datafederator-install-dir/bin/backup toolcon.sh

3. Enter your username and password. The Data Federator Backup and Restore Tool stops the Data Federator services and prepares to backup or restore your data.

3.3 Backing up your Data Federator data


Your user account must have administrator rights in order to use the Backup and Restore Tool. 1. Start the Data Federator Backup and Restore Tool. 2. Click Backup. (In console mode, type 0 and press enter). 3. Choose a directory where you want to store your data. You can type the name of a new directory, and the Backup and Restore Tool will create it.

104

2010-11-19

Backing up and restoring data

The Backup and Restore Tool backs up your data If you are using Windows, and the Data Federator Windows services are installed, the Backup and Restore Tool restarts the Data Federator services automatically. Otherwise, use the shutdown and startup scripts. 4. If you are using AIX, Solaris or Linux, restart the Data Federator servers by using the command: [data-federator-install-dir]/bin/startup.sh Related Topics Starting the Data Federator Backup and Restore tool

3.4 Restoring your Data Federator data


Your user account must have administrator rights in order to use the Backup and Restore Tool, and you must have previously backed up your data using it. Data Federator Administrators can restore data using the Data Federator Backup and Restore Tool. 1. Start the Data Federator Backup and Restore Tool. 2. Click Restore. (In console mode, type 1 and press enter). 3. Choose the directory where you backed up the data that you want to restore. The Backup and Restore Tool restores your data. If you are using Windows, and the Data Federator Windows services are installed, the Backup and Restore Tool restarts the Data Federator services automatically. Otherwise, use the shutdown and startup scripts. 4. If you are using AIX, Solaris or Linux, restart the Data Federator servers by using the command: data-federator-install-dir/bin/startup.sh Related Topics Starting the Data Federator Backup and Restore tool

105

2010-11-19

Backing up and restoring data

106

2010-11-19

Updating licenses

Updating licenses

If you have a new keycode, you can update your license by using the Data Federator License Management Tool. You can get a new keycode from your Business Objects representative. The Data Federator License Management Tool is available in an interactive GUI version and an interactive console version.

4.1 Updating your license


1. Start the Data Federator License Management Tool, as follows.
To start the License Management Tool in on this platform... GUI mode console mode

Click Start > Programs > BusinessObjects Data Federator XI 3.0 > Data Federator License Management Tool Windows You can also run the License Management Tool with the following batch script.
datafederator-install-dir\bin\license toolgui.bat

Run the following batch script.


datafederator-install-dir\bin\license toolcon.bat

107

2010-11-19

Updating licenses

To start the License Management Tool in on this platform...

GUI mode

console mode

Run Data_Federator_Li cense_Management_Tool_GUI from the links directory that you chose for Data Federator. AIX, Solaris or Linux You can also run the License Management Tool with the following shell script.
datafederator-install-dir/bin/license toolgui.sh

Run Data_Federator_Li cense_Management_Tool_Con sole from the links directory that you chose for Data Federator. You can also run the License Management Tool with the following shell script.
datafederator-install-dir/bin/license toolcon.sh

2. Follow the instructions that appear on the screen. When asked, enter your new keycode. The License Management Tool updates your license.

108

2010-11-19

More Information

More Information

Information Resource

Location

SAP BusinessObjects product information

http://www.sap.com Navigate to http://help.sap.com/businessobjects and on the "SAP BusinessObjects Overview" side panel click All Products. You can access the most up-to-date documentation covering all SAP BusinessObjects products and their deployment at the SAP Help Portal. You can download PDF versions or installable HTML libraries. Certain guides are stored on the SAP Service Marketplace and are not available from the SAP Help Portal. These guides are listed on the Help Portal accompanied by a link to the SAP Service Marketplace. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. http://service.sap.com/bosap-support > Documentation Installation guides: https://service.sap.com/bosap-instguides Release notes: http://service.sap.com/releasenotes

SAP Help Portal

SAP Service Marketplace

The SAP Service Marketplace stores certain installation guides, upgrade and migration guides, deployment guides, release notes and Supported Platforms documents. Customers with a maintenance agreement have an authorized user ID to access this site. Contact your customer support representative to obtain an ID. If you are redirected to the SAP Service Marketplace from the SAP Help Portal, use the menu in the navigation pane on the left to locate the category containing the documentation you want to access. https://cw.sdn.sap.com/cw/community/docupedia

Docupedia

Docupedia provides additional documentation resources, a collaborative authoring environment, and an interactive feedback channel. https://boc.sdn.sap.com/

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

109

2010-11-19

More Information

Information Resource

Location

SAP BusinessObjects articles on the SAP Community Network

https://www.sdn.sap.com/irj/boc/businessobjects-articles These articles were formerly known as technical papers. https://service.sap.com/notes

Notes These notes were formerly known as Knowledge Base articles. Forums on the SAP Community Network https://www.sdn.sap.com/irj/scn/forums http://www.sap.com/services/education Training From traditional classroom learning to targeted e-learning seminars, we can offer a training package to suit your learning needs and preferred learning style. http://service.sap.com/bosap-support Online customer support The SAP Support Portal contains information about Customer Support programs and services. It also has links to a wide range of technical information and downloads. Customers with a maintenance agreement have an authorized user ID to access this site. To obtain an ID, contact your customer support representative. http://www.sap.com/services/bysubject/businessobjectsconsulting Consulting Consultants can accompany you from the initial analysis stage to the delivery of your deployment project. Expertise is available in topics such as relational and multidimensional databases, connectivity, database design tools, and customized embedding technology.

110

2010-11-19

Index
A
Access configuring connectors 29 administrator rights to install services 10 connectors Access 29 configuring 29, 30, 31, 36, 37, 38, 43, 44, 45, 46, 47, 59, 63, 64, 66, 67, 68, 69, 70, 77, 78, 83, 84 DB2 30 Informix 31, 36 MySQL 37 Netezza 38, 43, 44 Oracle 44 Oracle 11 45, 46 Progress 59 Red Brick 63 SAP NetWeaver BI 47 SAP NetWeaver BW 47 SAS 64 SQL Server 2000 and 2005 66 SQL Server 2008 67, 68, 69 Sybase 70 Sybase IQ 77, 78 Teradata 83, 84 install sets ; drivers description 22 installation hardware requirements 8 prerequisites 10 requirements 7 software requirements 8 steps 13, 20 installation path 10 installed components 10 installing Connection Dispatcher 91 Data Federator 13, 20 silent mode 16, 18, 23, 25 installing drivers datasources 61, 65 Progress 61 resources 61, 65 SAS 65 installing middleware datasources 60, 70 Progress 60 resources 60, 70 Sybase 70

B
backing up data 103 Backup and Restore Tool 103 Data Federator data 104 Backup and Restore Tool starting 103 backups 104 BusinessObjects Enterprise configuring 28

C
callback SAP NetWeaver BW 48 components installed 10 configuration file silent mode installation 18, 25 configuring BusinessObjects Enterprise 28 connectors 29, 30, 31, 36, 37, 38, 43, 44, 45, 46, 47, 59, 63, 64, 66, 67, 68, 69, 70, 77, 78, 83, 84 connecting BusinessObjects Enterprise to SAP NetWeaver BI 28 connection dispatcher 8 Connection Dispatcher installing 91 shutting down 99, 100 starting 98 AIX 99 Solaris 99 Windows 98 stopping 99, 100 using 97 connections SAP NetWeaver BW 57 connector definition files syntax 50

D
data backing up 103 Backup and Restore Tool 103 restoring 103 Backup and Restore Tool 103 Data Federator installer starting 11, 12, 18, 19 datasources installing drivers 61, 65 installing middleware 60, 70 DB2 configuring connectors 30

L
licence updating 107 licenses updating 107 login and password default 97

M
maxRows using with Teradata 85 MySQL configuring connectors 37

G
GSS 57

I
Informix configuring connectors 31, 36 properties 32 install sets description 9, 15

N
Netezza configuring connectors 38, 43, 44 properties 39

111

2010-11-19

Index

O
Oracle configuring connectors 44 Oracle 11 configuring connectors 45, 46

P
ports opened by default 97 used by servers 97 privileges for Progress sources 61 Progress 59 configuring connectors 59 installing drivers 61 installing middleware 60 properties Informix 32 Netezza 39 Sybase 72 Sybase IQ 79 Teradata 85

R
Red Brick configuring connectors 63 resources installing drivers 61, 65 installing middleware 60, 70 restoring backups 105 data 103 Backup and Restore Tool 103 Data Federator data 105

S
SAP Business Explorer 54

SAP NetWeaver BI configuring connectors 47 SAP NetWeaver BW callback 48 configuring connectors 47 connections 57 SAP NetWeaver BW Data Warehousing Workbench 54 SAS configuring connectors 64 connectors 64 installing drivers 65 optimizing queries 65 order of tables in from clause 65 security 57 servers shutting down 95, 96 starting 93, 94 AIX 94 Linux 94 Solaris 94 Unix-like systems 94 stopping 95, 96 shutting down Connection Dispatcher 99, 100 servers 95, 96 AIX 96 Linux 96 Solaris 96 Unix-like systems 96 silent mode installing 16, 18, 23, 25 silent mode installation configuration file 18, 25 SNC 57 SQL Server 2000 and 2005 configuring connectors 66 SQL Server 2008 configuring connectors 67, 68, 69 starting Connection Dispatcher 98 Data Federator installer 11, 12, 18, 19

starting (continued) servers 93, 94 stopping Connection Dispatcher 99, 100 servers 95, 96 AIX 96 Linux 96 Solaris 96 Unix-like systems 96 Sybase configuring connectors 70 installing middleware 70 properties 72 Sybase IQ configuring connectors 77, 78 properties 79 syntax wd files 50

T
table names wildcards 46 Teradata configuring connectors 83, 84 properties 85

U
uninstall procedure 25, 27 uninstalling Data Federator 25 Data Federator Drivers 27 updating licence 107 licenses 107

W
Windows services 93, 95, 99 not installed 94, 95, 98, 100

112

2010-11-19