Criteria Maintenance (XML)
Overview
Click Administration > Criteria to open the Criteria Maintenance page.
Administrators can use this option to add, edit and delete criteria. Criteria cannot be used with RTS documents. Contact Support for assistance with creating or working with criteria.
Criteria are conditional statements that will disable documents if the condition is FALSE and enable the documents if the condition is TRUE. Criteria is triggered based on the host data file’s target field and value. For example, Power of Attorney (POA) documents vary from state to state. By defining criteria for each state that an FI does business in and associating those criteria to the different POA documents an administrator will ensure that only the correct document will be processed.
Criteria conditions in eSign can be any valid XPath expression. eSign evaluates this XPath expression for the transformed/orig xml file created (XML sent by the host is processed with our XSL which then creates the transformed/orig file) and counts the nodes that satisfy the XPath condition. If the node count is greater than 1, then the document that has the criteria attached is available for processing. If the node count is 0, then the document is not available for processing. 1 ‘//*[‘ will be added at the beginning and ‘]’ at the end automatically to make it a valid XPath expression.
Some of the commonly used operators/functions are listed below with examples:
|
Operator/ Function |
Criteria Condition |
Converted XPath Expression1 |
Description |
|---|---|---|---|
| = | APP1_ADDR_CITY=’New York’ | //*[APP1_ADDR_CITY=’New York’] | Criteria to match the applicant 1 city to ‘new York |
| != | APP1_ADDR_CITY!=’New York’ | //*[APP1_ADDR_CITY!=’New York’] | Criteria to match the applicant 1 city not equal to ‘new York’ |
| < | APP1_DOB_YEAR<’1970’ | //*[APP1_DOB_YEAR<’1970’] | Criteria to match applicant DOB less than 1970 |
| <= | APP1_DOB_YEAR<=’1970’ | //*[APP1_DOB_YEAR<=’1970’] | Criteria to match applicant DOB less than or equal to 1970 |
| > | APP1_DOB_YEAR>’1970’ | //*[APP1_DOB_YEAR>’1970’] | Criteria to match applicant DOB greater than 1970 |
| >= | APP1_DOB_YEAR>=’1970’ | //*[APP1_DOB_YEAR>=’1970’] | Criteria to match applicant DOB greater than or equal to 1970 |
| or | APP1_ADDR_ZIP=’12121’ or APP1_ADDR_ZIP=’21212’ | //*[APP1_ADDR_ZIP=’12121’ or APP1_ADDR_ZIP=’21212’] | Criteria to match applicant 1 zip to 12121 or 21212 |
| and | APP1_ADDR_ZIP=’12121’ and APP1_DOB_YEAR<=’1970’ | //*[APP1_ADDR_ZIP=’12121’ and APP1_DOB_YEAR<=’1970’] | Criteria to match zip to 12121 and DOB year less than or equal to 1970. |
| substring | substring(APP1_DOB_YEAR,1,3)= '197' | //*[substring(APP1_DOB_YEAR,1,3)= '197'] | Criteria to match applicant DOB from 1970 to 1980. |
| Mixed Condition 1 | (APP1_ADDR_ZIP='07201' or APP1_ADDR_ZIP='07202' or APP1_ADDR_ZIP='07206') and (SNR1_FULL_NAME_FML!='' and SNR2_FULL_NAME_FML!='' and SNR3_FULL_NAME_FML!='') | //*[(APP1_ADDR_ZIP='07201' or APP1_ADDR_ZIP='07202' or APP1_ADDR_ZIP='07206') and (SNR1_FULL_NAME_FML!='' and SNR2_FULL_NAME_FML!='' and SNR3_FULL_NAME_FML!='') | Criteria to match applicant 1 living in Elizabeth, NJ and the document requires three signers |
| Mixed Condition 2 | (APP1_ADDR_ST='NY' or APP1_ADDR_ST='NJ') and APP1_DOB_YYYY<'1956' | //*[(APP1_ADDR_ST='NY' or APP1_ADDR_ST='NJ') and APP1_DOB_YYYY<'1956'] | Criteria to match applicant 1 living in either NY or NJ and being at least 50 years old |
Note:
Connectors are case-sensitive. Use "or" and "and", not "OR" and "AND."
In complex expressions, enclose similar expressions in parentheses to control the order in which they are handled. For example, in Mixed Condition 1, Zip Codes will be evaluated first, then the signers' names, then the combination of the two.
Refer to https://www.w3schools.com/xml/xpath_operators.asp for other operators supported in XPath string.
Refer to https://www.w3schools.com/xml/xpath_functions.asp for using various other functions in the XPath string.
- To add criteria, click Add Criteria. A new line appears.
- Complete the following fields:
- Criteria Name: The name of the criteria.
- Condition: The criteria condition can be any valid XPath expression.
- Description: The description of the criteria.
- Click Update to save the changes. The Criteria Maintenance page refreshes, displaying the new criteria.
- From the Criteria Maintenance page, click Edit to the left of the criteria you want to edit. The Criteria Name, Condition and Description fields are now available to edit.
- Enter any necessary changes.
- Click Update.
After criteria have been defined, they must be attached to a document in order to be effective.
- From the Documents Maintenance (XML) page, click Edit next to the document to be edited. The Document Maintenance (XML) page refreshes with the document fields unlocked for editing.
- Select from the drop-down menu in the Criteria column. The Document Maintenance (XML) page refreshes showing your selection.
- Click Update to save the changes.
Note: When a criterion is associated with a document and that criterion is deleted, the Criteria field in the Document Maintenance (XML) page resets to None.
- Select the criteria to be deleted:
- Check the box to the left of the criteria to be deleted.
- Check the box at the top of the column to select all.
- Click Delete Selected.
Stop: Clicking Delete Selected will delete the criteria with no warning confirmation.