You are on page 1of 30

What would you do if you knew?

Teradata Studio, Studio Express, and


Plug-in for Eclipse
Installation Guide
Release 15.12
B035-2037-086K
August 2016

The product or products described in this book are licensed products of Teradata Corporation or its affiliates.
Teradata, Active Data Warehousing, Active Enterprise Intelligence, Applications-Within, Aprimo Marketing Studio, Aster, BYNET, Claraview,
DecisionCast, Gridscale, MyCommerce, QueryGrid, SQL-MapReduce, Teradata Decision Experts, "Teradata Labs" logo, Teradata
ServiceConnect, Teradata Source Experts, WebAnalyst, and Xkoto are trademarks or registered trademarks of Teradata Corporation or its
affiliates in the United States and other countries.
Adaptec and SCSISelect are trademarks or registered trademarks of Adaptec, Inc.
AMD Opteron and Opteron are trademarks of Advanced Micro Devices, Inc.
Apache, Apache Avro, Apache Hadoop, Apache Hive, Hadoop, and the yellow elephant logo are either registered trademarks or trademarks of
the Apache Software Foundation in the United States and/or other countries.
Apple, Mac, and OS X all are registered trademarks of Apple Inc.
Axeda is a registered trademark of Axeda Corporation. Axeda Agents, Axeda Applications, Axeda Policy Manager, Axeda Enterprise, Axeda
Access, Axeda Software Management, Axeda Service, Axeda ServiceLink, and Firewall-Friendly are trademarks and Maximum Results and
Maximum Support are servicemarks of Axeda Corporation.
Data Domain, EMC, PowerPath, SRDF, and Symmetrix are registered trademarks of EMC Corporation.
GoldenGate is a trademark of Oracle.
Hewlett-Packard and HP are registered trademarks of Hewlett-Packard Company.
Hortonworks, the Hortonworks logo and other Hortonworks trademarks are trademarks of Hortonworks Inc. in the United States and other
countries.
Intel, Pentium, and XEON are registered trademarks of Intel Corporation.
IBM, CICS, RACF, Tivoli, and z/OS are registered trademarks of International Business Machines Corporation.
Linux is a registered trademark of Linus Torvalds.
LSI is a registered trademark of LSI Corporation.
Microsoft, Active Directory, Windows, Windows NT, and Windows Server are registered trademarks of Microsoft Corporation in the United
States and other countries.
NetVault is a trademark or registered trademark of Dell Inc. in the United States and/or other countries.
Novell and SUSE are registered trademarks of Novell, Inc., in the United States and other countries.
Oracle, Java, and Solaris are registered trademarks of Oracle and/or its affiliates.
QLogic and SANbox are trademarks or registered trademarks of QLogic Corporation.
Quantum and the Quantum logo are trademarks of Quantum Corporation, registered in the U.S.A. and other countries.
Red Hat is a trademark of Red Hat, Inc., registered in the U.S. and other countries. Used under license.
SAP is the trademark or registered trademark of SAP AG in Germany and in several other countries.
SAS and SAS/C are trademarks or registered trademarks of SAS Institute Inc.
Simba, the Simba logo, SimbaEngine, SimbaEngine C/S, SimbaExpress and SimbaLib are registered trademarks of Simba Technologies Inc.
SPARC is a registered trademark of SPARC International, Inc.
Symantec, NetBackup, and VERITAS are trademarks or registered trademarks of Symantec Corporation or its affiliates in the United States and
other countries.
Unicode is a registered trademark of Unicode, Inc. in the United States and other countries.
UNIX is a registered trademark of The Open Group in the United States and other countries.
Other product and company names mentioned herein may be the trademarks of their respective owners.

The information contained in this document is provided on an "as-is" basis, without warranty of any kind, either express
or implied, including the implied warranties of merchantability, fitness for a particular purpose, or non-infringement.
Some jurisdictions do not allow the exclusion of implied warranties, so the above exclusion may not apply to you. In no
event will Teradata Corporation be liable for any indirect, direct, special, incidental, or consequential damages,
including lost profits or lost savings, even if expressly advised of the possibility of such damages.
The information contained in this document may contain references or cross-references to features, functions, products, or services that are not
announced or available in your country. Such references do not imply that Teradata Corporation intends to announce such features, functions,
products, or services in your country. Please consult your local Teradata Corporation representative for those features, functions, products, or
services available in your country.
Information contained in this document may contain technical inaccuracies or typographical errors. Information may be changed or updated
without notice. Teradata Corporation may also make improvements or changes in the products or services described in this information at any
time without notice.
To maintain the quality of our products and services, we would like your comments on the accuracy, clarity, organization, and value of this
document. Please e-mail: teradata-books@lists.teradata.com
Any comments or materials (collectively referred to as "Feedback") sent to Teradata Corporation will be deemed non-confidential. Teradata
Corporation will have no obligation of any kind with respect to Feedback and will be free to use, reproduce, disclose, exhibit, display, transform,
create derivative works of, and distribute the Feedback and derivative works thereof without limitation on a royalty-free basis. Further, Teradata
Corporation will be free to use any ideas, concepts, know-how, or techniques contained in such Feedback for any purpose whatsoever,
including developing, manufacturing, or marketing products or services incorporating Feedback.

Copyright 2016 by Teradata. All Rights Reserved.

