To run comparisons and deployments in Gearset, you'll need to set up some org connections.

Gearset allows you to connect to any Salesforce org:

  • Developer orgs
  • Sandbox orgs
  • Production orgs
  • Professional Edition orgs
  • Salesforce DX scratch orgs (see our article on DX orgs for more info)

Gearset also supports SSO and My Domain connections to your orgs.

By default, Gearset connects to orgs using the secure OAuth method (our recommended approach). If required, you can also connect to orgs using username/password connections.

The user you connect to your orgs must have the Modify all data  permission in order to run comparisons and deployments through Gearset.

Adding a Salesforce org connection via OAuth

OAuth is the recommended method for connecting to all orgs.

  1. You can add an org from either the Compare & Deploy page, or the Salesforce orgs page in the app
  2. Select either Salesforce authentication  or My Domain / Government Cloud  as the authentication method, depending on the org you're connecting to
  3. Enter the Salesforce username for the org you wish to connect to
  4. If you've selected My Domain / Government Cloud , enter the custom domain you use to connect to your org
  5. Select the Salesforce org type from the drop-down: Developer , Sandbox, or Production 
  6. Click Authorize . You'll be prompted to log into your org through Salesforce.
  7. Click Allow  when prompted to grant Gearset access to the org via OAuth.

The org will now be added to your list of saved connections. You can now select it for future comparisons or automated jobs from the org selector dropdown.

Adding a Salesforce org connection via username/password

  1. You can add an org from either the Compare & Deploy page, or the Salesforce orgs page in the app
  2. Select Username/password  as the authentication method
  3. Enter the Salesforce username for the org you wish to connect to
  4. Enter your org password
  5. Enter the org security token (if required)
  6. Select the Salesforce org type from the drop-down: Developer  , Sandbox , or Production 

The org will now be added to your list of saved connections. You can now select it for future comparisons or automated jobs from the org selector dropdown.

Adding a friendly name to a saved org

You can add names to your connected Salesforce orgs to make them easier to identify.

  1. From the Salesforce orgs page, click Add  under the friendly name column
  2. Enter the name for the connection
  3. Click Save 

Managing saved org connections

All of the org connections you have added to Gearset can be seen on the Salesforce orgs page in the app.

This page lists details for orgs you have added yourself, and any orgs that have been shared with you by members of your team.

  • Owner: who owns the org connection. If a team member has shared access to one of their orgs using Gearset's team features, you will see their name in this column
  • Entitlement level: for shared org connections, your access level to the org. See our sharing org credentials guide for more information about delegated access
  • Username: the username for the org connection
  • Organization type: Developer, Sandbox, or Production org
  • Friendly name: the custom name you've given that org connection (if any)
  • Authorization type: how you've connected to that org

You can manage your saved org connections from this page:

  • Delegate access: share this org credential with members of your team in Gearset, to allow them to compare, validate to, or deploy to it
  • Re-authorize: if the OAuth token has expired for a saved connection, use this to re-enter your user credentials and refresh the connection
  • Delete org link: if you wish to remove a saved connection, click the bin icon. If this org was shared with any team members, this will also remove it from their shared connections
  • Remove shared org: remove a connection shared with you by a team member. To regain access to this connection, ask the org connection owner to re-share it. This doesn't delete the connection from their account.
Did this answer your question?