78
Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

  • Upload
    others

  • View
    13

  • Download
    0

Embed Size (px)

Citation preview

Page 1: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

Informatica Data Archive (Version 6.1D)

File Archive Service ODBC/JDBC Setup Guide

Page 2: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

ii

Informatica Data Archive File Archive Service ODBC/JDBC Setup Guide Version 6.1D June 2012 Copyright (c) 1998-2012 Informatica. All rights reserved. Legal Copyright (c) 2003-2012 Informatica. All rights reserved. This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation. This Software may be protected by U.S. and/or international Patents and other Patents Pending. Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013 © (1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable. The information in this product or documentation is subject to change without notice. If you find any problems in this product or documentation, please report them to us in writing. Informatica, Informatica Platform, Informatica Data Services, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange Informatica On Demand, Informatica Identity Resolution, Informatica Application Information Lifecycle Management, Informatica Complex Event Processing, Ultra Messaging and Informatica Master Data Management are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners. Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies. All rights reserved. Copyright © Sun Microsystems. All rights reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All rights reserved.Copyright © Aandacht c.v. All rights reserved. Copyright Genivia, Inc. All rights reserved. Copyright Isomorphic Software. All rights reserved. Copyright © Meta Integration Technology, Inc. All rights reserved. Copyright © Intalio. All rights reserved. Copyright © Oracle. All rights reserved. Copyright © Adobe Systems Incorporated. All rights reserved. Copyright © DataArt, Inc. All rights reserved. Copyright © ComponentSource. All rights reserved. Copyright © Microsoft Corporation. All rights reserved. Copyright © Rogue Wave Software, Inc. All rights reserved. Copyright © Teradata Corporation. All rights reserved. Copyright © Yahoo! Inc. All rights reserved. Copyright © Glyph & Cog, LLC. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights reserved. Copyright © Information Builders, Inc. All rights reserved. Copyright © OSS Nokalva, Inc. All rights reserved. Copyright Edifecs, Inc. All rights reserved. Copyright Cleo Communications, Inc. All rights reserved. Copyright © International Organization for Standardization 1986. All rights reserved. Copyright © ej-technologies GmbH . All rights reserved. Copyright © Jaspersoft Corporation. All rights reserved. This product includes software developed by the Apache Software Foundation (http://www.apache.org/), and other software which is licensed under the Apache License, Version 2.0 (the "License"). You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. This product includes software which was developed by Mozilla (http://www.mozilla.org/), software copyright The JBoss Group, LLC, all rights reserved; software copyright © 1999-2006 by Bruno Lowagie and Paulo Soares and other software which is licensed under the GNU Lesser General Public License Agreement, which may be found at http://www.gnu.org/licenses/lgpl.html. The materials are provided free of charge by Informatica, "as-is", without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose. The product includes ACE(TM) and TAO(TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University, University of California, Irvine, and Vanderbilt University, Copyright ( © ) 1993-2006, all rights reserved. This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit (copyright The OpenSSL Project. All Rights Reserved) and redistribution of this software is subject to terms available at http://www.openssl.org and http://www.openssl.org/source/license.html. This product includes Curl software which is Copyright 1996-2007, Daniel Stenberg, <[email protected]>. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://curl.haxx.se/docs/copyright.html. Permission to use, copy, modify, and distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. The product includes software copyright 2001-2005 ( © ) MetaStuff, Ltd. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://www.dom4j.org/ license.html. The product includes software copyright © 2004-2007, The Dojo Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http://dojotoolkit.org/license. This product includes ICU software which is copyright International Business Machines Corporation and others. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://source.icu-project.org/repos/icu/icu/trunk/license.html. This product includes software copyright © 1996-2006 Per Bothner. All rights reserved. Your right to use such materials is set forth in the license which may be found at http://www.gnu.org/software/ kawa/Software-License.html. This product includes OSSP UUID software which is Copyright © 2002 Ralf S. Engelschall, Copyright © 2002 The OSSP Project Copyright © 2002 Cable & Wireless Deutschland. Permissions and limitations regarding this software are subject to terms available at http://www.opensource.org/licenses/mit-license.php. This product includes software developed by Boost (http://www.boost.org/) or under the Boost software license. Permissions and limitations regarding this software are subject to terms available at http:/ /www.boost.org/LICENSE_1_0.txt. This product includes software copyright © 1997-2007 University of Cambridge. Permissions and limitations regarding this software are subject to terms available at http:// www.pcre.org/license.txt. This product includes software copyright © 2007 The Eclipse Foundation. All Rights Reserved. Permissions and limitations regarding this software are subject to terms available at http:// www.eclipse.org/org/documents/epl-v10.php. This product includes software licensed under the terms at http://www.tcl.tk/software/tcltk/license.html, http://www.bosrup.com/web/overlib/?License, http://www.stlport.org/doc/license.html, http://www.asm.ow2.org/license.html, http://www.cryptix.org/LICENSE.TXT, http://hsqldb.org/web/hsqlLicense.html,

Page 3: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

iii

http://httpunit.sourceforge.net/doc/license.html, http://jung.sourceforge.net/license.txt, http://www.gzip.org/zlib/zlib_license.html, http://www.openldap.org/software/release/license.html, http://www.libssh2.org, http://slf4j.org/license.html, http://www.sente.ch/software/OpenSourceLicense.html, http://fusesource.com/downloads/license-agreements/fuse-message-broker-v-5-3- licenseagreement; http://antlr.org/license.html; http://aopalliance.sourceforge.net/; http://www.bouncycastle.org/licence.html; http://www.jgraph.com/jgraphdownload.html; http://www.jcraft.com/jsch/LICENSE.txt. http://jotm.objectweb.org/bsd_license.html; http://www.w3.org/Consortium/Legal/2002/copyright-software-20021231; http://www.slf4j.org/license.html; http://developer.apple.com/library/mac/#samplecode/HelpHook/Listings/HelpHook_java.html; http://www.jcraft.com/jsch/LICENSE.txt; http://nanoxml.sourceforge.net/orig/copyright.html; http://www.json.org/license.html; http://forge.ow2.org/projects/javaservice/, http://www.postgresql.org/about/licence.html, http://www.sqlite.org/copyright.html, http://www.tcl.tk/software/tcltk/license.html, http://www.jaxen.org/faq.html, http://www.jdom.org/docs/faq.html, and http://www.slf4j.org/license.html. This product includes software licensed under the Academic Free License (http://www.opensource.org/licenses/afl-3.0.php), the Common Development and Distribution License (http://www.opensource.org/licenses/cddl1.php ) the Common Public License (http://www.opensource.org/licenses/cpl1.0.php), the Sun Binary Code License Agreement Supplemental License Terms, the BSD License (http:// www.opensource.org/licenses/bsd-license.php) the MIT License (http://www.opensource.org/licenses/mitlicense.php) and the Artistic License (http://www.opensource.org/licenses/artistic-license-1.0). This product includes software copyright © 2003-2006 Joe WaInes, 2006-2007 XStream Committers. All rights reserved. Permissions and limitations regarding this software are subject to terms available at http://xstream.codehaus.org/license.html. This product includes software developed by the Indiana University Extreme! Lab. For further information please visit http://www.extreme.indiana.edu/. This Software is protected by U.S. Patent Numbers 5,794,246; 6,014,670; 6,016,501; 6,029,178; 6,032,158; 6,035,307; 6,044,374; 6,092,086; 6,208,990; 6,339,775; 6,640,226; 6,789,096; 6,820,077; 6,823,373; 6,850,947; 6,895,471; 7,117,215; 7,162,643; 7,254,590; 7,281,001; 7,421,458; 7,496,588; 7,523,121; 7,584,422, 7,720,842; 7,721,270; and 7,774,791 , international Patents and other Patents Pending. DISCLAIMER: Informatica Corporation provides this documentation "as is" without warranty of any kind, either express or implied, including, but not limited to, the implied warranties of noninfringement, merchantability, or use for a particular purpose. Informatica Corporation does not warrant that this software or documentation is error free. The information provided in this software or documentation may include technical inaccuracies or typographical errors. The information in this software and documentation is subject to change at any time without notice. NOTICES: This Informatica product (the "Software") includes certain drivers (the "DataDirect Drivers") from DataDirect Technologies, an operating company of Progress Software Corporation ("DataDirect") which are subject to the following terms and conditions: 1. THE DATADIRECT DRIVERS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. 2. IN NO EVENT WILL DATADIRECT OR ITS THIRD PARTY SUPPLIERS BE LIABLE TO THE END-USER CUSTOMER FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, CONSEQUENTIAL OR OTHER DAMAGES ARISING OUT OF THE USE OF THE ODBC DRIVERS, WHETHER OR NOT INFORMED OF THE POSSIBILITIES OF DAMAGES IN ADVANCE. THESE LIMITATIONS APPLY TO ALL CAUSES OF ACTION, INCLUDING, WITHOUT LIMITATION, BREACH OF CONTRACT, BREACH OF WARRANTY, NEGLIGENCE, STRICT LIABILITY, MISREPRESENTATION AND OTHER TORTS.

Page 4: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

iv

Contents Preface ........................................................................................................................................................... vi

Informatica Resources ................................................................................................................. vi

About this guide ...................................................................................... viii Overview of this guide ............................................................................................................. viii

Who should use this guide ...................................................................................................... viii

What’s in this guide? ................................................................................................................... ix

Document conventions ................................................................................................................. x

Available documentation ........................................................................................................................... xi

Product support .......................................................................................................................................... xii

Chapter 1: Overview of the ODBC/JDBC drivers ..................................... 1

About the ODBC/JDBC drivers .................................................................................................................. 2

Connecting a third-party tool to File Archive Service............................................................................. 3

ODBC/JDBC logging .................................................................................................................................... 4

ODBC/JDBC log file ...................................................................................................................... 4

Logging levels ................................................................................................................................ 4

Chapter 2: Installing and configuring the ODBC Windows driver ........... 5

About the ODBC Windows driver ............................................................................................................. 6

Installing the File Archive Service ODBC Windows driver ................................................................... 7

Configuring the ODBC data source using a DSN .................................................................................. 10

Configuring the initial DSN connection .................................................................................. 10

Adding a new DSN data source................................................................................................ 14

Changing the configuration of a DSN ...................................................................................... 15

Completing the DSN setup dialog ............................................................................................ 17

Setting Advanced properties ..................................................................................................... 19

Configuring the ODBC data source using a connection string ............................................................ 27

Setting the archive time via a connection string ..................................................................... 32

Chapter 3: Installing and configuring the ODBC Unix driver ................. 33

About the ODBC Unix driver ................................................................................................................... 34

Installing the File Archive Service ODBC Unix driver.......................................................................... 35

Page 5: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

v

Installation directory contents ................................................................................................... 37

Configuring the ODBC data sources ....................................................................................................... 38

Chapter 4: Installing and configuring the JDBC driver .......................... 47

Introduction ................................................................................................................................................. 48

About the jar file ......................................................................................................................................... 48

Configuring the JDBC data source using a URL .................................................................................... 49

Connection string elements ....................................................................................................... 49

Setting the archive time via a JDBC URL ................................................................................ 54

Chapter 5: Setting encryption on the server .......................................... 55

Introduction ................................................................................................................................................. 56

Changing the server encryption setting .................................................................................................. 57

Index .......................................................................................................... 59

Page 6: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

vi

Preface

Informatica Resources

Informatica Customer Portal

As an Informatica customer, you can access the Informatica Customer Portal site at http://mysupport.informatica.com. The site contains product information, user group information, newsletters, access to the Informatica Global Customer Support case management system (ATLAS), the Informatica How-To Library, the Informatica Knowledge Base, the Informatica Multimedia Knowledge Base, Informatica Product Documentation, and access to the Informatica user community.

Informatica Documentation

The Informatica Documentation team takes every effort to create accurate, usable documentation. If you have questions, comments, or ideas about this documentation, contact the Informatica Documentation team through email at [email protected]. We will use your feedback to improve our documentation. Let us know if we can contact you regarding your comments. The Documentation team updates documentation as needed. To get the latest documentation for your product, navigate to Product Documentation from http://mysupport.informatica.com.

Informatica Web Site

You can access the Informatica corporate web site at http://www.informatica.com. The site contains information about Informatica, its background, upcoming events, and sales offices. You will also find product and partner information. The services area of the site includes important information about technical support, training and education, and implementation services.

Informatica How-To Library

As an Informatica customer, you can access the Informatica How-To Library at http://mysupport.informatica.com. The How-To Library is a collection of resources to help you learn more about Informatica products and features. It includes articles and interactive demonstrations that provide solutions to common problems, compare features and behaviors, and guide you through performing specific real-world tasks.

Informatica Knowledge Base

As an Informatica customer, you can access the Informatica Knowledge Base at http://mysupport.informatica.com. Use the Knowledge Base to search for documented solutions to known technical issues about Informatica products. You can also find answers to frequently asked questions, technical white papers, and technical tips. If you have questions, comments, or ideas about the Knowledge Base, contact the Informatica Knowledge Base team through email at [email protected].

Informatica Multimedia Knowledge Base

As an Informatica customer, you can access the Informatica Multimedia Knowledge Base at http://mysupport.informatica.com. The Multimedia Knowledge Base is a collection of instructional multimedia files that help you learn about common concepts and guide you through performing specific tasks. If you have questions, comments, or ideas about the Multimedia Knowledge Base, contact the Informatica Knowledge Base team through email at [email protected].

Page 7: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

vii

Informatica Global Customer Support

You can contact a Customer Support Center by telephone or through the Online Support. Online Support requires a user name and password. You can request a user name and password at http://mysupport.informatica.com. Use the following telephone numbers to contact Informatica Global Customer Support:

North America / South America Europe / Middle East / Africa Asia / Australia

Toll Free Brazil: 0800 891 0202 Mexico: 001 888 209 8853 North America: +1 877 463 2435

Toll Free France: 0805 804632 Germany: 0800 5891281 Italy: 800 915 985 Netherlands: 0800 2300001 Portugal: 800 208 360 Spain: 900 813 166 Switzerland: 0800 463 200 United Kingdom: 0800 023 4632 Standard Rate Belgium: +31 30 6022 797 France: +33 1 4138 9226 Germany: +49 1805 702 702 Netherlands: +31 306 022 797 United Kingdom: +44 1628 511445

Toll Free Australia: 1 800 151 830 New Zealand: 09 9 128 901 Standard Rate India: +91 80 4112 5738

Page 8: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

viii

About this guide This section provides information about the guide, its intended audience, and the conventions used within it.

Overview of this guide This guide explains how to set up the Informatica ODBC and JDBC drivers so that you can use them to query the data in your File Archive Service archives. It gives details of how to set up the relevant drivers under the supported operating systems.

Who should use this guide This guide is intended for anyone who wants to query the data in File Archive Service using a query tool connected using either ODBC or JDBC. It describes how to establish the connection, rather than how to perform the queries.

Page 9: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

ix

What’s in this guide? This guide contains the following chapters and appendixes:

Chapter 1: Overview of the ODBC/JDBC driver, gives an overview of the ODBC and JDBC drivers, and explains the steps involved in connecting a third-party tool to File Archive Service.

Chapter 2: Installing and configuring the ODBC Windows driver, describes how to install and configure the File Archive Service ODBC driver under Windows.

Chapter 3: Installing and configuring the ODBC Unix driver, describes how to install and configure the File Archive Service ODBC driver under any supported Unix operating system.

Chapter 4: Installing and configuring the JDBC driver, gives instructions for installing and configuring the File Archive Service JDBC driver. These instructions are the same regardless of the operating system you are using.

Chapter 5: Setting encryption on the server, explains how to switch on encryption on the server so that you can encrypt communications between the server and the client. The encryption setting must be the same (either on or off) on both server and client.

The Index helps you locate the information you need in this guide quickly and easily.

Page 10: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

x

Document conventions

Notes, tips, and cautions

Throughout this guide the following symbols are used to emphasize important points about the information you are reading:

This is an example of a special note. It indicates further information about the product, or an item that needs particular attention.

This is a tip. It indicates useful advice or recommendations about a particular aspect of the product.

This is a caution. It indicates areas where potential problems might arise, and offers advice on how to avoid or overcome them.

Typefaces

The following typefaces are used throughout this manual:

This typeface represents computer commands, user-entered parameters, or output

This typeface (bold) represents examples or actual values

This typeface (italic) is used for emphasis, cross-references, and variables representing user-controlled values

Page 11: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

xi

Available documentation The available File Archive Service documents are:

File Archive Service Administration Guide

Describes how to run, monitor, and manage the File Archive Service product, and how to manage individual archives.

File Archive Service Getting Started Guide

Describes how to query and import data into the supplied demo archive. Explains how to use the supplied world_facts data to create a new world_facts archive, import data into the archive, and query the archived data.

File Archive Service Glossary

Lists terms and abbreviations that you might encounter when using File Archive Service and its associated documentation, with an explanation for each term or abbreviation.

File Archive Service Installation Guide

Describes how to install and configure File Archive Service in any supported environment.

File Archive Service ODBC/JDBC Setup Guide

Describes how to set up the File Archive Service ODBC and JDBC drivers. (These drivers are only available if you have the appropriate license agreement and corresponding version of File Archive Service.)

File Archive Service Query Guide

Describes how to query the archived data using standard SQL commands.

File Archive Service Remote Storage User Guide

Describes how to configure the remote storage version of File Archive Service as part of a File Archive Service installation. Gives details of the administration commands that are specific to the use of a remote storage device. (This user guide is only available with the remote storage version of File Archive Service.)

File Archive Service Syntax Guide

Gives full details of how to use all the File Archive Service command-line tools.

Page 12: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

xii

File Archive Service Technical Guide

Contains technical information about the structure and internal mechanism of File Archive Service.

File Archive Service Troubleshooting Guide

Provides guidance on how to troubleshoot specific issues that might arise when using File Archive Service. Describes the built-in transactional commit feature that maintains archive integrity in File Archive Service, and gives details of how to recover from different potential error scenarios.

Further documents might become available in future releases of File Archive Service.

Product support The level and type of support you are entitled to for the File Archive Service product depend on your Service Level Agreement and your End User License Agreement. Please refer to those documents for contact details if required.

Page 13: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

xiii

Page 14: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide
Page 15: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

1

Chapter 1: Overview of the ODBC/JDBC drivers

This chapter gives an overview of the ODBC and JDBC drivers, and explains the steps involved in connecting a third-party tool to File Archive Service.

In this chapter

About the ODBC/JDBC drivers ................................................................... page 2

Connecting a third-party tool to File Archive Service ............................. page 3

ODBC/JDBC logging .................................................................................... page 4

Page 16: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

2

About the ODBC/JDBC drivers If you have the appropriate license agreement, the ODBC and JDBC drivers for both Windows and Unix are provided with the File Archive Service distribution.

File Archive Service supports ODBC version 4.0 and JDBC version 3.0.

The ODBC and JDBC drivers have been validated to a maximum statement length of 4MB. Any queries that are longer than this might produce unexpected results.

Page 17: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

3

Connecting a third-party tool to File Archive Service

There are three main steps to connecting a third party analysis tool to File Archive Service and using that tool to query the data in an archive. These steps are:

1. Install the ODBC/JDBC Client.

The method of installation differs depending on whether you are using ODBC or JDBC, and whether you are installing the client under Windows or Unix.

To install and configure the ODBC driver under Windows, see Installing the File Archive Service ODBC Windows driver on page 7.

To install and configure the ODBC driver under Unix, see Installing the File Archive Service ODBC Unix driver on page 35.

To install and configure the JDBC driver under any operating system, see Chapter 4: Installing and configuring the JDBC driver.

2. Configure the data sources.

The configuration method differs depending on whether you are using ODBC or JDBC, and whether you are configuring the data source under Windows or Unix.

To configure the data source using ODBC under Windows, see Configuring the ODBC data source using a DSN on page 10, and Configuring the ODBC data source using a connection string on page 27.

To configure the data source using ODBC under Unix, see Configuring the ODBC data sources on page 38.

To configure the data sources using JDBC under any operating system, see Configuring the JDBC data source using a URL on page 49.

3. Connect the third party analysis tool

When you have installed the relevant driver and configured the data source, you are ready to connect your third-party tool to File Archive Service and submit your SQL queries against the archived data.

Page 18: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

4

ODBC/JDBC logging

ODBC/JDBC log file File Archive Service maintains a separate log file for messages generated from communication between the server and the ODBC or JDBC driver. For details of this log file, see the File Archive Service Administration Guide.

Logging levels The number of messages written to the ODBC/JDBC log file, and the amount of detail they contain, depend on your selected logging level. You configure the logging level by defining a value for the logs odbcLevel entry in the service manager configuration file (sm-config.xml). For full details of this configuration file, see the File Archive Service Installation Guide.

If required, you can make a temporary change to the configured logging level. This change persists only while the service manager is running, or until you change or reset the logging level. For details of the commands you use to check, set, or reset logging levels, see the File Archive Service Syntax Guide.

Page 19: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

5

Chapter 2: Installing and configuring the ODBC Windows driver

This chapter gives detailed instructions for connecting to File Archive Service using the File Archive Service ODBC driver on a Windows client.

In this chapter

About the ODBC Windows driver ............................................................. page 6

Installing the File Archive Service ODBC Windows driver.................... page 7

Configuring the ODBC data source using a DSN .................................. page 10

Configuring the ODBC data source using a connection string ............ page 27

Page 20: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

6

About the ODBC Windows driver To connect a third-party tool running under Windows to File Archive Service, using ODBC, you must first install the File Archive Service ODBC Windows driver.

When you have successfully installed the ODBC driver, you can configure a DSN connection to connect to a specific archive within the File Archive Service data store. You can also add further DSN connections to connect to other archives. To query an archive, you then select the appropriate DSN connection.

When you have connected to a particular archive, you can change the configuration parameters if required. For example, if you need to set or change the selected archive time (and schema) for a point-in-time query, or revert to the current time, you use the Advanced configuration properties. Or if record level management is being used within an archive, and you need to query the archive’s metadata, again you use the Advanced configuration properties.

This chapter describes how to install the ODBC driver and how to configure a DSN connection. The final section explains how to use an alternative method for connecting to the data source using a connection string rather than DSN.

The ODBC and JDBC drivers have been validated to a maximum statement length of 4MB. Any queries that are longer than this might generate an error.

Page 21: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

7

Installing the File Archive Service ODBC Windows driver

Follow the instructions below to install the File Archive Service ODBC driver on a Windows client. To perform the installation, you will need Administrator privileges on the Windows client.

1. Unzip the ODBC zipped folder from the File Archive Service distribution medium to a suitable Windows folder on your computer. The zipped folder name will be one of the following, as appropriate:

RainStor-ODBC-3.0.0.0.Windows.x86 RainStor-ODBC-3.0.0.0.Windows.x86_64

2. Locate the setup.exe file in the unzipped folder. Either double-click the file to run the setup process, or run it from the command prompt.

An initial "Powered by RainStor" splash screen opens briefly, together with a setup preparation dialog box. When the preparation is complete, you see the RainStor ODBC Driver 3.0 Setup dialog.

3. Click the Next button to proceed with the installation.

The Software License Agreement opens. This contains the terms of the Software License Agreement.

4. Read the terms of the license agreement. You can use the Print button to obtain a hard copy. If you accept the Terms and Conditions, click the Yes button.

You must accept the terms of the license agreement in order to install the File Archive Service ODBC driver.

Page 22: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

8

5. Select the installation destination folder.

Figure 1: ODBC Setup – select installation folder dialog

To install the File Archive Service ODBC driver in the default location, click Next.

To install the File Archive Service ODBC driver in a different location, click Browse, navigate to the required folder, and then click Next.

Page 23: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

9

When you have selected the installation directory, the Setup Status dialog displays a progress bar showing how the installation is progressing:

Figure 2: ODBC Setup – Setup Status dialog

When the installation is complete, the InstallShield Wizard Complete dialog opens:

Figure 3: ODBC Setup – InstallShield Wizard Complete dialog

6. Click the Finish button to complete the installation.

Page 24: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

10

Configuring the ODBC data source using a DSN This section explains how to configure the data source using DSN. You use these procedures to do any of the following:

Configure an initial DSN connection (page 10)

Add new DSN connections (page 14)

Change the configured settings for an existing DSN (page 15)

Change the encryption setting for a DSN (page 21)

Set the archive time (and schema) for a point-in-time query (page 22)

Query an archive’s metadata (page 25). (The metadata includes the unique record index, which identifies each individual record, and the current value of the selected metafield.)

Configuring the initial DSN connection When you have completed the installation of the File Archive Service ODBC driver, you can configure the connection to connect to a specific archive. To do this, follow the instructions below.

The instructions given below are for Windows XP. If you have a different version of Windows, please refer to the documentation provided with your operating system to find out how to select System Data Sources.

1. Click the Start button and select Control Panel.

2. Double-click Administrative Tools.

3. Double-click Data Sources (ODBC).

The ODBC Data Source Administrator dialog opens.

4. Select the System DSN tab.

This displays the names of any currently configured System Data Sources.

Page 25: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

11

Figure 4: ODBC Data Source Administrator – System DSN

5. Click the Add… button to add a new DSN.

The Create New Data Source dialog opens.

Scroll down until you see the RainStor 3.0 data source name.

Figure 5: Create New Data Source dialog

Page 26: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

12

6. Click on the RainStor 3.0 data source name, then click the Finish button.

The RainStor ODBC 3.0 DSN Setup dialog opens:

Figure 6: RainStor ODBC 3.0 DSN Setup dialog

This dialog contains various default values.

Page 27: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

13

7. Complete the entries on this dialog. See Table 1 on page 17 for details.

Figure 7: RainStor ODBC 3.0 DSN setup dialog – completed

The completed dialog box looks similar to the one shown in Figure 7 above.

8. Click the Advanced button to do any of the following:

change the data type settings

change the encryption settings

set or change the currently selected archive time

switch on querying of the field metadata

enter custom properties, as directed by Support personnel

See Setting Advanced properties on page 19 for details of these options.

9. Click OK to confirm the setup details and close the RainStor ODBC 3.0 DSN setup dialog.

You return to the ODBC Data Source Administrator dialog.

Page 28: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

14

Figure 8: ODBC Data Source Administrator dialog showing new data source

10. Click OK to confirm the data source settings and close the dialog.

You now have an ODBC connection to an archive. You can use this connection to query that archive using a Business Intelligence tool.

Adding a new DSN data source After you have configured your initial DSN connection, you can add further DSN connections to enable you to connect to different archives. The method for adding these further DSN connections is the same as for adding the initial connection. See Configuring the initial DSN connection on page 10.

Page 29: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

15

Changing the configuration of a DSN The method for changing the configuration of a DSN is similar to adding a new connection. Follow the steps below:

The instructions given below are for Windows XP. If you have a different version of Windows, please refer to the documentation provided with your operating system to find out how to select System Data Sources.

1. Click the Start button and select Control Panel.

2. Double-click Administrative Tools.

3. Double-click Data Sources (ODBC).

The ODBC Data Source Administrator dialog opens.

4. Select the System DSN tab.

This displays the names of the currently configured System Data Sources.

5. Select the data source that you want to amend, then click the Configure… button.

Figure 9: ODBC Data Source Administrator –

System DSN – List of data sources

Page 30: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

16

The RainStor ODBC 3.0 DSN Setup dialog opens, showing the current configuration of the selected data source.

Figure 10: RainStor ODBC 3.0 DSN setup dialog – current configuration

6. Amend the entries on this dialog as required. See Table 1 on page 17 for details.

7. Click the Advanced button to do any of the following:

change the data type settings

change the encryption settings

set or change the currently selected archive time

switch on querying of the field metadata

enter custom properties, as directed by Support personnel

See Setting Advanced properties on page 19 for details of these options.

Page 31: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

17

8. Click OK to confirm the setup details and close the RainStor ODBC 3.0 DSN setup dialog.

You return to the ODBC Data Source Administrator dialog.

9. Click OK to confirm the data source settings and close the dialog.

You can now query the selected archive using the amended configuration values.

Completing the DSN setup dialog When you are setting up a DSN connection or amending the connection parameters of an existing connection, you complete various entry fields on the dialog. These are described in Table 1 below.

Table 1: DSN setup dialog entries

Field Description

DSN properties

DataSource Name Enter a suitable name for your selected DSN connection. This identifies the ODBC connection and archive.

If you are changing the configuration values for an existing connection, you cannot change the data source name.

Description Enter a suitable description for the selected DSN connection.

Connection properties

Server Enter either the IP address or the server name of the server on which the File Archive Service service manager is running.

If you enter a server name, this is resolved via DNS into an IP address at runtime.

Port Enter the configured ODBC port number for the service manager.

Page 32: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

18

Field Description

User Name Enter a valid File Archive Service user name. For example: wfadmin. This enables you to connect to a running File Archive Service service manager.

The selected user name must have the relevant role or roles (query or qpit) for querying the selected archive.

Password Enter the password associated with the File Archive Service user name. For example: wfadmin.

SQL Parser Select the SQL parser you want to use for the queries. This can be one of:

Oracle

SQL92 (the default)

SQLServer

The parser you select enables you to use different variations of SQL in your queries. See the File Archive Service Query Guide for details.

To populate the list of archives on the selected server, click the Update button. This tests the connection properties and retrieves the list of archives. The list includes only those archives that are valid for the selected user name.

If a connection is successfully established, the list of archives is populated.

If the connection fails, you see a DSN Configuration Error popup. If this happens, check that a service manager is running on the selected server, and that the Server address, Port number, User Name, and Password are all correct. Make any necessary changes and then try the update again.

Archive Once the list of archives has been populated, select the archive you want to query. The archives are listed alphabetically, so if the first archive is not the one you want, use the drop-down list to locate the relevant archive.

There is a limit to the number of archives that can be displayed in the list. If you do not see the archive you want, or you do not want to display a long drop-down list of archives, you can enter the archive name into the box manually.

Page 33: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

19

Setting Advanced properties If you want to change any of the advanced DSN connection properties, you need to make the changes on the Advanced properties dialog, shown below.

Figure 11: Advanced ODBC 3.0 properties

To access this dialog, click on the Advanced… button on the RainStor ODBC 3.0 DSN setup dialog. This enables you to change any of the items listed below:

Data type properties

SSL encryption option and certificate file

Archive time (and schema)

Custom properties – This enables you to configure additional connection options, such as switching on querying of an archive’s field metadata

See the relevant subsection below for details.

Page 34: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

20

Setting the data type properties

There are four fields relating to data type handling. You complete these as described in Table 2 below.

Table 2: DSN setup advanced entries – Data types

Field Description

Data Type Properties

Metadata on prepare Select this check box if you want the data types to be returned initially without the data.

We recommend that you only use this option when requested to do so by Support personnel. Note, however, that some BI tools require this option to be switched on.

Describe WCHAR as CHAR

If your BI tool does not recognize the WCHAR data type, you can request that WCHAR types are returned as CHAR types instead. To do this, select this check box.

Describe VARCHAR as LONGVARCHAR

This field allows you to stream VARCHAR data types as LONGVARCHARs if they are greater than a specified value. To do this, enter the relevant value (in bytes).

Describe VARBINARY as LONGVARBINARY

This field allows you to stream VARBINARY data types as LONGVARBINARYs if they are greater than a specified value. To do this, enter the relevant value (in bytes).

Page 35: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

21

Setting encryption properties

There are two fields relating to setting encryption on the client. You complete these as described in Table 3 below.

Table 3: DSN setup advanced entries – SSL Certificate File properties

Field Description

SSL Certificate File

Use SSL data encryption Select this check box if you want data to be encrypted when it is sent via your ODBC connection. If you leave this box unchecked, the data is sent unencrypted.

SSL Certificate File The certificate file specified here holds the encryption key that will be used for encrypting the data. This defaults to the encryption file in the ODBC driver installation directory.

The SSL certificate file supplied with the ODBC driver is the standard file supplied by Simba. For security, we strongly recommend that you use your own SSL certificate file.

To use encryption, you must switch it on for both the client and the server. The setting here switches on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Setting encryption on the server.

Page 36: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

22

Setting the archive time via DSN

If you want to set or change the archive time for a point-in-time query, follow the steps below:

1. To set the Archive time, click the Enable check box if not already selected.

Figure 12: Advanced ODBC 3.0 properties dialog – enabling archive time

2. There are two ways in which you can change the archive time. You can either use the arrow keys on your keyboard to change each component of the archive time individually, or you can use the date selector to select the date, and then change the time components individually. See below.

Using the arrow keys:

This is the recommended way to change the archive time.

a. Click on the year component of the date:

Figure 13: Setting the archive time – selecting the year

b. Press the down-arrow or up-arrow key on your keyboard to decrease or increase the currently selected year.

c. Press the right-arrow key to move to the next component of the archive time.

Page 37: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

23

d. Press the down-arrow or up-arrow key on your keyboard to decrease or increase the value of the currently selected component of the archive time.

e. Repeat steps c and d until you have set all components of the archive time to the required value.

Figure 14: Setting the archive time – all elements set

Using the date selector:

You can use the supplied date selector to set the date portion of the archive time.

a. Click the down-arrow to the right of the Archive time to display the date selector.

b. Select the required archive date. Use the left-arrow and right-arrow buttons on the date selector to select an earlier or later month (and year). When the required month and year are displayed, click on the required date.

Figure 15: Setting the archive time –using the date selector

Page 38: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

24

You can also:

click on the month name at the top of the date selector to display a list of months, then select the required month from the list

click on the year at the top of the date selector, and use the scroll buttons to increase or decrease the year number

click on the current date at the bottom of the date selector to select today's date

c. Click on the hour component of the archive time.

d. Use the arrow keys on your keyboard to select the required hours, minutes, and seconds, as described for Using the arrow keys above.

The archive time is in the format HH:mm:ss. No local time offset is applied to an archive time submitted to the query engine via an ODBC connection, so you must enter the time in universal time (UTC). See the appendix on Logical time in the File Archive Service Administration Guide.

The selected archive time remains in place for this DSN until you select a different archive time. So if you want to revert to the current archive time and schema, you will have to reselect the Advanced properties and make the required change. This setting does not affect other DSN connections.

A quick way to revert a previously set archive time to the current date and time is to deselect the Enable check box, then click OK to confirm the change. This closes the Advanced properties dialog box. Click on the Advanced button again to reopen the dialog box. The archive time has been reset to the current date and time.

3. To use the version of the schema that was in place at the selected archive time, select the And Schema check box, as shown in Figure 16. To use the current schema in your point-in-time query, deselect the And Schema check box. This check box is selected by default when you enable the archive time.

Figure 16: Advanced ODBC 3.0 properties dialog – selecting the schema

Page 39: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

25

Supplying custom properties

If record level management is being used within an archive, you can use the Custom Properties box on the Advanced dialog to switch on querying of the archive's field metadata for the selected DSN connection. You can also use the custom properties to enter an advanced query option under instruction from Support personnel.

To enable access to the metadata, you enter:

addFieldMetadata+true

Note that the previous drivers used a question mark (?) to denote equality in the custom properties, but the replacement drivers require a plus sign (+) instead. See the example below.

For example:

Figure 17: Enabling access to metadata

You can query the following metafields:

unique_record_index

expiry_date

legal_hold

record_tag

<user_tag> (user-defined tag field – up to 10 per archive)

Page 40: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

26

Confirming the advanced settings

When you have made the required changes to the Advanced settings, confirm the new settings as described below:

1. Click OK to confirm your selections and close the Advanced dialog box.

2. Click OK on the RainStor ODBC 3.0 DSN setup dialog box to confirm the settings.

3. Click OK on the ODBC Data Source Administrator – System Data Sources dialog.

Page 41: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

27

Configuring the ODBC data source using a connection string

As an alternative to using DSN to connect to ODBC under Windows, you can use a connection string. To use a connection string, you must first install the File Archive Service ODBC driver, as explained in Installing the File Archive Service ODBC Windows driver on page 7.

Once you have installed the ODBC driver, you can set up a connection string to connect to a data source (archive). The connection string can contain various elements, as described in Table 4 below. Each element is in the format <element>=<value>, and individual elements are separated by a semi-colon (;):

Table 4: Windows ODBC connection string elements

Connection string element

Description

The following elements are mandatory:

Driver Name of the ODBC driver. This is RainStor 3.0.

For example:

Driver=RainStor 3.0

ServerIP The IP address of the server on which the service manager is running. See the File Archive Service Installation Guide for details.

For example:

ServerIP=10.0.0.20

ServerPort The port number of the ODBC server. See the File Archive Service Installation Guide for details.

For example:

ServerPort=3731

Page 42: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

28

Connection string element

Description

UID The user name required to connect to the File Archive Service service manager. This must be a valid File Archive Service user name with the relevant role or roles (query or qpit) for querying the selected archive.

For example:

UID=wfadmin

PWD The password required to connect to the File Archive Service service manager. This must be the correct password for the selected File Archive Service user name.

For example:

PWD=wfadmin

UseSsl Controls whether data is encrypted or not. Can be:

0 (Data not encrypted – the default)

1 (Data encrypted)

For example:

UseSsl=1

If you include the connection string element UseSsl=1, you must also include the path to the SSL certificate file. See below.

SslCertFile Only relevant if the connection string includes the element and value UseSsl=1. Contains the path to the SSL certificate file that specifies how to encrypt communications with the service manager.

For example:

SslCertFile=C:\Program Files\RainStor\ RainStor ODBC 3.0\SSLCertificates\ SimbaCACertificate.pem

Page 43: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

29

Connection string element

Description

The SSL certificate file supplied with the ODBC driver is the standard file supplied by Simba. For security, we strongly recommend that you use your own SSL certificate file.

To use encryption, you must switch it on for both the client and the server. The settings in the connection string switches on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Setting encryption on the server.

Archive The name of the archive that you want to connect to.

For example:

Archive=world_facts

Parser The SQL parser that you want to use for the queries. This can be one of:

ORACLE

SQL92 (the default)

SQLSERVER

For example:

Parser=SQLSERVER

The parser you choose enables you to use different variations of SQL. See the File Archive Service Query Guide for details.

To switch on querying of the field metadata, you include the following switch with the selected parser:

|addFieldMetadata+true

For example:

Parser=SQL92|addFieldMetadata+true

Note that the previous drivers used a question mark (?) with the addFieldMetadata switch, but the replacement drivers require a plus sign (+) instead. See the example above.

Page 44: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

30

Connection string element

Description

The following additional connection string elements are optional:

EnableArchiveTime Controls whether point-in-time queries are allowed or not. Can be:

0 (Archive time not enabled)

1 (Archive time enabled)

For example:

EnableArchiveTime=1

ArchiveTime Sets the archive time for point-in-time queries, so only relevant if archive time is enabled (see EnableArchiveTime above).

Enter the archive time in the format yyyy-MM-dd hh:mm:ss. This time must be in UTC, as the ODBC server does not support a timezone offset.

For example:

EnableArchiveTime=1;ArchiveTime= 2009-10-31 23:59:59

AndSchema Sets the schema for point-in-time queries, so only relevant if archive time is enabled (see EnableArchiveTime above). Only valid when ArchiveTime is set.

Can be:

0 (Use current schema)

1 (Use schema as at archive time)

For example:

EnableArchiveTime=1;ArchiveTime= 2010-11-30 23:59:59;AndSchema=1;

Page 45: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

31

Connection string element

Description

PrepareMetadata Include this element if you want the data types to be returned initially without the data.

For example:

PrepareMetadata=1;

We recommend that you only include this element if requested to do so by Support personnel. Note, however, that some BI tools require this element to be included.

DescribeWcharAsChar If your BI tool does not recognize the WCHAR data type, you can request that WCHAR types are returned as CHAR types instead. To do this, set this element to 1.

For example:

DescribeWcharAsChar=1;

DescribeVarcharAs Longvarchar

Enables you to stream VARCHAR data types as LONGVARCHARs if they are greater than the specified value. To do this, specify the relevant value in bytes.

For example:

DescribeVarcharAsLongvarchar=4096;

DescribeVarbinaryAs Longvarbinary

Enables you to stream VARBINARY data types as LONGVARBINARYs if they are greater than the specified value. To do this, specify the relevant value in bytes.

For example:

DescribeVarbinaryAsLongvarbinary=4096;

Page 46: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

32

Example:

Below is an example of an ODBC connection string that includes the metadata query switch and data type settings:

Driver=RainStor 3.0;ServerIP=10.0.0.20;ServerPort=3731; UID=wfadmin;PWD=wfadmin;UseSsl=1;SslCertFile=C:\Program Files\RainStor\RainStor ODBC 3.0\SSLCertificates\ SimbaCACertificate.pem;Archive=world_facts; Parser=SQL92|addFieldMetadata+true;DescribeWcharAsChar=1; DescribeVarcharAsLongvarchar=4096;

Setting the archive time via a connection string To set or change the archive time, and select whether or not you want to use the current schema or the version of the schema that was in place at the selected archive time, you supply relevant values for the connection string elements listed below:

EnableArchiveTime

ArchiveTime

andSchema

See the previous page for details.

Example:

Below is an example of an ODBC connection string configured for a point-in-time query. In this example, the selected archive time is 2009-11-30 23:59:59, and the query results are based on the schema that was in place as that time:

Driver=RainStor 3.0;ServerIP=10.0.0.20;ServerPort=3731; UID=wfadmin;PWD=wfadmin;Archive=world_facts; Parser=SQL92|addFieldMetadata+true;EnableArchiveTime=1; ArchiveTime=2009-11-30 23:59:59;andSchema=1;

Page 47: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

33

Chapter 3: Installing and configuring the ODBC Unix driver

This chapter gives instructions for installing and configuring the File Archive Service ODBC driver under any supported Unix operating system.

In this chapter

About the ODBC Unix driver .................................................................... page 34

Installing the File Archive Service ODBC Unix driver .......................... page 35

Configuring the ODBC data sources ........................................................ page 38

Page 48: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

34

About the ODBC Unix driver The ODBC Unix driver installation script allows you to select either the 32-bit or the 64-bit drivers, as appropriate. However, you need to choose the correct pair of installation files for the operating system that you are using. You can use the relevant driver to connect to your archives from a BI tool running on Unix.

For each driver, the installation includes a pair of files. Table 5 below shows the script and tar file names relevant to each supported operating system.

Table 5: Unix driver file names

Operating System Script & tar file

Linux RainStor-ODBC.3.0.0.0.Linux.x86.sh RainStor-ODBC.3.0.0.0.Linux.x86.tar

Solaris RainStor-ODBC.3.0.0.0.Solaris.sparc.sh RainStor-ODBC.3.0.0.0.Solaris.sparc.tar

AIX RainStor-ODBC.3.0.0.0.AIX.powerpc.sh RainStor-ODBC.3.0.0.0.AIX.powerpc.tar

HP-UX RainStor-ODBC.3.0.0.0.HP-UX.ia64.sh RainStor-ODBC.3.0.0.0.HP-UX.ia64.tar

To start the driver installation, copy the relevant pair of files to a suitable directory on your Unix system.

The ODBC and JDBC drivers have been validated to a maximum statement length of 4MB. Any queries that are longer than this might generate an error.

The AIX ODBC driver version 3.0.0.0 requires the following runtime libraries:

libgcc_s.a

libstdc++.a

You can download the relevant version of the libraries from the same FTP location as the main File Archive Service installation files. After completing the installation, copy the library into the lib64 directory of the installation. Make sure you copy the version of the library appropriate for your target architecture and operating system.

The libgcc source code is available on the File Archive Service FTP site. A URL can be provided on request.

Page 49: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

35

Installing the File Archive Service ODBC Unix driver

Follow the steps below to install the relevant ODBC Unix driver:

1. As described in the previous section, copy the relevant pair of installation files (.sh and .tar) to a suitable directory on your Unix system.

2. Make sure the .sh file is executable:

chmod +x RainStor-ODBC.3.0.0.0.<version_name>.sh

For example:

chmod +x RainStor-ODBC.3.0.0.0.Linux.x86_64.sh

3. Run the installer:

./RainStor-ODBC.3.0.0.0.<version_name>.sh

For example:

./RainStor-ODBC.3.0.0.0.Linux.x86.sh

4. The license agreement is displayed, followed by the prompt:

Do you agree to the above terms and conditions? [y/n]:

Enter y to accept the terms and conditions. (If you enter n, the installation terminates.)

The following text is displayed:

**************************************************** **************************************************** RainStor ODBC Installation logging to /tmp/RainStorODBC-<datetime>

5. The next prompt asks you to choose the installation directory:

Please enter the destination directory (default = ./):

Press <Enter> to install the driver in the default directory, otherwise supply the full path to a different installation directory.

Page 50: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

36

When you select the destination directory, the .tar file is unpacked into a directory called RainStor-ODBC-3 within the destination directory and the following message is displayed:

Extracting RainStor ODBC...

6. If your installation package includes both 32-bit and 64-bit drivers, you see a prompt asking which "bit-ness" version of the driver you want to install:

Do you want to install 32-bit or 64-bit Driver? 1) 32-bit 2) 64-bit enter line no: 2

