Availability
This routine is available starting with
- JJUPIN 2.5
- katl-commons 2.5
Syntax
lfSet(field, value, [triggerChange]);
Description
Sets the field with the given values.Note that this sets the value on the screen only. It does not set the value on the issue because setting it on the issue requires direct access to the field.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| field | String | Yes | The field to set the value for. |
| value | String | Yes | The value to set. It can be a string value or an array with string values. |
| triggerChange | Boolean | No | If set to true, triggers the change event when lfSet is used on a field. Available since v. 2.5.6 for Jira 5.x and v. 2.6.1 for Jira 6.x. |
Examples
The following code example sets the standard priority field as Major.
lfSet("priority", "Major"); // where field = "priority" and value = "Major"
Warning
The value will not be saved in the database. To save value in the database you should do something like:
priority = "Major"; // this saves the value into the database
However, make sure you're not on the create screen.
You can set multiple values to a field that can have multiple values. For example, you can set the components field to comp1, comp2.
lfSet("components" , {"comp1", "comp2"});
Note
You can't set a field if the values are not available for the given field. For example, in order to set components field to comp1, comp2, you have to make sure that comp1 and comp2 are valid components for that issue.
If you try to set, for example, an issue type field using an array like the code below, lfSet will take into account only the first value from the array. So, this will set the issue type to "Task".
lfSet("issueType", {"Task", "Bug"});
If you want to trigger the change event on the field when using lfSet, you can use the optional triggerChange parameter set to "true":
lfSet("customfield_10000", "updated val", true);
Known Issues
There are some fields, from the list provided in Fields and graphic elements supported by Live Fields, that you can’t set the value for:
- Labels, on Edit, Transition, Create screens;
- Estimate (remaining estimate), on Transition screens;
- Votes
- Watchers
On the view screen, when you want to edit a field the last value saved for that field will be displayed.
You can’t set fields that are uneditable. For example, on the issue view screen you can’t set status or resolution fields.
See Also