Interfaces
Version 27 Version 26 39.5.25 39.5.23 39.5.22 39.5.21 39.5.20 39.5.19 39.5.18 39.5.17 German English
Interfaces
Version 27 Version 26 39.5.25 39.5.23 39.5.22 39.5.21 39.5.20 39.5.19 39.5.18 39.5.17 German English
Breadcrumbs

Installation: PLANTA project with Jira

Requirements

The following requirements apply to the use of PLANTA project with Jira:

  • PLANTA project must be installed (at least DB 39.5.15)

  • Jira Server or Jira Cloud must be installed

  • PLANTA link must be licensed.

  • PLANTA Jira link must be licensed

Settings

To enable the integration of PLANTA project with Jira, the following settings must be made:

  • PLANTA Server

    • The following Webservice environment variables for the PLANTA project system that is to communicate with the Jira system must be configured in the manager container of the PLANTA server:

      • webservices__generic_service__enable - must be activated (true)

      • webservices__generic_service__interface - must be configured if necessary

      • webservices__generic_service__port - must be configured

      • webservices__ssl_generic_enable - must be activated (true) if you wish to run Jira on HTTPS.

      • webservices__apikey_auth_filter_generic - must be deactivated (false) because Jira does not authenticate itself to the web interfaces.

      Once the configuration is done, you have to restart the server.


  • PLANTA link

    • define the required parameters in the Jira Authentication area of the Jira Parameters module and select the required interfaces in the Jira Interfaces area.

      • In PLANTA standard, all required standard interfaces are already stored by default.

    • synchronize or link PLANTA project and Jira users in the User Synchronization module.

    • Additionally for Jira Cloud:

      • The global setting jira_platform is set to Jira Cloud. In addition, jira_api_url, the user name (email address), and the API token are entered. The OAuth credentials (jira_oauth_client_id and jira_oauth_client_secret) are optional. If they are empty, authentication is performed via Basic. If Jira requires OAuth, they must be entered. For details, see the section Authentication: Connection to Jira Cloud with OAuth further below.

      • Set up the nightly worklog import (store the interface in jira_cloud_worklog_interface, define the watermark, activate the scheduled event); see Jira Cloud: Worklog Import.

  • PLANTA Project

    • Time Recording Variant = 3 must be preset to enable the transfer of worklogs of hours worked recorded in Jira to PLANTA project.

    • Reverse posting:

      • From DB 27.2.0: Actual bookings from Jira are not recorded by the automatic reverse posting. Changes from Jira are applied directly, regardless of the reverse booking variant, even for postings before the cutoff date. In return, such postings cannot be changed in PLANTA Project, since Jira would overwrite them during the next transfer. Changes to actual load and date are rejected with a message naming the external system, regardless of whether posting reversal is active. If reverse posting is active, changes in the posting modules are reset and reported when saving, instead of being reversed.

      • Up to DB 27.1.0: The interface not support automatic reverse postings. This means:

        • either you use the reverse posting setting Reverse posting variant = 0, but this does not prevent changes on the Jira side (this would require adjustments on the Jira side); the changes are merely not transferred to PLANTA project.

        • or you can generally work without reverse postings (no key date, no release for records transferred to external systems, etc.)

Note

Authentication: Connection to Jira Cloud with OAuth

Information

  • Since version 39.5.22, PLANTA project supports authentication with Jira Cloud via OAuth 2.0. This means that integration into Jira Cloud is possible by default without any individual customization.

  • From the PLANTA perspective, the OAuth connection is optional. The global setting determines whether the authentication is done via OAuth or via Basic (user name and API token): If OAuth credentials are stored, OAuth is used, otherwise Basic. Without an OAuth, the user synchronization requires no OAuth app.

  • If the Jira page requires OAuth, OAuth must be activated correspondingly in PLANTA project, meaning, the OAuth credentials must be stored.

  • The OAuth connection facilitates secure communication between PLANTA project and Jira Cloud when creating, updating, and synchronizing projects, tasks, users, and working time.

Requirements for OAuth

  • Jira Cloud Instance with Activated OAuth 2.0 Integration

  • PLANTA project from version 39.5.22

  • OAuth credentials (client ID and client secret) stored from Jira Cloud in the PLANTA system parameters, see Jira Parameters

  • The Jira OAuth Connect app OAuth 2.0 (3LO) apps, which uses our web interface jira_oauth_authentication as a callback. Required Jira areas:

    • read:jira-user

    • read:jira-work

    • manage:jira-webhook

    • offline_access (for the refresh token, starting from DB 27.2.0)

    • The Jira API user must belong to the Jira administrator group.

Notes on reviewing the access token

  • From DB 27.2.0: The OAuth access token (valid for one hour) is renewed automatically via the refresh token, without a user and without a browser. After the one-time authorization in the Web Client, OAuth interfaces can therefore also run unattended, e.g., in scheduled events. If renewal is not possible, e.g., because access was revoked in Atlassian, the error is reported in the interface log.

  • Systems on which OAuth was already authorized before DB 27.2.0 do not yet have a refresh token and must be reauthorized once.

  • Up to DB 27.1.0: An expired access token could only be renewed via the interactive browser dialog. Unattended runs, e.g., scheduled events, could therefore not use OAuth.

  • The nightly worklog import (Jira Cloud: Worklog Import) only requires user name and API token (basic authentication).