Configure Archive Policy for Salesforce Data

Configure archive policies to define which Salesforce records should be archived based on specific criteria. You can configure policies to run on a schedule, set record limits, and include related objects and attachments.

Commvault software does not support archiving certain objects due to Salesforce API restrictions. For a list of Salesforce objects that cannot be archived, see Salesforce Objects Not Included in Backups and Archive.

Step 1: Add a Salesforce App

Add an app so that you can perform archive operations on your Salesforce data.

  1. From the Command Center navigation pane, go to Protect > Salesforce.

  2. Go to the Organizations tab.

  3. Click Add organization.

  4. Select Archive, and then click Next.

  5. For Region, select the region where you want to archive the Salesforce data, and then click Next.

  6. For Connected app, choose how to authenticate with Salesforce:

    • Commvault Connected App (Recommended): Use the Commvault Cloud-hosted connected app pre-configured to authorize your Salesforce account.

    • Bring your own Connected App: Use your own Salesforce connected app credentials.

  7. Enter a name for the Salesforce organization.

  8. From the Environment list, select Production or Sandbox.

  9. If you selected Bring your own Connected App:

    1. From the Connected app credentials list, select existing credentials or click Create new.

    2. If creating new credentials, add the Consumer key and Consumer secret, and then click Save.

  10. Click Sign in with Salesforce, and then sign in to your Salesforce account.

  11. Click Close, and then click Create.

  1. From the Command Center navigation pane, go to Protect > Salesforce.

  2. Go to the Organizations tab.

  3. Click Add organization.

  4. Select Archive, and then click Next.

  5. Specify the access node and database information:

    1. From the Access nodes list, select an access node.

    2. For Download cache path, enter a path on the access node where data downloaded from Salesforce can be temporarily stored.

    3. From the Database type list, select the database type (PostgreSQL or Microsoft SQL Server).

    4. For Database host, enter the client that hosts the database.

    5. For Database name, enter the database name.

    6. For Database port, enter the port that you use to connect to the database.

    7. For Sync DB credentials, select existing credentials or create new ones.

    8. Click Test Connection to verify the database connection.

  6. Click Next.

  7. Enter a name for the Salesforce organization.

  8. From the Environment list, select Production or Sandbox.

  9. From the Connected app credentials list, select existing credentials or click Create new.

    If creating new credentials, add the Consumer key and Consumer secret, and then click Save.

  10. Click Sign in with Salesforce, and then sign in to your Salesforce account.

  11. Click Close, and then click Create.

Step 2: Configure Archive Policy

  1. From the Command Center navigation pane, go to Protect > Salesforce.

  2. Go to the Organizations tab, and click the archive app instance.

  3. Click Policies, and then click Create new policy.

  4. Enter a name for the policy.

  5. Select an existing archive frequency rule (archive plan) or click the add button to create new credentials.

    Need help with creating a frequency rule?
    1. Next to Archive frequency rule, click +.

    2. Enter a name for the rule.

    3. For Archive, click edit button outline grey/gray pencil, specify the criteria, and then click Save.

    4. For Archive window, click edit button outline grey/gray pencil, select a time slot to trigger the archive operation, and then click Save.

    5. Click Save.

  6. Select Salesforce objects and records that you want to archive.

    1. Under Objects under this policy, click Add.

    2. For Root object, select the Salesforce object.

    3. Next to SOQL query, click edit button outline grey/gray pencil.

      You can configure rules and specify the criteria to filter records that you want to archive.

      1. Click Add rule group.

      2. Select the all or any condition for rule group, and then click Add rule.

      3. Select the Field, Condition, and then specify the Value.

      4. For Record limit, specify the maximum number of records of the root object to archive per job, and then click Save.

        For example, if you set a limit of 10 records for Account object, only 10 records of Account object will be archived per job. However, those 10 records may be associated with many child records—such as 20 from Contact, 5 from Opportunity, and 30 from Case—and all of those will be archived if they are related.

      You can specify the Salesforce Object Query Language (SOQL) query to filter records that you want to archive.

      1. Select the SOQL query option.

      2. Specify the query, and then click Save.

    4. To include lookup-relationships when archiving a root object, select the Archive related objects(Lookup relations) check box, and then click Add Child Object.

    5. Select the Child object and fields using which the root object is associated to the child object, and then click Save.

  7. To archive files or documents associated with filtered records, enable the Archive related documents toggle key.

  8. To disable validation rules, workflows and triggers to mitigate errors and improve delete operation, enable the ** Disable triggers and rules** toggle key.

    After the delete operation completes, the validation rules, workflows and triggers are automatically enabled.

  9. To exclude archiving child records that were accessed or modified recently, specify the number of days in the Dependent object's record protection days field.

    The Commvault software checks the Last View Date and Last Modified Date values in Salesforce to exclude such records.

  10. Click Save.

×

Loading...