Choose either 1 or 2, as appropriate.

This prompt is bypassed if your installation includes only a single "bit-ness" driver.

7. The next prompt asks you to choose the Driver Manager that you want to use. You see the following prompt:

Which Driver Manager do you want to use? 1) SimbaDM 2) iODBC 3) unixODBC enter line no: 1

Option 1 (SimbaDM) is the driver manager that is included with the installation package, but you can choose a different option if one of the other driver managers is available to you.

The following message is displayed:

Installation of RainStor ODBC is Complete. To use the ODBC driver you will need to source the following from your shell:- <destination_directory>/RainStor-ODBC-3/odbc.sh

<destination_directory> is the directory you selected as the installation directory. For example, if your installation directory was:

/home/rsodbc/

you would see the message:

Installation of RainStor ODBC is Complete. To use the ODBC driver you will need to source the following from your shell:- /home/rsodbc/RainStor-ODBC-3/odbc.sh

Page 51: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

37

8. As indicated in the displayed message, in order to use the driver you need to source the indicated ODBC file. To source the file, enter:

. <file_path>

For example:

. /home/rsodbc/RainStor-ODBC-3/odbc.sh

9. Before you use the newly installed driver, you need to configure the data sources that you want to access. See Configuring the ODBC data sources on page 38.

Installation directory contents When you install the ODBC driver, this creates the following directory within the selected destination directory:

