SDK Programmer’s Guide - Ellie Mae

1 SDK Programmer s GuideLast Revised: February 6, 2018 Copyright Statement 2018 EllieMae, Inc. Ellie Mae , Encompass , AllRegs , DataTrac , Ellie Mae Network , Mavent , Millennial Tracker , Mortgage Returns , Prospect Manager , Total Quality loan , True CRM , TQL and the Ellie Mae logo are trademarks of Ellie Mae, Inc. or its subsidiaries. All rights reserved. Other company and product names may be trademarks or copyrights of their respective SDK Programmer s GuideRev. 2/6/2018iTable of ContentsSection 1: Technical Overview.. 1 Why an SDK?.. 1 What s Included? .. 1 EncompassObjects API .. 1 EncompassObjects API Reference.. 1 Sample Code.. 1 Encompass SDK Programmer s Guide .. 1 Run-Time Components .. 1 Supported Operations.. 2 EncompassObjects API.. 2 Encompass Automation API (Banker Edition only) .. 3 Sample Code.. 3 Licensing.. 3 Section 2: Installation.. 4 SDK License Keys .. 4 Installation Procedure.

2 4 Section 3: Getting Started.. 6 Writing Standalone Application Using EncompassObjects.. 6 Deploying an EncompassObjects Application.. 8 Connecting to an Encompass Server .. 9 Creating an Encompass Plugin Assembly (Banker Edition only).. 9 Creating a Custom Form Codebase Assembly (Banker Edition only) .. 10 Section 4: Managing Loans .. 12 Retrieving, Saving, and Locking Loans .. 12 Creating and Assigning Loans .. 12 loan Fields .. 13 Field Formats and Descriptors.. 13 Accessing Simple Fields.. 14 Accessing Multi-Valued Fields.. 14 Accessing Borrower Pair-Specific Fields.. 15 Accessing Borrower Pair-Specific, Multi-Valued Fields.. 15 Importing and Exporting Loans.. 15 Fannie Mae Formatted Files.. 15 Accessing the loan Log .. 16 Conversation Log Entries .. 16 Milestone Event Log Entries .. 16 Document Log Entries .. 17 EDM Transactions .. 17 Received Documents.. 17 Attachments.

3 18 loan Templates .. 19 Access Rights .. 20 Roles and loan Associates .. 20iiLock Requests.. 22 loan Servicing.. 23 Batch loan Update.. 24 Section 5: Managing Contacts.. 26 Retrieving, Modifying, and Saving Contacts.. 26 Creating Contacts.. 26 Custom Fields .. 26 Accessing Contact Custom Field Data .. 26 Changing Contact Custom Field Data.. 27 Working with Field Types .. 27 Linking Contacts to Loans .. 27 Section 6: Reports and Queries.. 29 Criterion Classes .. 29 Logical Operations .. 29 Canonical Field Names.. 30 Related loan Contact Queries.. 34 Contact Custom Field Queries .. 34 Reporting Database Canonical Field Names .. 35 Creating Reports .. () Method .. () Method .. 35 Reporting Objects .. 36 Section 7: Calendar and Appointments.. 37 Retrieving Appointments .. 37 Modifying and Saving Appointments.. 37 Creating and Deleting Appointments.. 38 Section 8: Managing Users.

4 39 Managing User Access to Encompass via the SDK .. 39 Managing the Organization Hierarchy.. 39 Personas.. 40 Retrieving, Modifying and Saving Users .. 40 Creating and Deleting Users .. 40 Managing User Groups (Banker Edition only) .. 41 Managing loan Officer Licensing Data .. 41 Managing Third Party Originators.. 41 Section 9: Pipeline and Contact Cursors .. 43 Using the PipelineCursor.. 43 Using the Contact Cursor.. 44 Section 10: Basic Automation (Banker Edition only).. 45 The EncompassApplication Object.. 45 Application Events .. 45 Manipulating the User Interface .. 46 Macros .. 46iiiSection 11: Plugins (Banker Edition only) .. 48 Plugin Architecture .. 48 Using Encompass Data Exchange .. 48 Threading Considerations .. 49 External Dependencies.. 50 Section 12: Custom Input Form Codebase Assemblies (Banker Edition only).. 51 Forms & Controls .. 51 Form Lifetime.. 52 Stage 1: Instantiation.

