a 64-bit Environment Author: Rob procedures. SSIS servers. Attunity.

Transcription

1 Oracle Driver configuration for SSIS, SSRS and SSAS in Environment a 64-bit Technical Article Author: Rob Kerr ( rkerr@blue-granite.com, ) Published: March 2010 Applies to: SQL Server 2008 R2 x64, Windows Server 2008 R2 Summary: This white paper describess the procedures needed to configure Oracle database drivers for use in Microsoft BI services (SSIS, SSRS, SSAS and BIDS) in a 64 bit Windows Server 2008 R2 environment. This article covers the selection and configuration of Oracle database drivers, including detailed configuration procedures. Specific coverage is given to configuration requirements for scenarios where BIDS is installed and used on 64 bit SSIS servers. This document includes configuration procedures for both the 64 bit and 32 bit versions of the Oracle Provider for OLEDB and the Microsoft Connector for Oracle by Attunity. While the primary target for this document is SQL Server 2008 R2, the techniques and discussion also apply to SQL Server 2008 and SQL Server 2005 product versions.

2 Copyright This white paper is for informational purposes only. BLUEGRANTE MAKES NO WARRANTIES, EXPRESS, IMPLIED, OR STATUTORY, AS TO THE INFORMATION IN THIS DOCUMENT. Complying with all applicable copyright laws is the responsibility of the user. Without limiting the rights under copyright, no part of this document may be reproduced, stored in, or introduced into a retrieval system, or transmitted in any form or by any means (electronic, mechanical, photocopying, recording, or otherwise), or for any purpose, without the express written permission of BlueGranite BlueGranite Inc. All rights reserved. All trademarks are property of their respective owners. Page 2

3 Table of Contents Introduction... 4 Select Components for Configuration... 5 Install and configure the 64 bit Oracle Client... 7 Install and configure the 32 bit Oracle Client Configuring BIDS to use the 32 bit Oracle client Configuration Test using the Microsoft Connector for Oracle by Attunity Configuration Test using the Oracle OLE DB Driver Page 3

4 Introduction This document provides information and procedures for installing and using drivers to connect 64 bit SQL Server Integration Services packages to Oracle data sources. Oracle driver configuration has been a troublesome area for Microsoft BI professionals for several reasons: Multiple drivers to choose from, each supporting some but often not all use cases, and some but not all CPU architectures Documentation has been unclear on software dependency requirements Documentation has been unclear regarding procedures for configuring 64 bit operating systems Some SQL Server components run as 32 bit processes even when installed in a 64 bit environment (BIDS & Management Studio, for example), requiring workarounds in some scenarios. Most information used by IT professionals for this type of configuration is sourced from blogs and discussion groups, some of which are more than four years old and obsolete (at this writing), some which are inaccurate or misleading, and most of which are solve only one part of the configuration puzzle but don t provide comprehensive instructional material. This guide provides a comprehensive overview of out of the box Oracle driver alternatives for SQL Server 2008 R2, SQL Server 2008 and SQL Server Additionally, this guide provides step by step instructions to install and configure Oracle drivers to cover all common requirements. These procedures can be completed in about an hour. The intent of this guide is to serve as a source of complete information that helps others complete their configuration quickly, saving hours of troubleshooting and research. The product versions used in the configuration guide are the following: Windows 2008R2 x64 o At the time of this writing, Oracle did not offer a Client supported on Windows 2008R2, but it was used anyway. SQL Server 2008 R2 CTP x64 Oracle Client (the back end Oracle server was Oracle 11g) SSIS is used as the reference application to test configurations, however the configuration completed in this guide also supports SSAS and SSRS use cases. While this document used the latest versions of all products to ensure the procedure is up to date at the time of its writing, the same configuration steps have been used by its author on versions of SQL Server dating back to 2005, and Oracle versions back to 9i. The issues and complexities to this configuration haven t changed significantly over time, so these procedures should work with minimal adjustment on the various combinations of product versions mentioned above. Page 4

