Attività connettori

L'attività Connettori ti consente di connetterti in modo rapido e sicuro ai vari servizi Google Cloud e ad altre applicazioni aziendali dalla tua integrazione utilizzando i connettori pronti all'uso disponibili Connettori di integrazione.

Per l'elenco di tutti i connettori supportati per l'integrazione di Apigee, consulta la documentazione di riferimento dei connettori.

Prima di iniziare

  • Assicurati di aver concesso il ruolo IAM Amministratore connettori (roles/connectors.admin) per il tuo progetto Google Cloud. Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso.
  • Scopri i concetti generali dei connettori di integrazione.
  • Per connetterti ai servizi Google Cloud e ad altre applicazioni aziendali utilizzando un connettore, assicurati di aver allegato un account di servizio gestito dall'utente all'integrazione. Se per l'integrazione non è configurato un account di servizio gestito dall'utente, per impostazione predefinita viene utilizzato l'account di servizio predefinito (service-PROJECT_NUMBER@gcp-sa-apigee.iam.gserviceaccount.com) per l'autenticazione.
  • Assicurati che il tuo account di servizio abbia il ruolo IAM richiesto. Per informazioni sulla concessione di ruoli a un account di servizio, vedi Gestire l'accesso agli account di servizio.

Aggiungi un'attività Connettori

Per aggiungere l'attività Connettori all'integrazione, segui questi passaggi:

  1. Nell'interfaccia utente di Apigee, seleziona la tua organizzazione Apigee.
  2. Fai clic su Sviluppa > Integrazioni.
  3. Seleziona un'integrazione esistente o creane una nuova facendo clic su Crea integrazione.

    Se stai creando una nuova integrazione:

    1. Inserisci un nome e una descrizione nella finestra di dialogo Crea integrazione.
    2. Seleziona una regione per l'integrazione dall'elenco delle regioni supportate.
    3. Fai clic su Crea.

    Si aprirà l'integrazione nel designer dell'integrazione.

  4. Nella barra di navigazione del designer dell'integrazione, fai clic su + Aggiungi un'attività/un trigger > Attività per visualizzare l'elenco delle attività disponibili.
  5. immagine che mostra l'attività dei connettori

  6. Se vuoi configurare una nuova connessione, fai clic sull'elemento Connettori e posizionalo nell'editor di integrazione. Poi, fai clic su Configura connettore per configurare la connessione.

    immagine che mostra l'elenco delle attività del connettore immagine che mostra l'elenco delle attività del connettore

  7. Se disponi di una connessione esistente, fai clic sulla scheda Connettori per visualizzare le connessioni create di recente. Puoi anche cercare un connettore, una connessione o un'attività inserendo il nome nel campo Cerca.

    immagine che mostra la funzionalità di ricerca per l'attività dei connettori

  8. Fai clic e posiziona l'elemento Connectors configurato nell'editor di integrazione. Per informazioni su come configurare un'attività di connettore, consulta Configurare l'attività Connectors.

Configura l'attività Connectors

Per configurare un'attività Connettori:

  1. Fai clic sull'elemento attività Connettori nel designer per visualizzare il riquadro di configurazione dell'attività Connettori.

    Se vuoi, fai clic su per rinominare l'attività.

  2. Fai clic su Configura connettore.
  3. Puoi selezionare una connessione esistente nella regione o crearne una nuova. Per configurare una connessione esistente, completa i passaggi riportati di seguito nella pagina Editor attività dei connettori.

    L'immagine seguente mostra un layout di esempio della pagina Editor attività dei connettori. immagine che mostra la finestra di dialogo di configurazione dell'attività del connettore immagine che mostra la finestra di dialogo di configurazione dell'attività del connettore

    1. Nella sezione Seleziona connessione, seleziona la regione della connessione.
    2. Scegli una connessione esistente dall'elenco di connessioni disponibili nella regione selezionata.
    3. Fai clic su Avanti.
    4. Nell'elenco Tipo, seleziona Entità o Azioni.
      • Se selezioni Entità, l'elenco delle entità supportate per la connessione viene visualizzato nella sezione Imposta entità/azioni. Seleziona un'entità seguita dall'operazione che vuoi eseguire su quell'entità.
      • Se selezioni Azioni, l'elenco delle azioni supportate per la connessione viene visualizzato nella colonna Imposta entità/azioni. Seleziona un'azione per la connessione.
      • Le entità e le azioni supportate si basano sul tipo di connettore. Per l'elenco di tutti i connettori supportati per l'integrazione di Apigee, consulta la documentazione di riferimento dei connettori. Per visualizzare le azioni e le entità supportate per un connettore, consulta la documentazione specifica del connettore.

        Se il connettore supporta una query SQL personalizzata, puoi selezionare l'opzione Esegui query personalizzata dall'elenco Azioni. Per informazioni su come aggiungere una query SQL personalizzata per il connettore, consulta Azione: eseguire una query SQL personalizzata.

    5. Fai clic su Fine per completare la configurazione della connessione e chiudere il riquadro.

