Jira Service Management

Il connettore Jira Service Management ti consente di connetterti a Jira Service Management ed eseguire operazioni di inserimento, eliminazione, aggiornamento e lettura.

Prima di iniziare

Prima di utilizzare il connettore Jira Service Management, svolgi le seguenti attività:

  • Nel tuo progetto Google Cloud:
    • Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, consulta Connettività di rete.
    • Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
    • Concedi i seguenti ruoli IAM all'account di servizio che vuoi utilizzare per il connettore:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Un account di servizio è un tipo speciale di Account Google destinato a rappresentare un utente "non umano" che deve eseguire l'autenticazione ed essere autorizzato ad accedere ai dati nelle API Google. Se non hai un account di servizio, devi crearne uno. Per maggiori informazioni, consulta Creare un account di servizio.

    • Attiva i seguenti servizi:
      • secretmanager.googleapis.com (API Secret Manager)
      • connectors.googleapis.com (API Connectors)

      Per informazioni su come attivare i servizi, consulta Abilitazione dei servizi.

    Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti verrà chiesto di attivarli durante la configurazione del connettore.

Configura il connettore

Per configurare il connettore devi creare una connessione all'origine dati (sistema di backend). Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione distinta per ciascuna. Per creare una connessione:

  1. Nella console Cloud, vai alla pagina Connettori di integrazione > Connessioni, quindi seleziona o crea un progetto Google Cloud.

    Vai alla pagina Connessioni

  2. Fai clic su + CREA NUOVO per aprire la pagina Crea connessione.
  3. Nella sezione Località, scegli la località della connessione.
    1. Regione: seleziona una località dall'elenco a discesa.

      Per l'elenco di tutte le regioni supportate, consulta Località.

    2. Fai clic su AVANTI.
  4. Nella sezione Dettagli connessione, completa quanto segue:
    1. Connettore: seleziona Jira Service Management dall'elenco a discesa dei connettori disponibili.
    2. Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
    3. Nel campo Nome connessione, inserisci un nome per l'istanza di connessione.

      I nomi delle connessioni devono soddisfare i seguenti criteri:

      • I nomi delle connessioni possono contenere lettere, numeri o trattini.
      • Le lettere devono essere minuscole.
      • I nomi delle connessioni devono iniziare con una lettera e terminare con una lettera o un numero.
      • I nomi delle connessioni non possono contenere più di 49 caratteri.
    4. (Facoltativo) Inserisci una Descrizione per l'istanza di connessione.
    5. Se vuoi, attiva Cloud Logging e poi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su Error.
    6. Account di servizio: seleziona un account di servizio con i ruoli richiesti.
    7. Inserisci un ID Service Desk dell'utente autenticato. Per impostazione predefinita, riceviamo il primo ID restituito da una chiamata extra per ottenere tutti i desk di assistenza. Puoi ottenere il valore ServiceDeskId eseguendo una query sull'elenco dell'entità ServiceDesks.
    8. Inserisci il livello di dettaglio per la connessione, che varia da 1 a 5. Un livello di dettagli più elevato registrerà tutti i dettagli della comunicazione (richiesta,risposta e certificati SSL).
    9. (Facoltativo) Configura le impostazioni del nodo di connessione:

      • Numero minimo di nodi: inserisci il numero minimo di nodi di connessione.
      • Numero massimo di nodi: inserisci il numero massimo di nodi di connessione.

      Un nodo è un'unità (o una replica) di una connessione che elabora le transazioni. Sono necessari più nodi per elaborare più transazioni per una connessione e, al contrario, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi per i nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita il numero minimo di nodi è impostato su 2 (per una maggiore disponibilità) e il numero massimo di nodi è impostato su 50.

    10. Utilizza proxy: seleziona questa casella di controllo per configurare un server proxy per la connessione e imposta i seguenti valori:
      • Schema di autenticazione proxy: seleziona il tipo di autenticazione per l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Di base: autenticazione HTTP di base.
        • Digest: autenticazione HTTP Digest.
      • Utente proxy: un nome utente da utilizzare per l'autenticazione con il server proxy.
      • Password proxy: il segreto di Secret Manager della password dell'utente.
      • Tipo SSL proxy: il tipo di SSL da utilizzare per la connessione al server proxy. Sono supportati i seguenti tipi di autenticazione:
        • Automatica: impostazione predefinita. Se l'URL è un URL HTTPS, viene utilizzata l'opzione Tunnel. Se l'URL è un URL HTTP, viene utilizzata l'opzione MAI.
        • Sempre: la connessione è sempre abilitata per SSL.
        • Mai: la connessione non è abilitata per SSL.
        • Tunnel: la connessione avviene tramite un proxy di tunneling. Il server proxy apre una connessione all'host remoto e il traffico fluisce avanti e indietro attraverso il proxy.
      • Nella sezione Server proxy, inserisci i dettagli del server proxy.
        1. Fai clic su + Aggiungi destinazione.
        2. Seleziona un Tipo di destinazione.
          • Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.

            Per stabilire una connessione privata al sistema di backend:

    11. Se vuoi, fai clic su + AGGIUNGI ETIQUETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
    12. Fai clic su AVANTI.
  5. Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
    1. Tipo di destinazione: seleziona un Tipo di destinazione.
      • Seleziona Indirizzo host dall'elenco per specificare il nome host o l'indirizzo IP della destinazione.
      • Se vuoi stabilire una connessione privata ai tuoi sistemi di backend, seleziona Allegato endpoint dall'elenco, quindi seleziona l'allegato endpoint richiesto dall'elenco Allegato endpoint.

      Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con una maggiore sicurezza, puoi prendere in considerazione la configurazione di indirizzi IP statici in uscita per le tue connessioni, quindi configurare le regole del firewall in modo da inserire nella lista consentita solo gli indirizzi IP statici specifici.

      Per inserire destinazioni aggiuntive, fai clic su + AGGIUNGI DESTINAZIONE.

    2. Fai clic su AVANTI.
  6. Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
    1. Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.

      La connessione a Jira Service Management supporta i seguenti tipi di autenticazione:

      • OAuth2.0
      • Di base
      • APIToken
    2. Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.

    3. Fai clic su AVANTI.
  7. Rivedi: controlla i dettagli di connessione e autenticazione.
  8. Fai clic su Crea.

