Apps documentation
Extension for Jira Service Management
Cloud Server/Data Center
Extension for Jira Service Management

Cloud

Server/Data Center

Documentation
FAQ
Release notes
Articles & Videos
Last updated Mar 3, 2023

Dynamic Forms Use Case

Learn about exemplary configuration of Dynamic Forms

Objective

The aim of an exemplary configuration is to create a dynamically displayed request form for the Request new hardware request type which will require specific information concerning how soon new hardware is needed. Thanks to the configuration a reporter raises a precise request while the Support Team gets detailed information which is necessary for the team to plan equipment orders and distribution.

Note

Before you start, make sure that the fields you want to display are added to the linked issue type. You can add fields to the issue type by editing the create screen for your project. For more information, see Atlassian documentation.

Info

As any change in a request type is automatically saved and visible on the Customer Portal, we recommend to keep request forms Hidden from portal while modifying them.

Example

Exemplary request form for the Request new hardware request type. As Urgency is set to Critical, the I need it before date picker is displayed.

Copy Description field

Steps

  1. Go to Project Settings > Customer form extension to access the Dynamic Forms configuration.
  2. Select Request new hardware from the Request Types list.
  3. Click Copy fields with configuration.
  4. Select from this request type. A dialog box window appears.
  5. Select Description and click Copy.
  6. To avoid duplication, remove the non-dynamic Description from the Fields Defined in Request Type section.
    a. Click visit the request type page.
    b. Go to the Request form tab.
    c. In Visible fields, click Remove by Description.
    d. Refresh the Dynamic Forms browser tab.

Result

The previously non-dynamic Description field is now a dynamic field. You can configure Conditions and Validators for the field or add Translations.

Add Dynamic Fields

Steps

  1. In the Dynamic Forms configuration, navigate to the Dynamic Fields section and click Manage fields.
  2. Select Approvers, Due date, and Urgency from the Request Types list.
  3. Click Save.
  4. In Display name fields, change display names of Description, Approvers, and Due date.
  5. Add Field help to all Dynamic Fields.
  6. Use drag and drop to change the order of fields so that Approvers is right below Description.

Result

Dynamic Fields are added to the Request new hardware request form. You can now add Translations and configure Conditions and Validators for them.

Add Translations

Steps

  1. In Project Settings > Customer form extension > select the desired request type and click Add translations.
  2. In Language, select Polish (Poland).
  3. Make sure Request new hardware is selected in Request Type.
  4. Provide Polish translations for Display name and Field help. Changes are saved automatically.

Result

The dynamic form for the Request new hardware request type is now available in Polish.

Configure Conditions

Steps

  1. In Project Settings > Customer form extension, go to the Dynamic Fields section and select Due date.
  2. Click Conditions in the Options column.
  3. In Select field, select Urgency.
  4. In Select condition, select is equal.
  5. In Select…, select Critical.
  6. Click the Add a condition to field icon.
  7. In Select condition, select is equal.
  8. In Select…, select High.
  9. Click Save.

Result

If the urgency of the request is Critical or High, the Due date date picker is displayed. This way, if the reporter needs to request hardware for a specific date, it can be indicated. As a result the Support Team will receive a precise timeframe to resolve the request, which will be helpful in planning actions such as placing an order.

Configure Validators

Steps

  1. In Project Settings > Customer form extension, go to the Dynamic Fields section and select Description.
  2. Click Validators in the Options column.
Note
The is required validator is already configured. It was copied with the Descritpion field from Fields definded in this Request Type.
  1. In a new validator, select at least x characters.
  2. Type 1000 in the Minimal number of characters field.
  3. Click Save.
  4. Select the Approvers field.
  5. Click Validators in the Options column.
  6. In a new validator, select is required.
  7. Click Save
  8. Repeat steps 7, 8, and 9 for the Urgency field.

Result

Validators are configured and all fields, except Due date are required and cannot be empty. Description can be maximum 1000 characters long.

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.