Guide Table of Contents

Overview

Create a Baseline Data Dictionary using Schema APIs

Update Data Dictionary with Changes to the Encompass Loan Schema

The Encompass Loan Schema is updated with every major Encompass release to add new fields and to modify existing fields in keeping with industry and regulatory requirements. If you wish to fetch the loan data from any of the newly added fields in the Loan Schema, you will need to add those fields to your data dictionary.

Use the following resources to identify the new fields added to the Loan Schema for a given release:
(Note: For the APIs to use, see the APIs to Fetch Field Metadata section further down this page)

Loan Schema Delta File

The Data Connect team publishes a delta file with the details of the new tables and columns that are added in Data Connect for the given release. This delta file includes a FieldId which can be used in the V3 Get Field Schema API to see the field definition including a JSON path of the given field in the V3 loan schema.

📘
Please note, this delta file is exclusive to standard fields added in Encompass. If you have added custom fields in your Encompass instance, you need to maintain a delta file for any custom fields added after the creation of the baseline data dictionary.

The delta file is published with every encompass major release. Here are instructions for retrieving this file.

Click here and select the release version for which you want to see the delta file.
Select Updates & Enhancements.
Expand the Update to Schema section.
Locate the Field Updates Comparison Files section. The Field Updates Comparison Files are provided in both MS SQL and Posgres formats.

📘
This delta file is available for Encompass customers with access to the Resource Center. Access to this resource is not currently available for Encompass Partners.

Custom Diff Schema File

If you choose to forego the option of working with the Loan Schema Delta File, you can generate a diff using the V3 Loan Schema and V3 Field Schema payload.

Using a 3rd party API-diff tool, compare the JSON Loan Schema for the current and prior version to generate a list of new and updated fields.

The diff for the V3 Loan Schema API will include all standard and custom fields.

Encompass Field Lookup Tool

Now that you know which standard fields have been added or modified, you can use the Encompass Field Lookup Tool in the Resource Center to search for the new or updated standard field to locate the Field ID using a keyword description.

📘
You will need to login to the Resource Center using your Encompass credentials to access the Field Lookup Tool.

APIs to Fetch Field Metadata

Use the following APIs to fetch the field metadata including the JSON path to enrich your data dictionary:

New Standard Fields

Call the V3 Get Field Schema API using the fieldId query parameter to retrieve the metadata including the JSON path for the newly added standard field.
Add the new field to your data dictionary.

curl --location 'https://{{API_SERVER}}/encompass/v3/schemas/loan/standardFields?
start=0&limit=10000&ids=4000' \ 
--header 'Authorization: Bearer {{ACCESS_TOKEN}}'

[ 
    { 
      "id": "4000", 
      "description": "Borrower First Name", 
      "format": "STRING", 
      "readOnly": false, 
      "nullable": true, 
      "category": "Borrower", 
      "dataType": "String", 
      "maxLength": 0, 
      "multiInstance": false, 
      "contractPath": "loan.currentApplication.borrower.firstName", 
      "jsonPath": "$.applications[0].borrower.firstName", 
      "entitiesFilterKey": "borrower" 
    } 
]

New Custom Fields

Call the V3 Get Custom Fields API using the fieldId query parameter to retrieve the metadata including the JSON path for the newly added custom field.
Add the new field to your data dictionary.

curl --request GET \ 
     --url 'https://{{API_SERVER}}/encompass/v3/settings/loan/customFields?
     ids=CUST01FV' \ 
     --header 'Authorization: Bearer{{ACCESS_TOKEN}}'

[ 
    { 
        "id": "CUST01FV", 
        "format": "NONE", 
        "maxLength": 0, 
        "contractPath": "loan.customFields[(fieldName == 'CUST01FV')].value", 
        "jsonPath": "$.customFields[?(@.fieldName == 'CUST01FV')].value", 
        "isCalculatedField": false 
    } 
]