SharePoint
- Backup site
Declaration
<AMSHAREPOINT ACTIVITY="backup_site" SITEURL="text" BACKUPFILE="text" OVERWRITE="YES/NO" />
Description
Performs a site collection backup.
NOTE:
- This activity only supports SharePoint 2016 and 2019 Server with the 64-bit version of Automate Desktop.
- SharePoint-related error messages appearing in Automate Desktop are sent from your SharePoint site or server. Automate Desktop displays these messages verbatim. For information on SharePoint error messages, refer to Microsoft's SharePoint documentation.
Practical usage
Performing a site collection backup may require resources and affect farm performance when the backup is running. Avoid performance issues by creating a task to automate the backup process, and then set Automate Desktop to run the task during hours when farm use is lowest (for example, outside office hours).
Parameters
Server
| Property | Type | Required | Default | Markup | Description |
|---|---|---|---|---|---|
| Site | Text | Yes | (Empty) | SITE="http://myServer/tech" | The SharePoint site to backup. |
| Backup file | Text | Yes | (Empty) | BACKUPFILE="c:\backup\site.bak" | The
path and file name of the backup. Select
the  icon to connect to a SharePoint site using the SharePoint
Browser to view or select specific contents such as files, folders and attachments. |
| Overwrite if file exists | Yes/No | No | No | OVERWRITE="YES" | If selected, matching files found in the destination will be overwritten. If disabled, matching files will not be overwritten, however, an error will occur as a result. |
Example
NOTE:
- Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
- To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.
Description
This sample task backs up a SharePoint site.
Copy
<AMSHAREPOINT ACTIVITY="backup_site" SITEURL="http://server_name/sites/site_name" BACKUPFILE="C:/TEMP/MySharePointBackup.bak" />