Register your data with ArcGIS Server using Manager

You can use ArcGIS Server Manager to register data directories and databases with ArcGIS Server. Data registration provides the server with a list of locations where the source data for your services originates. Data registration provides the following benefits:

• Data registration helps you validate whether your services are referencing data locations known and approved by the server administrator.
• Data registration allows ArcGIS Server to remap paths to your data when you publish (and thereby copy) your map, model, or other resources to the server.

Registering your data directories does not grant the ArcGIS Server account permissions to access your data. You'll need to give the ArcGIS Server account at least read permissions to any folder that you register. If you're registering a database, the type of permissions you need to grant depends on what type of database you use and what type of authentication you use to connect. See Make your data accessible to ArcGIS Server to learn more about the scenarios where you need to apply permissions.

The way you register your databases and data directories with ArcGIS Server in Manager is through the Data Stores tab in the GIS Server module. To access this tab, sign in to Manager and click Site > GIS Server > Data Stores.

The Data Stores tab features the Registered Data Stores dialog box. Within it, all of your registered folders and databases are displayed and categorized by type. Available types are database, managed database, folder, and big data file share.

Follow the steps in the sections below based on what you want to register with the server.

• Register a database
• Register an ArcGIS Server managed database
• Register a folder
• Register a cloud store
• Register a raster store
• Register a big data file share

Register a database

Using the tools on the Data Stores tab, you can register any database compatible with ArcGIS. The 64-bit version of the database's client software must be installed on each ArcGIS Server machine in the site before registration.

Tip:

For more information on what is required to register a database , see the topic specific to your database management system.

• Register an ALTIBASE hybrid database with ArcGIS Server
• Register a Dameng database with ArcGIS Server
• Register a Db2 database with ArcGIS Server
• Register a Netezza database with ArcGIS Server
• Register an Oracle database with ArcGIS Server
• Register a PostgreSQL database with ArcGIS Server
• Register an SAP HANA database with ArcGIS Server
• Register a SQL Server database with ArcGIS Server
• Register a Teradata database with ArcGIS Server

To register a database and allow services to reference your data, follow these steps. For file geodatabases, use the option described in the subsequent section titled Register a folder.

1. Sign in to ArcGIS Server Manager, and click Site > Data Stores.
2. Click the Register drop-down arrow and select Database.
3. Provide a unique name for the registered database. Names can be alphanumeric and contain spaces.
4. Click Import. This opens a window where you can browse to the database connection file (.sde or .odc only) on disk. If you need help with this step, consult the documentation specific to your database platform in the Administering geodatabases section of the help.
5. Depending on how you've set up your data sources to work with ArcGIS, choose one of the following scenarios:
   • If the publisher's machine and the server are working with the same database:
   1. Click the Same as publisher database connection check box. This specifies the publisher's machine, and ArcGIS Server will view and access data residing in the same database. To learn more about this scenario, see About registering your data with ArcGIS Server.
   • If the publisher's machine and the server are working with different databases:
   1. Next to the Server database connection section, click Import to select a connection file.

      Note:

      Manager does not allow you to automatically create a geodata service to link your registered enterprise geodatabases. Optionally, you can create a geodata service after registering. To automatically create a geodata service when registering your enterprise geodatabases, use ArcMap. Geodata services are only supported with enterprise geodatabases, not with databases.

6. Click Create.

   The database you registered appears on the Registered Data Stores dialog box.

Register an ArcGIS Server managed database

You can register an enterprise or workgroup geodatabase as a managed database with a stand-alone or federated ArcGIS GIS Server site only; you cannot register an enterprise or workgroup geodatabase as a managed database with a hosting server. Also, only enterprise or workgroup geodatabases are supported as managed databases for stand-alone or federated servers; databases and desktop, file, or personal geodatabases are not supported. To learn more about ArcGIS Server managed databases and scenarios for using one, see Copying data to the server automatically when publishing.

Follow these steps to register an ArcGIS Server managed database, which allows ArcGIS Server to copy feature service data to the managed database and automatically remap paths when you publish a feature service (map service with feature access) from ArcMap:

