Configuring (Legacy) Power Database Custom Fields

Owned by Jonathan Muse
Last updated: Nov 19, 2024
4 min read

Steps

To configure Power Database Fields™, perform the following steps:

  1. Log into your Jira as Admin.

  2. From Jira administration console, go to Add-ons > Manage add-ons.

  3. Ensure that both SIL Engine™ and Power Database Fields PRO™ apps are enabled.

  4. On the Administration page, click Issues, and go to the Custom fields section.

  5. Add one of the following database custom fields. The fields are of the following types:

    • Database Information – database custom field

    • Database Child Information – a child field for the database custom field

    • Data Table Information

    • Database Row Field – database row custom field, this field is available starting with v4.5.0 of the app.

      You must add at least one custom field so that you have something to configure. You can add as many Database Information or Database Child Information custom fields as you need.



  6. Go to Administration > Add-ons > Database Custom Field configuration page.

  7. Configure the parameters as described in the table below. The following picture shows an example of how you can configure the fields.

     

  8. Click Save.

  9. Configure the parameters for the Data Table custom field.

This is it! If everything is configured correctly, in the Create or Edit page for a ticket you should be able to see the values for the main database custom fields configured, and when selecting one of the values for a main database custom field, the values for the child fields for the main database custom field will be automatically filled in.

Fields description

For each main database custom field that you add, there is a set of parameters to configure on the field configuration page. 

Field

Description

Configuration Timeout

Starting with v4.0.8 this field was moved to the Data Table custom field configuration page.

Type

  • Select list – the values of the field appear in a combo box.
    or

  • Autocomplete – the values of the field appear depending on the letters typed in the field, on the ticket screen.

Multiple values

If checked, you can select multiple values from the database for the given database custom field. If clear, you can configure child custom fields described below.

Add none option

Available for the select list types only. You can choose to show None option for each individual database custom field.

Accept any value

Available for the autocomplete types only. When this flag is checked, you can enter free text in the dbcf field input, even if the relevant entry is not listed in the database.

Database(JNDI name)

The JNDI data source. To configure the data source, see Data Source Configuration.

Sql query

The sql query to be run, for instance SELECT col1, col2, col3, col4 FROM testTable. It can either be a simple sql, or a dynamic sql.

Oracle

If you use Oracle, the ";" character placed at the end of the query causes a SQL error because ";" is considered to be an invalid character. Remove this character from the query.

Column

One of the columns selected by the sql query, for instance col1. This column will be used to get the values for a given database custom field. You can also make it read only.

Indexable Field Name

It is used to fetch the row field data from the external database when the ticket is viewed or edited.

The value of this field is saved in Jira. Should be unique.

Indexable Field Label

Customized read-only label for the indexable field.

Selectable Column Name

Use this field to select the necessary table row.

Selectable Column Label

Customized read-only label for the selectable column field.

Cacheable

If selected, this option enables you to get your data faster and enables you to avoid unnecessary queries to the external servers. When the request is made for the first time, its results are stored in Jira cache, so all other requests for the field's values will return cached values, hence improving overall performance. The cache is shared and synchronized over the Data Center deployments.

CacheInterval

Here you specify the time interval between checks for updates to the master database, in seconds. The minimum value is 0 seconds, and it that cache will never be updated.

Add Сhild, Delete

You can configure a list of child database custom fields associated to the main database custom field.

For each child, configure the following fields:

  • Child Custom Field – One of the child database custom fields that you added. These are visible for selection only when multiple values flag isn't checked for the parent database custom field.

  • Child column – One of the columns selected by the sql query, for instance col2. This column will be used to get the value for this child field. The value for the child field is completed automatically after a value for the main database custom field is selected.

  • Read Only – specify whether this field should be editable or read only.

 

Contents

See More