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

Artigo
05/11/2024

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 Synapse Analytics 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, atualize seu conector do Salesforce Service Cloud antes de 11 de outubro de 2024. Consulte esta seção para obter detalhes sobre a diferença entre a versão herdada e a versão mais recente.

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 a produção, área restrita e domínio personalizado do Salesforce.

O conector Salesforce é criado com base na API REST/Bulk do Salesforce. Por padrão, ao copiar dados do Salesforce, o conector usa v45 e escolhe automaticamente entre APIs REST e Bulk com base no tamanho dos dados - quando o conjunto de resultados é grande, a API em massa é usada para um melhor desempenho; ao gravar dados no Salesforce, o conector usa v40 de API em massa. Você também pode definir explicitamente a versão da API usada para ler/gravar dados por meio apiVersion da propriedade no serviço vinculado.

Pré-requisitos

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

Limites de solicitação do Salesforce

O Salesforce tem limites para o total de solicitações de API e solicitações de API simultâneas. Tenha em conta os seguintes pontos:

Se o número de solicitações simultâneas exceder o limite, a limitação ocorrerá e você verá falhas aleatórias.
Se o número total de solicitações exceder o limite, a conta do Salesforce será bloqueada por 24 horas.

Você também pode receber a mensagem de erro "REQUEST_LIMIT_EXCEEDED" em ambos os cenários. Para obter mais informações, consulte a seção "Limites de solicitação de API" 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:

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:
- Fábrica de Dados do Azure
- Azure Synapse
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 do Data Factory 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.

Property	Descrição	Obrigatório
tipo	A propriedade type deve ser definida como SalesforceServiceCloud.	Sim
environmentUrl	Especifique a URL da instância do Salesforce Service Cloud. - O padrão é `"https://login.salesforce.com"`. - Para copiar dados da sandbox, especifique `"https://test.salesforce.com"`. - Para copiar dados de domínio personalizado, especifique, por exemplo, `"https://[domain].my.salesforce.com"`.	Não
nome de utilizador	Especifique um nome de usuário para a conta de usuário.	Sim
password	Especifique uma senha para a conta de usuário. Marque este campo como um SecureString para armazená-lo com segurança ou faça referência a um segredo armazenado no Cofre de Chaves do Azure.	Sim
securityToken	Especifique um token de segurança para a conta de usuário. Para saber mais sobre tokens de segurança em geral, consulte Segurança e a API. O token de segurança só pode ser ignorado se você adicionar o IP do Integration Runtime à lista de endereços IP confiáveis no Salesforce. Ao usar o IR do Azure, consulte Endereços IP do Azure Integration Runtime. Para obter instruções sobre como obter e redefinir um token de segurança, consulte Obter um token de segurança. Marque este campo como um SecureString para armazená-lo com segurança no Data Factory ou faça referência a um segredo armazenado no Cofre da Chave do Azure.	Não
apiVersion	Especifique a versão REST/Bulk API do Salesforce a ser usada, por exemplo, `48.0`. Por padrão, o conector usa v45 para copiar dados do Salesforce e usa v40 para copiar dados para o Salesforce.	Não
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": "SalesforceServiceCloud",
        "typeProperties": {
            "username": "<username>",
            "password": {
                "type": "SecureString",
                "value": "<password>"
            },
            "securityToken": {
                "type": "SecureString",
                "value": "<security token>"
            }
        },
        "connectVia": {
            "referenceName": "<name of Integration Runtime>",
            "type": "IntegrationRuntimeReference"
        }
    }
}

Exemplo: Armazenar credenciais no Cofre da Chave

{
    "name": "SalesforceServiceCloudLinkedService",
    "properties": {
        "type": "SalesforceServiceCloud",
        "typeProperties": {
            "username": "<username>",
            "password": {
                "type": "AzureKeyVaultSecret",
                "secretName": "<secret name of password in AKV>",
                "store":{
                    "referenceName": "<Azure Key Vault linked service>",
                    "type": "LinkedServiceReference"
                }
            },
            "securityToken": {
                "type": "AzureKeyVaultSecret",
                "secretName": "<secret name of security token in AKV>",
                "store":{
                    "referenceName": "<Azure Key Vault linked service>",
                    "type": "LinkedServiceReference"
                }
            }
        },
        "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, as seguintes propriedades são suportadas.

Property	Descrição	Obrigatório
tipo	A propriedade type deve ser definida como SalesforceServiceCloudObject.	Sim
objectApiName	O nome do objeto Salesforce do qual recuperar dados.	Não para a fonte, Sim para o lavatório

Importante

A parte "__c" do Nome da API é necessária para qualquer objeto personalizado.

Nome da API de conexão do Salesforce

Exemplo:

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

Property	Descrição	Obrigatório
tipo	A propriedade type do conjunto de dados deve ser definida como RelationalTable.	Sim
tableName	Nome da tabela no Salesforce Service Cloud.	Não (se "consulta" na fonte da atividade for especificado)

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, 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 SalesforceServiceCloudSource.	Sim
query	Use a consulta personalizada para ler dados. Você pode usar a consulta SOQL (Salesforce Object Query Language) ou a consulta SQL-92. Veja mais dicas na seção de dicas de consulta. Se a consulta não for especificada, todos os dados do objeto Salesforce Service Cloud especificado em "objectApiName" no conjunto de dados serão recuperados.	Não (se "objectApiName" no conjunto de dados for especificado)
readBehavior	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á o primeiro. Valores permitidos: query (default), queryAll.	Não

Importante

A parte "__c" do Nome da API é necessária para qualquer objeto personalizado.

Lista de nomes da API de conexão do Salesforce

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": "SalesforceServiceCloudSource",
                "query": "SELECT Col_Currency__c, Col_Date__c, Col_Email__c FROM AllDataType__c"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Nota

A origem do Salesforce Service Cloud não oferece suporte a configurações de proxy no tempo de execução de integração auto-hospedado, mas o coletor sim.

Salesforce Service Cloud como um tipo de coletor

Para copiar dados para o Salesforce Service Cloud, as propriedades a seguir são suportadas na seção coletor de atividades de cópia.

Property	Descrição	Obrigatório
tipo	A propriedade type do coletor de atividade de cópia deve ser definida como SalesforceServiceCloudSink.	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.	Não (o padrão é 5.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:

"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": "SalesforceServiceCloudSink",
                "writeBehavior": "Upsert",
                "externalIdFieldName": "CustomerId__c",
                "writeBatchSize": 10000,
                "ignoreNullValues": true
            }
        }
    }
]