Configura autenticazione

Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.

  • OAuth2.0
    • ID client : l'ID client fornito dalla tua applicazione esterna.
    • Ambiti : ambiti di autorizzazione. L'ambito offline_access deve essere utilizzato con il connettore Jira Service Management. Per capire come funzionano gli ambiti e visualizzare tutti quelli disponibili per Jira Service Management, consulta Ambiti.
    • Client secret: seleziona il secret di Secret Manager. Devi aver creato il secret di Secret Manager prima di configurare questa autorizzazione.
    • Versione secret: versione del secret di Secret Manager per il client secret.
    • Per il tipo di autenticazione Authorization code, dopo aver creato la connessione, devi eseguire alcuni passaggi aggiuntivi per configurare l'autenticazione. Per ulteriori informazioni, consulta Passaggi aggiuntivi dopo la creazione della connessione.

  • Di base
    • Nome utente: l'account utente Jira Service Management utilizzato per l'autenticazione.
    • Password: la password associata all'account.
  • APIToken
    • Nome utente: il nome utente di Jira Service Management utilizzato per creare il token API.
    • Token API: la password per il nome utente sarà un token API. Seleziona il secret di Secret Manager contenente il token API associato al nome utente di Jira Cloud.

Passaggi aggiuntivi dopo la creazione della connessione

Se hai selezionato OAuth 2.0 - Authorization code per l'autenticazione, devi eseguire i seguenti passaggi aggiuntivi dopo aver creato la connessione:

  1. Nella pagina Connessioni, individua la connessione appena creata.

    Tieni presente che lo stato del nuovo connettore sarà Autorizzazione richiesta.

  2. Fai clic su Autorizzazione obbligatoria.

    Viene visualizzato il riquadro Modifica autorizzazione.

  3. Copia il valore URI di reindirizzamento nell'applicazione esterna.
  4. Verifica i dettagli dell'autorizzazione.
  5. Fai clic su Autorizza.

    Se l'autorizzazione va a buon fine, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Nuova autorizzazione per il codice di autorizzazione

