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
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

Jira Parameters MOD009D6O

Introduction

  • PLANTA link role → Jira Interfaces → User Synchronization → Jira Parameters

Information

  • This module lists all global parameters to be defined in order to use PLANTA project in combination with Jira.

Note

  • The parameters contained in this module are only a part of the settings required for the operation of PLANTA project in combination with Jira. For further requirements, please click here.

General Settings (Jira link)

Parameter name

Parameter ID

Meaning and values

API token

jira_api_token

API token which is to be used for authentication to Jira. If no API token is configured, you can use your user name and password. The API token is required for Jira Cloud.

For further information on API token creation, please contact the Jira manufacturer Atlassian.

API URL

jira_api_url

Synchronization between PLANTA project and Jira takes place via the address in the API URL parameter. Must be set in order to be able to use PLANTA project and Jira together.

Client URL

jira_client_url

The address in the Client URL parameter is used to open Jira from the PLANTA project client.

The configuration of the client URL is optional. If the parameter remains empty, the API URL will be used instead.

Jira Platform

jira_platform

Jira Platform: Jira Server or Jira Cloud. In the parameter, "server" or "cloud" is entered.

Jira Password

jira_password

For the Jira Server, both the user name and the password must be entered (alternatively the API token).

For the Jira Cloud the user name (jira_username) with the e-mail address of the user, and the API token (jira_api_token) is required. A password is not required.

The user must possess the following rights in Jira:

  • Create/update user

  • Create/update project

  • Create/update issue

  • Create/update worklog

Jira user name

jira_username

Jira user group

jira_group_name

Name of the Jira user group to which the linked user is to be assigned. By default, users are assigned to jira-software-users. In Jira Cloud, the default group is named jira-software-users-<name of the Jira instance>. You must complete the name in the parameter.

Synchronize new users

jira_sync_new_users

Determines whether new users are to be synchronized with Jira by default (0/1).
The default value is 0.

This setting has no effect on users who are configured via LDAP.

Jira Cloud (Jira link)

Information

  • The following parameters only apply to Jira Cloud (jira_platform = cloud).

Parameter ID

Meaning and values

jira_cloud_worklog_interface

ID of the interface that executes the nightly worklog import. If the parameter is empty, the import is not executed.

jira_cloud_worklog_delta_watermark

Timestamp (Unix time in milliseconds) of the last successful import. Worklog changes are imported from this point in time onward. If the value is empty, the import is not executed; if it is 0, the entire backlog is imported. PLANTA updates the value after each fully successful run; see Jira Cloud: Worklog Import.

jira_oauth_client_id
jira_oauth_client_secret

Client ID and Client Secret of the OAuth-2.0-App in Jira Cloud. Specifying these values is optional. If both parameters are filled in, OAuth is used; otherwise, basic authentication with user name and API token is used; see Installation: PLANTA project with Jira.

User Synchronization (Jira link)

Information

  • In the User Synchronization (Jira link) area, the UUIDs of the interfaces required for using PLANTA Project with Jira are stored in the respective parameters.

Hybrid Interfaces (Jira link)

Information

  • In the Hybrid Interfaces (Jira link) area, the UUIDs of the interfaces required for using PLANTA Project with Jira are stored in the respective parameters.

Generate API Token for Jira Web Interfaces

Procedure

  • Via the Generate API tokens for Jira interfaces button, an API token for the authentication of Jira in PLANTA project is generated and automatically assigned to the existing standard web interfaces for project-Jira integration. The generated token is immediately visible in the displayed dialog message.

Details

  • All generated API tokens and their assignments can be viewed and managed in the Manage API Tokens module.