1. Sign in to ArcGIS Server Manager, and click Site > Data Stores.
2. Click the Register drop-down arrow and select Managed Database.
3. Provide a unique name for the geodatabase connection. Names can be alphanumeric and can contain spaces.
4. Next to the Server database connection section, click Import. This opens a window where you can browse to the database connection (.sde) file on disk. If you need help with this step, consult the documentation specific to your database platform in the Administer geodatabases section of the help.
5. Click Create.

   The database is registered as the managed database and appears on the Registered Data Stores dialog box.

Note:

If you register a managed database with a federated server, you cannot assign that federated server as the ArcGIS Enterprise portal's hosting server. Instead, you must create a relational ArcGIS Data Store. See An overview of ArcGIS Data Store configuration and its related topics for information on creating a relational data store.

Once you have a relational data store on the hosting server, it appears as a managed database when you connect to the hosting server from ArcGIS Server Manager. You can validate the relational data store connection in Manager, but do not delete any ArcGIS Data Store items from the ArcGIS Server site using Manager.

Update password for registered or managed database

Database passwords, like other software and system passwords, are frequently changed for security reasons. If the password saved in the database connection file (.sde) that you registered with your ArcGIS Server site changes, create a new database connection file containing the new password, and edit the existing data store registration to point to the new file. This updates the registration for all services except search, stream, Workflow Manager services, and geoprocessing services published prior to ArcGIS 10.4.

1. Create a new database connection file that uses the updated password. You can create a new database connection file in ArcMap, ArcGIS Pro, or using the Create Database Connection geoprocessing tool.

   Be sure to save the user name and password in the new connection file. Also be sure the new connection file is in a directory you can access from the machine where you will run ArcGIS Server Manager.

2. Sign in to ArcGIS Server Manager and click Site > Data Stores.
3. Click the edit button next to the registered or managed database for which you need to update the password.

   Note that you cannot edit the connection for an ArcGIS Data Store relational data store (appears as a managed database), tile cache data store, or spatiotemporal big data store. To update a password for a relational data store, use the changepassword utility.

4. Click Import and browse to the location of the new database connection file.
5. Click Import.
6. Click Save to update your registered or managed database connection password.
7. Restart the services that were published from the registered database, or restart the feature services published to the managed database.
8. Also restart any geoprocessing services published from an ArcGIS 10.4 for Server. Geoprocessing services published from previous releases of ArcGIS Server must be republished to use the new password.

Services published from the registered database or feature services published to the managed database can access data again.

You must republish search, stream, and Workflow Manager services, and any geoprocessing service published to a 10.3.1 and earlier release ArcGIS Server to update the password.

Register a folder

Using the Data Stores tab, you can register a local file directory or shared directory that contains GIS resources and data, such as shapefiles and file geodatabases. When you register a directory, all subdirectories under the folder you specify are also registered with the server.

Note:

If you are registering a folder as a big data file share, refer to the steps in the Register a big data file share section. If you are registering a folder as a raster store, see the steps in the Register a raster store section.

Follow these steps to register a folder and allow services to reference the data in the folder and its subfolders:

1. Sign in to ArcGIS Server Manager, and click Site > Data Stores.
2. Click the Register drop-down arrow and select Folder.
3. Provide a unique name for the registered folder. Names can be alphanumeric and contain spaces.
4. For Publisher Folder Path, specify the full path to the publisher's folder, for example, /opt/local/data, or /net/myserver/opt/local/data.

   Note:

   You cannot browse directories in Manager. You must provide the full path to the folder you want to register.

5. For Publisher Folder Host Name, specify the machine that is hosting the publisher's folder. You can specify the machine name (MyServer), fully qualified domain name (MyServer.domain.com), IP address (12.34.56.789), or localhost (localhost).
6. Depending on how you've set up your data sources to work with ArcGIS, choose one of the following scenarios:
   • If the publisher's machine and the server are working out of the same folder:
   1. Click the Same as publisher folder path check box. This specifies the publisher's machine and ArcGIS Server will view and access data residing in the same folder. To learn more about this scenario, see About registering your data with ArcGIS Server.
   • If the publisher's machine and the server are working out of different folders:
   1. Next to the Server Folder Path section, specify the full path to the server's folder. To learn more about this scenario, see About registering your data with ArcGIS Server.
7. Click Create. The folder or folders you registered appear on the Registered Data Stores dialog box.

