Database Picker

The Database Picker scripted field displays database records returned by a pre-configured SQL query from a connected database.

Usage

Examples for usage include:

  • A field to select a customer from your internal customer relationship management database.

  • A field to select the relevant sales contract from a contracts database, for implementation of a new feature.

    1. From ScriptRunner, navigate to Script Fields. The Script Fields page shows all currently configured scripted fields.

      Scripted fields can also be created through Admin→Custom Fields however, they cannot be configured there. For simplicity, navigate to the ScriptRunner Scripted Fields page as outlined above.

    2. Click Create Script Field→Database Picker.

      Before creating a Database Picker scripted field, you must set up a connection to the target database in the Resources tab.

    3. Enter a Field Name. This is the name of the field created.

    4. Add a Field Description.

    5. Enter a Note for the field (optional).

    6. Select a database connection in the Connection field. Configure database connections under the Resources tab.

    7. Two SQL queries are required: a search query and a validation query. Both queries require a unique identifier for the database record being used (such as the primary key).

      This identifier should not change. If you are querying a single table, it most likely has a primary key set up.

      Often, this is called ID and will be an auto-incrementing number.

      The primary key is stored as a string in a varchar column in the connected database, allowing ScriptRunner to handle both strings and numbers as keys. However, if the primary key is a number, it must be cast from a string to a number in queries.

      • The Retrieval/Validation SQL query validates the input and retrieves a display value when viewing the issue.

      • The Search SQL query is used to search the typeahead when creating, editing, or searching issues.

        We strongly suggest using the Preview function to check SQL queries.

    8. Check the Multiple checkbox for a multi-select field. Leave unchecked for a single-select field.

    9. Enter a Preview Issue Key and click Preview. The preview runs the Retrieval/Validation SQL and Search SQL queries for the issue provided. Use the preview to check for errors in your queries.

    10. After confirming the queries work as expected, click Add.

Accessing display value

Database picker fields selected values are stored as a unique identifier for the related database entry.

If you want to obtain the display value of a database picker in plain text programmatically, you can use the methods shown in the script below:

import com.atlassian.jira.util.velocity.CommonVelocityKeys
import com.atlassian.jira.component.ComponentAccessor

def issue = Issues.getByKey("FOO-1")
def fieldName = "My Db Values Picker"

def customFieldManager = ComponentAccessor.customFieldManager
def fieldLayoutManager = ComponentAccessor.fieldLayoutManager

def dbPicker = customFieldManager.getCustomFieldObjectsByName(fieldName).first()
def fieldLayoutItem = fieldLayoutManager.getFieldLayout(issue).getFieldLayoutItem(dbPicker.id)

def displayParameters = [(CommonVelocityKeys.TEXT_ONLY): true]
def textDisplayValue = dbPicker.getViewHtml(fieldLayoutItem, null, issue, displayParameters as Map)
textDisplayValue?.trim()
Copy


On this page