Copia de datos en Salesforce con origen y destino mediante Azure Data Factory o Azure Synapse Analytics

Artículo
04/23/2024

SE APLICA A: Azure Data Factory Azure Synapse Analytics

Sugerencia

Pruebe Data Factory en Microsoft Fabric, una solución de análisis todo en uno para empresas. Microsoft Fabric abarca todo, desde el movimiento de datos hasta la ciencia de datos, el análisis en tiempo real, la inteligencia empresarial y los informes. Obtenga información sobre cómo iniciar una nueva evaluación gratuita.

En este artículo se resume el uso de la actividad de copia en canalizaciones de Azure Data Factory y Azure Synapse para copiar datos con Salesforce como origen y destino. El documento se basa en el artículo de introducción a la actividad de copia que presenta información general de la actividad de copia.

Importante

El nuevo conector de Salesforce proporciona compatibilidad nativa mejorada con Salesforce. Si usa la versión heredada del conector de Salesforce en la solución, que se admite tal cual solo en el caso de la compatibilidad con versiones anteriores, consulte el artículo Conector de Salesforce (heredado).

Funcionalidades admitidas

Este conector de Salesforce es compatible con las funcionalidades siguientes:

Funcionalidades admitidas	IR
Actividad de copia (origen/receptor)	① ②
Actividad de búsqueda	① ②

① Azure Integration Runtime ② Entorno de ejecución de integración autohospedado

Para obtener una lista de los almacenes de datos que se admiten como orígenes o receptores, consulte la tabla de almacenes de datos admitidos.

En concreto, este conector de Salesforce admite:

Ediciones de Salesforce Developer, Professional, Enterprise o Unlimited.
Copia de datos desde y hacia el dominio personalizado (el dominio personalizado puede configurarse tanto en entornos de producción como de espacio aislado).

Puede establecer de forma explicita la versión de la API que se va a usar para leer y escribir datos a través de propiedad apiVersion en el servicio vinculado. Al copiar datos a Salesforce, el conector usa la API BULK 2.0.

Requisitos previos

El permiso API debe estar habilitado en Salesforce.
Debe configurar las aplicaciones conectadas en el portal de Salesforce consultando este documento oficial o nuestra guía paso a paso en la recomendación de este artículo.
Importante
- El usuario de ejecución debe tener el permiso Solo API.
- El tiempo de expiración del token de acceso podría cambiarse en lugar del token de actualización mediante directivas de sesión.

Límites de la API Salesforce Bulk 2.0

Usamos la API Salesforce Bulk 2.0 para consultar e ingerir datos. En la API Bulk 2.0, los lotes se crean automáticamente. Puede enviar hasta 15 000 lotes por periodo gradual de 24 horas. Si los lotes superan el límite, verá errores.

En la API Bulk 2.0, solo los trabajos de ingesta consumen lotes. Los trabajos de consulta no. Para obtener más información, consulte Cómo se procesan las solicitudes en la Guía para desarrolladores de API Bulk 2.0.

Para obtener más información, consulte la sección "Límites generales" en Límites de desarrollador de Salesforce.

Introducción

Para realizar la actividad de copia con una canalización, puede usar una de los siguientes herramientas o SDK:

Creación de un servicio vinculado a Salesforce mediante la interfaz de usuario

Siga estos pasos para crear un servicio vinculado a Salesforce en la interfaz de usuario de Azure Portal.

Vaya a la pestaña Administrar del área de trabajo de Azure Data Factory o Synapse y seleccione Servicios vinculados; luego haga clic en Nuevo:
- Azure Data Factory
- Azure Synapse
Busque Salesforce y seleccione el conector de Salesforce.
Configure los detalles del servicio, pruebe la conexión y cree el nuevo servicio vinculado.

Detalles de configuración del conector

En las secciones siguientes se proporcionan detalles sobre las propiedades que se usan para definir entidades específicas para el conector de Salesforce.

Propiedades del servicio vinculado

Las siguientes propiedades son compatibles con el servicio vinculado Salesforce.

Propiedad	Descripción	Obligatorio
type	La propiedad type debe establecerse en SalesforceV2.	Sí
environmentUrl	Especifique la URL de la instancia de Salesforce. Por ejemplo, especifique `"https://<domainName>.my.salesforce.com"` para copiar datos del dominio personalizado. Obtén información sobre cómo configurar o ver el dominio personalizado consultando este artículo.	Sí
authenticationType	Tipo de autenticación que se usa para conectarse a Salesforce. El valor permitido es OAuth2ClientCredentials.	Sí
clientId	Especifica el Id. de cliente de la aplicación conectada de Salesforce OAuth 2.0. Para obtener más información, consulta este artículo.	Sí
clientSecret	Especifica el secreto de cliente de la aplicación conectada de Salesforce OAuth 2.0. Para obtener más información, consulta este artículo.	Sí
apiVersion	Especifica la versión de la API Bulk 2.0 de Salesforce que se va a usar, por ejemplo, `52.0`. API Bulk 2.0 solo admite la versión de API >= 47.0. Para obtener información sobre la versión de API Bulk 2.0, consulta este artículo. Si usas una versión de API inferior, se producirá un error.	Sí
connectVia	El entorno de ejecución de integración que se usará para conectarse al almacén de datos. Si no se especifica, se usará Azure Integration Runtime.	No