RainStor-ODBC-3

This directory contains various subdirectories, plus the following .ini files:

odbc.ini You will need to edit this file to include a section for each data source. See Configuring the ODBC data sources on page 38.

odbcinst.ini Contains the path to the driver. You should not need to change the contents of this file.

simba.ini Contains some values used by the driver. You should not need to change the contents of this file.

Page 52: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

38

Configuring the ODBC data sources When you have installed the ODBC Unix driver, you need to configure each data source (archive) that you want to query. To do this, you add the name of the data source to the section at the top of the odbc.ini file, and then you include a section for that data source within the same file.

The installed odbc.ini file contains a sample data source section with values that you need to supply indicated by square brackets. For example:

[RAINSTOR_SERVER_IP]

You need to replace the square brackets and their contents with the appropriate value. For example, you could replace [RAINSTOR_SERVER_IP] with 10.0.0.20.

To configure the ODBC data sources, follow the steps below:

1. Change to the RainStor-ODBC-3 ODBC driver directory within the destination directory you selected when you installed the driver.

cd RainStor-ODBC-3

2. Locate the following file in this directory:

odbc.ini

Page 53: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

39

Figure 18 below shows the default contents of this file:

[ODBC Data Sources] SampleDataSource=RainStor 3.0 [SampleDataSource] DRIVER=/home/rsodbc/RainStor-ODBC-3/lib64/libSimbaClient.so ; RainStor server settings ServerIP=[RAINSTOR_SERVER_IP] ServerPort=[RAINSTOR_SERVER_PORT] Archive=[RAINSTOR_ARCHIVE] UID=[RAINSTOR_USER] PWD=[RAINSTOR_PASSWORD] Description=A sample data source using the RainStor 3 driver. ; Query options Parser=SQL92 EnableArchiveTime=0 AndSchema=1 ; SSL options UseSsl=0 SSLCertFile=/home/rsodbc/RainStor-ODBC-3/resources/ SSLCertificates/SimbaCACertificate.pem ; Logging options EnableLogging=0 LogDirectory=/home/rsodbc/RainStor-ODBC-3/logs LogNamespace=Simba LogLevel=LOG_OFF LogMilliseconds=1 LogThreadId=1 ; Driver options ServerTimeout=3600000 RowFetchSize=1000 PushedParamCacheSize=8192 DriverUnicodeEncoding=2 IANAAppCodePage=106

