Configure a database connection for ArcGIS Server

In this topic

Install and configure the database client software
Reference the database client libraries in the init_user_param.sh script
Restart ArcGIS Server
Test your connection

To connect ArcGIS Server to a supported database platform, you'll need to do the following:

Install and configure the database client software

The following topics provide instructions on how to install and configure client software for specific databases. Keep in mind that you must install a release of the client software that is compatible with the release of the database to which you want to connect.

Follow the instructions in these topics to set up database client software on the ArcGIS Server machine:

No separate database client is needed to connect to PostgreSQL.

Reference the database client libraries in the init_user_param.sh script

For most databases, you need to reference the database client libraries in the ArcGIS Server init_user_param.sh script. You can access this script by browsing to the <ArcGIS Server installation directory>/arcgis/server/usr directory.

Note:

Before adding the reference, ensure that the ArcGIS Server installation owner has at least read and execute permissions on the database client libraries.

In the init_user_param.sh script, edit the section that is relevant to your RDBMS by referencing the database client libraries and other database variables. To enable the variables, remove # from the lines beginning with export.

For example:

ALTIBASE

# -----------------------------------------------------------------------
# Modify this section to configure a connection to ALTIBASE.
#
# -------------------------------------------------------------------------------
#export ALTIBASE_HOME=<Altibase_InstallDir>
#export ALTIBASE_PORT_NO=<Altibase_Port_No>
#export PATH=${ALTIBASE_HOME}/bin:${PATH}
#export LD_LIBRARY_PATH=${ALTIBASE_HOME}/lib:${LD_LIBRARY_PATH}
#export CLASSPATH=${ALTIBASE_HOME}/lib/Altibase.jar:${CLASSPATH}

Note:

The ALTIBASE Linux client adds the following environment variables to the installation account's .bash_profile file:

# ALTIBASE_ENV
export ALTIBASE_HOME=/data/installed/altibase-HDB-client-6.3.1
export ALTIBASE_PORT_NO=20300
export PATH=${ALTIBASE_HOME}/bin:${PATH}
export LD_LIBRARY_PATH=${ALTIBASE_HOME}/lib:${LD_LIBRARY_PATH}
export CLASSPATH=${ALTIBASE_HOME}/lib/Altibase.jar:${CLASSPATH}

Either comment out these lines from the .bash_profile file or make sure these settings are the same as those you set in the init_user_param.sh file.

DB2

#
# Modify this section to configure a connection to DB2
export DB2_CLIENT_HOME=<DB2_InstallDir>
export DB2INSTANCE=<DB2_instance_name>
export PATH=DB2_CLIENT_HOME/bin:$PATH
export LD_LIBRARY_PATH=$DB2_CLIENT_HOME/lib64:$LD_LIBRARY_PATH

Informix

# 
# Modify this section to configure a connection to Informix
#
export INFORMIXDIR=<Informix_InstallDir>
export INFORMIXSERVER=<Informix_Database_Server_Name>
export INFORMIXSQLHOSTS=<Location_to_sqlhosts>
export ODBCINI=<Location_to_.odbc.ini>
export PATH=$INFORMIXDIR/bin:$PATH
export LD_LIBRARY_PATH=$INFORMIXDIR/lib:$INFORMIXDIR/lib/cli:$INFORMIXDIR/lib/esql:$LD_LIBRARY_PATH

Netezza

# -----------------------------------------------------------------------
# Modify this section to configure a connection to Netezza.
#
# To make a connection, name the Netezza ODBC configuration files as .odbcinst.ini 
# and .odbc.ini and store them in the ArcGIS Server user $HOME directory. 
#
# Also install a Linux ODBC driver manager and reference it by setting
# the LIB_ODBC_DRIVER_MANAGER variable.
#
# -------------------------------------------------------------------------------------
export LIB_ODBC_DRIVER_MANAGER=<Location_to_libodbc.so>/libodbc.so

Oracle

#
# For connection with Oracle Runtime or Administrator Client
#
export ORACLE_BASE=<Oracle_Installdir>/app
export ORACLE_HOME=$ORACLE_BASE/<Oracle_release>/product/<Oracle_version>/<client_version>
export ORACLE_SID=<set when applicable>
export TNS_ADMIN=<set when applicable. e.g.$ORACLE_HOME/network/admin>
export PATH=$ORACLE_HOME/bin:$PATH
export LD_LIBRARY_PATH=$ORACLE_HOME/lib:$LD_LIBRARY_PATH

Note:

If you have installed multiple Oracle clients, you will see multiple Oracle client folders. Make sure the ORACLE_HOME variable is set to the folder you intend to use to connect to the database in ArcGIS Server.

If you use the Oracle database instant client libraries, only the $LD_LIBRARY_PATH needs to be referenced, for example:

#
# For connection with Oracle Instant Client
#
export LD_LIBRARY_PATH=<Location_to_instantclient_11_2>:$LD_LIBRARY_PATH

PostgreSQL

#
# Modify this section to configure a connection to PostgreSQL
#
export PGHOME=<PostgreSQL_InstallDir>
export PATH=$PGHOME/bin:$PATH
export LD_LIBRARY_PATH=$PGHOME/lib:$LD_LIBRARY_PATH

SAP HANA

# -----------------------------------------------------------------------
# Modify this section to configure a connection to SAP HANA.
#
# To make a connection, name the SAP HANA ODBC configuration files as .odbcinst.ini
# and .odbc.ini and store them in the ArcGIS Server user $HOME directory.
#
# Also install a Linux ODBC driver manager and reference it by setting
# the LIB_ODBC_DRIVER_MANAGER variable.
#
# -------------------------------------------------------------------------------------
export LIB_ODBC_DRIVER_MANAGER=<Location_to_libodbc.so>/libodbc.so

Teradata

# -----------------------------------------------------------------------
# Modify this section to configure a connection to Teradata.
#
# To make a connection, name the Teradata ODBC configuration files as  
# .odbcinst.ini and .odbc.ini and store them in the ArcGIS Server user $HOME directory. 
#
# -------------------------------------------------------------------------------------
#export LIB_ODBC_DRIVER_MANAGER=<Teradata_InstallDir>/client/14.00/odbc_64/lib/libodbc.so
#export TDDIR=<Teradata_InstallDir>/client/14.00/odbc_64
#export LD_LIBRARY_PATH=$TDDIR/lib:$LD_LIBRARY_PATH
#export ODBCINI=<Location_to_.odbc.ini>/.odbc.ini

Restart ArcGIS Server

For your settings to take effect in the init_user_param.sh script, you'll need to restart ArcGIS Server. You can do this by manually restarting each GIS server in your deployment by running the startserver.sh script.

Test your connection

Once you've configured your connection to a database in ArcGIS Server, you should test the connection by doing the following:

Register the database with the server
Publish a service to the server using data residing in the database

If you encounter problems with your connection, consult the server logs for more information. To learn more about server logging, see Viewing, querying, and configuring server logs.

Note:

If you've previously referenced the database client libraries in your user profile, you will still be able to connect to your databases in ArcGIS Server. However, if the reference information differs between the user profile and init_user_param.sh, you may experience problems when attempting to connect to the database. To alleviate connection issues, remove the reference information from your user profile and reference your database client libraries using the method described above.

Feedback on this topic?