Register a cloud store

Using the Data Stores tab, you can register a cloud store to use as an output location for raster analysis tools, as a big data file share for GeoAnalytics Tools, and to store map and image service caches for ArcGIS Server sites running in the cloud.

Note:

Ensure ArcGIS Server Manager is communicating over HTTPS when registering or editing a path for a cloud store.

Before you can register a cloud store, you must create the container or bucket. If you will use the cloud store for map and image service caches, this container or bucket must contain a folder named arcgiscache before you register the cloud store.

When you register a folder, all subfolders under the folder you specify are also registered with the ArcGIS Server site.

1. Sign in to ArcGIS Server Manager, and click Site > Data Stores.
2. Click the Register drop-down arrow and select Cloud Store.
3. ArcGIS Server supports the following cloud store locations. Follow the steps below based on the environment you are working with.
   • Amazon Simple Storage Service (S3)
   • Microsoft Azure Blob storage
   • Alibaba Cloud Object Storage Service (OSS)*

     Alibaba OSS buckets cannot be used for big data file shares.

   • Microsoft Azure Data Lake storage*

     Microsoft Azure Data Lake stores can only be used for big data file shares.

   *Support for these cloud stores begins with ArcGIS 10.6.1.

Tip:

ArcGIS Server needs access to a list of allowable cloud store locations. If you need to register cloud stores that use private URLs or your organization has a requirement to access the list from an Alibaba OSS bucket in China, the ArcGIS Server administrator can configure the site to access lists in those locations.

Amazon S3

If you are registering an Amazon Simple Storage Service (S3) bucket for use as a raster store, a big data file share, or to store map and image service caches for an ArcGIS Server site on Amazon Web Services (AWS), complete the following steps:

1. Click the Type drop-down arrow and select Amazon S3. You will need your AWS account information to register the cloud store.
2. Cloud Store Name: Provide a user-friendly name for the cloud store using alphanumeric characters and underscores. Do not include spaces or other special characters.
3. Credential Type: AWS storage supports connections using an Access Key or IAM Role. Select the credential type that you want to use to connect to AWS. If credential type is Access Key, you will also need to provide an Access Key ID and Secret Access Key that you have obtained from your AWS account.
4. Access Key Id: Enter the Access Key ID you've obtained from your AWS account.
5. Secret Access Key: Enter the Secret Access Key you've obtained from your AWS account.
6. Region: Select the AWS region in which the S3 bucket you are registering is located.
7. S3 Bucket Name: Enter the name of the S3 bucket you are registering.
8. Folder: Optionally provide the subfolder path that you want to register.
9. If you intend to use this cloud store for map and image service caches, check the Register Cache directory check box.

   The S3 bucket must contain a folder named arcgiscache. You should only use this bucket for service caches if your ArcGIS Server site is deployed on AWS. For additional details, see cache storage details for ArcGIS on AWS.

10. Click Create.

The cloud store is registered and appears on the Registered Data Stores dialog box.

You can use the Validate button to confirm the ArcGIS Server site can connect to the cloud store with valid credentials.

Note:

ArcGIS Server does not validate the location path you provide. Ensure this path is valid prior to registering the cloud store. If the specified location does not yet exist in your S3 bucket, ArcGIS Server creates the location as defined.

Microsoft Azure Blob storage

If you are registering a Microsoft Azure Blob storage container for use as a raster store, a big data file share, or to store map and image service caches for an ArcGIS Server site on Azure, complete the following steps:

1. Click the Type drop-down arrow and select Microsoft Azure Storage. You will need your Microsoft Azure account information to register the cloud store.
2. Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores. Do not include spaces or other special characters.
3. Account Name: Enter your Microsoft Azure storage account.
4. Account Key: Enter the Account Key you've obtained through your Microsoft Azure account.
5. Environment: Enter the environment for the Microsoft Azure storage account. Environment options are as follows:
   • Azure Cloud
   • Azure US Government
   • Azure China Cloud
   • Azure German Cloud
6. Container Name: Enter the name of the Microsoft Azure container you are registering.
7. Folder: Optionally provide the subfolder path you want to register.
8. If you intend to use this cloud store for map and image service caches, check the Register Cache directory check box.

   The container must contain a folder named arcgiscache. You should only use this container for service caches if your ArcGIS Server site is deployed on Azure.

