Search

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: height: height in pixels (e.g. 120, default 250) require content: if checked the user needs to type something to be able to save. allow using smart text: if checked user use smart text automatically render editor in edit mode: if checked the editor is automatically opened when showing an item, if not the user needs to click inside to show the toolbar.
Plain Text Editor (text)	And editor allowing to enter plain text parameter: number of rows: height of editor in lines, default 5 allow resizing: if checked. the can change size of control require content: if checked the user needs to enter something to save
File Manager (fileManager)	A control allowing to add file attachments to an item parameter: hide file manager: if set to true the file attachment control is only shown if at least one file is attached. Before that files can be attached using the context menu. file replacement: whether to replace existing files never (default): it is possible to add twice the and attachment with the same name ask if an uploaded file has the same name as a previously uploaded: if an attachment with the same name exists it is replaced, user needs to confirm always replace files if name is same: if an attachment with the same name exists, the old attachment is replaced ask if an uploaded file has the same file extension as a previously uploaded: if an attachment with the same file extension exists it will be replaced, user needs to confirm always replace if file extension is same: as above but user is not even asked restrict file uploads to given extensions: allows to restrict which extensions can be uploaded allow attaching only one file: restricts the control to only attach one file upload text: the text of the upload button
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: JIRA Server Connector JIRA Cloud Plugin GitHub Plugin Link Plugin 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)
Text Entry Line (textline)	Allows to enter one line of text parameter: require content: if set the user needs to enter something in order to save the item
User Selection (user)	A drop down with all users in the project parameter: require content: if set the user needs to enter something in order to save the item maximum number of selected items: how many users / user groups can be selected show users: whether users can be selected show user groups: whether user groups can be selected
Date Picker (date)	Control to select a date parameter: allow removing date: if checked the user can delete the date after it has been set. require content: if set the user needs to enter something in order to save the item
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 Field
Downlinks (links)	Shows the existing downlinks and allows to create new links as well as new linked items disabling the "Hide Create Buttons" settings: parameter: 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)	This control does not show up in reports and documents. Allows to show information about uplinks. Different options are available: parameter: 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 showCreate: if set to true a create and select button is shown 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 Example configuration to show uplinks with unlink button { "exists": true, "cats": "REQ", "itemInfo": "reflistedit" } Example configuration to mark uplinks to risks as risk controls { "exists": false, "cats": "REQ", "icon": "fa fa-exclamation-triangle", "iconfg": "yellow", "iconbg": "black", "text": "uplink info to REQ missing" }
Cross Project Links (crosslinks)	Links to items in other projects parameter: text before list of links: the text shown before the list, defaults to Links name of select button: text in button behind the links show as list: instead of showing them in a comma separated list, it shows them as bullet list hide unlink icon: if shown as list, this option hides the unlink button
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 or if it is necessary to have two or more different risk configuration in one project, the setting can also be saved with the field. See Risk Management for the options.
Checkbox (checkbox)	A checkbox control If an item category has a checkbox, this checkbox can be configured to only show in items if it is checked. parameter: showOnlyIfChecked: print in documents only if checked.
Quality Gates (gateControl)	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 approved the following can be be done: all fields above the gate can be locked (= made read only) all fields underneath the gate be unlocked (which means they are read only until a gate passed) tool and reference icon button can be removed the item title can be locked. 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. Searching: 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_" parameter: users / user groups: there are 4 of these lines in the configuration screen (note all need to be filled, but at least one): For each filled line, one person can activate (approve or disapprove) the gate. In order for the gate to be approved all lines need to be approved if gate has passed a gate has passed if all users approved it (well, one per line). If it lock fields above: will make all fields above the gate read only enable fields under gate: will make fields under gate writable hide tool menu: hides the item tools hide referencing dialog buttons: hides buttons lock item title: locks title set the following labels: sets some labels when the item is saved Require signature to pass: in order to pass a gate the user needs to provide his signature Show comments field: allows the user enter a comment Names for buttons to pass and fail, in 2 states passed or not passed. Reset gate if field changes: allows to specify other fields of the item, which will reset the gate if they are changed after the gate passed Printing options: to show gate in documents, depending on status
Design Review Table (reviewControl)	Review controls allow to perform design reviews of other items in the tree. See Configuration Review Controls for details on how to configure it
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 Extension Settings for the project (i.e. under Advanced of the Jira Cloud Plugin), for this field to work: "one2OneMapping":{ "projectId":"THEPROJ", "taskTypeId":"Task", "showId":false, "statusOverwrites":[ { "externalStatusName":"In Progress", "text":"task In Progress" "color":"grey", "background":"transparent" } ] }

Common parameters for fields

When some fields (Rich and Plain text + (user) Dropdown fields) are marked as "Require content", the item can't be saved without content in that specific field:

Common parameters for fields

read only control: If checked, the control will not be editable by the user
do not print in reports: if checked, the field will not be shown in reports
do not print in reports: if checked, the field will not be shown in documents

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] }

help to show under section name: shows a text in the UI to explain the user how to fill the field

The above is the default method, setting the property inlineHelp. There are 3 methods to show some help for a category. All can be changed int he advanced settings:
- 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

when creating the SIGN, copy the value of the field with the same name from DOC: 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
Advanced options:
- 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"}
```