Local issue fields
If you need to add a new issue field that is not available in Tracker, you can add local fields to your queue.
Note
You can see the list of existing global fields on the Tracker settings
A local field can only be used in the issues of the queue it's linked to. The advantage of local fields is that the queue owner can manage them without the risk of affecting the workflows in other queues. Users working in other queues will not see this field in their issues.
Adding a local field
Alert
By default, only the queue owner can configure a queue.
-
Open the queue page.
-
In the top-right corner of the page, click
Queue settings. -
Go to the Queue fields tab.
-
Click Create field.
-
Select the field type and click Continue.
-
Set parameters for a new field:
-
Category All Tracker fields are grouped into categories. Select the category that best suits the new field:
- System
- Time tracking
- Agile
- SLA
For more information about the fields and categories, see Standard issue fields.
-
Name: Try to give short and concise names to your fields.
-
Name in English: This name is shown in the English interface of Tracker.
-
Type of number (only for fields with the Number type).
-
List items (only for the Drop-down list fields): Enter the possible values and their order.
-
Item selection (only for the Drop-down list fields).
-
Number of employees (only for fields with the User list type).
-
-
Click Create.
Alert
You cannot delete a created local field.
You can hide a local field in the interface using Yandex Tracker API. To do this, set "visible": false, "hidden": true
.
Edit a local queue field
Editing the parameters of a local field is not supported in the Tracker web interface. To do this, you can use the Yandex Tracker API.
Local field constraints
Using local fields
-
To use the query language to search issues by a local field, specify a queue before the field's key or name.
-
When you move or clone issues with local fields to a different queue, the local field values are automatically deleted.
-
When you use macros, triggers, or automatic actions, to insert the value of a local field to a comment, formula, or HTTP request by a variable, use the
{{issue.local.<field ID>}}
format.
Where you cannot use local fields
Local fields are temporarily not supported in certain cases. Such support will be implemented later.
-
When creating an issue board, you will not be able to add issues automatically using the value of a local field. You can add this condition later, on the board editing page, using the query language.
-
On the issue board, local fields are not shown on cards.
-
You can't use local fields in SLA rules.
-
You can't edit the values of local fields using bulk change operations.
Accessing local fields via the API
The following two types of actions are supported when working with local fields via the Tracker API:
-
Assign a value to a local field.
To get or change the value for a local field of an issue via the API, specify the field ID in the request body, in the following format:
603fb94c38bbe658********--<field_key>: "<new_value_of_local_field>"
.To find out the ID of a local field, run a query that allows you to get a list of local fields in a certain queue.
-
Change a local field's parameter, such as its name or description, or multiple parameter values. For more information, see the Tracker API reference.