Skip to main content

Get started with Archive: from setup to restore

This article gives you the order of play for CloudM Archive, from your first storage bucket to restoring a leaver's data. Each stage is short and points you to the article that has the detailed steps, so work through them in order.

Before you start - The Prerequisites

Archive uses your own Google Cloud Storage, so a few things need to be in place first. Work through the Archive prerequisites, which cover your Google Cloud project, billing account, service account and the CloudM Automate subscription.

Stage 1: Create your storage bucket

Create a Google Cloud Storage bucket to hold your archived data. You can create more than one bucket if you want to keep some users' data separate. You choose which bucket each Archive step uses later on.

The guide below covers a PowerShell script that creates the bucket and service account for you, as well as the manual method. Keep hold of the bucket name and the service account JSON key, because you need both in the next stage.

Set up your Archive storage bucket in Google Cloud Storage

Stage 2A: Connect your bucket and set retention

In CloudM Automate, go to Archive > Storage Configuration. Add your bucket, test the connection and save it. On the same page, set how many days Mail, Drive and Chat are kept before they are permanently deleted, or choose indefinite retention.

Retention permanently deletes archived data once it reaches the number of days you set. Check your values with whoever owns your data compliance policy before you save them.

Stage 2B (optional): Configure Archive Vault

If your organisation uses Google Vault, you can also archive the Mail and Drive items that have been deleted but are still retained in Vault. This uses its own service account, so skip it if you do not use Vault or do not need that data. Google limits how many Vault exports can run at once, so you can add more than one service account to avoid rate limiting. See Archive Vault FAQ: Google Vault Export Limits.

Configure Archive Vault

Stage 3: Add the Archive steps to your offboarding workflow

Archive runs as part of the offboarding workflow, so add the Archive step (and the Archive Vault step if you set it up in stage 2B) to each offboarding workflow that should archive users. For each step you choose the bucket and the data types to archive. The Archive step stays greyed out until a bucket is connected, so do stage 2A first.

Add the Archive Steps to your Offboarding Workflow

Stage 4: Offboard users

Archiving starts when a user is offboarded with a workflow that contains the Archive step. You can offboard users manually from the CloudM Directory, or set things up so it happens automatically, for example when a user is suspended or moved to a specific organisational unit. You can also offboard in bulk.

Stage 5: Restore data when you need it

Go to Archive > Restoration, choose a user, and then restore either specific emails, files and chats, or the user's whole archive. Archive is designed for leavers, whose accounts have been offboarded, so you restore the data to another active user. You choose the destination user for each type of data.

How to Restore Archived Data

Stage 6: Track progress and troubleshoot

Use the status pages to see what is happening and why something failed.

  • Archive > Archive Status shows every archive job, including items that failed to archive. See Archive Status.
  • Archive > Restoration Status shows every restoration and its progress. See Restoration Status.

On both pages, click a row to open the side panel, use View Errors to see which items failed and click Retry to try them again. If the problem started during offboarding, check the Offboarding Status page and see Offboarding Steps - Troubleshooting. For failed archive steps and restorations, see How to manage a failed Archive step and Troubleshooting a Failed Restoration.


Related Articles

Was this article helpful?
1 out of 1 found this helpful