Figure 18: Default contents of an odbc.ini file

The items shown in blue are the items that you need to supply values for. Other entries in this file contain default values, so you only need to change them if you want to use a different value. And other entries are not present in the sample data source section, but you will need to add them if you want to use non-default values for those items.

3. Using an editor of your choice, edit the contents of the odbc.ini file. Table 6 below gives details of all the possible entries that you can supply for a data source.

You need to edit the data source details in this file whenever you want to set the archive time for a point-in-time query.

Page 54: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

40

Table 6: Configuring the .ini file contents

Entry Required value

[ODBC Data Sources] In this section you need an entry for each data source name that you want to use. For example, you could set up the following data source names:

wf1p3731=RainStor 3.0 wf2p3734=RainStor 3.0 gd1p3731=RainStor 3.0 gd2p3732=RainStor 3.0

The entry to the left of the equals sign (=) is the data source name. The entry to the right of the equals sign is the name of the ODBC driver that you want to use. This is RainStor 3.0. For each data source name that you specify here, you need to include a data source name section within the odbc.ini file. The contents of the data source name section are described below.

[SampleDataSource] You need one of these sections for each data source name that you have specified in the [ODBC Data Sources] section at the top of the file.

Replace the SampleDataSource text at the top of the sample section with the data source name you are using. Then complete the relevant details for that data source. When you have completed the first section, you can copy and paste that section and simply change the values for any items that are different.

