How to design your own Jira Service Desk Customer Portal? Sign up for the free webinar on June 12!

Extension for Jira Service Desk

Jira Server
HOSTING
Last updated May 13, 2019

Bundled Fields

This section provides information on configuring Bundled Fields.

A Bundled Fields feature allows to bundle all information into one custom field. This custom field is displayed as additional form.

Warning
Before you start, log in as a user with the Jira Administrators global permission.

Note
  • Bundled field feature supports four types of custom fields:
    text fields (single and multi-line), select fields, date pickers and checkboxes.
  • Remember to add the field to the issue screen and to the request type.
  • To check your settings, go to:
    Project Settings > Request Types > Edit fields > Add a field.
Info

For more information on adding a custom field, see official Atlassian documentation.

Add Bundled Field

Steps

To add a bundled field:

  1. Go to Jira Administration > Add-ons.
  2. Select Bundled Fields from the menu in the Extension for Jira Service Desk section.
  3. Click Create Custom Field.
    Creating a Bundled Field configuration with Extension for Jira Service Desk by adding a custom field
    Creating a Bundled Field configuration with Extension for Jira Service Desk by adding a custom field

  4. Click Add custom field.
    The Select a Field Type dialog box appears.
  5. Select Deviniti [Extension] - Bundled Fields from the list in the Advanced section.
  6. Click Next.
    All Deviniti custom fields are branded with the app logo therefore you can find it easy on the list
    All Deviniti custom fields are branded with the app logo therefore you can find it easy on the list

  7. Configure Deviniti [Extension] - Bundled Field’ Field dialog box appears.
  8. Configure the selection criteria (Name and/or Description).
  9. Click Create.
    Now you can type a name and description of bundled fields with Extension for Jira Service Desk
    Now you can type a name and description of bundled fields with Extension for Jira Service Desk

  10. Select the checkboxes of the screens on which this custom field will be displayed.
  11. Click Update.

Result

A new custom field Deviniti [Extension] - Bundled Fields is added.

Configure Bundled Field

To configure a Bundled Field:

  1. Go to Jira Administration > Add-ons.
  2. Select Bundled Fields from the menu in the Extension for Jira Service Desk section.
  3. Select a custom field from the list (below the plus icon) which you want to configure.

    Note
    This list contains all Deviniti [Extension] - Bundled Field custom fields which are added to Jira.

  4. Configure the following:

    • Context: Select in which context of custom field configuration will be set. Each custom field’s context can have own Bundled field’s configuration.
    • Alignment: Select how to compose fields: vertical or horizontal.
  5. Click Add new row.

  6. Configure the following:

    • Field Name: Type name of nested field.
    • Type: Select type of custom field: text, select, checkbox, multi text or date picker.
      Note

      In case of select and checkbox new option is added by clicking New option.

    • Required: Set the state of switch to on to make nested field required.
    • Show Label: Set the state of switch to on to show label of nested field (Field Name).
      Tip
      • Click Copy to copy nested field with configuration and create new rows quicker.
      • Use drag-and-drop to re-order nested fields in the list.
      • Option for deleting configuration is on the right side of the table. Click the trash icon to remove selected fields.

  7. In Layout settings section switch Turn on Edit mode to on.
    Now you can change field’s size and location.

  8. Click Save Layout.

    The next step of creating a Bundled Custom Field configuration with Extension for Jira Service Desk is setting a context, number of rows, alignment, field name and type, required and show label option
    Extension for Jira Service Desk - Bundled Custom Field configuration screen

Result

A new layout configuration is saved.

Note

If you don’t want to save layout settings, click Discard changes on the right side.

Details

Steps

To configure Bundled Fields details:

  1. Click on Details on the right side.
    Go to configuration details of Bundled Fields with Extension for Jira Service Desk
    Go to configuration details of Bundled Fields with Extension for Jira Service Desk
  2. Configure the following:
    • Help: Type text which will help user to fill fields.
    • Default number of rows: Choose default number of bundled field rows.
      For example, if you select five rows, a bundled field will be displayed five times, in five rows.
      Note
      You can select maximum 25 rows.

    • Allow user to add new rows during filling the form: Set the state of switch to on to allow user to add new rows during filling the form.
    • Show label only for the first row (in horizontal alignment).
  3. Click Save.
    Configuration details of Bundled Fields with Extension for Jira Service Desk
    Configuration details of Bundled Fields with Extension for Jira Service Desk

Result

Bundled Fields details are saved.

Example
Show label only for the first row (in horizontal alignment) prevents from repeating field’s labels in case of creating many rows within the issue. If you mark this option as checked, newly created issue will be displayed in the request detail view as in example below.
Example of option: Show label only for the first row (in horizontal alignment) in Bundled Fields with Extension for Jira Service Desk
Example of option: Show label only for the first row (in horizontal alignment) in Bundled Fields with Extension for Jira Service Desk
Example
If you mark Show label only for the first row (in horizontal alignment) as unchecked, field’s labels will be repeated.
Example of no option: Show label only for the first row (in horizontal alignment) in Bundled Fields with Extension for Jira Service Desk
Example of no option: Show label only for the first row (in horizontal alignment) in Bundled Fields with Extension for Jira Service Desk