Table of Contents

Preface...................................................................................................................................................................5
Audience..........................................................................................................................................................................5
Revision History.............................................................................................................................................................5
Related Documentation................................................................................................................................................ 5
Product Safety Information.......................................................................................................................................... 5

Chapter 1:
Dependencies...............................................................................................................................................7
Supported Platforms......................................................................................................................................................7
Supported Databases..................................................................................................................................................... 7
Hardware Requirements............................................................................................................................................... 8
Software Requirements..................................................................................................................................................8

Chapter 2:
Installing Teradata Studio........................................................................................................ 9
Installing Java Runtime Environment.........................................................................................................................9
Software Downloads...................................................................................................................................................... 9
Downloading Teradata Studio from DevX.....................................................................................................9
Installing Teradata Studio on Windows Systems...................................................................................................... 9
Installing Teradata Studio on Linux Systems...........................................................................................................10
Installing Teradata Studio on Mac Systems............................................................................................................. 11
Changing the Workspace Directory Location......................................................................................................... 11
Changing the Workspace Directory Location on Windows Systems.......................................................11
Changing the Workspace Directory Location on Linux Systems............................................................. 11
Changing the Workspace Directory Location on Mac Systems................................................................11
Setting Up a Teradata Connector for Hadoop.........................................................................................................12

Chapter 3:
Installing Teradata Studio Express............................................................................15
Installing Java Runtime Environment...................................................................................................................... 15
Software Downloads.................................................................................................................................................... 15
Downloading Teradata Studio Express from DevX.................................................................................... 15
Installing Teradata Studio Express on Linux Systems............................................................................................ 15
Installing Teradata Studio Express on Mac Systems...............................................................................................16
Installing Teradata Studio Express on Windows Systems..................................................................................... 16
Changing the Workspace Directory Location......................................................................................................... 17
Changing the Workspace Directory Location on Windows Systems.......................................................17
Teradata Studio, Studio Express, and Plug-in for Eclipse
Installation Guide, Release 15.12

Table of Contents

Changing the Workspace Directory Location on Linux Systems............................................................. 17


Changing the Workspace Directory Location on Mac Systems................................................................17

Chapter 4:
Installing Teradata Plug-in for Eclipse................................................................. 19
Before You Begin..........................................................................................................................................................19
Installing Java Runtime Environment...................................................................................................................... 19
Installing the Teradata Plug-in for Eclipse............................................................................................................... 19
Configuration Options for Java Stored Procedures and Java User-Defined Functions.....................................20
Setting the Compiler Compliance Level....................................................................................................... 21

Appendix A:
Optional Software................................................................................................................................23
Optional Software........................................................................................................................................................ 23
Installing Teradata Meta Data Services.....................................................................................................................23
Installing Apache Ant..................................................................................................................................................24
Installing Apache Tomcat...........................................................................................................................................24
Installing Oracle GlassFish......................................................................................................................................... 24
Installing Oracle GlassFish Metro JARs....................................................................................................................24
Configuring Teradata MDS Web Service................................................................................................................. 25
Setting the Tomcat Java Classpath.................................................................................................................25
Setting the GlassFish Java Classpath............................................................................................................. 25
Deploying the MDS Web Service on Tomcat.............................................................................................. 25
Deploying the MDS Web Service on GlassFish........................................................................................... 25
Verifying the Meta Data Services Web Service is Running on Tomcat................................................... 26
Verifying Meta Data Services Web Service is Running on GlassFish.......................................................26
Setting Teradata Dependencies Preferences.................................................................................................26
Installing Teradata XML Services..............................................................................................................................27

Appendix B:
Administrative Tasks.......................................................................................................................29
Updating the JRE Location in the TeradataStudio.ini File.....................................................................................29
Changing Workspace and Configuration Information Directories Using Roaming Profiles.......................... 29
Uninstalling Teradata Studio from Linux................................................................................................................ 30
Uninstalling Teradata Studio Express from Linux..................................................................................................30

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Preface

Audience
This book is intended for system administrators, analysts, engineers, and other database specialists who
perform product installations or use Teradata Tools and Utilities products.

Revision History
Date

Release

Description

August 2016

15.12

Release 15.12 initial release.

Related Documentation
Documents are located at http://www.info.teradata.com.
Publication Name

Publication ID

Teradata Studio User Guide

B035-2041

Teradata Studio Plug-in for Eclipse User Guide

B035-2043

Teradata Studio Express User Guide

B035-2042

Product Safety Information


This document may contain information addressing product safety practices related to data or property
damage, identified by the word Notice. A notice indicates a situation which, if not avoided, could result in
damage to property, such as equipment or data, but not related to personal injury.
Example

Notice:
Improper use of the Reconfiguration utility can result in data loss.

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Preface
Product Safety Information

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

CHAPTER 1

Dependencies

Supported Platforms
The following table lists the operating systems on which Teradata Studio, Studio Express, and Plug-in for
Eclipse are supported:
Platform

Studio

Studio
Express

Plug-in for
Eclipse

Microsoft Windows Vista, 32-bit and 64-bit

Microsoft Windows 7, 32-bit and 64-bit

Microsoft Windows 8 and 8.1

Microsoft Windows 10, 32-bit and 64-bit