5 52 Stage 2: Control Generation .. 52 Stage 3: Data Binding.. 52 Stage 4: Load Event.. 53 Stage 5: User Interaction .. 53 Stage 6: Unload Event .. 53 Dynamic Control Creation .. 53 Event Handling.. 54 Custom Data Binding .. 54 Packaging and Redistribution.. 55 Section 13: Error Handling in the API.. 56 Rules Violations .. 56 Systemic Errors .. 56 Section 14: Security in the API.. 57 Section 15: Distributing Applications Built Using the API .. 58 Encompass API Run-Time Licensing .. 58 Encompass Versioning.. 58 Updating Computers with the Encompass SDK Installed .. 59 Appendix A: Troubleshooting the EncompassObjects API .. 60 Problem 1 .. 60 Cause and Resolution .. 60 Problem 2 .. 60 Cause and Resolution .. 60 Problem 3 .. 60 Cause and Resolution .. 60 Problem 4 .. 60 Cause and Resolution .. 60 Problem 5 .. 60 Cause and Resolution .. 61 Problem 6 .. 61 Cause and Resolution .. 61 Problem 7.

6 61 Cause and Resolution .. 61 Problem 8 .. 61 Cause and Resolution .. 61 Problem 9 .. 61ivCause and Resolution .. 61 Problem 10 .. 61 Cause and Resolution .. 61 Problem 11.. 62 Cause and Resolution .. 62 Problem 12 .. 62 Cause and Resolution .. 62 Problem 13 .. 62 Cause and Resolution .. 62 Technical Overview1 Section 1 Technical OverviewWhy an SDK?The Encompass Software Development Kit (SDK) provides your organization the ability to integrate your existing back office applications with your Encompass using the Application Programming Interface (API) included with the SDK, software developers can write custom code to move data between applications, create processes for updating or reporting on your loans, or write their own, stand-alone user s Included?The SDK installation package includes the following APIThe EncompassObjects API consists of .NET assemblies (DLLs) that implement the business objects and their methods.

7 The entire public interface of the API is in a single assembly called When you write applications for use with the EncompassObjects API, it is this assembly against which you API ReferenceThis reference, in the form of a help file named , provides a complete listing of the objects provided by the API as well as their properties and methods. It also includes coding examples to demonstrate how many of the objects are used. You can access the reference from the Encompass SDK program group in the Start menu after you install the CodeLocated in the SDK/Samples folder under the installation root, the sample applications demonstrate how to build an application using the EncompassObjects and EncompassAutomation APIs. The sample code is written in C# and , and demonstrate use of the API in a standalone app, a web-based app, an Encompass plugin, and a custom input form. You will need Visual Studio 2010 or higher to load, compile and run these SDK Programmer s GuideThis document provides an introduction to installing, using, and distributing the ComponentsThe Encompass API is made up of two distinct sets of runtime objects.

8 The EncompassObjects API, which provides for externalapplications to interact with an Encompass system eitherlocally or using a remote Encompass Server. The EncompassAutomation API, which allows forintegration directly in the Encompass client application soyou extend the functionality of Encompass. (BankerEdition only)The EncompassObjects API is a data-layer/client-connectivity API, meaning that it provides the functionality you would need to connect your own custom application to an Encompass Server using the same protocols used by the Encompass client. This API also defines the core data structures that form the basis of the Encompass system, such as the loan and Contact objects. The following diagram depicts a typical run-time environment that uses the EncompassObjects following diagram depicts a typical run-time environment that uses the EncompassObjects this model, the custom application manipulates the basic data types that comprise the Encompass system by interfacing directly with the API.

9 The API in turn communicates with the Encompass Server. The EncompassAutomation API builds on the EncompassObjects API by allowing a developer to manipulate and extend the Encompass Banker Edition user interface. Unlike the EncompassObjects API, code that is written against the EncompassAutomation API runs directly within the Encompass application, either as an Encompass Custom Form Codebase Assembly or an Encompass Custom Client ApplicationEncompassObjects APIE ncompass ServerLoanSQLS erverFiles2 Technical OverviewPlugin Assembly. Both DLL types are loaded by the client at runtime and can respond to different events, both internal and external, to affect the desired APIs are implemented using version of Microsoft s .NET Framework. Although, the EncompassObjects API assembly can be used by projects implemented using later versions of .NET, compatibility with all functions cannot be guaranteed. Moreover, because assemblies that reference the EncompassAutomation API are loaded into and executed directly within the Encompass client application, they must follow much more rigid design and implementation guidelines.

10 For more information on how to get started creating projects using the EncompassObjects and EncompassAutomation APIs, see Section 3, Getting Started on page OperationsThe EncompassObjects API provides support for a wide variety of tasks. These operations include: Opening and modifying existing loans Creating new, empty loans Assigning loans to a loan officer and/or loan processor Importing data from and exporting data to external systems Importing data from and exporting data to Fannie Mae-formatted files using built-in methods performing complex queries against the set of all loans Enumerating the list of defined loan folders Creating new loan folders Opening and modifying existing borrower and business contacts Creating new contacts performing queries against the contacts database that include criteria related to previously completed loansThe API provides access to the full set of data included in a loan file and automatically performs all the calculations necessary for derived fields.