Ejemplo: Almacenamiento de credenciales

{
    "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"
        }
    }
}

Ejemplo: Almacenamiento de credenciales en 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"
        }
    }
}

Ejemplo: Almacenar credenciales en Key Vault, así como environmentUrl y clientId

Tenga en cuenta que, al hacerlo, ya no podrá usar la interfaz de usuario para editar la configuración. La casilla Especificar contenido dinámico en formato JSON se activará y tendrá que editar esta configuración por completo a mano. La ventaja es que puede derivar TODAS las opciones de configuración de Key Vault en lugar de parametrizar nada aquí.

{
    "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"
        }
    }
}

Propiedades del conjunto de datos

Si desea ver una lista completa de las secciones y propiedades disponibles para definir conjuntos de datos, consulte el artículo sobre conjuntos de datos. En esta sección se proporciona una lista de las propiedades que admite el conjunto de datos de Salesforce.

Para copiar datos desde y hacia Salesforce, establezca la propiedad type del conjunto de datos en SalesforceV2Object. Se admiten las siguientes propiedades.

Propiedad	Descripción	Obligatorio
type	La propiedad type debe establecerse en SalesforceV2Object.	Sí
objectApiName	El nombre del objeto de Salesforce desde el que se van a recuperar los datos.	No para el origen (si se especifica "SOQLQuery" en el origen); Sí para el receptor
reportId	El id. del informe de Salesforce desde el que se van a recuperar los datos. No se admite en el receptor. Ten en cuenta que hay limitaciones cuando se usan informes.	No para el origen (si se especifica "SOQLQuery" en el origen); no admite el receptor

Importante

La parte "__c" del nombre de la API es necesaria para cualquier objeto personalizado.

Nombre de API de la conexión a Salesforce

Ejemplo:

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

Propiedades de la actividad de copia

Si desea ver una lista completa de las secciones y propiedades disponibles para definir actividades, consulte el artículo sobre canalizaciones. En esta sección se proporciona una lista de las propiedades admitidas por el origen y el receptor de Salesforce.

Salesforce como tipo de origen

Para copiar datos desde Salesforce, establezca el tipo de origen de la actividad de copia en SalesforceV2Source. En la sección source de la actividad de copia se admiten las siguientes propiedades.

Propiedad	Descripción	Obligatorio
type	La propiedad type del origen de la actividad de copia debe establecerse en: SalesforceV2Source.	Sí
SOQLQuery	Utilice la consulta personalizada para leer los datos. Solo puede utilizar la consulta Salesforce Object Query Language (SOQL) con limitaciones. Para conocer las limitaciones de SOQL, consulte este artículo. Si no se especifica la consulta, se recuperarán todos los datos del objeto de Salesforce especificado en "ObjectApiName/reportId" en el conjunto de datos.	No (si se especifica "ObjectApiName/reportId" en el conjunto de datos)
includeDeletedObjects	Indica si se van a consultar los registros existentes o todos, incluso los que se eliminaron. Si no se especifica, el comportamiento predeterminado es falso. Valores permitidos: falso (predeterminado), verdadero.	No

Importante

La parte "__c" del nombre de la API es necesaria para cualquier objeto personalizado.

Conexión a Salesforce - Lista de nombres de API

Ejemplo:

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

Salesforce como tipo de receptor

Para copiar datos hacia Salesforce, establezca el tipo de receptor de la actividad de copia en SalesforceV2Sink. En la sección sink de la actividad de copia se admiten las siguientes propiedades.

Propiedad	Descripción	Obligatorio
type	La propiedad type del receptor de la actividad de copia debe establecerse en SalesforceV2Sink.	Sí
writeBehavior	El comportamiento de escritura de la operación. Los valores permitidos son: Insert y Upsert.	No (el valor predeterminado es Insert)
externalIdFieldName	El nombre del campo de identificador externo para la operación de upsert. El campo especificado debe definirse como "Campo de identificador externo" en el objeto de Salesforce. No puede tener valores NULL en los datos de entrada correspondientes.	Sí para "Upsert"
writeBatchSize	El recuento de filas de datos escritos en Salesforce en cada lote. Sugiera establecer este valor de 10 000 a 200 000. Las filas demasiado pequeñas de cada lote reducirán el rendimiento de la copia. Demasiadas filas de cada lote pueden provocar un tiempo de espera de la API.	No (el valor predeterminado es 100 000)
ignoreNullValues	Indica si se omiten los valores NULL de los datos de entrada durante la operación de escritura. Los valores permitidos son true y false. - True: deje los datos del objeto de destino sin cambiar cuando realice una operación upsert o update. Inserta un valor predeterminado definido al realizar una operación insert. - False: actualice los datos del objeto de destino a NULL cuando realice una operación upsert o update. Inserta un valor NULL al realizar una operación insert.	No (el valor predeterminado es false)
maxConcurrentConnections	Número máximo de conexiones simultáneas establecidas en el almacén de datos durante la ejecución de la actividad. Especifique un valor solo cuando quiera limitar las conexiones simultáneas.	No

