Asistované nastavení Tempo Integrace
Asistované nastavení
Pomocí vyhledávacího panelu otevřete aplikaci Asistované nastavení. Vyhledejte položku Nastavení Tempo Integrace a spusťte ji kliknutím na její název. Poté se zobrazí průvodce nastavením. Chcete-li pokračovat, zvolte možnost Další.
Výchozí hodnoty a vytváření zdrojů
V následujících dvou krocích je potřeba nastavit výchozí hodnoty, které bude systém automaticky vyplňovat při vytváření deníků projektů, a zda chcete automaticky vytvářet nové zdroje při stahování worklogů do systému Business Central.
Vaši Šablonu deníku projektů doporučujeme nastavit pouze jednou, například na šablonu s názvem Projekt, a už ji v průběhu používání integrace dále neměnit.
Pokud již byl do deníků projektů s touto šablonu stažen nějaký worklog a poté byl zaúčtován, tuto hodnotu již nebude možné měnit.
Pokud byl worklog pouze stažen a nezaúčtován, je stále možné jej smazat a šablonu v nastavení změnit.
Výchozí měrná jednotka zdroje by měla být vždy nastavena na hodnotu Hodina, protože integrace je přizpůsobena pouze pro práci s hodinovými sazbami.
Hodnotu Výchozí Obecné účto skupiny zboží zdroje lze nastavit na libovolnou účto skupinu podle potřeb vašeho systému, např. Různé.
Autentizační metody
Jira podporuje dvě hlavní metody autentizace.
Basic autentizaci, kterou je jednodušší nastavit, ale je nutné ji každé tři měsíce obnovovat. Tuto metodu doporučujeme, pokud s naší integrací teprve začínáte a chcete si vyzkoušet její celkovou funkcionalitu a otestovat volání API.
Vzhledem k tomu, že se od metody Basic bude postupně upouštět, doporučujeme pro každodenní provoz v produkčním prostředí používat metodu OAuth 2.0 využívající tzv. bearer token. Tato metoda je bezpečnější, má o něco složitější nastavení, ale platnost tokenu je pravidelně automaticky aktualizována, aniž by na to musel uživatel myslet.
Na druhou stranu Tempo podporuje pouze OAuth 2.0 metodu.
Na základě výše uvedených možností jsme navrhli dva způsoby, jak se můžete autentizovat: Autentizace pomocí souhlasu uživatele, která odpovídá metodě autentizace OAuth 2.0 v systémech Jira i Tempo. Pokud se rozhodnete použít tuto metodu, ponechte zapnutá obě přepínací tlačítka ze snímku obrazovky výše.
Druhou možností autentizace je Autentizace pomocí vložení tokenu, která odpovídá metodě Basic autentizace v systému Jira a metodě OAuth 2.0 v systému Tempo. Pokud se rozhodnete používat tento typ autentizace, na snímku obrazovky výše vypněte obě přepínací tlačítka.
Obě možnosti autentizace jsou podrobně popsány v následujících kapitolách. Pro účely této dokumentace jsou dostupné metody autentizace popsány ve dvojicích, ale můžete je libovolně kombinovat. Při přechodu z jedné metody na druhou je pouze potřeba se ujistit, že jsou vyplněny všechny požadované přístupové údaje. Při přechodu z autentizace pomocí vložení tokenu na autentizaci pomocí souhlasu uživatele je navíc potřeba použít obě funkce Autorizovat Tempo a Autorizovat Jira.
V případě, že byste si naše řešení nainstalovali, nastavili na autentizaci OAuth 2.0 a několik měsíců jej nepoužili, se může stát, že po takto dlouhé prodlevě se již API tokeny automaticky neobnoví, což by znamenelo, že nebudete moci stahovat nové worklogy. V takové situaci stačí použít naše akce Autorizovat Tempo a Autorizovat Jira, které jsou k dispozici v Průvodci asistovaným nastavením i v Nastavení Tempo integrace.
Autentizace pomocí souhlasu uživatele (OAuth 2.0)
Pokud jste zvolili tuto metodu autentizace, ponechte obě přepínací tlačítka na třetí stránce průvodce nastavením zapnutá.
Redirect URI
Redirect URI určuje adresu, na kterou Jira a Tempo přesměrují prohlížeč během procesu autentizace. Formát adresy se vždy skládá z URL adresy vašeho systému Business Central, včetně ID tenantu a názvu prostředí, a na konec je potřeba přidat /OAuthLanding.htm.
Při zadávání těchto informací se ujistěte, že jste správně zadali všechna lomítka. Zde je příklad pro kontrolu vaší adresy:
https://businesscentral.dynamics.com/tenant/environmentName/OAuthLanding.htm
Přístupové údaje k Jira a Tempo
V tomto kroku je potřeba vyplnit přihlašovací údaje k aplikacím Jira a Tempo.
Hodnota Jira Base URL je URL adresa vaší společnosti v systému Jira, například https://my-company-jira-url.atlassian.net/.
Hodnoty vašeho Jira Client ID a Jira Client Secret můžete získat z vašeho Jira vývojářského účtu na https://developer.atlassian.com/.
Jděte do vývojářské konzole a vytvořte novou aplikaci.
Při vytváření nové aplikace pomocí tlačítka Create v pravém horním rohu obrazovky je potřeba aplikaci pojmenovat a zadat typ integrace OAuth 2.0.
Po otevření aplikace se zobrazí stránka s několika menu položkami. V části Overview není nutné nic nastavovat. V části Distribution stačí nastavit aplikaci jako soukromou výběrem možnosti Not sharing.
V části Permissions vyberte možnost Jira API a pro Jira Platform REST API zaškrtněte oprávnění View Jira issue data a View user profiles pomocí tlačítka Edit Scopes v pravém horním rohu obrazovky.
V části Authorization je potřeba zadat Callback URL, které odpovídá Redirect URI nakonfigurovanému v předchozím kroku průvodce.
V části Settings pak naleznete informace potřebné k dokončení vašeho nastavení připojení k aplikaci Jira, hodnoty vašeho Jira Client ID a Jira Client Secret.
Po úspěšném vygenerování všech přístupových údajů Jira a jejich zadání do průvodce nastavením klikněte na tlačítko Autorizovat Jira v pravém dolním rohu okna průvodce. V prohlížeči se otevře nové okno s názvem aplikace, kterou jste vytvořili v předchozím kroku, a seznamem oprávnění, která tato aplikace má. Chcete-li aplikaci udělit oprávnění k přístupu k vašim datům v systému Jira, klikněte na tlačítko Accept v pravém dolním rohu stránky.
Úspěšnost akce poznáte podle toho, že se zobrazí níže uvedená hláška.
Po dokončení autorizace systému Jira můžete přejít k další části pro připojení k systému Tempo.
Chcete-li získat hodnoty Tempo Client ID a Tempo Client Secret, jděte do nastavení aplikace Tempo, klikněte na Oauth 2.0 Applications v sekci Data Access v postranní nabídce nalevo a vytvořte novou aplikaci kliknutím na tlačítko v pravém horním rohu stránky.
V dalším kroku se zobrazí krátký formulář, do kterého je potřeba zadat název aplikace, redirect URI adresu, kterou jste již konfigurovali v předchozích krocích průvodce nastavením, a nastavit hodnotu Client Type na Confidential.
V dalším kroku získáte potřebné přístupové údaje. Nyní je můžete zkopírovat do průvodce nastavením v Business Central.
Po úspěšném vygenerování obou přístupových údajů Tempo a jejich zadání do průvodce nastavením klikněte na tlačítko Autorizovat Tempo v pravém dolním rohu okna průvodce.
Úspěšnost akce poznáte podle toho, že se zobrazí níže uvedená hláška.
Číslo pole Account
V tomto kroku je třeba získat číslo pole účtu Tempo přidruženého k vašim projektům Jira. Tuto hodnotu získáte tak, že kliknete na tři tečky na řádku níže a číslo pole se samo doplní.
Pozor, v průběhu nastavování všech kroků na této stránce, je nutné dodržet pořadí, v jakém jdou jednotlivé sekce za sebou a zvolit odpovídající akce pro autorizaci, jinak se vám číslo pro účet Tempo nevyplní správně.
Nejdříve tedy nastavíte Redirect URI
Poté následuje připojení k vaší Jira instanci a autorizace
Následně připojení k Tempo a autorizace
A posledním bodem je dotažení čísla pole Account
Po dotažení čísla pole pro účet Tempo můžete připojení otestovat pomocí našich automatizovaných testů v následující části průvodce nastavením s názvem Testy API klíčů a oprávnění.
Autentizace pomocí vložení tokenu (Basic and OAuth 2.0)
Pokud jste zvolili tuto metodu autentizace, ponechte obě přepínací tlačítka na třetí stránce průvodce nastavením vypnutá.
Při použití metody Autentizace pomocí vložení tokenu bude obrazovka nastavení vypadat takto:
Přístupové údaje k Jira a Tempo
Nyní můžete přejít k nastavení připojení k systému Jira.
Hodnota Jira Base URL je URL adresa vaší společnosti v systému Jira, například https://my-company-jira-url.atlassian.net/.
Hodnota Jira API Email je e-mail uživatelského účtu Jira, prostřednictvím kterého se bude integrace vytvářet. Pokud si nejste jisti, jakou úroveň oprávnění by měl mít váš uživatel Jira, podívejte se na naše obecná doporučení na začátku hlavní dokumentace Tempo Integrace.
Chcete-li získat Jira API klíč, přejděte do svého prostředí Jira a vyhledejte nastavení účtu Atlassian, které je dostupné přes ozubené kolečko v pravém horním rohu hlavního horizontálního menu.
Jakmile se dostanete do nastavení účtu, vyhledejte v horním horizontálním menu záložku Security a poté vyhledejte API tokens. Vytvořte nový token pomocí tlačítka Create API token button.
V dalším kroku budete vyzváni k zadání a potvrzení názvu tokenu. Na následující obrazovce se zobrazí váš Jira API klíč, který můžete zkopírovat do průvodce nastavením v Business Central.
Jakmile je nastaveno připojení k systému Jira, můžete přejít k části Nastavení připojení k Tempo.
Chcete-li získat hodnotu Tempo Access Token, jděte do nastavení aplikace Tempo, klikněte na API Integration v sekci Data Access v postranní nabídce nalevo a vytvořte nový token kliknutím na tlačítko v pravém horním rohu stránky. Do formuláře, který se zobrazí, zadejte název tokenu.
Doba platnosti může být obvykle nastavena na 30, 90 nebo 365 dní.
Poté vyberte z možností přístupu možnost Custom Access. V možnostech oprávnění, které se zobrazí níže, zaškrtněte všechna oprávnění View a oprávnění Manage ponechte nezaškrtnutá, protože integrace nebude provádět žádné změny v datech. Jakmile jsou oprávnění nastavena, potvrďte výběr.
Poté, co nastavení potvrdíte, obdržíte svůj Tempo Access token, který pak zkopírujete do průvodce nastavením v aplikaci Business Central.
Pokud potřebujete obnovit platnost svého tokenu Tempo, můžete tak učinit pomocí funkce Regenerate, která je dostupná z nabídky se třemi tečkami na řádku s tokenem, nebo můžete vytvořit nový token.
Číslo pole Account
Číslo pole Tempo účtu přidruženého k projektům Jira lze získat stejným způsobem jako u autentizace pomocí souhlasu uživatele. Podrobné pokyny najdete v příslušné části dokumentace.
Po dotažení čísla pole pro účet Tempo můžete připojení otestovat pomocí našich automatizovaných testů v následující části průvodce nastavením s názvem Testy API klíčů a oprávnění.
Testy API klíčů a oprávnění
V této části budete vyzváni k zadání klíče pro jeden z vašich stávajících projektů Jira a klíče pro jeden z účtů Tempo, které používáte k logování času na tasky v rámci tohoto projektu. Poté použijte akci Otestovat API klíče v pravém dolním rohu.
Jira klíče projektů
Pokud si nejste jisti, kde tento typ informací najít, nejjednodušší je kliknout na rozevírací menu Projects na hlavním navigačním panelu Jira a poté kliknout na možnost View all projects. Klíče vašich projektů se zobrazí ve sloupci vedle názvu každého projektu.
Klíče účtů Tempo
Klíče účtů Tempo lze snadno najít v bočním menu aplikace Tempo v části Accounts.
Pomocí testů můžete ověřit, že má integrace přístup k vámi zadanému projektu a účtu Tempo a že může stáhnout potřebné informace. Zároveň takto můžete zjistit, zda má váš Jira uživatel dostatečná oprávnění, aby mohla integrace správně fungovat.
Pokud testy proběhnou úspěšně, bude příslušný řádek vyplněn zeleným nápisem OK. V případě chyby se zobrazí podrobnosti o daném volání API.
Ačkoli tento krok není povinný, všechny testy by měly být úspěšné, než přejdete k dalšímu kroku. Dokončením všech testů zajistíte, že integrace bude fungovat správně.
Testy jsou pro oba typy autentizace stejné.
Nastavení Fronty úloh
Vzhledem k tomu, že vaše worklogy budou stahovány prostřednictvím položky fronty úloh, můžete si v této části průvodce nastavením definovat datum, do kterého zůstane období předchozího měsíce otevřené, a přizpůsobit tak délku tohoto období potřebám vaší společnosti.
Pokud provedete změny ve worklozích předchozího měsíce v systému Tempo po datu začátku dalšího období, budete muset upravené worklogy stáhnout ručně.
Na příkladu ze snímku obrazovky níže lze worklogy za předchozí měsíc stahovat až do 5. dne aktuálního měsíce, ale pokud systém stáhne worklogy po tomto datu, do vašeho Business Central se již stáhnou pouze záznamy za aktuální měsíc.
V dalším kroku budete vyzváni k vytvoření položky fronty úloh pro automatické stahování pracovních záznamů z aplikace Tempo. Když kliknete na akci Vytvořit frontu úloh v pravém dolním rohu, systém pro vás vytvoří novou položku fronty úloh a jediné, co musíte udělat, je nastavit stav položky na hodnotu Připraveno.
Pokud v systému z nějakého důvodu už fronta úloh existuje (například při změně metody autentizace), systém vás na to upozorní.
Níže naleznete příklad fronty úloh, kterou pro vás vytvoří naše integrace. Jedná se o standardní položku fronty úloh Business Central. Pokud se o ní chcete dozvědět více podrobností, nahlédněte do příslušné části hlavní dokumentace.
Toto byl poslední krok nastavení a integrace je nyní připravena k použití. Je však pravděpodobné, že nejprve budete chtít provést některá uživatelská nastavení. Toto lze provést v Nastavení Tempo Integrace, které je podrobně popsáno v hlavní části naší dokumentace.