Configura le variabili di input e output delle attività

Il riquadro di configurazione dell'attività Connettori mostra le variabili Input dell'attività e Output dell'attività generate automaticamente in base all'entità e all'operazione o all'azione selezionata nella finestra di dialogo Configura attività di connettore. Queste variabili sono configurabili e accessibili come input per l'attività corrente o come output di attività successive, oppure condizionali nell'integrazione corrente.

Per configurare le variabili Input attività o Output attività, fai clic sulla rispettiva per aprire il riquadro Configura variabile ed eseguire questi passaggi:

  1. Inserisci il valore della variabile nel campo Valore predefinito.
  2. (Facoltativo) Seleziona Utilizza come input per l'integrazione o Usa come output per l'integrazione.
  3. Fai clic su Salva.

Per ulteriori informazioni sui valori di input e output dell'attività Connettori, consulta Operazioni sulle entità.

Operazioni e azioni sulle entità

Puoi eseguire operazioni CRUD (Create, Read, Update, Delete) sulle entità di un connettore. Ognuna di queste operazioni delle entità ha un set diverso di parametri di input e output. Nella tabella seguente sono elencati i parametri di input e output delle varie operazioni delle entità.

Nome operazione Parametri di input Parametri di output
Elenco
  • listEntitiesPageSize
  • listEntitiesPageToken
  • listEntitiesSortByColumns
  • filterClause
  • connectorOutputPayload
  • listEntitiesNextPageToken
Ottieni entityId connectorOutputPayload
Crea connectorInputPayload connectorOutputPayload
Aggiorna
  • connectorInputPayload
  • entityId
  • filterClause
connectorOutputPayload
Elimina
  • entityId
  • filterClause
N/D

Parametri di input

La tabella seguente descrive i parametri di input per le varie operazioni sulle entità.

Nome parametro Tipo di dati Descrizione
entityId Stringa

Un identificatore univoco della riga a cui vuoi accedere.

Di solito, entityId è un valore chiave primaria di una tabella o un set di dati. Se specifichi un valore per entityId e la tabella o il set di dati non ha una colonna di chiave primaria, l'integrazione segnala un errore di runtime e l'attività Connettori non va a buon fine.

Ad esempio, per ottenere una riga specifica da una tabella MySQL, entityId è il valore della chiave primaria nella tabella.

connectorInputPayload JSON I dati effettivi da aggiungere o aggiornare in un'entità. L'esempio seguente mostra lo snippet JSON dei dati di una riga da aggiungere a una tabella:
{
"employee_first_name": "John",
"employee_emailID": "test-05@test.com"
}
      

In questo esempio, employee_first_name e employee_emailID sono i nomi delle colonne con i valori corrispondenti John e test-05@test.com.

filterClause Stringa Limita il risultato delle operazioni in base a una condizione. Per ulteriori informazioni sull'aggiunta di una clausola di filtro, consulta Aggiungere un filtro per un'operazione.
listEntitiesPageSize Numero intero

Specifica il numero di risultati da restituire in una pagina.

Una pagina è un raggruppamento logico dei record di un set di risultati. Il concetto di una pagina è utile quando prevedi un gran numero di record nel set di risultati. Se il set di risultati è elevato, l'attività Connettori potrebbe non riuscire, poiché Un limite per le dimensioni dei dati che l'attività Connettori può elaborare. Puoi evitare questo problema suddividendo l'insieme di risultati in blocchi più piccoli.

Ad esempio, se prevedi 1000 record nel set di risultati, puoi impostare il valore listEntitiesPageSize su 100. Quindi, quando viene eseguita l'attività Connettori per la prima volta, restituisce i primi 100 record, i 100 record successivi nella seconda esecuzione e così via.

listEntitiesPageToken Stringa

Un identificatore di pagina (token) che ti consente di accedere a una pagina specifica.

Puoi ottenere il valore di un token di pagina dal listEntitiesNextPageToken parametro di output. Poiché ogni pagina ha un token univoco, hai la flessibilità di accedere a qualsiasi pagina che vuoi nel set di risultati. Per comprendere l'utilizzo di questo parametro, leggi anche descrizione del parametro di output listEntitiesNextPageToken.

listEntitiesSortByColumns Array di stringhe Nome della colonna in base al quale ordinare il set di risultati.

Parametri di output

La tabella seguente descrive i parametri di output per le varie operazioni delle entità.

Nome parametro Tipo di dati Descrizione
connectorOutputPayload JSON L'output di un'operazione in formato JSON.
listEntitiesNextPageToken Stringa

