Environment Hub

PROFILE PERMISSIONS REQUIRED

Manage Environments

Managing Environments

The Environment Hub allows you to manage all of your existing Salesforce orgs in one place.

Connecting 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 enabled.

When connecting to a Salesforce org, consider the following Profile settings that need to be enabled 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 Copy

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)

If you refresh a Sandbox, please re-authenticate the environment through the Environment Hub. Any existing references to these Sandboxes within Data Templates will be removed and the user will need to re-select the environment in the Data Template details page.

Adding a Source and Destination Environment

Step 1. Click New button on the top right. On the Add Salesforce Environment window, connect to your Salesforce org using either Username/Password or OAuth 2.0.

Use the table below to help you decide whether to use Username/Password or OAuth 2.0 to add an environment.

Username/Password

OAuth 2.0

Can be set to password never expire. This is useful for service accounts that will be used for scheduled jobs (i.e. CI/CD, Data Backup, Orchestrations).

Uses a Refresh Token to re-authenticate the application with your Salesforce orgs. Please note that Salesforce only allows a maximum of 5 refresh token 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 schedule jobs.

May require a security token to be specified depending on the orgs security settings.

Doesn’t require security tokens.

Requires acceptance of the following OAuth scope:

  • 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

For additional information, please see Create a Connected App.

Step 2. Complete all of the following fields to continue:

Organization Name

This will be reflected under Name on the Environment Hub table. Can be the same name as your environment or can be an alias. This name should be unique within your account.

Username/Password

  • Username (e.g. xxxxxx@xxxxxx.destination) - This is your username you use to connect to your source or destination Salesforce environment.
  • Security Token - Required if they have been enabled by your Salesforce Administrator or if you are connecting from a network outside of your organization’s whitelisted IP addresses. For more information on security tokens please see Security Tokens.  Alternatively, you can login using the OAuth login method to bypass using a security token.

Getting the Security Token for Your Salesforce Account

  1. Log in to Salesforce using the Salesforce account you plan to use for OrgTools.
  2. In the User Menu, select Setup.
  3. In the menu on the left, under Personal Setup, expand My Personal Information, and then click Reset My Security Token.
  4. Alternatively, you can search Reset in the Quick Find box, then select Reset My Security Token.
  5. Click Reset Security Token. The new security token will be sent to the email address in your Salesforce personal settings.
  6. See Reset Your Security Token for additional information.

Use the following table to determine which setting to use for each type of Salesforce environment:

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
  • Group - You can either create a new group or use an existing group. Used to categorize environments (i.e. Production, QA, Development, etc.).