Skip To Content

Back up and restore an ArcGIS Knowledge site

One consideration for your ArcGIS Knowledge site is developing a plan to restore the site in the event of hardware failure or data loss. You can export the components of your ArcGIS Enterprise deployment to a backup file that can later be used to restore it.

If you are using a NoSQL data store with your ArcGIS Knowledge site, there are additional factors to consider to ensure the NoSQL databases associated with your site can be restored. You must create a plan to back up and restore your NoSQL databases outside ArcGIS that is coordinated with your plan to back up and restore ArcGIS Enterprise.

Back up an ArcGIS Knowledge site

You can create backups of your ArcGIS Knowledge site by using the WebGISDR tool and setting the INCLUDE_GRAPH_STORE_DATA property to true. A backup will contain all of the data and settings in your base deployment along with the knowledge services and graph data.

Note:

You must configure a backup location for the graph store prior to creating a backup.

Sites with NoSQL data stores

When you use NoSQL data stores with knowledge graphs, you must back up your NoSQL databases in addition to taking the steps above to back up your ArcGIS Knowledge site. NoSQL databases must be backed up using the appropriate database administration utilities in a manner that is appropriate for your version of the software and your operating environment.

ArcGIS-managed data

When you have knowledge graphs that are configured to use NoSQL data stores containing ArcGIS-managed data, extra steps are needed to back up your ArcGIS Knowledge site.

The graph store associated with your ArcGIS Knowledge site stores schema information that must be kept in sync with the entities and relationships stored in all NoSQL databases that contain ArcGIS-managed data. It is critical that these ArcGIS-managed NoSQL databases are backed up at the same time as the rest of your ArcGIS Enterprise deployment so the data can be successfully restored in the future.

Edits to the ArcGIS-managed NoSQL databases are only supported through ArcGIS Pro and ArcGIS Enterprise. All NoSQL databases containing ArcGIS-managed data must be placed in read-only mode at the appropriate point in the process. This ensures no write operations are made to either the graph store or the ArcGIS-managed NoSQL databases until both backup operations are complete.

  1. Put all NoSQL databases associated with your ArcGIS Knowledge site that contain ArcGIS-managed data in read-only mode using either Neo4j or ArangoDB utilities.
  2. Back up your ArcGIS Enterprise deployment using the webgisdr utility.
  3. Back up the read-only NoSQL databases using the appropriate Neo4j or ArangoDB utilities.
  4. Put the appropriate NoSQL databases back in read-write mode.

User-managed data

When you have knowledge graphs that are configured to use NoSQL data stores containing user-managed data, it is expected that you will update the NoSQL database outside ArcGIS. This allows for some flexibility during the process of backing up your ArcGIS Knowledge site.

  1. Back up the NoSQL databases associated with your ArcGIS Knowledge site that contain user-managed data using the appropriate Neo4j or ArangoDB utilities.
  2. Back up your ArcGIS Enterprise deployment using the webgisdr utility.

Restore an ArcGIS Knowledge site

Follow the steps below to restore your ArcGIS Enterprise base deployment along with the knowledge services and graph data. The environment you're restoring to must have configured the ArcGIS Knowledge Server site with the knowledge server role.

Sites with NoSQL data stores

When you use NoSQL data stores with knowledge graphs, you must restore your NoSQL databases in addition to taking the steps above to restore your ArcGIS Knowledge site. NoSQL databases must be restored using the appropriate database administration utilities in a manner that is appropriate for your version of the software and your operating environment.

ArcGIS-managed data

When you have knowledge graphs that are configured to use NoSQL data stores containing ArcGIS-managed data, extra steps are needed to restore your ArcGIS Knowledge site.

The data in the graph store and the data in all ArcGIS-managed NoSQL databases must be in sync. That is, all pieces must represent the same backup point. During the restoration process, write operations must not be made to the graph store or to any ArcGIS-managed NoSQL databases until all steps are complete. Therefore, the ArcGIS-managed NoSQL databases must be placed in read-only mode at the appropriate point in the process.

  1. Restore the NoSQL databases associated with your ArcGIS Knowledge site that contain ArcGIS-managed data using either Neo4j or ArangoDB utilities.
  2. Put the restored NoSQL databases in read-only mode using the appropriate utilities.
  3. Restore your ArcGIS Enterprise deployment using the webgisdr utility.
  4. Put the appropriate NoSQL databases back in read-write mode using the appropriate Neo4j or ArangoDB utilities.

User-managed data

When you have knowledge graphs that are configured to use NoSQL data stores containing user-managed data, it is expected that you will update the NoSQL database outside ArcGIS. This allows for some flexibility during the process of restoring your ArcGIS Knowledge site.

  1. Restore your ArcGIS Enterprise deployment using the webgisdr utility.
  2. Restore the NoSQL databases containing user-managed data associated with this ArcGIS Knowledge site using the appropriate Neo4j or ArangoDB utilities.

If edits were saved to any user-managed NoSQL databases after the graph store was backed up using the WebGISDR tool and before the NoSQL database backups were complete, you can synchronize the data model for the appropriate knowledge graphs in ArcGIS Pro. Similarly, edits may have been saved to the user-managed NoSQL databases after they were restored but before the process of restoring the entire ArcGIS Knowledge site was complete.

The data model synchronization process updates the graph store with the entity types, relationship types, and the data types of their properties using the current data model of the user-managed NoSQL database associated with a knowledge graph.