Content Comparison

The client configuration can be done by an optional JSON object. Please note the text must use double quotes (") around all strings. The following parameters can be set:

• enabled: true | false - can be be set to false to disable the integration
• defaultProjectId:string - this is the default project in the create issue dialog

• defaultTypeId:string - this is default issue type in the create issue dialog

• requireCommitTicket: true | false - set to true if a JIRA ticket ID must be part of the change comment

• addJIRAComment: true | false - set to true if the change comment should also be saved in JIRA

• projectsAndTypes: an array of projects which should be available. If set only projects listed in here are available. Each of them needs

  • id:string the (short) JIRA project key
  • name:string a name for humans the project (used in the Matrix client only)
  • issueTypes:[] an array of issue types (tasks or bugs in JIRA). Only types listed in here can be created. Each of them needs
    • id:string the JIRA id of the type (e.g. BUG, TASK, EPIC, ...)
    • name:string a name (used in the Matrix client only)
• one2one:{} a structure which can be set if there should be a one to one mapping between an Matrix item and JIRA bug/task. It has two values:
  
  • projectId:string the project id
  • typeId:string the type id
• states:[]: an array mapping JIRA states to Matrix states. This can be configured per project and type, depending on the JIRA workflow 
  • projectId:string the project id can be empty for the default if there is no specific mapping)
  • typeId:string the type name (can be empty for the default if there is no specific mapping)
  • states:[] a list of mappings for this project / type
    • name:string the name of the status in matrix, this is computed automatically 
    • color:string color in display (one to one mapping)
    • background:string background color  (one to one mapping)
    • done:true | false if set to "true" the ticket will be rendered with strike through 

{
  "enabled":true,
  "jiraBaseUrl":"https://matrixtest.atlassian.net",
  "pluginId":"101",
  "defaultProjectId":"DEMOX",
  "defaultTypeId":"IMPROVE",
  "projectsAndTypes": [
    {
      "name":"Demonstration Project",
      "id":"DEMOX",
      "issueTypes":[
        { "id":"BUG",     "name":"Bug"},
        { "id":"TASK",    "name":"Task"},
        { "id":"IMPROVE", "name":"Improvement"},
        { "id":"EPIC",    "name":"Epic"},
        { "id":"STORY",   "name":"Story"}
      ]
    },
    {
      "name":"OR",
      "id":"IS",
      "issueTypes":[
        { "id":"TASK",    "name":"Task" }
      ]
    }],
  "one2one":{
    "projectId": "DEMOX",
    "typeId":"TASK"
  },
  "states": [
    {
      "project": "",
      "ticketType": "",
      "states": [
        { "name": "open",          "color": "white", "background": "red",    "done": "false"         },
        { "name": "in progress",   "color": "black", "background": "yellow", "done": "false"         },
        { "name": "Done",          "color": "white", "background": "green",  "done": "true"        }
      ]
    }
  ]
}