Copiar dados de e para o Salesforce Service Cloud usando o Azure Data Factory ou o Azure Synapse Analytics

APLICA-SE A: Azure Data Factory Azure Synapse Analytics

Este artigo descreve como usar a Atividade de Cópia no Azure Data Factory e nos pipelines do Azure Synapse para copiar dados de e para o Salesforce Service Cloud. Ele se baseia no artigo Visão geral da atividade de cópia que apresenta uma visão geral da atividade de cópia.

Capacidades suportadas

Esse conector do Salesforce Service Cloud é compatível com os seguintes recursos:

(1) Tempo de execução de integração do Azure (2) Tempo de execução de integração auto-hospedado

Para obter uma lista de armazenamentos de dados suportados como fontes ou coletores, consulte a tabela Armazenamentos de dados suportados.

Especificamente, esse conector do Salesforce Service Cloud é compatível:

• Edições Salesforce Developer, Professional, Enterprise ou Unlimited.
• Copiar dados de e para o domínio personalizado (o domínio personalizado pode ser configurado em ambientes de produção e sandbox).

Você pode definir explicitamente a versão da API usada para ler/gravar dados por meio apiVersion da propriedade no serviço vinculado. Ao copiar dados para o Salesforce Service Cloud, o conector usa a API BULK 2.0.

Pré-requisitos

• A permissão da API deve ser habilitada no Salesforce.

• Você precisa configurar os aplicativos conectados no portal do Salesforce consultando este documento oficial ou nossa diretriz passo a passo na recomendação deste artigo.

  Importante

  • O usuário de execução deve ter a permissão Somente API.
  • O tempo de expiração do Token de Acesso pode ser alterado por meio de políticas de sessão em vez do token de atualização.

Limites da API em massa do Salesforce 2.0

Usamos o Salesforce Bulk API 2.0 para consultar e ingerir dados. Na API em massa 2.0, os lotes são criados para você automaticamente. Você pode enviar até 15.000 lotes por período de 24 horas. Se os lotes excederem o limite, você verá falhas.

Na API em massa 2.0, apenas os trabalhos de ingestão consomem lotes. Os trabalhos de consulta não. Para obter detalhes, consulte Como as solicitações são processadas no Guia do desenvolvedor da API em massa 2.0.

Para obter mais informações, consulte a seção "Limites gerais" em Limites do desenvolvedor do Salesforce.

Começar agora

Para executar a atividade Copiar com um pipeline, você pode usar uma das seguintes ferramentas ou SDKs:

• A ferramenta Copiar dados
• O portal do Azure
• O SDK do .NET
• O SDK do Python
• Azure PowerShell
• A API REST
• O modelo do Azure Resource Manager

Criar um serviço vinculado ao Salesforce Service Cloud usando a interface do usuário

Use as etapas a seguir para criar um serviço vinculado ao Salesforce Service Cloud na interface do usuário do portal do Azure.

1. Navegue até a guia Gerenciar em seu espaço de trabalho do Azure Data Factory ou Synapse e selecione Serviços Vinculados e clique em Novo:

   • Fábrica de Dados do Azure
   • Azure Synapse

   

2. Pesquise o Salesforce e selecione o conector do Salesforce Service Cloud.

   

3. Configure os detalhes do serviço, teste a conexão e crie o novo serviço vinculado.

   

Detalhes de configuração do conector

As seções a seguir fornecem detalhes sobre as propriedades usadas para definir entidades específicas para o conector do Salesforce Service Cloud.

Propriedades do serviço vinculado

As propriedades a seguir são suportadas para o serviço vinculado do Salesforce Service Cloud.

Exemplo: armazenar credenciais

