...
1. Installation
Die Installation erfolgt problemlos über den Atlassian Marketplace. Führe dafür folgende Schritte durch:
Öffne das Jira Administrationsmenü und wähle Add-ons aus (Dafür benötigst du Admin Rechte).
Melde dich mit deinen Admin Daten an.
Wähle im Menü auf der linken Seite "Neue Add-ons finden" aus, um den Universal Plugin Manager (UPM) zu öffnen.
Suche im Marketplace nach dem MOCO Plugin für Jira.
Klicke "Installieren".
Das Plugin wird nun automatisch auf deine Jira Instanz installiert.
2. Konfiguration
Bevor das MOCO Plugin für Jira verwendet werden kann, müssen einige Globale Einstellungen vorgenommen werden. Diese findest du unter Jira Administratation → Addons → Moco Einstellungen.
Du benötigst die Base URL deiner MOCO Instanz .
Außerdem brauchst du das Admintoken des jeweiligen Users.
Wo du diese findest, zeigen wir dir in der folgenden Anleitung.
2.1 Die MOCO Base URL
Die Moco Base URL ist die Adresse, unter der die MOCO Instanz erreicht werden kann. In der Regel ist das die URL der Loginseite ohne "/session/new" oder andere Link Erweiterungen.
2.2 Das Admin Token
Das Zugriffstoken eines Users, welcher Zugriff auf das Kundenmodul hat. Über diesen User werden die Optionen für die Dropdownfelder Kunde, Projekt und Tätigkeit abgefragt. MOCO bietet keine andere Möglichkeit über die REST API an diese Informationen zu kommen. Dieses Token wird ausschließlich zur Abfrage der Kunden, Projekte und Tätigkeiten verwendet. Es werden keine Daten im Kontext dieses Users in MOCO geschrieben. Niemand ist in der Lage dieses Token über die Oberfläche auszulesen. Das ist lediglich über die Datenbank möglich.
Um das Admin Token abzurufen, loggst du dich in MOCO ein. Auf dem Profil (orangener Kasten rechts oben) findest du diesen unter dem Reiter Integrationen in dem Feld "Persönlicher API Schlüssel". Dieser muss vollständig kopiert und in Jira eingefügt werden.
Beim Speichern der Seite werden die eingegeben Daten validiert und Jira ruft die Kunden ab. Gelingt dies, erscheint eine Grüne Meldung, dass die Daten gespeichert wurden. Andernfalls erscheint eine rote Fehlermeldung und die Daten sollten auf Richtigkeit geprüft werden.
2.3 Benutzerdefinierte Felder
Das MOCO Plugin erzeugt 3 Benutzerdefnierte Felder in Jira:
MOCO Kunde
MOCO Projekt
MOCO Tätigkeit
Diese Felder werden aus MOCO befüllt und können nur in dieser Konstellation verwendet werden. Je nachdem welcher Kunde ausgewählt wird, ändern sich die Möglichkeiten im Projekt Auswahlfeld. Das gleiche gilt für Tätigkeiten. Um die Felder zu verwenden, muss zuerst ein Kontext angelegt werden. Informationen zum Konfigurieren eines benutzerdefinierten Feldes entnimmst de der Jira Dokumentation. Nachdem die Felder einem oder mehreren Projekten zugewiesen wurden, können sie beim Erstellen von Issues verwendet werden.
| Warnung |
|---|
Bekannter Fehler Aufgrund eines bekannten Fehlers müssen die Customfields in einem globalen Kontext konfiguriert werden. Dieser Fehler wird ab Version 1.1.2 gefixt sein. |
Mit Hilfe dieser Felder steuerst du, auf welche Tätigkeit die Zeit in MOCO gebucht wird. Sind diese Felder in einem Issue nicht vorhanden oder nicht korrekt ausgewählt, funktioniert die Übertragung an MOCO nicht.
2.4 Benutzereinstellungen
| Hinweis |
|---|
Diese folgende Einstellung muss jeder Benutzer, der die MOCO Erweiterung verwenden will, individuell vornehmen. |
Damit ein User die MOCO Erweiterung verwenden kann, muss er sein persönliches API Token (Siehe Punkt 2.2 Das Admin Token) in seinem Jira Profil hinterlegen. Dazu findet man unter Profil → Zanhrad → Moco Optionen eine Konfigurationsseite. Auf dieser kann das persönliche Token hinterlegt werden. Außerdem kann mit der Checkbox "Standardmäßig nach MOCO übertragen" eine Vorauswahl getroffen werden. Wird diese Option ausgewählt, ist beim Erstellen, Bearbeiten und Löschen von Zeiteinträgen in Jira die Checkbox "Nach MOCO übertragen" standardmäßig ausgewählt.
...
1. Installation
You can install the add-on easily via the Atlassian market place. Just follow the steps below:
Open your Jira admin menue and choose add-ons (you need admin rights to do so)
Log in with your admin information
Choose "Find new add-ons" from the menue on the left site to open the Universal Plugin Manager (UPM)
Search the marketplace for the MOCO Time Tracking for Jira add-on.
Click "Install"
The add-on will now be installed automatically on your Jira license
2. Configuration
Before you can use MOCO Time Tracking for Jira you have to carry out some global settings. You will find these under Jira administration → Add-ons → MOCO settings.
You need the base URL of your MOCO instance
You also need the admin token of the respective user
We will show you where to find these in the following instructions:
2.1 The MOCO Base URL
The MOCO base URL is the address of your MOCO instance. Usually it's the URL of the login page without "/session/new" or any other link extensions.
2.2 The Admin Token
The admin token is the access token of a user,who has access to the customer module. Via this user the add-on will import the options for the dropdown fields "Company", "Project" and "Task". MOCO offerns no other possibilities to get to these information through the REST API. This token will only request information about the fields "Company", "Project" and "Task". There won't be any data written in the context of this user in MOCO. Nobody is able to read anything from this token through this interface. It's only possible via the database.
To retrieve the admin token, log into your MOCO profil. In your profil settings (orange square on the right top side) you will find it in the tab "Integration" in the field "Personal API Key". You have to copy the complete key and paste it in Jira.
While saving your entered data will be validated and Jira will retrieve the "Company" data. Is the process successful a green notification will be displayed, saying that your data has been saved. Otherwise you will see a red error message and you should check if your data has been entered correctly.
2.3 Custom Fields
The MOCO add-on creates 3 custom fields in Jira:
[MOCO] Company
[MOCO] Project
[MOCO] taks
These fields are filled with values from MOCO and can only be used in this constellation. Depending on the chosen company you can only select the corresponding projects. The same way applies for projects and tasks. To use this fields you have to create a context. You find information about how to configure a custom field in the Jira Dokumentation. You can use the fields whil creating issues, after assigning one or more projects to them.
Known Issue
Due to a known Issue with the Plugin please configure the Custom Fields in a global context.
Mit Hilfe dieser Felder steuerst du, auf welche Tätigkeit die Zeit in MOCO gebucht wird. Sind diese Felder in einem Issue nicht vorhanden oder nicht korrekt ausgewählt, funktioniert die Übertragung an MOCO nicht.
2.4 User settings
Every user who is using the MOCO add-on has to enter the following settings individually.
To use the MOCO add-on every user has to record his personal API token (same as point 2.2 The Admin Token) in his Jira profil. You will find a configuration page in your profil at the tools dropdown menue with the cog icon. On this site you can enter your personal token. Besides you can make a preselection for the checkbox "Transfer to MOCO by default". If you choose this option, the checkbox in the creating, editing and deleting windows will be checked by default.