Encompass Data Connect Hosted - Frequently Asked Questions (FAQs)
With Encompass Data Connect, you can quickly access large amounts of near-real time loan data that's stored in the cloud, thus enabling you to leverage your existing technology to build your own intelligence on top.
These are the answers to Encompass Data Connect's most frequently asked questions.
Getting started
What is Encompass Data Connect Hosted?
Encompass Data Connect Hosted utilizes cloud infrastructure to give Encompass users low latency access to all their loan data via a customer-specific and securely isolated Snowflake account.
Since the loan data is available on a top-of-the-line analytical data store, this allows our customers to realize some of the most common use cases:
-
Direct access to data with no extra replication
-
Create custom views
-
Data sharing
-
Run analytical queries on loan dataset
-
Operational business intelligence using hosted analytics
-
Offloading reporting activity to a separate server
-
Offloading query and/or analytics activity to a separate server
What is the provisioning request process?
To host your Encompass instance on Encompass Data Connect, contact your account representative to initiate a provisioning request.
The provisioning process takes up to one week to complete and is as follows:
-
Provisioning Request - Two to four days after your account representative initiates a provisioning request, ICE Mortgage Technology will send a welcome email to the address you provided during initiation. This Welcome email contains a link to the Encompass Data Connect website.
-
Log into Encompass Data Connect - Click the link in your Welcome email to log in to Encompass Data Connect. From the log in screen, enter the Instance ID (i.e., the ID of your Encompass instance), your Encompass user ID, and your Encompass password.
- The Instance ID is your Encompass SmartClient ID, which is provided by your Encompass administrator. (It is not the Client ID found under Help > About Encompass in Encompass). Example SmartClient ID: BE111XXXXX.
In order to access Encompass Data Connect, you must have permission to log in to Encompass with the admin user ID, or be assigned the Super Administrator or Administrator persona
In the Provisioning Request Form, enter the following:
-
Email – Email address to which the provisioning statuses are emailed. Use commas to separate multiple email addresses.
-
Database User Name - Your desired Snowflake account user name to connect to the database
-
Database Password - Your desired Snowflake account password to connect to the database. This password must be a minimum of 12 characters with at least one lowercase and uppercase character, one number, and one of these characters: #, !, &, or %.
-
IP Address Range - The IP address range allowed to access the Encompass Data Connect Hosted instance. Use commas to separate multiple IP addresses. Use the subnet mask of "/32" for an individual IP address.
-
Data Sharing – This information is intended for Encompass Data Connect Hosted clients who already have their own company Snowflake account or clients who are in active discussions with Snowflake to spin up their own Snowflake account. If there are no Snowflake account details to provide, skip this section, and then click the Submit button to submit the Provisioning Request Form for provisioning.
-
Cloud Provider – AWS is the only supported Cloud provider for Encompass Data Connect Hosted 20.2. If your Snowflake account details are outside of the AWS Cloud provider, skip this section, and then click the Submit button to submit the Provisioning Request Form for provisioning.
-
Snowflake Region – If your Snowflake Cloud provider is AWS, then select your company’s Snowflake Region from the drop-down list.
-
On/Off Toggle – Snowflake clients can share their Hosted Views to their Company’s Snowflake account. Click the toggler to select On to enable data sharing upon provisioning.
-
Snowflake Account Name – If the Data Sharing check box has been selected, the Snowflake Account Name field will be enabled. In order to deploy the data share to your Snowflake account, provide the Snowflake Account Name here. If Data Sharing has not been enabled, then the Snowflake Account Name field will remain disabled and it will not be required for provisioning.
-
Connection Details - After receiving your completed Provisioning Request Form, ICE Mortgage Technology will create an Encompass Data Connect Hosted instance. It can take up to seven days to complete creation. Once complete, ICE Mortgage Technology will email you the connection details for your Encompass Data Connect Hosted instance including DB server URL, Database Name and Schema.
What are the best practices to use Encompass Data Connect Schema effectively?
A guide detailing the best practices to use Encompass Data Connect Hosted Schema can be found here Encompass Data Connect Hosted - Schema Best Practices.
Getting connected
How do I connect to Encompass Data Connect Hosted? Where can I find connection details?
After receiving the Provisioning Request Form, ICE Mortgage Technology will create an Encompass Data Connect Hosted environment. It can take up to seven days for the creation to complete. Once complete, ICE Mortgage Technology will email you the following connection details for your Encompass Data Connect Hosted environment:
-
Customer ID: Encompass Client ID
-
Instance ID: The ID of your Encompass instance. The Instance ID is your Encompass SmartClient ID, which is provided by your Encompass administrator. (It is not the Client ID found under Help > About Encompass in Encompass). Example SmartClient ID: BE111XXXXX.
-
Endpoint: Database endpoint
-
DB Engine: Snowflake
-
Warehouse: Name of your warehouse
-
DB Name: Name of your database
-
Schema: Name of Schema of database
-
Role: Role of the user added during provisioning of your instance
Using the provided information, you can use BI reporting tools (Tableau, Power BI, etc) to connect to your Snowflake Account and view their records. You can also use SQL Workbench/J by following the steps provided here or Oracle SQL Developer Data Modeler (SDDM) by following the steps provide here.
For details, view the Connecting to Encompass Data Connect Hosted guide.
How do I get Encompass Data Connect for additional Encompass instances?
Each Encompass Data Connect Hosted instance can only host a single Encompass instance. To host additional Encompass instances on additional Encompass Data Connect Hosted instances, contact your account manager to initiate a new provisioning request.
How can I have more than one user access Encompass Data Connect?
Encompass Data Connect Hosted allows one user assigned with the View role during the provisioning process. Users may be assigned the View or View Author role through the User Management tab on the Data Connect portal.
-
View role – This is the default role assigned to users during provisioning. This role has read-only access to schemas.
-
View Author role - This role has author privileges in the Custom View schema, where the user can define custom views.
To Add a New User:
Go to the Administration Settings screen, click the User Management tab, and then click the Add new user button. Enter a user ID for the user (must contain two or more characters, may include alphanumeric characters, but must start with an alpha character), assign the View or View Author role, and then indicate the user’s password (must meet the on-screen requirements displayed for this field).
To Update the User’s Role:
To change the user’s role, click the User Roles drop-down list for the user, and then select the role to assign to the user. When you are changing the user's role from View Author to View, any BI integrations created by this user will no longer work if you change this user’s role to View. Those integrations may need to be reestablished by the same user or a new user if you want to continue using them.
To Delete a User’s Role:
To delete a user, click the Delete icon (trash can) for the user you want to delete.
What if I lose or want to change my database password?
To request a password reset, contact ICE Mortgage Technology Technical Support. An email notification will be sent with the new password.
How do I enable access to Encompass Data Connect from additional IP addresses or ranges?
During your provisioning request, you can enable access by identifying up to 40 individual IP addresses or ranges. To add more later, go to the IP Management tab under Administration Settings on Data Connect portal. You can add new IP addresses and delete ones that are not needed. At all times at least one IP address must be whitelisted.
Database
Do you have example queries to explore loan data?
use role {YOUR_ENCOMPASS_INSTANCE_ID}_VIEW_ROLE;
-- ex: use role debe11170913_VIEW_ROLE;
use warehouse {YOUR_ENCOMPASS_INSTANCE_ID}_READ_WAREHOUSE;
-- ex: use warehouse debe11170913_READ_WAREHOUSE;
use database {YOUR_ENCOMPASS_INSTANCE_ID}_DB;
-- ex: use database debe11170913_DB;
use schema VIEW_SCHEMA;
select count(*) from loan;
select loan_id, loan_number, modified_utc from loan where loan_number='xxxxxxx';
Can I have virtual fields?
Yes, Encompass Data Connect Hosted provides both custom and virtual fields via the two views called: customfield and virtualfields.
Can I create my own database objects?
Users assigned with the View Author role can create custom views in the Custom View schema. The standard views are read-only.
Can I create Custom views?
Yes. To create Custom views (non-materialized views only), make sure the user is assigned with the View Author role. These View Author users can create, update, or delete views in the Custom View schema only. The Custom View schema is available in your database. Both View users and View Author users can query custom views.
How can I add historical data to my Encompass Data Connect instance?
Once provisioned, Encompass Data Connect Hosted adds three years of historical data. If you would like to access additional historical data, contact ICE Mortgage Technology Technical Support with the exact dates.
In contrast with Encompass Data Connect Standard/Lite, you should not expect noticeable degradation of performance while loading historical data.
Where can I view schema and table descriptions?
The schema file can be downloaded from the following knowledge base article in the Resource Center: Encompass Data Connect Help & Documentation.
How do I replicate data on Encompass Data Connect Hosted?
Encompass Data Connect Hosted is designed to allow you to run analytical queries on large datasets directly in the database. Data replication is discouraged.
Can I create reports or connect Encompass Data Connect with reporting tools?
Yes. Encompass Data Connect Hosted powered by Snowflake, supports a long list of compatible BI tools. You can connect directly your preferred BI tool to your DB environment and generate reports and dashboards.
How can I connect to Encompass Data Connect Hosted programmatically?
The Encompass Data Connect Hosted is powered by Snowflake, which supports an extensive list of connectors and drivers.
How often is data updated in Encompass Data Connect?
Loan changes are batched and uploaded into your Encompass Data Connect Hosted instance several times throughout the day.
Where can I view Encompass Data Connect ER diagram?
Encompass Data Connect tables have no relationships maintained at the database level, which means there are no integrity constraints associated between the tables. We do not produce ER Data Model as there are no relationships to show. The customer can refer to HTML Schema File to view different tables, or the PDF to understand relationships.
What is Data Sharing?
Data Sharing enables ICE Mortgage Technology to share loan data through secure views with Data Connect Hosted clients who have their own Snowflake account. With this data share, clients can query Data Connect Hosted data, along with their own data sources, within their own Snowflake account. ICE Mortgage Technology offers our mutual Snowflake clients utilizing the AWS cloud provider with the ability to receive the Data Connect Hosted data share in their Snowflake environment.
To learn more about Data Sharing and to determine eligibility, please refer to the Encompass Data Connect Hosted Data Sharing user guide.
Data fields
How can I know which fields are Personally Identifiable Information and encrypted?
Loan data is encrypted at all times, while in transit, and at rest. The first release of Encompass Data Connect Hosted does not have any special treatment for PII fields. Subsequent releases, will support PII level encryption with customer provided public key.
Where can I find Encompass custom fields in Encompass Data Connect?
Encompass Data Connect saves all custom fields in a table called "customfields". The "customfields" table is related to the loan table by the loan number (there can be multiple per loan table).
Are there primary keys in each table?
There is a unique field "encompassid" in all tables which uniquely identifies each Loan.
How can I use the “customfields” table to query and access data from custom fields?
Custom fields are stored in the table "customfields". Each field is stored as values in a row. To query values in "customfield", the table must be filtered by that custom field and loan_number.
Example: "California_id" is a custom field of type "String".
To get value of this custom field, the query can be:
select string_value from customfield where custom_field_id = ‘California_id' where loan_number="SMPLLOAN123";
How can I decrypt encrypted data fields in Encompass Data Connect?
There is no support of encrypted data fields in the first release.
Troubleshooting
Why can't I access Encompass Data Connect?
Ensure the following:
- Your IP Address matches one of the IP addresses listed on the IP Management screen provided on the Administration Settings tab.
- The network administrator for your organization has opened the firewall to traffic on ports 443 and 80 as indicated in the following documentation.
If you are still encountering access issues, contact ICE Mortgage Technology Technical Support.
Why isn't my data updating in Encompass Data Connect?
Loan changes are batched and uploaded into your Encompass Data Connect Hosted instance several times throughout the day. At times, due to high volumes or partial failures, delays can occur.
If after 30 minutes the data still hasn't updated, or if you experience frequent delays, contact ICE Mortgage Technology Technical Support.
Why doesn't the Encompass Data Connect data match the Encompass data?
Possible reasons may include logics applied in Encompass (application layer) or synchronization. If it's been over 30 minutes since the update in Encompass and data still does not match, contact ICE Mortgage Technology Technical Support with the loan ID, SQL query, and any other relevant information.
Why does my Loan ModifiedUTC not match DC_Modified?
There are multiple reasons for this, but it does not necessarily mean that your data is not getting synced in near real-time:
Loan folder: Since Loan Folder is the metadata and is not part of the Loan file, Data Connect gets the updates for Loan Folder using a parallel process that is not related to the Loan File. This is like moving a file to a different folder on your computer, which does not update the timestamp on the file but only moves the file. Similarly, when a loan is moved there is no update to the ModifiedUTC but DC_Modified is updated since it is an update in the database, Example: user makes changes to the loan on 11/11/2019, now ModifiedUTC and DC_Modified are same but when user moves it to a new folder on 11/13/2019 the ModifiedUTC remains old value of 11/11/2019 but DC_Modified will get updated to 11/13/2019.
Miscellaneous: At times Encompass will treat certain tasks after a loan has been opened but closed without any changes or save. These could include printing out forms for example. In this case, Data Connect DC_Modified is updated but since the loan hasn’t changed, the Modifiedutc is not updated so you can see a gap of days or weeks or even longer.
Latency: In some cases, the system may be running slowly and have issues. This is usually identified when the latency is considerably long but it usually catches up and impacts all loans, not selectively. If your loans are taking more than an hour, then please check Status Center and if there is no existing issue then contact Technical Support to open a case.
How Does Data Connect Calculate Time Zones?
Data Connect holds data for all Encompass customers in a common infrastructure. When a loan is created in any time zone, it will be converted into UTC.
- Data Connect does not store customer-specific time zones. The same customer may have branches across 50 states and Data Connect does not store a separate time zone for each one.
- Data Connect cannot assign a time zone based on the parent company location.
Data Connect uses PST and UTC only. Customers can convert to the target time zone as needed.
- CreatedUTC is the loan created time in Encompass.
- DCModifiedUTC is every time when this is loan updated in Data Connect.
Why is my query so slow?
The performance of your queries could be affected by multiple factors, please try the following options if possible:
- Reduce the number of joined tables.
- Reduce the qualified dataset, by narrowing a time range, and adding more filtering conditions.
If none of this work, and you still find a particular query taking more time, contact ICE Mortgage Technology Technical Support with the query details.
How do I contact ICE Mortgage Technology Technical Support?
In Data Connect, click Help to be taken to the Resource Center, where you can access Technical Support. (In order to access Technical Support features, you must be a named Support contact.
To Contact Technical Support:
- On the Resource Center Home Page, locate the Support panel, and then expand the New Technical Support Case row.
-
Click Open Web Case to be taken to the Technical Support page.
-
On the Submit a Case form, enter your first name, last name, email address, and phone number.
-
In the Standard Support Case section, select the Encompass Customization Topic Area.
-
Near the bottom of the Topic Area list, use the fields provided to enter details about your case.
-
It is recommended to include "Encompass Data Connect" in the subject.
-
Enter a description, include any attachments, and set a severity.
-
When finished, click the Submit Case button.