Configuring Power Custom Fields

Adding a PCF custom field

  1. Log into your Jira as Admin.

  2. Go to Administration > Issues > Custom Fields page.

  3. Click Add custom field and select one of the available PCF custom fields. Make sure you also select some project screens for it to be present on.
    You can select one of the following field types:

That's it!

Configuring PCF custom fields

After you create the field, go to the corresponding Configure link and fill out / configure the fields on that page, see fields' specifics below.

image-20240212-111826.png

 

Default value

To set the default value, click on “Edit Default value”.

NOTE: For the PCF - SIL User Picker, the default value is set by clicking “Edit Field data settings”.

NOTE: If your option provider data source (described below) relies on an issue/issue key, the default value selection will not work, since there’s no issue context in the field’s configuration page.

Template Configuration

To improve the usability of the app, we have added a template for each option type:

image-20240212-113458.png

 

You don't have to configure any other settings for such custom field. All you have to do is select a template, and the required properties will be set automatically. Thus, you can simply enjoy the goodies that Power Custom Fields offers you. 

For the templates regarding components and versions, edit the SIL script so it uses your own project key.

You can find the script in the field’s configuration page, or on the disk, in the silprograms folder, in the sub-folder named like your custom field ID / field config ID.

Data source types

The data source is used to obtain the values which will populate the custom field. You select the necessary data source type in the respective field.

image-20240212-114004.png

 

A script used as data source can either return a string or an option array. If a string array is returned, its elements will be saved as pairs (value, value). If an option array is returned, the elements will be saved as KPOption structure.

Predefined structure types

Name

Field

Type

Name

Field

Type

KPOption

label

string

value

string

The data source script is also invoked when JQL search is going.

For more information about data source types, see SIL Data Source and SQL Data Source. You can find examples of data sources in our Examples for Power Custom Fields section.

Option Types

For the types of option that you want to use, click the Edit Option Type link. The default option type is rendered as a string.

 

For in formation about other types, see Option types.

Validation Strategy and Execution

You can decide on the type of validation for the custom fields values which you have set, by editing it in the field’s configuration.

 

  • No Validation – the options set to custom field won't be validated

  • Datasource Options – the options set to custom field will be checked by the datasource generated list

  • Datasource Options with query – the options set to custom field will be validated by the datasource which is queried with each label of the selected values. We recommend this option for autocomplete type custom fields.

 

Force script execution – when the "Yes" radio button is selected, the script will be executed even if the value of the field does not change. Otherwise, the script will not be executed if the value is not changed.

Select Script

The SIL Script you select in the field configuration page is used to populate the field’s options and it will run each time when the custom field is modified. Another script can be selected at any time, under the “Pick a SIL Script as data source” section under “Data source”, by clicking the pencil.

 

When a custom field value is changed (either using inline edit or using the edit issue screen and saving the changes), the argv value changes. The argv contains the old value of the custom field and the new value of the custom field.

Autocomplete Settings

The Autocomplete settings tab in the configuration page, helps you configure the autocomplete settings for the custom fields that have the autocomplete functionality.

With the Minimum characters option you can decide which is the minimum number of characters that can be used for the autocomplete.

Maximum results represents the number of the results that can result from autocomplete. In the example above the script will show maximum 50 results.

The Filtering Strategy provides the following options:

  • Implicit - this option filters the values by the label

  • Datasource - this option doesn't use implicit filtering. It calls the datasource to decide what filter should be applied based on the query.


Dependencies

In order to use the screen values for a field in the data source, you have to add it as a dependent field.

Note that when the value of the dependent field is changed, the current fields' values will be recalculated, according to the new value of the dependent field.

You can find an example regarding dependent fields here.

 

What's next

After you add the power custom fields, see User Guide for details on how to use them.

See also