Red Hat Enterprise Server 5.0, 6.0, and 7.0, 32-bit and 64-bit

Red Hat Advanced Platform 5.0, 6.0, and 7.0 32-bit and 64-bit

SUSE Linux Enterprise 10, 32-bit and 64-bit

SUSE Linux Enterprise 11, 32-bit and 64-bit

SUSE Linux Enterprise 12, 32-bit and 64-bit

Mac OS X 10.7, 10.8, 10.9, 10.10, and 10.11

CentOS 7, 32-bit and 64-bit

Supported Databases
Teradata Studio, Studio Express, and Plug-in for Eclipse support the following Teradata Database releases:

Teradata Database 15.10


Teradata Database 15.0
Teradata Database 14.10
Teradata Database 14.0
Teradata Database 13.10

Teradata Studio, Studio Express, and Plug-in for Eclipse support the following Aster Database releases:
Aster Database 6.20
Aster Database 6.10
Aster Database 6.00
Teradata Studio, Studio Express, and Plug-in for Eclipse support the following Hadoop systems:
Teradata Studio, Studio Express, and Plug-in for Eclipse
Installation Guide, Release 15.12

Chapter 1: Dependencies
Hardware Requirements

Hortonworks Data Platform (HDP)

HDP 2.4 (Hadoop 2.4.0, Hiveserver2(HCatalog) .0.13.1


HDP 2.3 (Hadoop 2.4.0, Hiveserver2(HCatalog) .0.13.1
HDP 2.1.3 (Hadoop 2.4.0, Hiveserver2(HCatalog) 0.13.1)
HDP 2.1.0 (Hadoop 2.4.0, Hiveserver2(HCatalog) 0.13.0)

Cloudera Hadoop (CDH) versions


CDH 5.7 (Hadoop 2.0, HCatalog 0.5.0)
CDH 5.5 (Hadoop 2.0, HCatalog 0.5.0)
CDH 5.4 (Hadoop 2.0, HCatalog 0.5.0)

Hardware Requirements
The following table lists the minimum hardware requirements for Teradata Studio and Teradata Studio
Express.
Studio

Studio Express

Memory

4 GB (6 GB desired)

4 GB

Disk Space

250 MB

250 MB

Software Requirements
You must download and install the JDK, Eclipse, and Data Tools Platform (DTP) software to create an
Eclipse DTP Environment.
The following table lists the required software, supported versions, and where to download it:
Dependent Product

Supported
Versions

Download Locations

Java Development Kit

7 and 8

Java SE Downloads

Note:
Apple OS
X 10.7
and
higher
requires
Oracle's
JDK 1.7
or higher

Eclipse IDE for Java EE


Developers

Mars 4.5

http://www.eclipse.org/downloads/packages/eclipse-ide-javaee-developers/mars2

Neon

4.6

https://www.eclipse.org/downloads/packages/eclipse-ide-javaee-developers/neonr

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

CHAPTER 2

Installing Teradata Studio

Installing Java Runtime Environment


This task describes how to install the Java Runtime Environment (JRE) 1.7 or greater.
1.
2.
3.
4.
5.

Go to the Java SE Downloads website.


In the Java Platform, Standard Edition section, click Download under JRE.
Select Accept License Agreement.
Select the download for the appropriate operating system.
Follow the installation instructions on the Java SE Downloads website.

Software Downloads
Downloading Teradata Studio from DevX
1.
2.
3.
4.
5.

Go to Teradata Developer Exchange Downloads.


Click the Teradata Studio link to access the downloads page.
Click the link for your operating system.
Accept the License Agreement by clicking I Agree.
In the File Download dialog, click Save, navigate to the location where you want to download the file,
and click Save again.
The zip file downloads to your local file system.

Installing Teradata Studio on Windows Systems


1. Navigate to the directory where you downloaded the Teradata Studio package.
2. Unzip the Teradata Studio package to your local file system.
3. [Optional] Pre-configure connection profiles to be assigned at installation:
a) In the unzipped Teradata Studio package, navigate to the Config directory.
b) Edit the TeradataStudioDataSources_template.config file to define the connection
profiles.
c) Save the file as TeradataStudioDataSources.config in the Config directory or any other
directory that is accessible by the installation process.
4. [Optional] Pre-configure preferences to be set at installation:

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Chapter 2: Installing Teradata Studio


Installing Teradata Studio on Linux Systems

Note:
If you edited and saved the TeradataStudioDataSources.config file to an alternate directory
location in the previous step, then save the TeradataStudioPreferences.config file to this
same location.

5.

6.

7.

8.

a) In the unzipped Teradata Studio package, navigate to the Config directory.


b) Edit the TeradataStudioPreferences_template.config file to define the preferences.
c) Save the file as TeradataStudioPreferences.config in the Config directory or any other
directory that is accessible by the installation process.
Double-click setup.exe to start the Teradata Studio installer.
A workspace directory that contains workspace files, including the SQL project folder and log file is
created in your home directory: C:\Users\<user>\workspace.
[Optional] If you edited the TeradataStudioDataSources.config file, do the following in the
install wizard:
a) On the Pre-Configure Database Connection Profile page of the Install Wizard, select Setup Studio
with Pre-Configured TeradataStudioDataSources.config Connection Profiles.
b) Browse for the location of the TeradataStudioDataSources.config file.
c) Click Next.
[Optional] If you edited the TeradataStudioPreferences.config file, do the following in the
install wizard:
a) On the Pre-Configure Database Preferences page of the Install Wizard, select Setup Studio with
Pre-Configured TeradataStudioPreferences.config Connection Profiles.
b) Browse for the location of the TeradataStudioPreferences.config file.
c) Click Next until the Install button displays.
Click the Install button

