Content Comparison

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

• enabled: must true | false must be set to true if the client should use the JIRA
• pluginId:101 must be set to "101" (unless there is a newer version of the plugin)
• defaultProjectId:string this is the default project in the create issue dialog
• defaultTypeId: that string that is default issue type in the create issue dialog
• projectsAndTypes: an array of projects which should be available, each . Only projects listed in here are used in searches. Each of them needs
  • id: string the (short) JIRA project idkey
  • keyname: a string a name for humans the project (used in the Matrix client only)
  • issueTypes: an [] an array of issue types (tasks or bugs in JIRA), each . Only types listed in here can be created. Each of them needs
    • id: the string the JIRA id of the type (e.g. BUG, TASK, EPIC, ...)
    • name: a string a name (used in the Matrix client only)
    • icon:string (optional) a font awesome icon (https://fortawesome.github.io/Font-Awesome/icons/ up to version 4.0). if not set, the JIRA icon will be used. 
• one2one: a {} 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 to values
  
  • projectId: string the project keyid
  • typeId:string the type nameid
• states:[]: an array mapping JIRA states to Matrix states. This can be configured per projectKey and typeName. projectKey: the project key (project and type, depending on the JIRA workflow 
  • projectId:string the project id can be empty for the default if there is no better mapping)
  • typeNametypeId: the string the type name (can be empty for the default if there is no better mapping)
  • states: a [] a list of mappings for this project / type
    • name: the string the name of the status in matrix, this is computed automatically 
    • color: color string color in display (one to one mapping)
    • background: 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",         "icon":"fa fa-bug" },
        { "id":"TASK",    "name":"Task",        "icon":"fa fa-thumb-tack"},
        { "id":"IMPROVE", "name":"Improvement", "icon":"fa fa-plus"        },
        { "id":"EPIC",    "name":"Epic",        "icon":"fa fa-plus"        },
        { "id":"STORY",   "name":"Story",       "icon":"fa fa-plus"        }
      ]
    },
    {
      "name":"OR",
      "id":"IS",
      "issueTypes":[
        { "id":"TASK",    "name":"Task",         "icon":"fa fa-tasks"        }
      ]
    }],
  "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"        }
      ]
    }
  ]
}