Partager via


Copier des données à partir de ServiceNow V2 à l’aide d’Azure Data Factory ou Synapse Analytics

S’APPLIQUE À : Azure Data Factory Azure Synapse Analytics

Tip

Essayez Data Factory dans Microsoft Fabric, une solution d’analytique en un seul pour les entreprises. Microsoft Fabric couvre tout, du déplacement des données à la science des données, à l’analytique en temps réel, au décisionnel et aux rapports. Découvrez comment démarrer une nouvelle version d’évaluation gratuitement !

Cet article décrit comment utiliser l’activité de copie dans des pipelines Azure Data Factory et Azure Synapse Analytics pour copier des données à partir de ServiceNow. Il s’appuie sur l’article de vue d’ensemble de l’activité de copie qui présente une vue d’ensemble générale de l’activité de copie.

Important

Le connecteur ServiceNow V1 est à l’étape de suppression. Vous êtes recommandé de mettre à niveau le connecteur ServiceNow de V1 vers V2.

Fonctionnalités prises en charge

Ce connecteur ServiceNow est pris en charge pour les activités suivantes :

Fonctionnalités prises en charge IR
Activité de copie (source/-) (1) (2)
Activité de recherche (1) (2)

(1) Runtime d’intégration Azure (2) Runtime d’intégration auto-hébergé

Pour obtenir la liste des magasins de données pris en charge en tant que sources/récepteurs, consultez la table des magasins de données pris en charge .

Le service fournit un pilote intégré pour permettre la connectivité. Vous n'êtes donc pas tenu d'installer manuellement un pilote pour utiliser ce connecteur.

Prerequisite

Pour utiliser ce connecteur, vous devez avoir un rôle avec au moins un accès en lecture aux tables sys_db_object, sys_db_view et sys_dictionary dans ServiceNow.

Pour accéder aux vues dans ServiceNow, vous devez disposer d’un rôle avec au moins un accès en lecture aux tables sys_db_view_table et sys_db_view_table_field.

Mise en route

Pour effectuer l’activité de copie avec un pipeline, vous pouvez utiliser l’un des outils ou kits sdk suivants :

Créer un service lié à ServiceNow à l’aide de l’interface utilisateur

Utilisez les étapes suivantes pour créer un service lié à ServiceNow dans l’interface utilisateur du portail Azure.

  1. Accédez à l’onglet Gérer dans votre espace de travail Azure Data Factory ou Synapse, sélectionnez Services liés, puis cliquez sur Nouveau :

  2. Recherchez ServiceNow et sélectionnez le connecteur ServiceNow.

    Capture d’écran du connecteur ServiceNow.

  3. Configurez les informations du service, testez la connexion et créez le nouveau service lié.

    Capture d’écran de la configuration du service lié pour ServiceNow.

Détails de configuration du connecteur

Les sections suivantes fournissent des informations sur les propriétés utilisées pour définir les entités Data Factory spécifiques du connecteur ServiceNow.

Propriétés du service lié

Les propriétés prises en charge pour le service lié ServiceNow sont les suivantes :