Using the example data source names above, you would need the following sections:

[wf1p3731] [wf2p3734] [gd1p3731] [gd2p3732]

The remaining details below apply to the contents of each named data source section.

DRIVER Path to the ODBC driver. You should not need to change the value of this entry.

RainStor server settings:

ServerIP The IP address of the server on which the service manager is running. For example:

ServerIP=10.0.0.20

Default IP address is 127.0.0.1.

Page 55: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

41

Entry Required value

ServerPort The configured port number of the ODBC server. For example:

ServerPort=3731

Default port number is 3731.

Archive The name of the archive that you want to connect to. For example:

Archive=world_facts

UID The File Archive Service user name that you are using to access the archive. The selected user must have query rights on the archive. For example:

UID=wfadmin

PWD The password associated with the selected user name. For example:

PWD=wfadmin

Description An optional description that you can use to identify the correct data source name within the .ini file.

Query options:

Parser The SQL parser that you want to use for your queries. Can be:

ORACLE

SQL92 (the default)

SQLSERVER

For example: Parser=SQLSERVER

The parser you choose enables you to use different variations of SQL. See the File Archive Service Query Guide for details.

To switch on querying of the archive's field metadata, you include the following switch with the selected parser: |addFieldMetadata+true

For example: Parser=ORACLE|addFieldMetadata+true

