| 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)
...
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 change the case of 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.
|
...
Example 1 - Updating a Cascading Select Custom Field
For this example we Example 1.1 and Example 1.2 we will consider the following already existing options of the custom field:
...
| Code Block |
|---|
PARENT1 Child3 Child2 CHILD1 Parent2 Child5 |
Example 1.1 - Updating a Cascading Select Custom Field -
...
Detele missing input values, rename existing input values
| Code Block |
|---|
admUpdateCustomFieldOptions("CF_CASCADE", "updateoptions.txt", "", "DELETE", "NONE", {}, {}, false, false, true, false);
|
...