5 Select Components for Configuration Several things must be considered to decide which driver components to use in your configuration: Your application needs The options are available according to your SQL server license Technical compatibility issues within your environment. Because OLE DB is the fastest middleware available for database integration with SSIS, you should select one of the OLE DB alternatives for general use. The matrix below summarizes the three alternatives provided within your existing SQL and Oracle licenses. Third party products are also available for specialized needs, but are not considered in this document. 32 bit 64 bit SQL Standard SQL Enterprise SQL 2005 SQL 2008 Oracle Instant Client Oracle Full Client Microsoft OLE DB Driver for Oracle X X X X X X X Oracle OLE DB Driver for Oracle* X X X X X X X Microsoft Connector for Oracle by Attunity X X X X X X *as of this writing, the only Oracle supported method for installing the Oracle OLE DB driver is to install it as a component of the Full Client installation. The Oracle Client supported for Windows Server 2008 was Some recommendations: In terms of performance, the clear winner is the Attunity connector. If you re using SQL 2008 Enterprise (or later), this is the best choice in most cases. If using SQL Standard Edition and (a) you plan to deploy on 64 bit Windows and (b) run SSIS packages in 64 bit mode, you must choose the Oracle OLE DB Driver the only out of the box option in this scenario. If you will only deploy on 32 bit operating systems only (or choose to run packages in 32 bit mode), you can choose the Microsoft OLE DB driver, but it would only be the best choice if there was a specific requirement it provided that the Oracle driver does not. Page 5

6 The remainder of this technical document will configure and test: Oracle Full Client bit Oracle Full client bit o If you don t intend to run BIDS on the server being configured, you can skip this section Attunity 64 bit connector (skip if not using SQL Enterprise edition) Attunity 32 bit connector (skip if you don t install the Oracle 32 bit client) Oracle 64 bit OLE DB Driver Oracle 32 bit OLE DB Driver (skip if you don t install the Oracle 32 bit client) Note that if you don t plan to use the Oracle OLE DB driver, you can install the Oracle Instant Client instead of the Full Client if you prefer. The detailed configuration steps after client installation will be the same when using the instant client. Page 6

7 Install and configure the 64 bit Oracle Client Obtain the installation media for the Oracle 64 bit Windows Client. At the time of this writing, the current version for Windows 2008 Server compatibility is , with the package identifier V If unavailable locally, the client can be obtained from From the client installation folder, run the setup.exe installer application. On the Welcome screen, press the Next button. P age 7

8 On the Installation Type screen, select Custom, and then press the Next button. Because you may have both a 64 bit and 32 bit client installed and will need to know which one is in which folder, the following folder strategy is suggested: Home c:\oracle Name OraClient11g_32bit Path c:\oracle\11.1.0\client_64bit Press the Next button. P age 8

9 At the time of this writing, Oracle Client is not certified for Windows server 2008R2, so a prerequisite error is thrown. If it s acceptable to continue on an unsupported platform, check the open prerequisite boxes, and then press the Next button. In the Available Product Components dialog, select the following items: Oracle Client SQL*Plus (for testing step below) Oracle Windows Interfaces Oracle Provider for OLEDB Oracle Provider for.net 2.0 These components are needed to complete the sections in this document. You may select other components if they are needed. Click the Next button. P age 9

10 Confirm the installation plan, and then press the Install button. When the installation completes, press the Exit button. P age 10

11 Obtain a correct tnsnames.ora file for your environment, and copy it to the c:\oracle\11.1.0\client_64bit\net work\admin folder. The tnsnames.ora file provides a logical name along with network connection information used by applications to connect to the Oracle instance. Most sites will have a standard file to copy to client machines (rather than using UI tools to create this file on each client). From control panel, select System, then System and Security, then System to launch the System Properties dialog box Click the Environment Variables button Click the New button to create a new System Variable (doo not create a User variable, as it would not be available to servicee accounts). Name the variable TNS_ADMIN. For the value, specify the folder where you copied the tnsnames.ora file. Press OK buttons on all the dialogs to save the changes. P age 11

12 Verify that the Path variable in the System Variables collection includes the folder wheree the 64 bit client software s OCIW32.DLL file is located. This should have been updated by the Oracle installer application. P age 12

13 From a command prompt, perform a basic test of the client by running SQL*Plus to query the database instance specified in the tnsnames.ora file you copied. Verify you can connect to the Oracle instance and query it. When you ve completed this step, the Oracle 64 bit client is correctly configured for OCI connections. C:\Oracle\ \client_64bit\bin>sqlplus SQL*Plus: Release Production on Fri Mar 26 23:32: Copyright (c) 1982, 2008,, Oracle. All rights reserved. Enter user-name: system@orcl Enter password: Connected to: Oracle Database 11g Enterprise Edition Release Production With the Partitioning, OLAP, Data Mining and Real Application Testing options SQL> select ename, job from scott.emp; ENAME JOB SMITH CLERK ALLEN SALESMAN WARD SALESMAN JONES MANAGER MARTIN SALESMAN BLAKE MANAGER CLARK MANAGER SCOTT ANALYST KING PRESIDENT TURNER SALESMAN ADAMS CLERK ENAME JOB JAMES CLERK FORD ANALYST MILLER CLERK 14 rows selected. SQL> quit Disconnected from Oracle Database 11gg Enterprise Edition Release Pr oduction With the Partitioning, OLAP, Data Mining and Real Application Testing options If your target server is SQL Server 2008 Enterprise, Install the Microsoft Connector for Oracle by Attunity x64 driver if desired. Use the default installation options (obtain from oads/details.aspx?familyid=d9cb 21FE 32E9 4D34 A381 6F9231D84F1E&displaylang=en) C:\Oracle\ \client_64bit\bin> P age 13

