Gears properties manager for jira

=20

Function

The main goal of Gears Properties Manager is to manage system level and = global parameters;

In some enterprises with strong development ability, it is inconvenient = to use some global variables in various app For example, in ScriptRunner, s= ome customized scripts are often written into the workflow to obtain busine= ss data and send it to the third-party system. The third-party information = may include some URLs, account names and passwords, or other parameters. Wh= en these parameters are written more, the workload of modifying these workf= lows will be a challenge for changing them.

Therefore, the use of this app is to define global parameters, which can= be referenced to any required address. Just remember the key and value, an= d it will have the effect of one modification then all modifications.

At the same time, because of the global visual management of these param= eters, it is more convenient for operation and maintenance. You only need t= o query in the system without asking the specific developers how to define = them.

Scenario

For example,= we have written a large number of scripts in the scheduled tasks, fields a= nd postfusion of ScriptRunner. This script uses a user-defined field (devel= opment leader) and uses its value for many business processing.

In this case, we write multiple scripts and put them in different places= . Usually, we will write the obtained value of this custom field in the scr= ipt

customFieldManager.getCustomFieldObjectByName= ("development leader")

=20

=E6=9C=AC=E9=A1=B5=E5=86=85=E5=AE=B9

=20

Function
Scenario
Parameters=20
- Prefix
- Key-Value
Usage
REST API=20
API

=20

In this scenario, if the development leader says that it is necessary to c= hange a name to: "Dev leader", then we need to find all the scripts in the = system that use this code to modify its value.

Or we can write it this way,

customFieldManager.getCustomFieldObjec (123456L)=

In this case, it is also possible that this field is accidentally delete= d and re created; Then its ID value will also change. You still need to fin= d all the scripts in the system that use this code to modify its value.

Or in the following cases, the ID value or name is inconsistent in our p= roduction environment or test environment, which will also lead to the scri= pt debugged in the test environment, and the script obtained from the produ= ction environment can only be run by changing this value one by one.

For the above scenarios, using this plug-in, we can define a fixed varia= ble in it. The value of this variable can be quickly managed visually. Afte= r modifying this value, all the changes in the system will take effect, whi= ch makes it convenient for us to manage these variables in a unified way, s= o as to achieve visual and global management of variable scripts used every= where in our system.

Parameters

In order to manage global parameters and facilitate the maintenance of m= anagers, for example, if an administrator needs to write multiple parameter= s for interfacing with a third-party system, he can group by these paramete= rs;

Therefore, the global grouping will be distinguished by prefix in this a= pp; When managing parameters, you first need to determine which prefix for = them .

Prefix
Prefix information is a definition of grouping global parameters, so pre= fix management is required.

You can navigate to the prefix information to add and manage prefixes. A= fter saving, the prefix information defined in the system will be displayed= .

Key-Value

Key-value is effective information provided for business use. It is allo= wed to add a key value pair to the corresponding prefix to obtain informati= on through full key in the system.

You can select the prefix defined in the system to query all key value p= airs included in this prefix. Of course, you can also modify a key value pa= ir.

If you need to add a new key value pair to a prefix, you can add one. At= this time, click "add" to pop up the add interface

Usage

When the key value pair is defined and newly added, its information can = be obtained where needed for business processing.

Yes, you can use this kind of com.atlassian.jira.config.properti= es. Applicationproperties and use its getText() m= ethod.

=E9=94=AE=E5=80=BC=E5=AF=B9=E4=BD=BF=E7=94=A8

=20

String v=
alue =3D applicationProperties.getString($fullkey) ;

=20

REST API

Get all key-values information for a prefix

REST URL

/rest/gears= properties/1.0/properties/prefix/{prefixkey}

Method
=

get<= /span>

Example

/rest/gearsproperties/1.0/properti= es/prefix/ITDESK

=20

{
"fullkey": "HKTXPROPERTIESKEY.ITDESK.StaffId",
"prefix": "ITDESK",
"key": "StaffId",
"value": "1123"
},
{
"fullkey": "HKTXPROPERTIESKEY.ITDESK.key1",
"prefix": "ITDESK",
"key": "key1",
"value": "value11"
},
{
"fullkey": "HKTXPROPERTIESKEY.ITDESK.key2",
"prefix": "ITDESK",
"key": "key2",
"value": "value22"
}
]

=20

Get a value for a specific full key

REST URL

/rest/gears= properties/1.0/properties/fullkey/{fullkey}

Method
=

get<= /span>

Example

/rest/gearsproperties/1.0/properti= es/fullkey/HKTXPROPERTIESKEY.ITDESK.StaffId

[

=20

{
"fullkey": "HKTXPROPERTIESKEY.ITDESK.StaffId",
"value": "1123"
}

=20

API

First, we define a variable value by this app=EF=BC=88 prefix is=EF=BC= =9ASCRITRUNNER=EF=BC=8CKEY is =EF=BC=9ADEV_OWNER=EF=BC=89 then its fullkey = is=EF=BC=9AHKTXPROPERTIESKEY.SCRITRUNNER.DEV_OWNER , value is=EF=BC=9A123456

Your code may be like this

import com.atlassian.jira.config.properties.A= pplicationProperties

String <= span style=3D"color: rgb(255,0,0);">devOwnerCustomfieldId =3D applic= ationProperties.getString("HKTXPROPERT= IESKEY.SCRITRUNNER.DEV_OWNER") ;

CustomField devOwnerCustomfield =3D customFi= eldManager.getCustomFieldObject(Long.parseLong(devOwnerCustomfieldId));

ApplicationUser devOw= nerUser =3D issue.getCustomFieldValue(devOwnerCustomfield);

=20