Installing Teradata Studio on Linux Systems


1. Navigate to the directory where you downloaded the Teradata Studio package.
2. Unzip the Teradata Studio package to your local file system:
gunzip TeradataStudio__linux_i386.15.12.00.00-1.tar.gz
tar xvf TeradataStudio.15.12.00.00-1.tar
3. Change to the Teradata Studio directory:
cd TeradataStudio.15.12.00.00
4. Switch to Super User or Root and install Teradata Studio:
sudo ./studioinstall TeradataStudio-15.12.00.00-1.i86.rpm.
5. Provide the path to install Teradata Studio.
The default is /opt/teradata.
A workspace directory that contains workspace files, including the SQL project folder and log file is
created in your home directory: \home \<user>\workspace.

10

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Chapter 2: Installing Teradata Studio


Installing Teradata Studio on Mac Systems

Installing Teradata Studio on Mac Systems


1.
2.
3.
4.

Unzip the Teradata Studio package to your local file system.


Open Teradata Studio.pkg to start the Teradata Studio installer.
Select the disk on which to install Teradata Studio.
[Optional] Enter a specific installation location.
The default location is /Applications.
A workspace folder called SQLA that contains workspace files, including the SQL project folder and log
file, is created in the Documents folder.

Changing the Workspace Directory Location


When Teradata Studio is first launched, a workspace directory called workspace-studio is created in a default
location. The workspace is used for storing files and preferences.
Operating System

Default Workspace Location

Linux

The directory in which Teradata Studio is run.

Mac

/Users/Username/Documents/StudioWorkspace

Windows

C:\Users\Username\workspace-studio

You can change the location of the workspace directory from the default.

Changing the Workspace Directory Location on Windows


Systems
1. Right click the Teradata Studio shortcut on the desktop and select Properties.
2. Add the data option and new location for the workspace to the end of the Target field:
-data workspaceLocation.

Changing the Workspace Directory Location on Linux Systems


1. Specify the new directory in the command line program execution string:
./opt/teradata/TeradataStudio/TeradataStudio data /home /guestUser/
MyWorkspace

Changing the Workspace Directory Location on Mac Systems


1. Open the Terminal application.
2. Specify the new directory in the command line program execution string:
/Applications/TeradataStudio/Teradata\ Studio.app/Contents/MacOS/
TeradataStudio data /Users/guestUser/Documents/MyWorkspace.
Teradata Studio, Studio Express, and Plug-in for Eclipse
Installation Guide, Release 15.12

11

Chapter 2: Installing Teradata Studio


Setting Up a Teradata Connector for Hadoop

Setting Up a Teradata Connector for Hadoop


Teradata Studio provides an option to transfer data to and from Hadoop systems. The Smart Loader for
Hadoop feature uses the Teradata connector for Hadoop (TDCH) installed on the Hadoop node. Oozie is
used for the data transfer workflow.
1. Download and install the TDCH (version 1.4.4) onto your Hadoop system from Teradata Developer
Exchange Downloads under Connectivity.
2. Download the Configure Oozie script (configureOozie.sh) from Teradata Developer Exchange
Downloads onto your Hadoop system.
3. Change the mode so the script is executable:
chmod +x configureOozie.sh
4. Run configureOozie.sh to remove any hidden Windows characters from the file.
dos2unix configureOozie.sh
5. Execute configureOozie.sh as a root user, providing the locations of your Hadoop services:
Usage: ./configureOozie.sh nn=nameNodeHost[jt=jobTrackerHost][oozie=oozieHost]
[nnPort=nameNodePortNum][jtPort=jobTrackerPortNum][ooziePort=ooziePortNum]
[webhcatPort=webhcatPortNum] [webhdfsPort=webhdfsPortNum] where
Parameter

Definition

Value

nameNodeHost

The Name Node host name

required

jobTrackerHost

The Job Tracker host name

uses nn parameter value if omitted

oozieHost

The Oozie host name

uses nn parameter value if omitted

nameNodePortNum The Name node port number

8020 if omitted

jobTrackerPortNum The Job Tracker port number

50300 if omitted

ooziePortNum

The Oozie port number

11000 if omitted

webhcatPortNum

The WebHCatalog port number 50111 if omitted

webhdfsPortNum

The WebHDFS port number

50070 if omitted

Note:
The port numbers are HDP's defaults. If the system being set up has all the services hosted on a single
system on the default ports, only the nn parameter is needed.
The script exits with an error message if the TDCH is not in its expected location. Otherwise the script
displays a message indicating the parameters values. For example:
The following is the specification of the Hadoop services used
by the Oozie workflows:
{
"Distribution":"HDP",
"DistributionVersion":"3.2.1",
"WebHCatalog":"hostname",
"WebHCatalogPort":50111,
"WebHDFS":"hostname",
"WebHDFSPort":50070,
"JobTracker":"hostname",
"JobTrackerPort":50300,
12

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Chapter 2: Installing Teradata Studio


Setting Up a Teradata Connector for Hadoop

"NameNode":"hostname",
"NameNodePort":8020,
"Oozie":"hostname",
"OoziePort":11000
}

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

