Copia de datos en Salesforce Service Cloud con origen y destino mediante Azure Data Factory o Synapse Analytics (versión heredada)

Artículo
03/13/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 Synapse Analytics para copiar datos con Salesforce Service Cloud 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 servicio ha publicado un nuevo conector de Salesforce Service Cloud, que proporciona una mejor compatibilidad nativa con Salesforce Service Cloud; para obtener más información, consulte el artículo Conector de Salesforce Service Cloud.

Funcionalidades admitidas

Este conector de Salesforce Service Cloud 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 compatibles.

En concreto, este conector de Salesforce Service Cloud admite:

Ediciones de Salesforce Developer, Professional, Enterprise o Unlimited.
La copia de datos desde y hacia producción, espacio aislado y dominio personalizado de Salesforce.

El conector de Salesforce se basa en la API REST/Bulk de Salesforce. De forma predeterminada, al copiar datos de Salesforce, el conector usa v45 y elige automáticamente entre la API de REST y Bulk API en función del tamaño de los datos: cuando el conjunto de resultados es grande, se usa Bulk API para obtener un rendimiento mayor; al escribir datos en Salesforce, el conector utiliza v40 de Bulk API. También 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 apiVersion propiedad en el servicio vinculado.

Prerrequisitos

El permiso API debe estar habilitado en Salesforce.

Límites de solicitudes de Salesforce

Salesforce tiene límites para el número total de solicitudes de API y el de solicitudes de API simultáneas. Tenga en cuenta los siguientes puntos:

Si el número de solicitudes simultáneas supera el límite, se produce la limitación y verá errores aleatorios.
Si el número total de solicitudes supera el límite, la cuenta de Salesforce se bloqueará durante 24 horas.

También podría recibir el mensaje de error "REQUEST_LIMIT_EXCEEDED" en ambos escenarios. Consulte la sección "API Request Limits" (Límites de solicitudes de API) en Salesforce Developer Limits (Límites de Salesforce Developer) para más información.

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 Service Cloud mediante la interfaz de usuario

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

Vaya a la pestaña "Administrar" de su área de trabajo de Azure Data Factory o Synapse y seleccione "Servicios vinculados"; a continuación, haga clic en "Nuevo":
- Azure Data Factory
- Azure Synapse
Busque Salesforce y seleccione el conector de Salesforce Service Cloud.
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 de Data Factory específicas del conector de Salesforce Service Cloud.

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 SalesforceServiceCloud.	Sí
environmentUrl	Especifique la dirección URL de la instancia de Salesforce Service Cloud. - El valor predeterminado es `"https://login.salesforce.com"`. - Para copiar datos desde el espacio aislado, especifique `"https://test.salesforce.com"`. - Para copiar datos del dominio personalizado, especifique, por ejemplo, `"https://[domain].my.salesforce.com"`.	No
username	Especifique el nombre de usuario de la cuenta de usuario.	Sí
password	Especifique la contraseña para la cuenta de usuario. Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault.	Sí
securityToken	Especifique el token de seguridad para la cuenta de usuario. Para más información acerca de los tokens de seguridad en general, consulte Security and the API(Seguridad y la API). El token de seguridad solo se puede omitir si agrega la dirección IP de Integration Runtime a la lista de direcciones IP de confianza en Salesforce. Cuando use Azure IR, consulte Direcciones IP de Azure Integration Runtime. Para obtener instrucciones sobre cómo restablecer u obtener un token de seguridad consulte el artículo sobre obtención de un token de seguridad. Marque este campo como SecureString para almacenarlo de forma segura en Data Factory o para hacer referencia a un secreto almacenado en Azure Key Vault.	No
apiVersion	Especifique la versión de la API REST/Bulk de Salesforce que se va a usar, por ejemplo, `48.0`. De forma predeterminada, el conector usa V45 para copiar datos de Salesforce y v40 para copiar datos en Salesforce.	No
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": "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"
        }
    }
}

Ejemplo: Almacenamiento de credenciales en Key Vault

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

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 compatibles con el conjunto de datos de Salesforce Service Cloud.

Para copiar datos con Salesforce Service Cloud como origen y destino, se admiten las siguientes propiedades.

Propiedad	Descripción	Obligatorio
type	La propiedad type debe establecerse en SalesforceServiceCloudObject.	Sí
objectApiName	El nombre del objeto de Salesforce desde el que se van a recuperar los datos.	No para el origen, sí para el receptor

Importante

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

Salesforce connection API Name

Ejemplo:

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

Propiedad	Descripción	Obligatorio
type	La propiedad type del conjunto de datos debe establecerse en: RelationalTable.	Sí
tableName	Nombre de la tabla de Salesforce Service Cloud.	No (si se especifica "query" en el origen de la actividad)

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 Service Cloud.

Salesforce Service Cloud como tipo de origen