Note that the previous drivers used a question mark (?) with the addFieldMetadata switch, but the replacement drivers require a plus sign (+) instead. See the example above.

Page 56: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

42

Entry Required value

EnableArchiveTime Controls whether point-in-time queries are allowed or not. Can be:

0 (Archive time not enabled)

1 (Archive time enabled)

For example: EnableArchiveTime=1

ArchiveTime Sets the archive time for point-in-time queries, so only relevant if archive time is enabled (see EnableArchiveTime above).

Enter the archive time in the format yyyy-MM-dd hh:mm:ss. This time must be in UTC, as the ODBC server does not support a timezone offset.

For example: EnableArchiveTime=1 ArchiveTime=2010-11-30 23:59:59

This entry is not present by default in the sample data source section.

AndSchema Sets the schema for point-in-time queries, so only relevant if archive time is enabled (see EnableArchiveTime above). Only valid when ArchiveTime is set.

Can be:

0 (Use current schema)

1 (Use schema as at archive time)

For example: EnableArchiveTime=1 ArchiveTime=2010-11-30 23:59:59 AndSchema=0

SSL options:

UseSsl Controls whether data is encrypted or not when sent via your ODBC connection. Can be:

0 (Data not encrypted)

1 (Data encrypted)

For example: UseSsl=1

Page 57: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

43

Entry Required value

To use encryption, you must switch it on for both the client and the server. The settings in the .ini file switch on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Setting encryption on the server.

SSLCertFile The path to the certificate file containing the encryption key that will be used for encrypting communications with the service manager. This defaults to the encryption file in the ODBC driver installation directory. For example:

SSLCertFile=/home/rsodbc/RainStor-ODBC-3/ resources/SSLCertificates/

The SSL certificate file supplied with the ODBC driver is the standard file supplied by Simba. For security, we strongly recommend that you use your own SSL certificate file.

Logging options:

EnableLogging Controls whether messages are logged between the client and ODBC. Can be:

0 (Logging not enabled – the default)

1 (Logging enabled)

For example: EnableLogging=1

LogDirectory The path to the logs directory. Defaults to the logs directory within the installation directory. For example:

LogDirectory=/home/rsodbc/RainStor-ODBC-3/ logs

LogNameSpace Name associated with the log messages. Defaults to: LogNameSpace=Simba

LogLevel Controls the level of log messages that will be generated. Can be one of:

LOG_OFF LOG_FATAL LOG_ERROR LOG_WARNING LOG_INFO LOG_DEBUG LOG_TRACE

For example: LogLevel=LOG_WARNING

Page 58: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

44

Entry Required value

LogMilliseconds Controls whether log messages are recorded to the nearest millisecond or only to the nearest second. Can be:

0 (Record log messages to nearest second)

1 (Record log messages to nearest millisecond – the default)

For example: LogMilliseconds=1

LogThreadId Controls whether log messages are separated by thread ID. Used for debugging. Can be:

0 (Do not separate log messages by thread ID)

1 (Separate log messages by thread ID – the default)

For example: LogThreadId=1

Driver options:

ServerTimeout The time, in milliseconds, to wait for a response before timing out. The default is 3600000 ms (one hour). For example:

ServerTimeout=3600000

RowFetchSize The number of rows to return with each ODBC request. The default is 1000. For example:

RowFetchSize=1000

PushedParamCacheSize Controls the amount of data to cache before sending a message. The default value is 8192. For example:

PushedParamCacheSize=8192

This is an advanced option that you should not need to change.

DriverUnicodeEncoding The encoding you are using for submitting queries and retrieving results. Valid values are:

1 (UTF-16)

2 (UTF-8 – the default/recommended)

3 (UTF-32)

For example: DriverUnicodeEncoding=2

Page 59: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

45

Entry Required value

IANAAppCodePage The underlying code page used by the driver. The default value is 106. You should not need to change this value. For example:

IANAAppCodePage=106

Data type options:

PrepareMetadata Include this element if you want the data types to be returned initially without the data. For example:

PrepareMetadata=1

We recommend that you only include this element if requested to do so by Support personnel. Note, however, that some BI tools require this element to be included.

DescribeWcharAsChar If your BI tool does not recognize the WCHAR data type, you can request that WCHAR types are returned as CHAR types instead. To do this, set this element to 1. For example:

DescribeWcharAsChar=1

DescribeVarcharAs Longvarchar

Enables you to stream VARCHAR data types as LONGVARCHARs if they are greater than the specified value. To do this, specify the relevant value in bytes. For example:

DescribeVarcharAsLongvarchar=4096

DescribeVarbinaryAs Longvarbinary

Enables you to stream VARBINARY data types as LONGVARBINARYs if they are greater than the specified value. To do this, specify the relevant value in bytes. For example:

DescribeVarbinaryAsLongvarbinary=4096

Page 60: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

46

Figure 19 shows an example odbc.ini file with one data source defined:

[ODBC Data Sources] wf1p3731=RainStor 3.0 [wf1p3731] DRIVER=/home/rsodbc/RainStor-ODBC-3/lib64/libSimbaClient.so ; RainStor server settings ServerIP=10.0.0.20 ServerPort=3731 Archive=world_facts UID=wfadmin PWD=wfadmin Description=world_facts archive on port 3731. ; Query options Parser=SQL92|addFieldMetadata+true EnableArchiveTime=1 AndSchema=1 ArchiveTime=2010-11-30 23:59:59 ; SSL options UseSsl=0 SSLCertFile=/home/rsodbc/RainStor-ODBC-3/resources/SSLCertificates/ SimbaCACertificate.pem ; Logging options EnableLogging=0 LogDirectory=/home/rsodbc/RainStor-ODBC-3/logs LogNamespace=Simba LogLevel=LOG_WARNING LogMilliseconds=1 LogThreadId=1 ; Driver options ServerTimeout=3600000 RowFetchSize=1000 PushedParamCacheSize=8192 DriverUnicodeEncoding=2 IANAAppCodePage=106 ; Data type options PrepareMetadata=1 DescribeWcharAsChar=1 DescribeVarcharAsLongvarchar=4096 DescribeVarbinaryAsLongvarbinary=4096

Figure 19: Default contents of an odbc64.ini file

Page 61: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

47

Chapter 4: Installing and configuring the JDBC driver

This chapter gives instructions for installing and configuring the File Archive Service JDBC driver. These instructions are the same regardless of the operating system you are using.

In this chapter

Introduction ................................................................................................. page 48

About the jar file .......................................................................................... page 48

Configuring the JDBC data source using a URL .................................... page 49

