Skip to main content


 

 

druva_logo.pngDruva
|
Documentation

How can we help you?

Trending articles:

 

Druva Documentation

Configuring Environment Hub

  1. Last updated
  2. Save as PDF
Heads up!

We've transitioned to a new documentation portal to serve you better. Access the latest content by clicking here.

Overview

Managing all your Salesforce organizations gets easier with the Salesforce App. The Salesforce App installation is linked to a Salesforce Org but provides the ability to add multiple organizations from the same interface.

The Environment Hub page enables you to configure new Salesforce organizations and also manage existing Salesforce organizations with a centralized interface.

Salesforce_App_Environment_Hub.png

Connecting to a Salesforce Organization

The Salesforce organization you are connecting to must have the API feature enabled. This feature is enabled by default for Performance, Unlimited, Enterprise, and Developer Editions. Some Professional Edition organizations may also have the API feature enabled.

When connecting to a Salesforce org, enable the following Profile settings on the Salesforce User Account to use the associated feature:

Feature User Permission
Adding Environment API Enabled (Required)
Data Template View All Data (Recommended)
Data Backup

View All Data (Recommended)

Query All Files (Recommended)

Author Apex or Modify Metadata (Recommended)
Data Copy (Sandbox Seeding)

Modify All Data (Recommended)

Edit Read-Only Fields (Recommended)

Marketing User (Recommended for Campaigns)

Knowledge User (Recommended for Articles)
Disable/Enable Validations

Customize Application (Required)

Author Apex or Modify Metadata (Required)

Note: If you refresh a Sandbox, re-authenticate the environment from the Environment Hub. For more information, see Remove Organization Association. Any existing references to these Sandboxes within the Data Templates are removed, and you need to re-select the environment in the Data Template details page.

Adding a Salesforce Environment

Procedure

  1. On the Salesforce App console, click Environment Hub.
  2. Click New. The Add Salesforce Environment window appears.
  3. Enter the Organization Name.

Note: This appears as a Name on the Environment Hub table. The organization name can be the same as your environment or can be an alias. This name must be unique within your account.

4. Select the environment from the Environment dropdown list.

Salesforce Environment Type Environment Setting
Production Production
Sandboxes - Developer (Dev), Developer Pro (Dev Pro), Partial Copy (Partial), Full Sandbox
Scratch Orgs Sandbox
Developer Edition Production
Trialforce / Partner Developer Edition Production

5. Select a group from the Group dropdown list.

Note: Groups are used to categorize environments, such as Production, QA, or Development. You can either create a new group or use an existing group. Click Add Group to configure an additional group for the organization.

  1. (Optional) Select the Share with all Organizations Users option to share the environment with other users.
    Note: You can share the environment only when you have the Share Environment flag enabled in your profile settings.
  2. Click Connect to add your Salesforce org using OAuth 2.0. The Salesforce login page appears.

For more information about OAuth 2.0, see Using OAuth 2.0.

  1. Log in to your Salesforce org. The page requesting access to your Salesforce org appears.

Salesforce_App_Request_Access_to_Org_Data.png

  1. Click Allow.

Note:

  1. The Salesforce App connects your Salesforce org using OAuth 2.0. The OAuth 2.0 authentication and authorization framework requires access to your Salesforce org to ensure adequate permissions are in place for application features.
  2. When connecting to a Salesforce org, enable the Profile settings on the Salesforce User Account to use associated features. For more information, see Connecting your Salesforce Organization.

Managing Salesforce Organizations

You can manage the following tasks for your configured Salesforce organizations from the Environment Hub page:

Task Description
Refresh Objects Metadata Ensures the selected organization’s metadata is up-to-date with the latest changes.
Refresh Validations Ensures the selected organization’s data is up-to-date with the latest state of validations.
Disable Validations Disables validations for the selected organization.
Detail

Displays a page with the selected organization’s details. The Details page helps you manage linked Salesforce organizations to:

  • View dashboards related to data storage, API limits, and file storage for the organization
  • Apply validations to the organization
  • View tasks related to the organization

For more information, see Managing Salesforce Organizations.

Monitor a Salesforce Organization

You can view dashboards, apply validations, and view tasks related to an organization.

Procedure

  1. On the Salesforce App console, click Environment Hub.

Salesforce_App_Environment_Hub.png

2. Click Detail corresponding to a Salesforce organization listing.

The Details page is divided into the following:

Organization Details

Salesforce App_Organization_Details.png

