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

S’APPLIQUE À : Azure Data Factory Azure Synapse Analytics

Cet article explique comment utiliser l’activité de copie dans le pipeline Azure Data Factory ou Synapse Analytics pour copier des données de Xero. Il s’appuie sur l’article Vue d’ensemble de l’activité de copie.

Fonctionnalités prises en charge

Ce connecteur Xero est pris en charge pour les fonctionnalités suivantes :

① Runtime d’intégration Azure ② Runtime d’intégration auto-hébergé

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

Plus précisément, ce connecteur Xero prend en charge ce qui suit :

• Authentification OAuth 2.0
• Toutes les tables Xero (points de terminaison d’API) à l’exception de « Reports ».
• Versions Windows dans cet article.

Prise en main

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

• Outil Copier des données
• portail Azure
• Kit de développement logiciel (SDK) .NET
• Kit de développement logiciel (SDK) Python
• Azure PowerShell
• REST API
• Modèle Azure Resource Manager

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

Utilisez les étapes suivantes pour créer un service lié à Xero 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 :

   • Azure Data Factory.
   • Azure Synapse

   

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

   

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

   

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

Propriétés du service lié

Le connecteur Xero prend désormais en charge la version 2.0. Reportez-vous à cette section pour mettre à niveau votre version de connecteur Xero à partir de la version 1.0. Pour plus d’informations sur la propriété, consultez les sections correspondantes.

• Version 2.0
• Version 1.0

Version 2.0

Le service lié Xero prend en charge les propriétés suivantes lors de l’application de la version 2.0 :

Exemple :

{
    "name": "XeroLinkedService",
    "properties": {
        "type": "Xero",
        "typeProperties": {
            "host": "api.xero.com",
            "clientId": "<client ID>",
            "clientSecret": "<client secret>",
            "tenantId": "<tenant ID>", 
            "refreshToken": {
                "type": "SecureString",
                "value": "<refresh token>"
            },
            "authenticationType":"OAuth_2.0", 
            "version": "2.0"         
        }
    }
}

Version 1.0

Le service lié Xero prend en charge les propriétés suivantes lors de l’application de la version 1.0 :

Exemple : Authentification OAuth 2.0

{
    "name": "XeroLinkedService",
    "properties": {
        "type": "Xero",
        "typeProperties": {
            "connectionProperties": { 
                "host": "api.xero.com",
                "authenticationType":"OAuth_2.0", 
                "consumerKey": {
                    "type": "SecureString",
                    "value": "<client ID>"
                },
                "privateKey": {
                    "type": "SecureString",
                    "value": "<client secret>"
                },
                "tenantId": "<tenant ID>", 
                "refreshToken": {
                    "type": "SecureString",
                    "value": "<refresh token>"
                }, 
                "useEncryptedEndpoints": true, 
                "useHostVerification": true, 
                "usePeerVerification": true
            }            
        }
    }
}

Exemple : Authentification OAuth 1.0

{
    "name": "XeroLinkedService",
    "properties": {
        "type": "Xero",
        "typeProperties": {
            "connectionProperties": {
                "host": "api.xero.com", 
                "authenticationType":"OAuth_1.0", 
                "consumerKey": {
                    "type": "SecureString",
                    "value": "<consumer key>"
                },
                "privateKey": {
                    "type": "SecureString",
                    "value": "<private key>"
                }, 
                "useEncryptedEndpoints": true,
                "useHostVerification": true,
                "usePeerVerification": true
            }
        }
    }
}

Exemple de valeur de clé privée :

Inclut tout le texte du fichier .pem, y compris les fins de ligne Unix (\n).

"-----BEGIN RSA PRIVATE KEY-----\nMII***************************************************P\nbu****************************************************s\nU/****************************************************B\nA*****************************************************W\njH****************************************************e\nsx*****************************************************l\nq******************************************************X\nh*****************************************************i\nd*****************************************************s\nA*****************************************************dsfb\nN*****************************************************M\np*****************************************************Ly\nK*****************************************************Y=\n-----END RSA PRIVATE KEY-----"

Propriétés du jeu de données

Pour obtenir la liste complète des sections et propriétés disponibles pour la définition de 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 Xero.

Pour copier des données de Xero, affectez la valeur XeroObject à la propriété de type du jeu de données. Les propriétés prises en charge sont les suivantes :

Exemple

