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.

2 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 .. 4 Section 3: Getting Started.. 6 Writing Standalone Application Using EncompassObjects.. 6 Deploying an EncompassObjects Application.

3 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.

4 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.. 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.

5 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.

6 37 Retrieving Appointments .. 37 Modifying and Saving Appointments.. 37 Creating and Deleting Appointments.. 38 Section 8: Managing Users.. 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.

7 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.

8 51 Form Lifetime.. 52 Stage 1: Instantiation .. 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.

9 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 .. 61 Cause and Resolution .. 61 Problem 8.

10 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?