Each item has some input fields as specified for it's category. These input fields can be
| Field Name | Usage | Example Rendering |
| Rich Text Editor (richtext) | An editor allowing to enter formatted text. There are parameters to specify the height (number of lines visible) of the editor. parameter: - height: height in pixels (e.g. 120, default 250)
showSmartText: autoEdit:
| |
| Plain Text Editor (text) | And editor allowing to enter plain text parameter: - rows: number of rows, default 5
allowResize: autoEdit:
| |
| File Manager (fileManager) | A control allowing to add file attachments to an item parameter: - autoHide: if set to true the file attachment control is only shown if > 1 files are attached. before that files can be attached usign the context menu.
- replace: whether to replace existing files
- never (default): it is possible to add twice the and attachment with the same name
- name: if an attachment with the same name exists it is replaced, user needs to confirm
- name_auto: as above, user is not even asked
- type: if an attachment with the same file extension exists it will be replaced, user needs to confirm
- type_auto: as above, user is not even asked
| |
| Text Entry Line (textline) | Allows to enter one line of text
| |
| User Selection (user) | A drop down with all users in the project
| |
| Date Picker (date) | Control to select a date | |
| Dropdown (dropdown) | Shows a drop down of pre/configured values. The values are configured as a setting of the project or hard coded as parameter. parameter & examples: see Dropdown Options
| |
| Down Traces (links) | Shows down traces and allows to create new traces - linktypes: array of categories, by default it is given through traceabilty rules
- none: a text to show if there a no links
| |
| Table control (steplist) | A table with by default two columns: action and expected result. Table columns can be customized as a setting of the field. parameter & examples: see Table Configuration
| |
| Risk Control (risk2) | The risk formulas can be configured in a project setting. See Risk Configuration
| |
| Checkbox (checkbox) | A checkbox control | |
| Cross Project Links (crosslinks) | Links to items in other projects | |
Issue Link Control (workflowField)
obsolete from 1.11 will be replaced by tasksControl with second generation plugins | allows to show links to external websites / issue tracking systems. Plugins for certain sites might provide additional functionality like back links. Currently these plugins exists (note: 1.11 will replace these and add new ones)
parameter:
- plugins:[plugins ids], a list of links which should be shown in control e.g. {"plugins":["101"]} for JIRA server
| |
Downlink Tool (links) | Shows the existing downlinks and allows to create new links as well as new linked items - disableCreate: true/false. Allows to hide the create button(s) if set to true.
- render:[] a list of render options for each link button. The category must be an existing downlink type. If no render options is defined, the category is normally shown.
- category: required - the name of the category (e.g. REQ)
- hideLink: true/false. If set to true, links of the category will not be listed
- buttonName: string. Can be set to change the create button's type name.
- hideCreate: true/false. If set to true, the create button of the category will not be shown
- hideSelect: true/false. If set to true, the user cannot select the category in the list
|
|
Uplink Information (uplinkinfo)
| Allows to show information about uplinks - exists: true/false. If true, the information is shown if a link exists. If false, if the link does not exist
- cats: CAT1,CAT2. Comma separated list of categories to which this rule applies
- icon:"fa fa-clock" an icon to show (if rule applies). Must be font-awesome icon
- iconfg: foreground color
- iconbg: background color
- text: text to be displayed
- itemInfo: Makes only sense if rule is exists = true. Shows links according to value
- true: shows a simple list with all id's
- reflist: shows a list with id's as links and titles
- reflistedit: shows a list with id's as links and title with an unlink button (from version 1.11)
- ref: shows id's as links and titles inline behind text
{
"exists": true,
"cats": "REQ",
"itemInfo": "reflistedit"
}
{
"exists": false,
"cats": "REQ",
"icon": "fa fa-exclamation-triangle",
"iconfg": "yellow",
"iconbg": "black",
"text": "uplink info to REQ missing"
}
{
"exists": true,
"cats": "RISK",
"icon": "fa fa-exclamation-triangle",
"iconfg": "yellow",
"iconbg": "black",
"text": "Risk Control"
}
|  |
HTML Forms (htmlForm) BETA | Allows to render custom HTML forms as fields. - htmlSetting: name of project setting which contains html of form
<form>
<table class="table table-bordered" style="width:100%">
<tr><td colspan="6" style="background:lightgrey;font-weight:bold;font-size:larger;">General Information</td></tr>
<tr><td>Indicator Name</td><td colspan=2><input class="form-control" style="width:100%" name="indicator_name" type="text" /></td><td>Initiate Date</td><td colspan=2><input class="form-control" style="width:100%" name="initiate_date" type="date" /></td></tr>
<tr><td>Change Assembly<br>Change Type</td><td colspan=5><textarea class="form-control" style="width:100%" name="change_assembly"></textarea></td></tr>
<tr>
<td style="background:lightgrey;font-weight:bold"></td>
<td style="background:lightgrey;font-weight:bold">P/N</td>
<td style="background:lightgrey;font-weight:bold">Description</td>
<td style="background:lightgrey;font-weight:bold">Change revision</td>
<td style="background:lightgrey;font-weight:bold">From</td>
<td style="background:lightgrey;font-weight:bold">To</td>
</tr>
<tr>
<td>Parent Assembly</td><td><input type="text" class="form-control" style="width:100%" name="sass_pn" value="Not Set"></input></td>
<td><input type="text" class="form-control" style="width:100%" name="ass_desc"></input></td>
<td><label class="radio-inline"><input type="radio" name="ass_rev">Yes</label>
<label class="radio-inline"><input type="radio" name="ass_rev">No</label></td>
<td><input type="text" class="form-control" style="width:100%" name="ass_from"></input></td>
<td><input type="text" class="form-control" style="width:100%" name="ass_to"></input></td>
</tr>
<tr>
<td>Sub Assembly</td><td><input type="text" class="form-control" style="width:100%" name="sub_ass_pn" value="Not Set"></input></td>
<td><input type="text" class="form-control" style="width:100%" name="sub_ass_desc"></input></td>
<td><label class="radio-inline"><input type="radio" name="sub_ass_rev">Yes</label>
<label class="radio-inline"><input type="radio" name="sub_ass_rev">No</label></td>
<td><input type="text" class="form-control" style="width:100%" name="sub_ass_from"></input></td>
<td><input type="text" class="form-control" style="width:100%" name="sub_ass_to"></input></td>
</tr>
<tr><td colspan="6" style="background:lightgrey;font-weight:bold;font-size:larger;">Description of Change</td></tr>
<tr><td colspan="6"><textarea class="form-control" style="width:100%" name="description_change"></textarea></td></tr>
<tr><td colspan="6" style="background:lightgrey;font-weight:bold;font-size:larger;">Reason of Change / Root Cause</td></tr>
<tr><td colspan="6"><textarea class="form-control" style="width:100%" name="reason_change"></textarea></td></tr>
<tr><td colspan="6" style="background:lightgrey;font-weight:bold;font-size:larger;">Required Verification / Validation (tests to be performed) </td></tr>
<tr><td colspan="6"><textarea class="form-control" style="width:100%" name="required_vv"></textarea></td></tr>
<tr><td colspan="6" style="background:lightgrey;font-weight:bold;font-size:larger;">Script test</td></tr>
<tr><td><input name="allowInput" id="allowInput" type="checkbox"></input><label for="allowInput">conditional</label></td><td colspan=5><textarea id="moreInput" style="width:100%" name="moreInput"></textarea></td></tr>
</table>
<script>$("#allowInput").change(function() {$("#moreInput").attr("readonly",$("#allowInput").is(":checked")) })</script>
</form>
|  |
- readonly: If set to true, the control will not be editable by the user
- hide_report: if set to true the field will not be shown in reports
- hide_document: if set to true the field will not be shown in documents
e.g. { "hide_report":true, "hide_document":true }
Note for the FOLDER category the same thing can be achieved by a project setting hideFields, which can have two settings, hideDoc and hideReport. Both can contain a list of field id's which should be hidden, e.g.
{ "hideDoc" : [1683, 1688] }
There are 3 methods to show some help for a category
- externalHelp: this can be set to point to a an external website which is openend when user clicks on a link, e.g. "externalHelp":"matrix.com". Note this must be a website which is accesible through https://url
- popupHelp: this can be set to show help as a tooltip, e.g. "popupHelp":"enter a short description"
- inlineHelp: this can be set to render a help line underneath the "heading":"enter a long description"
- copyfromdoc: This allows to copy fields from underlying DOC into the SIGN item.
Note: Fields are copied only if this is set to true and the labels (names) of the field is the same in the DOC and the SIGN - invisible: if set to true, the field is not visible (only makes sense with the above flag)
It is possible to add fields to the category FOLDER. If these fields should only be visible for the folders in a specific category, they need the parameter visibleOption set to the category name, e.g.
{"visibleOption":"XTC"}
