Upgrading the Encompass SDK

For an Encompass major release (or other applicable Service Pack or Critical Patch releases), the Encompass SDK (Encompass Software Development Kit) run time environment must be upgraded to match the newly updated Encompass Server. If your SDK application utilizes the Encompass SmartClient, you can automate this process so the SDK is upgraded every time you apply a major Encompass release. If your SDK application is installed directly on a computer at your location, you must manually upgrade the SDK for every major release (or other applicable Service Pack or Critical Patch release).

Encompass Versioning

Because Encompass is a client-server application, the software enforces a strict versioning policy to ensure the client and server are version-compatible when a connection is made between them.

The versioning policy is very simple. The Encompass software versions running on the client and server must match exactly for the connection to be permitted. Thus, a server running version 16.3 of Encompass, for example, will only permit connections from clients running version 16.3 of Encompass or running on top of version 16.3 of the EncompassObjects API.

When a new version of Encompass is released, the Encompass Server is the first component upgraded by Ellie Mae. When a user logs into the Encompass Server using the Encompass SmartClient, the version update is detected and the SmartClient automatically streams the required changes to the user’s computer.

If your application follows the guidelines set forth in the SDK Programmer's Guide, your custom application can also leverage the auto-updating capabilities of the Encompass SmartClient. Your application will be “SmartClient-enabled” if the following three conditions are met:

• You have initialized the API Runtime Services in your application prior to using or referencing the EncompassObjects assembly. (Read the SDK Programmer's Guide, (Section 3 - Getting Started) for details.)
• You do not have the EncompassObjects assembly or any of its dependencies in the .NET probing path for your application. This includes your application’s bin folder as well as the GAC.
• You do not have the Encompass SDK installed on the computer.

If you have satisfied these three requirements, the Encompass API Runtime Services will handle ensuring that your software is using the correct component versions based on the Encompass Server version. Conversely, if you fail to meet any one of these three requirements, then you will be required to manually upgrade the computer with the correct Encompass components whenever a server version upgrade occurs.