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 Jun 10, 2020

Project configuration

Note
  • Remember to add the fields to the issue screen and to the request type.
  • Related fields must be optional in Jira. You can set them as required in the configuration of Dynamic Forms.
  • To check your settings, go to:
    Project Settings > Request Types > Edit fields > Add a field.
  • Remember to configure both Related and Master fields in the Request Type.

Use global configuration

Steps

To use global configuration in the service project:

  1. Choose Projects at the top of the screen.
  2. Choose the service project you want to configure.
  3. From service project sidebar, select Project settings > Dynamic Forms in the Extension for Jira Service Management section.
  4. Choose a field/custom field on the list in the left sidebar (with the globe icon).
  5. Set the state of Global configuration to on (this option is enabled by default).
    Extension for Jira Service Management: Dynamic Forms Project Configuration
    Extension for Jira Service Management: Dynamic Forms Project Configuration screen
    Warning

    A global configuration is used in all request types (see Request types column). To change it, set the state of Global configuration to off. The global configuration will be converted to the project one.

Result

A global configuration of Dynamic Forms is available in the current project.

Convert a global configuration into project configuration

Steps

To convert global configuration into project configuration:

  1. Turn off the Global configuration toggle.
    Extension for Jira Service Management: Dynamic Forms Project Configuration
    Extension for Jira Service Management: Dynamic Forms Project Configuration screen

    The Change configuration type dialog box appears.
  2. Choose the option:
    • Edit global configuration: Copy all settings from global configuration and manage them.

    • Restore project: Restore project configuration which was created earlier. This option is available only if you had created any project configuration before.

      Extension for Jira Service Management: change Dynamic Forms configuration type
      Extension for Jira Service Management: change Dynamic Forms configuration type

    • Create empty configuration: Clear global configuration and configure project configuration.

      Extension for Jira Service Management: change Dynamic Forms configuration type
      Extension for Jira Service Management: change Dynamic Forms configuration type

Result

A global configuration of Dynamic Forms has been changed into project configuration.

Add a new configuration

To add a new project configuration of Dynamic Forms:

  1. Click the Plus icon in the left sidebar.

    Adding a new Dynamic Forms Project Configuration with Extension for Jira Service Management
    Adding a new Dynamic Forms Project Configuration with Extension for Jira Service Management

  2. The Add Field/Custom field to configuration dialog box appears. Select Field/Custom field for configuration. You can also Create new custom field.

Note
  • To learn about the fields that can be used in configuration, check Supported fields.
  • It’s also possible to use Assets object field as a master field. To learn more, navigate to Compatibility.
Tip
To create a new custom field and use it for configuration, you can click Create new custom field or navigate to Jira Administration > Issues > Custom fields.
  1. Click Add.
    Creating a Dynamic Forms Project Configuration with Extension for Jira Service Management by adding a field/custom field
    Creating a Dynamic Forms Project Configuration with Extension for Jira Service Management

    Selected Field/Custom field is added to the list.
  2. Select Context and configure the following:
    • Option: Select the option which will be a trigger for Dynamic Forms.
      Note
      Fields available in the Option are related to the previous chosen field/custom field. Change them by going to Jira Administration > Issues > Custom fields.
    • Related field: Select the field/custom field which will show up after selecting the option (defined in the Option).
      Note
      All Jira fields and standard custom field types are supported. They are added to the configuration with a context named Default Configuration Scheme for …, which is created automatically when you add a new custom field to Jira. From version 6.0.5 the following fields provided by Elements Connect are supported: Live Text, Live User, Snapshot Date, Snapshot Datetime, Snapshot Text.
      Tip
      To add a new related field, click Select related field to start typing and press Enter to confirm.
    • Required: Set the state of switch to on to make the field/custom field (defined in the Related field) required.
      Warning
      If you want to add Bundled Field to Dynamic Forms configuration, you must set this custom field as required only in this configuration. In the Request Types settings, this custom field must be set as optional.
    • Default value: Set the state of switch to on to keep default value from the field/custom field (defined in the Related field). This is the value which is first displayed to a user.
    • Request types: Select in which request types selected configuration will be used.
      Note

      Select all allows to select all available request types. If you add a new one to the service project, you should add it to this configuration manually.
      Apply to all allows to select all available request types. If you add a new one to the service project, it will be added to this configuration automatically.

    • Actions: Click the trash icon to remove settings of selected options.
      Warning

      Remember to set the state of switch to on to make the configuration enabled.
      To make it disabled, set the state of switch to off. Configuration will be saved as a draft.

Result

A project configuration of Dynamic Forms is added.

Extension for Jira Service Management: Dynamic Forms Project Configuration
Extension for Jira Service Management: Dynamic Forms Project Configuration screen

More options

To see more options, click the three dot icons on the right side of the table :

  • Collapse/Expand all: Hide/Show all rows by one click.
  • Clear configuration: Clear all related fields with their settings and start building configuration from scratch.
  • Delete configuration: Delete a configuration for selected field/custom field. It will be removed from the list in the left sidebar.
Extension for Jira Service Management: Dynamic Forms Project Configuration
Extension for Jira Service Management: Dynamic Forms Project Configuration screen
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.