Ejemplo: receptor de Salesforce en la actividad de 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
            }
        }
    }
]

Asignación de tipos de datos para Salesforce

Al copiar datos desde Salesforce, se usan las siguientes asignaciones de tipos de datos de Salesforce en los tipos de datos provisionales del servicio. Para más información acerca de la forma en que la actividad de copia asigna el tipo de datos y el esquema de origen al receptor, consulte el artículo sobre asignaciones de tipos de datos y esquema.

Tipos de datos de Salesforce	Tipo de datos provisional del servicio
Numeración automática	String
Casilla de verificación	Boolean
Moneda	Decimal
Date	DateTime
Fecha y hora	DateTime
Email	String
ID	String
Relación de búsqueda	String
Lista desplegable de selección múltiple	String
Number	Decimal
Percent	Decimal
Teléfono	String
Lista desplegable	String
Texto	String
Área de texto	String
Área de texto (largo)	String
Área de texto (enriquecido)	String
Texto (cifrado)	String
URL	String

Nota:

El tipo de número de Salesforce se asigna al tipo decimal en Azure Data Factory y en canalizaciones de Azure Synapse como un tipo de datos provisional de servicio. El tipo decimal respeta la precisión y la escala definidas. En el caso de los datos cuyas posiciones decimales superen la escala definida, el valor se redondeará en los datos y la copia de vista previa. Para evitar la pérdida de precisión en las canalizaciones de Azure Data Factory y Azure Synapse, considere la posibilidad de aumentar las posiciones decimales a un valor razonablemente alto en la página Edición de definición de campo personalizado de Salesforce.

Propiedades de la actividad de búsqueda

Para obtener información detallada sobre las propiedades, consulte Actividad de búsqueda.

Actualización del servicio vinculado de Salesforce

Estos son los pasos que le ayudarán a actualizar el servicio vinculado y las consultas relacionadas:

Configure las aplicaciones conectadas en el portal de Salesforce; para ello, consulte los Requisitos previos.
Cree un servicio vinculado de Salesforce y configúrelo consultando las propiedades del servicio vinculado.
Si usa una consulta SQL en el origen de la actividad de copia o en la actividad de búsqueda que hace referencia al servicio vinculado heredado, debe convertirlos a la consulta SOQL. Obtenga más información sobre la consulta SOQL de Salesforce como un tipo de origen y Salesforce Object Query Language (SOQL).
readBehavior se reemplaza por includeDeletedObjects en el origen de la actividad de copia o la actividad de búsqueda. Para obtener la configuración detallada, consulte Salesforce como un tipo de origen.

Diferencias entre Salesforce y Salesforce (heredado)

El conector de Salesforce ofrece nuevas funcionalidades y es compatible con la mayoría de las características del conector de Salesforce (heredado). En la tabla siguiente se muestran las diferencias de características entre Salesforce y Salesforce (heredado).

Salesforce	Salesforce (heredado)
Compatibilidad con SOQL dentro de Salesforce Bulk API 2.0. Para consultas SOQL: • Las cláusulas GROUP BY, LIMIT, ORDER BY, OFFSET o TYPEOF no son admitidas. • No se admiten funciones agregadas como COUNT(), puede utilizar los informes de Salesforce para implementarlas. • Las funciones de fecha en las cláusulas GROUP BY no son admitidas, pero sí lo son en la cláusula WHERE. • No se admiten los campos de direcciones compuestas ni campos de geolocalización compuesta. Como alternativa, consulte los componentes individuales de los campos compuestos. • No se admiten consultas de relación de elementos primarios a secundarios, mientras que se admiten consultas de relación de elementos secundarios a primarios.	Admite la sintaxis SQL y SOQL.
No se admiten objetos que contengan campos binarios.	Los objetos que contienen campos binarios son compatibles, como el objeto Adjunto.
Se admiten objetos dentro de Bulk API. Para obtener más información, consulte este artículo.	Se admiten objetos que no son compatibles con Bulk API, como CaseStatus.
Admita el informe seleccionando un Id. de informe.	Sintaxis de consulta de informes, como `{call "<report name>"}`.

Para obtener una lista de almacenes de datos que la actividad de copia admite como orígenes y receptores, vea Almacenes de datos que se admiten.

Copia de datos en Salesforce con origen y destino mediante Azure Data Factory o Azure Synapse Analytics

Funcionalidades admitidas

Requisitos previos

Límites de la API Salesforce Bulk 2.0

Introducción

Creación de un servicio vinculado a Salesforce mediante la interfaz de usuario

Detalles de configuración del conector

Propiedades del servicio vinculado

Propiedades del conjunto de datos

Propiedades de la actividad de copia

Salesforce como tipo de origen

Salesforce como tipo de receptor

Asignación de tipos de datos para Salesforce

Propiedades de la actividad de búsqueda

Actualización del servicio vinculado de Salesforce

Diferencias entre Salesforce y Salesforce (heredado)

Contenido relacionado

Recursos adicionales