The Matrix field type provides the ability to display a two-dimensional array of checkboxes, allowing users to plot or rank responses relative to two factors. For example, create a matrix to assist in analyzing a broad set of characteristics across your physical assets. The columns of the matrix represent characteristics, such as maintenance burden, portability, and power consumption, while the rows might represent ranking levels, such as high, medium, and low.
On this page
Task 1: Create the field
- From your application, go to Designer tab > Layout tab > Objects panel > click
. - Select the field type, enter a name, and click OK.
- If possible, keep names under 20 characters. For example, use Description instead of Description of the Asset.
- Capitalize the first letter of each word in the field name. For example, use Predicted Impact instead of Predicted impact.
- Avoid redundant wording in field names. For example, using the word Asset is unnecessary in the following series of fields: Asset Name, Asset Type and Asset Value.
- Use noun-based field names whenever possible. Avoid verb-based field names, for example, Set Asset Name.
- Do not use the names: Version, Level ID, or Content ID for fields that you add to an application or questionnaire. Field do not display properly with these names.
- In the General Information section, enter a description.
Field name guidelines:
Note: When you save the field, the system strips any HTML tags <?xm>l, <form>, <textarea>, <option>, <select>, <meta>, and <body> that you may have inserted in the description because they may constitute vulnerabilities in the system. The following example shows how you can correct the cascading style sheet (CSS) syntax for the <body> tag so that it will function correctly:
<html>
<head>
<style type="text/css">.c0 { font-family: 'Arial' } .c1 { margin: 0px; background-color: #ffe4e1 } </style>
</head>
<body class="c0">
<p class="c1">This is a text field.</p>
</body>
</html>
Note: Do not use absolute positioning in HTML content.
Task 2: Configure options
In the Options section, select all of the following options that apply to this field.
|
Option |
Description |
|---|---|
|
Make this a required field |
Designates the field as required and forces users to enter a value when adding or editing a record in the application. An icon indicates required fields to alert users that they must enter a value. |
|
Display last modified data |
Displays auditing information next to the field each time that its value is changed. The auditing information includes only the name of the user who made the change and the date and time of the change. |
|
Make this a searchable field |
Makes this field available for display in all search results. |
|
Display this field in global search results |
Makes this field available for display in global search results. This option is only available if this field is set as searchable. |
|
Validate this field when any value changes in the record |
Designates that a field is validated whenever any value changes in a record. If this option is not selected, this field validates only when the value in this field has changed. |
Task 3: Set configuration options
In the Configuration section, set the following options:
|
Option |
Description |
|---|---|
|
Minimum selections |
Specifies the minimum number of selections for the matrix rows or columns. |
|
Maximum selections |
Specifies the maximum number of selections for the matrix rows or columns. |
|
Minimum selections axis |
Defines the axis which specifies the minimum number of selections for the matrix rows or columns. |
|
Maximum selections axis |
Defines the axis which specifies the maximum number of selections for the matrix rows or columns. |
|
Column values list name |
Defines a column-specific values list name if the Values List is field-specific. |
|
Row values list name |
Defines a row-specific values list name if the Values List is field-specific. |
Task 4: Define column and row values
During the field creation process, you can select to populate a Matrix field column and row values with global values lists or to create custom column and row values. If you select to create field-specific values, you can define those values from the Column Values or the Row Values sections on the Matrix field properties panel. Field-specific column and row values are considered local to the Matrix field because you cannot reuse these values for other fields.
For more information, see Defining Field-Specific Column and Row Values for a Matrix Field.
Task 5: Configure help text
Field-level help provides additional guidelines and instructions to ensure users enter appropriate information in the field. This Help text displays for users when they add, edit, and view records in the application where the field resides.
Consider the following general guidelines when writing field-level Help:
- Use short, concise instructions that direct the user to take a specific action. For example, "Enter your name" is preferable to "This field is used to enter your name."
- Use complete sentences whenever possible.
- Avoid jargon (unless terms are critical and are familiar to your users).
- Consider the technical aptitude of your audience, and author your help text at a corresponding level.
- Use “you” and “your” as if you are speaking directly to the user.
- Consider posing Help text in the form of a question, for example, "What is your level of interest?"
In the Help text section, do the following:
- Select a display option for both edit and view modes.
- If you are using help text, enter the text.
| Option |
Description |
|---|---|
|
None |
Help text does not display. |
|
Tooltip Icon |
Help icon displays beside the field in edit and view modes. Click this icon to display the field Help. The application dynamically sizes of the Help box based on the number of characters in the text.
|
|
Below |
Help displays below the field in edit and view modes.
|
Task 6: Configure field access
Access rights determine whether all users or only select users or groups have access to the field.
In the Access section, do the following:
- Select Public or Private.
- If you selected Private, maximize the pane and click
to select the users and groups to whom you want to grant access.
Note: Key fields must be public.