Configuration of Entries

Basic Entries Properties

Name

Enter a name for the entry. This should be a short name for the entry that can be used to reference it within other configuration options (e.g. option dependencies, values for derived entries etc.) The primary function of the 'name' field is for configuring the study and it will not be displayed to the user in openCDMS Collect.

Display Text

Enter a name for the entry. This is the name of the entry that will be displayed to the user.

Number

This is the label that will appear to the user before the entry name. Typically, numbered labels such as 1, 2, 3, might be entered here to identify the entries in the document sequentially.

Entry Status

This field determines which status the entry will be in - MANDATORY: the field must be completed by the user; OPTIONAL: the field may or not be completed by the user; DISABLED: the field will be ineditable (greyed out) to the user (typically this is used when the entry is controlled by option dependencies.)

Entry Permissions

This displays the permissions given to the entry. It shows who can see or edit the response to the entry. Click on the 'view/edit' button for more detailed information about the current entry.

Help Text

This field allows a text entry for providing information to the user about how to respond to this entry.

Disable Missing Codes

This checkbox determines whether the missing codes will be displayed for this entry or not (missing codes include for example 'Not Applicable' and 'Data unable to be captured'). This box should be checked if you want the user to be forced to enter a value for the question or to choose from a predefined list of configured options.

Font Style

Select the font style of the displayed text. (Header: large, bold text.) This is particularly useful for displaying headers within a document.

Show Option Codes

For an option, selecting this checkbox will make the option codes visible (option codes are configurable during the creation of options.) Option codes are typically numbered labels for the individual options.

Use drop-down selection box

Display the options as a drop-down box rather than as a selectable list of radio buttons.

Option Dependencies

  • Option Dependencies. For some entries, you may wish to define a dependency between this entry and another entry. For example, a question on pregnancy may be enabled/disabled by the participant's gender. To create this kind of dependency. First create the entry on which the question depends. In this case we create the gender question. To create an option entry, we complete the basic entry properties as before. Additionally we create options for the entry as follows:

    Figure 5.3. Configure Option Entry dialog

    Configure Option Entry dialog

    Click the "Add" button to create a new option and fill in the required fields. Repeat this process for all required options. In this case, we just create 'Male' and 'Female'.

    Figure 5.4. Add Option dialog

    Add Option dialog

    Next we create the pregnancy option entry. In the same way as before we create the options 'Yes' and 'No'. This time, however we set the Entry Status of the option entry to 'DISABLED'. This means the option entry will initially be greyed out and will not require the user to enter a value for it. Now we click the 'Option Dependencies' tab and define a dependency.

    Here, we assign the option 'Gender-female' and set the Status to 'MANDATORY'. This ensure that if the option 'Female' is selected by the user, the pregnancy question will be mandatory and must be completed.

    Figure 5.5. Configure Entry - Option Dependencies

    Configure Entry - Option Dependencies

Manage Units

Provides the capability for adding, removing and changing the units for the study. To add a unit, click the 'add' button a configuration dialog for creating a new unit will be provided. For editing a unit, select the unit in the list and a configuration dialog will be produced. Similarly, to remove a unit, select the unit in the list and click 'Remove'. A description of the configuration options for creating and editing units is described below. The 'Ok' button will save the configured units. 'Cancel' will exit from the units management window and will not save the changes. 'Apply' will instantly save any changes made to the units to the study; this is a useful option if you wish to define base units within a single units management session.

  • Abbreviation: Provide a short abbreviation of the unit (e.g. "mg", "kg").

  • Description: Provide a textual description of the units (e.g. "milligrams", 'kilograms").

  • Base Unit: This can be used to convert any value having this unit to the units of the base unit by multiplying the value by the factor.

  • Factor: The factor used to convert a value having this unit to the units of the base unit by multiplication.

Manage Validation Rules

Provides the capability for adding, removing and changing the validation rules for the study. Use the add, edit and remove buttons to manage validation rules. Adding, editing, removing, saving and canceling operations available in this dialog function like the operations described for units above. The 'View Tests' button is used within the Library mode and is described the Element Library section. A short overview of the general fields for validation rules is now provided before a more in-depth description of specific fields for particular kinds of validation rules.

  • Description: Provide a short description of the validation rule e.g. Number > 0 and < 5.

  • Message: Provide a description that will be displayed to the user when the rule is violated. e.g. The number must be greater than 0 and less than 5.

  • Type: Select the type of validation rule depending on the kind of contraints you wish to apply, a numeric range, a date range etc.

Type of Rules

Text Validation Rule : Use this kind of rule to restrict a textual entry to a particular pattern and/or length.

  • Lower Limit: the minimum number of letters the response must contain

  • Upper Limit: the maximum number of letter the response must contain

  • Patterm: A regex expression to use for constraining the entry.

  • Pattern Details: A short summary description of the pattern.

Integer Validation Rule : Use this kind of rule to set acceptable ranges on an integer entry. (An integer is a positive or negative whole number e.g. -1, -2, 1, 2, 3).

  • Lower Limit: the minimum integer that can be entered.

  • Upper Limit: the maximum integer that can be entered.

Number Validation Rule : Use this kind of rule to set acceptable ranges on a number entry.

  • Lower Limit: the minimum number that can be entered.

  • Upper Limit: the maximum number that can be entered.

Date Validation Rule : Use this kind of rule to constrain a date entry to particular values.

  • Absolute Lower Limit: The minimum date that may be entered.

  • Absolute Upper Limit: The maximum date that may be entered.

  • Relative Lower Limit: The range from today that specifies the minimum date that can be entered.

  • Relative Lower Limit Units: The timeframe used in conjuction with the value entered in the 'relative lower limit'.

  • Relative Upper Limit: The range from today that specifies the maximum date that can be entered.

  • Relative Upper Limit Units: The timeframe used in conjuction with the value entered in the 'relative upper limit'.

Manage Transformers

Provides the capability for adding, removing and changing the transformers for the study. The operations to add, edit, remove, ok and cancel function as in the manage units dialog described above. The View Tests button is only relevant in the Element Library view as descibed in the Library documentation.

  • Type of the new transformer: Choose from either the preconfigured transformers or define your own.

  • Web service namespace: Set the namespace of the web-service that the transformer utilizes to perform data transformation.

  • Web service operation: Set the operation of the web-service that the transformer utilizes to perform data transformation.

  • Web service URL: Set the URL of the web-service that the transformer utilizes to perform data transformation.

  • Result class: Get the name of the sub-class of Value that the result of the transformation will be stored in.

  • Viewable Output: Set the value of the viewable output flag. If true, the output of the transformation can be viewed by humans; if false the output of the transformation should not be viewed by humans