9. Click Create.

The cloud store is registered and appears on the Registered Data Stores dialog box.

You can use the Validate button to confirm the ArcGIS Server site can connect to the cloud store with valid credentials.

Note:

ArcGIS Server does not validate the location path you provide. Ensure this path is valid prior to registering the cloud store. If the specified location does not yet exist in your Azure Blob container, ArcGIS Server creates the location as defined.

Alibaba Cloud OSS

If you are registering an Alibaba Cloud Object Storage Service (OSS) bucket for use as a raster store or to store map and image service caches for an ArcGIS Server site on Alibaba, complete the following steps:

1. Click the Type drop-down arrow and select Alibaba Cloud Storage.
2. Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores. Do not include spaces or other special characters.
3. Access Key Id: Enter the Access Key ID you've obtained from your Alibaba account.

   You can only authorize the connection with AccessKey/SecretKey information.

4. Secret Access Key: Enter the Secret Access Key you've obtained from your Alibaba account.
5. Region: Select the Alibaba region in which the OSS bucket you are registering is located.
6. Bucket Name: Enter the name of the OSS bucket you are registering.
7. Folder: Optionally provide the subfolder path that you want to register.
8. If you intend to use this cloud store for map and image service caches, check the Register Cache directory check box.

   The OSS bucket must contain a folder named arcgiscache. You should only use this bucket for service caches if your ArcGIS Server site is deployed on Alibaba.

9. Click Create.

The cloud store is registered and appears on the Registered Data Stores dialog box.

You can use the Validate button to confirm the ArcGIS Server site can connect to the cloud store with valid credentials.

Note:

ArcGIS Server does not validate the location path you provide. Ensure this path is valid before registering the cloud store. If the specified location does not yet exist in your bucket, ArcGIS Server creates the location as defined.

Microsoft Azure Data Lake store

If you are registering a Microsoft Azure Data Lake store for use as a big data file share, complete the following steps:

1. Click the Type drop-down arrow and select Microsoft Azure Data Lake Store. You will need your Microsoft Azure account information to register the cloud store.
2. Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores. Do not include spaces or other special characters.
3. Account Endpoint: Enter your Microsoft Azure endpoint. This will be in a format similar to: azuredatalakename.azuredatalakestore.net.
4. AAD Application ID: Enter the Azure Data Lake ID you've obtained through your Microsoft Azure account.
5. AAD Application Key: Enter the Azure Data Lake Application Key you've obtained through your Microsoft Azure account.
6. AAD Tenant ID: Enter the Azure Data Lake Tenant ID you've obtained through your Microsoft Azure account.
7. Environment: Enter the environment for the Microsoft Azure storage account. Environment options are as follows:
   • Azure Cloud
   • Azure US Government
   • Azure China Cloud
   • Azure German Cloud
8. Folder: Optionally provide the subfolder path you want to register.
9. Click Save.

The cloud store is registered and appears on the Registered Data Stores dialog box.

You can use the Validate button to confirm the ArcGIS Server site can connect to the cloud store with valid credentials.

Note:

ArcGIS Server does not validate the location path you provide. Ensure this path is valid prior to registering the cloud store. If the specified location does not yet exist in your Azure Data Lake store, ArcGIS Server creates the location as defined.

Register a raster store

Using the Data Stores tab, you can register a raster store that is used for storing hosted raster datasets generated by raster analysis tasks. The raster store can be of different types, such as a file share or a cloud store.

Note:

Ensure ArcGIS Server Manager is communicating over HTTPS when registering or editing a path for a raster store.

Register a file share as a raster store

If you are registering a file share as a raster store, complete the following:

1. Name: Provide a unique name for the registered location containing alphanumeric characters and underscores.
2. Type: Click the Type drop-down arrow and select File Share.
3. Path: Specify the full path to the raster file share, for example, /net/myserver/opt/local/rasterFileShare . Avoid using local paths /opt/local/data unless the same data folder will be available on all nodes of the server site.

   Note:

   You cannot browse directories in Manager. You must provide the full path to the folder you want to register.

4. Click Save. The file share you registered appears on the Registered Data Stores dialog box.

