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

  • Data backup (organization data, Chatter feeds, and metadata)

  • Backup data restore

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

To administer CAB for Salesforce, the following are required:

Setting up the admin account

Before proceeding any further, you have to check if Salesforce API is enabled for CAB to properly access your Salesforce admin account. Follow these steps:

  1. Sign in to your Salesforce admin account.

  2. Click Setup at the top of the page.

  3. Go to Administration Setup > Manage Users, and then click Profiles.

  4. Click Edit for the appropriate profile.

  5. In the Administrative Permissions section, check if API Enabled, View All Data, and Modify All Data are selected.

Backup task activation

Once you have verified the Salesforce API is enabled, you can activate Salesforce backup task as follows:

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

  2. Click Add Backup Task, and then click Salesforce.

  3. Select the preferred backup type (see Backup types).

  4. Click Authenticate in Salesforce and complete the authorization process.

  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 Salesforce or Edit ().

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

Admin details and backup types

You can change the Salesforce admin account used to activate the backup task. For this, select the backup type, click Go to Salesforce, and then sign in to a different Salesforce admin account.

Backup type Description
Production Allows to back up Salesforce Production environment
Sandbox Allows to back up Salesforce Sandbox environment

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 your 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 Salesforce 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
Account Name Name of the Salesforce admin account used to activate the backup task. Default is the email address of the Salesforce admin account
Throughput Daily Salesforce API limit. By default, CAB uses up to 0.75 (75%) on a scale from 0 to 1.0 (100%)

Backup task management

To manage the backup task, in the CAB Management Portal, click BACKUPS in the sidebar menu, and use special actions opposite to Salesforce.

Action icon Action name Action description
Edit Edit backup task settings
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 Salesforce.

  2. 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.

    • Via Item Search

      infoThis restore option is not available for now.
  3. 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.

    infoWhen 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 include metadata to the download.

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