Para copiar datos de Salesforce Service Cloud, en la sección source (origen) 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 SalesforceServiceCloudSource.	Sí
Query	Utilice la consulta personalizada para leer los datos. Puede usar una consulta de SQL-92 o de Salesforce Object Query Language (SOQL). Consulte más sugerencias en la sección Sugerencias de consulta. Si no se especifica la consulta, se recuperarán todos los datos del objeto de Salesforce Service Cloud especificado en "objectApiName" en el conjunto de datos.	No (si se especifica "objectApiName" en el conjunto de datos)
readBehavior	Indica si se van a consultar los registros existentes o todos, incluso los que se eliminaron. Si no se especifica, el comportamiento predeterminado es el primero. Valores permitidos: query (valor predeterminado), queryAll.	No

Importante

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

Salesforce connection API Name list

Ejemplo:

"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

El origen de Salesforce Service Cloud no admite la configuración de proxy en el entorno de ejecución de integración autohospedado, pero sí lo hace el receptor.

Salesforce Service Cloud como un tipo de receptor

Para copiar datos a Salesforce Service Cloud, en la sección source (origen) 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: SalesforceServiceCloudSink.	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 Service Cloud. No puede tener valores NULL en los datos de entrada correspondientes.	Sí para "Upsert"
writeBatchSize	El recuento de filas de datos escritos en Salesforce Service Cloud en cada lote.	No (el valor predeterminado es 5000)
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:

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

Sugerencias de consulta

Recuperación de datos a partir de un informe de Salesforce Service Cloud

Puede recuperar datos de informes de Salesforce Service Cloud especificando una consulta como {call "<report name>"}. Un ejemplo es "query": "{call \"TestReport\"}".

Recuperación de los registros eliminados desde la papelera de reciclaje de Salesforce Service Cloud

Para consultar los registros eliminados temporalmente de la papelera de reciclaje de Salesforce Service Cloud, puede especificar readBehavior como queryAll.

Diferencias entre la sintaxis de consulta SQL y SOQL

Al copiar datos de Salesforce Service Cloud, puede usar consultas SOQL o consultas SQL. Tenga en cuenta que estas dos tienen diferente compatibilidad con sintaxis y funciones, no las mezcle. Es recomendable que use la consulta SOQL que se admite de forma nativa en Salesforce Service Cloud. En la tabla siguiente se muestran las diferencias principales:

Sintaxis	Modo SOQL	Modo SQL
Selección de columnas	Necesita enumerar los campos que se van a copiar en la consulta, por ejemplo `SELECT field1, filed2 FROM objectname`.	`SELECT *` se admite además de la selección de columna.
Comillas	Los nombres de objetos o de campos no pueden entrecomillarse.	Los nombres de objetos o de campos no pueden entrecomillarse, por ejemplo `SELECT "id" FROM "Account"`.
Formato de fecha y hora	Consulte más detalles aquí y ejemplos en la sección siguiente.	Consulte más detalles aquí y ejemplos en la sección siguiente.
Valores booleanos	Se representan como `False` y `True`, por ejemplo, `SELECT … WHERE IsDeleted=True`.	Se representan como 0 o 1, por ejemplo `SELECT … WHERE IsDeleted=1`.
Cambio del nombre de la columna	No compatible.	Admitido, por ejemplo: `SELECT a AS b FROM …`.
Relación	Admitido, por ejemplo: `Account_vod__r.nvs_Country__c`.	No compatible.

Recuperación de datos mediante el uso de una cláusula where en la columna DateTime

Cuando se especifica la consulta SQL o SOQL, preste atención a la diferencia del formato de fecha y hora. Por ejemplo:

Ejemplo 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')}
Ejemplo 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')}'}

Error de MALFORMED_QUERY: Truncated

Si aparece un error "MALFORMED_QUERY: Truncated", normalmente se debe a que tiene la columna de tipo JunctionIdList en datos y Salesforce tiene una restricción en cuanto a la admisión de tales datos con un gran número de filas. Para solucionarlo, pruebe a excluir la columna JunctionIdList o limite el número de filas que desea copiar (puede dividir el proceso en varias ejecuciones de la actividad de copia).

Asignación de tipos de datos para Salesforce Service Cloud

Al copiar datos de Salesforce Service Cloud, se usan las siguientes asignaciones de tipos de datos de Salesforce Service Cloud en los tipos de datos provisionales que se utilizan internamente dentro 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.

Tipo de datos de Salesforce Service Cloud	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 Service Cloud 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, considera 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 Service Cloud.

Propiedades de la actividad de búsqueda

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

Pasos siguientes

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 Service Cloud con origen y destino mediante Azure Data Factory o Synapse Analytics (versión heredada)

Funcionalidades admitidas

Prerrequisitos

Límites de solicitudes de Salesforce

Introducción

Creación de un servicio vinculado a Salesforce Service Cloud 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 Service Cloud como tipo de origen

Salesforce Service Cloud como un tipo de receptor

Sugerencias de consulta

Recuperación de datos a partir de un informe de Salesforce Service Cloud

Recuperación de los registros eliminados desde la papelera de reciclaje de Salesforce Service Cloud

Diferencias entre la sintaxis de consulta SQL y SOQL

Recuperación de datos mediante el uso de una cláusula where en la columna DateTime

Error de MALFORMED_QUERY: Truncated

Asignación de tipos de datos para Salesforce Service Cloud

Propiedades de la actividad de búsqueda

Pasos siguientes

Recursos adicionales