Differences

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

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
jira_addon [2018/01/14 00:12] – adminjira_addon [2020/05/10 16:13] (current) – removed admin
Line 1: Line 1:
-===== JIRA AddOn Configuration ===== 
-//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. 
- 
-You may use any text editor to add/update settings. 
- 
- 
----- 
-==== Minimum Configuration ==== 
-First pick a unique name for your JIRA system, e.g. MYJIRA. The name must be in uppercase.  
- 
-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 
- 
-The above configuration exercises the following default behavior: 
-  * Pull in requirements/issues with issue type of "Story", "Task" and "Sub-Task" and status is either "In Progress" or "Done" 
-  * Pull in defects/issues with issue type of "Bug" and status in either "In Progress" or "To Do" 
-  * Defects created will be lined to the requirement issue with LinkType of "Relates". 
- 
----- 
- 
-==== 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 AUTH_.* fields supported for OAuth and OAuth2: 
- * 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 
- 
- 
----- 
-==== Enable JIRA AddOn for Models ===== 
-Each model that needs to access //JIRA// for requirement or defects must also be configured: 
-  * Enable [[ALMPlugin]] in the model using [[modelnode | model property]]. 
-  * Select 'MYJIRA' as the requirement and/or defect system using [[alm_configuration | ALM Configuration]]. 
- 
-ALM Config Settings: 
- 
-  * PROJECT=project key, it tells the ALM plugin which project in JIRA to search for the requirements and defects. 
-