Se utilizzi il tipo di autenticazione Authorization code e hai apportato modifiche alla configurazione nell'applicazione Jira Service Management, devi autorizzare di nuovo il collegamento a Jira Service Management. Per autorizzare di nuovo una connessione, segui questi passaggi:

  1. Fai clic sulla connessione richiesta nella pagina Connessioni.

    Viene visualizzata la pagina dei dettagli della connessione.

  2. Fai clic su Modifica per modificare i dettagli della connessione.
  3. Verifica i dettagli di OAuth 2.0 - Codice di autorizzazione nella sezione Autenticazione.

    Se necessario, apporta le modifiche necessarie.

  4. Fai clic su Salva. Viene visualizzata la pagina dei dettagli della connessione.
  5. Fai clic su Modifica autorizzazione nella sezione Autenticazione. Viene visualizzato il riquadro Autorizza.
  6. Fai clic su Autorizza.

    Se l'autorizzazione va a buon fine, lo stato della connessione verrà impostato su Attivo nella pagina Connessioni.

Entità, operazioni e azioni

Tutti gli Integration Connectors forniscono un livello di astrazione per gli oggetti dell'applicazione collegata. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione viene mostrata come entità, operazioni e azioni.

  • Entità : un'entità può essere considerata un oggetto o una raccolta di proprietà nell'applicazione o nel servizio collegato. La definizione di un'entità varia da un connettore all'altro. Ad esempio, in un connettore di database le tabelle sono le entità, in un connettore di file server le cartelle sono le entità e in un connettore di sistema di messaggistica le code sono le entità.

    Tuttavia, è possibile che un connettore non supporti o non abbia entità, nel qual caso l'elenco Entities sarà vuoto.

  • Operazione: un'operazione è l'attività che puoi eseguire su un'entità. Puoi eseguire su un'entità una delle seguenti operazioni:

    La selezione di un'entità dall'elenco disponibile genera un elenco di operazioni disponibili per l'entità. Per una descrizione dettagliata delle operazioni, consulta le operazioni sulle entità dell'attività Connettori. Tuttavia, se un connettore non supporta nessuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco Operations.

  • Azione : un'azione è una funzione di prima classe resa disponibile all'integrazione tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e varia da un connettore all'altro. In genere, un'azione avrà alcuni parametri di input e un parametro di output. Tuttavia, è possibile che un connettore non supporti alcuna azione, nel qual caso l'elenco Actions sarà vuoto.

Limitazioni del sistema

Il connettore Jira Service Management può elaborare 15 transazioni al secondo, per nodo, e limita le transazioni oltre questo limite. Per impostazione predefinita, Integration Connectors alloca 2 nodi (per una maggiore disponibilità) per una connessione.

Per informazioni sui limiti applicabili a Integration Connectors, vedi Limiti.

Azioni

Il connettore Jira Service Management fornisce azioni come AddAttachment, AttachTemporaryFile e CreateCustomer. Per capire come configurare le azioni, consulta Esempi di azioni.

Esempi di azioni

Questa sezione descrive come eseguire alcune delle azioni in questo connettore.

Esempio: allega un file temporaneo

Questo esempio allega un file temporaneo e fornisce un ID allegato da utilizzare per aggiungere un allegato.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione AttachTemporaryFile e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:
      {
        "Content": "test to create 1 temporaryid"
      }
  4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task del connettore avrà un valore simile al seguente:

    [{
        "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "FileName": "16324233309516250343.connector.txt"
    }] 

Esempio: aggiungere un allegato

Questo esempio allega il file temporaneo all'ID richiesta fornito nel payload di input.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione AddAttachment e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:
    {
        "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "RequestId": "10032"
    }  
  4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task del connettore avrà un valore simile al seguente:

    [{
      "Success": "true",
      "filename": "16324233309516250343.connector.txt",
    }] 

