Page History
Panel | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
On this page
|
What are JWT project properties?
UI Text Box | ||||
---|---|---|---|---|
| ||||
Project Properties is a simple mechanism implemented by Jira Workflow Toolbox, to include machine-readable JWT project properties are key-value pairs into projects description, using the format {property=value}, thereby operating as an effective way for adding metadata to your Jira projects. | ||||
UI Expand | ||||
| ||||
added to a project description. The main goal of the properties is to provide project metadata, which can be referenced and used in multiple JWT features. |
Format of JWT project properties
A JWT project property can be added to any project description in the following format:
{propertyKey=propertyValue}
The screenshot shows an example with 5 JWT project properties:
Property key | Property value | Potential use case |
---|---|---|
codeReview | compulsory | Could be used to enforce certain parts of the workflow related to code reviews using Condition on JWT project property or Validation of JWT project property. |
maxResponseTime |
30 | Could be used to set individual SLA times per project. These could be used in combination with JWT JQL functions to set up filter subscription or to automatically update an issue priority using an Update field action. | |
technology | java | Could be used in many JWT functions or expressions using the Advanced text mode. |
database | oracle | Could be used in many JWT functions or expressions using the Advanced text mode. |
stageURL | https://stage/myapp | Could be used in many JWT functions or expressions using the Advanced text mode. |
JWT project properties and workflows
Project properties were initially aimed at customizing
Purpose of project properties
Customizing workflow behavior depending on projects
icon | false |
---|
your workflow behavior depending on project features (metadata added to projects in the form of project properties)
, this way highly improving workflow reusability.
For example you can use project properties to:
- Enable/disable transitions depending on project
- property values.
- Set project customized values for timelines (dates), costs, weights, or any other date
- /numerical values used in your workflows. Can also be used for implementing non-numerical or non-date attributes.
- Set priorities among projects, that may be inherited
- by issues, for example by using priority adjustment tables.
- Provide project related metadata that may be used by the workflow post functions to compose project customized dynamic text, setting custom or virtual fields with project customized values, etc, e.g., customer information, servers URLs, etc.
Tools for customizing workflows
Conditions and Validators
:Check : compare the value of a project property with a literal value, a custom or virtual field value, or a composed text, disabling a transition if the comparison fails.Post functions:Post functions
: updates the value of a project property, or creates it in case it doesn't exist. Works on the current issue's project, or on any project its key can be provided.Logical expressions
JWT project properties can be referenced and validated when writing a logical expression in the Logical mode (e.g in the conditional execution parameter of post functions).
Available functions
JWT provides special parser functions to work with JWT project properties.
Page properties report | ||||||||
---|---|---|---|---|---|---|---|---|
|
JWT project properties and JQL
Function "projectProperty(property_name)" is available in the plugin's parser for reading the value of project property. The parser is a common module of the plugin available for the following features of the plugin:
- Condition "Boolean Condition with math, date-time or text-string terms"
- Validator "Boolean Validator with math, date-time or text-string terms"
- Post function "Set a field as a function of other fields" and "Mathematical and date-time expression calculator".
Enhancing JQL search capability by project attributes
icon | false |
---|
You can use JWT project properties in JQL queries, by using any of the
JQL functions provided by Jira Workflow Toolbox:
- projectsWhereTextProperty( project_property, operator, string_literal | regular_expression )
- projectsWhereNumberProperty( project_property, operator, numeric_literal )
- projectsWhereDateProperty( project_property, operator, date_literal )
You can use it, among other things, to extend the Jira native Project Category concept, by creating several project classifications by using Project Properties.
Page properties report | ||||||||
---|---|---|---|---|---|---|---|---|
|
Setting the
Settingdefault assignee for a project role
icon | false |
---|
You can use JWT project properties in the Assign to project role
" for settingpost function for setting a default assignee for a specific project role
uses Project Properties with a certain format.Example
.
Use cases and examples
Page properties report | ||||
---|---|---|---|---|
|
Setting user "feynman" as default assignee for project role "Developers", with internal identifier 10100. As you can be seen in the picture, you can use the name of the project role, or the internal identifier as the project property name. The second option has the de advantage that it's immune to project role renaming.
Excerpt Include | ||||||
---|---|---|---|---|---|---|
|
Page properties | ||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||
|