Label and Workflow Configuration

Owned by Wolfgang Huber
Last updated: Apr 02, 2017
11 min read

REQUIRES ENTERPRISE EDITION


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

  • labels a list of labels. Each labels has the following parameters
    • label: identifier of label (just characters a-z)
    • categories: list of categories for which the label can be set
    • editors: string[] can be set to a list of users ids, to limit who can set a label
    • reportName: name to display in reports / documents. 
    • reportHide: if reportHide="unset" labels which are not set will not show up in reports / documents 
    • default (true|false|filter): set to true, if label should be set for newly created items, if set to filter it will take the value of the filter. Note: This setting is ignored for labels in 'xor', and 'review' groups: for these defaults are define for the group.
    • defaultAsk: set to true if the user should be prompted in the create dialog.
    • style.[filter|label].[on|off] style information for any of the 4 cases in which a label can be seen in the UI
  • groups a possibility to group labels in the UI.
    • selection: the selection value determines how label groups behave (for items, filters are always using the or behavior, so it is possible to select any number and combinations of labels in the filter)
      • or: any number of labels can be selected
        additional parameters for review groups:
      • xor: exactly one label can be selected (initially it can also be undefined)
      • review: behaves like xor, but has some additional properties:
        additional parameters depending on selection type
      • default: ['xor' and 'review'] specifies the label id to be used if an item is saved or created.
      • defaultAsk: ['xor' and 'review'] set if the user should be able to change the default in the create dialog.
      • reset:  ['review'] if set to true, a change of the item data will reset the value (delete the label and select the default)
      • noName:  ['review'] is used for display if no review label has been set
      • foreground,background:  ['review'] are the colors for display if no review label has been set
      • noIcon:  ['review'] is the icon for display if no review label has been set
      • askForComment:  ['review'] if set to true a the user can enter a comment in a pop-up dialog. This comment is saved as change comment with the item when setting the label.
      • showComments:  ['review'] if set to true a list of previous label changes is shown in the review menu.
      • tooltip:  ['review'] the name of the tooltip for the drop down menu
      • reviewers:[]  ['review'] a list of possible reviewers, empty for all (from 1.11 onwards)
    • labels: array of lables in that group
    • filterMenu:  allows grouping of filters into dropdown
      • displayName: name of group to display if useFilterMenu is set to true
      • off|on:  menu parameters depending if at least one filter in the group is on: Note these options are used to have one menu per group
        • foreground: color 
        • background": color
        • icon: (optional)
        • displayName: name of menu button
        • tooltip: in this status
  • filterBackgroundColor: background color for top toolbar if a project filter is selected
  • useFilterMenu: if set to true the filters are accessible through one menu (Note: for that they need to be member of a group and each group must have filterMenu with a displayName specified)
  • design_reviews:[] a group of design review dialog definitions. Design review dialogs are bound to a label, a positive review set's the label.
    • reviewers:[] a list of possible reviewers, empty for all
    • label:string name of label to show in toolbar (label must be define in label section)
    • reset:true|false a label whether to reset the review labels if item is modified, default true
    • reviewName:string name of the review (shown in dialog)
    • reviewHelp:string explanation of review (shown in dialog)
    • reviewDetails:[] a list review actions for the review rendered as checkbox (all must be checked for a positive review)
      • name:string review which needs to be done 
      • help:string explaining details on what to do review


Example FDA/CE and Regression Filter

