Schedule a Salesforce transfer

Salesforce Classic

Retrieve myDomain details

To find your myDomain, do the following:

1. Sign in to the Salesforce platform.
2. Click Setup.
3. In the search bar, search for My Domain.
4. In the search results, click Domain Management > My Domain.

In the My Domain Details section, your myDomain appears as the prefix in Current My Domain URL. For example, if the My Domain URL is example.my.salesforce.com, the myDomain value to use is example.

Retrieve ClientId and ClientSecret details

To find your ClientId and ClientSecret values, do the following:

1. Sign in to the Salesforce platform.
2. Click Setup.
3. In the search bar, search for Apps.
4. In the Build section in the search results, click Create > Apps.
5. Click a Connected App Name.
6. In the Connected Apps details page, click Manage Consumer Details.
7. Verify your identity using one of the registered methods. You can view the consumer details page for up to five minutes before you're prompted to verify your identity again.
8. In the Consumer Details page, the Consumer Key is your ClientId value. The Customer Secret is your ClientSecret value.

Salesforce Lightning Experience

Retrieve myDomain details

To find your myDomain, do the following:

1. Sign in to the Salesforce platform.
2. Click Setup.

1. In the search bar, search for My Domain.
2. In the search results, click Company Settings > My Domain.

In the My Domain Details section, your myDomain appears as the prefix in Current My Domain URL. For example, if the My Domain URL is example.my.salesforce.com, the myDomain value to use is example.

Retrieve ClientId and ClientSecret details

1. Sign in to the Salesforce platform.
2. Click Setup.
3. In the search bar, search for Apps.
4. In the search results, click Apps > App Manager.
5. Find a connected app, then click View.
6. Click Manage Consumer Details.
7. Verify your identity using one of the registered methods. You can view the consumer details page for up to five minutes before you're prompted to verify your identity again.
8. In the Consumer Details page, the Consumer Key is your ClientId value. The Customer Secret is your ClientSecret value.

Console

1. Go to the Data transfers page in the Google Cloud console.

   Go to Data transfers

2. Click add Create transfer.

3. In the Source type section, for Source, choose Salesforce.

4. In the Data source details section, do the following:

   • For My Domain, enter your Salesforce My Domain.
   • For Client ID, enter the Salesforce connected application Consumer Key.
   • For Client secret, enter the Salesforce connected application Consumer Secret.

   • For Salesforce objects to transfer, click Browse to select any objects to be transferred to the BigQuery destination dataset.

     • You can also manually enter any objects to include in the data transfer in this field.

     

5. In the Destination settings section, for Dataset, choose the dataset you created to store your data.

6. In the Transfer config name section, for Display name, enter a name for the data transfer.

7. In the Schedule options section:

   • In the Repeat frequency list, select an option to specify how often this data transfer runs. To specify a custom repeat frequency, select Custom. If you select On-demand, then this transfer runs when you manually trigger the transfer.

   • If applicable, select either Start now or Start at set time and provide a start date and run time.

8. In the Service Account list, select a service account associated with your Google Cloud project. The selected service account must have the required roles to run this data transfer.

   If you signed in with a federated identity, then a service account is required to create a data transfer. If you signed in with a Google Account, then a service account for the transfer is optional.

   For more information about using service accounts with data transfers, see Use service accounts.

9. Optional: In the Notification options section, do the following:

   • To enable email notifications, click the Email notification toggle. When you enable this option, the transfer administrator receives an email notification when a transfer run fails.
   • To enable Pub/Sub transfer run notifications for this transfer, click the Pub/Sub notifications toggle. You can select your topic name, or you can click Create a topic to create one.

10. Click Save.

bq

Enter the bq mk command and supply the transfer creation flag --transfer_config:

bq mk \
    --transfer_config \
    --project_id=PROJECT_ID \
    --data_source=DATA_SOURCE \
    --display_name=NAME \
    --target_dataset=DATASET \
    --params='PARAMETERS'

Where:

• PROJECT_ID (optional): your Google Cloud project ID. If --project_id isn't supplied to specify a particular project, the default project is used.
• DATA_SOURCE: the data source — salesforce.
• NAME: the display name for the data transfer configuration. The transfer name can be any value that lets you identify the transfer if you need to modify it later.
• DATASET: the target dataset for the transfer configuration.

• PARAMETERS: the parameters for the created transfer configuration in JSON format. For example: --params='{"param":"param_value"}'. The following are the parameters for a Salesforce data transfer:

  • connector.authentication.oauth.clientId: The Consumer Key of the Salesforce connected application.
  • connector.authentication.oauth.clientSecret: OAuth Client Secret or Consumer Secret of the Salesforce connected application.
  • connector.authentication.oauth.myDomain: the Salesforce My Domain. For example, if your domain URL is example.my.salesforce.com, then the value is example.
  • assets: the path to the Salesforce objects to be transferred to BigQuery.

For example, the following command creates a Salesforce data transfer in the default project with all the required parameters:

bq mk \
    --transfer_config \
    --target_dataset=mydataset \
    --data_source=salesforce \
    --display_name='My Transfer' \
    --params='{"assets":["Account"],
        "connector.authentication.oauth.clientId": "1234567890",
        "connector.authentication.oauth.clientSecret":"ABC12345",
        "connector.authentication.oauth.myDomain":"MyDomainName",}'

API

Use the projects.locations.transferConfigs.create method and supply an instance of the TransferConfig resource.