{
    "name": "SalesforceServiceCloudLinkedService",
    "properties": {
        "type": "SalesforceServiceCloudV2",
        "typeProperties": {
            "environmentUrl": "<environment URL>",
            "authenticationType": "OAuth2ClientCredentials",
            "clientId": "<client ID>",
            "clientSecret": {
                "type": "SecureString",
                "value": "<client secret>"
            },
            "apiVersion": "<API Version>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Exemplo: Armazenar credenciais no Cofre da Chave

{
    "name": "SalesforceServiceCloudLinkedService",
    "properties": {
        "type": "SalesforceServiceCloudV2",
        "typeProperties": {
            "environmentUrl": "<environment URL>",
            "authenticationType": "OAuth2ClientCredentials",
            "clientId": "<client ID>",
            "clientSecret": {
                "type": "AzureKeyVaultSecret",
                "secretName": "<secret name of client secret in AKV>",
                "store":{
                    "referenceName": "<Azure Key Vault linked service>",
                    "type": "LinkedServiceReference"
                }
            },
            "apiVersion": "<API Version>"
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Propriedades do conjunto de dados

Para obter uma lista completa de seções e propriedades disponíveis para definir conjuntos de dados, consulte o artigo Conjuntos de dados. Esta seção fornece uma lista de propriedades suportadas pelo conjunto de dados do Salesforce Service Cloud.

Para copiar dados de e para o Salesforce Service Cloud, defina a propriedade type do conjunto de dados como SalesforceServiceCloudV2Object. As seguintes propriedades são suportadas.

Exemplo:

{
    "name": "SalesforceServiceCloudDataset",
    "properties": {
        "type": "SalesforceServiceCloudV2Object",
        "typeProperties": {
            "objectApiName": "MyTable__c"
        },
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Salesforce Service Cloud linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Propriedades da atividade Copy

Para obter uma lista completa de seções e propriedades disponíveis para definir atividades, consulte o artigo Pipelines . Esta seção fornece uma lista de propriedades compatíveis com a origem e o coletor do Salesforce Service Cloud.

Salesforce Service Cloud como um tipo de origem

Para copiar dados do Salesforce Service Cloud, defina o tipo de origem na atividade de cópia como SalesforceServiceCloudV2Source. As propriedades a seguir são suportadas na seção copiar fonte de atividade.

Exemplo:

"activities":[
    {
        "name": "CopyFromSalesforceServiceCloud",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Salesforce Service Cloud input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "SalesforceServiceCloudV2Source",
                "query": "SELECT Col_Currency__c, Col_Date__c, Col_Email__c FROM AllDataType__c",
                "includeDeletedObjects": false
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Salesforce Service Cloud como um tipo de coletor

Para copiar dados para o Salesforce Service Cloud, defina o tipo de coletor na atividade de cópia como SalesforceServiceCloudV2Sink. As propriedades a seguir são suportadas na seção coletor de atividade de cópia.

Exemplo: coletor do Salesforce Service Cloud em uma atividade de cópia

"activities":[
    {
        "name": "CopyToSalesforceServiceCloud",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<Salesforce Service Cloud output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "<source type>"
            },
            "sink": {
                "type": "SalesforceServiceCloudV2Sink",
                "writeBehavior": "Upsert",
                "externalIdFieldName": "CustomerId__c",
                "writeBatchSize": 10000,
                "ignoreNullValues": true
            }
        }
    }
]

Mapeamento de tipo de dados para o Salesforce Service Cloud

Quando você copia dados do Salesforce Service Cloud, os mapeamentos a seguir são usados de tipos de dados do Salesforce Service Cloud para tipos de dados provisórios dentro do serviço internamente. Para saber como a atividade de cópia mapeia o esquema de origem e o tipo de dados para o coletor, consulte Mapeamentos de esquema e tipo de dados.

Propriedades da atividade de pesquisa

Para saber detalhes sobre as propriedades, verifique Atividade de pesquisa.

Atualizar o serviço vinculado do Salesforce Service Cloud

Aqui estão as etapas que ajudam você a atualizar seu serviço vinculado e consultas relacionadas:

1. Configure os aplicativos conectados no portal do Salesforce consultando Pré-requisitos.

2. Crie um novo serviço vinculado do Salesforce Service Cloud e configure-o consultando as propriedades do serviço vinculado.

3. Se você usar a consulta SQL na fonte de atividade de cópia ou na atividade de pesquisa que se refere ao serviço vinculado herdado, será necessário convertê-las para a consulta SOQL. Saiba mais sobre a consulta SOQL do Salesforce Service Cloud como um tipo de origem e do Salesforce Object Query Language (SOQL).

4. readBehavior é substituído por includeDeletedObjects na fonte da atividade de cópia ou na atividade de pesquisa. Para obter a configuração detalhada, consulte Salesforce Service Cloud como um tipo de origem.

Diferenças entre o Salesforce Service Cloud e o Salesforce Service Cloud (legado)

O conector do Salesforce Service Cloud oferece novas funcionalidades e é compatível com a maioria dos recursos do conector (legado) do Salesforce Service Cloud. A tabela abaixo mostra as diferenças de recursos entre o Salesforce Service Cloud e o Salesforce Service Cloud (legado).

Conteúdos relacionados

Para obter uma lista de armazenamentos de dados suportados como fontes e coletores pela atividade de cópia, consulte Armazenamentos de dados suportados.