Example configuration 
{
  "labels": [
    {
      "label": "FDA",
      "categories": [ "REQ", "SPEC"],
      "reportName": "FDA",
      "style": {
        "filter":{
		  "off": { "displayName":"FDA", "foreground":"orange","background":"transparent", "icon":"",       "tooltip":"click to filter by FDA" },
		  "on":  { "displayName":"FDA", "foreground":"white", "background":"orange",      "icon":"",       "tooltip":"click to remove filter" }
        },
        "label":{
		  "off": { "displayName":"FDA", "foreground":"orange", "background":"transparent", "icon":"",      "tooltip":"add FDA label" },
		  "on":  { "displayName":"FDA", "foreground":"orange", "background":"transparent", "icon":"check", "tooltip":"click to remove FDA label" }
        }
      }
    },
    {
      "label": "CE",
      "categories": ["REQ", "SPEC"],
      "reportName": "CE",
      "style": {
        "filter":{
		  "off": { "displayName":"CE", "foreground":"blue",  "background":"transparent", "icon":"",      "tooltip":"click to filter by CE" },
		  "on":  { "displayName":"CE", "foreground":"white", "background":"blue",        "icon":"",      "tooltip":"click to remove filter" }
        },
        "label":{
		  "off": { "displayName":"CE", "foreground":"blue", "background":"transparent",  "icon":"",      "tooltip":"add CE label" },
		  "on":  { "displayName":"CE", "foreground":"blue", "background":"transparent",  "icon":"check", "tooltip":"click to remove CE label" }
        }
      }
    },
    {
      "label": "regression",
      "categories": [ "TC", "XTC"],
      "reportName": "Regression",
      "style": {
		"filter":{
		  "off": { "displayName":"Regression", "foreground":"grey", "background":"transparent", "icon":"",      "tooltip":"click to filter by Regression" },
		  "on":  { "displayName":"Regression", "foreground":"white", "background":"grey",       "icon":"",      "tooltip":"click to remove filter" }
		},
		"label":{
		  "off": { "displayName":"Regression", "foreground":"grey", "background":"transparent", "icon":"",      "tooltip":"add Regression label" },
		  "on":  { "displayName":"Regression", "foreground":"grey", "background":"transparent", "icon":"check", "tooltip":"click to remove Regression label" }
		}
	  }
    }
  ],
  "groups":[
    { "selection":"or", "labels":["FDA", "CE"]},
    { "selection":"or", "labels":["regression"]
    }
  ]
}

Setup for Simple Review Workflow v1.7

example review setup 
{
  "labels": [
    {
      "label": "review_todo",
      "categories": ["REQ", "SPEC", "RISK", "UC", "TC", "XTC", "DOC"],
      "style": {
        "filter":{
          "off": { "foreground":"orange", "background":"transparent","icon":"comment-o", "displayName":"todo" },
          "on":  { "foreground":"white", "background":"orange","icon":"comment", "displayName":"todo" }
        },
        "label":{
          "off": { "foreground":"orange", "background":"transparent", "icon":"comment", "displayName":"todo" },
          "on":  { "foreground":"orange", "background":"transparent", "icon":"comment" , "displayName":"todo"}
        }
      },
      "reportName": "To be reviewed"
    },
    {
      "label": "review_passed",
      "categories": [ "REQ", "SPEC","RISK", "UC", "TC", "XTC", "DOC"],
      "style": {
        "filter":{
          "off": { "foreground":"green","background":"transparent","icon":"comment-o", "displayName":"passed" },
          "on":  { "foreground":"white","background":"green","icon":"comment", "displayName":"passed" }
        },
        "label":{
          "off": { "foreground":"green", "background":"transparent", "icon":"comment", "displayName":"passed"},
          "on":  { "foreground":"green", "background":"transparent", "icon":"comment", "displayName":"passed" }
        }
      },
      "reportName": "Passed"
    } ,
    {
      "label": "review_failed",
      "categories": [ "REQ", "SPEC","RISK", "UC", "TC", "XTC", "DOC"],
      "style": {
        "filter":{
          "off": { "foreground":"red", "background":"transparent", "icon":"comment-o", "displayName":"failed" },
          "on":  { "foreground":"red", "background":"green", "icon":"comment" , "displayName":"failed" }
        },
        "label":{
          "off": { "foreground":"red", "background":"transparent", "icon":"comment", "displayName":"failed" },
          "on": { "foreground":"red", "background":"transparent", "icon":"comment", "displayName":"failed" }
        }
      },
      "reportName": "Failed"
    }
  ],
  "groups":[
    {
      "selection":"review",
      "labels":[
        "review_todo",
        "review_passed",
        "review_failed"],
      "default":"review_todo",
      "noName":"select",
      "foreground":"red",
      "background":"transparent",
      "noIcon": "commenting",
      "reset":true
    }
  ]
}

Setup for Comment Workflow v1.7