Property Description Required
type La propriété type doit être définie sur : ServiceNowV2 Yes
endpoint Point de terminaison du serveur ServiceNow (http://<instance>.service-now.com). Yes
authenticationType Type d’authentification à utiliser.
Les valeurs autorisées sont : De base, OAuth2
Yes
username Nom d’utilisateur utilisé pour la connexion au serveur ServiceNow pour l’authentification De base et OAuth2. Yes
password Mot de passe correspondant au nom d’utilisateur pour l’authentification De base et OAuth2. Marquez ce champ en tant que SecureString pour le stocker en toute sécurité, ou référencez un secret stocké dans Azure Key Vault. Yes
clientId ID client pour l’authentification OAuth2. Oui pour l’authentification OAuth
clientSecret Secret client pour l’authentification OAuth2. Marquez ce champ en tant que SecureString pour le stocker en toute sécurité, ou référencez un secret stocké dans Azure Key Vault. Oui pour l’authentification OAuth
grantType Spécifie le type de flux OAuth2.0 utilisé par l’application cliente pour accéder au jeton. La valeur par défaut est le mot de passe. Oui pour l’authentification OAuth

Example:

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

Propriétés du jeu de données

Pour obtenir la liste complète des sections et des propriétés disponibles pour définir des jeux de données, consultez l’article sur les jeux de données . Cette section fournit la liste des propriétés prises en charge par le jeu de données ServiceNow.

Pour copier des données à partir de ServiceNow, définissez la propriété de type du jeu de données sur ServiceNowV2Object. Les propriétés prises en charge sont les suivantes :

Property Description Required
type La propriété type du jeu de données doit être définie sur : ServiceNowV2Object Yes
tableName Nom de la table. Yes
valueType Type de valeurs de table ServiceNow. La valeur de cette propriété peut être display ou actual (par défaut). Vous pouvez l’examiner comme un paramètre vrai ou faux lors de l’appel des sysparm_display_valueAPI REST ServiceNow. No

Example

{
    "name": "ServiceNowDataset",
    "properties": {
        "type": "ServiceNowV2Object",
        "typeProperties": {
            "tableName": "<table name>",
            "valueType": "actual"
        },
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<ServiceNow linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Propriétés de l’activité de copie

Pour obtenir la liste complète des sections et des propriétés disponibles pour définir des activités, consultez l’article Pipelines . Cette section fournit la liste des propriétés prises en charge par la source ServiceNow.

ServiceNow en tant que source

Pour copier des données à partir de ServiceNow, définissez le type de source dans l’activité de copie sur ServiceNowV2Source. Les propriétés suivantes sont prises en charge dans la section source de l’activité de copie :

Property Description Required
type La propriété type de la source d’activité de copie doit être définie sur : ServiceNowV2Source Yes
expression Utilisez l’expression pour lire des données. Vous pouvez configurer l’expression dans le générateur de requêtes. Il a la même utilisation que le générateur de conditions dans ServiceNow. Pour obtenir des instructions sur son utilisation, consultez cet article . Vous pouvez également utiliser des paramètres d’expression. Notez que vous devez utiliser la valeur réelle au lieu de la valeur d’affichage. No
Sous : expression
type Type d’expression. Les valeurs peuvent être Constant (valeur par défaut), Unary, Binary, Field et Nary. No
value Valeur de constante. Oui lorsque le type d’expression est Constant ou Field
operators Valeur d’opérateur. Pour plus d’informations sur les opérateurs, consultez Opérateurs disponibles pour les champs de choix contenant la section chaînes de cet article. Oui lorsque le type d’expression est Unary ou Binary
operands Liste des expressions sur lesquelles un opérateur est appliqué. Oui lorsque le type d’expression est Unary ou Binary
pageSize nombre de documents par page du résultat de la requête. Il est recommandé de définir la taille de page entre 5 000 et 10 000 pour permettre les lectures multithread. No
(la valeur par défaut est 300)

Example:

"activities": [
    {
        "name": "CopyFromServiceNow",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<ServiceNow input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ServiceNowV2Source",
                "expression": {
                    "type": "Nary",
                    "operators": [
                        "<"
                    ],
                    "operands": [
                        {
                            "type": "Field",
                            "value": "u_founded"
                        },
                        {
                            "type": "Constant",
                            "value": "2000"
                        }
                    ]
                },
                "pageSize": 300
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Utilisation de paramètres d’expression

Vous pouvez configurer le paramètre d’expression dans le Générateur de requêtes en sélectionnant Ajouter du contenu dynamique. Le type de paramètre doit être Object et la valeur doit suivre le format indiqué dans l’exemple JSON ci-dessous :

 {
	"type": "Nary",
	"operators": [
		"="
	],
	"operands": [
		{
			"type": "Field",
			"value": "col"
		},
		{
			"type": "Constant",
			"value": "val"
		}
	]
}

Voici un exemple de la source JSON utilisant le paramètre d’expression :

"activities": [
    {
        "name": "CopyFromServiceNow",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<ServiceNow input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "ServiceNowV2Source",
                "expression": {
                    "type": "Expression",
                    "value": "@pipeline().parameters.expressionParameter"
                }
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Note

La colonne sys_tags et ses colonnes dérivées ne peuvent pas être obtenues en raison des limitations de l’API ServiceNow.

Propriétés de l’activité Lookup

Pour en savoir plus sur les propriétés, consultez l’activité de recherche.

Mettre à niveau le connecteur ServiceNow

Voici les étapes qui vous aideront à mettre à niveau votre connecteur ServiceNow :

  1. Créez un service lié en faisant référence aux propriétés du service lié.
  2. La requête dans la source est mise à niveau vers le générateur de requêtes, qui a la même utilisation que le générateur de conditions dans ServiceNow. Découvrez comment la configurer en faisant référence à ServiceNow en tant que source.

Différences entre ServiceNow V2 et V1

Le connecteur ServiceNow V2 offre de nouvelles fonctionnalités et est compatible avec la plupart des fonctionnalités du connecteur ServiceNow V1. Le tableau ci-dessous présente les différences de fonctionnalités entre V2 et V1.

ServiceNow V2 ServiceNow V1
useEncryptedEndpoints, useHostVerification et usePeerVerification ne sont pas pris en charge dans le service lié. Prend en charge useEncryptedEndpoints, useHostVerification et usePeerVerification dans le service lié.
Soutenir le générateur de requêtes dans la source. Le générateur de requêtes n’est pas pris en charge dans la source.
Les requêtes SQL ne sont pas prises en charge. Prend en charge les requêtes SQL.
Les requêtes sortBy ne sont pas prises en charge dans le Générateur de requêtes. Prise en charge des requêtes sortBy dans Query.
Vous pouvez afficher le schéma dans le jeu de données. Vous ne pouvez pas afficher le schéma dans le jeu de données.
Vous pouvez configurer valueType vers display ou actual dans des jeux de données. Le nom d’affichage ou de table réel est utilisé comme valeur de tableName.

Le nom de colonne est [column name] à la fois pour l’affichage et la valeur réelle.
Le nom d’affichage ou de table réel avec le préfixe « Affichage » ou « Réel » ajouté est utilisé comme valeur de tableName.

Le nom de colonne de la valeur réelle est [column name]_value, tandis que pour la valeur d’affichage est [column name]_display_value.

Pour obtenir la liste des magasins de données pris en charge en tant que sources et récepteurs par l’activité de copie, consultez les magasins de données pris en charge.