This article is intended for individuals who administer CAB for Google G Suite. It is structured in such a way that you easily 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 (emails, chats, calendars, contacts, tasks, and documents)

    Backup can be activated for all or selected user accounts.

  • Backup data restore

    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 admin account

In order to properly activate the backup task and automatically discover all user accounts, your G Suite admin account must have API access enabled. Also, you have to turn POP and IMAP access on for all user accounts in your organization.

Backup task activation

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

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 Add Backup Task, 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 (see User account backup management).

  5. Set the backup preferences and data indexing (see Backup task settings). You can change these later.

  6. Click Save to apply changes and activate the backup task.

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.

Admin details

Here, you can change the admin account used to activate the backup task. For this, click Integrate with Google, and then sign in to a different G Suite admin account.

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 .

Select Automatically start a backup when a new mailbox is added to automatically start backup for new users accounts.

The system automatically archives the backups if the license is removed or a user account is deleted. Select Retain auto-archived backups and enter the number of days to retain the automatic archive, or leave blank to retain it indefinitely. This does not affect manually paused backups.

The following details are available for each user account backup:

Details Description
Account User account email address
Status Backup status (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 the user account backup (see details below)

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

Action icon Action name Action description
Resume Resume backup
Pause Pause backup
Backup Now Start backup immediately
Delete Remove backup and delete all backup data

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.

Backup preferences

Preference Description
Friendly Name A nickname to identify the backup task. Default is the email address of the G Suite admin account
Archive location AWS datacenter location you have selected when enabling CAB for the company1
Backup frequency Frequency of the backup task initiation. Available options: Daily, Every 3 days, Weekly
Backup hour UTC time when the backup task is initiated
Retention period Number of days, months, or years to keep backups for until they are deleted from the cloud2

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 backup task settings and manage user account backups
Backup Now Start backup task immediately
Resume Resume backup task
Pause Pause backup task
Cancel Cancel backup task
Delete Remove backup task 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 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.

        Tip

        You can also restore or export specific items from snapshots. To browse a snapshot, click Explore in the Action column, and then click Restore or Download.
    • 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.

        Tip

        For Email, Documents, and Calendars, click More 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.

    Note

    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
Download Download exported data
Info View process details
Cancel Cancel process
  1. If you want to change the datacenter location, please contact Infrascale Support. 

  2. By default, we provide unlimited retention for your backups for as long as you maintain your subscription. If you want to change this, please contact Infrascale Support.