Page 62: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

48

Introduction To connect a third-party tool to File Archive Service using JDBC, all you need to do is copy the File Archive Service .jar file to a known location on the computer on which you want to run the Java query application. Then, when you run the Java query application, you include the .jar file on the classpath of that application. You also supply the driver class to use.

When you have included the .jar file on the classpath, and supplied the driver class, you connect to the relevant archive using an appropriate connection string.

The ODBC and JDBC drivers have been validated to a maximum statement length of 4MB. Any queries that are longer than this might generate an error.

About the jar file The File Archive Service installation includes a .jar file that enables you to query the archived data using a Java query application via JDBC. These .jar file is:

RainStorJDBC.jar

Copy this file to a suitable location on your computer. Then, when you run your Java query application, you include the .jar file on the application’s classpath.

You also need to supply the driver class to the application. The driver class is:

com.simba.client.core.SimbaJDBCDriver

When you have supplied this information, you use a suitable connection string to connect to the archive via JDBC. To change the configuration details, you change the relevant elements of the connection string. For example, you can set or change the selected archive time (and schema) for a point-in-time query.

Page 63: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

49

Configuring the JDBC data source using a URL When you have supplied your query application with the relevant classpath and class information, you need to connect to the archive that you want to query. To do this, you use a JDBC URL. The way you use this URL depends on the application you are using to query the archive.

Connection string elements The JDBC URL connection string can include the following elements:

Connection string element

Description

The following elements are mandatory:

jdbc:simba: This must be the first entry in the connection string. It defines the server and port that you want to connect to. For example:

jdbc:simba://10.0.0.20:3731

UID The user name required to connect to the File Archive Service service manager. This must be a valid File Archive Service user name with the relevant role or roles (query or qpit) for querying the selected archive. For example:

UID=wfadmin

PWD The password required to connect to the File Archive Service service manager. This must be the correct password for the selected File Archive Service user. For example:

PWD=wfadmin

Page 64: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

50

Connection string element

Description

UseSsl This is an optional element. It controls whether data is encrypted or not. Can be:

0 (Data not encrypted – the default)

1 (Data encrypted)

For example:

UseSsl=1

To use encryption, you must also supply the TrustedStorePath and TrustedStorePassword connection string elements. See below.

TrustedStorePath If you have included the connection string element and value UseSsl=1, you must also include the TrustedStorePath. This is the path used by Java to store the SSL certificates.

For example:

TrustedStorePath=/home/rsjdbc/tspath

TrustedStorePassword If you have included the connection string element and value UseSsl=1, you must also include the TrustedStorePassword. This is the password required to access the trusted store path.

For example:

TrustedStorePassword=Jtspass1

The SSL certificate file supplied with the JDBC driver is the standard file supplied by Simba. For security, we strongly recommend that you use your own SSL certificate file.

To use encryption, you must switch it on for both the client and the server. The settings in the connection string switch on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Setting encryption on the server.

Page 65: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

51

Connection string element

Description

Custom properties

You enter the remaining parameters within parentheses, separated by semi-colons.

Archive The name of the archive that you want to connect to.

For example:

Archive=world_facts

Parser Defines the SQL parser you want to use for the queries. This can be one of:

ORACLE

SQL92 (the default)

SQLSERVER

The parser you choose enables you to use different variations of SQL. See the File Archive Service Query Guide for details.

For example:

Parser=SQL92

If you want to switch on querying of the archive's field metadata, you can include the following switch with the selected parser:

|addFieldMetadata+true

For example:

Parser=SQL92|addFieldMetadata+true

Note that the previous drivers used a question mark (?) with the addFieldMetadata switch, but the replacement drivers require a plus sign (+) instead. See the example above.

Page 66: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

52

Connection string element

Description

EnableArchiveTime Controls whether point-in-time queries are allowed or not. Can be:

0 (Archive time not enabled)

1 (Archive time enabled)

For example:

EnableArchiveTime=1

ArchiveTime Sets the archive time for point-in-time queries, so only relevant if archive time is enabled (see EnableArchiveTime above).

Enter the archive time in the format yyyy-MM-dd hh:mm:ss. This time must be in UTC, as the JDBC server does not support a timezone offset. For example:

ArchiveTime=2010-11-30 23:59:59

AndSchema Sets the schema for point-in-time queries. Only valid when ArchiveTime is set. Can be:

0 (Use current schema)

1 (Use schema as at archive time)

For example:

AndSchema=0

PrepareMetadata Include this element if you want the data types to be returned initially without the data.

For example:

PrepareMetadata=1

We recommend that you only include this element if requested to do so by Support personnel. Note, however, that some BI tools require this element to be included.

Page 67: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

53

Connection string element

Description

DescribeWchar AsChar

If your BI tool does not recognize the WCHAR data type, you can request that WCHAR types are returned as CHAR types instead. To do this, set this element to 1.

For example:

DescribeWcharAsChar=1

DescribeVarchar AsLongvarchar

Enables you to stream VARCHAR data types as LONGVARCHARs if they are greater than the specified value. To do this, specify the relevant value in bytes.

For example:

DescribeVarcharAsLongvarchar=4096

DescribeVarbinaryAs Longvarbinary

Enables you to stream VARBINARY data types as LONGVARBINARYs if they are greater than the specified value. To do this, specify the relevant value in bytes.

For example:

DescribeVarbinaryAsLongvarbinary=4096

Example:

Below is an example of a JDBC URL connection string that includes the metadata query switch:

jdbc:simba://10.0.0.20:3731;UID=wfadmin;PWD=wfadmin; UseSsl=1;TrustedStorePath=/home/rsjdbc/tspath; TrustedStorePassword=Jtspass1;Archive=world_facts; Parser=SQL92|addFieldMetadata+true;DescribeWcharAsChar=1; DescribeVarcharAsLongvarchar=4096;

Page 68: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

54

Setting the archive time via a JDBC URL To set or change the archive time, and select whether or not you want to use the current schema or the version of the schema that was in place at the selected archive time, you supply relevant values for the connection string elements listed below:

EnableArchiveTime

ArchiveTime

AndSchema

See the previous page for details.

Example:

Below is an example of a JDBC URL connection string configured for a point-in-time query. In this example, the selected archive time is 2007-10-01 01:00:00, and the query results will be based on the schema that was in place at that time.

jdbc:simba://10.0.0.20:3731;UID=wfadmin;PWD=wfadmin; UseSsl=1;TrustedStorePath=/home/rsjdbc/tspath; TrustedStorePassword=Jtspass1;Archive=world_facts; Parser=SQL92|addFieldMetadata+true;EnableArchiveTime=1; ArchiveTime=2010-11-30 23:59:59;AndSchema=1;

Page 69: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

55

Chapter 5: Setting encryption on the server

This chapter explains how to switch on encryption on the server so that you can encrypt communications between the server and the client. The encryption setting must be the same (either on or off) on both server and client.

In this chapter:

Introduction ................................................................................................. page 56

Changing the server encryption setting .................................................. page 57

Page 70: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

56

Introduction File Archive Service supports SSL encryption between client and server. To use encryption, you must enable it on both the server and the client. Similarly, to switch off encryption, you must switch it off on both the server and the client. The encryption setting on the client and the server must always be the same.

This chapter explains how to change the encryption setting on the server.

Page 71: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

57

Changing the server encryption setting When you install File Archive Service, by default encryption is switched off. When you want to use an external BI tool to query the contents of an archive, you can choose to use encryption for greater security . To use encryption on the client, you must use encryption on the server.

We recommend that you stop the service manager before changing the encryption settings, then restart it when you have made the change.

Follow the steps below to change the encryption setting on the server:

1. Stop the service manager:

npa_stop_sm –S<server> -p<port> -U<username> -P<password>

2. Navigate to the following directory:

NParchive-dist/conf

3. Locate the service manager configuration file:

sm-config.xml

4. Using an editor of your choice, edit the file and locate the odbc tag:

<odbc hostname="10.0.0.20" port="3731" />

5. Add the following attributes and values to the tag:

sslKeyFile="<path_to_SSL_key_file>" sslCertFile="<path_to_SSL_certificate_file>"

The sslKeyFile attribute should contain the path to the file containing the private encryption key associated with the certificate file.

The sslCertFile attribute should contain the path to the file containing the public encryption key used when connecting the client to the server.

The SSL key file and certificate file supplied with File Archive Service are the standard files supplied with the Simba ODBC and JDBC drivers. For security, we strongly recommend that you use your own SSL key file and certificate file.

Page 72: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

58

If both file paths are present, the server will use encryption. If only one file path is present, or both entries are absent, the server will not use encryption.

The odbc tag now has the following elements, with appropriate values:

<odbc hostname="10.0.0.20" port="3731" sslKeyFile="/home/rsodbc/ssl/SimbaServerKey.pem" sslCertFile="/home/rsodbc/ssl/SimbaServerCertificate.pem" />

To switch off encryption, remove the file paths from the odbc tag.

6. Exit and save the file.

7. Restart the service manager:

npa_start_sm

The service manager picks up the file paths and encrypts messages sent via ODBC or JDBC.

Page 73: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

59

Index

A

adding new DSN data source, 14

advanced properties confirming values, 26 DSN setup, 19

advanced query options custom properties, 25

AIX ODBC driver required runtime libraries, 34

and schema custom properties, 42 JDBC URL, 52 ODBC connection string, 30 ODBC Unix driver, 42

archive DSN, 18 ODBC connection string, 29 ODBC Unix driver, 41 populating list, 18 selecting, 18

Archive JDBC URL, 51

archive time changing, 13, 16, 22, 23, 32, 54 custom properties, 42 enabling, 22, 30, 32, 42, 52, 54 JDBC URL, 52 ODBC connection string, 30 ODBC Unix driver, 42 selecting schema, 24 setting, 13, 16, 22, 23, 30, 32, 42, 48, 52, 54 universal time, 24

