File Archive Service ODBC/JDBC Setup Guide Informatica Data Archive (Version 6.1C)
Welcome message from author
This document is posted to help you gain knowledge. Please leave a comment to let me know what you think about it! Share it to your friends and learn new things together.
Transcript
File Archive Service ODBC/JDBC Setup Guide
Informatica Data Archive (Version 6.1C)
ii
File Archive Service ODBC/JDBC Setup Guide
Version 6.1C May 2010
Copyright (c) 2003-2010 Informatica Corporation. 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 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(c)(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, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerExchange, PowerChannel, PowerMart, Metadata Manager, Informatica Data Quality, Informatica Data Explorer, Informatica B2B Data Transformation, Informatica B2B Data Exchange, Informatica Identity Resolution, Informatica On Demand, Informatica Data Archive, Informatica Data Privacy and Informatica Data Subset 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 may be subject to copyright held by third parties, including without limitation: Copyright © Adobe Systems Incorporated. All rights reserved. Copyright © Codebase. All rights reserved. Copyright © eHelp Corporation. All rights reserved. Copyright © EMC Corporation. All rights reserved. Copyright © IBM. All rights reserved. Copyright © Microsoft Corporation. All rights reserved. Copyright © Oracle Corpration. All rights reserved. Copyright © Thinkmap, Inc. All rights reserved. Copyright © Clearpace Software Limited. All rights reserved.
This product includes software developed by the Apache Software Foundation (http://www.apache.org/) and other software which is licensed under various versions of the Apache License (collectively the "License"). You may obtain a copy of the License at http://www.apache.org/licenses. 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.
This product includes software licensed under the Lesser General Public License (“LGPL”) (http://www.gnu.org/licenses/lgpl-2.1.txt). See the License for the specific language governing permissions and limitations.
This product includes software developed by the Eclipse Foundation (http://www.eclipse.org/) licensed under the Eclipse Public License (http://www.eclipse.org/legal/epl-v10.html). See the License for the specific language governing permissions and limitations.
This product includes software licensed under the Common Public License (http://www.opensource.org/licenses/cpl1.0.php). See the License for the specific language governing permissions and limitations. Source code is available at http://sourceforge.net/.
This product includes software licensed under the Common Development and Distribution License (http://www.opensource.org/licenses/cddl1.php). See the License for the specific language governing permissions and limitations.
This product includes software copyright © 2000-2008 The Legion Of The Bouncy Castle (http://www.bouncycastle.org), all rights reserved. See the License (http://www.bouncycastle.org/license.html) for the specific language governing permissions and limitations.
This product includes software licensed under the BSD License (http://www.opensource.org/licenses/bsd-license.php/). See the License for the specific language governing permissions and limitations.
This product includes software licensed under the MIT License (http://www.opensource.org/licenses/mit-license.php). See the License for the specific language governing permissions and limitations.
This product includes software licensed under the MPL (http://www.mozilla.org/MPL/MPL-1.0.html). (http://www.mozilla.org/MPL/MPL-1.1.html). See the License for the specific language governing permissions and limitations.
This product includes software copyright © Sun Microsystems, all rights reserved. See License (http://www.java.com/en/download/license.jsp) for the specific language governing permissions and limitations.
This product includes software developed by the DOM4J Project (http://www.dom4J.org) copyright 2001-2005 © MetaStuff, Ltd., all rights reserved. See the License (http://www.dom4j.org/dom4j.-1.6.1/license.html) for the specific language governing permissions and limitations.
This product includes software developed by the jMock Project (http://www.jmock.org) copyright 2000-2007 © jMock.org, all rights reserved. See the License (http://www.jmock.org/license.html) for the specific language governing permissions and limitations.
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 non-infringement, 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.
Contents
Preface..........................................................................................................v
Informatica Resources ..................................................................................................................v
About this guide......................................................................................... vii Overview of this guide...............................................................................................................vii Who should use this guide ........................................................................................................vii What’s in this guide? ..................................................................................................................vii Document conventions............................................................................................................. viii
Available documentation ........................................................................................................................... ix Product support............................................................................................................................................ x
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
Chapter 2: Installing and configuring the ODBC Windows driver...........5
About the ODBC Windows driver............................................................................................................. 6 Installing the File Archive Service ODBC driver ..................................................................................... 7 Configuring the ODBC data source using a DSN.................................................................................. 12
Configuring the initial DSN connection .................................................................................. 12 Adding a new DSN data source................................................................................................ 16 Changing the configuration of a DSN...................................................................................... 16 Completing the DSN setup dialog............................................................................................ 19 Using the Advanced properties ................................................................................................ 21
Configuring the ODBC data source using a connection string............................................................ 28 Setting the archive time via a connection string..................................................................... 32
Chapter 3: Installing and configuring the ODBC Unix driver.................34
About the ODBC Unix driver ................................................................................................................... 35 Installing the File Archive Service ODBC Unix driver ......................................................................... 36 Configuring the data sources.................................................................................................................... 38
iv
Chapter 4: Installing and configuring the JDBC driver ..........................44
Introduction................................................................................................................................................. 45 Making the jar files available .................................................................................................................... 45 Configuring the JDBC data source using a URL.................................................................................... 46
Connection string elements ....................................................................................................... 46 Setting the archive time via a JDBC URL................................................................................. 49
Chapter 5: Changing encryption on the server .....................................50
Introduction................................................................................................................................................. 51 Changing the server encryption setting .................................................................................................. 52
Glossary ......................................................................................................54
Index ...........................................................................................................74
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 customer support case management system (ATLAS), the Informatica How‐To Library, the Informatica Knowledge Base, the Informatica Multimedia Knowledge Base, Informatica Documentation Center, 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://my.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
vi
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].
Informatica Global Customer Support
You can contact a Customer Support Center by telephone or through the WebSupport Service. WebSupport 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 +1 877 463 2435 Standard Rate Brazil: +55 11 3523 7761 Mexico: +52 55 1168 9763 United States: +1 650 385 5800
Toll Free
00 800 4632 4357
Standard Rate
Belgium: +32 15 281 702 France: +33 1 41 38 92 26 Germany: +49 1805 702 702 Netherlands: +31 306 022 797 Spain and Portugal: +34 93 480 3760 United Kingdom: +44 1628 511 445
Toll Free
Australia: 1 800 151 830 Singapore: 001 800 4632 4357
Standard Rate
India: +91 80 4112 5738
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.
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: Changing encryption on the server, explains how to switch on encryption on the server if you have selected to switch on encryption on the client. (The encryption setting must always be the same (either on or off) on both client and server.)
The Glossary lists terms and abbreviations that you might encounter when using File Archive Service and its associated documentation. It provides an explanation for each term or abbreviation.
The Index helps you locate the information you need in this guide quickly and easily.
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
viii
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, and 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 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 Informatica 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, and how to use 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.
File Archive Service Technical Guide
Contains technical information about the structure and internal mechanism of File Archive Service.
Further documents might become available in future releases of File Archive Service.
ix
x
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.
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
1
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 currently support a maximum statement length of 512K bytes. Any queries that are longer than this will generate an error.
2
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 it under Windows or Unix.
To install and configure the ODBC driver under Windows, see Installing the File Archive Service ODBC driver on page 7.
To install and configure the ODBC driver under Unix, see Installing the File Archive Service ODBC Unix driver on page 36.
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 12, and Configuring the ODBC data source using a connection string on page 28.
To configure the data source using ODBC under Unix, see Configuring the 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 46.
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.
3
4
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 driver.......................................page 7
Configuring the ODBC data source using a DSN ...................................page 12
Configuring the ODBC data source using a connection string .............page 28
5
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 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. When you want to query an archive, you 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 expiry has been switched on for 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 driver currently supports a maximum SQL statement length of 512K bytes. Any queries that are longer than this will generate an error.
6
Installing the File Archive Service ODBC 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.
2. Locate the setup.exe file from the unzipped folder. Either double‐click the file to run the setup process, or run it from the command prompt.
As an alternative to steps 1 and 2, you can run the setup.exe file directly from the zipped folder.
3. An initial Powered by RainStor splash screen opens briefly, and then you
see the Rainstor ODBC Driver 2.0 Setup – Welcome dialog.
4. Click the Next button to proceed with the installation.
5. The License Agreement opens. This contains the Software License Agreement.
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, select the I accept the terms of the license agreement radio button.
You must accept the terms of the license agreement in order to install the File Archive Service ODBC driver.
6. When you have accepted the terms of the license agreement, click Next.
7
7. The Choose Destination Location dialog opens:
Figure 1: ODBC Setup – Choose Destination Location
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.
8
8. The Select Program Folder dialog opens:
Figure 2: ODBC Setup – Select Program Folder dialog
Either accept the suggested installation folder, or choose a different folder.
When you have selected the folder, click Next.
9. The Start Copying Files dialog opens:
Figure 3: ODBC Setup – Start Copying Files dialog
9
Check the displayed settings. If they are correct, click Next.
10. The Setup Status dialog displays a progress bar showing the progress of the file copy:
Figure 4: ODBC Setup – Setup Status dialog
11. When the copy is complete, the InstallShield Wizard Complete dialog opens:
Figure 5: ODBC Setup – InstallShield Wizard Complete dialog
If you want to read the ODBC driver warranty information, put a check mark in the View the Readme file check box.
10
Click the Finish button to complete the installation. If you selected to read the ODBC driver warranty information, the readme file opens in the default text editor. When you have read the contents, close the file.
11
Configuring the ODBC data source using a DSN This section explains how to configure the data source using DSN. You use these procedures for any of the following reasons:
To configure an initial DSN connection (page 12)
To add new DSN connections (page 16)
To change the configured settings for an existing DSN (page 16)
To change the encryption setting for a DSN (page 22)
To set the archive time (and schema) for a point‐in‐time query (page 22)
To query an archive’s metadata if record level expiry has been switched on (page 25). (The metadata includes the unique record index, which identifies individual records, and the current value of the associated expiry date.)
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.
12
4. Select the System DSN tab.
This displays the names of any currently configured System Data Sources.
Figure 6: ODBC Data Source Administrator – System DSN
5. Click the Add… button to add a new DSN.
6. The Create New Data Source dialog opens:
Scroll down until you see the Rainstor 2.0 data source name.
Figure 7: Create New Data Source dialog
13
Click on the Rainstor 2.0 data source name, then click the Finish button.
7. The RainStor ODBC 4.0 DSN Setup dialog opens:
Figure 8: RainStor ODBC 4.0 DSN Setup dialog
14
8. Complete the entries on this dialog. See Table 1 on page 19 for details.
The completed dialog box looks similar to the one shown in Figure 9 below.
Figure 9: RainStor ODBC 4.0 DSN setup dialog – completed
9. If you want to change the encryption setting, set or change the currently selected archive time, or query the metadata, click the Advanced button. See Using the Advanced properties on page 21 for details of these options.
10. Click OK to confirm the setup details and close the RainStor ODBC 4.0 DSN setup dialog.
You return to the ODBC Data Source Administrator dialog.
11. Click OK to confirm the data source settings and close the dialog.
You now have an ODBC connection to an archive. You can use it to connect a Business Intelligence tool to the selected archive so that you can query that archive.
15
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 12.
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.
16
5. Select the data source that you want to amend, then click Configure… button.
Figure 10: ODBC Data Source Administrator –
System DSN – List of data sources
17
6. The RainStor ODBC 4.0 DSN Setup dialog opens, showing the current configuration of the selected data source.
Figure 11: RainStor ODBC 4.0 DSN setup dialog – current configuration
7. Amend the entries on this dialog as required. See Table 1 on page 19 for details.
8. If you want to change the encryption setting, set or change the currently selected archive time, or query the metadata, click the Advanced button. See Using the Advanced properties on page 21 for details of these options.
9. Click OK to confirm the setup details and close the RainStor ODBC 4.0 DSN setup dialog.
You return to the ODBC Data Source Administrator dialog.
10. Click OK to confirm the data source settings and close the dialog.
You can now query the selected archive using the amended configuration values.
18
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.
User name Enter a valid File Archive Service user name. This enables you to connect to a running File Archive Service service manager. For example: wfadmin.
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.
19
Field Description
SQL parser Select the SQL parser you want to use for the queries. This can be one of:
SQL92 (the default)
ORACLE
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.
If a connection is successfully established, a popup dialog box displays the message ʹArchive list updated successfully!ʹ. Click OK to dismiss the dialog box.
If the connection fails, you see an ʹAuthentication failed!ʹ error. 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.
20
Using the 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, as shown in Figure 12.
Figure 12: Advanced ODBC 4.0 properties
To access this dialog, click on the Advanced… button on the RainStor ODBC 4.0 DSN setup dialog. This enables you to change any of the items listed below:
Encryption option
Archive time (and schema)
Custom properties – This enables you to configure additional connection options, such as accessing an archive’s metadata (if record level expiry has been switched)
See the relevant subsection below for details.
21
Changing the encryption setting
If you want data to be encrypted when it is sent via your ODBC connection, put a check mark in the Use SSL data encryption check box. If you leave this unchecked, the data is sent unencrypted.
To use encryption, you must switch it on for both the client and the server. The setting on the Advanced properties switches on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Changing encryption on the server.
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 13: Advanced ODBC 4.0 properties dialog – enabling archive time
22
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, or you can use the date selector to select the date, and then change the time components. 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 14: 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.
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 15: Setting the archive time – all elements set
23
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 16: Setting the archive time –using the date selector
c. Click the OK button to confirm the selected month and year, and close the Advanced properties dialog box.
If you use the date selector to select the date, you must save the selected date before you can use the arrow keys to change the time elements of the archive time.
d. Click on the Advanced button again box to reopen the Advanced Properties dialog box.
e. Click on the hour component of the archive time.
f. Use the arrow keys on your keyboard to select the required hours, minutes, and seconds, as described for Using the arrow keys above.
24
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. If you want 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 17 If you want to use the current schema in your point‐in‐time query, leave the And Schema check box unselected.
Figure 17: Advanced ODBC 4.0 properties dialog – selecting the schema
Supplying custom parameters
If record level expiry has been switched on for an archive, you can use the Custom parameters box on the Advanced dialog to enable access to the metadata for the selected DSN connection. You can also use the custom parameters to enter an advanced query option under instruction from support personnel.
To enable access to the metadata, you enter:
addFieldMetadata?true
25
For example:
Figure 18: Enabling access to metadata
In the unlikely event that your archived tables contain one or more columns with the same names as the metadata columns, you can add a switch to the custom parameters to replace the “npa_” prefix in the queries. This switch includes the prefix that you want to designate as the metadata column prefix instead of “npa_”. You add this optional switch immediately after the addFieldMetadata?true switch, with a pipe or vertical bar character (|) as the delimiter. The format is: fieldMetadataPrefix?<new_prefix>.
For example:
addFieldMetadata?true|fieldMetadataPrefix?prfx_
Figure 19: Using an alternative metadata prefix
In the example shown above, any queries against the metadata would have to use the expiry date column name “prfx_expiry_date”, and the unique record index column name “prfx_unique_record_index”.
Any replacement prefix applies only for the currently selected DSN connection. You can use a different prefix for other connections if you want, or you can change the prefix for the current connection.
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 4.0 DSN setup dialog box to confirm the settings.
3. Click OK on the ODBC Data Source Administrator – System Data Sources dialog.
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 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 the following elements, separated by semi‐colons (;):
Connection string element
Description
The following elements are mandatory:
Driver Name of the ODBC driver. This is RainStor 2.0.
For example:
Driver=RainStor 2.0
Host The IP address of the server on which the service manager is running. See the File Archive Service Installation Guide for details.
For example:
Host=10.0.0.20
Port The port number of the ODBC server. See the File Archive Service Installation Guide for details.
For example:
Port=3812
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
Encrypted Controls whether data is encrypted or not. Can be:
0 (Data not encrypted)
1 (Data encrypted)
For example:
Encrypted=1
To use encryption, you must switch it on for both the client and the server. The setting in the connection string switches on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Changing encryption on the server.
Archive The name of the archive that you want to connect to.
For example:
Archive=world_facts
29
Connection string element
Description
Parser The SQL parser 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.
If you want to query the metadata, you can include the following switch with the selected parser:
|addFieldMetadata?true
For example:
Parser=SQL92|addFieldMetadata?true
If you want to use an alternative metadata prefix in your queries, instead of npa_, you can also include the following switch:
|fieldMetadataPrefix?prfx_
For example:
Parser=SQL92|addFieldMetadata?true| fieldMetadataPrefix?prfx_
30
Connection string element
Description
The following additional 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= 2009-10-31 23:59:59;andSchema=0
31
Example:
Below is an example of an ODBC connection string that includes the metadata query switch:
Driver=RainStor 2.0;Host=10.0.0.20;Port=3812; UID=wfadmin;PWD=wfadmin;Encrypted=1;Archive=world_facts; Parser=SQL92|addFieldMetadata?true|fieldMetadataPrefix?prfx_;
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 2.0;Host=10.0.0.20;Port=3812;UID=wfadmin; PWD=wfadmin;Encrypted=1;Archive=wf_expiry;Parser=SQL92; EnableArchiveTime=1;ArchiveTime=2009-11-30 23:59:59; andSchema=1;
32
33
Chapter 3: Installing and configuring the ODBC Unix driver
This chapter gives describes how to install and configure the File Archive Service ODBC driver under any supported Unix operating system.
In this chapter
About the ODBC Unix driver.....................................................................page 35
Installing the File Archive Service ODBC Unix driver ...........................page 36
Configuring the data sources .....................................................................page 38
34
About the ODBC Unix driver File Archive Service includes both 32‐bit and 64‐bit Unix drivers. 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 2 below shows the script and tar file names relevant to each supported operating system.
Table 2: Unix driver file names
Operating System Script & tar file
32-bit Linux RainStor-ODBC.2.0.0.0.Linux.i386.sh RainStor-ODBC.2.0.0.0.Linux.i386.tar
64-bit Linux RainStor-ODBC.2.0.0.0.Linux.x86_64.sh RainStor-ODBC.2.0.0.0.Linux.x86_64.tar
32-bit Solaris RainStor-ODBC.2.0.0.0.SunOS32.sparc.sh RainStor-ODBC.2.0.0.0.SunOS32.sparc.tar
64-bit Solaris RainStor-ODBC.2.0.0.0.SunOS64.sparc.sh RainStor-ODBC.2.0.0.0.SunOS64.sparc.tar
32-bit AIX RainStor-ODBC.2.0.0.0.AIX32.powerpc.sh RainStor-ODBC.2.0.0.0.AIX32.powerpc.tar
64-bit AIX RainStor-ODBC.2.0.0.0.AIX64.powerpc.sh RainStor-ODBC.2.0.0.0.AIX64.powerpc.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 currently support a maximum SQL statement length of 512K. Any queries that are longer than this will generate an error.
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 file (.sh and .tar) to a suitable directory on your Unix system.
2. Make sure the .sh file is executable:
chmod +x RainStor-ODBC.2.0.0.0.<version_name>.sh
For example:
chmod +x RainStor-ODBC.2.0.0.0.Linux.x86_64.sh
3. Run the installer:
./RainStor-ODBC.2.0.0.0.<version_name>.sh
For example:
./RainStor-ODBC.2.0.0.0.Linux.x86_64.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.)
5. The following text is displayed:
**************************************************** **************************************************** RainStor ODBC Installation logging to /tmp/RainStorODBC-<datetime> Please enter the destination directory (default = ./):
Press <Enter> to install the driver in your default directory, otherwise supply the full path to a different installation directory.
6. When you select the destination directory, the .tar file is unpacked into a directory called RainStor-ODBC within the destination directory.
36
The following messages are displayed:
Extracting RainStor ODBC...
Installation of RainStor ODBC is Complete. To use the ODBC driver you will need to source one of the following depending on your shell:- For Bash/Ksh: /home/<destination_directory>/RainStor-ODBC/ oaodbc64.sh For C shell: /home/<destination_directory>/RainStor-ODBC/ oaodbc64.csh
<destination_directory> is the directory you selected in the previous step.
7. As indicated in the displayed message, in order to use the driver you need to source the relevant ODBC file.
If you are installing the 32‐bit driver, this is:
oaodbc.sh or oaodbc.csh
If you are installing the 64‐bit driver, this is:
oaodbc64.sh or oaodbc64.csh
To source the file, enter:
source /home/<destination_directory>/RainStor-ODBC/<source_file>
For example:
source /home/rhome/RainStor-ODBC/oaodbc64.sh
8. Before you use the newly installed driver, you need to configure the data sources that you want to access. See Configuring the data sources on page 38.
37
Configuring the data sources When you have installed the ODBC Unix driver (32‐bit or 64‐bit, as appropriate), you need to configure each data source (archive) that you want to query. To do this, follow the steps below:
1. Change to the RainStor-ODBC directory. This will be in the destination directory you selected when you installed the driver.
2. Locate the .ini file in this directory.
For the 32‐bit version, the file is:
odbc.ini
For the 64‐bit version, the file is:
odbc64.ini
The default contents of this file are shown in Figure 20:
;This is a template for the OpenAccess ODBC Driver data source. [ODBC Data Sources] DataSourceName=RainStor 2.0 [DataSourceName] Driver=/home/rhome/RainStor-ODBC/lib64/ivoa22.so Description=RainStor 2.0 ODBC driver Host= Port= ServerDataSource= UseLDAP=0 DistinguishedName= Encrypted=0 LoadBalancing=0 AlternateServers= ConnectionRetryCount=0 ConnectionRetryDelay=3 CustomProperties= [ODBC] Trace=0 IANAAppCodePage=4 TraceFile=odbctrace.out TraceDll=/home/rhome/RainStor-ODBC/lib64/odbctrac.so InstallDir=/home/rhome/RainStor-ODBC
Figure 20: Default contents of an odbc64.ini file
The sections and lines shown in blue are the areas that you need to change.
38
3. Using an editor of your choice, edit the contents of the .ini file. Table 3 gives details of the areas of the .ini file that you need to edit, and the values that you need to supply.
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.
Table 3: 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 DSN names:
DSNwf1=RainStor 2.0 DSNwf2=RainStor 2.0 Arch1=RainStor 2.0 Arch2=RainStor 2.0
The entries to the left of the equals sign (=) are the data source names. You need a [DataSourceName] section for each name that you specify here.
[DataSourceName] You need one of these sections for each data source name that you have specified in the previous section. You replace the DataSourceName text at the top of the section with the DSN name. Using the examples above, you would need the following sections:
[DSNwf1] [DSNwf2] [Arch1] [Arch2]
The remaining details below apply to the contents of each named DSN section.
Host Enter the IP address of the server on which the service manager is running. For example:
Host=10.0.0.20
Port Enter the configured port number of the ODBC server. For example:
Port=3812
39
Entry Required value
Encrypted Controls whether data is encrypted or not. Can be:
0 (Data not encrypted)
1 (Data encrypted)
For example: Encrypted=1
To use encryption, you must switch it on for both the client and the server. The setting in the .ini file switches on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Changing encryption on the server.
CustomProperties This is where you specify the name of the archive that you want to connect to, the SQL parser that you want to use, and any additional parameters, as detailed below. You enter these properties after the equals sign (=), and separate the different parameters with a semi‐colon (;).
Archive Enter the name of the archive that you want to connect to. For example:
Archive=world_facts
Parser Enter 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.
If you want to query the metadata, you can include the following switch with the selected parser: |addFieldMetadata?true
For example: Parser=SQL92|addFieldMetadata?true
40
Entry Required value
If you want to use an alternative metadata prefix in your queries, instead of npa_, you can also include the following switch: |fieldMetadataPrefix=prfx_
For example: Parser=SQL92|addFieldMetadata?true| fieldMetadataPrefix?prfx_
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= 2009-10-31 23:59:59;andSchema=0
41
Figure 21 shows an example .ini file with two data sources defined:
;This is a template for the OpenAccess ODBC Driver data source. [ODBC Data Sources] Arch1=RainStor 2.0 Arch2=RainStor 2.0 [Arch1] Driver=/home/rhome/RainStor-ODBC/lib64/ivoa22.so Description=RainStor 2.0 ODBC driver Host=10.0.0.20 Port=3812 ServerDataSource= UseLDAP=0 DistinguishedName= Encrypted=1 LoadBalancing=0 AlternateServers= ConnectionRetryCount=0 ConnectionRetryDelay=3 CustomProperties=Archive=world_facts;Parser=SQLSERVER [Arch2] Driver=/home/rhome/RainStor-ODBC/lib64/ivoa22.so Description=RainStor 2.0 ODBC driver Host=10.0.0.20 Port=3812 ServerDataSource= UseLDAP=0 DistinguishedName= Encrypted=1 LoadBalancing=0 AlternateServers= ConnectionRetryCount=0 ConnectionRetryDelay=3 CustomProperties=Archive=wf_expiry;Parser=SQL92|addFieldMetadata?true [ODBC] Trace=0 IANAAppCodePage=4 TraceFile=odbctrace.out TraceDll=/home/rhome/RainStor-ODBC/lib64/odbctrac.so InstallDir=/home/rhome/RainStor-ODBC
Figure 21: Default contents of an odbc64.ini file
42
43
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 45
Making the jar files available......................................................................page 45
Configuring the JDBC data source using a URL .....................................page 46
44
Introduction To connect a third‐party tool to File Archive Service using JDBC, all you need to do is copy the two File Archive Service .jar files 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 files on the classpath of that application. You also supply the driver class to use.
When you have included the .jar files on the classpath, and supplied the driver class, you connect to the relevant archive using an appropriate connection string.
The JDBC driver currently supports a maximum SQL statement length of 512K bytes. Any queries that are longer than this will generate an error.
Making the jar files available The File Archive Service installation includes two .jar files that enable you to query the archived data using a Java query application via JDBC. These two .jar files are:
CPjc.jar
CPssl14.jar
Copy these files to a suitable location on your computer. Then, when you run your Java query application, you include these .jar files on the application’s classpath.
You also need to supply the driver class to the application. The driver class is:
com.rainstor.jdbc.openaccess.OpenAccessDriver
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.
45
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:rainstor: 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:rainstor://10.0.0.20:3812
user 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:
user=wfadmin
password 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:
password=wfadmin
Encrypted This is an optional element. It controls whether data is encrypted or not. Can be:
0 (Data not encrypted)
1 (Data encrypted)
For example:
Encrypted=1
46
Connection string element Description
To use encryption, you must switch it on for both the client and the server. The setting in the connection string switches on encryption on the client. To find out how to switch on encryption on the server, see Chapter 5: Changing encryption on the server.
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.
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 query the metadata, you can include the following switch with the selected parser:
|addFieldMetadata?true
For example:
Parser=SQL92|addFieldMetadata?true
If you want to use an alternative metadata prefix in your queries, instead of npa_, you can also include the following switch:
|fieldMetadataPrefix?prfx_
47
Connection string element Description
For example:
Parser=SQL92|addFieldMetadata?true| fieldMetadataPrefix?prfx_
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=2009-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
Example:
Below is an example of a JDBC URL connection string that includes the metadata query switch:
jdbc:rainstor://10.0.0.20:3812;user=wfadmin; password=wfadmin;Encrypted=1; CustomProperties=(Archive=wf_expiry; Parser=SQL92|addFieldMetadata?true|fieldMetadataPrefix?prfx_)
48
49
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:rainstor://10.0.0.20:3812;user=wfadmin; password=wfadmin;Encrypted=1; CustomProperties=(Archive=wf_expiry; Parser=SQL92;EnableArchiveTime=1; ArchiveTime=2007-10-01 01:00:00;andSchema=1)
Chapter 5: Changing encryption on the server
This chapter explains how to switch on encryption on the server if you have selected to switch on encryption on the client. The encryption setting must always be the same (either on or off) on both client and server.
In this chapter:
Introduction ..................................................................................................page 51
Changing the server encryption setting....................................................page 52
50
Introduction File Archive Service supports SSL encryption between client and server. If you have enabled encryption on the client, you must also enable encryption on the server. Similarly, if you have switched off encryption on the client, you must also switch off encryption on the server. 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.
51
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, for security you might choose to use encryption. If you use encryption on the client, you also need to use encryption on the server.
We recommend that you stop the service manager before changing the encryption setting, and restart it when you have made the change.
Follow the steps below to change the encryption setting on the server:
1. Navigate to the following directory:
NParchive-dist/sbin/oa6/cfg
2. Locate this file:
oadm.ini
3. Using an editor of your choice, edit the file and locate the section:
[Service_0]
This section is towards the end of the file, after the Attributes and Entities sections.
4. Locate the entry:
ServiceSSLEnabled=<value>
5. Change the value as required.
Either:
ServiceSSLEnabled=0 (Encryption not enabled)
Or:
ServiceSSLEnabled=1 (Encryption enabled)
6. Exit and save the file.
52
53
Glossary
This Glossary lists terms and abbreviations that are used in the File Archive Service documentation, and for which you might require a definition or explanation. Cross‐references to other glossary terms are shown in italics.
Active Directory (AD) An implementation of LDAP directory services by Microsoft for use in Windows environments. Active Directory allows administrators to assign enterprise‐wide policies. Amongst other benefits, this enables a user to employ the same username and password in multiple applications, with centralized authentication.
Archive A collection of Archived tables. An archive contains data archived from one or more tables in a data source.
Archive creation DDL file A file containing the DDL that defines the structure of an archive and the tables within it. The DDL must conform to File Archive Service DDL grammar. The full path to the archive creation DDL file must be supplied as a parameter when you run npa_create_archive.
Archive data file An individual file containing data archived from a data source table. Also referred to as a tree file or a partition file. See also Archived table.
Archive data file size Also known as grain size. Each data import from a load file results in the creation of one or more archive data files. The number of archive data files created depends on the size of the load file and the value of the splitExpr entry in the import properties file.
54
Archive Engine The module of File Archive Service that manages the importing of data into an archive in compressed form. The Archive Engine uses the contents of the import properties file to determine the level of compression in the archive and the location of the archive.
Archive super-user A File Archive Service user that has full administrative rights over a specific archive. This user can be created as a new user when the archive is created. Alternatively, administrative rights over an archive can be assigned to an existing user when the archive is created. The main purpose of an archive super‐user is to assign and remove user roles within their own archive.
Archive time The date and time that you set prior to submitting a point‐in‐time query. Once you have set the archive time, any subsequent queries will reflect all data loaded into the archive with a logical time on or before the selected archive time.
When you set an archive time, you can optionally select the schema at the same time. If you do this, any subsequent query results will use the schema version that was in place at the selected archive time, rather than the current schema. You only need to select the schema if any schema changes have been applied to the archive.
Archived table An archived table is the collection of archive data files created from a single data source table. The number of data files in an archived table increases with each new data import from the data source table, but the archived table is treated as a single entity for query purposes.
Batch For data import, a ʺbatchʺ is single load file, or directory of load files, designated by a specific tablen group of entries in an import properties file. The tablen group of entries define the archived table into which the data will be imported, the location and name of the individual load file or directory of load files, and the logical time to which the imported data relates.
55
BCP Bulk Copy Program. A utility program provided with Sybase and Microsoft SQL Server databases for the high‐speed extraction and loading of data. BCP can extract data from a table to a delimited file, similar to a CSV file, and can load data into a table from a file. You can specify the field and row delimiters that you are using to separate the fields and rows, but those delimiters cannot appear within the data values.
Binary collation Binary collation is used in the ordering of query results. It means sorting all characters according to their internally represented numeric value.
CAS Content‐Addressable Storage Content‐Addressed Storage Content‐Aware Storage
A mechanism for providing fast access to fixed‐content data on a remote storage device. CAS assigns a data object a unique and permanent place on the storage device. The address of an object on the storage device is determined by the objectʹs contents, so the object cannot be duplicated or modified once it has been stored.
Centera cluster A type of CAS device that appears to an application as a single unit. The cluster can be accessed via a set of node IP addresses and access profiles, which are held in a PEA file.
CSV Comma Separated Values. A type of file that stores tabular data in delimited form. The delimiter is usually a comma or semi‐colon. Unlike other types of delimited files, data within CSV files can contain the delimiter itself, provided that any data values containing the delimiter or other reserved characters (such as newline characters) are enclosed within double quotes (ʺ).
56
Data expiration When archived data reaches a certain age (depending on your data expiration policies), that data can be expired from the archive in which it is stored. The data expiration process marks the data as retired, which means that it is no longer available for querying. The default data expiration method for an archive is import level expiry, but you can switch to using record level expiry if you need to expire individual records.
Data source The source of the archived data. This is typically a production database, but data can also come from a variety of other sources, such as data streams or log files.
DDL Data Definition Language. A computer language for defining data, such as the DDL subset of SQLʹs instructions.
DDL SQL statements define the structure of a database, including rows, columns, tables, indexes, and other database specifics. DDL SQL statements depend on the DBMS (database management system), so can differ widely between SQL variations.
DDL checker See npa_check_ddl.
DDL translator See npa_translate_oracle and npa_translate_sqlserver.
Delimited data/delimited file Delimited data is data whose values are separated by specific characters or delimiters. The delimiter can be any character or sequence of characters. The commonest delimiter characters are the comma, tab, semi‐colon, vertical bar (or pipe), and space.
One form of delimited data is the comma‐separated values (or CSV) file – in this case the delimiter is a comma. Another form of delimited data is the BCP file. In this case the delimiter can be any character, or sequence of characters – the actual delimiter is specified when the BCP file is created.
57
Delimited data is often divided into columns and rows. The first line of data generally defines the column headers, and each subsequent line is a row containing data values. The lines are normally separated by newline/ carriage return characters, and the data values are separated by the specified field delimiter.
DSN Data Source Name. Contains information about a specific data source that an ODBC driver needs in order to connect to that data source. For File Archive Service ODBC connectivity, the data source is a specific archive. On Windows, the DSN information is stored in the registry of the computer on which it is set up; on Unix/Linux, the DSN information is stored in a file.
Enterprise Vault archive A logical container used within Enterprise Vault for organizing and partitioning data, identified by an Archive ID.
Enterprise Vault store A storage area configured for use with Enterprise Vault (EV), identified by a Vault Store ID.
ETL tool Extract, Transform, Load. The process of transferring data from one database to another using a single tool. An ETL tool can read data in one format, extract the subset of data required, transform it into another format, and load it into the new data storage form.
Expiration of data See data expiration.
Field level de-duplication Also known as single instancing. This is the primary method used by File Archive Service to compress data. It is the removal of duplicate data values, so that each distinct value of a column is stored only once. Records are held as a series of pointers to the relevant data values, rather than being stored as the values themselves. So the more duplication of data values there is in the original data source, the greater the degree of compression of that data within File Archive Service.
58
Garbage collection The automated removal of task files and temporary working files. Within File Archive Service you can switch garbage collection on or off. You would normally only switch garbage collection off to track down an error.
Grain size See Archive data file size.
Immediate task A task that runs immediately rather than being added to the task queues to be processed when a service manager slot becomes available.
Immutable device A storage device to which data can be written, but not be modified or removed.
Import level expiry The default data expiry method in File Archive Service. This allows you to expire all the data imported on or before a calculated retention date. The retention date is calculated by adding the specified retention period to the logical import time of the archived data.
If you switch on record level expiry for an archive, you can no longer use import level expiry for that archive.
Import properties file A file supplied as a parameter to npa_load_data. The contents of the import properties file define the names and locations of the load files (containing the data to be imported), the format of the load files, whether load files should be aggregated on import, and the structure of the data in the load files. This structure includes date and time formats, and field and row delimiters (where relevant).
JDBC Java DataBase Connectivity. A protocol providing connectivity between the Java platform and a wide range of databases regardless of their programming language, DataBase Management System (DBMS) or operating system. As for ODBC, a set of application programming interfaces (APIs) provide a standard mechanism to allow Java programs access to a database.
59
LDAP Lightweight Directory Access Protocol. An online client‐server protocol for accessing directory services over TCP/IP (Transmission Control Protocol/Internet Protocol). LDAP allows administrators to assign enterprise‐wide policies. Amongst other benefits, this enables a user to employ the same username and password in multiple applications, with centralized authentication.
Legal hold Data that is subject to legal process, and must therefore be retained, can be marked as on legal hold. This prevents the data from being expired, even when it has reached its expiration date. When legal hold is no longer required, the data can be released for expiration. Legal hold is set and unset on an archive‐by‐archive basis.
Load file A delimited or XML file in the staging area, containing data extracted from a data source table, ready for importing into File Archive Service. During data import each load file might be split into one or more archive data files, or several load files can be aggregated into one archive data file, depending on the options contained in the import properties file.
Locale A value configured during installation that governs the expected format of dates and times used in queries. The table below shows the valid locale values and their corresponding date and time formats.
Table 4: Locale values and formats
Locale value Format for: Format
en_ISO Date: YYYY‐MM‐DD Time: HH24:MI:SS.SSS Datetime: YYYY‐MM‐DD HH24:MI:SS.SSS en_GB Date: DD/MM/YYYY Time: HH24:MI:SS.SSS Datetime: DD/MM/YYYY HH24:MI:SS.SSS en_US Date: MM/DD/YYYY Time: HH24:MI:SS.SSS
Datetime: MM/DD/YYYY HH24:MI:SS.SSS
60
Logical time The date and time associated with either a batch of imported data or a set of schema changes.
All batches of data imported into an archive have a logical time associated with them. The File Archive Service query engine uses this logical time to choose the correct data for point‐in‐time queries. To run a point‐in‐time query, you set the archive time before you submit the query. The logical time of a data import is also used for import level expiry – if the logical time of a data import falls outside the retention period, the data is eligible for expiry.
All schema changes applied to an archived table have a logical time associated with them – this is the effective time of the schema change. The File Archive Service query engine uses this logical time to choose the correct schema version for point‐in‐time queries. To select the version of a schema that was in place at a particular point in time, you set the schema as well as the archive time before you submit the point‐in‐time query.
MD5 checksum Message‐Digest algorithm 5. This is a widely used means of verifying data integrity. It takes an input message of arbitrary length and outputs a 128‐bit hash value. As it is extremely unlikely that two different input messages will produce the same hash value, this value can be used to check data integrity.
Metadata Data about data. File Archive Service has a designated metadata directory that holds security and permissions data about the archives. The metadata directory also contains the system archive. Other metadata relating to a specific archive is held in the data directory, within the directory structure for the relevant archive.
Multi-service-manager (multi-SM) environment An environment where there is more than one installation of File Archive Service, and the installations have been configured to use the same shared area. In a multi‐SM environment, each separate instance of File Archive Service is typically installed on a different server, although they can be installed in separate directories on a single server.
61
npa_admin
A command‐line tool that enables you to perform general administration tasks within File Archive Service. These tasks include adding and deleting users, changing passwords, listing archives and tables, managing archive queues, and monitoring other tasks.
npa_check_ddl
A command‐line tool that enables you to check the structure of the DDL files that you intend to use to create the tables within an archive, apply schema changes, or update table‐level permissions. The DDL structure must conform to the File Archive Service DDL grammar, otherwise the archive creation process might fail.
npa_configure_install
A script that is run as part of the File Archive Service installation procedure, to allow you to configure an implementation of File Archive Service. This script enables you to select the server IP address, service manager port number, structure of the shared archive area, locale, and various other values.
npa_create_archive
The command‐line tool that you use to create a new archive. This requires several run‐time parameters, including the name of the archive to create, and the location of the DDL file that defines the structure of the archive.
npa_env.csh
The script you can use to set up your PATH and environment variables if you use the C shell.
npa_env.sh
The script you can use to set up your PATH and environment variables if you use the Bourne, Korn, or Bourne‐Again (bash) shell.
npa_install_npsystem
A script that is run as part of the File Archive Service installation procedure, to install the system archive. You can also use this script as a command‐line tool to install the system archive if you need to restore your archives from a backup.
62
npa_install_sample
The command‐line tool that you use to install the demo archive if this archive was not installed as part of the File Archive Service installation and configuration procedures.
npa_load_data
The command‐line tool that you use to import data into an archive. This requires several run‐time parameters, including the name of the archive to import data into, and the location of the import properties file that contains the location and structure of the data to be imported.
npa_monitor_tasks
The command‐line tool that enables you to monitor the progress of a data import. By default npa_load_data monitors data import progress automatically, but if you run it with the -notrack option it will suppress task monitoring. You can then use npa_monitor_tasks to monitor the data import progress separately.
npa_ping_sm
The command‐line tool that you use to check the status of a File Archive Service service manager on a particular server and port.
npa_query
A command‐line tool that enables you to query an archive using standard SQL commands, and optionally export query results to an XML, CSV, or BCP file.
npa_retire_archive
The command‐line tool that you use to remove an archive from the list of active archives. When you retire an archive, the archiveʹs contents are not deleted, but the archive is no longer visible to File Archive Service.
npa_start_sm
The script that you use to start a File Archive Service service manager.
npa_stop_sm
The command‐line tool that you use to stop a running File Archive Service service manager.
63
npa_test_install
A script that can be run as part of the File Archive Service installation process, if requested. The script tests whether the installation has been successful and whether File Archive Service can run successfully with the supplied configuration parameters.
npa_translate_oracle
A command‐line tool that enables you to parse a supplied Oracle DDL file (or directory of DDL files) and convert the DDL from Oracle format to a format that complies with File Archive Service DDL grammar.
npa_translate_sqlserver
A command‐line tool that enables you to parse a supplied SQL Server DDL file (or directory of DDL files) and convert the DDL from SQL Server format to a format that complies with File Archive Service DDL grammar.
npa_update_schema
The command‐line tool that you use to apply schema changes to an archive. This tool takes several run‐time parameters, including the name of the archive to be updated, the location of the schema change file that contains the details of the schema changes, and the logical time that defines the effective time of the schema change.
npa_update_security
The command‐line tool that you use to grant and revoke SELECT permission on tables and views for individual users. This tool takes several run‐time parameters, including the name of the relevant archive, and the location of the permissions file.
ODBC Open DataBase Connectivity. A standard created by Microsoft to provide a common interface through which software can interact with a database without requiring direct knowledge of how that database is implemented. The ODBC system consists of a collection of Drivers that map the calls from ODBC into actual operations on the underlying database. Where available, you can use the File Archive Service ODBC driver to query an archive via a business intelligence tool running under Windows.
Operational database See Production database.
64
Partition elimination The selection of only those archive data files that are relevant to a query, or the elimination of irrelevant archive data files from a query. Selected files are loaded into memory as tree partitions.
Partition file Another name for an archive data file.
PEA file Pool Entry Authorization file. A file containing the authorization profile that enables an application to access a Centera cluster. The profile determines which applications can access the cluster, and what operations they can perform.
Permissions file A file containing details of table and view permission changes for an archive. The permission changes take the form of GRANT and REVOKE statements for changing SELECT permission on tables and views for individual users. These statements must conform to File Archive Service DDL grammar. The full path to the permissions file must be supplied as a parameter when you run npa_update_security.
Point-in-time query A query whose results reflect the contents of an archive at a selected date and time. To run a point‐in‐time query, you must first set the archive time (and optionally the schema) prior to submitting the query. The query results will only include data that was archived with a logical time on or before the set archive time.
Production database A database containing up‐to‐date, modifiable data. In contrast, an archive data store can have data added to it, but cannot be modified, or have data deleted from it. A production database is one type of data source.
Query engine The module of File Archive Service that interprets SQL queries entered through either npa_query or an ODBC‐compliant third party tool. The query engine applies the queries to the archive and returns the results to the user.
65
Queue status The table below explains the different queue status values and their significance. These status values apply to selected task groups.
Table 5: Queue status values and meanings
Queue status Meaning
blocked A queue must be blocked before it can be drained or paused. Once blocked, no new tasks in the blocked groups can be submitted to the queue. Tasks that are already in the queue will continue to be processed.
blocked drained The status required before you can apply a schema change or change table level permissions within an archive. No new tasks in the blocked groups can be submitted to the queue. Any pending tasks or processing tasks in the selected groups must complete processing before the queue is fully drained. If there are any large data imports pending or processing, draining the queue might take a long time.
blocked draining An interim status between blocked and blocked drained. This status applies until all tasks that are already submitted have been completely processed.
blocked paused The status required before you can create a backup manifest. No new tasks in the blocked groups can be submitted to the queue. Any pending tasks in the paused groups can be moved to the processing queue, but they are not processed until the queues are unpaused. Any tasks that are already in processing, but have not yet started committing their data, will continue processing, but their data will not be committed until the queue has been unpaused. Any tasks that have already started committing their data will complete the data commit process. If there are any large data import tasks in processing, pausing the queue might take a long time, because those tasks continue processing until the data is committed or ready to be committed.
blocked pausing An interim status between blocked and blocked paused. This status applies until all tasks that have already started committing their data complete the data commit process.
66
Queue status Meaning
blocked undraining An interim status between blocked drained and blocked. Undraining a queue is a much faster process than draining a queue. You can force an undrain to reverse the draining process if required.
blocked unpausing An interim status between blocked paused and blocked. Unpausing a queue is a much faster process than pausing a queue. You can force an unpause to reverse the pausing process if required.
blocking An interim status between running and blocked. This status applies until the queue has been completely blocked for the selected task groups.
running The normal status of a queue. Tasks will be submitted to the queue and processed when picked up by a service manager.
unblocking An interim status between blocked and running. This status applies until the queue has been completely unblocked for the selected task groups. Unblocking a queue is a much faster process than blocking a queue. You can force an unblock to reverse the blocking process if required.
File Archive Service DDL grammar The DDL format recognized by File Archive Service. This DDL structure must be used in archive creation DDL files, schema change files, and permissions files. You can use npa_translate_oracle or npa_translate_sqlserver to translate Oracle or SQL Server DDL respectively into File Archive Service DDL. You can use npa_check_ddl to check the format of a DDL file before you use it to create an archive, apply schema changes, or apply permission changes.
Archive Bridge for Symantec EV A thin piece of software for forwarding remote storage requests and responses between File Archive Service and a storage medium, where a direct connection is not possible.
File Archive Service server The server on which the service manager runs.
67
File Archive Service service manager See service manager.
Record level expiry A method of expiring data that allows you to expire individual records from an archive, either by identifying the records that you want to expire, or by selecting to expire all relevant records from a table. To use this method, you must switch on record level expiry for each archive where you want record level expiry to apply. Once record level expiry is switched on for an archive, you can no longer use import level expiry for that archive, and you cannot go back to using import level expiry.
Remote storage device A device or service, other than a local disk, that can be used to store data.
Retention period If you are using the remote storage version of File Archive Service, your remote device might support a retention period. If this is the case, when you install File Archive Service you can specify a default retention period for the remote device.
If you are using the default expiry method of import level expiry, you can specify a retention period when you execute the expiry command. This retention period controls which import subdirectories are expired and which are kept.
If you switch on record level expiry for an archive, you specify a default retention period for the archive. This retention period is used to generate expiry dates for data already in the archive. For subsequent imports, if no specific retention period is selected, the archive’s default retention period is used to generate expiry dates for the imported data.
Retired archive An archive that is no longer visible to File Archive Service. The archive has not been physically deleted, but can no longer be queried.
Scheduled task A task that does not run immediately, but instead is added to the task queues to be processed when a service manager slot becomes available. A scheduled task can spawn one or more child tasks (or sub‐tasks).
68
Schema change file A file containing all the details of the schema changes to apply to an archive. The statements in the file must conform to File Archive Service DDL grammar. The full path to the schema change file must be supplied as a parameter when you run npa_update_schema.
Schema version Each table within an archive is created using a particular schema, which specifies the column names and data types within the table. Whenever you apply a set of schema changes to the schema, File Archive Service creates a new schema version within the archive. These schema versions enable the query engine to select the correct version of the schema when processing a point‐in‐time query.
Service manager A piece of software that manages File Archive Service by processing jobs from an archive’s task queue. Each implementation of File Archive Service must have at least one service manager, but can have more.
Shared area The data and metadata areas of File Archive Service. These comprise the archived data, security and configuration data, SQL views, and the system archive.
Single instancing See Field level de‐duplication.
SQL Structured Query Language. A widely used computer language for creating, modifying, retrieving, and manipulating data from relational database management systems (RDBMS). There are several ANSI/ISO SQL standards, including SQL‐92 and SQL‐99. File Archive Service supports SQL‐92, with a subset of Oracle and SQL Server extensions.
SQL is pronounced either as the names of the individual letters (S‐Q‐L), or like the word sequel.
69
Staging area A data storage area to which File Archive Service must have read access. If data is exported from a query to a staging area, File Archive Service also needs write access to that area.
A staging area is used for holding data that has been extracted from a data source. It can also hold the schema information from the data sources, which tells File Archive Service how that data is structured. Data intended for import into File Archive Service, and held in a staging area, must be in either delimited or XML format load files.
Super-user See Archive super‐user.
System archive An internally created and maintained archive that is located in the metadata directory. This archive contains queryable versions of File Archive Service audit and log records.
Task groups The File Archive Service queue management system uses the concept of task groups to prevent conflicting tasks from running at the same time. You can block the task queues for selected groups of tasks, so that no further tasks from the blocked groups can be submitted.
The first row of the table below shows the task group names. Within each group the table lists the tasks that are included in that group. You can block the queues for individual archives, either for a single task group or for multiple task groups. You cannot block general tasks.
Table 6: Queue management task groups
GROUP — — — — Tasks — — — —
import npa_create_archive npa_load_data
query all queries
schema_change npa_update_schema npa_update_security
general npa_admin tasks all other tasks
70
Timezone offset An offset that indicates the time difference between a given logical time or archive time, and Universal Time (UTC). The offset value is negative if the given time is behind UTC, and positive if the given time is ahead of UTC.
The following web page gives a useful list of timezone abbreviations, and offsets from UTC:
http://www.timeanddate.com/library/abbreviations/timezones/
Tree file One or more tree partitions that are joined in memory to satisfy a query.
Also, the extension used to identify individual archive data files within the shared area.
Tree partition The in‐memory representation of an archive data file. Only those archive data files that are required to satisfy a query are selected from an archive. Once loaded into memory, these tree partitions are joined seamlessly in the background, with no user intervention.
Universal Time (UTC) UTC=Coordinated Universal Time. The equivalent of Greenwich Mean Time (GMT), which is the time kept on the Greenwich meridian (longitude zero). To convert a local time to UTC, you must supply the timezone offset. Internal times within File Archive Service, such as those included in schema version directory names, are in Universal Time.
URL Uniform Resource Locator or Identifier. The address of, and means of describing, the primary access mechanism for a resource. The URL defines the route to a file or resource.
VIM Vendor Implementation Module. A piece of vendor‐written code that translates XAM requests into device‐specific actions. A VIM enables a vendor application to communicate with a remote storage device using the XAM standard interface.
71
WebDAV Web‐based Distributed Authoring and Versioning. A set of extensions to the HTTP protocol that allows users to collaboratively edit and manage files on remote web servers. When used in conjunction with File Archive Service, a WebDAV server is used as the remote archive store.
XAM eXtensible Access Method. A standard interface that enables application and management software to store data on, and retrieve data from, a fixed‐content remote storage device. XAM enables the contents of the remote device to be guaranteed and verified.
XML eXtensible Markup Language. XML is a simplified subset of Standard Generalized Markup Language (SGML). The way XML is structured makes it relatively easy to share data across different information systems – XML created in one software application can be passed to, and read by, other applications without having to be reformatted, or translated into a different computer language.
72
73
Index
A
adding new DSN data source, 16
advanced properties confirming values, 27 DSN setup, 21
advanced query options custom parameters, 25
and schema custom properties, 41 JDBC URL, 48 ODBC connection string, 31 ODBC Unix driver, 41
archive custom properties, 40 DSN, 20 JDBC URL, 47 ODBC connection string, 29 ODBC Unix driver, 40 populating list, 20 selecting, 20
archive time changing, 15, 22, 23, 24, 32, 49 custom properties, 41 enabling, 22, 31, 32, 41, 48, 49 JDBC URL, 48 ODBC connection string, 31 ODBC Unix driver, 41 selecting schema, 25 setting, 15, 22, 23, 24, 31, 32, 41, 45, 48, 49 universal time, 25
C
changing archive time, 15, 22, 23, 24, 32, 49 DSN configuration, 16 encryption on server, 52 encryption option, 15, 22, 29 encryption setting, 52
classpath including jar files, 45
completing DSN setup dialog, 19
configuring data, 12 initial DSN connection, 12 JDBC data source, 3, 46 JDBC driver, 3, 45 ODBC data source, 3, 12, 28, 38 Unix ODBC driver, 3, 38 Windows ODBC driver, 3, 12, 28
confirming advanced DSN setup properties, 27
connecting third‐party tool, 3
connection string configuring data source, 3, 28 elements, 28 JDBC driver, 45 JDBC URL, 46
conventions cautions, ix notes, ix tips, ix typefaces, ix
custom parameters advanced query options, 25 supplying, 25
custom properties and schema, 41 archive, 40 archive time, 41 enable archive time, 41 enabling metadata, 40 ODBC Unix driver, 40 parser, 40
D
data source adding new, 16 changing configuration, 16 configuring under DSN, 12
data source description DSN, 19
data source name
74
DSN, 19 ODBC Unix driver, 39
description DSN, 19
document conventions, ix typefaces, ix
documentation available, x for drivers, 2
driver ODBC connection string, 28
driver class JDBC driver, 45
DSN adding new data source, 16 advanced properties, 21 archive, 20 changing configuration, 16 completing the dialog, 19 configuring data source, 3, 12 configuring initial connection, 12 confirming advanced properties, 27 data source name, 19 description, 19 password, 19 port number, 19 server, 19 SQL parser, 20 user name, 19
DSN setup advanced properties, 21 completing, 19 confirming advanced properties, 27
E
enable archive time custom properties, 41 JDBC URL, 48 ODBC connection string, 31 ODBC Unix driver, 41
enabling archive time, 22, 31, 32, 41, 48, 49 encryption, 29, 40, 46, 51 encryption on server, 51
enabling metadata
custom properties, 40 encrypted JDBC URL, 46 ODBC connection string, 29 ODBC Unix driver, 40
encryption changing setting, 52 enabling, 29, 40, 46, 51 enabling on server, 51, 52
encryption option changing, 15, 22, 29
F
File Archive Service connecting to, 3
H
help with product, xi
host ODBC connection string, 28 ODBC Unix driver, 39
I
installation directory Windows ODBC driver, 9
installing JDBC driver, 3, 45 Unix ODBC driver, 3, 36 Windows ODBC driver, 3, 7
J
jar files JDBC driver, 45
JDBC data source configuring using URL, 3, 46
JDBC driver about, 2, 45 classpath, 45 configuring, 3, 45 connection string, 45
75
documentation, 2 driver class, 45 installing, 3, 45 jar files, 45 maximum statement length, 2, 35, 45
JDBC URL and schema, 48 archive, 47 archive time, 48 connection string elements, 46 enable archive time, 48 encrypted, 46 parser, 47 password, 46 port, 46 server, 46 SQL parser, 47 user name, 46
M
maximum statement length JDBC driver, 2, 35, 45 ODBC driver, 2, 6, 35
metadata duplicate column names, 26, 30, 41, 47 querying, 15, 25, 30, 40, 47 specifying different prefix, 26, 30, 41, 47
O
ODBC connection string and schema, 31 archive, 29 archive time, 31 driver, 28 enable archive time, 31 encrypted, 29 host, 28 parser, 30 password, 29 port, 28 pwd, 29 SQL parser, 30 UID, 29 user name, 29
ODBC data source
configuring using connection string, 3, 28 configuring using DSN, 3, 12 ODBC Unix driver, 39
ODBC driver about, 2, 6, 35 configuring under Unix, 3, 38 configuring under Windows, 3, 12, 28 documentation, 2 installation directory, 9 installing under Unix, 3, 36 installing under Windows, 3 installing under Windows, 7 maximum statement length, 2, 6, 35 Unix, 35
ODBC Unix driver and schema, 41 archive, 40 archive tTime, 41 custom properties, 40 data source name, 39 enable archive time, 41 encrypted, 40 host, 39 ODBC data sources, 39 parser, 40 port, 39
P
parser custom properties, 40 JDBC URL, 47 ODBC connection string, 30 ODBC Unix driver, 40 SQL, 20, 30, 47
password DSN, 19 JDBC URL, 46 ODBC connection string, 29
port DSN, 19 JDBC URL, 46 ODBC connection string, 28 ODBC Unix driver, 39
product support, xi pwd ODBC connection string, 29
76
77
Q
querying metadata, 15, 25, 30, 40, 47
S
schema selecting, 25 setting, 31, 32, 41, 48, 49
selecting archive, 20 archive time (and schema), 25
server DSN, 19 JDBC URL, 46
setting archive time, 15, 22, 23, 24, 31, 32, 41, 45, 48, 49 schema, 31, 32, 41, 48, 49
SQL parser DSN, 20 JDBC URL, 47 ODBC connection string, 30
SSL encryption changing, 29, 46, 51, 52 enabling, 40
SSL encryption option changing, 22, 29
statement length maximum via JDBC driver, 2, 35, 45 maximum via ODBC driver, 2, 6, 35
supplying custom parameters, 25
support details, xi
T
third‐party tool connecting to File Archive Service, 3
U
UID ODBC connection string, 29
universal time using in archive time, 25
Unix ODBC driver about, 35 configuring, 3, 38 installing, 3, 36
URL configuring data source, 3, 46
user name DSN, 19 JDBC URL, 46 ODBC connection string, 29
W
Windows ODBC driver about, 6 configuring, 3, 12, 28 installation directory, 9 installing, 3, 7
Related Documents
