1) When a text field is dragged and dropped into the form builder body/grid:
2) The text properties appear in the toolbox as shown below. Text fields are designed to store single or multiple lines of alphanumeric text (unless a Field Mask is defined as discussed below).
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 can be used; however, it is recommended that field names be defined by the user because they are 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). Field names can be edited 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. The text, TODAYS_DATE1 or TODAYS_DATE_1 can be used.
- 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 an abbreviated name for a field for export and reporting purposes. For example, if a label used in the form is related to a form field (in this case, a text field) is very long, when the data is exported the data the column header may be unwieldy when displayed in the report or exported data. The label will be used for the column header if the label is related to the field (in this case, a text field) but a reporting label is not used as shown in the figure below.
The Free Text field (assigned the Field Name TP_FREETEXT) has been related to Label (the active field indicated by the dotted blue lines in the figure above) using the Field dropdown in Label Properties section. A Reporting Label has not been designated; therefore the Label will be used as the column header in the Exported Data Pack table as shown in the following figure.
In addition, if when completing the Add New Data Pack form, the “Use Label as Header (as opposed to field name)” checkbox is selected the Label will appear as shown in the figure above. The header in a report or in an export data set would be much too long and unwieldy.
If the checkbox is not selected, the designated Field Name (TP_FREETEXT) will appear in the column header as shown in the figure below.
If the label is not related to the text field, a reporting label has not been designated, and the “Use Label as Header (as opposed to field name)” checkbox is not selected, then the column header will default to the field name in the report or export data as shown in the figure below.
Instead, the label should be related to the field (TP_FREETEXT) and a descriptive reporting label (“Reporting Label”) should be created as shown in the figure below.
Then, when the “Use Label as Header (as opposed to field name)” checkbox is selected when exporting the data, the Reporting Label will be used in the column header instead of the long string of Label text as shown in the figure below.
Type – Fields that are similar in design can be changed to other field types. Using the Type dropdown a “Text” field can be changed to a “Memo” field type using the Type dropdown as shown in the figure below.
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. To designate a Maximum Length for the field, simply enter the desired number of characters for the field to accept as shown in the figure below.
Field Mask – The Field Mask allows the Form Designer to set a pattern of how the text should appear in the field. For example, to create a text field to capture a telephone number, set the Maximum Length to 14. Then, set the mask so that the code appears as a telephone number. When a telephone number is entered in the form, only the numbers and not the dashes will need to be entered.
A telephone number in the Field Mask box is shown in the figure below. Note the Maximum Length field has been set to “14.”
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. Clicking on the View/Edit link will display the Tooltip window as shown in the figure below.
Using the Tooltip window, the Form Designer can type in the desired message which will be presented to the user completing a form when hovering over the field as shown in the figure below.
Show in Log – The Show in Log checkbox should be selected if the form being created is part of a Log Form. Selecting 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 accessed by selecting a Subject ID from the Subject Manager page (accessed from the Subject menu). Selecting 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 as a MedDRA Code Field. When the field is rendered in the form it allows the user to search the MedDRA code database for the appropriate term and code. Selecting the desired code will populate the text field with the code and term. The Special Type MedDRA Code field displays the MedDRA symbol next to the field. The figure below shows how the field appears in the form.
Clicking on the MedDRA symbol opens the “Search MedDRA Database” dialog box as shown in the figure below.
To search for the correct term and code; simply click on the MedDRA Search Term text box, type in the beginning letters of the term (start the term with an uppercase letter), and click the Go button.
After the Go button is clicked, the Search Results box will display all of the MedDRA codes with the appropriate terms as shown in the figure below.
Scroll through the Search Results, select the appropriate code and term and click the Select AE button. The code will populate the Text field and the MedDRA Search Term will display below the code.
The Special Type drop-down list contains the following choices:
MedDRA Code (Preferred) – This choice allows the Form Designer to set the Text field as a MedDRA Code search for the “Preferred” term.
MedDRA Code (Low Level) – This choice allows the Form Designer to set the Text field as a MedDRA Code search for the “Low Level” term.
Validations allow the Form Designer to define conditions that a field(s) value must meet (or not meet). Please refer to the Conditional Actions – Validations help document for complete instructions.
Required – Selecting the “Required” checkbox indicates the field must be completed. If the field is not completed, when the form is saved an error message will be displayed indicating, “This field is required” as shown in the figure below.
(Notice a query icon also appears to the left of the field. Clicking the icon will open the Add Query dialog box indicating an “Edit Check Error – This field is required” query.)
Conditional Actions - View/Edit – Selecting the View/Edit link brings up the Conditional Actions dialog box and allows the Form Designer to create simple to complex edit checks (validations) for fields (and forms). The Conditional Actions dialog box can be used to: disable or hide fields (or forms) based on some criteria, produce edit checks (validations), display a popup message, compute a value, populate a field with a value based on some criteria and/or send an email notification. Each field can contain multiple conditional actions. The number that precedes the View/Edit link indicates the number of conditional actions present on the field (or form). Please refer to the library of Conditional Actions help documents for complete instructions.
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 left edge of the Text Field will be located.
Top (pixels) – This field allows the Form Designer to designate where the top edge of the Text Field 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 width of the Text Field as a percentage of the total Form width. For example: If the width of the form is designated 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).