Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleVersion History

Date

Change

October 2020

Initial Version

April 2023

Updated and reformatted.

February 2024

Added alternative versions

Introduction

Before you submit submitting any data, make sure to double-check that you have completed all the mandatory form fields in the correct format. This process is called known as form validation, and it which ensures that the data you provide information provided meets the specified requirementscriteria.

For example, if the phone number field requires a specific format, such as xxx-xxxx, you should enter the data in that format. Similarly, if you are asked to provide an email address, it must follow the specified format. Additionally, ensure that you do not leave any required field blank or incomplete.

Locating the Form Field Name

Rw ui steps macro
Rw step

You will need to capture the name of each fillable field that has added validations. To identify the Form Field Name, create a Work Item and add the forms to that request.

Open the form. It is displayed in the Docupace HTML5 viewer.

Rw step

The easiest way to do this is to use the Admin tool.

Click the Admin icon. Form fields will appear with color backgrounds.

Note: Green background means fields are mapped correctly. Red means that the BASE field name is missing.

Tip

Tip: You can also use the Inspect Element function of your browser to identify the field name.

Rw step

Right-click the Form Field (1), and select Validations (2). Please note that the field name appears within parentheses. To copy the name, select the Copy Field Name (3).

How to Create an Individual Validation

The approach for creating form validations varies based on the specific task.

Example #1: Creating Validations Using a Specific Work Item Form

Rw ui steps macro
Rw step

Go to Monitor (1) and open a Work Item (2) that contains the form.

Rw step

Open the form (1), enter Admin mode (2), and navigate to the field you want to work with (3).

Rw step

Right-click on the field, select Validation (1), and choose Show All Validations or Create New Validation (2).

Tip

Tip: Create separate rules for each field that you plan to provide validations for.

Rw step

Depending on which option you selected, a new window opens.

Option 1: Show All Validations

This allows you to copy/paste and update the fields you need for the new validation.

Validations-4.png

Option 2: Create a New Validation

This allows you to create a validation from scratch. Click Save when finished.

Validations-5.png

Example #2: Creating Validations in the Validations Domain

Rw ui steps macro
Rw step

Go to Administration (1) and search for Validations (2).

Rw step

Click New Validations.

Rw step

Fill out the fields in the Details section.

Validations Detail Field

Description

Name

Name of the field.

Error Message

The message that will appear to the left of the form if validation is not met.

Source Code Type

Choose SQL or Java.

Style Sheet

List of predefined style sheets with font sizes, text colors, background colors, etc. (see Appendix).

Optional

  • If the flag is set to No, then this validation MUST be completed before moving through the workflow.

  • If the flag is set to Yes, an error message will appear, but the advisor will still be allowed to complete it.

Priority

Determines the order of the validation (e.g. “0“ for the highest priority).

Expression

The rule that applies to this validation.

Reason for Adding/Changing

Enter a meaningful reason for adding (or changing).

Rw step

Filling out the Forms section depends on whether the validation should apply to a specific form or all forms containing the field name in the "Form Field Name" section. Select a form from the Quick select dropdown (1) or click Add New (2) to create a new form and fill out fields in the Details section.

Rw step

Similar to the Forms section, filling the Excluded Forms section depends on whether there is a form you want to exclude.

Rw step

In the Form Field Name section, the Form Field Name field is mandatory for creating a validation; without it, the validation won't work. You need to know for what form field the validation should apply. Click Add and enter the field name.

Rw step

The Add to Validation Sets section is mandatory. Without it, the validation process will not be successful. The data will be used in a Transition Validation. This is typically done when creating the validation.

  • Select validation from the Quick select dropdown (1) or

  • Click Add New (2) to create a new one.

How to Create A Validation Set

Associate a group of validations with a specific form or form type. It simplifies the whole process.

Rw ui steps macro

Go to Administration (1)and search for Validation Sets (2).

Rw step

Click New Validations Set.

07. New Validation Set.png
Rw step

Fill out the fields in the Details (1), Validation Sub-Set (2), and Validations (3) sections.

Details

Validation Sets Detail Field

Description

Description

Name of the Validation Set.

Validations

Validations, included in the set.

Validation Set Condition

A condition that determines which form(s), if any, to include.

Optional

  • If the flag is set to No, completing this validation set is mandatory before proceeding with the workflow.

  • If the flag is set to Yes, an error message will appear, but the advisor will still be allowed to complete it.

Reason for Adding/Changing

