Konfiguration und Installation - garaio/jira2vertec-Gateway GitHub Wiki

Konfiguration des Plugins

Die Konfiguration des Plugins erfolgt über das File JiraToVertec.properties. Die Einstellungen sind grundsätzlich im Source Code vorzunehmen. Sollte das Plugin ohne Source Code vorhanden sein, bitte über ein zip-Tool wie z.B. 7-zip das .jar file öffnen und die Einstellungen in der Konfigurationsdatei anpassen, BEVOR das Plug-in installiert wird.

Konfigurationseinstellungen:

vertecServiceUrl=http://vertecserver.domain.local:8081/xml
vertecAuthServiceUrl=http://vertecserver.domain.local/auth/xml
vertecServiceUser={username}
vertecServicePassword={password}
useVertecCloudAuth=true
vertecJiraReferenceField=referenz
vertecJiraReferenceFieldIsZusatzfeld=false
defaultPhaseIdWennNichtZugeordnet=5812
defaultPhaseIdWennNachbearbeitungNoetig=5813
zeigeProjektbeschrieb=false
projektbeschriebMaxLaenge=25
enableCaching=false;

Die ID's der in Vertec erzeugten Phasen für Leistungen, welche nicht zugeordnet werden konnten oder nachbearbeitet werden müssen erhält man, indem in Vertec auf der entsprechenden Phase der Dialog "Eigenschaften" geöffnet wird. Die dort angezeigte Interne ID ist zu verwenden.

Die Konfigurationseinstellung enableCaching=true führt dazu, dass Daten zu Benutzern und Projektphasen gecached werden. Dies kann die Performance leicht verbessern, wurde aber in dieser Konfiguration nicht umfassend getestet.

Im Feld vertecJiraReferenceField wird der Name des Feldes angegeben in dem die Jira Referenz ID der Jira Leistungsbuchung gespeichert wird. Dieses Feld kann ein Feld sein welches sich in der Datenbanktabelle OffeneLeistung befindet, oder ein Zusatzfeld. In beiden Fällen muss dies ein Feld des Typs "Zeichen" sein. Falls es sich bei der Angabe um ein Zusatzfeld handelt muss die Einstellung vertecJiraReferenceFieldIsZusatzfeld auf den Wert true gesetzt werden. Andernfalls geben Sie für diese Einstellung den Wert false. Der Standardwert für das Feld vertecJiraReferenceField ist referenz. Falls das Feld leer gelassen wird, geben Sie für die Einstellung vertecJiraReferenceFieldIsZusatzfeld zwingend false an. Bei Fehlerhafter Konfiguration dieser beiden Einstellungen kann es zu Fehlern beim Erstellen, Löschen oder Ändern von Leistungen kommen.

Vertec Cloud Service

Falls useVertecCloudAuth den Wert true hat wird über den Cloud Service per definierter Username/Password Kombination ein Token angefordert und im Cache zwischengespeichert. Dieses Token wird für die Authentifizierung beim XML Server verwenden. Ist der Wert auf false wird bei jedem Request die definierte Username/Password Kombination zur Authentifizierung verwendet. Die Verwendung des Vertec Cloud Service benötigt ausserdem die Einstellung vertecAuthServiceUrl.

Projekt-Beschrieb

Mit dem Property zeigeProjektbeschrieb kann definiert werden, ob der Projekt-Beschrieb im Projekt-Namen ausgegeben werden soll:

zeigeProjektbeschrieb=true (Projekt-Beschrieb wird ausgegeben)
zeigeProjektbeschrieb=false (Projekt-Beschrieb wird nicht ausgegeben)

Sortiert wird anhand des Projekt-Beschriebs. Mit dem Property projektbeschriebMaxLaenge wird die maximale Länge festgelegt.

Konfiguration in Vertec

Der vertecServiceUser muss ein aktiver Bearbeiter in Vertec sein. Dieser Bearbeiter benötigt folgende Berechtigungen:

  • Projekt-Administrator (Vertec Standardrecht)
  • Projekt-Fremderfasser (Vertec Standardrecht)
  • "Alle erteilen" auf der Klasse "Leistung"

Installation

Das Plugin muss in JIRA installiert und aktiv sein (sollte nach der Installation per Default der Fall sein).

Anschliessend ein Custom Field vom Typ "Auswahlfeld für Vertec Phasen." hinzufügen und folgende Einstellungen vornehmen:

  • Name z.B.: Vertec Phase
  • Search Template: Exact Text Searcher
  • Vorgangstypen: Any Issue Type
  • Application Context: Global context
  • Screens: Default screen
  • Zudem braucht es einen Benutzer (Lizenz) in Vertec

Das Plugin hat Abhängigkeiten zu com.sun.xml.internal.bind.v2.ContextFactory. Diese Klasse ist nicht Teil von JIRA und muss deshalb mit dem Installations-JAR ausgeliefert werden (jaxb-impl-2.1.jar). Momentan ist nicht klar wie JIRA sich verhalten würde, falls ein anderes Plugin das gleiche JAR, evtl. auch mit einer anderen Versionsnummer, mitliefern würde.