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
Gorjeta
Experimente o Data Factory no Microsoft Fabric, uma solução de análise tudo-em-um para empresas. O Microsoft Fabric abrange tudo, desde a movimentação de dados até ciência de dados, análises em tempo real, business intelligence e relatórios. Saiba como iniciar uma nova avaliação gratuitamente!
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.
Importante
O novo conector do Salesforce Service Cloud oferece suporte nativo aprimorado ao Salesforce Service Cloud. Se você estiver usando o conector herdado do Salesforce Service Cloud em sua solução, suportado no estado em que se encontra apenas para compatibilidade com versões anteriores, consulte o artigo Salesforce Service Cloud connector (legado).
Capacidades suportadas
Esse conector do Salesforce Service Cloud é compatível com os seguintes recursos:
| Capacidades suportadas | IR |
|---|---|
| Atividade de cópia (origem/coletor) | (1) (2) |
| Atividade de Pesquisa | (1) (2) |
(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.
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:
Pesquise o Salesforce e selecione o conector do Salesforce Service Cloud.
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.
| Property | Descrição | Obrigatório |
|---|---|---|
| tipo | A propriedade type deve ser definida como SalesforceServiceCloudV2. | Sim |
| environmentUrl | Especifique a URL da instância do Salesforce Service Cloud. Por exemplo, especifique "https://<domainName>.my.salesforce.com" para copiar dados do domínio personalizado. Saiba como configurar ou visualizar seu domínio personalizado referente a este artigo. |
Sim |
| authenticationType | Tipo de autenticação usado para se conectar ao Salesforce Service Cloud. O valor permitido é OAuth2ClientCredentials. |
Sim |
| clientId | Especifique a ID do cliente do aplicativo conectado Salesforce OAuth 2.0. Para obter mais informações, consulte este artigo | Sim |
| clientSecret | Especifique o segredo do cliente do aplicativo conectado Salesforce OAuth 2.0. Para obter mais informações, consulte este artigo | Sim |
| apiVersion | Especifique a versão 2.0 do Salesforce Bulk API a ser usada, por exemplo. 52.0 A API em massa 2.0 suporta apenas a versão >da API = 47.0. Para saber mais sobre a versão 2.0 da API em massa, consulte o artigo. Se você usar uma versão inferior da API, isso resultará em uma falha. |
Sim |
| ConecteVia | O tempo de execução de integração a ser usado para se conectar ao armazenamento de dados. Se não for especificado, ele usará o Tempo de Execução de Integração do Azure padrão. | Não |
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.
| Property | Descrição | Obrigatório |
|---|---|---|
| tipo | A propriedade type deve ser definida como SalesforceServiceCloudV2Object. | Sim |
| objectApiName | O nome do objeto do Salesforce Service Cloud do qual recuperar dados. | Não para a fonte (se "SOQLQuery" na fonte for especificado), Sim para o coletor |
| reportId | A ID do relatório do Salesforce Service Cloud do qual recuperar dados. Não é suportado na pia. Observe que há limitações quando você usa relatórios. | Não para origem (se "SOQLQuery" na origem for especificado), não suporta coletor |
Importante
A parte "__c" do Nome da API é necessária para qualquer objeto personalizado.
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.
| Property | Descrição | Obrigatório |
|---|---|---|
| tipo | A propriedade type da fonte de atividade de cópia deve ser definida como SalesforceServiceCloudV2Source. | Sim |
| SOQLQuery | Use a consulta personalizada para ler dados. Você só pode usar a consulta SOQL (Salesforce Object Query Language) com limitações. Para limitações de SOQL, consulte este artigo. Se a consulta não for especificada, todos os dados do objeto Salesforce especificado em "ObjectApiName/reportId" no conjunto de dados serão recuperados. | Não (se "ObjectApiName/reportId" no conjunto de dados for especificado) |
| includeDeletedObjects | Indica se os registros existentes devem ser consultados ou consultados todos os registros, incluindo os excluídos. Se não for especificado, o comportamento padrão será false. Valores permitidos: false (padrão), true. |
Não |
Importante
A parte "__c" do Nome da API é necessária para qualquer objeto personalizado.
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",
"SOQLQuery": "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.
| Property | Descrição | Obrigatório |
|---|---|---|
| tipo | A propriedade type do coletor de atividade de cópia deve ser definida como SalesforceServiceCloudV2Sink. | Sim |
| writeBehavior | O comportamento de gravação para a operação. Os valores permitidos são Insert e Upsert. |
Não (o padrão é Inserir) |
| externalIdFieldName | O nome do campo ID externo para a operação de upsert. O campo especificado deve ser definido como "Campo de ID Externo" no objeto Salesforce Service Cloud. Ele não pode ter valores NULL nos dados de entrada correspondentes. | Sim para "Upsert" |
| writeBatchSize | A contagem de linhas de dados gravados no Salesforce Service Cloud em cada lote. Sugira definir esse valor de 10.000 a 200.000. Poucas linhas em cada lote reduzirão o desempenho da cópia. Muitas linhas em cada lote podem causar o tempo limite da API. | Não (o padrão é 100.000) |
| ignoreNullValues | Indica se os valores NULL devem ser ignorados dos dados de entrada durante uma operação de gravação. Os valores permitidos são true e false. - True: Deixe os dados no objeto de destino inalterados quando você fizer uma operação de upsert ou atualização. Insira um valor padrão definido quando você fizer uma operação de inserção. - False: atualize os dados no objeto de destino para NULL quando você fizer uma operação de upsert ou atualização. Insira um valor NULL quando você fizer uma operação de inserção. |
Não (o padrão é false) |
| maxConcurrentConnections | O limite superior de conexões simultâneas estabelecidas para o armazenamento de dados durante a execução da atividade. Especifique um valor somente quando quiser limitar conexões simultâneas. | Não |
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.
| Tipo de dados do Salesforce Service Cloud | Tipo de dados provisórios de serviço |
|---|---|
| Número automático | String |
| Caixa de verificação | Boolean |
| Moeda | Decimal |
| Date | DateTime |
| Data/Hora | DateTime |
| Correio Eletrónico | String |
| ID | String |
| Relação de pesquisa | String |
| Lista de opções de seleção múltipla | String |
| Número | Decimal |
| Percentagem | Decimal |
| Telefone | String |
| Picklist | String |
| Texto | String |
| Área de Texto | String |
| Área de texto (longa) | String |
| Área de texto (Rich) | String |
| Texto (encriptado) | String |
| URL | String |
Nota
O tipo de Número do Salesforce Service Cloud está mapeando para o tipo Decimal nos pipelines do Azure Data Factory e do Azure Synapse como um tipo de dados provisório de serviço. O tipo decimal honra a precisão e a escala definidas. Para dados cujas casas decimais excedam a escala definida, seu valor será arredondado em dados de visualização e cópia. Para evitar essa perda de precisão nos pipelines do Azure Data Factory e do Azure Synapse, considere aumentar as casas decimais para um valor razoavelmente grande na página Edição de definição de campo personalizado do Salesforce Service Cloud.
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:
Configure os aplicativos conectados no portal do Salesforce consultando Pré-requisitos.
Crie um novo serviço vinculado do Salesforce Service Cloud e configure-o consultando as propriedades do serviço vinculado.
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).
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).
| Salesforce Service Cloud | Salesforce Service Cloud (legado) |
|---|---|
| Ofereça suporte ao SOQL no Salesforce Bulk API 2.0. Para consultas SOQL: • As cláusulas GROUP BY, LIMIT, ORDER BY, OFFSET ou TYPEOF não são suportadas. • Funções agregadas como COUNT() não são suportadas, você pode usar relatórios do Salesforce para implementá-las. • As funções de data nas cláusulas GROUP BY não são suportadas, mas são suportadas na cláusula WHERE. • Não há suporte para campos de endereços compostos ou campos compostos de geolocalização. Como alternativa, consulte os componentes individuais dos campos compostos. • As consultas de relacionamento entre pais não são suportadas, enquanto as consultas de relacionamento entre pais são suportadas. |
Suporta sintaxe SQL e SOQL. |
| Não há suporte para objetos que contêm campos binários. | Há suporte para objetos que contêm campos binários, como o objeto Attachment. |
| Ofereça suporte a objetos dentro da API em massa. Para mais informações, consulte este artigo. | Ofereça suporte a objetos que não são suportados pela API em massa, como CaseStatus. |
| Relatório de suporte selecionando um ID de relatório. | Ofereça suporte à sintaxe de consulta de relatório, como {call "<report name>"}. |
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.