Enter a meaningful reason for adding (or changing).

Validation Sub-Set

To add an existing validation set to this Validation Set, click +Add and select a validation set from the list.

Validations

To add an existing validation to this Validation Set, click +Add and select a validation from the list.

Anchor
Example-D
Example-D
Step-by-Step Example

Rw ui steps macro
Rw step

Create Work Item.

Rw step

Open Form (1), enter Admin mode (2), and navigate to the field on the form (3).

Rw step

Right-click the field name (1), select Copy Field Names (2), and then select BASE Field Name (3).

Rw step

Right-click again (1), select Validations (2), then select either Show Validations (3) or Create New Validation.

Rw step

Select an appropriate validation from the list and click Copy.

Rw step

A copy of the validation form will open. Fill out all necessary fields.

2-05. Validation Form.png

Validations Details

Description

Name

Field name. When working with Vendor, then Vendor name and field name, eg., SCHWAB//1own.

Error Message

The message will appear to the left of the form if a validation is not met.

Source Code Type

Dropdown with choices SQL or Java.

Forms

Forms that use validation.

Excluded Forms

Forms excluded from validation.

Form Field Name

Name of the form field.

Style Sheet

List of predefined style sheets with font sizes, text colors, background colors, etc. (see Appendix).

Optional

  • If the flag is set to No, then this validation MUST be completed before moving through the workflow.

  • If the flag is set to Yes, an error message will appear, but the advisor will still be allowed to complete it.

Priority

Determines the order of the validation (e.g. “0“ for the highest priority).

Expression

The rule that applies to this validation.

Add To Validation Sets

Adds or removes forms to/from validation sets.

Reason for Adding/Changing

Enter a meaningful reason for adding (or changing).

Rw step

Select Form (1) from the Forms list, and click Add (2) to add the selected Form to the validations list.

Rw step

Click Add to add a Validation to a Validation Set.

Rw step

In the Validation Set Details form, enter the required data and click Submit when finished.

Validations Details

Description

Description

Description of the validation set. If working with a vendor, add the vendor name, e.g., SCHWAB//1own.

Validations

A list of current validations to add. You must add at least one validation to the validation set.

Validation Set Condition

Add condition script, eg.,

If form: Author in ('PERSHING','PERSHING ADVISOR SOLUTIONS') or

If form: QUIKID in ('44249','44252','44253').

Optional

If the flag is set to No, then this validation MUST be completed before moving through the workflow.

If set to Yes, it will allow the validations to show, but will not require them to be cleared before choosing to eSign or Wet Sign, i.e., the next step in Workflow. The advisor will still be allowed to complete it.

Reason for Adding/Changing

Enter a meaningful reason for adding (or changing).

Rw step

[Optional]

In the Validation Sets window (Figure 7), select the Edit action for the Validation Set to access a list of validations for that set and make changes (Figure 9).

Note: Creating a new Validation Set from scratch is similar. When creating a validation, you can either add an existing subset or create a new one.

2-09. Validation Sets Validations.png
Rw step

Click Submit when finished.

Tip

Example

In the process of transitioning from eSign to Wet Sign, we usually make use of Sub-Sets. Before eSigning, we ensure that all validations are cleared. The person handling the Wet Sign case may need to meet the client, but may not have all the necessary data. For this reason, we need to allow the printing of forms despite incomplete validations.

12. Validation Sub-Set-2.png

Consolidating multiple sets into a single Sub-Set for a vendor is recommended to maintain a cleaner structure.

11. Validation Sub-Set-1.png

Rw step

Go to Administration > Transition Validations.

Rw step

Click New Transition Validations to create a new record.

Rw step

Enter (Save) in the Namefield. Select the appropriate Task Node.

The default value for Transition Validations is Advisor Review. In this location, advisors create Work Item packets for processing.

Note: All additional sets will be added to this record.

2-13. Transition Validation Details.png
Rw step

Verify the new validations for the selected field of the initial form.

Validations-2.png
Rw step

Update the field and click the Save icon. If the save is successful, the red validation message disappears.

Rw step

Repeat these steps for each validation on the form.

Audience: Business Analysts, Configuration Analysts, Forms Teams

Info

Functionality: Form validations provide BDs the ability to control what the Advisor must fill out in a form before the form proceeds to the next step (eSign, wet signature, etc.).

Related Pages

Filter by label (Content by label)
showLabelsfalse
max6
showSpacefalse
cqllabel = "validations" and space = "UG" and text ~ "form"