Access

Information

  • In the  Settings module, global settings can be configured which are relevant for the PLANTA link area.
  • Information on the editing and creation of global settings, please refer to the description of the Global Settings module in the PLANTA customizer help area. The module itself provides a general overview of all global settings of the system.

Note

  • If "0" is offered for selection as a parameter value and no value is defined for a particular parameter, it behaves as if it was set to "0".
Parameter - nameParameter - IDMeaning and valuesDefault

Activate SSL validation

link_enable_ssl_validation

Configures whether SSL certificates are validated by PLANTA link. 

Values
0: are not validated 
1: are validated

1

Hostname for web interfaces

planta_link_hostname

This parameter serves to configure the host name which is to be used by PLANTA link in web interfaces.

If the field is not filled, the default host name of the computer is used.


Local host address

local_host_address

Parameter which is used when the local host address must have a specific value (e.g. depending on the Docker environment).

Default value 'localhost'


General Settings (Jira link)

Parameter - nameParameter - IDMeaning 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.

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

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

Jira Passwordjira_password

For Jira Server, both the user name and the password must be entered

For Jira Cloud, only the user name (jira_username) must be filled with the e-mail address of the user. However, this entry is required.

 The user must possess the following rights in Jira:

  • Create/update user
  • Create/update project
  • Create/update issue
  • Create/update workloads


Jira user namejira_username
Jira user groupjira_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 usersjira_sync_new_users

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

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

User Synchronization (Jira link)

Information

  • In the User Synchronization (Jira link) area, the Universally Unique Identifiers (UUIDs) of the interfaces required for using PLANTA project with Jira are stored on the corresponding parameters.

Hybrid Interfaces (Jira link)

Information

  • In the Hybrid interfaces (Jira link) area the Universally Unique Identifiers (UUIDs) of the interfaces required for using PLANTA project with Jira are stored on the corresponding parameters.

General Settings (pulse)

Parameter - nameParameter - IDMeaning and values

API token

pulse_api_token

API token which is to be used for authentication to PLANTA pulse. If no API token is configured, you can use your user name and password.

The API token must be created in PLANTA pulse via API user.

API URL

pulse_api_url

Synchronization between PLANTA project and PLANTA pulse takes place via the address in the API URL parameter. This address must be set in order to be able to use PLANTA Hybrid.

Client URLpulse_client_url

The address in the Client URL parameter is used if PLANTA pulse is opened 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.

pulse Passwordpulse_password

Login data of the user for PLANTA pulse

pulse User Namepulse_username
Synchronize new userspulse_sync_new_users

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

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

Hybrid Interface (pulse)

Information

  • In the PLANTA Hybrid (pulse) area you have to specify the UUIDs of the interfaces required for the functioning of this hybrid variant on the corresponding parameters.