| Info | ||
|---|---|---|
| ||
This routine is available starting with SIL Engine™ 4.6.3. |
Syntax
admUpdateCustomFieldOptions(fieldName, pathToFile, charset, actionForOldFieldValues, actionForExistingFieldValues, projectKeys, issueTypes, useDefaultScheme, reorder, updateExistingOptionsValues, applyActionsOnParentOptions)
...
If the project keys and issue types are not specified (empty arrays), the option will be added to the global context.
This routine only handles custom fields of the following types: single select, multi select, radio buttons and , checkboxes and cascading selects.
...
Parameter name | Type | Required | Description | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| fieldName | string | Yes | Name of custom field. | ||||||||||
| pathToFile | string | Yes (can be empty string) | The path to a file to read options from. If this parameter is empty, an empty list of options will be considered.
| ||||||||||
| charset | string | Yes (can be empty string) | The character set to use when reading from file. If this parameter is empty, then the default system charset will be used. | ||||||||||
| actionForOldFieldValues | string | Yes (can be empty string) | The action to take for the field values (options) that are present in the current field options but are not present in the input options. Possible values: "NONE", "DISABLE", "ENABLE", "DELETE". If this parameter is empty, the value "NONE" will be used. | ||||||||||
| actionForExistingFieldValues | string | Yes (can be empty string) | The action to take for the field values (options) that are present in the current field options and are also present in the input options. Possible values: "NONE", "DISABLE", "ENABLE", "DELETE". If this parameter is empty, the value "NONE" will be used. | ||||||||||
| projectKeys | string array | Yes (can be empty array) | Project keys. | ||||||||||
| issueTypes | string array | Yes (can be empty array) | Issue types. | ||||||||||
| useDefaultScheme | boolean | Yes | Specify if you want to use the default configuration scheme (or context) of this custom field. | ||||||||||
| reorder | boolean | Yes | Specify if you want to reorder the options as they are given in the input file. | ||||||||||
| updateExistingOptionsValues | boolean | Yes | Specify if you want to update the existing options with the values provided in the input file. This option is needed because Jira considers for example that the option "ABC" is the same as "abc". This option allows you to rename the options. | ||||||||||
| applyActionsOnParentOptions | boolean | Yes | Specify if you want the actionForOldFieldValues and actionForExistingFieldValues to also be applied to parent options, or just child options.
|
...
| Code Block |
|---|
Parent1(disabled) Child1(disabled) Child2(disabled) Child3 Parent2(disabled) Child4 Child5 Parent3 NewChild |
Option "Parent2 - Child4" is going to be removed, because the actionForOldFieldValues parameter is "DELETE".
...
Example 2 - Updating other custom fields
Updating custom fields with types different than cascading select, works exactly the same, except the fact that the applyActionsOnParentOptions parameter should always be set to true.
The new option "PARENT1 - Child3" is added at the end of the existing options because the parameter reorder was set to false.
Example 2
| Code Block |
|---|
admAddCustomFieldOption("New Option", "Select List", "TEST", "Bug"); |
Add the "New Option" to custom field "Select List" with context for project "TEST" and issue type "Bug".
...
This is because these types of fields only use parent options (no child options).
That means that an example of the input file, "updateoptions.txt" could look something like this, for cascading select:
| Code Block |
|---|
Option 1
Child option 1
Child option 2
Option 2
Child option 3
Child option 4 |
and something like this for the other supported types (single select, multi select, radio buttons and checkboxes):
| Code Block |
|---|
Option 1
Option 2
Option 3
|
See also
| Filter by label (Content by label) | ||||||||
|---|---|---|---|---|---|---|---|---|
|
...