{
    "name": "XeroDataset",
    "properties": {
        "type": "XeroObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<Xero linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Le connecteur version 2.0 prend en charge les tables Xero suivantes :

• Accounts
• Bank_Transaction_Line_Items
• Transferts_bancaires
• Budgets
• Contacts_Addresses
• Contact_Group_Contacts
• Contacts_Phones
• Éléments de ligne de note de crédit
• Suivi_des_éléments_de_ligne_des_notes_de_crédit
• Devises
• Éléments_de_Ligne_Facture
• Invoice_Line_Items_Tracking
• Objets
• Journaux
• Lignes_du_Journal
• Journal_Line_Tracking_Categories
• Manual_Journals
• Manual_Journal_Lines
• Organisations
• Éléments_de_Ligne_de_Prépaiement
• Projets
• Utilisateurs du Projet
• Articles_de_la_ligne_de_commande_d'achat
• Taux_d'imposition
• Tracking_Categories
• Options_Catégories_de_Suivi
• Users

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

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

Xero en tant que source

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

Exemple :

"activities":[
    {
        "name": "CopyFromXero",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<Xero input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "XeroSource",
                "query": "SELECT * FROM Contacts"
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Notez ce qui suit lors de la spécification de la requête Xero :

• Les tables comportant des éléments complexes sont réparties dans plusieurs tables. Par exemple, les transactions bancaires ont une structure de données complexe « LineItems », les données de transaction bancaire sont donc mappées à la table Bank_Transaction et Bank_Transaction_Line_Items, avec Bank_Transaction_ID en tant que clé étrangère pour les relier.

• Les données de Xero sont disponibles via les deux schémas : Minimal (par défaut) et Complete. Le schéma complet contient des tables d’appel requises qui nécessitent des données supplémentaires (par exemple, la colonne ID) avant d’effectuer la requête souhaitée.

Les tables suivantes contiennent les mêmes informations dans le schéma Minimal et le schéma Complet. Pour réduire le nombre d’appels d’API, utilisez un schéma Minimal (par défaut).

• Bank_Transactions
• Contact_Groups
• Contacts
• Contacts_Sales_Tracking_Categories
• Contacts_Phones
• Contacts_Addresses
• Contacts_Purchases_Tracking_Categories
• Credit_Notes
• Credit_Notes_Allocations
• Expense_Claims
• Expense_Claim_Validation_Errors
• Factures
• Invoices_Credit_Notes
• Invoices_ paiement anticipé
• Invoices_Overpayments
• Manual_Journals
• Overpayments
• Overpayments_Allocations
• Prepayments
• Prepayments_Allocations
• Receipts
• Receipt_Validation_Errors
• Tracking_Categories

Les tables suivantes peuvent uniquement être interrogées avec un schéma complet :

• Complete.Bank_Transaction_Line_Items
• Complete.Bank_Transaction_Line_Item_Tracking
• Complete.Contact_Group_Contacts
• Complete.Contacts_Contact_ Persons
• Complete.Credit_Note_Line_Items
• Complete.Credit_Notes_Line_Items_Tracking
• Complete.Expense_Claim_ Payments
• Complete.Expense_Claim_Receipts
• Complete.Invoice_Line_Items
• Complete.Invoices_Line_Items_Tracking
• Complete.Manual_Journal_Lines
• Complete.Manual_Journal_Line_Tracking
• Complete.Overpayment_Line_Items
• Complete.Overpayment_Line_Items_Tracking
• Complete.Prepayment_Line_Items
• Complete.Prepayment_Line_Item_Tracking
• Complete.Receipt_Line_Items
• Complete.Receipt_Line_Item_Tracking
• Complete.Tracking_Category_Options

Mappage de type de données pour Xero

Lorsque vous copiez des données à partir de Xero, les mappages suivants s’appliquent des types de données de Xero aux types de données internes utilisés par le service. Pour découvrir comment l’activité de copie mappe le schéma et le type de données la source au récepteur, consultez Mappage de schéma dans l’activité de copie.

Propriétés de l’activité Lookup

Pour en savoir plus sur les propriétés, consultez Activité Lookup.

Cycle de vie et mise à niveau du connecteur Xero

Le tableau suivant présente l’étape de mise en production et les journaux des modifications pour différentes versions du connecteur Xero :

Mettre à niveau le connecteur Xero de la version 1.0 vers la version 2.0

1. Dans la page Modifier le service lié , sélectionnez la version 2.0 et configurez le service lié en faisant référence aux propriétés du service lié version 2.0.

2. Le mappage de type de données pour le service lié Xero version 2.0 est différent de celui de la version 1.0. Pour en savoir plus sur le mappage de type de données le plus récent, consultez Mappage de type de données pour Xero.

3. Si vous utilisez le runtime d’intégration auto-hébergé, sa version doit être 5.61 ou ultérieure.

4. Utilisez table au lieu de tableName dans la version 2.0. Pour obtenir la configuration détaillée, accédez aux propriétés du jeu de données.

5. query est uniquement pris en charge dans la version 1.0. Vous devez utiliser table au lieu de query dans la version 2.0.

6. Notez que la version 2.0 prend en charge des tables Xero spécifiques. Pour la liste de tables prise en charge, accédez aux propriétés du jeu de données.

Contenu connexe

Consultez les banques de données prises en charge pour obtenir la liste des banques de données prises en charge par l’activité de copie.