Version Manager
Use the Version Manager tool in Encompass Admin Tools to manage how and when Encompass updates are applied to your Encompass Server. Here you can specify the amount of time before the update will start, and send an announcement to all currently logged in users to notify them of the update before it starts.
If your company uses hosted server software with the Encompass SmartClient software running on local computers, refer to Version Manager for Smart Client.
Update Types
There are two kinds of Encompass server updates- installing a major upgrade or installing a server update:
- Major upgrade: Major upgrades (for example, upgrading to Encompass 16.1) introduce significant new features and enhancements. Your current version of Encompass is completely uninstalled, and then the new upgraded version of Encompass is downloaded and applied to your Encompass server. Your users’ computers are upgraded when they log in to the newly updated Encompass server.
- Server update: Server updates (for example, updating to Encompass 16.1.x) are small updates that do not require a completely new installation of Encompass. Instead, a group of new or updated files is copied to the Encompass server. Your users’ computers are upgraded when they log in to the newly updated Encompass server.
- Hot update: Hot updates (for example, updating to Encompass 16.1.x.x) are smaller updates that do not require a completely new installation of Encompass. Instead, a group of new or updated files is copied to the client computers running the Encompass SmartClient application install on your end users' computers. Hot updates can be set to install automatically or manually.
To Install Major Upgrades:
- Access the server that is running the Encompass application.
- On your Windows task bar, click the Start menu or Start icon, navigate to the Ellie Mae Encompass program folder, and then click Admin Tools.
- Double-click Version Manager.
- If you are prompted
to log in to the server, type the User ID, Password, and Server that you
use to log in to Encompass as the admin user.
- If an upgrade is listed in the Major Upgrade Management section (on the Server Major Updates tab), click Release Notes to review the features and enhancements.
Notify your users about the major upgrade.
Before the server upgrade begins, all client users must be logged out of Encompass. The upgrade program will do this automatically, but any unsaved data will be lost. It is advisable to notify your users well in advance of beginning the upgrade, so they have time to save their data and log out of Encompass.
Encompass provides tools to notify users of impending upgrades, log users out of Encompass, and prevent users from logging in during upgrades. Some recommendations are provided below. For more information about these tools, refer to the Encompass online help.
- Notice to All Users - Use the All User Information tool to send an email to all Encompass users in advance of the scheduled upgrade. (From the Encompass Settings screen, select System Administration and then All User Information).
- Disable Logins – Before starting the upgrade, use the Current Logins tool to stop users from logging in. (From the Encompass Settings screen, select System Administration and then Current Logins).
- Notice to Logged In Users – Use the Current Logins tool to send an email or broadcast message to logged-in users just prior to starting the upgrade. Instruct users to save their work and log out of Encompass.
- Log Users Out of Encompass – Before starting the upgrade, use the Current Logins tool to log any remaining users out of Encompass. Each user receives a message informing them that they have been logged out.
- Click Upgrade Now to begin the upgrade.
- The Encompass Download Manager window displays the progress of the download.
- When a message asks you to stop the Encompass Server service and log off all users to complete the update, click Yes.
- When the download is complete, click OK to close the Admin Tools and continue the installation.
- The Encompass Update Wizard opens. Close all Windows applications and click Next.
- Follow the on-screen instructions in the Update Wizard to complete the installation. Refer to the Upgrading Encompass document for additional instructions.
To Install Server Updates:
- Access the server that is running the Encompass application.
- On your Windows task bar, click the Start menu or Start icon, navigate to the Ellie Mae Encompass program folder, and then click Admin Tools.
- Double-click Version Manager.
- If you are prompted
to log in to the server, type the User ID, Password, and Server that you
use to log in to Encompass as the admin user.
- If an update is listed in the Server Update Management section (on the Server Major Updates tab) , click to select it.
- Click Install Updates.
- On the Version Management Notification window, enter the number of minutes and seconds before the server update will start.
- Enter the announcement to display to all logged in users to notify them of the update.
- Click Install Updates.
- A message window displaying your announcement displays to all logged in Encompass users.
- When it is time for the install to start (based on the start time you set), Encompass waits 30 additional seconds and then automatically logs out all users.
- Once all users are logged out, the update starts. All users are locked out of Encompass until the update is complete and the server is restarted.
To Install Hot Updates:
- Access each of the end user computers where the Encompass SmartClient application is installed.
- On the Windows task bar, click the Start menu or Start icon, navigate to the Ellie Mae Encompass program folder, and then click Admin Tools.
- Double-click Version Manager.
- If you are prompted to log in to the server, type the User ID, Password, and Server that you use to log in to Encompass as the admin user.
- In the Hot Update Management section:
- If the option to apply all updates automatically is selected, you do not need to take any action. All current and future updates will be applied automatically.
- If the option to manually approve and apply updates is selected, select a hot update from the list, and then click Approve.
See Also
System Requirements for Encompass