13

Chapter 2: Installing Teradata Studio


Setting Up a Teradata Connector for Hadoop

14

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

CHAPTER 3

Installing Teradata Studio Express

Installing Java Runtime Environment


This task describes how to install the Java Runtime Environment (JRE) 1.7 or greater.
1.
2.
3.
4.
5.

Go to the Java SE Downloads website.


In the Java Platform, Standard Edition section, click Download under JRE.
Select Accept License Agreement.
Select the download for the appropriate operating system.
Follow the installation instructions on the Java SE Downloads website.

Software Downloads
Downloading Teradata Studio Express from DevX
1.
2.
3.
4.
5.

Go to Teradata Developer Exchange Downloads.


Click Teradata Studio Express to access the downloads page.
Click the link for your operating system.
Accept the License Agreement by clicking I Agree.
In the File Download dialog, click Save, navigate to the location where you want to download the file,
and click Save again.
The zip file downloads to your local file system.

Installing Teradata Studio Express on Linux


Systems
1. Navigate to the directory where you downloaded the Teradata Studio Express package.
2. Unzip the Teradata Studio Express package to your local file system:
gunzip TeradataStudioExpress__linux_x86.15.12.00.00-1.tar.gz
tar xvf TeradataStudioExpress.15.12.00.00.tar
3. Change to the Teradata Studio Express directory:
cd TeradataStudioExpress.15.12.00.00.
4. Switch to Super User or Root and install Teradata Studio Express:
sudo ./studioexpressinstall TeradataStudioExpress-15.12.00.00-1.i386.rpm.
5. Provide the path to install Teradata Studio Express.

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

15

Chapter 3: Installing Teradata Studio Express


Installing Teradata Studio Express on Mac Systems

The default location is /opt/teradata.


A workspace directory that contains workspace files, including the SQL project folder and log file is
created in your home directory: \home\<user>\workspace.

Installing Teradata Studio Express on Mac


Systems
1.
2.
3.
4.

Unzip the Teradata Studio Express package to your local file system.
Open Teradata Studio Express.pkg to start the Teradata Studio Express Installer.
Select the disk on which to install Teradata Studio Express.
[Optional] Enter a specific installation location.
The default location is /Applications.
A workspace folder called SQLA that contains workspace files, including the SQL project folder and log
file, is created in the Documents folder.

Installing Teradata Studio Express on Windows


Systems
1. Navigate to the directory where you downloaded the Teradata Studio Express package.
2. Unzip the Teradata Studio Express package to your local file system.
3. Create connection profiles to be used at installation:
a) In the unzipped Teradata Studio Express package, navigate to the Config directory.
b) Edit the TeradataStudioExpressDataSources_template.config file to define the
connection profiles.
c) Save the file as TeradataStudioExpressDataSources.config in the Config directory or any
other directory that is accessible by the install.
4. [Optional] Set preferences to be used at installation:
a) In the unzipped Teradata Studio Express package, navigate to the Config directory.
b) Edit the TeradataStudioExpressPreferences_template.config file to define the
preferences.
c) Save the file as TeradataStudioExpressPreferences.config in the Config directory or any
other directory that is accessible by the installation process.
5. Double-click setup.exe to start the Teradata Studio Express installer.
A workspace directory that contains workspace files, including the SQL project folder and log file is
created in your home directory: C:\Users\<user>\workspace.
6. [Optional] If you edited the TeradataStudioExpressDataSources.config file, do the following
in the install wizard:
a) On the Pre-Configure Database Connection Profile page of the Install Wizard, select Setup Studio
Express with Pre-Configured TeradataStudioDataSources.config Connection Profiles.
b) Browse for the location of the TeradataStudioExpressDataSources.config file.
c) Click Next.

16

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Chapter 3: Installing Teradata Studio Express


Changing the Workspace Directory Location

7. [Optional] If you edited the TeradataStudioExpressPreferences.config file, do the following


in the install wizard:
a) On the Pre-Configure Database Preferences page of the Install Wizard, select Setup Studio Express
with Pre-Configured TeradataStudioPreferences.config Connection Profiles.
b) Browse for the location of the TeradataStudioPreferences.config file.
c) Click Next until the Install button displays.
8. Click Install.

Changing the Workspace Directory Location


When Teradata Studio Express is first launched, a workspace directory called workspace-studioexpress is
created in a default location. The workspace is used for storing files and preferences.
Operating System

Default Workspace Location

Linux

The directory in which Teradata Studio Express is run.

Mac

/Users/Username/Documents/StudioExpressWorkspace

Windows

C:\Users\Username\workspace-studioexpress

You can change the location of the workspace directory from the default.

Changing the Workspace Directory Location on Windows


Systems
1. Right click the Teradata Studio shortcut on the desktop and select Properties.
2. Add the data option and new location for the workspace to the end of the Target field:
-data workspaceLocation.

Changing the Workspace Directory Location on Linux Systems


1. Specify the new directory in the command line program execution string:
/opt/teradata/TeradataStudioExpress/TeradataStudioExpress data /home/
guestUser/MyWorkspace

