Add and configure a new Power custom field
Add a Power custom field
Log in to your Jira instance as an administrator.
Click Administration (
), then navigate to Issues > Custom Fields.
Click Add custom field.
In the Select a field type wizard that opens, click Advanced.
Select one of the available Power custom field types and click Next.
The Select a field type wizard
Contents: |
---|
Each Power custom field type provides configurable selection options for specific use cases. The table below provides a brief description of the available types.
See the individual PCF configuration page for custom field-specific configuration details and examples.
Power custom field type | Description |
---|---|
Provides multiple-option selection from a dynamically populated list. | |
Displays a Jira-style interval field. | |
Provides multiple-option selection from a dynamic data source. | |
Provides multiple-option selection from a dynamic data source using autocomplete. | |
Provides single-option selection using radio buttons populated by a dynamic data source. | |
Provides text field validation based on a regex pattern. | |
Provides field input calculated using a SIL script. | |
Provides a popup picker for user selection, where available users are determined by a SIL script | |
Displays a dropdown select list populated from a dynamic data source. | |
Displays a dropdown select list of options generated by a Simple Issue Language (SIL) script |
Give your field a name and description, then click Next.
Configure the issue type context for the new Power custom field.
Configure issue contextClick Create.
Associate the field with the required screens.
Until associated, the field is not visible on screens. Once associated, it appears at the bottom of the issue view.
The new Power custom field has been created and appears on the Custom fields page.
General configuration settings for the new Power custom field
Once your Power custom field is created, you can start configuring its settings. It is recommended that you complete the configuration steps in the order they are presented.
To access the configuration settings, locate the field in the Custom fields page in Jira Administration console and select Configure contexts from its respective Actions () menu.
For each context (the combination of projects and issue types where that field can be used), you can set:
Default values: what is pre-filled when the custom field is displayed.
Data options: what users can choose from (if the custom field type uses options).
Most custom fields require the general configuration settings described here. The following Power custom fields are an exception; their default and data options configurations are done differently:
PCF - Regular Expression Custom Field
PCF - SIL Script Custom Field
PCF - SIL User Picker
For detailed instructions, refer to their configuration guides.
Set default value
If your data source requires an issue key, the default value selection won't work on the configuration page because no issue context is available.
To set the default pre-filled value for your Power custom field:
Click Edit Default value.
Start typing to select an option from the drop-down list.
Click Set Default.
Select a data option template
You can select a data option type for your Power custom field from a list of pre-configured templates. You can use any option type with any custom field type. To select a template for a newly created Power custom field:
In the contexts configuration page of the Power custom field, click Edit Field data settings.
Templates for selecting a data option type
The templates are displayed only the first time you open the Field data settings page for a new Power custom field. Once the template is set, clicking the Edit Field data settings link opens the Power custom field configuration Summary page (see screenshot below).
Click the option template you want to choose for your Power custom field. You can use any option type with any custom field type.
Data option type | Description |
---|---|
User (User Picker) | Provides a selection of users from your Jira instance. |
Issue (Issue Picker) | Provides a selection of issues from your Jira instance. |
Component (Component Picker) | Provides a selection of components from your Jira project. After creating the Power custom field, set your project key in the SIL script data source. |
Group (Group Picker) | Provides a selection of groups from your Jira instance. |
Project (Project Picker) | Provides a selection of projects from your Jira instance. |
Version (Version Picker) | Provides a selection of versions from your Jira project. After creating the Power custom field, set your project key in the SIL script data source. |
For additional information and examples, see Option types.
Click Choose Template.
You have now set the option type for your Power custom field. All required properties are set automatically and displayed in the Summary page as illustrated in the example below.
Click Configure.
Change the option type
Once you choose the data option type template for your Power custom field, you can change it only to a string, which is the default option type. You can change a string option type to any supported option type.
For details, review the Supported option types by custom field type section in the Option types page.
Before proceeding with this task, check if your data source supports the new option type.
Changing the data option to another type can invalidate existing field values that do not match the data source options configured for the Power custom field. You will be prompted to synchronize field values to keep matching values and remove invalid ones.
Open the Power custom field configuration settings.
In the Option Type section of the page, expand the drop-down menu as shown in the screenshot below.
Change option type drop-down menuSelect the new data option type.
Click Save.
You are prompted to synchronize the existing values of the Power custom field.
To keep matching fields values and remove invalid values, click Save and sync.
To save the configuration without synchronization, click Save. You can run a sync later from the Maintenance tab of the Power custom field configuration page.
Configure the data source
The data source populates the Power custom field with values. You select and configure the data source for your Power custom field in the Data Source section of the field configuration page.
(Optional) Toggle on if you want to have “None” to display as a valid option for data sources in the custom field’s configuration summary.
Select a data source type and configure the required settings.
See the individual data source type page for additional details.
Data source type | Description |
---|---|
SIL data source lets you use a SIL script to populate Power custom fields. The SIL script runs each time you modify the custom field. The Select a SIL script as data source field displays the path to the generated SIL script location.
Select SIL script as data source
You can write your own SIL scripts to retrieve and display data from databases (using the sql function), files, or legacy systems.
Data source SIL script in SIL Manager
A script used as a data source can return either a string array or a KPOption array. For additional information, see Return types. When you modify a custom field's value (either through inline editing or the edit issue screen) and save your changes, the argv parameter in your SIL script is automatically updated to contain both the field's previous value and the newly set value. This parameter can be accessed in your script using:
| |
SQL data source uses database queries to populate custom fields with values.
SQL data source settings
To set up the database connection:
To configure database filtering:
|
If applicable, add fields as dependent fields to use their values in your data source.
When a dependent field's value changes, the current field automatically updates its options based on the new value.
The Dependent fields setting is available only for Power custom fields of the following type:
PCF - Single Select
PCF - Single Autocomplete
PCF - Multi Select
PCF - Multiple Autocomplete
For additional information, see examples of using dependent fields and refer to the individual Power custom field usage guides.
Click Save.
Configure validation
Power custom field validation is a way to verify that values in your field match allowed options from your data source. You configure the validation settings of your Power custom field in the Validation settings section of the field configuration page.
Select the type of validation you want to use for your Power custom field.
Validation type | Description |
---|---|
No validation (default) | Values are accepted without checking. |
Data source options | Values must match a predefined list from your data source. |
Data source options with query | Values are validated by querying your data source directly. Recommended for autocomplete fields. |
If you are using a data source, select a SIL script that validates values when this field changes.
Toggle Always run script on to run the script regardless of field value changes. When off, the script runs only if values change.
Click Save.
Configure autocomplete
These settings are available only for Power custom fields of the following type:
PCF - Single Autocomplete
PCF - Multi Autocomplete
On the Power custom field configuration page, select the Autocomplete settings tab.
Adjust the required settings:
Autocomplete setting | Description |
---|---|
Minimum characters | Set minimum number of characters required to trigger autocomplete. |
Maximum results | Set maximum number of results to display. |
Filtering strategy | Select how to filter options:
If you have configured the SQL Data Source type for this field, the Filtering strategy is set to Data source by default. |
Click Save.
Select export format
Power Custom Fields offers multiple formats for exporting field data.
In the Export section of the Power custom field configuration page, choose an export format that best suits your needs for data analysis or integration.
The Export section on the Power custom field configuration page
Export format | Description |
---|---|
Historical | The original app format with label and value: Label [Value] |
JSON | Complete data structure in JSON format |
Labels | Only field labels without values |
Values | Only field values without labels |
Click Save.
Additional information
Need support? Create a request with our support team.
Copyright © 2005 - 2025 Appfire | All rights reserved.