Manage registered data stores

In ArcGIS Pro, you can register enterprise databases, folders, cloud stores, and NoSQL databases as data stores with your ArcGIS Enterprise portal's federated servers. A data store is any location containing data that a federated server has permission to access and use as source data for web layers. When sharing web layers that reference data from a registered data store, the source data does not need to be copied to the server. You can also use ArcGIS Pro to edit and remove data stores.

Starting with ArcGIS Enterprise 10.7.1, new data stores are viewed, created, and managed as items in your portal content. It is possible to add and manage data stores without creating portal items if you use ArcGIS Server Manager, but it is not possible from ArcGIS Pro.

Creating a data store requires the portal privilege to register data stores. This is a default privilege of the publisher and administrator roles. Data stores can be managed (edited or removed) by the data store owner or an organization administrator.

For ArcGIS Enterprise 10.7 and earlier versions, you work with data stores directly through the federated server, not through your portal. Data stores can be created or managed by organization members with administrator or publisher permissions. This help topic includes notes where workflows are different for these older ArcGIS Enterprise versions.

Learn more about prerequisites for registering data and the different scenarios for registering data in the ArcGIS Enterprise help.

View data stores

With ArcGIS Enterprise 10.7.1 or a later version, you can use ArcGIS Pro to view data stores as items in your portal.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.

    The Manage Registered Data Stores pane appears. By default, the drop-down list at the top of the pane is set to Portal Items.

  2. If necessary, click the My Content button My Content to filter the view.

    The pane displays registered data stores created and owned by you.

  3. Click the Shared With Me button Shared With Me to see data stores in the portal that are shared with you.

    Two views of the Manage Registered Data Stores pane
    You can display data stores that you own, data stores that are shared with you, or both, depending on how you filter the view.

  4. Click the drop-down arrow and click a federated server to see all portal data store items registered with the server, as well as existing data stores that were registered directly with the server and not as portal items.
    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, this is the only way to view data stores.

Register a database as a data store

If you want web layers to reference—and potentially edit—data in an enterprise geodatabase or supported database, you need to register the database with a server that is federated with your portal.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.

    The Manage Registered Data Stores pane appears. (You can also open the pane from the Share As Web Layer pane, on the General tab, under Location.)

  2. At the top of the pane, confirm that the drop-down list is set to Portal Items. Click the Add button Add a data store item to the portal and click Database Database.
    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, the drop-down list does not contain a Portal Items option. Choose the federated server where the data store will be created.

  3. On the Add data store dialog box, provide a title and, optionally, enter tags.

    A title is required metadata for the data store portal item. Tags are required when sharing to an ArcGIS Enterprise 10.9 or earlier portal.

    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, the name of the dialog box is Register Database. Instead of a title and tags, you provide a name for the data store. There is no option to specify a portal folder as described in the next step.

  4. Optionally, specify a folder to contain the data store item in your portal.

    By default, the item is stored at the root level of your content. You can choose an existing folder or create a folder using the drop-down menu. You can also browse to a folder.

  5. Add a publisher database connection in one of the two following ways:
    • Click Add. On the Database Connection dialog box, fill in the connection properties and click OK. See Database connections in ArcGIS Pro for details.
    • Click Import. In the Select Existing Geodatabase file browser, browse to an existing database connection file (.sde) and click OK.

    The publisher database is the database that contains the data you want to register with the server.

  6. On the Add data store dialog box, if the publisher and server work with different databases, select the New connection option. Click Add or Import to specify a database connection the server can access.
    Note:

    • For ArcGIS Enterprise 10.7 and earlier portals, this setting appears on the Register Database dialog box. Because you previously specified a server from the Federated Servers drop-down list, you can now click Create to create the data store.
    • When registering a data store for a cloud data warehouse, the server database connection must be the same as the publisher database connection. The option to specify a different server database connection is disabled.

  7. Click the check box for the server to which you want to add the data store. You can select more than one server.
    If your database connection is to a cloud data warehouse, select the hosting server. You can only publish data from cloud data warehouses to the hosting server.
  8. Optionally, click Validate Validate to confirm that the server can access the server database.

    If the database is accessible, a confirmation Valid appears in the Status column next to the server name. If not, an error The data item is inaccessible appears. The connection is also validated automatically when you create the data store.

  9. Under Share with, specify how the data store will be shared.
    • Everyone—This option makes your data store public. Anyone can access and see it.
    • My Organization—This option allows your data store to be shared with all authenticated users in the organization.
    • Groups—You can share your data store with groups to which you belong and their members.

    Leave all options unchecked to set the sharing level to the owner of the item.

  10. Click Create.

    The data store is created and appears in the Manage Registered Data Stores pane.

