Attività connettori

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

Per l'elenco di tutti i connettori supportati per Apigee Integration, vedi Riferimento connettore.

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, vedi 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 collegato 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 dei 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'UI 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.

    Viene aperta l'integrazione nel designer dell'integrazione.

  4. Nella barra di navigazione integration designer, fai clic su +Aggiungi un'attività/un attivatore > Tasks per visualizzare l'elenco delle attività disponibili.
  5. Fai clic e posiziona l'elemento Connectors nell'editor dell'integrazione.

Configura l'attività Connettori

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 il nome dell'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 seguenti passaggi nella pagina Editor attività dei connettori:
    1. In Seleziona connettori, 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à, nella sezione Imposta entità/azioni viene visualizzato l'elenco di entità supportate per la connessione. Seleziona un'entità seguita dall'operazione da eseguire sull'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 Apigee Integration, vedi Riferimento connettore. 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.
    6. L'immagine seguente mostra un layout di esempio della pagina Editor di 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

Configura le variabili di input e output delle attività

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

Per configurare le variabili Task Input o Task Output, fai clic sulla rispettiva variabile per aprire il riquadro Configura variabile ed esegui 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 parametri di input e output dell'attività Connettori, consulta Operazioni con le entità.

Operazioni e azioni relative alle entità

Puoi eseguire operazioni CRUD (creazione, lettura, aggiornamento, eliminazione) 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
Get entityId connectorOutputPayload
Creazione connectorInputPayload connectorOutputPayload
Aggiornamento
  • connectorInputPayload
  • entityId
  • filterClause
connectorOutputPayload
Elimina
  • entityId
  • filterClause
N/A

Parametri di input

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

Nome parametro Tipo di dati Descrizione
entityId String

Un identificatore univoco della riga a cui vuoi accedere.

Normalmente, entityId è un valore di chiave primaria di una tabella o di 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 riesce.

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 di dati di riga da aggiungere in 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 String Limita il risultato delle operazioni in base a una condizione. Per saperne di più sull'aggiunta di una clausola di filtro, consulta Aggiungere un filtro per un'operazione.
listEntitiesPageSize Integer

Specifica il numero di risultati che devono essere restituiti in una pagina.

Una pagina è un raggruppamento logico dei record di un set di risultati. Il concetto di pagina è utile quando prevedi un numero elevato di record nel set di risultati. Se il set di risultati è di grandi dimensioni, l'attività Connettori potrebbe non riuscire, poiché esiste 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 listEntitiesPageSize su 100. Di conseguenza, quando l'attività Connettori viene eseguita per la prima volta, restituisce i primi 100 record, i 100 record successivi nella seconda esecuzione e così via.

listEntitiesPageToken String

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

Puoi ottenere il valore di un token di pagina dal parametro di output listEntitiesNextPageToken. Poiché ogni pagina ha un token univoco, hai la flessibilità di accedere a qualsiasi pagina nel set di risultati. Per comprendere l'utilizzo di questo parametro, leggi anche la 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 String

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

Se hai suddiviso il set di risultati in più pagine impostando il parametro listEntitiesPageSize, avrai bisogno di un meccanismo per navigare da una pagina all'altra. Il parametro di output listEntitiesNextPageToken consente di fare esattamente questo. Ogni volta che viene eseguita l'attività Connettori, il sistema genera un token per la pagina successiva e imposta il valore di listEntitiesNextPageToken sul 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 parametro di input listEntitiesPageToken sul valore del token della pagina successiva.

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

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

Clausola di filtro per le operazioni delle 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 alle seguenti operazioni sulle entità:

  • Elenco
  • Elimina
  • Aggiornamento

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:

  1. Fai clic sull'elemento attività Connettori nel designer per visualizzare il riquadro di configurazione dell'attività Connettori.
  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 syntax) nel campo Valore predefinito.
  4. Fai clic su Salva.

Sintassi ed esempi della clausola di filtro

Una clausola di filtro ha il formato seguente:

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 un esempio di mappatura tra una variabile di integrazione e la variabile filterClause(Connectors):

Salvaguardie Salvaguardie
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à, quindi segui questi 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 custom-sql-query immagine che mostra custom-sql-query

    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 parametri di ricerca. Ad esempio, la seguente query SQL seleziona tutte le righe della tabella Employees corrispondenti 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 interrogativi (?), devi aggiungere tre parametri in ordine sequenziale.

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

      Per aggiungere parametri di ricerca:

      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.

Creazione di una connessione in linea

Puoi utilizzare l'attività Connettori per creare direttamente una nuova connessione in Connettori di integrazione.

Prima di iniziare

Crea nuova connessione

Per creare una nuova connessione da Apigee Integration, segui questi passaggi:

  1. Fai clic sull'elemento attività Connettori nel designer per visualizzare il riquadro di configurazione dell'attività Connettori.
  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 Posizione, scegli la posizione per la 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 dall'elenco a discesa il tipo di connettore che vuoi creare. 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 di 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 ulteriori informazioni, consulta la rispettiva 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.

        Ogni tipo di connessione utilizza metodi di autenticazione differenti. 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 l'articolo sulle strategie di gestione degli errori.