How to use the Configuration Wizard

How to use the Configuration Wizard

The Configuration Wizard process is the same for both Advanced Database Row Fields and Advanced Database Table Fields.

The Configuration Wizard provides the fastest way to set up your Advanced Database Fields through a guided, five-step process without the need for manual scripting. It automatically generates the necessary configurations and scripts, so your new database field is ready to use in Jira immediately upon completion.

To access the Configuration Wizard:

  1. Open the custom field configuration page through the Edit Field data settings link.

  2. In the Configuration Wizard section, click Use the Wizard.

Here’s what the Configuration Wizard does:

  • Guides you through field type selection based on your use case.

  • Connects your field to the appropriate data source.

  • Helps you select the right database table and columns.

  • Automatically generates basic scripts and configurations.

  • Creates a fully functional field ready for immediate use.

Let's walk through each step of the process.


Step 1: Choose the field type

  1. On the Choose field's type screen that opens when you start the Configuration Wizard, choose from the available options.

The first screen of the Advanced Database Fields Configuration Wizard

The Advanced Row Field offers two main configuration options based on your requirements:

Readonly fields

Readonly fields support basic value selection and are ideal for displaying reference data from your database. They have one important constraint: the configuration requires exactly two columns—a primary key and a display value column.

Readonly fields come in three display options:

  • Single Select: Enables selection of one value from a complete list of available options.

  • Multi Select: Enables selection of multiple values from the available options.

  • Autocomplete: Uses autocomplete functionality to filter and display options as users type.

Editable fields

Editable fields provide the most flexibility and functionality:

  • Support for multiple columns (not limited to two).

  • Extended configuration options.

  • Ability to configure custom scripts.

  • Most complex setup, but offers the greatest customization potential.

  1. Click Next.


Step 2: Select the data source

On this step, you can select only from previously configured data sources. For more information on configuring a data source, go to the Configuring data sources guide.

  1. On the Choose the data source screen, choose your SQL data source from the available options:

The Select SQL data source drop-down menu on the Choose the data source screen
  1. Click Next to proceed to the next step.


Step 3: Select the table

The tables available for selection are only those provided in the schema of the previously selected database.

  1. On the Choose the table screen, choose the database table you want to use:

The selection drop-down list on the Choose the table screen
  1. Click Next to proceed to the next step.


Step 4: Select the columns

Column selection requirements differ based on your field type choice from Step 1.

  1. On the Choose the columns screen, choose the columns you need:

For read-only Advanced Row Fields

Select only two columns: the primary key and the column that holds the values shown by the field. If the original table already has a primary key column, the Advanced Row Field automatically uses it.

For editable Advanced Row Fields

You can select as many columns as needed. The field layout is designed to display numerous columns, providing flexibility in your choices.

A selection of columns on the Choose the columns screen
  1. Click Next to proceed to the next step.


Step 5: Finalize the field configuration

On the final screen, click Finish to complete the field setup.

The Finish button on the final step of the Configuration wizard

 

Need support? Create a request with our support team.

Copyright © 2005 - 2025 Appfire | All rights reserved.