Adding Dataform Fields

Determines the type of data you store in this field. ClientSpace has a full array of different datatypes. The most commonly used datatypes can be found in the topic Configuring Your Dataform Datatypes. For an in-depth look at the Lookup datatype, see Configuring lookups.

Field sets are not data entry fields, and no corresponding SQL Server field is created when a new fieldset data type is created. Field sets act as an organization container for other fields. The use of fieldsets typically makes the layout and organization of a data form significantly better.

Allows you to control whether fields within a field set are visible or collapsed within the field set container when the form loads.

Note: 

• This setting affects field display only. Dataform field validation still occurs on fields contained within field sets that are collapsed by default. Additionally, this setting does not interfere with workflow channel configurations that reference fields in collapsed field sets.

• With the ClientSpace Release 132 update, a one-time script will run to check for instances of Field Set Default that are empty and set them to Expanded so that you do not have to manually apply field set collapse/expand functionality to field sets that existed prior to when this feature was introduced. Previously entered Field Set Default values will be skipped by the script to preserve your entries.

You can:

• Select Expanded to display all fields within the field set by default upon form load.

  Note: Expanded is the default selection when you add a new field set.

  Upon form load, all fields within the field set are visible and a down chevron appears next to the field set name. The chevron is a toggle switch for changing between expanded and collapsed views. From the default expanded view, a user can click the down chevron to switch to a collapsed view as shown in the example below:

  

• Select Collapsed to hide all fields within the field set by default upon form load. Upon form load, all fields within the field set are hiding and a right chevron appears next to the field set name. The chevron is a toggle switch for changing between expanded and collapsed views. From the default collapsed view, a user can click the right chevron to switch to an expanded view as shown in the example below:

  

• Clear the Field Set Default field to always display all fields in the field set with no ability to expand or collapse field sets.

The field label is displayed on the dataform. By default, the underlying field name is set to the field name with any spaces or special characters removed.

Click (Settings) to open the Style Configuration fieldset and change the style of the field label (for example, font type, style or color). You can:

• Select Normal, Bold, Underline, or Italic in the Font Type field.

  Note:  After selecting one type you can select another so that you can add multiple font type attributes to the field label (For example, Normal and Underline, or Bold and Italic)

• Select Normal, Small, or Large in the Font Style field.

• Select the Color picker drop-down in the Color field and complete the following:

  • Enter a color Hex code (for example, #0000ff)

    Or

    Select a color and adjust the color with the slider

  • Click Update to set the color

    

• Review the Sample Text.

• (Optional) Click Discard to remove the style configuration for the field label.

The name of the field that is created on the SQL table. By default, the field label is stripped of its spaces and special characters and used as the Field Name. The field name can be overridden as needed and can be set to anything that is accepted by SQL Server as a valid field name. Duplicate field names are not accepted.

Field labels are often duplicated in developing large dataforms. As duplicate fields are created, you must modify the field name to make it unique to save the field. After the field is saved the first time, the field name CANNOT be changed.

Carefully map out your field naming standards before creating dataforms. ClientSpace uses a standard naming convention when naming a field based on the datatype of the field. It is a recommended best practice to use these same conventions in your own field names. To discover the best practice for your field type, see Dataform field naming standards.

The row property determines the vertical ordering of fields and fieldsets. Fields that are within a fieldset are ordered within that fieldset. Though the sort uses a standard numeric order, it is recommended to set rows in increments of ten. This allows for reordering fields or adding fields between rows without reordering the entire form.

The column property is hardcoded to dictate a two-column format. Technically, you can select the same row and column for more than one field, and they align alphabetically. However, this generally causes problems in the presentation of the dataform to the user.

When ReadOnly is selected, the field cannot be edited. Normally, these fields are set automatically by business logic.

When Required is selected, the field must be completed in order for the Dataform to be saved, unless the field is contained in a hidden field set.

Specifies the maximum character length of the field entry. This property is valid for Text, Text-Wide, and TextArea element types. For example, if the Length property is set to 10, a user can only enter 10 characters for the field. If this property is blank, the system does not limit the character length of the field entry.

The text in Comment provides contextual help for dataform users. When comments are added to any dataform field, the info bubble next to the field label is enabled, and on hover, the info bubble displays the comment text in a pop-up.

Selecting a value in this list adds the field to the Quick Search on multiform searches. Fields that link to other dataforms are not eligible for Quick Searches. Available options (quick search types) include Starts With, Equals, and Contains (% search).

This setting is only available when the Element Type of the dataform field is Org Type Ahead. Selecting a value in this list filters the organization lookup list to organization records that match the specified category. EX: Brokers or Staffing.

This setting is only available when the Element Type of the dataform field is Org Type Ahead. Setting this field filters the organization lookup list to organization records are associated with a workspace.

This setting is only available when the Element Type of the dataform field is Org Type Ahead. This section is used enable settings to display additional workspace-specific information (if entered), such as making the Client Number, PEOID, and DBA display next to each value in the lookup list which can help users identify the correct company when there are similarly named companies in the list.

Used when there is a special script or special code entered in Advanced Settings for a dataform field. For instance, on the Benefit Parent Company field, there is code entered in Advanced Settings to filter the Org Type Ahead for this field to only display companies associated with a workspace and an Active Client Master record. Also see Configuring Your Dataform Datatypes.

Is this one of the Search parameters available in a multiform list? This property can be set from the form list page or from within the field property page.

Secures the field and generates a security entity for the field in the format of gen_TableName_FieldName. For more in-depth documentation about using security entities in Role security, review Configuring Organization and Workspace Security.

Determines if the field appears on the dataform. Deactivating a field is preferential to deleting it because deleting the field removes it from the underlying SQL table and erases the data. When you deactivate or hide a field, you retain the data for later use.

This property is only available for Field Sets. When selected, the field and its children are hidden when a dataform record is viewed.

When selected, this option includes the dataform field when indexing documents attached to the form so that it can be used as part of the document search.

Marks the field auditable and is configured in System Admin > Advanced > Tables.

Marks the field as configurable when this dataform is created by Workflow Channels. Clearing this option initiates a validation to determine if this field is used by Workflow Channel dataform cloning. When used, a warning message is displayed with a link to the referenced items. Only published Workflow Channels are referenced.

If selected, this field is included in a dataform notification when dataform subscribers are emailed. Updated fields appear in bold in this email.

Marks the field as available for use as a Triggering Field or as one of the Triggering Conditions when configuring Workflow Channels and Email Templates. When a field is marked (selected) as Triggerable, it displays in the field list on Email Templates and Workflow Channels.

Clearing this option initiates a validation to determine if this field is used as a triggering condition in an Email Template or Workflow Channel. When used, a warning message is displayed with a link to the referenced items. Only published Email Templates or Workflow Channels are referenced. This option cannot be cleared until the dependencies are removed.

When a developer user selects the System setting for a dataform field, a Global Admin user can edit the field but can not delete the field.

A Global Admin user can view the System setting, but only a developer user can change this option for a dataform field. If a developer user deselects the System option for a dataform field, the system displays a message before the user confirms the change to the dataform field:

This field is a system field that may be used in business logic. Making this field 'not system' may impact some functionality.