JIRA Addon communicates with JIRA using REST API.

You must configure the JIRA connection in config.properties before you can use it for each model. You may define multiple JIRA connections if necessary. For example, you may set up one JIRA connection for each project using different JIRA login credential.

All configuration parameters (with the exception of the CLASS field) can be defined or overridden within a model's ALM Configuration, but it is generally recommended that universal values for your company (such as the URL, the general username/password, SOURCE type, and field identifiers, all be defined in config.properties file, which will ensure that you do not need to have all these values repeated within each model.

To configure JIRA AddOn, you need to provide the JIRA server connection information at the minimum:

  ADDON.myjira.CLASS=com.webmbt.plugin.alm.jira.AddOnJira
  ADDON.myjira.CONNURL=<url> example http://myJiraSvr:8080
  ADDON.myjira.PASSWORD=<pwd>
  ADDON.myjira.USERNAME=<userid>
  ADDON.myjira.REQ.ENABLED=true
  ADDON.myjira.BUG.ENABLED=true

where myjira is a unique name you assign to identify the JIRA Connection.

The above example defines myjira to server as the requirement and defect system. You can split requirement from defect into its own system as well by configuring them with their own unique names.

• ADDON.myjira.SOURCE=<JIRA, JAMA, POLARION; default to JIRA>

You may need to customize JIRA <issue type> with which TestOptimal can find the ENHANCEMENT, REQUIREMENT and STORY.

• ADDON.myjira.ITYPE_ENHANCEMENT=<issue type>
• ADDON.myjira.ITYPE_REQUIREMENT=<issue type>
• ADDON.myjira.ITYPE_STORY=<issue type>

<issue type> can be:

• Improvement
• Requirement
• Story
• New Feature
• Bug

The above list may vary depending on the version of your JIRA and how your JIRA is configured.

The following configuration settings are used to define the matching field name in SOURCE if you have specified JAMA or POLARION for SOURCE and you wish to import the corresponding Requirements, User Story or Enhancements into TestOptimal:

• ADDON.myjira.REQ_ID=<the field name which hosts the original requirement identifier>
• ADDON.myjira.STORY_ID=<the field name which hosts the original user story identifier>
• ADDON.myjira.ENHMNT_ID =<the field name which hosts the original enhancement identifier>

• ADDON.myjira.REQ_STATUS=<the field name which hosts the Requirement Status>
• ADDON.myjira.STY_STATUS=<the field name which hosts the User Story Status>
• ADDON.myjira.ENH_STATUS=<the field name which hosts the Enhancement Status>
• ADDON.myjira.REQ_PRIORITY=<the field name which hosts priority for the Requirement/User Story>
• ADDON.myjira.MODEL_NAME=<the field name to store the name of the model that submitted the defect>
• ADDON.myjira.MODEL_VERSION=<the field name to store the version number of the model that submitted the defect>
• ADDON.myjira.REQ_KEY=<the field name which hosts keywords for requirements/stories/enhancements. This is used in conjunction with REQ_GROUP which is often defined in model ALM Configuration>
• ADDON.myjira.TAGTYPE=<r, s, e or r. It defines whether the Req Tags that we assert against are to be recorded as JIRA requirement issues r, enhancements e and/or User Story issues s. The definition of both in TAGTYPE means that the Req Tag could be either a requirement, enhancement or User Story issue.>

Each model that needs to access JIRA for requirement or defects must also be configured:

• EnableALMPlugin in the model using model property.
• Select 'myjira' as the requirement and/or defect system using ALM Configuration.

Additional configuration is needed to complete the JIRA AddOn for the model. You need to tell JIRA AddOn which project in JIRA to access and some further customization like how you would like requirements to be linked, etc.

• PROJECT=<project key>, this is one tag that would be expected to always be defined in the model's ALM configuration (once for Req and once for Bug), as each model would be expected to relate to a specific project. It tells the ALM plugin which project to search/lodge requirements and defects against.