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, esegui le seguenti attività:
- Nel tuo progetto Google Cloud:
- Assicurati che la connettività di rete sia configurata. Per informazioni sui pattern di rete, vedi Connettività di rete.
- Concedi il ruolo IAM roles/connectors.admin all'utente che configura il connettore.
- Concedi i seguenti ruoli IAM al 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 di Google. Se non hai un account di servizio, devi crearne uno. Il connettore e il account di servizio devono appartenere allo stesso progetto. Per ulteriori informazioni, vedi Creare un service account.
- Attiva i seguenti servizi:
secretmanager.googleapis.com
(API Secret Manager)connectors.googleapis.com
(API Connectors)
Per capire come abilitare i servizi, consulta Abilitazione dei servizi.
Se questi servizi o autorizzazioni non sono stati attivati in precedenza per il tuo progetto, ti viene chiesto di attivarli durante la configurazione del connettore.
Configura il connettore
Una connessione è specifica per un'origine dati. Ciò significa che se hai molte origini dati, devi creare una connessione separata per ciascuna. Per creare una connessione:
- Nella console Google Cloud, vai alla pagina Integration Connectors > Connessioni e poi seleziona o crea un progetto Google Cloud.
- Fai clic su + CREA NUOVA per aprire la pagina Crea connessione.
- Nella sezione Posizione, scegli la posizione della connessione.
- Regione: seleziona una località dall'elenco a discesa.
Per l'elenco di tutte le regioni supportate, consulta Località.
- Fai clic su AVANTI.
- Regione: seleziona una località dall'elenco a discesa.
- Nella sezione Dettagli connessione, completa quanto segue:
- Connettore: seleziona Jira Service Management dall'elenco a discesa dei connettori disponibili.
- Versione del connettore: seleziona la versione del connettore dall'elenco a discesa delle versioni disponibili.
- 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 superare i 49 caratteri.
- (Facoltativo) Inserisci una descrizione per l'istanza di connessione.
- (Facoltativo) Abilita Cloud Logging,
quindi seleziona un livello di log. Per impostazione predefinita, il livello di log è impostato su
Error
. - Service Account: seleziona un account di servizio con i ruoli richiesti.
- Inserisci un ID service desk dell'utente autenticato. Per impostazione predefinita, otteniamo il primo ID restituito da una chiamata aggiuntiva per ottenere tutti i service desk. Puoi ottenere ServiceDeskId eseguendo una query di elenco sull'entità ServiceDesks.
- Inserisci il livello di verbosità per la connessione, che varia da 1 a 5. Un livello di dettaglio più elevato registra tutti i dettagli della comunicazione (richiesta,risposta e certificati SSL).
- (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, viceversa, sono necessari meno nodi per elaborare meno transazioni. Per capire in che modo i nodi influiscono sui prezzi dei connettori, consulta Prezzi dei nodi di connessione. Se non inserisci alcun valore, per impostazione predefinita i nodi minimi sono impostati su 2 (per una migliore disponibilità) e i nodi massimi sono impostati su 50.
- (Facoltativo) Nella sezione Impostazioni avanzate, seleziona la casella di controllo Usa proxy per configurare un server proxy per la connessione e configura i seguenti valori:
-
Proxy Auth Scheme (Schema di autenticazione proxy): seleziona il tipo di autenticazione per l'autenticazione con il server proxy. Sono supportati i seguenti tipi di autenticazione:
- Basic: 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 secret di Secret Manager della password dell'utente.
-
Tipo di 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 NEVER.
- 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 scorre avanti e indietro attraverso il proxy.
- Nella sezione Server proxy, inserisci i dettagli del server proxy.
- Fai clic su + Aggiungi destinazione.
- Seleziona un Tipo di destinazione.
- Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.
Se vuoi stabilire una connessione privata al tuo sistema di backend:
- Crea un collegamento del servizio PSC.
- Crea un collegamento dell'endpoint e poi inserisci i dettagli del collegamento dell'endpoint nel campo Indirizzo host.
- Indirizzo host: specifica il nome host o l'indirizzo IP della destinazione.
- (Facoltativo) Fai clic su + AGGIUNGI ETICHETTA per aggiungere un'etichetta alla connessione sotto forma di coppia chiave/valore.
- Fai clic su AVANTI.
- Nella sezione Destinazioni, inserisci i dettagli dell'host remoto (sistema di backend) a cui vuoi connetterti.
- Tipo di destinazione: seleziona un Tipo di destinazione.
- Per specificare il nome host o l'indirizzo IP di destinazione, seleziona Indirizzo host e inserisci l'indirizzo nel campo Host 1.
- Per stabilire una connessione privata, seleziona Collegamento endpoint e scegli il collegamento richiesto dall'elenco Collegamento endpoint.
Se vuoi stabilire una connessione pubblica ai tuoi sistemi di backend con maggiore sicurezza, puoi valutare la possibilità di configurare indirizzi IP statici in uscita per le tue connessioni e poi configurare le regole del firewall in modo da consentire solo gli indirizzi IP statici specifici.
Per inserire altre destinazioni, fai clic su +AGGIUNGI DESTINAZIONE.
- Fai clic su AVANTI.
- Tipo di destinazione: seleziona un Tipo di destinazione.
-
Nella sezione Autenticazione, inserisci i dettagli di autenticazione.
- Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
La connessione Jira Service Management supporta i seguenti tipi di autenticazione:
- OAuth2.0
- Di base
- APIToken
- Fai clic su AVANTI.
Per capire come configurare questi tipi di autenticazione, consulta Configurare l'autenticazione.
- Seleziona un Tipo di autenticazione e inserisci i dettagli pertinenti.
- Rivedi: rivedi i dettagli di connessione e autenticazione.
- Fai clic su Crea.
Configura l'autenticazione
Inserisci i dettagli in base all'autenticazione che vuoi utilizzare.
-
OAuth2.0
- ID client : l'ID client fornito dall'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 per visualizzare tutti gli ambiti disponibili per Jira Service Management, consulta Ambiti. - Client secret : seleziona il secret di Secret Manager. Prima di configurare questa autorizzazione, devi aver creato il secret Secret Manager.
- Versione secret : la versione 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 saperne di più, vedi Passaggi aggiuntivi dopo la creazione della connessione. -
Basic
- 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 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:
- Nella pagina Connessioni,
individua la connessione appena creata.
Tieni presente che lo Stato del nuovo connettore sarà Autorizzazione richiesta.
- Fai clic su Autorizzazione obbligatoria.
Viene visualizzato il riquadro Modifica autorizzazione.
- Copia il valore URI di reindirizzamento nell'applicazione esterna.
- Verifica i dettagli dell'autorizzazione.
- 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 riautorizzare la connessione a Jira Service Management. Per autorizzare nuovamente una connessione:
- Fai clic sulla connessione richiesta nella pagina Connessioni.
Viene visualizzata la pagina dei dettagli della connessione.
- Fai clic su Modifica per modificare i dettagli della connessione.
- Verifica i dettagli di OAuth 2.0 - Codice di autorizzazione nella sezione Autenticazione.
Se necessario, apporta le modifiche necessarie.
- Fai clic su Salva. Viene visualizzata la pagina dei dettagli della connessione.
- Fai clic su Modifica autorizzazione nella sezione Autenticazione. Viene visualizzato il riquadro Autorizza.
- Fai clic su Autorizza.
Se l'autorizzazione va a buon fine, lo stato della connessione verrà impostato su Attiva nella pagina Connessioni.
Entità, operazioni e azioni
Tutti i connettori di integrazione forniscono un livello di astrazione per gli oggetti dell'applicazione connessa. Puoi accedere agli oggetti di un'applicazione solo tramite questa astrazione. L'astrazione ti 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 connesso. 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 del file server, le cartelle sono le entità e in un connettore del 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
una delle seguenti operazioni su un'entità:
Selezionando un'entità dall'elenco disponibile, viene generato 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 alcuna delle operazioni sulle entità, queste operazioni non supportate non sono elencate nell'elenco
Operations
. - Azione: un'azione è una funzione di prima classe resa disponibile per l'integrazione
tramite l'interfaccia del connettore. Un'azione ti consente di apportare modifiche a una o più entità e
varia da connettore a connettore. In genere, un'azione ha 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 di 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 due nodi (per una migliore 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: allegare un file temporaneo
Questo esempio allega un file temporaneo e fornisce un ID allegato che utilizzi per aggiungere un allegato.
- Nella finestra di dialogo
Configure connector task
, fai clic suActions
. - Seleziona l'azione
AttachTemporaryFile
, quindi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e poi inserisci un valore simile al seguente nel campoDefault Value
:{ "Content": "test to create 1 temporaryid" }
Se l'azione ha esito positivo, il parametro
di risposta connectorOutputPayload
dell'attività
del connettore avrà un valore simile al seguente:
[{ "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8", "FileName": "16324233309516250343.connector.txt" }]
Esempio: aggiunta di un allegato
Questo esempio allega il file temporaneo all'ID richiesta fornito nel payload di input.
- Nella finestra di dialogo
Configure connector task
, fai clic suActions
. - Seleziona l'azione
AddAttachment
, quindi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e poi inserisci un valore simile al seguente nel campoDefault Value
:{ "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8", "RequestId": "10032" }
Se l'azione ha esito positivo, il parametro
di risposta connectorOutputPayload
dell'attività
del connettore avrà un valore simile al seguente:
[{ "Success": "true", "filename": "16324233309516250343.connector.txt", }]
Esempio: creare un cliente
Questo esempio crea un cliente.
- Nella finestra di dialogo
Configure connector task
, fai clic suActions
. - Seleziona l'azione
CreateCustomer
, quindi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e poi inserisci un valore simile al seguente nel campoDefault Value
:{ "Email": "something@something.com", "FullName": "Something" }
Se l'azione ha esito positivo, il parametro
di risposta connectorOutputPayload
dell'attività
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: elencare tutte le richieste
Questo esempio elenca tutte le richieste nell'entità Requests
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona Richieste dall'elenco
Entity
. - Seleziona l'operazione
LIST
, quindi fai clic su Fine.
Esempio: ottieni richieste da un ID service desk specifico
Questo esempio recupera la richiesta con RequestKey DP1-14 dall'entità Requests
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Requests
dall'elencoEntity
. - Seleziona l'operazione
LIST
, quindi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su filterClause e
poi inserisci
RequestKey='DP1-14'
nel campo Valore predefinito.In questo caso,
RequestKey
è il valore della chiave primaria dell'entitàRequests
.
Esempio: crea una richiesta
Questo esempio crea una richiesta nell'entità Requests
.
- Nella finestra di dialogo
Configure connector task
, fai clic suEntities
. - Seleziona
Requests
dall'elencoEntity
. - Seleziona l'operazione
Create
, quindi fai clic su Fine. - Nella sezione Input attività dell'attività Connettori, fai clic su
connectorInputPayload
e poi inserisci un valore simile al seguente nel campoDefault Value
:{, , ,) VALUES ('2', '1', '','test'); "RequestTypeId": "2", "ServiceDeskId": "1", "Summary": "test", "Description": "test" }
Se l'integrazione ha esito positivo, il campo
connectorOutputPayload
dell'attività del connettore avrà un valore simile al seguente:{ "RequestId": "10032" }
Creare connessioni utilizzando Terraform
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 template Terraform di esempio per la creazione di connessioni, consulta template 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, questa diventa disponibile sia in Apigee Integration che in Application Integration. Puoi utilizzare la connessione in un'integrazione tramite l'attività Connettori.
- Per capire come creare e utilizzare l'attività Connettori in Apigee Integration, consulta Attività Connettori.
- Per capire come creare e utilizzare l'attività Connettori in Application Integration, vedi Attività Connettori.
Ricevere assistenza dalla community Google Cloud
Puoi pubblicare le tue domande e discutere di questo connettore nella community di Google Cloud nei forum di Cloud.Passaggi successivi
- Scopri come sospendere e ripristinare una connessione.
- Scopri come monitorare l'utilizzo dei connettori.
- Scopri come visualizzare i log dei connettori.