14 P age 14

15 Install and configure the 32 bit Oracle Client If you don t intend to run BIDS on your SSIS server, do not complete this section on your SSIS server. This step is necessary because BIDS is a 32 bit application, and it must use a 32 bit driver to connect to Oracle when configuring data sources and destinations. If you will develop packages on a developer workstation, then deploy them to a separate 64 bit server, you do not need the 32 bit Oracle client on your server, and you can skipp this section. This section assumes you have previously installed the 64 bit client according to the steps in the previous section. Obtain the installation media for the Oracle 32 bit Windows Client. At the time of this writing, the current version for Windows 2008 Server compatibility is , with the package identifier V If unavailable locally, the client can be obtained from From the client installation folder, run the setup.exe installer application. On the Welcome screen, press the Next button. P age 15

16 On the Installation Type screen, select Custom, and then press the Next button. Because you may have both a 64 bit and 32 bit clients installed and will need to know which one is in which folder, the following folder strategy is suggested: Home c:\oracle Name OraClient11g_32bit Path c:\oracle\11.1.0\client_32bit Press the Next button. P age 16

17 In the Available Product Components dialog, select the following items: Oracle Client SQL*Plus (for testing step below) Oracle Windows Interfaces Oracle Provider for OLEDB Oracle Provider for.net 2.0 These components are needed to complete the sections in this document. You may select other components if they are needed. Click the Next button. At the time of this writing, Oracle Client is not certified for Windows server 2008R2, so a prerequisite error is thrown. If it s acceptable to continue on an unsupported platform, check the open prerequisite boxes, and then press the Next button. P age 17

18 Confirm the installation plan, and then press the Install button. When the installation completes, press the Exit button. P age 18

19 Remove the 32 bit home folder from the Path variable within the System Variable collection. Since the default client we want applications to find on the path is the 64 bit client, we don t want the 32 bit drivers in the path at all. For BIDS, we ll override the path as BIDS is launched (we ll configure this in a later configuration step). This is what the Path variable should look like after you modify it. P age 19

20 Verify that the System variable TNS_ADMIN still points to the client_64bit\ \network\admin folder wheree the tnsnames.ora file was copied. The 32 bit installer may have removed this variable, so double check it. Since the tnsnames.ora file is independent of 32 bit/64 bit client issues, it makes sense to store in in one location, and use the TNS_ADMIN environment variable to direct either client to it. P age 20

21 From a command prompt, perform a basic test of the client by running SQL*Plus to query the database instance specified in the tnsnames.ora file you copied. Be sure to run this test from the 32bit client s bin directory otherwise the path environment variable will run the 64 bit sqlplus.exe, and your testt will be invalid). Verify you can connect to the Oracle instance and query it. Note: if you install InstantClient rather than the full client, SQL*Plus may fail to run due to a missing dependency msvcr71.dll. This is a Visual C++ runtime file, and SQL*Plus assumes it would have been installed previously on the client computer. When you ve completed this step, the Oracle 32 bit client is correctly configured for OCI connections. C:\Oracle\ \client_32bit>sqlpluss SQL*Plus: Release Production on Fri Mar 26 23:32: Copyright (c) 1982, 2008,, Oracle. All rights reserved. Enter user-name: system@orcl Enter password: Connected to: Oracle Database 11g Enterprise Edition Release Production With the Partitioning, OLAP, Data Mining and Real Application Testing options SQL> select ename, job from scott.emp; ENAME JOB SMITH CLERK ALLEN SALESMAN WARD SALESMAN JONES MANAGER MARTIN SALESMAN BLAKE MANAGER CLARK MANAGER SCOTT ANALYST KING PRESIDENT TURNER SALESMAN ADAMS CLERK ENAME JOB JAMES CLERK FORD ANALYST MILLER CLERK 14 rows selected. SQL> quit Disconnected from Oracle Database 11gg Enterprise Edition Release Pr oduction With the Partitioning, OLAP, Data Mining and Real Application Testing options C:\Oracle\ \client_32bit> If deploying on SQL Serve 2008 Enterprise edition, Install the Microsoft Connector for Oracle by Attunity 32 bit driver if desired (obtain from oads/details.aspx?familyid=d9cb 21FE 32E9 4D34 A381 6F9231D84F1E&displaylang=en) P age 21