Register a folder as a data store

If you want web layers to reference data in a folder, you need to register the folder with a server that is federated with your portal.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.

    The Manage Registered Data Stores pane appears. (You can also open the pane from the Share As Web Layer pane, on the General tab, under Location.)

  2. At the top of the pane, confirm that the drop-down list is set to Portal Items. Click the Add button Add a data store item to the portal and click Folder Folder.
    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, the drop-down list does not contain a Portal Items option. Choose the federated server where the data store will be created.

  3. On the Add data store dialog box, provide a title and, optionally, enter tags.

    A title is required metadata for the data store portal item. Tags are required when sharing to an ArcGIS Enterprise 10.9 or earlier portal.

    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, the name of the dialog box is Register Folder. Instead of a title and tags, you provide a name for the data store. There is no option to specify a portal folder as described in the next step.

  4. Optionally, specify a folder to contain the data store item in your portal.

    By default, the item is stored at the root level of your content. You can choose an existing folder or create a folder using the drop-down menu. You can also browse to a folder.

  5. Type the path to the publisher folder. Alternatively click the Browse button Browse, browse to a folder, and click OK.

    The publisher folder is the folder that contains the data you want to register with the server.

  6. Under Server folder path, choose one of the following options:

    Same as publisher folder path

    The publisher and server access data in the same shared folder. This is the default option.

    New path

    The publisher and server work with different folders. Type a path or browse to a folder the server can access.

    For ArcGIS Enterprise on Kubernetes, the file shares must be already mounted.

    NFS host and path

    Provide the NFS hostname and NFS share path to have ArcGIS Enterprise mount the directory without requiring that cluster nodes be prepared in advance. This option is only available if your active portal is ArcGIS Enterprise on Kubernetes 11.0 or later.

    Only ArcGIS Enterprise administrators can add new file share locations. Adding a new file share location causes all services running on shared resources to restart. Services cannot be used when they are restarting, which can take up to 15 minutes.

    Publishers can register subfolders if the root folder has been previously registered by an administrator.

    For more information, see Add a data store.

    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, this setting appears on the Register Folder dialog box. Because you previously specified a server from the Federated Servers drop-down list, you can now click Create to create the data store.

  7. Click the check box for the server to which you want to add the data store. You can select more than one server.

    If you selected the NFS host and path option, select the hosting server. You can only register NFS folders to the hosting server.

  8. Optionally, click Validate Validate to confirm that the server can access the server folder.

    If the folder is accessible, a confirmation Valid appears in the Status column next to the server name. If not, an error The data item is inaccessible appears. The connection is also validated automatically when you create the data store.

  9. Under Share with, specify how the data store will be shared.
    • Everyone—This option makes your data store public. Anyone can access and see it.
    • My Organization—This option allows your data store to be shared with all authenticated users in the organization.
    • Groups—You can share your data store with groups to which you belong and their members.

    Leave all options unchecked to set the sharing level to the owner of the item.

  10. Click Create.

    The data store is created and appears in the Manage Registered Data Stores pane.

Register a cloud store as a data store

If you want web imagery layers to reference data in a cloud store, you must register the cloud store with a server that is federated with your portal.

Note:

Registering a cloud store is not supported for ArcGIS Enterprise 10.7 and earlier portals.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.

    The Manage Registered Data Stores pane appears. (You can also open the pane from the Share As Web Layer pane, on the General tab, under Location.)

  2. At the top of the pane, confirm that the drop-down list is set to Portal Items. Click the Add button Add a data store item to the portal and click Cloud Cloud.
  3. On the Add data store dialog box, provide a title and, optionally, enter tags.

    A title is required metadata for the data store portal item. Tags are required when sharing to an ArcGIS Enterprise 10.9 or earlier portal.

  4. Optionally, specify a folder to contain the data store item in your portal.

    By default, the item is stored at the root level of your content. You can choose an existing folder or create a folder using the drop-down menu. You can also browse to a folder.

  5. Add a cloud store connection in one of the following ways:
    • Click Add. On the Create Cloud Storage Connection dialog box, fill in the connection properties and click OK.
    • Click Import. In the Select Existing Cloud Store file browser, browse to an existing cloud storage connection file (.acs) and click OK.

    The following are supported cloud storage providers:

    • Alibaba Cloud Storage
    • Amazon S3
    • Google Cloud Storage (supported for ArcGIS Enterprise 10.9.1 and later)
    • Microsoft Azure Storage

    Learn more about connecting to a cloud store

  6. Check the check box for the server to which you want to add the data store. You can select more than one server.
  7. Optionally, click Validate Validate to confirm that the server can access the cloud store.

    If the cloud store is accessible, a confirmation Valid appears in the Status column next to the server name. If not, an error The data item is inaccessible appears. The connection is also validated automatically when you create the data store.

  8. Under Share with, specify how the data store will be shared.
    • Everyone—This option makes your data store public. Anyone can access and see it.
    • My Organization—This option allows your data store to be shared with all authenticated users in the organization.
    • Groups—You can share your data store with groups to which you belong and their members.

    Leave all options unchecked to set the sharing level to the owner of the item.

  9. Click Create.

    The data store is created and appears in the Manage Registered Data Stores pane.

