Skip to content

Atlassian Jira Plug-in

Last update April 17, 2019

Plug-in Version 1.2.3

The Jira plug-in integrates with the issue tracking and project management capabilities that Jira provides.

Supported Versions

The Jira plug-in supports the following Jira versions:

  • 6.0 
  • 5.0

Capabilities

The Jira plug-in lets you perform the following tasks:

  • Import content from a Jira instance into an application version.
  • Update application content in Jira from a task in a release.

What's New

The following updates were made for plug-in version 1.2.3:

  • Support was added for Java 11.

Configuration

Register the plug-in and create endpoints as described in Manage Plug-ins.

The URL of the manifest for Jira plug-in registration is http://<plugin-server>:<port>/cdd-Jira-plugin/manifest.json.

 To add an endpoint for the Jira plug-in, select the Jira Endpoint Type in the ADD ENDPOINT dialog. When you create endpoints, the following Jira information is required:

  • Name
    Specifies the name of the endpoint
  • URL
    Specifies the URL to access the Jira instance
  • User Name
    Specifies the user name to access the Jira instance
  • Password
    Specifies the password to access the Jira instance
  • Use Proxy
    {Optional} Determines whether a proxy server is used 
    Note: If selected, the Proxy Host, Proxy PortProxy Username, Proxy Password, and Use HTTPS fields appear
  • Proxy Host
    Specifies the HostName or IP for the proxy server
  • Proxy Port
    Specifies the port for the proxy server
  • Proxy Username
    Specifies the user name for the proxy server
  • Proxy Password
    Specifies the password for the proxy server
  • Use HTTPS
    Specifies whether the Jira connection uses an SSL connection.
  • Time Out
    Specifies the time to wait until the operation is complete before timing out, in seconds.

Tasks

The Jira plug-in lets you select one of the following task types:

Note: Each task type requires execution stage information.

For task fields where you can select a value from the Jira instance, type the @ symbol to receive a list of available values to choose from.

  • Add Jira Issues Comment

    Required Fields:

Issue Key
Specifies the Jira project key that is used for the issue. This is usually the Jira project initials.

Comment
Specifies a comment to add to the specified Jira issue.

Role
Specifies the role that can view the comment. Roles belong to project issues. If null, the default value is all roles. If you select Others, use the Other Role field to define a customized role.

  • Create Jira Issue

    Required Fields:

    Input Parameters

Jira Project Key
Specifies the Jira project key that is related to the issue. This is usually the Jira project initials.

Issue Type
Select one of the following issue types that is defined in the project to which the issue belongs:

    • Task
    • Sub-task
    • Story
    • Bug
    • Epic
      Note: If you select Epic, specify the Epic name.

Epic Name
Specifies the associated epic name in the Jira agile boards. This input is only valid when you select Epic in the Issue Type field.

Summary
Specifies a summary of the issue.

Priority
Specifies the priority level of the issue. 

Due Date
Specifies the issue due date in the format YYYY-MM-DD. 
Example: 2013-9-29 

Show Advanced Settings
Displays the following additional fields: 

Affects Versions
Specifies an array of affected versions separated by a semicolon. Each element is a version. Jira lets you track different versions for software projects. You can assign issues to version that are configured in project administration. 

Fix Versions
Specifies an array of versions separated by a semicolon. Each element is a version. Jira lets you track different versions for software projects. You can assign issues to version that are configured in project administration. 

Assignee
Specifies the issue assignee. This field defaults to the current logon user. Use the user name used to log in instead of the first name and last name values associated with the user. 

Reporter
Specifies the issue reporter. This field defaults to the current logon user. Use the user name used to log in instead of the first name and last name values associated with the user. 

Environment
Specifies environment details relevant to the issue such as operating system, software platform, or hardware specifications. 

Description
Specifies the Jira issue description. 

Labels
Specifies an array of issue labels separated by a semicolon. Each element is a label. Labels cannot contain spaces.

Custom Fields
Specifies a list of custom field names and values. The following Jira custom field types and JSON syntax are supported:

  • Text Field (single line)
    Syntax: {"field_name":"textual_value"}
  • Select List (single choice)
    Syntax: {"field_name":"choice_1"}
  • Checkboxes
    Syntax: {"field_name":["check_1.","check_2"]}
  • Cascade field - A cascading select list with two levels of select lists. What you see in the second select list depends on what you choose in the first select list.
    Syntax: {"field_name":["Parent Value", "Child Value"]}. If you want to enter the parent value only, the syntax is {"field_name":["Parent Value", ""]} (that is, no space between the double quotes).

Note: If a standard field and a custom field have identical field names, the merged field displays the custom field value. 
Values:
You can update multiple values in the following JSON syntax: {"field1":"value1","field2":"value2"...}
Examples:
{"Links":"Reporter","Votes":"Watcher","Updated":"Remaining"}.  For Cascade:  {"Task Type":["Tests","Run UI Test"]}

Output Parameters
Note:
You can store the returned values in tokens (except for built-in tokens) for use in other release items.

Issue Key
Returns the key of the created issue.
Example: AP-51

Issue ID
Returns the ID of the created issue.

Self Link
Returns the URL of the created issue.

  • Update Jira Issue Status

    Required Fields:

Issue Key
Specifies the key that is used for the Jira issue. This is usually the Jira project initials.

Transition I would like to perform
Select from the following transitions:

    • Resolve Issue
    • Reopen
    • Closed
    • Start Progress
    • Stop Progress
    • Start Work
    • Stop Work
    • Define
    • Accept
    • Restart Work
    • Block
    • Complete
    • Verified
    • Assign
    • To Do
    • In Progress
    • Done
    • Others

Resolution
Specifies how the issue is resolved if you are resolving the issue. Select from an available resolution, or add custom codes to the Jira default codes. In some workflows, this field is mandatory. Refer to your Jira workflow configuration.

Comment
Specifies a comment for a reopened issue. In some workflows, this field is mandatory. Refer to your Jira workflow configuration.

  • Wait for Approval

    The Wait for Approval task lets you determine that tasks are queued until the completion and approval of a specified issue.

    Required Fields:

Jira Issue ID
Specifies the ID of a Jira issue to be completed and approved before the next task starts.

Required Status
Specifies the required status for the selected Jira issue to reach before the next task starts.

Poll Interval
Specifies the length of time in seconds between system requests for the Jira issue status.
Default: 120 seconds

Import Work Items

The Jira plug-in uses the Jira Query Language (JQL), to import Jira work items into a release. Use this capability when you deploy a release to see the related Jira issue information.

Follow these steps:

  1. In a release, expand the Apps & Work Items tree on the left menu, and select the version number.
  2. Select Add Work Items.
    The ADD WORK ITEMS window opens.
  3. Select the External Work Items option.
  4. Enter a name for the work items source.
    Example: Jira Feed
  5. Under Work Items Source, select the Jira plug-in and a configured Jira endpoint.
  6. Provide information in the required parameter fields. You can import the following Jira metadata into a release by entering a JQL query into the Query field:
    • Summary
      Example: 
      summary = issue ID_123456
    • Type
      Example: 
      type = bug and status = resolved
    • External Id
      Example: 
      External issue ID ~ YourID_123456
    • Display Type
      Example: 
      type = status = open
    • Status
      Example:  status = open and priority = urgent and assignee = jsmith

Tutorial Video

The following video shows how to configure Automic® Continuous Delivery Director integration with Jira:


Was this helpful?

Please log in to post comments.