22 Configuring BIDS to use the 32 bit Oracle client If you don t intend to run BIDS on your SSIS server, do not complete this section on your SSIS server. Because BIDS is a 32 bit application, it will expect to load 32 bit Oracle DLLs when connecting to Oracle data sources. However, we configured the 64 bit server to find 64 bit versions of these DLLs by default, so the PATH variable will find the 64 bit version of OCIW32.DLL when the client application requests it to be loaded. While this is desirable for dtexec.exe, it s undesirable for BIDS. Furthermore, a well known bug/limitation (depending on your point of view) in the Oracle client causes it to fail whenever it s called by an executable that is launched from a folder containing a parenthesis in the name. Since BIDS is a 32 bit application, it s installed by default under C:\Program Files (x86), and encounters this problem. To work around both issues in one step, we ll make a custom command file to launch the BIDS application in a way that will resolve calls to the Oracle client to the 32 bit folder location by changing the path, and run BIDS in a way that will not introduce a parenthesis into the application image path by using the alternate short file name. Another way to work around the (x86) problem often recommended in blogs and newsgroups is to copy the BIDS application to another folder that doesn t have (x86) embedded in it. I don t recommend this, as future service packs will almost certainly fail to update these secondary application copies. The launch command file method shown here makes no changes to the SQL Server installation structure, so future maintainability is not impacted. Open a command prompt, and change directory to the C:\ folder (if BIDS is installed on a different drive change to that drive instead of C). At the command prompt, type dir /x Note the alternate name for the C:\Program Files (x86). In this example, the alternate folder name is C:\PROGRA~2. C:\>dir /x Volume in drive C has no label. Volume Serial Number is AC0D-A7D5 Directory of C:\ 07/13/ :20 PM <DIR> PerfLogs 03/27/ :01 AM <DIR> product 03/26/ :58 PM <DIR> PROGRA~1 Program Files 03/27/ :16 AM <DIR> PROGRA~2 Program Files (x86) 01/15/ :23 PM <DIR> SQLBAC~1 SQLBackup 12/18/ :47 PM <DIR> Users 01/28/ :25 AM <DIR> Windows 0 File(s) 0 bytes 7 Dir(s) 200,383,090,688 bytes free C:\> Page 22

23 Open up a new notepad file Type the two lines at the right, ensuring the path in the set is the same you used when installing the 32 bit client, and the alternate path for 32 bit executable files matches what you discovered in the last step. SET PATH=C:\Oracle\ \client_32bit\BIN;%PATH% "C:\PROGRA~2\Microsoft Visual Studio 9.0\Common7\IDE\devenv.exe" Be very careful not to add additional spaces in these commands, and if you copy/past, ensure the quotes aren t translated to smart quotes. Note that the quotation marks around the second line is required due to the spaces in the Visual Studio folder name. Save the notepad file as a file name you like, and give it a.cmd extension. Note: to save a file from notepad without a.txt extension, choose All Files from the Save as type drop down list. P age 23

24 Double click the command file you created to launch BIDS IMPORTANT: With this technique, you must ALWAYS launch BIDS using this command file, and then open the project you re working with. If you run BIDS any other way (e.g. double clicking on a.sln file from the Windows shell, the Start menu, etc.), the PATH variable will not be correct for that application instance, and the application image will include the (x86), which will cause connection problems with many versions of Oracle OCI drivers. After BIDS launches, create a new Integration Services Project for testing Oracle connectivity. P age 24

25 Change the Project properties so that the package runs using the 32 bit runtime when debugging ( Run64BitRuntime=False).. If you do not change this setting, then the package will run in 64 bit mode when you run it from the BIDS IDE, and the package will fail since the 64 bit code will attempt to load the 32 bit Oracle OCI. This setting does not affect processing when running outside the BIDS environment. P age 25

26 Configuration Test using the Microsoft Connectorr for Oracle by Attunity This procedure assumes the test package you created in the BIDSS configuration section is still open. NOTE: If you DO intend to run BIDS on your SSIS Server, follow this entire procedure on the SSIS Server. If you DO NOT intend to run BIDS on your SSIS Server but will develop packages on a developer PC and then deploy them to the server then follow this procedure using the following sequence: 1. Complete the steps in this section on the developer workstation except the last step 2. Deploy or copy the resulting.dtsx package to the SSIS server 3. Complete the last step of this procedure on the SSIS server. Right click in the Connection Managers pane within your package, and select New Connection. P age 26

