The module editor: module list, Index tab and field panels
Under Super > Modules you adjust your company’s document modules: the labels, help texts and required setting of fields, how list fields are shown, and the values users can choose. The module’s structure (its fields, sections, field types, workflow steps and receivers, name and icon) is set up by Antenor; contact Antenor to change it. You need the Admin level on the Super area row of your rights; this is what shows the Super menu. Your user administrator sets this; see The Users page and the rights table.
This page describes the module list, the Index tab of the editor and the panel that opens for each field. The Admin tab is described in The module Admin tab: statuses, comments box, Read & understood, revisioning, checklist templates.
The module list
Section titled “The module list”| Control | What it does |
|---|---|
| Filter box (placeholder Filter) with a search button | Finds modules by text. While you filter, all matches are shown on one page. |
| Module name | The module’s display name. Click the header to sort. |
| Description | The module’s description. Click the header to sort. |
| Click a row | Opens the module editor for that module. |
| Paging | 10 modules per page. |
The list shows every module in your company, whatever rights you have on each module.
The editor: top and tabs
Section titled “The editor: top and tabs”| Control | What it does |
|---|---|
| Module name | The name of the module you are editing. |
| Status (blue button) | Opens the dialog where you choose the status each section gives a document. See Set the document statuses for a module. |
| Index | The tab with the module’s sections and fields, described below. |
| Admin | The tab with statuses, the comments box, Read & understood, revisioning and checklist templates. See The module Admin tab: statuses, comments box, Read & understood, revisioning, checklist templates. |
The Index tab
Section titled “The Index tab”| Control | What it does |
|---|---|
| Section tabs | One tab per section (workflow step), with the section’s name. Click a tab to see its fields. You cannot add or delete sections. |
| Title | The section’s title, shown read-only. |
| “Row number #n” | Each row of fields is labelled with its number. |
| Field | Each field shows its field type and a tasks icon. |
| Tasks icon (tooltip Expand/Collapse) | Opens or closes the field’s panel, described below. |
| Save | Saves every change you made in the field panels. Disabled while the system or the module is in maintenance. |
The field panel
Section titled “The field panel”The panel has up to three parts: Field label, Field Settings and Field Items. Which controls you see depends on the field type. Some controls are shown but locked; they are listed so you know they are set up by Antenor.
Field label
Section titled “Field label”| Control | Applies to | What it does |
|---|---|---|
| Label box, or two boxes English and Norwegian | Every field | The text users see as the field’s label. Every box must have text before you save. |
Field Settings
Section titled “Field Settings”| Control | Applies to | What it does |
|---|---|---|
| Colour settings for background and text, and a control to clear them | Label fields | Set the colours of the label. |
| Show as dropdown | Checkbox fields | Shows the choices as a dropdown instead of checkboxes. |
| Show as dropdown, Show as radio | Dropdown and radio fields | Choose whether users pick the value from a dropdown or from radio buttons. |
| Show as type ahead | Dropdown and radio fields shown as dropdown | Lets users type to find a value in the dropdown. |
| Configure dynamic form | Dropdown and radio fields | Shown, but locked. |
| With Translation | Information and rich-text fields | A switch for translated content in the field. The rich-text field has a tooltip that explains it. |
| Risk field range and colours | Risk fields | Shown, but locked. |
| Single select, Multiselect | Global fields placed in the module | Whether users can pick one value or several. The values themselves are managed under Super > Global Fields; see Add a value to a global field, with or without translation. |
| Allow adding and deleting rows, and a translation switch | Table fields | Whether users can add and delete rows in the table. |
| Choice between a dynamic and a static user | User fields | Shown, but locked. |
| Multiple select, Single select | Connected dropdowns | Whether users can pick one value or several. |
| Show progress bar | Checklist fields | Shows a progress bar with the checklist. |
| Required | Every field except label and information fields | When on, the field must be filled in before the document can be sent. Users see a star with the tooltip Required; see Edit mode: buttons, the send dialog, the required-fields dialog. |
| Number of columns (1, 2 or 3) | Checkbox fields not shown as dropdown | Lays the checkboxes out in one, two or three columns. |
| Configure Tooltip: Enable Tooltip, Translation, English, Norwegian | Every field except information fields | Enable Tooltip gives the field a help text. With Translation on, you write it in English and Norwegian; otherwise in one box. |
| Default value box (“Enter default value”) | Text fields | Shown, but locked. |
Field Items
Section titled “Field Items”Shown for dropdown, radio and checkbox fields. These are the values users can choose. See Change the values of a dropdown, radio or checkbox field in a module.
| Control | What it does |
|---|---|
| Sort button | Sort alphabetically (ascending or descending) or Custom sort by number (ascending or descending). |
| Number box per value | The value’s place in the list. Can be changed only with Custom sort by number. |
| “+” | Shown when the list is empty. Adds the first value. |
| Text box | The value’s text. Locked until you click the pencil. A new value can be typed at once. |
| Default button | Makes the value the default. In a dropdown or radio field there is one default; click it again to clear it. In a checkbox field several values can be default. The default applies to this field in this module only. |
| Add | Adds a new value after this one. |
| Delete | Removes the value. Allowed only when no document in the module uses it. |
| Deactivate | Deactivates the value; the button turns red. A deactivated value stays in the documents that already have it. |
| Edit (pencil) | Unlocks the text box; the button turns green. Allowed only when no document in the module uses the value. |
| Dialog listing documents | Shown instead when you click Edit or Delete on a value that is in use. It lists the documents that use it (ID, name and a link, 10 per page) and has a Close button. The value is left unchanged. |
| Translation search (lists with translation) | In a list with translation, the text box searches your company’s existing translations; pick one for each value. A button next to it opens a form for adding a new translation. |
Saving
Section titled “Saving”Changes in the field panels are kept only when you click Save at the bottom of the Index tab; if you leave the page first, they are lost. Before you save, fill in every label box and choose a translation for every value in a list with translation. When the module is saved, the page returns to the module list. If it stays on the editor, a label or a value is missing its text.
Saved changes apply to the module as it is: they also show on existing documents in that module.
Next step
Section titled “Next step”- Change a field’s label, help text or required setting
- Change the values of a dropdown, radio or checkbox field in a module
Related
Section titled “Related”- The module Admin tab: statuses, comments box, Read & understood, revisioning, checklist templates
- Set the document statuses for a module
- Add a value to a global field, with or without translation
- Change, deactivate, delete or merge values in a global field
- The Global Fields page
- Manage the risk dropdown lists
- Manage equipment dropdowns and intervals