Skip to main content
All CollectionsFAQsAuthentications and integrations and connectionsManaging connections
Connecting to a Salesforce org hosted on Alibaba Cloud in China
Connecting to a Salesforce org hosted on Alibaba Cloud in China

If you have an org hosted on Salesforce China you will need to connect it to Gearset to use it for metadata deployments.

Claudia McPhail avatar
Written by Claudia McPhail
Updated over 2 weeks ago

Introduction

Now that Salesforce on Alibaba Cloud is live, your organisation may have started planning their multi org strategy.

If you have a Salesforce org hosted on Alibaba Cloud you will need to connect it to your Gearset account, which will allow you to:

This article will take you through the process of connecting to a Salesforce on Alibaba (aka SFOA) org.

At the moment this connection type doesn't allow the use of our data deployment solution, or the creation of data backup jobs.

This is to prevent users:

  • Using Gearset to move customer data out of China to anywhere else.

  • Making a backup of their Chinese org on a Gearset instance not hosted in China.

Doing either of those things would defeat the purpose of setting up an org in China for data residency compliance. There's scope in the future to allow data deployments to China as part of the initial setup process of these orgs, but but for now we have limited the connection use to metadata (and configuration data). If you would like us to allow the deployment of data to or from your org hosted in China please feed that back through the in-app chat so we know that you require that support.

Note: If you're planning to use team-shared Pipelines, please make sure you connect to any shared orgs using team-shared connections.

Creating a connected app in your Salesforce on Alibaba Cloud org

Before you start, make sure that you have a user in the org with these permissions.

To use Gearset with your Salesforce China instance securely, we're going to create a Connected App within your instance that will allow Gearset to connect with it.

We also recommend that a team owner creates the connection, so that access can delegated appropriately to team members.

Configuring the basic connected app settings

In your org:

  1. Open Setup.

  2. Search for App Manager and open it.

Click New Connected App in the top right of the screen.

Next, enter the following information:

  1. Connected App Name

  2. API Name

  3. Contact email (this should be your email)

  4. Contact Phone
    ​leave blank

  5. Logo image url
    ​leave blank

  6. Icon url
    ​leave blank

  7. Info url
    ​​https://gearset.com (optional)

  8. Description
    ​An OAuth app to allow Gearset to deploy to orgs based in China.

Check the Enable OAuth settings checkbox, and input the following values.

  1. For the Callback URL enter
    ​https://app.gearset.com/authorization/callback

  2. Enable for device flow
    ​leave blank

  3. Call abc url
    ​leave blank

  4. Use digital signatures
    ​leave blank

  5. Selected OAuth scope
    ​Full access and Perform requests at any time

  6. Require Proof Key for Code Exchange (PKCE) Extension for Supported Authorization Flows
    ​tick

  7. Require Secret for Web Server Flow
    ​tick

  8. Require Secret for Refresh Token Flow
    ​tick

  9. Enable Client Credentials Flow
    ​leave blank

  10. Enable Authorization Code and Credentials Flow
    ​leave blank

  11. Enable Token Exchange Flow
    ​leave blank

  12. Enable Refresh Token Rotation
    ​leave blank

  13. Issue JSON Web Token (JWT)-based access tokens for named users
    ​leave blank

  14. Introspect All Tokens
    ​leave blank

15. Click the ”Save” button at the top of the screen, and on the next page click Continue.

16. Click the ”Manage” button at the top of the page.

17. Click “Edit Policies” at the top of the page.

18. Set “Permitted Users” to All users may self-authorize.

19. Click “Save”, the final settings should look like this.

Getting the Consumer ID and Secret

To get the Consumer Key and Secret:

  1. Open Setup.

  2. Search for App Manager and open it.

  3. Find your new App, and click “View”.

  4. Click “Manage consumer Details”.

  5. On the next page you will see the Consumer Key and Consumer Secret.

    1. Copy both of these values, as Gearset will need them to complete the connection.

Connecting to your org hosted on Alibaba Cloud

You will need to start by creating a connected app in your SFOA org.

  1. Navigate to the Salesforce org connections page in Gearset.

  2. Click "Add new organization".

  3. Input the following details:

    1. The custom domain of your org.

    2. The Consumer Key in "Client ID" and

    3. The Consumer Secret in "Client secret"

  4. If you are setting up this connection to be used as part of a Pipeline toggle "Team-shared connection" to on.

  5. Click Connect - this will bring you to your organization's login page. Log in to the org as normal, and you will be returned to Gearset.

After the connection is complete you will see it on your list of connected orgs here. You can also delegate access to your team members.

Related Articles
Managing Salesforce org connections
Resolving issues with logging in and connecting orgs via Salesforce
What access does Gearset need when connecting to a Salesforce org?
Restricting which Salesforce orgs your team can connect to
Deleting an Org Connection
Did this answer your question?