Skip to main content

Creating your first data backup job

Backup your metadata and data records with Gearset

Mateusz Kochanowicz avatar
Written by Mateusz Kochanowicz
Updated this week

Access requirements:
Creating backup jobs is a feature reserved for Gearset team owners.

If you are not a team owner, you will need to ask an existing team owner to change your status from "Member" to "Owner", therefore allowing you to become a team owner to create a job.

Which orgs can I back up?
​You can only back up orgs that you own the connections for and not those that have been delegated to you.

If you're a team owner on your Gearset team, navigate to Data management -> Data backup jobs page in Gearset.

You'll see an option to CREATE A BACKUP JOB.


Consider using team-shared org connections for Backup jobs

It is possible to use a team-shared Salesforce org connection for your Backup jobs.

You'll find more information in our documentation on team-shared shared Salesforce org connections.

How is this useful?

Consider a scenario where your Gearset team aims to connect the backed up org from a Salesforce "service user" account - usually a type of account that is managed and accessed by multiple members at your organisation.

This way, a backup job created in Gearset can be set up from a generic account that isn't necessarily tied to a single Salesforce user (e.g. a Salesforce user that is assigned to a specific person at your organisation).

What potential issues does it solve?

This can help with avoiding issues such as having to recover access to a Backup job originally set up by a user who may have left the organisation, and prior to leaving didn't transfer the ownership of their backup job to another member on their Gearset team (because a Backup job was created for an org authorised in Gearset via that employee's Salesforce username).

Note: If a Backup job is created from a user-owned Salesforce org connection, then backup job creator is the sole owner of such Backup job.

However, if a Backup job is created for a team-shared org connection added to Gearset, then every Team Owner on a Gearset team becomes the owner of that job.

Add a new data backup job

If this isn't your very first backup job, you can add a new org to back up via the Create job button.

1. Select the job type

There are three options to choose from:

  • Standard job - daily backup of your org.

  • High frequency job - hourly backup of your org.

2. Define job details

In the next step you go through:

  • Job details - to select the org you want to create a backup job for.

  • Job name - is to enter a custom name for your backup.

  • Time - to select the time when you want your backup job to run.

    Once done, click on Next, select data to include.

3. Are "Modify All Data" and "Query All Files" profile permissions enabled?

When you select the org you want to create a backup for, Gearset will detect and notify you when all the required permissions are assigned to the org.

If we've notified you that "you have all the recommended permissions assigned to this organization", you're good to move to the next step.

However, if your org is missing Query All Files and/or Modify All Data permission(s), we'll let you know about it by displaying relevant notifications.

  • When only Query All Files permissions are not enabled:

  • When Query All Files and Modify All Data permissions are not enabled:


Can I still backup the org with these permissions missing?

Yes, you can still back up your Salesforce org without these permissions.

However, be aware that without having those permissions assigned to your profile, there may be objects in your organization that you are not able to include in a backup and/or restore.


You can also choose to enable automated backup for any new objects and managed packages.

4. Select data to be backed up

Note: Once you're on "Include data" page during backup job creation, it isn't possible to go back to the previous page to re-configure job details.

It is because at this point the Backup job has already been created and it isn't possible to edit the selected Salesforce org. You can only go "Back to data backup jobs" page, and start creating a new backup job from scratch.

  • Include data - By default, every new backup job is configured to use Gearset's recommended filter.
    Check our documentation to find out what objects are being backed up in this filter: Gearset backup & restore - job filters

  • Manually configure - if you'd like to manually configure the filter for your backup job, select this option instead.

