Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
jira_addon [2017/03/09 04:10]
admin [Use JIRA AddOn in Model]
jira_addon [2018/01/14 00:12]
admin
Line 1: Line 1:
 ===== JIRA AddOn Configuration ===== ===== JIRA AddOn Configuration =====
-//JIRA Addon// communicates with {{https://​www.atlassian.com/​software/​jira | JIRA}} using REST API.  ​+//JIRA Addon// communicates with {{https://​www.atlassian.com/​software/​jira | JIRA}} using REST API.  ​Configuration settings are defined in //​config.properties//​ file located in ///​www/​config///​ folder.
  
-==== JIRA Connection ==== +You may use any text editor to add/update settings.
-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| 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.+
  
  
 +----
 ==== Minimum Configuration ==== ==== Minimum Configuration ====
 +First pick a unique name for your JIRA system, e.g. MYJIRA. The name must be in uppercase. ​
  
-To configure ​//JIRA AddOn//, you need to provide ​the JIRA server connection information at the minimum:+Copy and paste following settings into //config.properties// and adjust ​the values to yours: 
 +  ADDON.MYJIRA.CLASS=com.webmbt.alm.addon.AddOnJira 
 +  ADDON.MYJIRA.URL=http\://​localhost\:​8080/​ 
 +  ADDON.MYJIRA.AUTH.TYPE=Basic 
 +  ADDON.MYJIRA.AUTH.USERNAME=userid 
 +  ADDON.MYJIRA.AUTH.PASSWORD=password 
 +  ADDON.MYJIRA.BUG.ENABLED=true 
 +  ADDON.MYJIRA.REQ.ENABLED=true
  
-    ADDON.myjira.CLASS=com.webmbt.plugin.alm.jira.AddOnJira +The above configuration exercises the following default behavior: 
-    ​ADDON.myjira.CONNURL=<​url>​ example http://myJiraSvr:​8080 +  * Pull in requirements/issues with issue type of "​Story",​ "​Task"​ and "​Sub-Task"​ and status is either "In Progress"​ or "​Done"​ 
-    ​ADDON.myjira.PASSWORD=<​pwd>​ +  * Pull in defects/issues with issue type of "​Bug"​ and status in either "In Progress"​ or "To Do" 
-    ADDON.myjira.USERNAME=<​userid>​ +  * Defects created will be lined to the requirement issue with LinkType of "​Relates"​.
-    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 Settings ====
  
 +  * ADDON.MYJIRA.CLASS=com.webmbt.alm.addon.AddOnJira
 +  * ADDON.MYJIRA.URL= host and port of your JIRA server
 +  * ADDON.MYJIRA.AUTH.TYPE=Basic/​Form
 +  * ADDON.MYJIRA.AUTH.USERNAME=userid
 +  * ADDON.MYJIRA.AUTH.PASSWORD=password
 +  * ADDON.MYJIRA.BUG.ENABLED=true/​false - if to enable defect interface. Default false
 +  * ADDON.MYJIRA.BUG.ISSUETYPES=list of JIRA issue types to pull in the defects. Separate multiple issues with a comma. If issue type contains a space, enclose issue type with a pair of single quote.
 +  * ADDON.MYJIRA.BUG.STATUS= issue status used to pull in the defects. Separate multiple issue status codes with a comma. If issue status contains a space, enclose issue status with a pair of single quote.
 +  * ADDON.MYJIRA.BUG.JQL.EXTRA=additional JQL conditions to be added to the JQL used to pull in defects
 +  * ADDON.MYJIRA.REQ.ENABLED=true/​false - if to enable requirement interface. Default false.
 +  * ADDON.MYJIRA.REQ.ISSUETYPES=list of issue types to pull in the requirement items. Separate multiple issues with a comma. If issue type contains a space, enclose issue type with a pair of single quote.
 +  * ADDON.MYJIRA.REQ.STATUS=issue status used to pull in the requirements. Separate multiple issue status codes with a comma. If issue status contains a space, enclose issue status with a pair of single quote.
 +  * ADDON.MYJIRA.REQ.JQL.EXTRA=additional JQL conditions to be added to the JQL used to pull in requirements
 +  * ADDON.MYJIRA.REQBUG.LINK=linkType[,​visibilityType,​visibilityValue],​ default "​Relates"​. You may only specify the linkType or specify the linkType and the link visibilityType and visibilityValue.
  
-==== Additional ​Configuration ==== +Additional ​AUTH_.* fields supported for OAuth and OAuth2: 
-  * ADDON.myjira.SOURCE=<//​JIRA,​ JAMA, POLARION//; default to //​JIRA//>​+ * ADDON.MYJIRA.AUTH.OAUTH.CONSUMER.KEY 
 + * ADDON.MYJIRA.AUTH.OAUTH.CONSUMER.SECRET 
 + * ADDON.MYJIRA.AUTH.OAUTH.ACCESS.TOKEN 
 + * ADDON.MYJIRA.AUTH.OAUTH.SECRET.TOKEN 
 + * ADDON.MYJIRA.AUTH.OAUTH2.SECURITY.TOKEN 
 + * ADDON.MYJIRA.AUTH.OAUTH2.SIGNATURE
  
-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> +==== Enable ​JIRA AddOn for Models ​=====
-  * 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| ALM Configuration]]>​ +
-  * ADDON.myjira.TAGTYPE=<​r,​ e, or s. 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.>​ +
- +
- +
-==== Use JIRA AddOn in Model =====+
 Each model that needs to access //JIRA// for requirement or defects must also be configured: Each model that needs to access //JIRA// for requirement or defects must also be configured:
   * Enable [[ALMPlugin]] in the model using [[modelnode | model property]].   * Enable [[ALMPlugin]] in the model using [[modelnode | model property]].
-  * Select 'myjira' as the requirement and/or defect system using [[alm_configuration | ALM Configuration]].+  * Select 'MYJIRA' as the requirement and/or defect system using [[alm_configuration | ALM Configuration]]. 
 + 
 +ALM Config Settings:
  
-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, it tells the ALM plugin ​which project in JIRA to search for the requirements ​and defects.
  
-  * 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. 
-  * REQ_GROUP=<​comma-separated list of keywords to filter requirements/​stories/​enhancements in //REQ_KEY// field> 
  
Print/export
QR Code
QR Code jira_addon (generated for current page)