Using Bundled Fields

Steps

To check how bundled fields work:

  1. Go to Jira Administration > Projects.
  2. Select project from the Project list.
    Welcome guide screen is displayed.
  3. Go to Customer channels.
  4. Click Visit the portal or copy and paste a link into a browser address bar.
  5. Create a request.
  6. A screen with the request is displayed.
  7. Fill in the request details, including the custom field: Deviniti [Extension] - Bundled Field (for example: Address).
    Note
    If you allow user to add new rows during filling the form, the + icon appears below the bundled field.

  8. Click Create.
    Creating a request with horizontal alignment in Bundled Fields with Extension for Jira Service Desk
    Creating a request with horizontal alignment in Bundled Fields with Extension for Jira Service Desk

Result

The request with Deviniti [Extension] - Bundled Field (for example: Address) is created.

Horizontal and vertical alignment

Example

You can configure Bundled fields in horizontal and vertical positions in the request detail view and issue view.
Below you can see the example of Bundled field in horizontal alignment in the request detail view.

Example of request with horizontal alignment in Bundled Fields with Extension for Jira Service Desk
Example of request with horizontal alignment in Bundled Fields with Extension for Jira Service Desk
Example
The example of Bundled field in vertical alignment in the request detail view.
Example of request with vertical alignment in Bundled Fields with Extension for Jira Service Desk
Example of request with vertical alignment in Bundled Fields with Extension for Jira Service Desk
Example
Layout settings allows to resize and relocate fields according to your needs. See the example below.
Creating a request with Layout settings in Bundled Fields with Extension for Jira Service Desk
Creating a request with Layout settings in Bundled Fields with Extension for Jira Service Desk

Bundled Fields Searcher

Extension for Jira Service Desk provides a dedicated searcher. It allows to search issues in Jira which contains a Bundled Fields custom field. There are two options: issue in bundledFieldsEx("", "") (two arguments) and issue in bundledFieldsEx("", "", "") (three arguments).

  • issue in bundledFieldsEx("", "")
Syntax with details Example
issue in bundledFieldsEx(“customfield_name”, “subfield_value”) issue in bundledFieldsEx(“Address”, “Poland”)
It returns all issues which contain Address custom field where one value is Poland.
issue in bundledFieldsEx(“Address”, “”) It returns all issues which contain Address custom field where min. one value is empty.
issue in bundledFieldsEx(“customfield_id”, “subfield_value”) issue in bundledFieldsEx(“customfield_10301”, “Poland”)
It returns all issues which contain custom field with ID = 10301 (in this case: Address) where one value is Poland.
issue in bundledFieldsEx(“customfield_10301”, “”)
It returns all issues which contain custom field with ID = 10301 (in this case: Address) where min. one value is empty.
issue in bundledFieldsEx(“id”, “subfield_value”) issue in bundledFieldsEx(“10301”, “Poland”)
It returns all issues which contain custom field with ID = 10301 (in this case: Address) where one value is Poland.
issue in bundledFieldsEx(“10301”, “”)
It returns all issues which contain custom field with ID = 10301 (in this case: Address) where min. one value is empty.
  • issue in bundledFieldsEx("", "", "")
Syntax with details Example
issue in bundledFieldsEx(“customfield_name”, “subfield_name”, “subfield_value”) issue in bundledFieldsEx(“Address”, “Country”, “Poland”)
It returns all issues which contain Address custom field with Country subfield (which value is Poland).
issue in bundledFieldsEx(“customfield_id”, “subfield_name”, “subfield_value”) issue in bundledFieldsEx(“customfield_10301”, “Country”, “Poland”)
It returns all issues which contain custom field with ID = 10301 (in this case: Address) with Country subfield (which value is Poland).
issue in bundledFieldsEx(“id”, “subfield_name”, “subfield_value”) issue in bundledFieldsEx(“10301”, “Country”, “Poland”)
It returns all issues which contain custom field with ID = 10301 (in this case: Address) with Country subfield (which value is Poland).
Tip

To find an ID of Bundled Field custom field, go to the Issues > Custom Fields. Select custom field, click Edit and check URL address.
Example: http://192.168.0.84:8082/secure/admin/EditCustomField!default.jspa?id=10301

Note

If you don’t see issues that contain Bundled Field custom field, go to the Issues > Custom Fields. Select custom field, click Edit and check Search Template. Bundled Fields Searcher should be set.

Bundled Fields
Bundled Fields searcher

Need help?

If you can’t find the answer you need in our documentation, raise a support request*.

*Include as much information as possible to help our support team resolve your issue faster.

Additional reading