Un identificatore generato dal sistema per una pagina. Puoi considerare il token come un puntatore, da cui puoi accedere a una determinata pagina del set di risultati.

Se hai suddiviso di risultati impostati in più pagine impostando il parametro listEntitiesPageSize, necessitano di un meccanismo per navigare tra le pagine. Il parametro di output listEntitiesNextPageToken ti consente di farlo. Ogni volta che viene eseguita l'attività Connettori, il sistema genera un token per la pagina successiva e imposta il parametro listEntitiesNextPageToken al token appena generato. Puoi quindi utilizzare questo token per accedere alla pagina successiva nel set di risultati. Per accedere alla pagina successiva, devi impostare il campo listEntitiesPageToken al valore del token della pagina successiva.

Ad esempio, supponiamo che tu abbia impostato il parametro listEntitiesPageSize su 2 e che, quando l'attività Connettori viene eseguita per la prima volta, listEntitiesNextPageToken venga impostato sul valore del token ChoKC2VtcGxveWVlX2lkEgkRAAAAAAAA8D8YDw==. Puoi quindi impostare il parametro di input listEntitiesPageToken su questo valore token per recuperare la pagina successiva nell'esecuzione successiva dell'attività Connettori.

Se il set di risultati contiene un numero elevato di pagine, puoi considerare l'utilizzo della Attività Per ogni loop per richiamare ripetutamente l'attività Connettori e utilizzare la mappatura dei dati per assegnare automaticamente i valori dei token listEntitiesPageToken parametro di input dopo ogni esecuzione.

Clausola di filtro per le operazioni sulle entità

Puoi limitare i record elaborati dall'attività Connettori utilizzando la variabile Clausola filtro disponibile come input attività. Ad esempio, in caso di operazione di eliminazione, puoi aggiungere una clausola di filtro per eliminare i record con un orderId specifico.

La clausola di filtro può essere applicata solo per le seguenti operazioni sulle entità:

  • Elenco
  • Elimina
  • Aggiorna

Quando selezioni una di queste operazioni, la sezione Input attività dell'attività Connettori mostra automaticamente il campo Clausola filtro.

Aggiungi una clausola di filtro

Per aggiungere una clausola di filtro, svolgi i seguenti passaggi:

  1. Fai clic sull'elemento attività Connettori nel designer per visualizzare l'attività Connettori di configurazione del deployment.
  2. Espandi la sezione Input attività e fai clic sulla variabile di stringa filterClause(Connectors).

    Viene visualizzata la finestra di dialogo Configura variabile.

  3. Inserisci la clausola di filtro (seguendo la clausola sintassi) nel campo Valore predefinito.
  4. Fai clic su Salva.

Sintassi ed esempi della clausola di filtro

Una clausola di filtro ha il seguente formato:

FIELD_NAME CONDITION FILTER_VALUE

Esempi

  • OwnerId = '0053t000007941XAAQ'
  • PoNumber < 2345
  • OrderNumber = 00110 AND StatusCode = 'Draft'
  • TotalAmount > 2500
  • ShippingPostalCode = 94043 OR ShippingPostalCode = 77002

Utilizzo di variabili nella clausola di filtro

Non puoi utilizzare direttamente una variabile di integrazione in una clausola di filtro. Se vuoi utilizzare una variabile di integrazione, devi prima configurare un'attività di mappatura dei dati per creare una mappatura tra la variabile di integrazione e la clausola di filtro.

La tabella seguente mostra una mappatura di esempio tra una variabile di integrazione e la variabile filterClause(Connectors):

Input Output
PRIMARY_KEY_ID = ' .CONCAT(INTEGRATION_VARIABLE) .CONCAT(') filterClause(Connectors)
Dove, PRIMARY_KEY_ID = ' viene inserito come Valore nella riga di input.

Azione: esegui una query SQL personalizzata

