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:
displayName
foreground
background
tooltip
{ "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"] } ] } |
{ "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 } ] } |
{ "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 } ] } |
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.
{ "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
{ "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)"} ] } ] } |