Copiare dati da e in Salesforce V2 utilizzando Azure Data Factory o Azure Synapse Analytics

SI APPLICA A: Azure Data Factory Azure Synapse Analytics

Questo articolo descrive come usare l'attività di copia in Azure Data Factory e nelle pipeline di Azure Synapse per copiare dati da e verso Salesforce. Si basa sull'articolo di panoramica dell'attività di copia che presenta informazioni generali sull'attività di copia.

Supported capabilities

Questo connettore Salesforce è supportato per le funzionalità seguenti:

① Azure Integration Runtime ② Runtime di integrazione self-hosted

Per un elenco degli archivi dati supportati come origini o sink, vedere la tabella Archivi dati supportati.

In particolare, il connettore Salesforce supporta:

• Le edizioni Developer, Professional, Enterprise o Unlimited di Salesforce.
• Copia di dati da e verso un dominio personalizzato (il dominio personalizzato può essere configurato sia in ambienti di produzione che in ambienti sandbox).

È possibile impostare in modo esplicito la versione dell'API usata per leggere/scrivere dati tramite apiVersion proprietà nel servizio collegato. Quando si copiano dati in Salesforce, il connettore usa l'API BULK 2.0.

Prerequisites

• In Salesforce deve essere abilitata l'autorizzazione API.

• È necessario configurare le app connesse nel portale di Salesforce facendo riferimento a questo documento ufficiale o alle linee guida dettagliate riportate nei suggerimenti di questo articolo.

  Important

  • L'utente di esecuzione deve avere l'autorizzazione Solo API.
  • L'ora di scadenza del token di accesso può essere modificata tramite i criteri di sessione anziché il token di aggiornamento.

Limiti dell'API Bulk 2.0 di Salesforce

Per eseguire query e inserire dati viene usata l'API Bulk 2.0 di Salesforce. Nell'API Bulk 2.0 i batch vengono creati automaticamente. È possibile inviare fino a 15.000 batch per periodo di 24 ore in sequenza. Se i batch superano il limite, si verificano errori.

Nell'API Bulk 2.0, solo i processi di inserimento consumano batch. Ciò non avviene per i processi di query. Per informazioni dettagliate, vedere Come vengono elaborate le richieste nella Guida per sviluppatori dell'API Bulk 2.0.

Per altre informazioni, vedere la sezione "Limiti generali" in Limiti per sviluppatori di Salesforce.

Get started

Per eseguire l'attività di copia con una pipeline, è possibile usare uno degli strumenti o SDK seguenti:

• Strumento Copia dati
• Il portale di Azure
• .NET SDK
• SDK Python
• Azure PowerShell
• API REST
• Modello di Azure Resource Manager

Creare un servizio collegato a Salesforce tramite l'interfaccia utente

Usare la procedura seguente per creare un servizio collegato a Salesforce nell'interfaccia utente del portale di Azure.

1. Passare alla scheda Gestisci nell'area di lavoro di Azure Data Factory o Synapse e selezionare Servizi collegati, quindi fare clic su Nuovo:

   • Azure Data Factory
   • Azure Synapse

   

2. Cercare Salesforce e selezionare il connettore Salesforce.

   

3. Configurare i dettagli del servizio, testare la connessione e creare il nuovo servizio collegato.

   

Dettagli di configurazione del connettore

Le sezioni seguenti riportano informazioni dettagliate sulle proprietà usate per definire entità specifiche per il connettore Salesforce.

Proprietà del servizio collegato

Per il servizio collegato di Salesforce sono supportate le proprietà seguenti.

Esempio: archiviare le credenziali

{
    "name": "SalesforceLinkedService",
    "properties": {
        "type": "SalesforceV2",
        "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"
        }
    }
}

Esempio: Archiviare le credenziali in Key Vault

{
    "name": "SalesforceLinkedService",
    "properties": {
        "type": "SalesforceV2",
        "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"
        }
    }
}

Esempio: archiviare le credenziali in Key Vault, nonché environmentUrl e clientId