27 Select the MSORA Microsoft Connector for Oracle by Attunity connection manager from the selection list. Enter the TNS Name ( from your tnsnames.ora file) in the Server Name field, enter your username and password, and then press the Test Connection button. If the test succeeds, then BIDS is finding the 32 bit Oracle client files (most importantly ociw32.dll), and the Oracle client is properly reading the tnsnames.ora file to resolve the TNS name to the database IP address, port, etc. All is good so far. If you get connection errors at this point, most likely BIDS is unable to find ociw32.dll (path problem), it s finding the 64 bit version, and is unable to load a 64 bit P age 27

28 DLL into its 32 bit environment, or you didn t use the command file that eliminates the ( x86) path. Check the command file used to launch BIDS, and the TNS_ADMIN environment variable. Verify tnsnames.ora s location and contents. Create a simple data flow task to extract data from Oracle and write it to a text file With the Dataa Flow editor selected, add the Attunity tools to the SSIS toolbox. From the Tools menu, select Choose Toolbox Items P age 28

29 From the SSISS Data Flow Items tab, enable the Oracle Source and Oracle Destination tools, and then press the OK button. Execute the package within BIDS to ensure it runs correctly. P age 29

30 From a command line, execute the package using dtexec.exe. Ensure the package was run in 64 bit mode, and that it runs successfully. Since the path for the command prompt points to the 64 bit Oracle client, the 64 bit dtexec.exe will load the correct driver. You ve now tested that dtexec.exe works successfully in 64 bit mode with the Attunity OLEDB driver. C:\Projects\TestOracle>dtexec /F testoracle.dtsx Microsoft (R) SQL Server Execute Package Utility Version for 64-bit Copyright (C) Microsoft Corporation All rights reserved. Started: 2:35:10 PM Progress: :35:18.47 Source: Extract Oracle Data Validating: 100% complete End Progress Progress: :35:18.69 Source: Extract Oracle Data Post Execute: 100% complete End Progress DTExec: The package execution returned DTSER_SUCCESS (0). Started: 2:35:10 PM Finished: 2:35:18 PM Elapsed: seconds C:\Projects\TestOracle> Page 30

31 Configuration Test using the Oracle OLE DB Driver This procedure assumes the test package you created in the BIDSS configuration section is still open. NOTE: If you DO intend to run BIDS on your SSIS Server, follow this entire procedure on the SSIS Server. If you DO NOT intend to run BIDS on your SSIS Server but will develop packages on a developer PC and then deploy them to the server then follow this procedure using the following sequence: 1. Complete the steps in this section on the developer workstation except the last step 2. Deploy or copy the resulting.dtsx package to the SSIS server 3. Complete the last step of this procedure on the SSIS server. From your package s Connection Managers pane, right click and select New Connection. Select the OLEDB Connection manager for OLE DB connections connection manager from the selection list. P age 31

32 Click the New button to create a new OLE DB connection From the list of providers, select Oracle Provider for OLE DB, then press the OK button. P age 32

33 Enter the TNS Name ( from your tnsnames.ora file) in the Server or file name field, enter your user name and password, then press the Test Connection button. If the test succeeds, then BIDS is finding the 32 bit Oracle client files (most importantly ociw32.dll), and the Oracle client is properly reading the tnsnames.ora file to resolve the name to the database. All is good so far. If you get connection errors at this point, most likely BIDS is unable to find ociw32.dll (path problem) or it is finding the 64 bit version, and is unable to load a 64 bit DLL into its 32 bit environment. Check the command file used to launch BIDS, and the TNS_ADMIN environment variable. Create a simple data flow task to extract data from Oracle and write it to a text file (or, as in this example, add it to the flow created in the previous section) P age 33

34 Execute the package within BIDS to ensure it runs correctly. From a command line, execute the package using dtexec.exe. Ensure the package was run in 64 bit mode, and that it runs successfully. Since the path for the command prompt points to the 64 bit Oracle client, the 64 bit dtexec.exe will load the correct driver. You ve now ested that dtexec.exe works successfully in 64 bit mode with the Oracle OLE DB Driver. C:\Projects\TestOracle>dtexec /F testoracle.dtsx Microsoft (R) SQL Server Execute Package Utility Version for 64-bit Copyright (C) Microsoft Corporation All rights reserved. Started: 2:35:10 PM Progress: :35:18.47 Source: Extract Oracle Data Validating: 100% complete End Progress Progress: :35:18.69 Source: Extract Oracle Data Post Execute: 100% complete End Progress DTExec: The package execution returned DTSER_SUCCESS (0). Started: 2:35:10 PM Finished: 2:35:18 PM Elapsed: seconds C:\Projects\TestOracle> END OF DOCUMENT P age 34