This article is intended for individuals who administer CAB for Google G Suite. 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 G Suite covers the following:

  • Data backup (including emails, chats, calendars, contacts, tasks, and documents)

    Backup can be activated for all or selected user accounts.

  • 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 G Suite, the following are required:


Setting up the admin account

In order to properly activate the backup task and automatically discover all user accounts, G Suite admin account must have API access enabled. For this:

  1. Sign in to your Google Admin console.

  2. Go to Security > API reference.

    info To see Security on the Home page, you might have to click More controls at the bottom.
  3. Verify that Enable API access is selected, and then click Save.


Backup task activation

Once you have set up your G Suite admin account, you can activate G Suite backup task as follows:

notification_important If you use 2-Step Verification for G Suite, you need to create an app password in your G Suite admin account, and use it to authenticate your CAB backups.
  1. In the CAB Management Portal, click BACKUPS in the sidebar menu.

  2. Click Activate a New Backup, and then click G Suite.

  3. Click Integrate with Google, and complete the authorization process.

  4. In the list of user accounts, activate backup for those preferred. (For details, see User account 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 G Suite or Edit ( ).

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

Backup preferences

Preference Description
Automatically detect and activate new Google domain Allows to automatically activate backup for all current user accounts and for new user accounts added in the future. If cleared, you will need to manually activate backup for new user accounts as they are added.
Friendly Name A nickname to identify the backup task. Default is the email address of the G Suite admin account used to activate the backup task.
Archive location AWS datacenter location you have selected when enabling CAB for the company.1
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 user account 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 G Suite.

Action icon Action name Action description
Edit Edit the backup task settings and manage user account 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

User account backup management

To manage backups at a user account level and view the relevant details, click BACKUPS in the sidebar menu, and then click G Suite or Edit ( ).

The following details are available for each user account backup:

Details Description
Google domain User account email 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 user account backup (see details below)

The following special actions are available for each user account backup:

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 G Suite.

  2. Find the required user account 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. Select one of the available categories (Email, Documents, Contacts, Tasks, or Calendars) to search in.

      2. Enter the search query, and then click Continue.

        info For Email, Documents, and Calendars, click More ( ) below to show the advanced search options.
      3. In the list of items, select the item(s) to restore or export.

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

    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. Also, you can choose the export format for the archived files, that is Standard in .EML (emails in .eml, contacts in .vcf, tasks in .ics, and calendars in .ical) or Outlook compatible .PST.

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. If you want to change the datacenter location, please contact Infrascale Support