You can use ArcGIS Server Manager to register data directories, databases, and cloud storage locations with ArcGIS Server. Data registration provides the ArcGIS Server site 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 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 must give the ArcGIS Server account at least read permissions to any folder that you register. When you register a database, the type of permissions you need to grant depends on what type of database you use, what type of authentication you use, and what type of access the connecting user needs. See Make your data accessible to ArcGIS Server to learn more about the scenarios where you need to apply permissions.
The way you register data storage locations with ArcGIS Server in Server Manager is through the Data Stores tab in the Server Configuration module. To access this tab, sign in to Server Manager and click Site > Server Configuration > Data Stores.
The Data Stores tab features the Registered Data Stores dialog box. Within it, all of your registered data stores are displayed and categorized by type. Available types are listed below.
Follow the steps in the sections below based on what you want to register with the ArcGIS Server site.
- 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
Tip:
To add new database, folder, cloud, or most types of big data file share data stores to ArcGIS Server sites that are federated with ArcGIS Enterprise, add a data store item to take advantage of portal sharing and authentication. Organization administrators can create data store items from existing registered databases and folders.
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.
Use the links below to access information on what is required to register each type of supported database:
To register a database (including one that contains an enterprise geodatabase) and allow services to reference data in the database, follow the next set of steps. For file geodatabases, use the option described in the subsequent section titled Register a folder. To register a database connection to a cloud data warehouse, add a data store item in the portal.
- Sign in to ArcGIS Server Manager, and click Site > Data Stores.
- Click the Register drop-down arrow and select Database.
- Provide a unique name for the registered database.
Names can be alphanumeric and contain spaces.
- Click Import.
A window appears where you can browse to the database connection file (.sde or .odc only) on disk.
- Depending on how you set up your data sources to work with ArcGIS, choose one of the following scenarios:
- If the publisher's machine and the ArcGIS Server site are working with the same database, 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 Data sources for ArcGIS Server.
- If the publisher's machine and the server are working with different databases, click Import next to the Server database connection section and select a database connection file (.sde).
Note:
Server 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. Geodata services are only supported with enterprise geodatabases, not with databases.
- If the publisher's machine and the ArcGIS Server site are working with the same database, click the Same as publisher database connection check box.
- 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. 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. The geodatabase you register as the managed database for a stand-alone or federated ArcGIS GIS Server site applies to the entire site. Every feature service published to this site will use the managed database; therefore, only the ArcGIS Server administrator should configure a managed database for a site.
Note:
You cannot register an enterprise or workgroup geodatabase as a managed database with a hosting server, because the hosting server uses a relational ArcGIS Data Store.
Follow these steps to register a managed database with a stand-alone or federated ArcGIS Server site, which allows ArcGIS Server to copy feature service data to the managed database and automatically remap paths when you publish a feature service (a map service with feature access enabled):
- Sign in to ArcGIS Server Manager, and click Site > Data Stores.
- Click the Register drop-down arrow and select Managed Database.
- Provide a unique name for the geodatabase connection.
Names can be alphanumeric and can contain spaces.
- Next to the Server database connection section, click Import.
A window appears where you can browse to the database connection file (.sde only) on disk.
- 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 hosting server. If you need to use the federated server as a hosting server, you must create and use a relational ArcGIS Data Store instead. 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 Server Manager, but do not delete any ArcGIS Data Store items from the ArcGIS Server site using Server Manager.
Update information for a registered or managed database
At times, you may need to update the password to a database you've registered, or update the hostname of that database. You can do so at any time using ArcGIS Server Manager.
Database passwords, like other software and system passwords, are frequently changed for security reasons. While less common, database hostnames can also change, such as when migrating to a new operating system for the database.
If the information (password or hostname) 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 information, and edit the existing data store registration to point to the new file.
This updates the registration for all services except stream services and ArcGIS Workflow Manager (Classic) services. This workflow cannot be used if the registered data store references a cloud data warehouse.
Follow these steps to register a new database connection file containing updated password or hostname information.
- Create a database connection file that uses the updated password or hostname.
You can create a database connection file in the Catalog pane in ArcGIS Pro or using the Create Database Connection geoprocessing tool.
Be sure to save the username 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.
- Sign in to ArcGIS Server Manager and click Site > Data Stores.
- Click the edit button next to the registered or managed database you need to update.
You cannot edit the connection for any type of ArcGIS Data Store in ArcGIS Server Manager. To update a password for a relational data store, use the changepassword utility. You also cannot update the password for a database you added as a data store item in the portal (appears as a registered database). Update the password for a database data store item from the item's details page in the portal instead.
- Click Import and browse to the location of the new database connection file.
- Click Import.
- Click Save to update your registered or managed database connection.
- Restart the services that were published from the registered database, or restart the feature services published to the managed database.
- If applicable, republish any stream services and ArcGIS Workflow Manager (Classic) services in your site.
Services published from the registered database or feature services published to the managed database can access data again.
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 or file geodatabases. When you register a directory, all subdirectories under the folder you specify are also registered with the server.
Note:
To register a folder as a big data file share, see the steps in the Register a big data file share section. To register 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:
- Sign in to ArcGIS Server Manager, and click Site > Data Stores.
- Click the Register drop-down arrow and select Folder.
- Provide a unique name for the registered folder.
Names can be alphanumeric and contain spaces.
- For Publisher Folder Path, specify the full path to the publisher's folder, for example, C:\data, or \\myserver\share\data.
Note:
You cannot browse directories in ArcGIS Server Manager. You must provide the full path to the folder you want to register.
- 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).
- Depending on how you set up your data sources to work with ArcGIS, choose one of the following scenarios:
- If the publisher's machine and the ArcGIS Server site are working out of the same folder, check the Same as publisher folder path check box.
This specifies that the publisher's machine and ArcGIS Server site will view and access data residing in the same folder. To learn more about this scenario, see Data sources for ArcGIS Server.
- If the publisher's machine and the ArcGIS Server site are working out of different folders, specify the full path to the server's folder in the Server Folder Path section.
To learn more about this scenario, see Data sources for ArcGIS Server.
- If the publisher's machine and the ArcGIS Server site are working out of the same folder, check the Same as publisher folder path check box.
- 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 for the following uses:
- Store map and image service caches for ArcGIS Server sites running in the cloud.
- Register a cloud store and subsequently register it as a raster store to use as an output location for raster analysis tools and to store hosted imagery layer data you upload in the Create imagery layer wizard in the portal website.
- Register a cloud store and subsequently register it as a big data file share for GeoAnalytics Tools in the portal Map Viewer Classic or ArcGIS Pro.
Tip:
ArcGIS Server automatically retrieves a list of known public cloud regions from the Esri cloud infrastructure.
The Register Cloud Store dialog box also allows you to register cloud stores from public or private cloud infrastructure not on this list. To do this, provide the API endpoint in the Private URL field.
If 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.
Prerequisites for registering a cloud store include the following:
- You must create the container or bucket in the cloud storage location before registering the cloud store.
- 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.
- ArcGIS Server Manager must communicate over HTTPS when registering or editing a path for a cloud store.
- For best performance, all ArcGIS components should be deployed in the same cloud region.
When you register a cloud store, all subfolders in that location are also registered with the ArcGIS Server site.
Follow these steps to open the Register Cloud Store dialog box:
- Sign in to ArcGIS Server Manager, and click Site > Data Stores.
- Click the Register drop-down arrow and select Cloud Store.
- ArcGIS Server supports the following cloud store locations. Follow the steps below based on the environment with which you're working.
- Amazon Simple Storage Service (S3) or S3 compatible storage
- Microsoft Azure Blob storage
- Google Cloud storage
Google Cloud buckets cannot be used for big data file shares.
- 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.
Amazon S3
Complete the following steps to register an Amazon Simple Storage Service (S3) or S3 compatible storage 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 in the cloud:
- Click the Type drop-down arrow and select Amazon S3.
You need your AWS account information to register the cloud store.
- Provide a user-friendly name for the cloud store using alphanumeric characters and underscores in the Cloud Store Name text box.
Do not include spaces or other special characters in the name.
- Select the credential type that you want to use to connect to AWS with the Credential Type option.
AWS storage supports connections using an access key or IAM Role.
If you choose Access Key, you must provide an access key ID and secret access key that you obtain from your AWS account.
- Access Key Id: Provide the access key ID you obtained from your AWS account.
- Secret Access Key: Provide the secret access key you obtained from your AWS account.
- Region: Select the AWS region in which the S3 bucket you are registering is located or choose Custom if you want to use a private cloud store.
- Private URL: If you are registering cloud storage from an unlisted region, private cloud, or other storage compatible with S3, type or paste the URL of the API endpoint for your S3 compatible storage provider.
You must use HTTPS to communicate with the private URL.
For example, the URL could be in the format https://s3-us-west-2.amazonaws.com.
- S3 Bucket Name: Provide the name of the S3 bucket you are registering.
- Folder: Optionally, provide the subfolder path that you want to register.
- 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 in the same cloud region as the bucket.
- 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 exist in your S3 bucket, ArcGIS Server creates the location as defined.
Microsoft Azure Blob storage
Complete the following steps to register 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:
- Click the Type drop-down arrow and select Microsoft Azure Storage.
You need your Microsoft Azure account information to register the cloud store.
- Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores.
Do not include spaces or other special characters.
- Account Name: Provide your Microsoft Azure storage account.
- Account Key: Provide the account key you obtained through your Microsoft Azure account.
- Environment: Provide the environment for the Microsoft Azure storage account. Environment options are as follows:
- Azure Cloud
- Azure US Government
- Azure China Cloud
- Azure German Cloud
- Container Name: Provide the name of the Microsoft Azure container you are registering.
- Folder: Optionally, provide the subfolder path you want to register.
- 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.
- 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 exist in your Azure Blob container, ArcGIS Server creates the location as defined.
Google Cloud
Complete the following steps to register a Google Cloud bucket for use as a raster store or to store map and image service caches for an ArcGIS Server site on Google Cloud:
- Click the Type drop-down arrow and select Google Cloud.
You need an access key and secret key for your Google Cloud account to register the cloud store.
- Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores.
Do not include spaces or other special characters.
- Access Key Id: Provide the access key ID for your Google Cloud storage account.
- Secret Access Key: Provide the secret key associated with the access key for your account.
- Region: The default Google Cloud region is used.
- S3 Bucket Name: Provide the name of the Google Cloud bucket container you are registering.
- Folder: Optionally, provide the subfolder path you want to register.
- If you intend to use this cloud store for map and image service caches, check the Register Cache directory check box.
The bucket must contain a folder named arcgiscache. You should only use this bucket for service caches if your ArcGIS Server site is deployed on Google Cloud.
- 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 exist in your bucket, ArcGIS Server creates the location as defined.
Alibaba Cloud OSS
To register 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:
- Click the Type drop-down arrow and select Alibaba Cloud Storage.
- Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores.
Do not include spaces or other special characters.
- Access Key Id: Provide the access key ID you obtained from your Alibaba account.
You can only authorize the connection with AccessKey and SecretKey information.
- Secret Access Key: Provide the secret access key you obtained from your Alibaba account.
- Region: Select the Alibaba region in which the OSS bucket you are registering is located or choose Custom if you want to use a private cloud store.
- Private URL: If you are registering cloud storage from an unlisted region, private cloud, or other storage compatible with Alibaba OSS, type or paste the URL of the API endpoint for your Alibaba OSS compatible storage provider.
You must use HTTPS to communicate with the private URL.
- Bucket Name: Provide the name of the Alibaba OSS bucket you are registering.
- Folder: Optionally, provide the subfolder path that you want to register.
- 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.
- 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
To register a Microsoft Azure Data Lake store for use as a big data file share, complete the following steps:
- 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.
- Cloud Store Name: Provide a user-friendly name for the store using alphanumeric characters and underscores.
Do not include spaces or other special characters.
- Account Endpoint: Provide your Microsoft Azure endpoint.
This will be in a format similar to: azuredatalakename.azuredatalakestore.net.
- AAD Application ID: Provide the Azure Data Lake ID you obtained through your Microsoft Azure account.
- AAD Application Key: Provide the Azure Data Lake Application Key you obtained through your Microsoft Azure account.
- AAD Tenant ID: Provide the Azure Data Lake Tenant ID you obtained through your Microsoft Azure account.
- Environment: Provide the environment for the Microsoft Azure storage account. Environment options are as follows:
- Azure Cloud
- Azure US Government
- Azure China Cloud
- Azure German Cloud
- Folder: Optionally provide the subfolder path you want to register.
- 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 tools and the From Local input option in the Create imagery layer wizard in the ArcGIS Enterprise portal website. The raster store can be of different types, such as a file share or a cloud store.
All raster analysis output will be placed in the raster store configured for the ArcGIS Image Server site; therefore, only the ArcGIS Server administrator should configure a raster store for a site.
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
To register a file share as a raster store, complete the following:
- Name: Provide a unique name for the registered location containing alphanumeric characters and underscores.
- Type: Click the Type drop-down arrow and select File Share.
- Path: Specify the full path to the raster file share, for example, \\myserver\share\rasterFileShare. Avoid using local paths, such as C:\rasterFileShare, unless the same data folder will be available on all nodes of the server site.
Note:
You cannot browse directories in ArcGIS Server Manager. You must provide the full path to the folder you want to register.
- Click Save. The file share you registered appears on the Registered Data Stores dialog box.
Register a cloud store as a raster store
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 to register the cloud store as a raster store:
- Name: Provide a unique name for the registered location containing alphanumeric characters and underscores.
- Type: Click the type drop-down arrow and select Cloud Store.
- Click the Cloud Store drop-down arrow and select your registered cloud store.
- 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), ORC, parquet, and shapefiles as an input. These datasets are identified by a registered big data file share with the following types: file share, cloud store, Apache Hadoop Distributed File System (HDFS), or Apache Hive. When registering a big data file share, you register a parent folder for file shares, cloud stores, 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.
A big data file share can also be used to store data output from ArcGIS GeoAnalytics Server tools. Register an output store at the same time as you register a store for input. You can register the same location as both an input and output store, or as only an input.
Only HDFS, a file share, or a cloud store that is a Microsoft Azure Data Lake or Amazon Simple Storage Service (S3) bucket can be used to store output. You cannot use Hive or Microsoft Azure Blob storage as big data file share to store the results generated from GeoAnalytics Tools.
Note:
Add a data store item in the portal instead of using this workflow for all supported big data file shares except Microsoft Azure Data Lake cloud stores. See Edit big data file share manifests in Server Manager for more information.
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 item with portal groups whose members should have access to this data for analysis. Only members of these groups will be able to use the data as input to their analysis tasks. To learn more, see Get started with big data file shares
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.
If you added the file share or cloud storage location as a data store item in ArcGIS Enterprise, you cannot use that file share or cloud storage location as a big data file share.
Ensure ArcGIS Server Manager is communicating over HTTPS when registering or editing a big data file share.
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:
- Sign in to ArcGIS Server Manager on GeoAnalytics Server, and click Site > Data Stores.
- 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 register a big data file share, you can configure the big data file share to store results generated from GeoAnalytics Tools. Register a local directory or shared directory by completing the following:
Note:
As a best practice, it is recommended that you locate the big data file share on a dedicated file server with SAN or DAS or a NAS device. 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.
- Name: Provide a unique name for the registered location.
Names can be alphanumeric and contain spaces.
- Type: Click the type drop-down arrow and select File Share.
- Path: Specify the full path to the big data file share, for example, \\myserver\share\bigdata. Avoid using local paths, such as C:\bigdata, unless the same data folder is available on all nodes of the server site.
Note:
You cannot browse directories in ArcGIS Server Manager. You must provide the full path to the folder you want to register.
- Check Register as an output template to write results to your big data file share, and choose from the following list of output formats that you would like to support. Choose one or more options.
- Parquet
- Shapefile
- Delimited File
- ORC
Configure the output templates after registration. See Output templates in a big data file share for details.
- Click Create.
The file share you registered appears on the Registered Data Stores dialog box.
- Click the Pencil icon to preview the autogenerated manifest file and verify its datasets and schemas are appropriately defined.
If needed, you can modify or download and edit the manifest file. See Edit big data file share manifests in Server Manager for details. If you set this big data file share as an output location, you can modify, download, or edit the output targets.
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 the example shown in the Register a big data file share section.
Register HDFS as a big data file share
To register an HDFS directory of datasets, complete the following:
- Name: Provide a unique name for the registered location.
Names can be alphanumeric and contain spaces.
- Type: Click the type drop-down arrow and select HDFS.
- 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.
- Username: Provide a username to connect using simple authentication.
Note:
If you don't provide a username, the ArcGIS Server account will be used.
The username is supported if you are using Kerberos authentication.
- To write results from GeoAnalytics Tools to the big data file share, check Register as an output target and choose from a list of output formats that you would like to support. Choose one or more options.
- Parquet
- Shapefile
- Delimited File
- ORC
You can configure the output templates after registration.
- Click Create.
The HDFS share you registered appears on the Registered Data Stores dialog box.
- 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 Server 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 the example shown in the Register a big data file share section.
Register Hive as a big data file share
To register Hive, complete the following:
Note:
You cannot write results to a Hive big data file share.
- Name: Provide a unique name for the registered location.
Names can be alphanumeric and contain spaces.
- Type: Click the type drop-down arrow and select Hive.
- Metastore URIs: Specify the URI for the big data file share.
You can specify multiple metastores and, by default, Hive will use the first entry from the list.
For example, if you use 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.
- Database: Specify the database that contains the big data datasets you want to register.
- Username: Optionally provide a username to connect.
Note:
Hive does not support connecting to secured stores.
- Click Create.
The Hive store you registered appears on the Registered Data Stores dialog box.
- 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 Server 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 the example shown in the Register a big data file share section.
Register a cloud store as a big data file share
To register a cloud store as a big data file share in Server Manager, 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, complete the following steps:
- Name: Provide a unique name for the registered location.
Names can be alphanumeric and contain spaces.
- Type: Click the type drop-down and select Cloud Store.
- Click the Cloud Store drop-down and select your registered cloud store.
- To write results to the big data file share, check Register as an output target and choose from a list of output formats that you would like to support. Choose one or more options.
- Parquet
- Shapefile
- Delimited File
- ORC
You can configure the output templates after registration.
- 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.
- Sign in to ArcGIS Server Manager.
- Open the Data Stores page (Site > Data Stores).
- 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.
Unregister a data store
When you unregister a data store, the services and other functionality that depend on the data store will no longer function. Ensure that the data is no longer being used by the ArcGIS Server site or ArcGIS Enterprise before you unregister a data store.
How you remove the association between an ArcGIS Server site and a data store depends on how you registered the data store and the type of data store.
- If you registered the data store in ArcGIS Server Manager or ArcMap, use the unregister button next to the data store on Site > Data Stores in ArcGIS Server Manager.
Before you unregister a cloud data store that was added in ArcGIS Server Manager, delete the associated ArcGIS Server cache directory in ArcGIS Server Manager. For information on deleting an ArcGIS Server cache directory, see Delete a server directory in Server Manager.
- If you registered the data store in ArcGIS Pro or added a data store item in the ArcGIS Enterprise portal, you must remove the federated server from the data store item in the portal. Do not use any other app to unregister the data store.
- To remove an ArcGIS Data Store from the hosting server, use the unregisterdatastore utility installed with ArcGIS Data Store or ArcGIS Server Manager.
If you or a publisher in your organization accidentally unregisters an ArcGIS Data Store using ArcGIS Server Manager, you can use the registerdatastore utility to establish the association between the data store and the same ArcGIS Server site to get services to function again.
Considerations when unregistering data stores
Do not remove or unregister a data store if existing services contain data from the data store.
If you do unregister a data store from your ArcGIS Server site, and that data store is used to populate existing services, you may still be able to view the services depending on the type of data store that was used.
Keep the following limitations in mind when you unregister a data store:
- For databases registered in ArcGIS Server Manager or ArcGIS Pro, you can still view the data in the services they populate. However, if the password stored with the data store changes, you cannot update services to use the new password. At that point, the services will no longer function, and you will have to register the database that contains the service data and republish the services.
- For registered and managed databases, any new ArcGIS Server machines you add to the site will not recognize services if their source data store is no longer registered with the ArcGIS Server site. You will have to register the database that contains the service data and republish the services to allow the new machines to recognize the services.