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

Importing an Archive

Required User Credentials

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

Overview

Backup & Archive lets you import archived data from other backup applications into AWS S3 buckets. This guide outlines the import procedures and the required directory and file structures.

Archives can only be imported from an AWS S3 Bucket.

Start an Import

1

Create an Import

  1. Click Backup & Archive from the left sidebar menu.

  2. Click the Organization Switcher from the breadcrumb path.

  3. Select the organization you wish to import to.

  4. Click Import Archive.

2

Connect S3 Bucket

The import process can only import an archive from an AWS S3 bucket.

  1. Enter a Name for the import job.

  2. Enter the Bucket settings values. See the table below for an explanation of each.

Field
AWS Field

Bucket Name

Amazon S3 > Buckets > Name

Region

Amazon S3 > Buckets > AWS Region (Only include the Region and not the Region Name. For example, if your storage is in US East (N. Virginia) us-east-1, only enter us-east-1.)

Access Key Id

The Access Key ID generated when the bucket was created.

Secret Access Key

The Secret Access Key generated when the bucket was created.

  1. Click Validate to check the connection to your S3 bucket.

  2. If a connection to your bucket succeeds, you will receive a Bucket credentials are valid message, and the Next button will be enabled.

  3. Click Next.

3

Enter Prefix

The Prefix setting is used to handle archives structured differently. You can import directories with nested structures like the following example:

s3://my_bucket/
├── 00DWU000001IVG52AO/
│   └── nested/
│       └── path/
│           └── in/
│               └── bucket/
│                   └── export-directory_2024-7-29_17_5/
│                       ├── archive_export_1.zip
│                       ... other files
│
├── {other_org_id}/
... other directories

There is no such thing as a directory in the AWS S3 bucket. We use the / character as a delimiter.

  1. Enter the folder path to your import files in the Prefix textbox.

4

Select Data and Import

Backup & Archive lists directories starting with the directory named after your Salesforce organization ID. See the following structure example:

00DWU000001IVG52AO/
├── archive_directory/
│   ├── archive_export.zip
├── archive_directory_1/
│   ├── archive_export.zip
│   └── archive_export_1.zip
... other directories

With the example structure above, the following directories will be listed for you to import.

  • archive_directory/

  • archive_directory_1/

For more information on the import directory structure, see the Directory Structure section below.

When you select multiple directories, each is processed as a separate job and executed sequentially. For instance, if you select two archive directories, the first one is imported first, followed by the second.

  1. Click Select for each archive directory to import.

  2. Click Import to start the import process.

  3. After starting the import job, you can view the results on the Backup & Archive > History tab.

Directory Structure

To successfully import archived data into Flosum Backup & Archive, you must have a specific directory structure for your import data. The following example demonstrates the required structure.

In this example, you have an S3 bucket named my_bucket and a Salesforce organization with ID 00DWU000001IVG52AO. To import archived data from this organization into the Backup & Archive application, the required directory structure is shown below.

s3://my_bucket/
└── 00DWU000001IVG52AO/
    ├── export-directory_2024-7-29_17_5/
    │   └── archive_export_1.zip
    └── export-directory_2024-8-30_18_10/
        ├── archive_export_1.zip
        ├── archive_export_2.zip
        └── archived_files/
              ├── Attachment/
              │   ├── 00P5x00001Koqb6EAB/
              │   │   └── attachment_body.pdf
              │   └── 00P5x00001Koqb6EAB/
              │       └── attachment_body.csv
              └── ContentVersion/
                  ├── 0685x00000AsY5aAAF/
                  │   └── content_version_body.pdf
                  └── 0685x00000AsY5bAAF/
                      └── content_version_body.csv

With the directory structure above, the Import Archive > Select Data UI screen will list two directories available to import:

  • export-directory_2024-7-29_17_5/

  • export-directory_2024-8-30_18_10/

Zip Files

Each directory should include a zip file prefixed with archive_export. Files with other prefixes will be ignored. Each zip file should contain directories and .csv files. See the following example of an acceptable zip file structure.

Processing Imports

When an import job is processed, all .zip files in the selected directories are extracted, and the .csv files are processed.

For this example, s3://my_bucket/ and archive_export_1.zip from the examples above are used to explain how an import is processed. Processing archive_export_1.zip creates records in the Backup & Archive application for the objects Task and Case. If a .zip file includes a binary object, its body is located under the archived_files/ directory, using the Record ID to locate the body.

When processing archive_export_1.zip from the export-directory_2024-8-30_18_10/ directory, to find the file Attachment/Attachment_1.csv and a record with ID 0685x00000AsY5bAAF, you should locate it in the S3 bucket using the pattern:

For example:

If nothing exists at this path, the record will not be imported. Note that the tmp/ directory under s3://{bucket_name}/{ord_id}/{export_directory_name}/archived_files/{object_api_name}/{record_id}/ is ignored.

PreviousImports
NextViewing a Backup or Archive Job Details

Last updated

Was this helpful?