Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Introduction

...

The Smart Form Manager Tool is available in the Regent Tools menu for users with the ‘Smart Form Manager Tool’ permission enabled.

The Document Assignment Tool is comprised of a top section with selection options for Institution Name and Query Name and a bottom section for the selection of Documents to be assigned.

NOTE: This tool is designed to be used at the Institution level. Only one Campus per Institution should be configured.

...

Expand
titleSection Fields

Section Field Name

Section Description

Required/Optional

Section Field Type

Section Field Options

Template Engine

If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html).

Required

Dropdown

  • Static

  • Velocity

Section Name

The text entered in this field is displayed in the Smart Form menu as the Menu Section Name.

Required

Textbox

Code

The text entered here will be used as a short name to identify the Section in the Smart Form Manager.

Required

Textbox

Sort Order

The number entered here will be used to sort Sections in the Smart Form from the lowest Sort Order to the highest Sort Order.

Required

Numberic box

Visible

If selected, the Section will be visible by default. If unselected, the Section will not be visible by default. Dependency logic can be used to display or hide the Section from its initial default state.

Optional

Checkbox

Section Additional Information and Advanced Settings

Section Id

A system-generated ID is created and associated when creating a new section.

Textbox (Read-only)

Created At

This is the date upon which a new section is created.

Textbox (Read-only)

Modified At

This is the last date upon which a section was modified.

Textbox (Read-only)

Section Title

The text entered in this field is displayed at the top of the Smart Form page.

Optional

Textbox

Section Information

The text entered in this field is displayed at the top of the Smart Form page beneath the Section Title, if configured

Optional

Text Area

Parent Information

The selection(s) in this section can be used as an identifier or in validation and dependency logic in the Smart Form.

Optional

Checkbox

  • Selected

  • Unselected

...

Expand
titleGroup Fields

Group Field Name

Group Field Description

Group Field Type

Group Field Options

Template Engine

If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html).

Dropdown

  • Static (Default)

  • Velocity

Group Name

The text entered in this field is displayed as a Group Title for a set of one or more questions in the Smart Form.

Textbox

Group Instructions

The text entered here is displayed as instructional messaging for the questions within the group.

Textbox

Code

The text entered here will be used as a short name to identify the Group in the Smart Form Manager.

Textbox

Sort Order

The number entered here will be used to sort Groups within the Section from the lowest Sort Order to the highest Sort Order.

Numeric

Visible

If selected, the Group will be visible by default. If unselected, the Group will not be visible by default. Dependency logic can be used to display or hide the Group from its initial default state.

Checkbox

  • Selected

  • Not Selected (Default)

Page Index

Groups can be displayed on different pages within each Section. The number entered here will be used to determine which page the Group is displayed on.

Numeric

Group Additional Information and Advanced Settings

Group Id

A system-generated ID is created and associated when creating a new group.

Created At

This is the date upon which a new group is created.

Modified At

This is the last date upon which a group was modified.

...

Expand
titleQuestion Fields

Question Field Name

Required/Optional

Question Field Description

Question Field Type

Question Field Options

Field Type

Required

The selection here will be used to determine the question selection type.

Dropdown

  • Textbox

  • Dropdown

  • RadioButton

  • Date

  • SSN

  • Autosize Dropdown

  • MMDDYYYY Dropdown

  • HyperlinkButton

  • Text Only

  • MMYYYY Dropdown Date

  • Text Area

  • Checkbox

  • Currency - Whole Dollar

  • Phone

Data Type

Required

The Data Type entered here will determine how the value is saved in the database and the available operators in the Regent Query Tool. If this field is not selected, the question is not available as an option in the Regent Query Tool.

Dropdown

  • Text

  • Amount

  • Date

  • Number

Template Engine

Required

If static is selected, the field content is displayed in the same manner provided. If velocity is selected, a velocity templating engine is used that will allow for dynamic logic and display (see https://velocity.apache.org/engine/1.7/user-guide.html).

Dropdown

  • Static (Default)

  • Velocity

Question

Required

The text entered in this field is displayed as a Group Title for a set of one or more questions in the Smart Form.

Textbox

Help Text

Optional

The text entered here will display as help text beneath the question in the Smart Form.

Textbox

Code

Required

The text entered here will be used as a short name to identify the question in the Smart Form Manager.

Textbox

Allows alpha-numeric characters without spaces

Sort Order

Required

The number entered here will be used to sort questions within the Group from the lowest Sort Order to the highest Sort Order.

Numeric

Pre-populate Question Response from

Optional

If ‘Prior Smart Form’ is selected, the question response is pre-populated from the most recently completed Smart Form with the same Smart Form Type, regardless of the FAY scope. If ‘Prior Smart Form with same FAY’ is selected, the question response is pre-populated from the most recently completed Smart Form with the same Smart Form Type and the same FAY scope. If ‘None’ is selected, the question response presented in the Smart Form is not pre-populated.

Dropdown

  • None (Default)

  • Prior Smart Form

  • Prior Smart Form with same FAY

Default Question Response

Optional

The text or input value entered here will be used to pre-populate the response for the question in the Smart Form based on predefined Regent data or one of the available options.

Textbox

Maximum Number of Characters Allowed in Response

Optional

The number entered here will be used to as the limit for the number of characters allowed in the user response for this question when completing the Smart Form.

Numeric

Maximum Characters: 10

Required

Optional

When this field is selected, the question requires a response in the Smart Form. If selected, this question is always displayed if the section and group are displayed and takes precedence over the ‘visible’ setting for the question. If dependency logic is desired for the question, the ‘visible’ setting should be used to display or hide the question from its initial default state.

Checkbox

  • Selected

  • Not Selected (Default)

Visible

Optional

If selected, the Question will be visible by default. If unselected, the Question will not be visible by default. Dependency logic can be used to display or hide the Question from its initial default state.

Checkbox

  • Selected

  • Not Selected (Default)

Read Only

Optional

When this selection is selected, no question options will be required or available.

Checkbox

  • Selected

  • Not Selected (Default)

Group Additional Information and Advanced Settings

Question Id

A system-generated ID is created and associated when creating a new question.

Created At

This is the date upon which a new question is created.

Modified At

This is the last date upon which a question was modified.

Reset Response if Hidden

Optional

When this field is selected, the question response will revert back to the original default response value (e.g. blank, unselected) if the question is subsequently hidden due to smart logic. For example, if a user answers ‘Yes’ to this question then changes a prior question that forces this question to no longer display, the response value is then reverted back to the original default response value.

Checkbox

  • Selected

  • Not Selected (Default)

Reset Response if Restarted

Optional

When this field is selected, the question response will revert back to the original default response value (e.g. blank, unselected) if the question is subsequently displayed after being hidden due to smart logic.

Checkbox

  • Selected

  • Not Selected (Default)

Auto Capitalize

Optional

When this field is selected, the response will be user response in the Smart Form is automatically updated to all capital letters.

Checkbox

  • Selected

  • Not Selected (Default)

Options Expression

Optional

This field allows an expression to be provided by the user when to display an option under the defined conditions. Expressions use JavaScript language (see https://www.geeksforgeeks.org/javascript-regexpregular-expression/) to perform logical and mathematical operations to determine if the expression is true or false.

Textbox

Secure

Optional

This is a legacy setting and is no longer used.

Checkbox

  • Selected

  • Not Selected (Default)

...