C

changing archive time, 13, 16, 22, 23, 32, 54 data type properties, 13, 16 DSN configuration, 15 encryption on server, 57 encryption properties, 13, 16

encryption setting, 57 logging level temporarily, 4

classpath including jar files, 48

completing DSN setup dialog, 17

configuring data, 10 initial DSN connection, 10 JDBC data source, 3, 49 JDBC driver, 3, 48 logging level, 4 ODBC data source, 3, 10, 27, 38 Unix ODBC driver, 3, 38 Windows ODBC driver, 3, 10, 27

confirming advanced DSN setup properties, 26

connecting third-party tool, 3

connection string configuring data source, 3, 27 elements, 27 JDBC driver, 48 JDBC URL, 49

conventions cautions, x notes, x tips, x typefaces, x

custom properties advanced query options, 25 and schema, 42 entering, 13, 16 supplying, 25

D

data encryption enabling, 21, 28, 42, 50 SSL certificate file, 21, 28, 43, 50

data source adding new, 14 changing configuration, 15 configuring under DSN, 10

data source description

Page 74: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

60

DSN, 17 data source name

DSN, 17 ODBC Unix driver, 40

data type properties changing, 13, 16

data types returning WCHAR as CHAR, 20 returning without data, 20 streaming VARBINARY as

LONGVARBINARY, 20 streaming VARCHAR as LONGVARCHAR, 20

describe VARBINARY as LONGVARBINARY usage, 20

describe VARCHAR as LONGVARCHAR usage, 20

describe WCHAR as CHAR usage, 20

DescribeVarbinaryAsLongvarbinary JDBC URL, 53 ODBC connection string, 31 ODBC Unix driver, 45

DescribeVarcharAsLongvarchar JDBC URL, 53 ODBC connection string, 31 ODBC Unix driver, 45

DescribeWcharAsChar JDBC URL, 53 ODBC connection string, 31 ODBC Unix driver, 45

description DSN, 17 ODBC Unix driver, 41

document conventions, x typefaces, x

documentation available, xi for drivers, 2

Driver ODBC connection string, 27

driver class JDBC driver, 48

DriverUnicodeEncoding ODBC Unix driver, 44

DSN adding new data source, 14 advanced properties, 19

archive, 18 changing configuration, 15 completing the dialog, 17 configuring data source, 3, 10 configuring initial connection, 10 confirming advanced properties, 26 data source name, 17 description, 17 password, 18 port number, 17 server, 17 SQL parser, 18 user name, 18

DSN setup advanced properties, 19 completing, 17 confirming advanced properties, 26

E

enable archive time custom properties, 42 JDBC URL, 52 ODBC connection string, 30 ODBC Unix driver, 42

EnableLogging ODBC Unix driver, 43

enabling archive time, 22, 30, 32, 42, 52, 54 encryption, 56 encryption on client, 21, 28, 42, 50 encryption on server, 56 logging in ODBC Unix driver, 43

encryption changing setting, 57 enabling, 21, 28, 42, 50, 56 enabling on server, 56, 57 SSL certificate file, 21, 28, 43, 50

encryption properties changing, 13, 16

entering custom properties, 13, 16

F

File Archive Service connecting to, 3

Page 75: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

61

H

help with product, xii

I

IANAAppCodePage ODBC Unix driver, 45

installing JDBC driver, 3, 48 Unix ODBC driver, 3, 35 Windows ODBC driver, 3, 7

J

jar files JDBC driver, 48

JDBC data source configuring using URL, 3, 49

JDBC driver about, 2, 48 classpath, 48 configuring, 3, 48 connection string, 48 documentation, 2 driver class, 48 installing, 3, 48 jar files, 48 maximum statement length, 2, 34, 48

JDBC log file, 4 JDBC logging level, 4 JDBC URL

and schema, 52 Archive, 51 archive time, 52 connection string elements, 49 DescribeVarbinaryAsLongvarbinary, 53 DescribeVarcharAsLongvarchar, 53 DescribeWcharAsChar, 53 enable archive time, 52 Parser, 51 password, 49 port, 49 PrepareMetadata, 52 server, 49

SQL parser, 51 TrustedStorePassword, 50 TrustedStorePath, 50 user name, 49 UseSsl, 50

L

log level for ODBC Unix driver, 43

log name space for ODBC Unix driver, 43

LogDirectory ODBC Unix driver, 43

logging enabling in ODBC Unix driver, 43

logging level changing temporarily, 4 JDBC logs, 4 ODBC logs, 4

LogLevel ODBC Unix driver, 43

LogMilliseconds ODBC Unix driver, 44

LogNameSpace ODBC Unix driver, 43

logs directory for ODBC Unix driver, 43 level for ODBC Unix driver, 43 name space for ODBC Unix driver, 43

logs directory for ODBC Unix driver, 43

LogThreadId ODBC Unix driver, 44

M

maximum statement length JDBC driver, 2, 34, 48 ODBC driver, 2, 6, 34

metadata querying, 13, 16, 25, 29, 41, 51 valid metafields, 25

metadata on prepare usage, 20

metafields querying, 25

Page 76: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

62

O

ODBC connection string and schema, 30 archive, 29 archive time, 30 DescribeVarbinaryAsLongvarbinary, 31 DescribeVarcharAsLongvarchar, 31 DescribeWcharAsChar, 31 Driver, 27 enable archive time, 30 parser, 29 password, 28 PrepareMetadata, 31 pwd, 28 ServerIP, 27 ServerPort, 27 SQL parser, 29 SslCertFile, 28 UID, 28 user name, 28 UseSsl, 28

ODBC data source configuring using connection string, 3, 27 configuring using DSN, 3, 10 ODBC Unix driver, 40

ODBC driver about, 2, 6, 34 AIX libraries, 34 configuring under Unix, 3, 38 configuring under Windows, 3, 10, 27 documentation, 2 installing under Unix, 3, 35 installing under Windows, 3 installing under Windows, 7 maximum statement length, 2, 6, 34 Unix, 34

ODBC log file, 4 ODBC logging level, 4 ODBC Unix driver

and schema, 42 archive, 41 archive tTime, 42 data source name, 40 DescribeVarbinaryAsLongvarbinary, 45 DescribeVarcharAsLongvarchar, 45 DescribeWcharAsChar, 45 description, 41

DriverUnicodeEncoding, 44 enable archive time, 42 EnableLogging, 43 enabling logging, 43 IANAAppCodePage, 45 log level, 43 LogDirectory, 43 LogLevel, 43 LogMilliseconds, 44 LogNameSpace, 43 logs directory, 43 logs name space, 43 LogThreadId, 44 ODBC data sources, 40 parser, 41 password, 41 PrepareMetadata, 45 PushedParamCacheSize, 44 PWD, 41 RowFetchSize, 44 ServerIP, 40 ServerPort, 41 ServerTimeout, 44 SslCertFile, 43 UID, 41 username, 41 UseSsl, 42

P

parser ODBC connection string, 29 ODBC Unix driver, 41 SQL, 18, 29, 51

Parser JDBC URL, 51

password DSN, 18 JDBC URL, 49 ODBC connection string, 28 ODBC Unix driver, 41

port DSN, 17 JDBC URL, 49

PrepareMetadata JDBC URL, 52 ODBC connection string, 31

Page 77: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

63

ODBC Unix driver, 45 product support, xii PushedParamCacheSize

ODBC Unix driver, 44 pwd

ODBC connection string, 28 PWD

ODBC Unix driver, 41

Q

querying metadata, 13, 16, 25, 29, 41, 51

R

returning data types without data, 20 VARBINARY as LONGVARBINARY, 20 VARCHAR as LONGVARCHAR, 20 WCHAR as CHAR, 20

RowFetchSize ODBC Unix driver, 44

S

schema selecting, 24 setting, 30, 32, 42, 52, 54

selecting archive, 18 archive time (and schema), 24

server DSN, 17 JDBC URL, 49

ServerIP ODBC connection string, 27 ODBC Unix driver, 40

ServerPort ODBC connection string, 27 ODBC Unix driver, 41

ServerTimeout ODBC Unix driver, 44

setting archive time, 13, 16, 22, 23, 30, 32, 42, 48, 52, 54 schema, 30, 32, 42, 52, 54

SQL parser DSN, 18 JDBC URL, 51 ODBC connection string, 29

SSL certificate file for JDBC driver, 50 for Windows driver, 21, 28, 43

SSL encryption certificate file, 21, 28, 43, 50 changing, 56, 57 enabling, 21, 28, 42, 50

SslCertFile ODBC connection string, 28 ODBC Unix driver, 43

statement length maximum via JDBC driver, 2, 34, 48 maximum via ODBC driver, 2, 6, 34

supplying custom properties, 25

support details, xii

T

third-party tool connecting to File Archive Service, 3

TrustedStorePassword JDBC URL, 50

TrustedStorePath JDBC URL, 50

U

UID ODBC connection string, 28 ODBC Unix driver, 41

universal time using in archive time, 24

Unix ODBC driver about, 34 configuring, 3, 38 installing, 3, 35

URL configuring data source, 3, 49

user name DSN, 18 JDBC URL, 49 ODBC connection string, 28

Page 78: JDBC Setup Guide - Informatica Documentation... · 2016-07-24 · Informatica Data Archive (Version 6.1D) File Archive Service ODBC/JDBC Setup Guide

64

username ODBC Unix driver, 41

UseSsl JDBC URL, 50 ODBC connection string, 28 ODBC Unix driver, 42

V

VARBINARY streaming as LONGVARBINARY, 20

VARCHAR streaming as LONGVARCHAR, 20

W

WCHAR returning as CHAR, 20

Windows ODBC driver about, 6 configuring, 3, 10, 27 installing, 3, 7