To run a comparison in Gearset, you need to add a source and target location of your metadata. 

Gearset supports comparing metadata from all live Salesforce organizations:

  • Developer
  • Sandbox
  • Production
  • Salesforce custom domains (My Domain and Government Cloud)
  • Professional Edition orgs
  • Single Sign On (SSO) connections
  • Salesforce DX scratch orgs (see our article on DX orgs for more info)

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

  1. From the Compare & Deploy screen, select Salesforce organization as the metadata location
  2. Select Salesforce authentication as the authentication method
  3. Enter the Salesforce username
  4. Select the Salesforce org type from the drop-down (Developer, Sandbox, Production)
  5. Click Authorize to proceed through the OAuth flow and allow Gearset access to connect to your Salesforce org
  6. Click Allow when prompted to grant Gearset access to the org

The org will now be added to your list of saved connections. It will appear in the list of available orgs via the dropdown for future comparisons and automation jobs.

Adding a My Domain / Government cloud Salesforce org connection via OAuth

  1. From the Compare & Deploy screen, select Salesforce organization as the metadata location
  2. Select My Domain / Government Cloud as the authentication method
  3. Enter the Salesforce username
  4. Enter your custom domain prefix (e.g. https://domain.my.salesforce.com)
  5. Select the Salesforce org type from the drop-down (Developer, Sandbox, Production)
  6. Click Authorize to proceed through the OAuth flow and allow Gearset access to connect to your Salesforce org
  7. Click Allow when prompted to grant Gearset access to the org

The org will now be added to your list of saved connections. It will appear in the list of available orgs via the dropdown for future comparisons and automation jobs.

Connecting to a Salesforce org using username/password

  1. From the Compare & Deploy screen, select Salesforce organization as the metadata location
  2. Select Username/password as the authentication method
  3. Enter the Salesforce username
  4. Enter the password
  5. Enter the org security token (if required)
  6. Select the Salesforce org type from the drop-down (Developer, Sandbox, Production)

Note: Connections made using username/password are not stored in Gearset. You will need to enter the user details every time you run a comparison, and these connections cannot be used for automated monitoring or CI jobs. We recommend using OAuth for all org connections.

Adding a friendly name to an authorised org connection

You can add friendly names for your Salesforce orgs to make them easier to identify via the Connections page. This also provides the option to remove org connections or re-authorize the org should the token have expired or access been revoked.

Viewing and deleting saved org connections

All of the org connections you have added to Gearset can be seen on the Connections page.

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: you can give saved connections a name to make it easier to identify than the username. For example, this could be your Production instance, or the name of a client org. Friendly names will be displayed in the selection dropdown when choosing any org connection in the app
  • Authorization type: Salesforce (OAuth), My Domain (OAuth)
  • Actions: actions to perform on the connection (see below)

There are a number of actions available from this page:

  • Add new connection: add a new Salesforce org connection
  • Re-authorize: if the OAuth token has expired for a saved connection, click this to re-enter your user credentials and refresh the connection so Gearset can continue to connect to it
  • Delegate access: select which individual members of your team can also compare, validate to, or deploy to the selected org
  • 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
  • Unlink shared connection: 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
Did this answer your question?