Validations actions
Use the Validations actions to check and modify the content and format of the current field value.
Other actions in the Validations library do arithmetic calculations, assign values, copy values, and check variables.
The Validations actions are described in the following table.
- AddLeadingZeros
Inserts zeros at the beginning of a value so the character count equals the number that is specified. - AddPaddingToEnd
Pads the captured value of the current Field object with spaces from after the last character in the string out to the number of specified characters. - AddPaddingToStart
Pads the captured value of the current Field object with spaces from the start of the string up to the first character until the specified length is reached. - AddTrailingZeros
Adds zeros to the end of captured value of the current Field until the length of the value reaches the maximum n you enter as the parameter. - AllowOnlyChars
Removes all of the characters that are not specified as supported. - AppendFromField
Appends the captured value of the specified Field object to the captured value of the current Field object. - AppendToField
Appends the captured value of the current Field object to the captured value of the Field object that is specified by the parameter. - AssignFieldDefault
Assigns a default value to the current field. - CalculateDateDifference
Calculate the differences between two dates and stores the calculation in a user defined variable. - CalculateFields
Evaluates a specified expression as either True or False. - CheckSubFields
Determines whether the values of the specified child fields meet the specified criteria and deletes the parent field if they do not. - CompareFields
Compares the values of two fields by using the specified matching criteria that supports fuzzy matching. - ConvertFieldToCurrency
Converts the value of the current field to a currency value. - ConvertToLowerCase
Converts any upper case characters in the captured value of a Field object to lower case characters. - ConvertToUpperCase
Converts the lower case characters in the captured value of a Field object to upper case characters. - CopyField
Copies the value of the current field to a specified field. - CopyFieldToField
Copies the value of the current field to a specified field. - DateStampField
Updates the current Field object with today's date. - DeleteAllAlpha
Deletes all of the alphabetic characters from the captured value of the current Field object. - DeleteAllMiscChars
Deletes all of the UNICODE Symbol Category characters from the captured value of the current Field object. - DeleteAllNumeric
Deletes all of the numeric characters from the captured value of the current Field object. - DeleteAllPunct
Deletes all of the punctuation from the value of the current field. - DeleteAllSysChars
Deletes all of the characters with ASCII values 0 through 31 from the captured value of the current Field object. - DeleteChildType
Deletes all of the child objects of the type that you designate as a parameter from the Document Hierarchy. - DeleteLCSpaces
Deletes all of the low confidence spaces from the value of the current field. - DeleteParentObj
Deletes the parent of the Document Hierarchy object to which a rule that contains this action is bound. - DeleteSelectedChars
Deletes a specified character sequence from the value of the current field. This action is a more flexible version of the FilterFieldSelectedChars action. - EmptyFieldValue
Clears the text value in the field represented by the Field object of the Document Hierarchy that is specified by the parameter. - FieldContainsValue
Determines whether the current field value contains some or all of the specified text but no additional text. - FilterFieldSelectedChars
Deletes the specified characters from the value of the current field. - FormatNumberToLocale
Evaluates the current field value for known number patterns and if a known pattern is detected, updates the decimal and digit separators characters to match that of the current locale. - GetJobID
Assigns the current job ID to the Text property of the current object. - HasChildOfType
Determines whether the current object has a child of the specified type. - InsertChars
Inserts one or more characters into the value of the current field. - InsertDecimalPoint
Inserts a decimal point into the value of the current field at the specified position. - IsFieldCurrency
Determines if the captured value of the Field meets the currency format of the current locale. - IsFieldDate
Checks that the value of the field has an acceptable Date format. This action uses the current locale setting to determine valid patterns. - IsFieldDateEqualOrAfter
Checks that the Date value in the current field represented by the bound Field object of the Document Hierarchy is greater than or equal to the Date value in the field that is specified as the parameter. - IsFieldDateEqualOrBefore
Checks that the date in the current field represented by the bound Field object of the Document Hierarchy is less than or equal to the Date value in the field that is specified as the parameter. - IsFieldDateUpToToday
Checks that the Date value of the current Field object is today's date or earlier. - IsFieldDateWithinRange
Checks that the value assigned to the Text property of the bound object is a valid Date. If yes, this action then confirms that the Date is within the range specified by the parameters. - IsFieldDateWithinXDays
Checks that the captured Date value of the current Field object is within n days of the number entered as a parameter. - IsFieldDateWithReformat
Confirms that the data of a field is a valid date and then formats the Date value according to the format entered as the parameter. - IsFieldEmpty
Checks that the Field object designated as a parameter does not have a captured value. - IsFieldFilled
Determines whether the Field object designated as a parameter contains a captured value or is empty. - IsFieldGreaterOrEqual
Determines if the captured value of the current Field object is greater than or equal to the value entered as a parameter. - IsFieldHidden
Checks that the calling field is Hidden, which means the field has a variable STATUS that is equal to -1. - IsFieldLengthMax
Checks that the character length of the current Field object's captured value is equal to or less than the value set as a parameter. - IsFieldLengthMin
Checks the character length of the current Field object's captured value to see if its length is equal to or longer than a number n. - IsFieldLessOrEqual
Determines if the captured value of the current Field object is less than or equal to the value entered as a parameter. - IsFieldMatching
Determines if the value entered as the parameter is identical to the captured value of the current Field object. - IsFieldPercentAlpha
Determines if the characters in the captured value of current Field object are n% alphabetic. - IsFieldPercentNonNumeric
Determines if any of the characters in the captured value of the current Field object are n% not numeric characters. - IsFieldPercentNumeric
Determines if the characters in the captured value of the current Field object are n% numeric characters. - IsMatchingJobID
Checks that the Job ID of the current User Application job matches the Job ID value of the parameter. - IsMaxOMRChecked
Indicates the maximum number of check boxes that can contain a value, such as a check. - IsMinOMRChecked
Indicates the minimum number of check boxes that can contain a value, such as a check. - IsPatternInField
Checks that the value of the current field contains the specified VBScript regular expression. - IsSupportedImageFile
Checks that the image file attached to the current page is in a supported image format. - IsThisFieldEmpty
Checks that the value of the current field is empty. - IsThisFieldFilled
Checks that the current field has a captured value. - IsVariableEmpty
Checks that the variable specified by the parameter does not contain a value. - IsVariableFilled
Checks that the variable specified by the parameter contains a value. - ParseMultilineAddress
Splits the value of the current field at each comma and saves the substrings to the specified fields. Typically used for address fields. - ParseName
Splits the three word value of the current field and saves the substrings to the specified fields. Typically used for name fields, such as first name, middle name/initial, last name. - ReplaceChars
Replaces a character or string of characters in the captured value of the current Field object with a String that you enter as one of the parameters. - ReplaceValueAtPosition
Replaces the value at the specified position within the current field with a replacement string, or deletes the value. - ResetField
Deletes the value of the current field and sets the Position attribute of the field to 0,0,0,0. - SetIsOverrideable
Specifies if the user can or cannot override a validation that fails for the current object. - SplitFieldValuePreserveEnd
Splits the captured value of a Field object at the first instance of the character specified as a parameter. - SplitFieldValuePreserveStart
Splits the captured value of a Field object at the first instance of the character specified as a parameter. - SumFields
Adds the values of all child fields of the specified type and assigns the result to the current field. You can also use this action to sum the values of the specified variable for all child objects. - TimeStampField
Updates the current Field object with the current time. - TrimSpaces
Deletes extra spaces at the beginning and end of the captured value of the current Field object. - TruncateFromEnd
Deletes characters from the end of the captured value of the current Field object until the length of the value equals the length indicated by the parameter. - TruncateFromStart
Deletes characters from the start of the captured value of the current Field object until the length of the value equals the length specified by the parameter.
Parent topic: Global actions