pdf » assertFormValue(var,name,expected)

Description

This command asserts the form value in the pdf document is as expected.

This assumes that the underlying pdf has a form, which is to be parsed via saveFormValues(pdf,var,pageAndLineStartEnd,strategy). Consult the PDF Form Data Extraction for more details.

This is the general approach:

1. Make sure the target PDF exists via io » assertReadableFile(file,minByte)
   • not entirely necessary, but would be easier for root cause analysis.
2. Make sure the target PDF contains key phrases, so as to affirm its validity.
   • again, not necessary but simplifies root cause analysis.
3. Parse and save the PDF form via saveFormValues(pdf,var,pageAndLineStartEnd,strategy)
4. Perform form-level validation via one or more of the following commands:
   • assertFormValue(var,name,expected) - assertFormValues(var,name,expectedValues,exactOrder) - assertFormElementPresent(var,name)

Parameters

• var - the variable that stores previously parsed PDF form data
• name - the name of the form element to validate
• expected - the expected value of that form element

Example

Script:

Output:

See Also

• saveFormValues(pdf,var,pageAndLineStartEnd,strategy)
• assertFormValues(var,name,expectedValues,exactOrder)
• assertFormElementPresent(var,name)