This section enables you to:

  • Refresh Validations - Ensures the selected organization’s data is up-to-date with the latest state of validations.

  • Org Describe Refresh - Performs a refresh to get the latest state of your Salesforce organization with the latest updates.

  • Disable Validations - Disables validations for the organization.

  • Delete Organization - Deletes the organization.

  • View Details - Displays details about the organization, such as:

    • Sandbox Type - Displays the type of sandbox.
    • Group - Specifies the organization’s group name. Groups are used to categorize environments, such as Production, QA, or Development. 
    • Instance URL - Specifies the instance URL for the organization.
    • Describe Cache Updated At - Specifies when the describe cache was last updated.
    • Validation Cache Updated At - Specifies when the validation cache was last updated.
    • Is Disabled - Specifies if the organization is currently disabled.

Storage and API Dashboards

The Details page displays the following dashboards.

Salesforce_App_Organization_Details_Dashboards.png

Dashboard Description
Data Storage Displays an overview of the total data storage and consumed data storage.
File Storage Displays an overview of the total file storage and consumed file storage.
API Limit

Displays the total API usage limit and the consumed API statistics.

The Salesforce App consumes APIs while performing the data backups, data restore, and data copy of your Salesforce organizations. As a Salesforce App administrator, ensure that you are aware of the API usage limit set for your organization by Salesforce. 

The first backup utilizes maximum APIs. The subsequent backups are incremental and minimal APIs are consumed.

To stay updated with these statistics, refresh these dashboards using the undefined icon.

To update these statistics for all your Salesforce organizations, click Update Org Limits from the Environment Hub page.

Validations

You can manage validations for any of the configured Salesforce organizations from the Details page.

Salesforce_App_Validations_Details_Page.png

Select the Validation Type from the dropdown list. A table displays the applied validations.

For more information, see Validation Workflow.

Related Tasks

The Related Tasks tab from the Details page displays the list of associated tasks for the selected organization.

Salesforce_App_Org_Related_Tasks.png

For more information, see Managing Tasks.

Describe Objects

The Describe tab from the Details page enables you to search for objects within your Salesforce organization. Also, you can identify creatable or updateable objects within your Salesforce organization.

Salesforce_App_Details_Describe_Objects.png

Procedure

  1. Search for an object name in the search box.
  2. Select Creatable or Updateable to filter the records.

Run SOQL Query

Search for specific information within Salesforce data from an organization using the Salesforce Object Query Language (SOQL). The Run SOQL Query tab enables you to search for data using SOQL queries.

SOQL queries are similar to SELECT statements, wherein you can filter a data set within the organization and perform analysis using the query result.

Salesforce_App_Run_SOQL_Query.png

Enter a SOQL query in the input field and click Execute SOQL. This renders a SOQL Result window with the filtered data set.

Using OAuth 2.0

The OAuth 2.0 authentication and authorization framework uses a Refresh Token to re-authenticate the application with your Salesforce org. Salesforce only allows a maximum of 5 refresh tokens per connected app that can be issued at any point in time. If you request an additional security token after the 5th token is issued, the oldest security token will be invalidated. This is not ideal for scheduled jobs.

OAuth 2.0 doesn’t require security tokens. However, it requires acceptance of the following OAuth access requirements when connecting your Salesforce org from the Salesforce App:

  • Access your basic information
  • Access and manage your data
  • Provide access to your data via the Web
  • Access and manage your Chatter data
  • Provide access to custom applications
  • Allow access to your unique identifier
  • Access custom permissions
  • Access and manage your Wave data
  • Access and manage your Eclair data
  • Perform requests on your behalf at any time

Note:

  1. The Salesforce App connects your Salesforce org using OAuth 2.0. The OAuth 2.0 authentication and authorization framework requires access to your Salesforce org to ensure adequate permissions are in place for application features.
  2. When connecting to a Salesforce org, enable the Profile settings on the Salesforce User Account to use associated features. For more information, see Connecting your Salesforce Organization.

For additional information, see Create a Connected App.

Delete an Organization in Salesforce App

Deleting an organization in the Salesforce App removes the backup data and associated Archival definitions, Backup definitions, and Data Templates. You cannot recover or restore the data to the organization. Therefore, it is recommended that you carefully consider the implications of deleting an organization before taking this action.

Before you begin

Ensure no tasks associated with Archival definitions, Backup definitions, and Data Templates for the organization that you plan to delete are running. You can view the tasks in various stages by visiting Tasks. For more information, see Managing Tasks.

Procedure

  1. On the Salesforce App console, click Environment Hub. All the Salesforce organizations that are configured for backup are listed.

  2. Locate the Organization that you wish to delete and click the dropdown arrow on the right and select Delete. A confirmation window appears.

  3. You can download the list of Archival definitions, Backup definitions, and Data Templates that will be deleted as part of the Organization deletion.

  4. Provide a valid Reason for deletion.

  5. Click Delete.

An email is triggered to the Salesforce App administrator with the deleted Organization details and the reason for deletion.

  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Article type
    Topic
  2. Tags
    1. environment hub
    2. oAuth
    3. stage:draft