Přeskočit na hlavní obsah

Jira Connector

Jira Connector integruje Alvao do Jira, zefektivnění správy požadavku a komunikace.

Mezi klíčové funkce patří:

  • Vytvořte pracovní položky Jira přímo z Alvao pro bezproblémový pracovní postup.
  • Zajistěte konzistentní stavy požadavku s automatickou obousměrnou synchronizací.
  • Synchronizovat zprávy a přílohy mezi oběma platformami pro účinnou spolupráci.
  • Získejte přístup k pracovním položkám Jira přímo z Alvao pro rychlou a snadnou navigaci.

Ukázkový proces:

Stav požadavku Development je v tomto příkladu mapován na stav pracovního položky ToDo v Jira. Když požadavek v Alvao přejde do tohoto stavu, v Jira se vytvoří pracovní položka definovaného typu. Když pracovní položka vstoupí do stavu In Progress, požadavek automaticky přejde do stavu Development pending. Po vyřešení pracovního položky (stav Done) se požadavek v Alvao převede na stav Testing.

Technické požadavky​

  • Jira Cloud nebo Server

SaaS​

  • Předplatné ALVAO ITSM nebo Service Desk

Instalace v on-prem prostředí​

  • ALVAO Service Desk
  • Alvao REST API dostupné z internetu

Instalace​

Pro instalaci jsou vyžadována práva správce.

  1. Stáhněte si balíček JiraConnector.zip.

  2. Ve Správa Service Desk** - Služby vyberte složku, do které chcete importovat vzorovou službu pro připojení k Jira, a použijte příkaz Importovat pro načtení souboru JiraConnectorServiceEnu.xml, který je součástí souboru JiraConnector.zip.

  3. Přejděte do Správa - Aplikace a zapněte aplikaci Jira Connector.

    Manuální stažení: JiraConnector.xml

Jira účet pro integraci​

  1. V Jira vytvořte vyhrazený uživatelský účet pro tuto integraci, pojmenujte jej "Alvao Connector" a vytvořte pro účet osobní přístupový token (PAT).

  2. Přejděte na Správa - Nastavení - Pokročilé. Použij příkaz Nové nastavení k vytvoření nastavení JiraIntegrationToken0 s hodnotou:

    • Pro Jira Cloud (Pronájem) zadejte hodnotu ve formátu \<username>:\<PAT>, např. james.smith@onmicrosoft.com:TT3xGF0T97pYKtidC3mcL5SC_71xB9irVIZozbnHg, kde \<username> je e-mailová adresa účtu.
    • Pro Jira Server (on-premise) zadejte PAT vyhrazeného uživatelského účtu.

  3. Ujistěte se, že účet má následující oprávnění:

    • Projektová oprávnění:
      • Browse projects
      • Create issues
      • Create attachments
      • Add comments
      • Transition issues
    • Global permissions
      • Browse users and groups (při použití nastavení TicketReporter=Requester)
Tip

Pokud například potřebujete integrovat Jiru z různých organizací do jedné instance Alvao, můžete použít více uživatelských účtů a jejich přístupové tokeny. Vytvořte nové nastavení a zvyšte číslo na konci názvu nastavení. Pak použijte toto číslo v položce AccessToken v níže uvedeném nastavení služby.

Rozsahový API token Jira Cloudu​

Jako alternativu k výše popsanému klasickému API tokenu Jira Cloud také podporuje servisní účty spravované na úrovni organizace s rozsahovými API tokeny (pověřeními), které omezují přístup pouze na potřebná oprávnění.

  1. Přihlaste se jako administrátor organizace do Atlassian.
  2. Přejděte do Adresáře – Servisních účtů a vytvořte nový servisní účet (např. pojmenujte Alvao Connector).
  3. Otevřete servisní účet a použijte příkaz Vytvořit pověření.
  4. Po vyzvání k výběru typu pověření zvolte API token.
  5. Pověřením přiřaďte popis, např. Alvao Connector, vyberte aplikaci Jira a zvolte následující klasické rozsahy:
    • read:jira-work – prohlížení projektů, čtení požadavků, seznam stavů a příloh.
    • write:jira-work – vytváření požadavků, přidávání komentářů, nahrávání příloh, provádění stavových přechodů.
    • read:jira-user – rozlišení uživatelů (zapisovatel požadavků, autoři komentářů, vyhledávání integračního účtu).
  6. Klikněte na Vytvořit a okamžitě si zkopírujte vygenerovaný API token (zobrazuje se pouze jednou).
  7. Použijte token v pokročilém nastavení JiraIntegrationToken0 ve formátu \<username>:\<token>, kde \<username> je e-mailová adresa servisního účtu.
Tip

Výše uvedené rozsahy jsou obvykle samy o sobě dostačující, protože výchozí schéma oprávnění projektu obvykle již uděluje povinná oprávnění projektu libovolnému účtu s přístupem k produktu Jira. Pokud používáte vlastní/omezené schéma oprávnění, ujistěte se, že účet má také přiřazena oprávnění uvedená výše pro příslušný projekt – rozsahy pouze definují, které API operace jsou povoleny, nenahrazují oprávnění na úrovni projektu.

Info

