This article is intended for individuals who administer CAB for Microsoft SharePoint Online. It is structured in such a way that you find the information you need to set up and manage the respective environment.


Scope and prerequisites

CAB for SharePoint Online covers the following:

  • Data backup (including sites, documents, and libraries)

    Backup can be activated for all or selected sites.

  • Backup data restore

    notification_important CAB restore process is non-destructive, that is, the restored data does not overwrite the existing one.
  • Backup data export

To administer CAB for SharePoint Online in your Office 365 environment, the following are required:


Backup task activation

To activate SharePoint Online backup task, follow these steps:

  1. In the CAB Management Portal, click BACKUPS in the sidebar menu.

  2. Click Activate a New Backup, and then click SharePoint Online.

  3. Complete the authorization process.

    The backup task is activated using OAuth or regular authorization method.

    • To use OAuth, switch the form, enter SharePoint URL1, click Start, and then sign in to your Office 365 admin account.

    • To use regular authorization method, switch the form, enter your Office 365 admin account credentials, enter SharePoint URL1, and then click Start.

    notification_important CAB automatically assigns admin permissions to SharePoint sites when using Office 365 admin account.
  4. In the list of sites, activate backup for those preferred. (For details, see Site backup management.)

  5. Set the backup preferences and data indexing (see Backup task settings).

    info You can change the backup preferences later.
  6. Click Save Changes.


Backup task settings

  1. In the CAB Management Portal, click BACKUPS in the sidebar menu.

  2. Click SharePoint Online or Edit ( ).

  3. Change the backup settings as needed (see below), and then click Save Changes.

Authorization details

Backup task relies either on OAuth or on the regular authorization method.

You can change the account, for which the backup task was activated, as follows:

  • To use OAuth, switch the form, enter SharePoint URL1, click Apply, and then sign in to a different Office 365 admin account.

  • To use regular authorization method, switch the form, enter credentials for a different Office 365 admin account and SharePoint URL1, and then click Apply.

Backup preferences

Preference Description
Automatically detect and activate new Site Allows to automatically activate backup for all current sites and new sites added in the future. If cleared, you will need to manually activate backup for new sites as they are added.
Friendly Name A nickname to identify the backup task. Default is SharePoint URL.
Archive location AWS datacenter location you have selected when enabling CAB for the company.2
Backup hour UTC time when the backup task is initiated.
Backup frequency Frequency of the backup task initiation. Available options: Daily, Every 3 days, Weekly.
Delete auto-archive after The system automatically archives the backups if a site is deleted. Enter the number of days to retain the automatic archive, or leave blank to retain it indefinitely. This will not affect manually paused backups.

Archived data indexing

Archived data indexing allows to provide the granular search and restore of the backup data. The system scans the data and builds the relevant search index. For this, you have to allow the system to unencrypt the data, since it is encrypted by default.

Select Index all archived data to allow indexing of the backup data for use in the granular search and restore functions. Once the search index is built, both the data and the index will be encrypted again.

Clear Index all archived data if you do not want to allow indexing. This will disable the granular search and restore functions, but you will still be able to browse backups by date.


Domain backup management

You can manage the backup task at a domain (general) level. For this, in the CAB Management Portal, click BACKUPS in the sidebar menu, and use special actions opposite to SharePoint Online.

Action icon Action name Action description
Edit Edit the backup task settings and manage site backups
Backup Now Immediately start the backup task
/ Activate / Pause Activate / pause the backup task. (Backup starts on schedule. See Backup hour and Backup frequency in Backup preferences.)
Cancel Cancel the backup task
Delete Remove the backup task and delete all backup data

Site backup management

To manage backups at a site level and view the relevant details, click BACKUPS in the sidebar menu, and then click SharePoint Online or Edit ( ).

The following details are available for each backup site:

Details Description
Site SharePoint site URL address
Status Backup status. Possible values: All, Active, In Process, Not active, Scheduled, Paused, Backed-up in another task)
Last backup Number of days from the last completed backup
Size Size of the backup data
Action Set of special actions you can take in respect to a backup site (see details below)

The following special actions are available for each backup site:

Action icon Action name Action description
/ Activate / Pause Activate / pause backup. (Backup starts on schedule. See Backup hour and Backup frequency in Backup preferences.)
Backup Now Start backup immediately
Delete Remove backup and delete all backup data

Backup data restore and export

To restore or export the backup data, follow these steps:

  1. In the CAB Management Portal, click RECOVERY in the sidebar menu, and then click SharePoint Online.

  2. Find the backup site to restore or export the data for, and then click Next ( ) in the Action column.

  3. Select the preferred choice for restore:

    • Via Snapshot

      1. Set the date range to show all snapshots within this range, and then click Continue.

      2. In the list of snapshots, select the snapshot to restore or export the data from.

        info To browse a snapshot, click Explore ( ) in the Action column, and then click the desired item name.
    • Via Item Search

      1. Enter the search query (click More ( ) below to show the advanced search options), and then click Continue.

      2. In the list of files, select the file(s) to restore or export.

  4. Click Restore to recover the selected files (you can restore the files to a different site), or click Download and specify the desired options to export the selected files.

    info When exporting, the data is archived in a .zip file, which can be downloaded locally or exported to Amazon S3, Azure Blob, Box, or Dropbox.

Once you have initiated the restore or the download process, you can view its current status in the Restore & download status section.

You can manage the process using the following special actions in the Action column:

Action icon Action name Action description
Info View details of the process
Download Download the exported data
Cancel Cancel the process
  1. Sign in to your Office 365 admin account, go to SharePoint, and copy the URL address from your browser address bar (for example, company.sharepoint.com).  2 3 4

  2. If you want to change the datacenter location, please contact Infrascale Support