Creating a custom section is similar to creating any other kind of section, except that you need to indicate the kinds of fields to appear, and configure those fields. You can create custom fields within a custom, objective, or competency section.
The process to create custom fields is exactly the same in each type of section, but the visibility of those fields differs across different sections.
Watch this video to learn how custom fields display in each section of the performance form.
For each custom field, four elements must be defined:
Element Key – ID for the field. Must be one word, unique per form template, and can be used for permissioning.
Element Name – Label that appears on the form; some basic HTML functionality.
Element Type – Defines the kind of element and dictates the kind of data allowed. Indicated in element attributes as type="x". You can find all the available types in the table titled Custom Field Element Types.
Element Value <evalue> – Used to pre-populate a value in the field – can also be reportable.
There is more flexibility to create <evalue> in XML, because in Manage Templates you are restricted to the field type.
For example, if the field type is Integer, which only supports a whole number, you may only populate the <evalue> field with a whole number. In XML, you are able to use text to pre-populate the field instead than being restricted to a whole number.
Types of Custom Fields
| Field | Definition |
|---|
<ekey> | This is the id for the field, and is used for permissioning and other functions. The element key must be unique per form template, and can only be one word. |
<ename> | This is the label that appears on the form. Limited HTML tags may be used in this field, such as <b></b> for bold, etc. |
<type> | This defines what kind of element this field will be, and what type of data is allowed. It is indicated in the sub-element attributes as type="x," where x is the number indicating the type of element. |
<evalue> | This is used to pre-populate a value in the field. Only required if using the element type of checkbox. The value within this element is chosen to match the content of the checkbox (for example, True, Yes, or Approved). Allows the value to be reportable. If a value is not specified, then no value is stored in the database, and nothing shows up on reports. If an <evalue> is entered, and the user does not change that default value, the <evalue> is what will be reported.
|
Select the arrows to learn how to configure each custom field type in both XML and Manage Templates.
Custom Field Configuration
Custom Element Error
Custom Element Error Explanation
Introduction Text for Custom Sections
It is possible to add an introduction text to a custom section. In Manage Templates, just add the necessary paragraph in the Description area just as you would for the Introduction section. It can also be added in the XML after </fm-sect-name>, with the code <fm-sect-intro><![CDATA[Intro text example]]></fm-sect-intro> which should be placed.
There is an option to make this introduction text editable when we mass create forms and this option is also supported with the Launch Forms tool.
In Launch Forms, the introduction text can be edited.