Dicas de consulta

Recuperar dados de um relatório do Salesforce Service Cloud

Você pode recuperar dados de relatórios do Salesforce Service Cloud especificando uma consulta como {call "<report name>"}. Um exemplo é "query": "{call \"TestReport\"}".

Recuperar registros excluídos da Lixeira do Salesforce Service Cloud

Para consultar os registros excluídos suavemente da Lixeira do Salesforce Service Cloud, você pode especificar readBehavior como queryAll.

Diferença entre a sintaxe de consulta SOQL e SQL

Ao copiar dados do Salesforce Service Cloud, você pode usar a consulta SOQL ou a consulta SQL. Observe que esses dois têm sintaxe e funcionalidade diferentes, não misture. Sugere-se que você use a consulta SOQL, que é suportada nativamente pelo Salesforce Service Cloud. A tabela a seguir lista as principais diferenças:

Sintaxe	Modo SOQL	Modo SQL
Seleção de colunas	Necessidade de enumerar os campos a serem copiados na consulta, por exemplo, `SELECT field1, filed2 FROM objectname`	`SELECT *` é suportado além da seleção de colunas.
Aspas	Nomes de arquivos/objetos não podem ser citados.	Nomes de campos/objetos podem ser citados, por exemplo: `SELECT "id" FROM "Account"`
Formato datetime	Consulte os detalhes aqui e exemplos na próxima seção.	Consulte os detalhes aqui e exemplos na próxima seção.
Valores booleanos	Representado como `False` e `True`, por exemplo, `SELECT … WHERE IsDeleted=True`.	Representado como 0 ou 1, por exemplo. `SELECT … WHERE IsDeleted=1`
Renomeação de coluna	Não suportado.	Suportado, por exemplo: `SELECT a AS b FROM …`.
Relação	Suportado, por exemplo. `Account_vod__r.nvs_Country__c`	Não suportado.

Recuperar dados usando uma cláusula where na coluna DateTime

Ao especificar a consulta SOQL ou SQL, preste atenção à diferença de formato DateTime. Por exemplo:

Amostra SOQL: SELECT Id, Name, BillingCity FROM Account WHERE LastModifiedDate >= @{formatDateTime(pipeline().parameters.StartTime,'yyyy-MM-ddTHH:mm:ssZ')} AND LastModifiedDate < @{formatDateTime(pipeline().parameters.EndTime,'yyyy-MM-ddTHH:mm:ssZ')}
Exemplo de SQL: SELECT * FROM Account WHERE LastModifiedDate >= {ts'@{formatDateTime(pipeline().parameters.StartTime,'yyyy-MM-dd HH:mm:ss')}'} AND LastModifiedDate < {ts'@{formatDateTime(pipeline().parameters.EndTime,'yyyy-MM-dd HH:mm:ss')}'}

Erro de MALFORMED_QUERY: truncado

Se você clicar no erro "MALFORMED_QUERY: truncado", normalmente é devido a você ter a coluna do tipo JunctionIdList nos dados e o Salesforce tem limitação no suporte a esses dados com grande número de linhas. Para atenuar, tente excluir a coluna JunctionIdList ou limitar o número de linhas a serem copiadas (você pode particionar para várias execuções de atividade de cópia).

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 usados internamente no serviço. 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.

Próximos passos

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

Share via

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

Capacidades suportadas

Pré-requisitos

Limites de solicitação do Salesforce

Começar agora

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

Detalhes de configuração do conector

Propriedades do serviço vinculado

Propriedades do conjunto de dados

Propriedades da atividade Copy

Salesforce Service Cloud como um tipo de origem

Salesforce Service Cloud como um tipo de coletor

Dicas de consulta

Recuperar dados de um relatório do Salesforce Service Cloud

Recuperar registros excluídos da Lixeira do Salesforce Service Cloud

Diferença entre a sintaxe de consulta SOQL e SQL

Recuperar dados usando uma cláusula where na coluna DateTime

Erro de MALFORMED_QUERY: truncado

Mapeamento de tipo de dados para o Salesforce Service Cloud

Propriedades da atividade de pesquisa

Próximos passos

Recursos adicionais