Changing the Workspace Directory Location on Mac Systems


1. Open the Terminal application.
2. Specify the new directory in the command line program execution string:
/Applications/TeradataStudioExpress/Teradata\ Studio\ Express.app/Contents/
MacOS/TeradataStudioExpress data /Users/guestUser/Documents/MyWorkspace

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

17

Chapter 3: Installing Teradata Studio Express


Changing the Workspace Directory Location

18

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

CHAPTER 4

Installing Teradata Plug-in for Eclipse

Before You Begin


Before you begin working with Teradata Plug-in for Eclipse, you must install dependent products.
Related Information

Required Software for Teradata Plug-in for Eclipse

Installing Java Runtime Environment


This task describes how to install the Java Runtime Environment (JRE) 1.7 or greater.
1.
2.
3.
4.
5.

Go to the Java SE Downloads website.


In the Java Platform, Standard Edition section, click Download under JRE.
Select Accept License Agreement.
Select the download for the appropriate operating system.
Follow the installation instructions on the Java SE Downloads website.

Installing the Teradata Plug-in for Eclipse


You can also use this procedure for upgrades.
Installations and upgrades of Teradata Plug-in for Eclipse require additional steps to install the EMF Client
Platform (ECP).
You should install Eclipse into a new or empty directory. If you have a preexisting Eclipse installation but
want to use the same directory path for the new installation, you can rename the current directory and then
install a new version of Eclipse into the desired directory.
1.
2.
3.
4.

5.
6.
7.

Set up your JRE environment.


Install the Eclipse IDE for Java EE Developers.
From the Eclipse main menu, select Help > Install New Software.
At Work with, enter the EMF ECP 1.9.x Update Site: http://download.eclipse.org/ecp/releases/
releases_19/
If you have the previous version of the EMF ECP installed, remove it from Eclipse before installing the
new version.
Click Add.
Select the ECP SDK 3.x option under the All SDKs category.
Click Next>.
The EMF Client Platform and ECP SDK features display for your selection.

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

19

Chapter 4: Installing Teradata Plug-in for Eclipse


Configuration Options for Java Stored Procedures and Java User-Defined Functions

8.
9.
10.

11.
12.
13.
14.
15.
16.
17.

18.
19.
20.
21.
22.
23.

Click Next> to confirm the selected features.


In the Review Licenses window, click I accept the terms of the license agreement, and click Finish.
The Installing Software dialog displays to show the progress of the EMF Client Platform and ECP SDK
installations.
When you receive a Security Warning message advising that you are installing software that contains
unsigned content, click OK to continue.
You may choose to cancel the installation if you are concerned about the authenticity or validity of the
feature software. You cannot install Teradata Plug-in for Eclipse without installing the ECP feature
first.
When prompted to restart Eclipse, click No.
Locate your Eclipse directory, and delete plugins
\org.eclipse.emf.ecp.view.swt.layout_<versionNumber>.jar.
Click File > Restart to restart Eclipse and effect your changes.
From the Eclipse main menu, click Help and select Install New Software.
Click Add.
At Name, type Teradata Update Site.
Type the following URL at Location:
http://downloads.teradata.com/download/cdn/tools/tdide/tdide-15.12.00.00/
update/site.xml.
Click OK.
Select each of the Teradata Plug-in for Eclipse components to install and click Next.
When the Feature License Agreement window appears, select I accept the terms in the license
agreement and click Next.
A list of features that specifies version, size, and Eclipse install location appears.
Verify that the information is correct and click Finish.
When you receive a Security Warning advising that you are installing software with unsigned content,
click OK to continue.
Click Yes to restart Eclipse.

Configuration Options for Java Stored


