Automate ArcGIS Enterprise Backup
It's a good practice to backup your ArcGIS Enterprise in the event of failure or corruption. Doing so allows you to recover the portal items, services, and data that existed at the time you created the backup. This document and attached script will help you automate this procedure. Here are the steps:
Prerequisites
The python-dateutil module is required for this script to execute successfully. This module is not included with python that is installed with Portal. Follow the below steps to install this module.
1. Navigate to the following URL, copy all the text on the page, and paste into a text editor (i.e. Notepad++)
2. Save the file to Portal's python directory (i.e. C:\Program Files\ArcGIS\Portal\framework\runtime\python) as get-pip.py
3. Open a command prompt as an Administrator and navigate to Portal's python directory (i.e. C:\Program Files\ArcGIS\Portal\framework\runtime\python)
4. Run the following command:
python get-pip.py
5. After that installs, navigate to C:\Program Files\ArcGIS\Portal\framework\runtime\python\scripts:
6. Run the following command
pip install python-dateutil
Configure Script and BAT File
1. Following the steps in this help document, edit the webgisdr.properties file accordingly.
2. Once you have the webgisdr.properties file edited, update the variables in the attached WEBGISDR_Export_Full.py script.
- backupDirectory - should be the same as the BACKUP_LOCATION variable in the webgisdr.properties file
- previousBackups - a directory of your choose where you can store previous backups
- batFile - the path to a batch file (.bat) that this python script will execute
- days - the number of days to retain previous backups in the previous backups directory
3. Edit the attached WEBGISDR_Export_Full.bat file using a text editor (i.e. Notepad++)
- Line 2 - Specify a path to the webgisdr directory (i.e. C:\Program Files\ArcGIS\portal\tools\webgisdr)
- Line 3 - Specify the file parameter to the path where the webgisdr.properties file exists
4. Set up Windows Task Scheduler to execute the python script on a scheduled basis. It would be best to perform full backups while there is less traffic on your network, i.e. after business hours.
Note: Refer to this section of what's included in the backup, and what is not.
See a video of this workflow in the link below:
@Izzattry the following to get the dateutil module:
1. Download get-pip.py to C:\Program Files\ArcGIS\Portal\framework\runtime\python
2. Open a command prompt and navigate to the above directory
3. Run the following command
python get-pip.py
4. After that installs, navigate to C:\Program Files\ArcGIS\Portal\framework\runtime\python\scripts:
5. Run the following command
pip install python-dateutil
@JakeSkinner ,
This is the location. No Scripts folder.
I try to create manually the folder and run get-pip.py still got same error.
Currently i am using ArcGIS Enterprise 10.8.1 and webgisdr backup file name currently change to 20210210-110267-SGT-FULL.webgissite. So i change to this one
for file in os.listdir(previousBackups):
fileDate = file.split("-")[0]
data = str(fileDate)
year = int(data[0:4])
month = int (data[4:6])
day = int (data[6:8])
date = str(year) + "-" + str(month) + "-" + str(day)
Yes, at 10.8.1 the file name changed. Here is the script I updated.
for file in os.listdir(previousBackups):
if 'FULL' in file:
print(file)
print("day: " + file[6:8])
day = file[6:8]
print("month: " + file[4:6])
month = file[4:6]
print("year: " + file[:4])
year = file[:4]
#month = file.split("-")[0]
#day = file.split("-")[1]
#year = file.split("-")[2]
date = month + "-" + day + "-" + year
dt = parse(date)
newDate = datetime.now() - timedelta(days + 1)
if dt < newDate:
# Delete File
os.remove(os.path.join(previousBackups, file))
@JakeSkinner What I'm wondering is has anyone experienced this error when trying to run the incremental import? I ran the full import and then the incremental. Can't find anything about this error. It's specific to datastore.
"Cannot get ancestors in the response of the request"
@JakeSkinner Thanks man it is working.
One Thing I need to discuss with you, in the WEBGISDR_Export_Full.py file
backupdirectory, previousBackups for these variables I need to assign the S3 Bucket folder, Can i do that?
Because my purpose is need to upload the all files in the S3 bucket. So these backpDirectory and previousdirectory should be there in S3 buckets
@BrielleHartney make sure there are no additional files in the directory you have specified for the previousBackups variable. This directory should only contain webgisdr backups (i.e. .webgissite) files. Ex:
The script iterates through all files within this directory and parses the date from the filename. If there is another file that is not formatted like above, the script will fail.
