SharePoint - Backup Site

Declaration

<AMSHAREPOINT ACTIVITY="backup_site" SITEURL="text" BACKUPFILE="text" />

Description: Performs a site collection backup.

NOTE: This activity is only supported on SharePoint 2013 Server. In addition, the user account that is performing this procedure must have the site collection administrator permission.

Practical Usage

Performing a site collection backup might require resources and may affect farm performance when the backup is running. You can help avoid performance issues by creating a task that automates the backup process and set to run the task during hours when farm use is lowest, such as outside office hours.

Parameters Connection

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 filename of the backup. Click the folder icon to open the SharePoint Browser allowing for easy navigation.

Overwrite if file exists

Yes/No

No

No

Overwrite="YES"

If set to YES, matching files found in the destination will be overwritten. If set to NO, matching files will not be overwritten, however, an error will occur as a result.

Example

The sample AML code below can be copied and pasted directly into the Steps panel of the Task Builder.

Description: Backup sharepoint site "http://server_name/sites/site_name". Backup file is "C:/TEMP/MySharePointBackup.bak".

<AMSHAREPOINT ACTIVITY="backup_site" 
SITEURL="http://server_name/sites/site_name" 
BACKUPFILE="C:/TEMP/MySharePointBackup.bak" />