Esempio: creare un cliente

Questo esempio crea un cliente.

  1. Nella finestra di dialogo Configure connector task, fai clic su Actions.
  2. Seleziona l'azione CreateCustomer e poi fai clic su Fine.
  3. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:
    {
      "Email": "something@something.com",
      "FullName": "Something"
    } 
  4. Se l'azione ha esito positivo, il parametro di risposta connectorOutputPayload della task del connettore avrà un valore simile al seguente:

    [{
        "Key": null,
        "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "Name": null,
        "EmailAddress": "something@something.com",
        "DisplayName": "Something",
        "Active": "true",
        "Timezone": "Asia/Calcutta",
        "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
        "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
        "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
        "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
        "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
    }]

Esempi di operazioni sulle entità

Esempio: elenca tutte le richieste

Questo esempio elenca tutte le richieste nell'entità Requests.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Richieste dall'elenco Entity.
  3. Seleziona l'operazione LIST e poi fai clic su Fine.

Esempio: ottieni le richieste da un ID Service Desk specifico

Questo esempio recupera la richiesta con RequestKey come DP1-14 dall'entità Requests.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Requests dall'elenco Entity.
  3. Seleziona l'operazione LIST e poi fai clic su Fine.
  4. Nella sezione Input dell'attività dell'attività Connettori, fai clic su filterClause e poi inserisci RequestKey='DP1-14' nel campo Valore predefinito.

    Qui, RequestKey è il valore della chiave primaria dell'entità Requests.

Esempio: crea una richiesta

Questo esempio crea una richiesta nell'entità Requests.

  1. Nella finestra di dialogo Configure connector task, fai clic su Entities.
  2. Seleziona Requests dall'elenco Entity.
  3. Seleziona l'operazione Create e fai clic su Fine.
  4. Nella sezione Input attività dell'attività Connettori, fai clic su connectorInputPayload e poi inserisci un valore simile al seguente nel campo Default Value:
    {, , ,) VALUES ('2', '1', '','test');
        "RequestTypeId": "2",
        "ServiceDeskId": "1",
        "Summary": "test",
        "Description": "test"
      }
      

    Se l'integrazione è andata a buon fine, il campo connectorOutputPayload dell'attività del connettore avrà un valore simile al seguente:

     {
        "RequestId": "10032"
      } 
      

Utilizzare Terraform per creare connessioni

Puoi utilizzare la risorsa Terraform per creare una nuova connessione.

Per scoprire come applicare o rimuovere una configurazione Terraform, consulta Comandi Terraform di base.

Per visualizzare un modello Terraform di esempio per la creazione di una connessione, consulta il modello di esempio.

Quando crei questa connessione utilizzando Terraform, devi impostare le seguenti variabili nel file di configurazione Terraform:

Nome parametro Tipo di dati Obbligatorio Descrizione
proxy_enabled BOOLEANO Falso Seleziona questa casella di controllo per configurare un server proxy per la connessione.
proxy_auth_scheme ENUM Falso Il tipo di autenticazione da utilizzare per l'autenticazione al proxy ProxyServer. I valori supportati sono: BASIC, DIGEST, NONE
proxy_user STRING Falso Un nome utente da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_password SECRET Falso Una password da utilizzare per l'autenticazione al proxy ProxyServer.
proxy_ssltype ENUM Falso Il tipo di SSL da utilizzare per la connessione al proxy ProxyServer. I valori supportati sono: AUTO, ALWAYS, NEVER, TUNNEL

Utilizzare la connessione Jira Service Management in un'integrazione

Una volta creata, la connessione diventa disponibile sia nell'Apigee Integration sia nell'Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.

  • Per informazioni su come creare e utilizzare l'attività Connectors in Apigee Integration, consulta Attività Connectors.
  • Per informazioni su come creare e utilizzare l'attività Connettori in Application Integration, consulta Attività Connettori.

Ricevere assistenza dalla community Google Cloud

Puoi pubblicare le tue domande e discutere di questo connettore nella community Google Cloud ai forum di Cloud.

Passaggi successivi