Copia de datos de ServiceNow con Azure Data Factory o Synapse Analytics

Artículo
10/20/2023

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 más 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 de ServiceNow. El documento se basa en el artículo de introducción a la actividad de copia que describe información general de la actividad de copia.

Funcionalidades admitidas

Este conector ServiceNow es compatible con las funcionalidades siguientes:

Funcionalidades admitidas	IR
Actividad de copia (origen/-)	7,7
Actividad de búsqueda	7,7

① 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 y receptores, consulte la tabla de almacenes de datos admitidos.

El servicio proporciona un controlador integrado para permitir la conectividad. Por lo tanto, no es necesario instalar manualmente ningún controlador con este conector.

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

Siga estos pasos para crear un servicio vinculado a ServiceNow 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 ServiceNow y seleccione el conector de ServiceNow.
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 para el conector de ServiceNow.

Propiedades del servicio vinculado

Las siguientes propiedades son compatibles con el servicio vinculado de ServiceNow:

Propiedad	Descripción	Obligatorio
type	La propiedad type debe establecerse en: ServiceNow	Sí
endpoint	El punto de conexión del servidor de ServiceNow (`http://<instance>.service-now.com`).	Sí
authenticationType	Tipo de autenticación que se debe usar. Los valores permitidos son: Basic y OAuth2	Sí
username	Nombre de usuario utilizado para conectarse al servidor de ServiceNow para la autenticación Basic y OAuth2.	Sí
password	Contraseña correspondiente al nombre de usuario para la autenticación Basic y OAuth2. Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault.	Sí
clientId	Id. de cliente para la autenticación OAuth2.	No
clientSecret	Secreto de cliente para la autenticación OAuth2. Marque este campo como SecureString para almacenarlo de forma segura, o bien haga referencia a un secreto almacenado en Azure Key Vault.	No
useEncryptedEndpoints	Especifica si los puntos de conexión de origen de datos se cifran mediante HTTPS. El valor predeterminado es true.	No
useHostVerification	Especifica si se requiere que el nombre de host del certificado del servidor coincida con el nombre de host del servidor al conectarse a través de TLS. El valor predeterminado es true.	No
usePeerVerification	Especifica si se debe verificar la identidad del servidor al conectarse a través de TLS. El valor predeterminado es true.	No

Ejemplo:

{
    "name": "ServiceNowLinkedService",
    "properties": {
        "type": "ServiceNow",
        "typeProperties": {
            "endpoint" : "http://<instance>.service-now.com",
            "authenticationType" : "Basic",
            "username" : "<username>",
            "password": {
                 "type": "SecureString",
                 "value": "<password>"
            }
        }
    }
}

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 ServiceNow.

Para copiar datos de ServiceNow, establezca la propiedad type del conjunto de datos en ServiceNowObject. Se admiten las siguientes propiedades:

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

Ejemplo

{
    "name": "ServiceNowDataset",
    "properties": {
        "type": "ServiceNowObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<ServiceNow 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 compatibles con el origen de ServiceNow.

ServiceNow como origen

Para copiar datos de ServiceNow, establezca el tipo de origen de la actividad de copia en ServiceNowSource. Se admiten las siguientes propiedades en la sección source de la actividad de copia:

Propiedad	Descripción	Obligatorio
type	La propiedad type del origen de la actividad de copia debe establecerse en: ServiceNowSource	Sí
Query	Use la consulta SQL personalizada para leer los datos. Por ejemplo: `"SELECT * FROM Actual.alm_asset"`.	No (si se especifica "tableName" en el conjunto de datos)

Tenga en cuenta lo siguiente cuando especifique el esquema y la columna para ServiceNow en la consulta, y consulte los consejos de rendimiento en la implicación de rendimiento de copia.

Esquema: especifique el esquema como Actual o Display en la consulta de ServiceNow, que puede considerar como el parámetro de sysparm_display_value verdadero o falso al llamar a las API de REST de ServiceNow.
Columna: el nombre de columna del valor real del esquema Actual es [column name]_value, mientras que el valor de visualización del esquema Display es [column name]_display_value. Tenga en cuenta que el nombre de columna se debe asignar al esquema que se usa en la consulta.

Consulta de ejemplo:SELECT col_value FROM Actual.alm_asset O SELECT col_display_value FROM Display.alm_asset

Ejemplo:

"activities":[
    {
        "name": "CopyFromServiceNow",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<ServiceNow input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ServiceNowSource",
                "query": "SELECT * FROM Actual.alm_asset"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Consejos de rendimiento

Esquema que se va a usar

ServiceNow tiene dos esquemas diferentes: uno se denomina "Real" , ya que devuelve los datos reales y el otro se denomina "Mostrar" , ya que devuelve los valores de visualización de datos.

Si tiene un filtro en su consulta, use el esquema "Real" que tenga un mejor rendimiento de copia. Al realizar una consulta con el esquema "Real", ServiceNow admite de forma nativa el filtro al obtener los datos que usará para devolver solo el conjunto de resultados filtrado; asimismo, al consultar el esquema "Mostrar", ADF recupera todos los datos y aplica el filtro internamente.

Índice

El índice de la tabla de ServiceNow puede ayudarle a mejorar el rendimiento de las consultas; para ello, consulte Create a table index (Crear un índice de tabla).

Propiedades de la actividad de búsqueda

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

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.