Custom Fields
Best Practices
Overview
In general, Custom Fields should be used sparingly. When Custom Fields are used excessively, they can cause Encompass to perform slowly. In addition, partners should keep in mind that if every partner had an integration where excessive use of Custom Fields were in place, then the count of Custom Fields in a lender's instance could get unmanageable. Therefore, we provide the following guidance on when it is appropriate for the partner to use Custom Fields:
- Custom Fields should not be used for storing borrower level data.
- Custom Fields should not be used when there is already a standard field used for the same data.
- Custom Fields should not be used to store partner level data in Encompass. However, if there is a need for an Encompass action based on data from the partner, then this could be stored in a Custom Field.
Custom Fields Search Filter Properties
When using the filter query parameter on Custom Field-related APIs, refer to the following custom field search filter properties:
(not case sensitive)
| Filter Properties | = (Exact Match) | | (IN) | : (Like) | > (Greater Than) | > = (Greater Than Or Equal) | < (Less Than) | <= (Less Than Or Equal) | ~ (Between) |
|---|---|---|---|---|---|---|---|---|
| id | id='cx.test' | id|('cx.test','cx.test2') | id:'cx.tes' | Not supported | Not supported | Not supported | Not supported | Not supported |
| format | format='string' | format|('string','INTEGER') | format:'int' | Not supported | Not supported | Not supported | Not supported | Not supported_ |
| maxLength | maxLength='1' | Not supported | Not supported | maxLength>'1' | maxLength>='1' | maxLength<'5' | maxLength<='5' | maxLength~('1','5') |
Updated 3 days ago
Did this page help you?
© ICE Mortgage Technology, Inc. All rights reserved.