Ctrlk
Customer Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Creating a Templated Backup

Required User Credentials

[Flosum User] - Backup & Archive license with Backup & Archive permissions

Overview

This article provides step-by-step instructions for creating a Templated Composite Backup in Flosum Backup & Archive. Templated Backups provide precise control over which Salesforce objects and records are backed up by applying object-level filters. The initial run creates a complete backup of your selected Salesforce data. After that, subsequent jobs will only back up changed data.

With a Templated Backup, you gain granular control over your backup job through a reusable template that specifies:

  • The Salesforce objects to include

  • Optional filters (Declarative or SOQL) to refine the data set

  • Whether to run immediately or on a defined schedule

Creating a Templated Backup

1

Create a Backup

  1. Click Backup & Archive from the sidebar menu.

  2. Click the Organization Switcher from the breadcrumb path.

  3. Select the organization you wish to back up.

  4. Click Templated Backup.

2

Create a Template

If there are no templates or you need to create a new one, follow the instructions below. Skip to Select a Template if you don’t need to create a template.

  1. Click Create Template if there are no templates or if you need to create a new one.

  2. Enter a Name for the template.

  3. (Optional) Enter a helpful Description of the template’s purpose in the optional Backup Template textbox.

3

Add Objects to Template

  1. Click the Add object menu button to select the Salesforce Objects to include in the template.

  2. Search or browse for objects from the menu.

When searching for an object, enter the Salesforce Object Label, not the Salesforce API Name. For example, enter Content Version, not ContentVersion.

  1. Check the objects you want to add.

  2. Click Add to add all of the selected objects.

  3. Once an object is added, you can add one or more child objects.

To the right of the object’s name is a count of Add/Available child objects. In this example, the Account object has 123 child objects, and 0 of them have been added.

  1. Click an object to open the Add child objects dialog.

  2. Click the + Add button next to each of the child objects to add.

  3. Once you have added all the objects, click Apply to save the changes.

4

(Optional) Add Filters to Objects

  1. Click Filter to add a filter to the object.

  2. You can filter using Declarative criteria, similar to Salesforce reporting, or via an SOQL query. An example of the same filter created each way is shown in the screenshots below.

  3. (Optional) Click the Count records button to verify that the filter is retrieving the correct number of records.

  4. Click Apply to save the filter.

5

Save the Template

  1. Click Save once you have configured all of the objects for this template.

6

Select a Template

  1. Enter a name for the backup job.

  2. Click the Select button of the template to use. Note: only one template can be selected.

  3. Click Next.

7

Configure the Backup Job

  1. (Optional) Check the Metadata checkbox in the Job Settings section to include metadata in the backup.

  2. (Optional) Enter a description of the backup in the textbox.

8

Run or Schedule the Backup Job

Immediate Backup

  1. Click the Run button to start the Templated Backup job.

Scheduled Backup

A backup job can be scheduled to run at a specific date and time interval.

See the following article for more details about job scheduling options.

  1. Switch the Schedule toggle to Enabled.

  2. Select the Recurrence of the backup to run Daily, Weekly, or Monthly.

  3. Configure the Schedule options. Daily, Weekly, and Monthly each offer different options for setting the time and date the backup runs.

  4. Click the Schedule button to schedule your backup job.

9

Review Backup Job

Immediate Backup

  1. After starting the backup job, you will be taken to the Backup & Archive > History tab.

  2. The table shows the status of the Templated Backup job.

Scheduled Backup

  1. After scheduling the backup job, you will be taken to the Backup & Archive > Schedule tab.

  2. The scheduled Templated Backup job is located in the User Scheduled section.

PreviousCreating a User-Defined Composite Backup
NextArchives

Last updated

Was this helpful?