Požadavky autentizované pomocí rozsahového API tokenu musí být odesílány na bránu API Jira Cloudu (https://api.atlassian.com/ex/jira/\<cloudId>) místo vlastní domény pracoviště (https://\<your-site>.atlassian.net). V nastavení konektoru odpovídajícím způsobem nastavte URL.

Zjištění ID cloudu​

\<cloudId> identifikuje vaše pracoviště Jira Cloud a je vyžadováno pro URL brány API. Získejte jej otevřením následující URL v prohlížeči (ověření není potřeba):

https://<your-site>.atlassian.net/_edge/tenant_info

Odpověď obsahuje cloudId, např.:

{ "cloudId": "30f44b5f-3325-410e-887e-8086fbb413eb" }

Změna URL v nastavení konektoru​

Při použití rozsahového API tokenu nastavte atribut URL v Externí aplikaci - nastavení konektoru na URL brány API včetně ID cloudu místo domény pracoviště:

"URL": "https://api.atlassian.com/ex/jira/30f44b5f-3325-410e-887e-8086fbb413eb"

Nastavení webhooků v Jira​

  1. V Jira, vytvořte nový webhook a nastavte:
    • Jméno – zadejte Alvao Connector.
    • Stav - Povoleno
    • URL - zadejte adresu URL REŽIMU Alvao, po níž následuje cesta /connectors/jiraCallback/{issue.key}, např.: https://contoso.onalvao.com/AlvaoRestApi/connectors/jiraCallback/{issue.key}.
    • Rozsah – nastavte webhook tak, aby byl spouštěn pouze vybranými projekty, např. project = JIRAPROJECT.
    • Události – povolte Komentář – vytvořeno.
  2. Nastavte webhook na být spuštěn přechodem pracovního postupu, který chcete synchronizovat s Alvao (jsou součástí StatusMap).

Nastavení služby v Alvao​

  1. Ve Správa - Service Desk - Služby vyberte službu, kterou chcete připojit k Jira, a použijte Upravit - Vlastnosti.

  2. V sekci Ostatní najděte vlastní pole Nastavení konektoru externí aplikace a upravte jeho hodnotu.

    Výchozí hodnota:

{
    "ConnectorType": "Jira",
    "URL": "https://jira.contoso.com",
    "AccessToken": "0",
    "AttributeMap": {
        "summary": "[$TicketTitle$]",
        "description": "[$OriginalMessage$]",
        "issuetype.name": "Bug",
        "project.key": "JIRAPROJECT",
        "customfield_10123": "[$TicketID$]"
    },
    "StatusMap": {
        "ToDo": "Development",
        "In Progress": "Development pending",
        "Done": "Testing"
    },
    "SyncCommunication": true,
    "DisplayOpenExternalCommand": true,
    "TicketReporter": "Requester",
    "CustomHttpHeaders": {
        "X-AlvaoHeader": "Header value"
    }
}

Legenda:

  • ConnectorType - zadejte text Jira.

  • URL - zadejte URL Jira, např. https://jira.contoso.com. Při použití rozsahového API tokenu Jira Cloudu zadejte místo toho URL brány API s ID cloudu, např. https://api.atlassian.com/ex/jira/30f44b5f-3325-410e-887e-8086fbb413eb.

  • AccessToken - zadejte číslo nastavení osobního přístupového tokenu (PAT), které jste použili v pokročilých nastaveních (obvykle 0).

  • AttributeMap - uveďte seznam polí Jira issue a jejich hodnot. V hodnotách můžete použít stejné proměnné jako pro šablonu oznámení o změně stavu žadateli.

  • StatusMap – určete mapování přechodu pracovních položek Jira do stavů požadavků v Alvao. Při prvním přechodu na stav v Alvao, který je uveden v mapování, se v Jira vytvoří pracovní položka. ID vytvořené pracovní položky je uloženo ve vlastním poli External Application – the ticket ID. Synchronizace stavů probíhá při změně stavu buď v Alvao nebo v Jira.

    Stavy v Alvao jsou ve výchozím jazyce Alvao, zatímco přechody v Jira jsou ve výchozím jazyce Jira.

  • SyncCommunication – (true | false). Pokud je tato možnost povolena, každý záznam komunikace požadavku (e-mailová zpráva, poznámka atd.) je zaznamenáván jako komentář související pracovní položky Jira a každý komentář pracovní položky v Jira označený jako veřejný je zapsán v komunikaci o požadavku Alvao a přidělený požadavek je upozorněn e-mailem nebo MS Teams botem.

  • ShowOpenExternalTicketCommand – (true | false). Pokud je povoleno, příkaz Otevřít související požadavek Jira je zobrazen na stránce Požadavek každého synchronizovaného požadavku.

  • TicketReporter – vyberte, kdo bude určen jako zadavatel pracovních položek v Jira:

    • Default – uživatel, jehož PAT je použit v konfiguraci konektoru.
    • Žadatel – žadatel požadavku v Alvao; Uživateli Alvao je spárován s uživatelem Jira podle uživatelského jména. Pokud není nalezen odpovídající uživatel Jira, je použita možnost Výchozí.
    • Specifické uživatelské jméno uživatele Jira, např. user@contoso.com.

  • CustomHttpHeaders – volitelně další HTTP záhlaví odesílaná do REST API Jira.