Input Fields
Each item has some input fields as specified for its 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:
| |
Plain Text Editor (text) | And editor allowing to enter plain text parameter:
| |
File Manager (fileManager) | A control allowing to add file attachments to an item parameter:
| |
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 | |
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 | |
Tasks Control (tasksControl) | Allows to show links to external websites / issue tracking systems. Extensions for certain sites might provide additional functionality like back links. Currently these plugins exists:
For this field to work, you need to ensure that the extensions is globally enabled for the server (Extensions in the tree), and also for the project (Extension Settings for the project) | |
One2One Issue Mapping (workflow) | This field is actually shown in the toolbar: it allows to create a tight relation between a Matrix item and a task in an external system (JIRA, ...). You need to add these in the Extenstion Settings for the project, for this field to work: "one2OneMapping":{ "projectId":"THEPROJ", "taskTypeId":"Task", "showId":false, "statusOverwrites":[ { "externalStatusName":"In Progress", "text":"task In Progress" }] } | |
Downlinks (links) | Shows the existing downlinks and allows to create new links as well as new linked items
| |
Uplink Information (uplinkinfo) | This control does not show up in reports and documents. Allows to show information about uplinks
| |
Quality Gates (gateControl) NEW 2.0 | Gate fields allow you to lock or unlock other fields in forms. A gate is activated by approval of one or more users. These are the options to specify users to lock: A gate is approved if one user in each group has clicked on "Pass". If a gate is approed the following can be be done:
It is also possible to add a review comment when passing or failing a gate. Printing: It is possible to specify the text which is added to documentes depending on the status of the gate. If no text is specified, nothing is printed. Seaching: it is possible to do a full text search to find items e.g. _pass_tim_ - will find all items where tim passed a gate _fail_tom_ - will find all items where tom did no pass a gate _todo_demo_ - will find all items where demo needs to review _passed_ - will find approved gates _failed_ - will find failed gates _todo_ - will find all gates which need a review This can be combined with mrql to seach in specific fields, e.g. mrql:"Gate 1"~"_failed_" | |
Design Review Table (reviewControl) NEW 2.1 | Review controls allow to perform design reviews of other items in the tree. See Configuration Review Controls for details on how to configure it |
Common parameters for fields
Readonly fields
- readonly: If set to true, the control will not be editable by the user
Hiding fields in documents / reports
- 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] }
Category help
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"
Special parameter for SIGN category
- 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)
Special parameter for FOLDER category
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"}