Summary
This article covers the form type, Text Fields.
Table of Contents
Text Properties
When a text field is dragged and dropped into the form builder workspace or an existing text field is selected, the text properties appear in the toolbox as shown below. Text fields are designed to store single or multiple alphanumeric text lines.
The following sections describe the various properties available for Text fields.
Data
Field Name: The field name allows the form designer to define the field name stored in the database. Field names can be defined by the user or the default field name.
It's recommended that field names be defined by the user due to the field names being utilized when creating conditional actions and identify the field in other areas of the system. Therefore, for ease of use and to easily locate and identify fields it is also recommended some sort of standardized naming convention be adopted and used that will be easy to understand when the study data is being viewed in reports or in an exported format. For example, a subject registration date field might be named SUBJREG_DATE. The first part of the field name is the form name (Subject Registration – abbreviated as “SUBJREG.” The second part of the name indicates the actual field (DATE).
You can edit field names as long as the form in which the field exists is not part of a published version. All field names are capitalized by default. Therefore, if a field name is typed in lower case after the cursor is moved from the field, the text will automatically convert to uppercase text. Field names have a maximum length of 30 characters and cannot begin with a number.
To define a field name:
- Click on the text box next to a field name or highlight the text with your mouse
- Type in the new name of the field
- Press the tab or enter key
Suggested Rules for Field Names:
- Field names should reflect the label text of the field. For example, if the label for the field is today’s date, the field name could be, “TODAYS_DATE” or “TODAYSDATE”.
- Field names cannot begin with a number—for example, 1_TODAYS_DATE or 1TODAYS_DATE. You can use the text, TODAYS_DATE1, or TODAYS_DATE_1.
- For long Field Names only use the _ underscore to separate words.
- Symbols should not be used in field names.
Reporting Label: The reporting label allows the form designer to define a more user-friendly name for a field for export and reporting purposes.
Example: if a field name is INC3 for Inclusion #3, you can set the reporting label as "Inclusion 3" so users who aren't familiar with a specific naming format or study design don't see "INC3" throughout the system.
If a reporting label is not set, the system will always default to using the field name.
Note: Text labels themselves can be related to the field they are associated with, via the 'Field' property. This simply causes the text label to follow the behavior of the related field in the event of hide logic being used on the field. The 'Field' property of text labels does not impact field naming in any way.
Text – selecting “Text” allows any combination of text, numeral, and symbols to be entered into the field;
Memo – selecting “Memo” allows for the entry of large amounts of alphanumeric information into the field and allows for scrolling (for specific information about creating a Memo Form Field, see the Memo Properties section below).
Maximum Length
The Maximum Length field allows the Form Designer to set the maximum number of characters allowed in the field. If the Maximum length is not defined, the default length is 10 characters.
ToolTip
The ToolTip field is an optional property that can be used at the field level to provide a Tip or Help Message explaining how to complete the field or provide a reason or explanation for the field. The user will see the tip message when they hover over the field on a desktop browser.
For more information on the available Field Types, please visit the Field Types Knowledge base article.
Show in Log
You should select the Show in Log checkbox if the form being created is part of a Log Form. Setting this property for a subject type form will show this particular field in the Log forms section displayed on the Subject Visits and Events Manager page. You can access this by selecting a Subject ID from the Subject Manager page (accessed from the Subject menu). Setting this property for a Study type form will show this particular field in the Log Form displayed on the Study Forms page accessed from the Subject menu using the Access Study Related Forms… link. The Log Forms feature is only available for use on Subject and Study type forms created in the Study Form Builder.
Special Type: The Special Type dropdown control allows users to designate the field for a particular purpose, including:
- Medical Coding attribute
- Randomization ID
- Inventory Item
- Barcode scanning (mobile compatible)
Validations
Validations allow the Form Designer to define conditions that a field(s) value must meet (or not meet). The most common method is via conditional actions.
Required – Selecting the "Required" checkbox indicates the field must be completed. If the field is not completed, an error message will be displayed when the form is saved, indicating, "This field is required". The exception to this rule will be when the field is being conditionally hidden.
Layout
The Layout Properties enable the Form Designer to designate the exact location on the Form Builder body/grid where the Text Field will be placed. The Layout properties allow the Form Designer to align various fields in a form, so they are uniform and the appropriate size when the form is rendered.
Left (pixels) – This field allows the Form Designer to designate where the Text Field's left edge will be located.
Top (pixels) – This field allows the Form Designer to designate where the Text Field's top edge will be located.
Width – This field allows the Form Designer to designate the width of the Text Field. The width of the field can be expressed in pixels or a percentage using the dropdown control.
Pixels – This dropdown choice allows the Form Designer to designate the width of the Text Field by the number of pixels.
Percent – This dropdown choice allows the Form Designer to designate the Text Field's width as a percentage of the total Form width. For example: If the form's width is specified in the form properties is 800 pixels, and a Text Field Width of 50 percent is selected, the Text Field Width will be 400 pixels wide (half the width of the form).
Need more help?
Please visit the Datatrak Contact Information page.