Copiare dati da QuickBooks Online usando Azure Data Factory o Synapse Analytics (anteprima)

SI APPLICA A: Azure Data Factory Azure Synapse Analytics

Suggerimento

Provare Data Factory in Microsoft Fabric, una soluzione di analisi all-in-one per le aziende. Microsoft Fabric copre tutto, dallo spostamento dati al data science, all'analisi in tempo reale, alla business intelligence e alla creazione di report. Vedere le informazioni su come iniziare una nuova prova gratuita!

Questo articolo illustra come usare l'attività Copy in una pipeline di Azure Data Factory o Synapse Analytics per copiare dati da QuickBooks Online. Si basa sull'articolo di panoramica dell'attività di copia che presenta una panoramica generale sull'attività di copia.

Importante

Questo connettore è attualmente disponibile in anteprima. È possibile provarlo e inviare commenti e suggerimenti. Se si vuole accettare una dipendenza dai connettori in versione di anteprima nella propria soluzione, contattare il supporto tecnico di Azure.

Funzionalità supportate

Questo connettore QuickBooks è supportato per le funzionalità seguenti:

Funzionalità supportate IR
Attività Copy (origine/-) ① ②
Attività Lookup ① ②

① Azure Integration Runtime ② Runtime di integrazione self-hosted

Per un elenco degli archivi dati supportati come origini o sink, vedere la tabella Archivi dati supportati.

Questo connettore supporta l'autenticazione OAuth 2.0 di QuickBooks.

Introduzione

Per eseguire l'attività di copia con una pipeline, è possibile usare uno degli strumenti o SDK seguenti:

Creare un servizio collegato a QuickBooks usando l'interfaccia utente

Usare la procedura seguente per creare un servizio collegato a QuickBooks nell'interfaccia utente del portale di Azure.

  1. Passare alla scheda Gestisci nell'area di lavoro di Azure Data Factory o Synapse e selezionare Servizi collegati, quindi fare clic su Nuovo:

  2. Cercare QuickBooks e selezionarne il connettore.

    Screenshot del connettore QuickBooks.

  3. Configurare i dettagli del servizio, testare la connessione e creare il nuovo servizio collegato.

    Screenshot della configurazione del servizio collegato per QuickBooks.

Dettagli di configurazione del connettore

Le sezioni seguenti riportano informazioni dettagliate sulle proprietà che vengono usate per definire entità di Data Factory specifiche per il connettore QuickBooks.

Proprietà del servizio collegato

Per il servizio collegato QuickBooks sono supportate le proprietà seguenti:

Proprietà Descrizione Richiesto
type La proprietà type deve essere impostata su: QuickBooks
connectionProperties Gruppo di proprietà che definisce come connettersi a QuickBooks.
In connectionProperties:
endpoint Endpoint del server QuickBooks Online, ovvero quickbooks.api.intuit.com
companyId ID azienda dell'azienda QuickBooks da autorizzare. Per informazioni su come trovare l'ID dell'azienda, vedere Come è possibile trovare l'ID dell'azienda?
consumerKey ID client dell'applicazione QuickBooks Online per l'autenticazione OAuth 2.0. Altre informazioni sono disponibili qui.
consumerSecret Segreto client dell'applicazione QuickBooks Online per l'autenticazione OAuth 2.0. Contrassegnare questo campo come SecureString per archiviarlo in modo sicuro oppure fare riferimento a un segreto archiviato in Azure Key Vault.
refreshToken Token di aggiornamento OAuth 2.0 associato all'applicazione QuickBooks. Altre informazioni sono disponibili qui. Si noti che il token di aggiornamento scadrà dopo 180 giorni. Il cliente deve aggiornare regolarmente il token di aggiornamento.
Contrassegnare questo campo come SecureString per archiviarlo in modo sicuro oppure fare riferimento a un segreto archiviato in Azure Key Vault.
useEncryptedEndpoints Specifica se gli endpoint dell'origine dati vengono crittografati tramite HTTPS. Il valore predefinito è true. No

Esempio:

{
    "name": "QuickBooksLinkedService",
    "properties": {
        "type": "QuickBooks",
        "typeProperties": {
            "connectionProperties": {
                "endpoint": "quickbooks.api.intuit.com",
                "companyId": "<company id>",
                "consumerKey": "<consumer key>", 
                "consumerSecret": {
                     "type": "SecureString",
                     "value": "<clientSecret>"
            	},
                "refreshToken": {
                     "type": "SecureString",
                     "value": "<refresh token>"
            	},
                "useEncryptedEndpoints": true
            }
        }
    }
}