Per creare una query personalizzata:

  1. Segui le istruzioni dettagliate per aggiungere un'attività dei connettori.
  2. Quando configuri l'attività del connettore, seleziona Azioni nel tipo di azione che vuoi eseguire.
  3. Nell'elenco Azione, seleziona Esegui query personalizzata, quindi fai clic su Fine.

    immagine che mostra l&#39;esecuzione di una query personalizzata immagine che mostra l&#39;esecuzione di una query personalizzata

  4. Espandi la sezione Input attività ed esegui i seguenti passaggi:
    1. Nel campo Timeout dopo, inserisci il numero di secondi di attesa prima che la query venga eseguita.

      Valore predefinito: 180 secondi.

    2. Nel campo Numero massimo di righe, inserisci il numero massimo di righe da restituire dal database.

      Valore predefinito: 25.

    3. Per aggiornare la query personalizzata, fai clic su Modifica script personalizzato. Viene visualizzata la finestra di dialogo Editor di script.

      immagine che mostra la query SQL personalizzata immagine che mostra la query SQL personalizzata

    4. Nella finestra di dialogo Editor di script, inserisci la query SQL e fai clic su Salva.

      Puoi utilizzare un punto interrogativo (?) in un'istruzione SQL per rappresentare un singolo parametro che deve essere specificato nell'elenco dei parametri di ricerca. Ad esempio, la seguente query SQL seleziona tutte le righe della tabella Employees che corrispondono ai valori specificati per la colonna LastName:

      SELECT * FROM Employees where LastName=?

    5. Se hai utilizzato dei punti interrogativi nella query SQL, devi aggiungere il parametro facendo clic su + Aggiungi nome parametro per ciascun punto. Durante l'esecuzione dell'integrazione, questi parametri sostituiscono in sequenza i punti interrogativi (?) nella query SQL. Ad esempio, se hai aggiunto tre punti di domanda (?), devi aggiungere tre parametri in ordine di sequenza.

      immagine che mostra add-query-param immagine che mostra add-query-param

      Per aggiungere i parametri di query:

      1. Nell'elenco Tipo, seleziona il tipo di dati del parametro.
      2. Nel campo Valore, inserisci il valore del parametro.
      3. Per aggiungere più parametri, fai clic su + Aggiungi parametro di query.

Aggiornamento dello schema

A tutte le entità e le azioni verrà associato uno schema. Ad esempio, uno schema di azioni avrà i dettagli dei parametri, ad esempio i nomi dei parametri e il relativo tipo di dati. Lo schema (metadati) per entità e azioni viene recuperato dalla connessione in dal tuo backend. Se sono presenti aggiornamenti allo schema, questi non verranno applicati automaticamente alle connessioni esistenti. Dovrai aggiornare manualmente lo schema. Per visualizzare lo schema aggiornato nelle attività del connettore esistenti:
  1. In Integration Connectors, apri la pagina Dettagli connessione della connessione e fai clic su Aggiorna lo schema di connessione.
  2. In Apigee Integration, devi riconfigurare l'attività del connettore esistente per la stessa connessione.

Creazione di una connessione in linea

Puoi utilizzare l'attività Connettori per creare direttamente una nuova connessione in Integration Connectors.

Prima di iniziare

Crea nuova connessione

Per creare una nuova connessione da Apigee Integration:

  1. Fai clic sull'elemento attività Connettori nel designer per visualizzare l'attività Connettori di configurazione del deployment.
  2. Fai clic su Configura connettore.

    Viene visualizzata la pagina Editor attività Connectors.

  3. Salta il campo Regione.
  4. Fai clic su Connessione e seleziona l'opzione Crea connessione dal menu a discesa.
  5. Completa i seguenti passaggi nel riquadro Crea connessione:
    1. Nel passaggio Località, scegli la località della connessione.
      1. Fai clic su Regione e seleziona una località dall'elenco a discesa.
      2. Fai clic su Avanti.
    2. Nel passaggio Dettagli connessione, fornisci i dettagli della connessione:
      1. Connettore: seleziona il tipo di connettore da creare dall'elenco a discesa. Per informazioni sull'elenco dei connettori supportati, vedi Tutti i connettori di integrazione.
      2. Versione connettore: scegli una versione disponibile del tipo di connettore selezionato dall'elenco a discesa.
      3. Nome connessione: inserisci un nome per l'istanza di connessione.
      4. (Facoltativo) Inserisci una descrizione per l'istanza di connessione.
      5. (Facoltativo) Seleziona Abilita Cloud Logging per archiviare i dati dei log dell'istanza di connessione.
      6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
      7. (Facoltativo) Fai clic su Impostazioni avanzate per configurare le impostazioni del nodo di connessione.

        Per saperne di più, consulta la documentazione relativa alla connessione in Integration Connectors.

      8. (Facoltativo) Fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
      9. Fai clic su Avanti.
    3. Nel passaggio Autenticazione, fornisci i dettagli di autenticazione per la connessione.
      1. I metodi di autenticazione compilati in questo passaggio si basano sul tipo di connessione creata.

        I diversi tipi di connessione utilizzano metodi di autenticazione diversi. Per ulteriori informazioni, consulta la sezione Configura l'autenticazione della rispettiva documentazione sulle connessioni in Connettori di integrazione.

      2. Fai clic su Avanti.
    4. Verifica: controlla i dettagli della connessione e dell'autenticazione.
    5. Fai clic su Crea.

Best practice

Strategia di gestione degli errori

Una strategia di gestione degli errori per un'attività specifica l'azione da eseguire se l'attività non riesce a causa di un errore temporaneo. Per informazioni su come utilizzare una strategia di gestione degli errori e per conoscere i diversi tipi di strategie di gestione degli errori, consulta Strategie di gestione degli errori.