Archiviando le credenziali in Key Vault, oltre a environmentUrl e clientId, è possibile usare più a lungo l'interfaccia utente per modificare le impostazioni. La casella di controllo Specifica contenuti dinamici in formato JSON deve essere selezionata e questa configurazione deve essere eseguita manualmente. Il vantaggio di questo scenario è che è possibile derivare tutte le impostazioni di configurazione da Key Vault invece di parametrizzare qualsiasi elemento qui.

{
    "name": "SalesforceLinkedService",
    "properties": {
        "type": "SalesforceV2",
        "typeProperties": {
            "environmentUrl": {
                "type": "AzureKeyVaultSecret",
                "secretName": "<secret name of environment URL in AKV>",
                "store": {
                    "referenceName": "<Azure Key Vault linked service>",
                    "type": "LinkedServiceReference"
                },
            },
            "authenticationType": "OAuth2ClientCredentials",
            "clientId": {
                "type": "AzureKeyVaultSecret",
                "secretName": "<secret name of client ID in AKV>",
                "store": {
                    "referenceName": "<Azure Key Vault linked service>",
                    "type": "LinkedServiceReference"
                },
            },
            "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"
        }
    }
}

Dataset properties

Per un elenco completo delle sezioni e delle proprietà disponibili per la definizione dei set di dati, vedere l'articolo Set di dati. Questa sezione presenta un elenco delle proprietà supportate dal set di dati Salesforce.

Per copiare dati da e verso Salesforce, impostare la proprietà type del set di dati su SalesforceV2Object. Sono supportate le proprietà seguenti.

Example:

{
    "name": "SalesforceDataset",
    "properties": {
        "type": "SalesforceV2Object",
        "typeProperties": {
            "objectApiName": "MyTable__c"
        },
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Salesforce linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Proprietà dell'attività di copia

Per un elenco completo delle sezioni e delle proprietà disponibili per la definizione delle attività, vedere l'articolo sulle pipeline. Questa sezione presenta un elenco delle proprietà supportate dall'origine e dal sink Salesforce.

Salesforce come tipo di origine

Per copiare dati da Salesforce, impostare il tipo di origine nell'attività di copia su SalesforceV2Source. Nella sezione source dell'attività di copia sono supportate le proprietà seguenti.

Example:

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

Salesforce come tipo di sink

Per copiare dati in Salesforce, impostare il tipo di sink nell'attività di copia su SalesforceV2Sink. Nella sezione sink dell'attività di copia sono supportate le proprietà seguenti.

Esempio: Sink Salesforce in un'attività di copia

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

Mapping dei tipi di dati per Salesforce

Quando si copiano dati da Salesforce, vengono usati i mapping seguenti tra i tipi di dati di Salesforce e i tipi di dati provvisori internamente al servizio. Per informazioni su come l'attività di copia esegue il mapping dello schema di origine e del tipo di dati al sink, vedere Mapping dello schema e del tipo di dati.

Proprietà dell'attività Lookup

Per altre informazioni sulle proprietà, vedere Attività Lookup.

Ciclo di vita e aggiornamento del connettore Salesforce

La tabella seguente illustra la fase di rilascio e i log delle modifiche per versioni diverse del connettore Salesforce:

Aggiornare il connettore Salesforce da V1 a V2

Ecco i passaggi che consentono di aggiornare il connettore Salesforce:

1. Configurare le app connesse nel portale di Salesforce facendo riferimento ai Prerequisiti.

2. Creare un nuovo servizio collegato Salesforce e configurarlo facendo riferimento alle Proprietà del servizio collegato. È anche necessario aggiornare manualmente i set di dati esistenti che si basano sul servizio collegato precedente, modificando ogni set di dati per usare il nuovo servizio collegato.

3. Se si utilizza una query SQL nell'origine dell'attività di copia o nell'attività di ricerca che fa riferimento al servizio collegato V1, è necessario convertirli nella query SOQL. Altre informazioni sulla query SOQL da Salesforce come tipo di origine e Salesforce Object Query Language (SOQL).

4. readBehavior viene sostituito con includeDeletedObjects nell'origine dell'attività di copia o nell'attività di ricerca. Per la configurazione dettagliata, vedere Salesforce come tipo di origine.

Related content

Per un elenco degli archivi dati supportati come origini e sink dall'attività di copia, vedere Archivi dati supportati.