Register a NoSQL database as a data store

If you want to create knowledge graphs that use a NoSQL database, you must register the NoSQL database with a server that is federated as an ArcGIS Knowledge Server with your portal.

Note:

Registering a NoSQL database is supported starting with ArcGIS Enterprise 11.1. It is not supported for ArcGIS Enterprise on Kubernetes.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.

    The Manage Registered Data Stores pane appears. (You can also open the pane from the Share As Web Layer pane, on the General tab, under Location.)

  2. At the top of the pane, confirm that the drop-down list is set to Portal Items. Click the Add button Add a data store item to the portal and click NoSQL NoSQL.
  3. On the Add data store dialog box, provide a title and, optionally, enter tags.
  4. Optionally, specify a folder to contain the data store item in your portal.

    By default, the item is stored at the root level of your content. You can choose an existing folder or create a folder using the drop-down menu. You can also browse to a folder.

  5. Click Add. On the NoSQL Connection dialog box, fill in the connection properties and click OK.

    Only Neo4j is a supported provider.

  6. Check the check box for the ArcGIS Knowledge Server to which you want to add the data store.
  7. Optionally, click Validate Validate to confirm that the server can access the NoSQL database.

    If the NoSQL database is accessible, a confirmation Valid appears in the Status column next to the server name. If not, an error The data item is inaccessible appears. The connection is also validated automatically when you create the data store.

  8. Under Share with, specify how the data store will be shared.
    • Everyone—This option makes your data store public. Anyone can access and see it.
    • My Organization—This option allows your data store to be shared with all authenticated users in the organization.
    • Groups—You can share your data store with groups to which you belong and their members.

    Leave all options unchecked to set the sharing level to the owner of the item.

  9. Click Create.

    The data store is created and appears in the Manage Registered Data Stores pane.

Edit a data store

After your data store has been registered, you can edit it if necessary. For example, if the location of your source data changes, you may need to update a publisher or server path.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.
  2. At the top of the Manage Registered Data Stores pane, confirm that the drop-down list is set to Portal Items.
    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, the data stores appear under the selected server in the Federated Servers list.

  3. Click or hover over the data store to select it and click Edit Edit.

    On the Edit data store dialog box, you can edit the following properties:

    • For data stores created from databases, the password of the publisher or server database connection
    • For data stores created from folders, the publisher or server folder path. For ArcGIS Enterprise on Kubernetes 11.0 or later, this includes the NFS hostname and NFS share path if the root folder is already registered.
    • For data stores created from cloud stores, you can edit the following:
      • Amazon Web Services, Alibaba, and Google Cloud—You can edit the access key, secret key, bucket name, folder, and region.
      • Microsoft Azure—You can edit the account name, account key, container name, folder, and environment.
    • For data stores created from NoSQL databases, the password, connection URI, and fallback servers
    • The servers to which the data store is added
    • The data store sharing properties

    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, only the first two properties are editable.

  4. Edit the data store properties and click Save.

Remove a data store

If your federated server no longer requires access to a data store, you can remove it.

  1. On the ribbon, click the Share tab. In the Manage group, click Data Stores Data Stores.
  2. At the top of the Manage Registered Data Stores pane, confirm that the drop-down list is set to Portal Items.
    Note:

    For ArcGIS Enterprise 10.7 and earlier portals, there is no Portal Items drop-down list. The data stores appear under the selected server in the Federated Servers list.

  3. Click or hover over the data store to select it and click Remove Remove.
  4. Click OK on the prompt to unregister the database or folder.