example comment setup 
{
  "labels": [
    {
      "label": "comment_good",
      "categories": [ "REQ", "SPEC","RISK", "UC","TC", "XTC", "DOC"],
      "style": {
        "filter":{
          "off": { "foreground":"green","background":"transparent", "icon":"flag-o", "displayName": " " },
          "on":  { "foreground":"white", "background":"green", "icon":"flag","displayName": " " }
        },
        "label":{
          "off": { "foreground":"green","background":"transparent","icon":"flag", "displayName": "" },
          "on":  { "foreground":"green", "background":"transparent", "icon":"flag","displayName": "set comment (all good)" }
        }
      },
      "reportName":"comment (all good)"
    },
    {
      "label": "comment_bad",
      "categories": [ "REQ", "SPEC","RISK", "UC","TC", "XTC", "DOC"],
      
      "style": {
        "filter":{
          "off": { "foreground":"red", "background":"transparent","icon":"flag-o", "displayName": ""  },
          "on":  { "foreground":"white", "background":"red", "icon":"flag" , "displayName": ""  }
        },
        "label":{
          "off": { "foreground":"red", "background":"transparent", "icon":"flag", "displayName": ""  },
          "on":  { "foreground":"red", "background":"transparent", "icon":"flag" , "displayName": "set comment (raise flag)" }
        }
      },
      "reportName":"comment (raise flag)"
    } ,
    {
      "label": "comment",
      "categories": [ "REQ", "SPEC","RISK", "UC","TC", "XTC", "DOC"],
      
      "style": {
        "filter":{
          "off": { "foreground":"grey", "background":"transparent", "icon":"flag-o" },
          "on":  { "foreground":"white", "background":"grey", "icon":"flag", "displayName": ""  }
        },
        "label":{
          "off": { "foreground":"grey", "background":"transparent", "icon":"flag", "displayName": "" },
          "on":  { "foreground":"grey", "background":"transparent", "icon":"flag", "displayName": "set comment"  }
        }
      },
      "reportName":"comment"
    }
  ],
  "groups":[
    {
      "selection":"review",
      "labels":[ "comment_good", "comment_bad","comment"],
      "noName":"",
      "foreground":"grey",
      "background":"transparent",
      "noIcon": "flag-o",
      "askForComment":true,
      "showComments":true
    }
  ]
}

Colors and Icons from (1.7.*)

This can be overwritten, e.g. by "style.filter.off"

Default: color is specified by foreground and background

icon if an icon is specified: the icon is used....,icons are font awesome 4.4 definitions like "commenting"

displayName: can be set per label. If this value is set, the label is shown in documents. The value can be overwritten per status for the ui (e.g. style.filter.on ).

altName: can be used to show an alternative name in reports (e.g. if a filter should not be in documents but in reports). If no altName is set the displayName of the label is used in reports.



color/icons setup 
{
  "labels": [
    {
      "label": "review_todo",
      "categories": [
        "REQ",
        "SPEC",
        "RISK",
        "UC",
        "TC",
        "XTC"],
      "style": {
		 "filter":{
			"off": {
			  "foreground":"red",
              "background":"white",
		      "icon":"commenting",
              "displayName":"text if off" }, 
            "on": {
              "foreground":"white",
              "background":"red",
              "icon":"iconOn.gif",
              "displayName":"text if on" }
	      },
         "label":{
            "off": {
			  "foreground":"red",
              "background":"white",
		      "icon":"commenting-o" }, 
            "on": {
              "foreground":"white",
              "background":"red",
              "icon":"commenting" }
         }
      },
       "displayName": "To Be Reviewed",
       "altName":"report text"
    }
}

Review Label Example

Review Labels 
{
  "labels":[{
  "label":"req_correct",
  "categories":["REQ"],
  "style":{
    "filter":{
      "off":{"foreground":"orange","background":"transparent","icon":"square-o","displayName":"DR REQ","tooltip":"filter by design review software requirement"},
      "on":{"foreground":"white","background":"orange","icon":"check-square-o","displayName":"DR REQ","tooltip ":"stop filter by design review software requirement "}},
    "label":{
      "off":{"foreground":"orange","background":"transparent","icon":"square-o","displayName":"DR REQ"},
      "on":{"foreground":"orange","background":"transparent","icon":"check-square-o","displayName":"DR REQ"}}},
  "reportName":"Software requirement reviewed"
  }],
  "design_reviews":[
    {
      "reviewers":[],
      "reset":true,
      "label":"req_correct",
      "reviewName":"Design Review Requirement (Class A,B,C)",
      "reviewHelp":"Verify Software Requirements 62304",
      "reviewDetails":[
        {"name":"Related system requirements are up-to-date","help":"see 62304/5.2.5"},
        {"name":"Software requirement implement system requirement(s)","help":"see 62304/5.2.6 a)"},
        {"name":"Software requirement does not contradict other software requirement(s)","help":"see 62304/5.2.6 b)"},
        {"name":"Software requirement is well expressed and unambiguous","help":"see 62304/5.2.6 c)"},
        {"name":"Software requirement can be tested","help":"see 62304/5.2.6 d)"}
      ]
    }
  ]
}