Register a cloud store as a raster store

If you are registering a cloud store as a raster store, complete the following:

Note:

To register a cloud store as a raster store, you must first add the cloud store as a registered data store. For more information, review the Register a cloud store section above. Once the cloud store is available in your list of registered data stores, you can complete the following steps.

1. Name: Provide a unique name for the registered location containing alphanumeric characters and underscores.
2. Type: Click the type drop-down arrow and select Cloud Store.
3. Click the Cloud Store drop-down arrow and select your registered cloud store.
4. Click Create. The cloud store you registered appears on the Registered Data Stores dialog box.

Register a big data file share

ArcGIS GeoAnalytics Server can read collections of delimited files (for example, .csv and .tsv) and shapefiles as an input. These datasets are identified by a registered big data file share with the following types: file share, HDFS, or Hive. When registering a big data file share, you register a parent folder for file shares and HDFS or a metastore for Hive that contains one or more subfolders with datasets. A single data file or multiple data files of the same type and schema can be in a single folder.

Using the Data Stores tab, you can register a path pointing to a big data file share.

When you register a directory, all subdirectories under the folder you specify are also registered with the server. Always register the parent folder (for example, \\machinename\mydatashare) that contains one or more individual dataset folders as the big data file share item. The following is an example of a big data file share folder that contains three datasets: Earthquakes, Hurricanes, and GlobalOceans.

\\machinename\mydatashare   < -- registered item

├───Earthquakes 
	       |-1960.csv
	       |-1961.csv
	       |-1962.csv
├───Hurricanes 
	       |-atlantic_hur.shp
	       |-pacific_hur.shp
├───GlobalOceans
	       |-oceans.shp

For each registered big data file share, an associated big data file share portal item is created. Share the portal item with portal groups whose members should have access to this data for analysis. Only members of groups with which you have shared the big data file share portal item will be able to use the data as input to their analysis tasks. To learn more, see What is a big data file share?

Keep in mind that if you delete a big data file share from the ArcGIS Server site's data store, the corresponding portal item is also deleted.

A big data catalog service is also created when you register a big data file share. See the ArcGIS REST API documentation for details on the big data catalog service.

Note:

The option to register a big data file share is not available in ArcGIS Server Manager unless you have configured GeoAnalytics Server.

For detailed steps, see Set up ArcGIS GeoAnalytics Server in the ArcGIS Server help.

Complete the following steps to register a big data file share and allow services to reference the data in the file share and its subfolders:

Note:

Ensure ArcGIS Server Manager is communicating over HTTPS when registering or editing a big data file share.

1. Sign in to ArcGIS Server Manager on GeoAnalytics Server, and click Site > Data Stores.
2. Click the Register drop-down arrow and select Big Data File Share. Follow the steps below based on the type of environment you are working with.

Register a file share as a big data file share

When you are registering a big data file share, you can register a local directory or shared directory by completing the following:

Note:

It is recommended to locate the big data file share on a dedicated file server with SAN or DAS or a NAS device as a best practice. If a shared directory is on an ArcGIS GeoAnalytics Server machine, there will be resource contention for file access when executing big data analytics tasks. If you must register a local directory, it is recommended that you use a local path and replicate the data to all machines on the GeoAnalytics Server site.

1. Name: Provide a unique name for the registered location. Names can be alphanumeric and contain spaces.
2. Type: Click the type drop-down arrow and select File Share.
3. Path: Specify the full path to the big data file share, for example, /net/myserver/opt/local/bigdata Avoid using local paths /opt/local/data unless the same data folder will be available on all nodes of the server site.

   Note:

   You cannot browse directories in Manager. You must provide the full path to the folder you want to register.

4. Click Create. The file share you registered appears on the Registered Data Stores dialog box.
Once a big data file share is registered, a manifest that contains metadata about the datasets in the share is automatically generated. Depending on the size of the data, it may take from a few seconds to several minutes to generate the manifest.
5. Click the Pencil icon to preview the autogenerated manifest file and verify its datasets and schemas are appropriately defined. If needed, you can modify and/or download and edit the manifest file. See edit big data file share manifests in Manager for details.

Tip:

