Create Form - Build Tab - Define General Information

When creating a form, at the top of the form, administrators can configure the form's title and API name, as well as enter a description. Administrators can also define the Active status of the form and whether or not effective dated changes can be made using the form.

To create a form, go to Admin > Tools > Core Functions > Form Management > Manage Forms. Then, from the Manage Forms page, select the Create Form button.

Title

This is a required field. Enter the title, up to 100 characters. The title displays in the administrator's default language. The title entered here automatically displays on the Settings page.

If multiple languages are enabled for your portal, select the Translate icon to translate the field into other available languages.

API Name

This is a required field that is used for third party integration purposes. The content in this field does not display for end users.

To view instructions for this field, mouse over the tooltip icon . The instructions display in a tooltip pop-up.

The name can be manually entered or automatically generated. The name must be unique.

  • To manually define the name, enter the name in the field, up to 40 characters.
  • To generate the name automatically, click the Generate button. This populates the field with the first 40 characters from the Title field. Spaces display as an underscore. If special characters are used in the Title field, the characters do not display in the Name field.
  • Once the name is automatically generated, it can be modified manually by entering changes in the field. If the name is deleted from the Name field, the name can be regenerated by clicking the Generate button.

    Note: Changes made to the Title field are not automatically populated into the Name field.

Description

This is not a required field. Enter a description for the form. This description is for administrative purposes, and it is only visible when managing forms and when selecting a form for a task.

If multiple languages are enabled for your portal, select the Translate icon to translate the field into other available languages.

Active

Forms are active by default. Uncheck the Active box to inactivate the form. Inactive forms are not available for use in tasks.

Allow effective dating changes for this form

Select this option to allow users to set an effective date for changes that are made using the form. The effective date is the date on which the changes from the form are implemented. The effective date can be a date in the future or in the past. This option is unselected by default. When editing a form that has been published, this option cannot be modified.

Note: This option is only available if effective dating for forms is enabled via a backend setting.

When the Allow effective dating changes for this form option is selected, the following additional options are available that allow the administrator to limit the range of effective dates that may be selected when completing the form. These fields are optional, and values from 0-999 are accepted. The administrator can specify a number of days into the future or past that a user can select as an effective date when completing the form. When limits are specified, the limitations are displayed to the user within the form.

  • From launch, maximum number of days into the future
  • From launch, maximum number of days into the past

Effective Date

When the Allow effective dating changes for this form option is selected, an Effective Date field is automatically added to the top of the form. The Effective Date field cannot be moved, edited, or removed from the form as long as effective dating is enabled for the form. If effective dating is disabled for the form, then the Effective Date field is automatically removed from the top of the form.

Non-Effective Dated Fields

When the Allow effective dating changes for this form option is selected, if any fields are added to the form that cannot be effective dated, the Read-Only and Auto-fill Response options are automatically selected for all non-effective dated fields, and these options cannot be unselected. This also applies to Question Bank questions that are added.