ArcGIS Data Store is registered with the GIS Server site that is set as the hosting server for an ArcGIS Enterprise deployment. You must upgrade all components of this deployment to the same version.
Prepare to upgrade ArcGIS Data Store
Carefully review the information below and complete any required actions before you upgrade ArcGIS Data Store.
Confirm your system meets 12.0 requirements
Supported systems, functionality, and other requirements may change between ArcGIS releases.
To confirm that your system meets the 12.0 requirements, do the following:
- Review the information for upgrading ArcGIS Enterprise.
- Read the ArcGIS Data Store 12.0 system requirements to ensure that your hardware meets current requirements.
- Before upgrading the relational data store, check the size of the ArcGIS Data Store directory on each machine. Ensure that the machine contains enough free disk space to accommodate double the size of the ArcGIS Data Store directory.
- Read What's new in ArcGIS Data Store 12.0 for information about changes in support and functionality.
- Confirm that all required ports are available.
Note:
Port requirements can change between releases. If you do not open the required ports, web layers may not be able to access data.
Software versions
If your current deployment is at version 11.0 or later, you can run the ArcGIS Data Store 12.0 setup and reconfigure data stores to upgrade to 12.0. Do not uninstall the previous version of ArcGIS Data Store.
Starting with this release, upgrading directly to ArcGIS Data Store 12.0 from version 10.8, 10.8.1, 10.9, or 10.9.1 is not supported. You must upgrade to an interim version, and upgrade that version to 12.0. Read the upgrade documentation for the interim version to confirm direct upgrades are supported for the ArcGIS Data Store version you start with.
If your organization contains hosted scene layer items, you cannot upgrade directly from 11.3 or earlier. You must first upgrade to 11.5, add the object store to the deployment, and migrate hosted scene layer caches to the object store before you can upgrade to 12.0.
Caution:
If you do not migrate hosted scene layer caches to the object store before you upgrade to 12.0, upgrading your deployment will delete the caches and leave the hosted scene layers unusable. The same is true for other item types that are no longer supported if you do not migrate them; they will not function after you upgrade.
The table below summarizes upgrade paths based on your starting version and whether your organization is using functionality that is not supported after 11.5. This includes the following:
- Hosted scene layers with caches stored in the tile cache data store
- Apps created using ArcGIS Web AppBuilder
- Apps created using ArcGIS Configurable Apps
| Deployment includes functionality not supported after 11.5 | Starting version | Interim versions |
|---|---|---|
No | 10.8, 10.8.1, 10.9, or 10.9.1 | 11.1 – 11.5 |
11.0, 11.1, 11.2, 11.3, 11.4, or 11.5 | None; upgrade directly to 12.0 | |
Yes | 10.8, 10.8.1, 10.9, 10.9.1, 11.0, 11.1, 11.2, 11.3, or 11.4 | 11.5 |
Note:
If your organization has an ArcGIS Enterprise 11.4 deployment that contains hosted scene layers with caches in the tile cache data store, but it does not contain any apps created using ArcGIS Web AppBuilder or ArcGIS Configurable Apps that must be migrated, you can migrate the hosted scene layer caches to the object store; then upgrade to the ArcGIS Enterprise deployment directly to 12.0.
Versions 10.7.1 and earlier are retired. Upgrading from these versions requires two interim upgrades. Read the 11.5 upgrade documentation for information.
See the ArcGIS Blog article Dive into ArcGIS Enterprise 11.5 before you delve into 12 for more information.
Tasks to complete before upgrading
Complete the following tasks before you upgrade:
- Create a backup of all data stores in the deployment, and store the backup files in a remote, secure location.
- Download the latest ArcGIS Data Store, Portal for ArcGIS, ArcGIS Server, and ArcGIS Web Adaptor software installation files from My Esri. Also download 12.0 authorization files for Portal for ArcGIS and ArcGIS Server from My Esri.
All components of a base ArcGIS Enterprise deployment must be the same software version.
- ArcGIS Data Store is always used as part of an ArcGIS Enterprise deployment, and you must upgrade certain components of the deployment before you upgrade ArcGIS Data Store. Upgrade the required ArcGIS Enterprise components described in the next section before you upgrade ArcGIS Data Store.
ArcGIS Enterprise upgrade order
The recommended order to upgrade the components in your ArcGIS Enterprise deployment is as follows:
- Upgrade Portal for ArcGIS.
- Upgrade ArcGIS Web Adaptor (for Portal for ArcGIS) for IIS or Java (Windows).
- Upgrade the ArcGIS Server site serving as the portal's hosting server.
- Upgrade ArcGIS Web Adaptor (for ArcGIS Server) for IIS or Java (Windows).
- Upgrade ArcGIS Data Store.
- If your ArcGIS Enterprise deployment includes them, upgrade any other federated server sites.
Most federated server sites must match the version of the base ArcGIS Enterprise deployment. For information on supported versions for federated server sites, see Federate an ArcGIS Server with your portal.
See the upgrade information for the type of federated servers you need to upgrade.
Upgrade ArcGIS Data Store
Once you have the installation files and backup files and you have upgraded the hosting server, complete the upgrade steps for each type of data store. All data stores registered to the same ArcGIS Server site must run the same ArcGIS Data Store release. Keep the following in mind when upgrading ArcGIS Data Store:
- Always install ArcGIS Data Store on all machines in a data store type before reconfiguring that data store.
For example, if the relational data store contains a primary and a standby machine, install the new version of ArcGIS Data Store on both machines first; then reconfigure the data store from either machine.
Similarly, if you have multiple spatiotemporal big data store, object store, or graph store machines configured with the hosting server site, install the new version of ArcGIS Data Store on every data store machine in the cluster. Once the new version is installed on all machines in the cluster, you can reconfigure the data store.
- Primary-standby mode for a graph store is no longer supported. Upgrading a graph store running in primary-standby mode from 11.2, 11.3, or 11.4 places the graph store in single instance mode. If you have primary and standby machines in the graph store, install the new version of ArcGIS Data Store on the primary and standby machines, and reconfigure one of the machines. Ensure that a default backup location is configured for the graph store, and use the configuredatastore utility to re-add the second machine and add a third machine to the graph store after upgrading.
- Do not uninstall ArcGIS Data Store before installing the new version.
You can upgrade using an interactive wizard-driven experience by running the Setup.exe program, or run Setup.exe and the configuredatastore utility from a command prompt or script to silently upgrade ArcGIS Data Store. Regardless of the method you use, the Setup.exe installation file detects and upgrades an existing installation of ArcGIS Data Store.
Note:
Upgrading ArcGIS Data Store restarts the ArcGIS Data Store service.
Upgrade using an interactive experience
After you complete the steps outlined in the Prepare to upgrade ArcGIS Data Store section above and have upgraded the ArcGIS Enterprise components that must be upgraded before ArcGIS Data Store, complete the following steps to upgrade your data stores using an interactive app. To upgrade using commands instead, proceed to the next section.
Note:
The ArcGIS Data Store upgrade app can be used to upgrade one machine of the graph store, but to configure two other graph store machines to deploy in cluster mode, you must use the configuredatastore utility.
- If you are using a spatiotemporal big data store with ArcGIS GeoEvent Server, sign in to ArcGIS GeoEvent Manager, and stop the feature services used to archive data.
- Update the ArcGIS Data Store installation on every data store machine.
To update the installation, run the ArcGIS Data Store Setup.exe program on every machine that participates in a data store that is configured with the same hosting server.
Note:
Do not uninstall the existing ArcGIS Data Store installation.
- During the installation, read the license agreement and accept it, or exit if you do not agree with the terms.
If you accept the license agreement, the ArcGIS Data Store setup program displays the features that will be installed.
- Provide the password for the account.
Typically, this is the password you defined when installing the software. If the password has changed since you installed the software, you must provide the password you designated when modifying the account. If the password is not valid, an error message appears, indicating the password is invalid. If you are unsure of the password for the account, contact your system administrator.
- After you update the ArcGIS Data Store installation on all data store machines, open a supported web browser and clear the browser cache, including cookies.
- Run the ArcGIS Data Store upgrade app to configure each type of data store to complete the upgrade.
The ArcGIS Data Store upgrade app URL is in the format https://datastoremachine.example.com:2443/arcgis/datastore.
The number of times you need to run the ArcGIS Data Store upgrade app depends on your configuration as follows:
- For a relational data store running in primary-standby mode, run the ArcGIS Data Store upgrade app on either the primary or standby machine. Completing the steps in the app upgrades the data store on both machines.
- For a graph store running in primary-standby mode, run the ArcGIS Data Store upgrade app on either machine to upgrade it. This upgrades the graph store on that machine and sets it in single instance mode. It also unregisters the graph store on the other machine and deletes the duplicate graph data from it. To maintain high availability, configure a graph store cluster as described in the Add a machine to upgraded graph store section in the Postupgrade tasks near the bottom of this page.
- For a data store type that is running in cluster mode, run the ArcGIS Data Store upgrade app on any machine in the cluster. Completing the steps in the app upgrades all machines in that data store cluster.
- When there is more than one type of data store on the same machine, you only have to run the ArcGIS Data Store upgrade app once to upgrade the data stores on that machine.
- In the first page of the app, provide the fully qualified name of one of the machines in the hosting server site, provide the username and password of an ArcGIS Server administrator for the hosting server, and click Next.ArcGIS Data Store checks each machine for each data store registered with this hosting server to verify it meets the following prerequisites:
- All machines in the data stores associated with this hosting server have the same version of ArcGIS Data Store installed.
- All machines in the data stores associated with this hosting server are accessible.
- The hosting server is accessible.
If any prerequisites are not met, they appear in the Prerequisite check page in the status for each data store type. You must correct any problems before you can proceed with upgrading.
Once all prerequisites are met, the Prerequisite check page shows each data store that is ready for upgrade.
- Click Next to reconfigure these data stores with the hosting server and complete the upgrade.
The Upgrade status page appears.
The status for the data store being upgraded is scheduled while the upgrade is running.
For each data store that was upgraded successfully, succeeded appears in the Status field. For highly available relational data stores, a status appears for both machines.
- If all data store machines upgraded successfully, click Next to proceed to the Configuration status page.
You can close the ArcGIS Data Store upgrade app.
If any upgrades were not successful, that data store or machine shows a failed status, and messages are displayed to help you troubleshoot the problem.
- If applicable, correct the problems and run the ArcGIS Data Store upgrade app again to upgrade the machines that previously failed.
- If you have a spatiotemporal big data store, confirm that it shows a status of healthy.
To determine a data store's status, sign in to the ArcGIS Server Administrator Directory for the hosting server and run the validate REST command.
Caution:
When the installation program completes, it automatically opens the ArcGIS Data Store upgrade app in your default browser. Do not proceed with upgrade until you have installed the same version of ArcGIS Data Store on every data store machine.
Upgrade using commands
Rather than run the setup program, you can run the Setup.exe file at a command prompt or in a batch script to update ArcGIS Data Store. To avoid receiving a prompt to proceed with the upgrade, run the command in silent mode. To do so, include the /qb parameter in the script.
After you complete the steps outlined in the Prepare to upgrade ArcGIS Data Store section above and have upgraded the ArcGIS Enterprise components that must be upgraded before ArcGIS Data Store, run the ArcGIS Data Store setup file on every machine in the data store to install the new software version. Next, run the configuredatastore utility on every data store machine to upgrade.
- If you are using a spatiotemporal big data store with ArcGIS GeoEvent Server, sign in to ArcGIS GeoEvent Manager and stop the feature services used to archive data.
- Update the ArcGIS Data Store installation on every data store machine.
Run the Setup.exe file from a command prompt or in a script on every machine in the data store. For example, if you have a highly available relational data store (two machines) and a highly available spatiotemporal big data store that includes three machines, run the Setup.exe file on all five machines before you proceed with configuration.
Note:
Do not uninstall the existing ArcGIS Data Store installation.
When upgrading using Setup.exe in silent mode, you must specify the ArcGIS Data Store account. Typically, this is the account you defined when installing the software. If the account has changed since you installed, you need to provide the username and password you designated when modifying the ArcGIS Data Storeaccount.
If you do not specify the ArcGIS Data Store account, or it does not match the account used by the current installation, the installation process displays a message indicating the credentials could not be validated, and the installation closes.
In the following example of running the command in silent mode, the account used by the software is myaccount:
<path to ArcGIS Data Store setup download folder>\Setup.exe /qb USER_NAME=myaccount PASSWORD=mypassword ACCEPTEULA=yes
For example, to run the command with a domain account, such as mydomain\myaccount, with the password 4myI.s0nly, type the following:
\\machinename\mydownloadfolder\Setup.exe /qb USER_NAME=mydomain\myaccount PASSWORD=4myI.s0nly ACCEPTEULA=yes
Caution:
Command line parameters are case sensitive. Confirm the case matches the properties as shown in the examples.
- Use the configuredatastore utility to reconfigure the data store with the same GIS Server site you were using before upgrading.
You must run the command prompt as an administrator on the machine where ArcGIS Data Store is installed.
Where and the number of times you need to run the configuredatastore utility depends on your configuration as follows:
- For a relational data store running in primary-standby mode, sign in to either the primary or standby machine as the user who installed ArcGIS Data Store, and run the configuredatastore utility. This upgrades the data store on both the primary and standby machines.
- For a graph store running in primary-standby mode, sign in to one of the graph store machines as the user who installed ArcGIS Data Store, and run the configuredatastore utility. This upgrades the graph store on that machine and sets it to single instance mode. It also unregisters the graph store on the other machine and deletes the duplicate graph data from it. To maintain high availability, configure a graph store cluster as described in the Add a machine to upgraded graph store section in the Postupgrade tasks near the bottom of this page.
- For a data store running in cluster mode, sign in to any of the machines in that cluster as the user who installed ArcGIS Data Store, and run the configuredatastore utility. This upgrades all machines in the clustered data store.
- When different types of data stores are on the same machine, you can specify the ones to upgrade using the --stores parameter when you run the configuredatastore utility.
In this example, the configuredatastore utility is run on the primary machine where the relational data store is running. The data store is configured with the GIS Server site https://myserver.example.com:6443/arcgis:
configuredatastore https://myserver.example.com:6443/arcgis serveradmin MyAdminPassword C:\arcgisdatastore --stores relational
In this example, the configuredatastore utility is run on one of the machines in a spatiotemporal big data store that is configured with the GIS Server site https://gisserver.example.com:6443/arcgis:
configuredatastore https://gisserver.example.com:6443/arcgis serveradmin MyAdminPassword C:\arcgisdatastore --stores spatiotemporal
Running the configuredatastore utility restarts ArcGIS Data Store on all machines in the data store.
Before upgrading, ArcGIS Data Store confirms that all machines in the data store have the same version of ArcGIS Data Store installed and all machines are accessible. If any machines are not updated or accessible, ArcGIS Data Store cannot proceed with the upgrade procedure. Correct the installation or network problems and run the configuredatastore utility again.
- If you have a spatiotemporal big data store, confirm that it shows a status of healthy.
To determine a data store's status, sign in to the ArcGIS Server Administrator Directory for the hosting server and run the validate REST command.
- If the ArcGIS Enterprise portal has federated ArcGIS GeoEvent Server, ArcGIS Mission Server, or ArcGIS Knowledge Server sites, upgrade these sites.
Once the federated sites are upgraded, confirm that the services running on the sites are functional.
Postupgrade tasks
After upgrading all ArcGIS Data Store types in the deployment, do the following:
- Validate that all data stores are accessible.
- Check hosted web layers to ensure they are running.
- If you upgraded a primary-standby graph store from 11.4 or earlier and need a graph store cluster, follow the instructions to add machines to the upgraded graph store.
- Create backups of all data stores.
- Remove temporary files that are no longer necessary.
Validate data stores
You can sign in to ArcGIS Server Manager to validate that the GIS Server site can still communicate with each of the data stores.
To validate a data store from ArcGIS Server Manager, complete the following steps:
- Sign in to ArcGIS Server Manager.
The account you use to sign in must be a member of the publisher or administrator role.
- Go to Site > Data Stores.
- Check the box next to the data store you want to validate (ArcGIS_Data_Store).
- Click Validate.
If the data store is running and the GIS Server site can communicate with it, a green check mark appears in the Status column.
Check hosted web layer status
To ensure that hosted web services still function after you upgrade, complete the following steps:
- Sign in to ArcGIS Server Manager.
The account you use to sign in must be a member of the publisher or administrator role.
- Go to Services > Hosted.
- Confirm that all services are running.
Add machines to an upgraded graph store
When you upgrade a graph store to 12.0 from 11.4 or an earlier release, the upgraded graph store is in single instance mode. If you upgrade an 11.2, 11.3, or 11.4 graph store that was running in primary-standby mode, upgrading changes the mode to single instance mode, and only one machine remains viable. To maintain high availability, configure a graph store cluster.
A cluster must contain three machines. You can use the existing (though unregistered) second machine for the second machine in the cluster, because you installed the latest version of ArcGIS Data Store on it already. Configure it with the same hosting server as the upgraded graph store machine. Next, install ArcGIS Data Store on a third machine and configure it as a graph store that is registered with the same hosting server as the other two graph store machines.
Caution:
Do not use these instructions if you created the deployment using ArcGIS Enterprise Cloud Builder for Microsoft Azure or any of the ArcGIS Enterprise on Amazon Web Services deployment tools. Instead, follow the upgrade instructions provided in the ArcGIS Enterprise on Microsoft Azure and ArcGIS Enterprise on Amazon Web Services help.
To create a graph store cluster after upgrading, complete the following steps:
- Ensure that a default backup location is configured for the graph store.
- Add a second graph store machine to the deployment by doing the following:
- Use the old second machine or install ArcGIS Data Store (graph store) on a new machine.
- Run the configuredatastore utility on the second machine to configure the graph store, and register it with the same hosting server as the upgraded graph store machine.
configuredatastore https://myserver.example.com:6443/arcgis serveradmin MyAdminPassword C:\arcgisdatastore --stores graph --mode cluster
The graph store is placed in cluster mode as soon as you configure the second graph store machine in cluster mode. However, it is not a functional cluster until you add the third machine.
- Install ArcGIS Data Store (graph store) on a third machine.
A graph store cluster must contain three machines; no more and no fewer.
- Run the configuredatastore utility on the third machine to create the graph store, and register it with the same hosting server as the other two machines.
The graph store cluster is in place, and ArcGIS Data Store will distribute the graph data across the cluster.
Create full backups of all data stores
After you confirm that the upgrade is valid, use the backupdatastore utility to create a backup of each data store in the deployment. This provides you with a usable full backup in case anything happens before the next scheduled backup.
Remove unneeded temporary files
After you complete the postupgrade steps described above, you can run the diskcleanup utility to remove temporary files that are no longer necessary.