If the manifest contains an empty dataset, it could mean the big data file share does not have valid data. Verify that you have registered the appropriate parent folder, for instance as indicated in this example.

Register HDFS (Hadoop Distributed File System) as a big data file share

If you are registering an HDFS directory of datasets, complete the following:

1. Name: Provide a unique name for the registered location. Names can be alphanumeric and contain spaces.
2. Type: Click the type drop-down arrow and select HDFS.
3. Path: Specify the fully qualified file system path to the big data file share, for example, hdfs://domainname:port/folder.
   • The domain name is the NameNode machine.
   • The default port is 8020.
   • The folder represents the full path to the data in HDFS.

   For example, if your NameNode is machine goldenI007 in /james/mydata, the file system path would be hdfs://goldenI007:8020/james/mydata.

4. Username: Optionally provide a user name to connect.

   Note:

   HDFS does not support connecting to secured stores.

5. Click Create. The HDFS share you registered appears on the Registered Data Stores dialog box.
Once a big data file share is registered, a manifest that contains metadata about the datasets in the share is automatically generated. Depending on the size of the data, it may take from a few seconds to several minutes to generate the manifest.
6. Click the Pencil icon to preview the autogenerated manifest file and verify its datasets and schemas are appropriately defined. If needed, you can modify and/or download and edit the manifest file. See edit big data file share manifests in Manager for details.

Tip:

If the manifest contains an empty dataset, it could mean the big data file share does not have valid data. Verify that you have registered the appropriate parent folder, for instance as indicated in this example.

Register Hive as a big data file share

If you are registering Hive, complete the following:

1. Name: Provide a unique name for the registered location. Names can be alphanumeric and contain spaces.
2. Type: Click the type drop-down arrow and select Hive.
3. Metastore URIs: Specify the URI for the big data file share. Note that it is possible to specify multiple metastores and, by default, Hive will use the first entry from the list. For example, if you're using the following as an entry: thrift://domainname1:port,thrift://domainname2:port,thrift://domainname3:port, Hive will use thrift://domainname1:port as the default but will fall back on others from the list in case of failure.
4. Database: Specify the database that contains the big data datasets you want to register.
5. Username: Optionally provide a user name to connect.

   Note:

   Hive does not support connecting to secured stores.

6. Click Create. The Hive store you registered appears on the Registered Data Stores dialog box.
Once a big data file share is registered, a manifest that contains metadata about the datasets in the share is automatically generated. Depending on the size of the data, it may take from a few seconds to several minutes to generate the manifest.
7. Click the Pencil icon to preview the autogenerated manifest file and verify its datasets and schemas are appropriately defined. If needed, you can modify and/or download and edit the manifest file. See edit big data file share manifests in Manager for details.

Tip:

If the manifest contains an empty dataset, it could mean the big data file share does not have valid data. Verify that you have registered the appropriate parent folder, for instance as indicated in this example.

Register a cloud store as a big data file share

If you are registering a cloud store, complete the following:

Note:

To register a cloud store as a big data file share, you must first add the cloud store as a registered data store. For more information, review the Register a cloud store section above. Once the cloud store is available in your list of registered data stores, you can complete the following steps:

1. Name: Provide a unique name for the registered location. Names can be alphanumeric and contain spaces.
2. Type: Click the type drop-down and select Cloud Store.
3. Click the Cloud Store drop-down and select your registered cloud store.
4. Click Create. The cloud store you registered appears on the Registered Data Stores dialog box.

Validate data stores

You can validate the data store connection to confirm that the ArcGIS Server site can communicate with a data store.

Note:

Raster stores cannot be validated in ArcGIS Server Manager at this time. Their status will always be unknown when viewed in Manager, and a question mark (?) will appear in the Status column.

1. Sign in to ArcGIS Server Manager.
2. Open the Data Stores page (Site > Data Stores).
3. Validate data store connections using one of the following methods:
   • To validate the connection for a single data store, check the box next to the data store name and click Validate.
   • To validate all the data stores for the ArcGIS Server site at once, click Validate All.

A check appears in the Status column for all data stores whose connections could be validated. If ArcGIS Server could not connect, an X appears in the Status column.

If ArcGIS Server could not connect, confirm that the data store is available; for example, that the machine the data store is on is running and has network connectivity.