Skip To Content
ArcGIS Developers
Dashboard

Register Relational Data Store Type

Description

Legacy:

The use of all relational data store operations in the ArcGIS Server Admin API has been deprecated as of ArcGIS Enterprise 10.9. Starting at Insights 2021.1, the registration and management of relational data store types should be performed with ArcGIS Insights. For more information, see Manage connector types.

This operation registers a new relational data store type with the server. Once registered, a relational data store type enables Insights users to create Relational Database Connection portal items to browse and query data from relational databases.

Note:
Relational data store types are only used with Insights and are not to be confused with ArcGIS Data Store relational data stores.

This operation should only be called on an ArcGIS Server site that has been designated as a Portal for ArcGIS hosting server. In order to register a relational data store type, you must obtain the correct Java Database Connectivity (JDBC) driver from your database vendor. These drivers are typically delivered as one or more Java Archive (.jar) files, which you must compress/package into a ZIP file. The name of the ZIP file does not matter, except that the file extension must be .zip. Before calling this Register operation, you must first upload the ZIP file to your server. Be sure to make note of the Item ID property of the newly created upload item. Repeat the upload step for each database platform your organization supports.

Note:

This operation should be called once for each upload item you created (i.e. once for each database driver ZIP file you uploaded). Once all relational data store types have been registered, you must completely re-start ArcGIS Server on each machine in your site. To do this, you need to re-start the Windows Service or use the stopserver/startserver scripts on Linux.

The ZIP file should only contain the driver files for a single platform. For example, if your organization supports the use of Microsoft SQL Server and SAP HANA, but not Teradata, you would create two ZIP files. The following outlines the contents of the ZIP file for the supported database platforms for 10.5. Starting at 10.5.1, please refer to the Supported databases section of Insights documentation to get up-to-date information.

Note:
Starting at 10.5.1, ArcGIS Insights must be installed in order to register Relational Data Store Types and create Relational Catalog Services or Relational Database Connections. Please refer to ArcGIS Insights documentation for more information on supported databases, required vendor files, supported data types and required database privileges.

Database PlatformZip file contentsDescription

Microsoft SQL Server

sqljdbc42.jar

Standard/Enterprise editions:

  • Microsoft SQL Server 2016 (64-bit)
  • Microsoft SQL Server 2014 (64-bit)
  • Microsoft SQL Server 2012 SP1 (64-bit)

SAP Hana

ngdbc.jar

SAP HANA 1.0 SPS11* or SPS 12

Teradata

tdgssconfig.jar and terajdbc4.jar

Teradata 14.10, 15.0 or 15.10

*For spatially-enabled databases, SPS11 Revision 2 (1.00.112) or better is required to avoid 'Unregistered function name: "__cs_field_Geometry__" ' errors during certain workflows (BUG-000101435).

Tip:

Once all relational data store types have been registered, do not delete the upload items created for the zipped database drivers. They might be needed at a later date.

Request parameters

ParameterDetails
uploadedItemId

Identifier of the uploaded ZIP file containing JDBC driver file(s).

Example

uploadedItemId=ic600379e-be10-4fd2-ab7e-76d37989d3bf
typeId

Identifier of the relational data store type you are registering.

Example

typeId=esri.hana
f

The response format. The default response format is html.

Values: html | json | pjson

Example usage

Below is a sample request URL for register:

POST /webadaptor/admin/data/relationalDatastoreTypes/register HTTP/1.1
Host: machine.domain.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []

uploadedItemId=ic600379e-be10-4fd2-ab7e-76d37989d3bf&typeId=esri.hana&f=json

JSON Response example

{"status": "success"}