Gestione dei token di aggiornamento per il servizio collegato

Quando si usa il connettore QuickBooks Online in un servizio collegato, è importante gestire correttamente i token di aggiornamento OAuth 2.0 da QuickBooks. Il servizio collegato usa un token di aggiornamento per ottenere nuovi token di accesso. Tuttavia, QuickBooks Online aggiorna periodicamente il token di aggiornamento, invalidando quello precedente. Il servizio collegato non aggiorna automaticamente il token di aggiornamento in Azure Key Vault, quindi è necessario gestire l'aggiornamento del token per fare in modo che la connettività non venga ininterrotta. In caso contrario, è possibile che si verifichino errori di autenticazione dopo la scadenza del token di aggiornamento.

È possibile aggiornare manualmente il token di aggiornamento in Azure Key Vault in base al criterio di scadenza del token di aggiornamento di QuickBooks Online. Un altro approccio consiste invece nell'automatizzare gli aggiornamenti con un'attività pianificata o una funzione di Azure che verifica la presenza di un nuovo token di aggiornamento e lo aggiorna in Azure Key Vault.

Proprietà del set di dati

Per un elenco completo delle sezioni e delle proprietà disponibili per la definizione di set di dati, vedere l'articolo sui set di dati. Questa sezione presenta un elenco delle proprietà supportate dal set di dati QuickBooks.

Per copiare dati da QuickBooks Online, impostare la proprietà type del set di dati su QuickBooksObject. Sono supportate le proprietà seguenti:

Proprietà Descrizione Richiesto
type La proprietà type del set di dati deve essere impostata su: QuickBooksObject
tableName Nome della tabella. No (se nell'origine dell'attività è specificato "query")

Esempio

{
    "name": "QuickBooksDataset",
    "properties": {
        "type": "QuickBooksObject",
        "typeProperties": {},
        "schema": [],
        "linkedServiceName": {
            "referenceName": "<QuickBooks linked service name>",
            "type": "LinkedServiceReference"
        }
    }
}

Proprietà dell'attività di copia

Per un elenco completo delle sezioni e delle proprietà disponibili per la definizione delle attività, vedere l'articolo sulle pipeline. Questa sezione presenta un elenco delle proprietà supportate dall'origine QuickBooks.

QuickBooks come origine

Per copiare dati da QuickBooks Online, impostare il tipo di origine nell'attività di copia su QuickBooksSource. Nella sezione origine dell'attività di copia sono supportate le proprietà seguenti:

Proprietà Descrizione Richiesto
type La proprietà type dell'origine dell'attività di copia deve essere impostata su QuickBooksSource
query Usare la query SQL personalizzata per leggere i dati. Ad esempio: "SELECT * FROM "Bill" WHERE Id = '123'". No (se nel set di dati è specificato "tableName")

Esempio:

"activities":[
    {
        "name": "CopyFromQuickBooks",
        "type": "Copy",
        "inputs": [
            {
                "referenceName": "<QuickBooks input dataset name>",
                "type": "DatasetReference"
            }
        ],
        "outputs": [
            {
                "referenceName": "<output dataset name>",
                "type": "DatasetReference"
            }
        ],
        "typeProperties": {
            "source": {
                "type": "QuickBooksSource",
                "query": "SELECT * FROM \"Bill\" WHERE Id = '123' "
            },
            "sink": {
                "type": "<sink type>"
            }
        }
    }
]

Copiare dati da Quickbooks Desktop

L'attività di Copy nel servizio non può copiare dati direttamente da Quickbooks Desktop. Per copiare dati da Quickbooks Desktop, esportare i dati di Quickbooks in un file di valori delimitati da virgole (con estensione csv) e quindi caricare il file in Archiviazione BLOB di Azure. A questo punto, è possibile usare il servizio per copiare i dati nel sink di propria scelta.

Proprietà dell'attività Lookup

Per altre informazioni sulle proprietà, vedere Attività Lookup.

Per un elenco degli archivi dati supportati come origini e sink dall'attività Copy, vedere Archivi dati supportati.