5. Options available under "Manually configure"

  • By default, you'll see these two toggles being enabled:
    - "New recommended objects"
    - "Include managed packages"

  • The dropdown allows you to filter through:
    - "Recommended objects"
    - "Not Recommended objects"
    - "Selected Objects" (the ones you've selected for your backup job)
    - "Not Selected Objects" (the ones not selected for your backup job)

  • Use recommended filter instead - allows you to revert back to Gearset's default filter.

  • Can't find the object you're looking for? - this option allows you to preview objects that are not supported by the Bulk API (e.g. since Summer '18), or currently unsupported by Gearset.

    • When Gearset knows the exact reason why a specific object isn't supported, we will display it in the Reason column.
      An example is can be ActivityMetric object, which is "not supported by the Bulk API", as per the info we provide.

    • These unsupported objects won't appear in the list of objects you can include in your backup job.

Once done, click on Next, job permissions.

6. Job permissions

  • On this page Gearset recommends to assign your Backup job to at least one other member on your Gearset team.

  • By default, every user will get minimum View permission for your Backup job.
    As for other permissions, you're in full control which ones to assign.
    Check our documentation on what access each permission gives.

Once you're happy with your choices, click on Next, notifications.

7. Notifications

  • Send notifications - allows you to send email notifications for either:
    - Every backup run
    - Or only for the backup runs that fail

  • Email results to - this option lets you select an existing member from your Gearset team who is to receive an email notifications about the backup run.

  • Text results to - you can send SMS notifications to numbers staring with country codes: +1 (USA), +44 (UK) and +61 (Australia).

  • The remaining options allow you to set up Slack and Microsoft notifications via webhooks, as well as to enable Chatter notifications.

Once you've set up your notifications, click on Create - this will create your backup job in Gearset!

You can preview all your Backup jobs on our Data backup jobs page.

Running your first backup job

Once the backup job is set up, it will show "Pending first run" status.

By default, when the job hits the scheduled run time, it will begin the first backup snapshot.



Can I skip the scheduled time for backup?

Yes, you can. If you don't want to wait for your first back up job to run at the time you originally selected, you can click on Back up now. Gearset will then initiate the backup process.

Setting up the backup baseline

Gearset will need to establish a baseline for all the data in your org. This is a one time only operation that involves downloading and storing every record for each object included by your backup job's filter.

Once this baseline has been established, Gearset can then make intelligent decisions, which means that subsequent runs of your job should be much quicker.

Backup job statuses

When the job is running, you'll see the status change to blue. The time that the run takes will vary depending on your org record size. When the run is completed, it will change to green.

You can view the history and statistics of the job by clicking Job history > View details. Jobs can also be run on demand by clicking Back up now.

If there are any issues running the job, you'll see more information about what went wrong.

Metadata filtering tab

Important to note:

"Metadata filtering" tab by default is disabled for your Backup job. It is a feature that can be optionally enabled on Data management page - although Gearset does not recommend enabling it, unless you have a valid reason to do so.

To find out more about this feature, please read our documentation:
"Manual metadata filtering" - optional setting on your Backup job

Metadata filtering allows you to choose which objects in your org you want to backup or exclude from the job.

To manage it, make sure to click on Edit first, as otherwise you won't be able to amend any settings in this tab.

  • Recommended objects - if you're looking for a starting point, you can use this Gearset filter. We will suggest the objects to include, avoiding loads of unnecessary objects and therefore improving your backup job's performance.

  • Unselected objects - this option shows all objects that have not been selected to be backed up in your job.

  • All objects - allows you to preview all objects that can be selected for backup.

Once you've added new objects to an existing backup job, make sure to click on Save. Otherwise, the objects won't be added to your job's metadata filter.

Important to note:
To help your backup job run quickly and use fewer API calls, Gearset recommends backing up only the objects containing business-critical data.

By default, each backup run will contain your organisation's metadata, plus the data for:
- Salesforce standard objects
- Your custom objects
Managed packages (including configuration for CPQ, Vlocity, Conga etc.)

Job permissions

On your Data backup jobs page, click on Edit job... > Edit settings, and navigate to Job permissions tab.

By default, for all new Backup jobs there won't be any permissions configured for your team members.

For more information on configuring access to members across your Gearset team, refer to our documentation on how to set backup job permissions.

Setting up smart alerts

Once you've added a Backup job, you can click on Edit job... > Edit settings...

The Smart alerts tab allows you to trigger notifications based on more advanced rules.

For example, if you want to get alerted when:

  • more than 5% of your contacts in Account object change, and/or

  • when 100 records in Account are deleted

You can set up respective alerts and add them in this section.

Can I edit existing smart alerts?

Currently, it isn't possible to edit already created/added alerts. You'd need to create a new alert and delete the one you want to amend.

Is there a limit of smart alerts per backup job?
Yes, the limit is 20 alerts per job.

Advanced settings - daily API call usage and retention policy

  • Advanced settings - this tab allows you to configure two important settings:

    • Daily API call usage limit (%) - it's an API limit after which Gearset will stop trying to back up your data records to allow non-backup jobs to use your API call.

      When you hover over the sign , you'll see this helpful notification:


      "Salesforce allocates a daily API limit for each org across all platforms. When the limit is reached, it will prevent any communication with your org through Salesforce API until the limit is reset. If you set the limit to 80%, it will guarantee there will always be at least 20% of your daily API consumption free to use for non-backup jobs."

    • Retention rule - this policy defines the length of time you want Gearset to keep the backup records. By default, this is set to 7 years.

Note: There is no specific API usage limit assigned by Gearset to a backup job. However, your daily API limit depends on the Salesforce Edition you are on. Salesforce allocates a daily API limit for each org across all platforms.

Salesforce documentation will provide you with more information on ​API Request Limits and Allocations.

Types of data backup jobs

Once you have successfully created your first backup job - which by default is a Standard job (full backup) - you'll now see an option to choose between:

  • Standard job (daily backup)
    This job runs every day. It takes a backup of the records in your org once a day.

  • High frequency job (hourly backup)
    This job runs every hour. It is limited to 10 objects.

To create a high frequency job, you can follow the same steps as for the standard job. You won't have to set a time for the backup to run, and the limit of 10 objects for the filter.

License requirements:
You must have Backup Teams license in order to be able to create a High frequency job, as per our Pricing page (restricted to 2 high frequency jobs).

Backup Starter license allows only access for our Standard jobs (daily backup).

Number of backup jobs (license requirements)

By default, each Gearset team can have up to 2 standard backup jobs. If you need more, please chat to us about your use case.

If you have a Backup Teams license, in addition to 2 standard jobs you can also create up to 2 high frequency jobs.

Data backup dashboard

On Data backup jobs dashboard you have an overview of the data backup jobs that you have set up.

Only your Gearset account has the visibility of the jobs you set up. Each job represents a single org that is being backed up.

Job history

The Job history tab page will tell you the details of each run, along with a visual representation of the changes to your records over time.

Selecting Use snapshot will give you the below options both for data and metadata.

Options for data:

  • Restore (data) - allows you to restore deleted records to your org. For more information about this feature, see this article.

  • Download (data) - allows you to download snapshot of backed up data in a zip file. For more information check this article.

  • Replicate (data) - allows you to replicate (deploy) this run's data to a different org.

Options for metadata:

  • Restore (metadata) - allows you to restore this run's metadata back to your org.

  • Download (metadata) - allows you to download metadata snapshot in a zip file (this doesn't not include data).

  • Replicate (metadata) - allows you to replicate (deploy) this run's metadata to a different org or Git repository.

Data differences column

View changes lets you drill down into the changes across each object for this backup run.

There, you will have two options:

  • View records - allows you to see a list of all the records changed for an individual objects, with the option to perform a quick record restore or configure a restore if you wish.

  • Restore - allows you to restore deleted records. For more information about this feature check this article.

Metadata differences column

Depending on metadata differences, you may see your backup run being either:

  • Identical - meaning there are no metadata differences, but there may be some data differences in the backup run.

  • Different - meaning there are metadata differences detenced. Data differences may be present as well, which you can confirm by looking at "Data differences" column.

  • Unavailable - it's possible Gearset may not be able to report on whether metadata differences were detected in a backup run. In which case please speak to our support to find to obtain more information.

Metadata history

In this tab you, will find all the runs for the metadata backup.

The options available here are very similar to the ones in a Monitoring job:

  • Download org snapshot - allows you to download the contents of this metadata snapshot in a zip file.

  • Download comparison report - allows you to download metadata comparison in a CSV file.

  • Explore Permissions - preview on how profiles and permissions are applied across objects and fields. Additional options to export the report for the whole org, or for a given permission.

  • View code analysis issues - allows to preview static code analysis results for a given backup run. Additional option to export the analysis results into a CSV.
    Note: You can manage rule settings on the Code analysis settings page in Gearset.

  • View changes - this option allows you to:

    • View records - here you can view record history within Gearset (filtering by metadata objects is possible), or download records (new, changed, deleted or changed records can be downloaded). You can also restore selected records from previous backup.

    • Restore records - allows you to restore deleted records with dependent objects (or without dependencies), restore records with specific fields, or restore records across multiple objects.

      For useful documentation resources on how to restore from Backup check our Restoration collection.

Object analysis

Switching to the Object analysis tab will show the record changes by object for the chosen timeframe.

Timeframe can be selected on the top right corner - you have options for the last 7, 10 or 30 days, or you can select your custom range.

Selecting an object at the top (dropdown under Choose object:) will display how the records in that object have changed during each backup job run.

To view more details on a specific run, select the object you want to preview changes for and click the run time link at the bottom right of the page (as shown on below video).

Audit history

If you delete a record from a data backup job, Audit history tab is where you will find the details of these deletions.

Optionally you can also export all audit history records in a CSV file.

FAQs

Can I send email notifications to custom email addresses?

No, adding custom email addresses for your Backup job notification is not possible. Our updated Backup UI allows you to set up notifications only for existing Gearset team members.

If you have set up Backup job notifications for custom email addresses before 15 April 2025 (so prior to the new UI release), Gearset will continue sending these notifications. However, past that date once you remove a custom email from your Backup job notifications it won't be possible to re-add it.

What's the alternative?
The alternative is to use Slack or Teams notifications if you intend to notify other people than your Gearset team members about the Backup job runs.

What if I don't want to use Slack or Teams notifications?
You can set up a service user Gearset account under the email address for which you'd like to receive Backup notifications (e.g. this could be a common inbox available for all of your team members), and configure email notifications to be sent to that Gearset user.

Did this answer your question?