Procedures and Java User-Defined Functions
When creating and deploying Java Stored Procedures and Java User-defined Functions, make sure the JAR
name consists of the following valid characters:
Uppercase or lowercase letters (A to Z, a to z)
Digits (0 through 9)
Special characters: dollar sign ($), number sign (#), low line (_), dot (.), and hyphen (-).
Note:
The JAR Name cannot be RETURNS or contain KANJI characters.

20

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Chapter 4: Installing Teradata Plug-in for Eclipse


Configuration Options for Java Stored Procedures and Java User-Defined Functions

Setting the Compiler Compliance Level


Teradata Database 15.12 supports JRE 1.6. However, Teradata Database versions earlier than 14.0 support
only JRE version 1.5. Because Teradata Plug-in for Eclipse requires JRE 1.6 (jre6), if you are connecting to a
Teradata Database version earlier than 14.0 the compiler compliance level must be set to 1.5 to create Java
stored procedures or Java functions compatible with Teradata Database. When creating a Teradata Project,
an option for the JRE execution environment appears:
1. In the Teradata Project Wizard, select Use and execution environment JRE and click JRE-1.6.

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

21

Chapter 4: Installing Teradata Plug-in for Eclipse


Configuration Options for Java Stored Procedures and Java User-Defined Functions

22

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

APPENDIX A

Optional Software

Optional Software
You can install the following products to run with Teradata Plug-in for Eclipse:
Product

Release

Description

Teradata Meta
Data Services

13.10.00 or
greater

Enables Teradata Plug-in for Eclipse to discover object dependencies


using the Interdependency Browser feature.

Teradata XML
Services

1.1.7 or greater

Generates XSD, XSLT, and returns XML result data from JavaBeans
using Teradata Plug-in for Eclipse.

Apache Ant

1.9.1 or greater

Download and install if you will run Ant outside of Eclipse from
http://ant.apache.org/.

Apache Tomcat 6.0.18 or greater Download and install from http://tomcat.apache.org/.


version
Oracle Glassfish 9.1_02 or
greater

Download and install from http://www.oracle.com/technetwork/


indexes/downloads/index.html.

Installing Teradata Meta Data Services


To use the Teradata Plug-in for Eclipse Interdependency Browser and Find Objects features, Teradata Meta
Data Services must be installed and its web service configured for the Teradata Database.
Refer to Teradata Meta Data Services Administrator Guide, B035-3118 (Release 13.01) for installation
instructions.
Note:
The Meta Data Services logon information is necessary to configure Teradata Plug-in for Eclipse to use
the Meta Data Services web service.
A web server must be downloaded and installed to run the Teradata Meta Data Services web service.
Teradata Meta Data Services supports the following web servers:
Web server

Version

Description

Apache Tomcat 6.0.18

GlassFish Metro JARs and Apache Ant are also required. Metro
provides an easy-to-use web service stack for running the web service.
Apache Ant is required to install the Metro JARs.

Sun's GlassFish

Suns GlassFish includes the Metro JARs.

9.1_02

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

23

Appendix A: Optional Software


Installing Apache Ant

Installing Apache Ant


Download and install Apache Ant from the Apache web site: http://ant.apache.org/.

Installing Apache Tomcat


Download and install Apache Tomcat version 6.0.18 from the Apache web site at http://
tomcat.apache.org/.

Installing Oracle GlassFish


1. Download and install GlassFish version 9.1_02 from the Oracle web site: http://www.oracle.com/
technetwork/indexes/downloads/index.html.

Installing Oracle GlassFish Metro JARs


GlassFish Metro JARs provides a web service stack for running the web service.
Note:
Apache Ant is required to install the Metro JARs.
1. Download the Metro JARS from the GlassFish Metro web site (https://metro.java.net/).
2. Perform the install on your system:
java jar metro.jar
The command unzips the Metro files onto your file system, creating a /lib directory. The folder
contains five JARs needed by Eclipse to run the web services client:

webservices-api.jar
webservices-extra.jar
webservices-extra-api.jar
webservices-rt.jar
webservices-tools.jar

A metro subdirectory containing the metro-on-tomcat.xml file is created. This file is an Ant install
script that installs the Metro JARs on your Tomcat system. The script creates the appropriate Tomcat
directory for the Metro libraries, copies the Metro libraries to the directory, and modifies the Tomcat
configuration file (catalina.properties).
3. Set the following environment variables in your operating system settings (in Windows, go to Control
Panel > System > Advanced Settings):
CATALINA_HOME to <TOMCAT_INSTALL_DIR>
CATALINA_BASE to <TOMCAT_INSTALL_DIR>
JAVA_HOME to <JAVA_RUNTIME_INSTALL_DIR>
PATH to include %JAVA_HOME%\bin
4. Run the metro-on-tomcat.xml Apache Ant script from the metro subdirectory:

24

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Appendix A: Optional Software


Configuring Teradata MDS Web Service

ant -Dtomcat.home=<TOMCAT_INSTALL_DIR> -f <METRO_INSTALL_DIR>/metro-ontomcat.xml install


The Metro JAR files copy to the <TOMCAT_INSTALL_DIR>/shared/lib directory.

Configuring Teradata MDS Web Service


The Meta Data Services web service WAR (Web Archive) uses metajava.jar (the Meta Data Services Java
API). It must be identified in the web server classpath.

Setting the Tomcat Java Classpath


1. In the TOMCAT_INSTALL_DIR/bin directory, double-click tomcat6w.exe.
2. Click the Java tab and modify the Java Classpath to include metajava.jar.
3. Click Apply, then click OK to close the Apache Tomcat Properties dialog.

Setting the GlassFish Java Classpath


For GlassFish, both the metajava.jar and the PATH to the Meta Data Services installation /bin
directory must be identified. Use the GlassFish Administrator console to create these settings.
1.
2.
3.
4.

Open the GlassFish Administrator Console.


Select Application Server.
Click the JVM Settings tab, then the Path Settings tab.
Enter the location of the Meta Data Services metajava.jar in the system Classpath and the location of
the Meta Data Services /bin directory in the Native Library Path Prefix.
5. Click Save.
6. Close the Administrator Console.
7. Restart the GlassFish web server.

Deploying the MDS Web Service on Tomcat


During the deploy process, you choose a port number for the web service. Use this information when
configuring Teradata Plug-in for Eclipse to use the MDS web service.
Tomcat has a unique folder for the MetaJavaWS.WAR file:<Teradata_MDS_INSTALL_DIR>/ws/tc.
Tomcat provides a mechanism through the respective Manager windows to deploy a web service.
1. Copy MetaJavaWS.WAR to the <TOMCAT>/webappps directory.
2. Select the /ws/tc directory as the location of the MDS web service WAR for Tomcat.
3. From the Apache Tomcat Properties dialog box, click Start to restart the Tomcat web server.

Deploying the MDS Web Service on GlassFish


During the deploy process, choose a port number for the web service. Use this information when
configuring Teradata Plug-in for Eclipse to use the MDS web service.

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

25

Appendix A: Optional Software


Configuring Teradata MDS Web Service

The unique folder for the MetaJavaWS.WAR is <Teradata_MDS_INSTALL_DIR>/ws/tc.


Note:
GlassFish provides a mechanism through the respective Manager windows to deploy a web service.
1. Open the GlassFish Administrator Console, and click Deploy on the Web Applications tab.
2. Browse for the location of the Teradata Meta Data Services web service WAR file.
3. Select the /ws/gf directory as the location of the Teradata Meta Data Services web service WAR for
GlassFish.
4. Click Save and restart the GlassFish web server.

Verifying the Meta Data Services Web Service is Running on


Tomcat
1. Go to http://localhost:8080.
2. Click the Tomcat Manager link at the top of the left hand column.
A prompt for the Tomcat administrator logon credentials appears.
3. Enter your logon credentials.
The Tomcat server displays a list of deployed applications.
4. To verify the application is deployed and running, scroll down the list to the Teradata Meta Data
Services WebServices application and make sure the Running column has a value of TRUE.

Verifying Meta Data Services Web Service is Running on


GlassFish
1. Open the GlassFish Administrator Console.
2. Verify that MDS Web Service appears in the list of web services.

Setting Teradata Dependencies Preferences


1.
2.
3.
4.
5.
6.

In Teradata Plug-in for Eclipse, click Windows > Preferences .


Click Teradata Datatools Preferences > Dependencies Preferences.
Enter the name of the Meta Data Services Web Service System.
Enter the port number for the web service.
Enter the user credentials to access Meta Data Services.
Click Test User to verify that the information is accurate and that the web service is running.
If the web service is running, a dialog displays the list of Teradata Database systems managed by Meta
Data Services.
Note:
If the system is not in the list, go to the Teradata Meta Data Services MetaManager application and
use the Database Administration utility to load the system into Meta Data Services.

26

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

Appendix A: Optional Software


Installing Teradata XML Services

Installing Teradata XML Services


To use the Teradata Plug-in for Eclipse XML features, install the Unicode version of the Teradata XML
Services.
1.
2.
3.
4.
5.

Go to Teradata Developer Exchange Downloads.


Click Teradata XML Services.
Click the link for your operating system.
Accept the License Agreement by clicking I Agree.
In the File Download dialog, click Save, navigate to the location where you want to download the file,
and click Save again.
6. Navigate to the location where the file was downloaded and unzip the package.
7. Follow the installation instructions provided in the /doc directory.
8. When the install script has run, select the option to install the Unicode version or publishing functions.

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

27

Appendix A: Optional Software


Installing Teradata XML Services

28

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

APPENDIX B

Administrative Tasks

Updating the JRE Location in the


TeradataStudio.ini File
During the install of Teradata Studio, the JRE location is recorded in the TeradataStudio.ini file. This .ini file
is located in your install directory. On Windows for example, it is located at:
C:\Program Files (x86)\Teradata\Client\15.10\Teradata Studio
After you have completed the install of Teradata Studio and the TeradataStudio.ini is created, the location of
your JRE may change if you automatically update the JRE revisions from the Oracle download site.
If your JRE location has changed, you should modify the TeradataStudio.ini file's reference to the JRE
location:
1. Identify the location of the JRE files on your computer, by entering the following.
-vm C:\Program Files (x86)\Java\jre7\bin\javaw.exe
2. Locate and open the teradatastudio.ini file.
C:\Program Files (x86)\Teradata\Client\15.10\Teradata Studio
3. Update the line in the .ini file that references the JRE location.

Changing Workspace and Configuration


Information Directories Using Roaming Profiles
When Teradata Studio is launched, it creates a workspace directory (called workspace-studio) in your User
Home directory. If you want to change the location of your workspace directory, you must pass the -data
option into the TeradataStudio executable by changing the Target parameter in the Windows desktop
shortcut or in the command window when launching Teradata Studio.
For example:
C:\Program Files (x86)\Teradata\Client\15.10\Teradata Studio
\TeradataStudio.exe" -data "c:\Teradata Studio\My Workspace
There is another directory (called .eclipse) created in your User Home directory that contains configuration
information and jars for launching Teradata Studio. If you want to change the location of your configuration
directory, you must pass the -configuration option into the TeradataStudio executable by changing
the Target parameter in the Windows desktop shortcut or in the command window when launching
Teradata Studio.
For example:
C:\Program Files (x86)\Teradata\Client\15.10\Teradata Studio
\TeradataStudio.exe" -configuration "c:\Teradata Studio
Teradata Studio, Studio Express, and Plug-in for Eclipse
Installation Guide, Release 15.12

29

Appendix B: Administrative Tasks


Uninstalling Teradata Studio from Linux

You can combine both the -data and -configuration options on a single command line.This is often
needed when using a Roaming Profile that is not always accessible when running applications.

Uninstalling Teradata Studio from Linux


Run the uninstall command:
rpm -e TeradataStudio

Uninstalling Teradata Studio Express from Linux


Run the uninstall command:
rpm -e TeradataStudioExpress

30

Teradata Studio, Studio Express, and Plug-in for Eclipse


Installation Guide, Release 15.12

You might also like