Encompass TPO Connect Plugins

What are Plugins?

Plugins are extensions to the Encompass and Encompass TPO Connect applications, managed as JavaScript files and hosted in the administration portals for each application. Plugins are automatically launched at the point of sign-in, after a user has been authenticated during the process of logging into each application. As soon as a user logs in, plugins are loaded within an HTML iFrame element for the entire duration of the session. Based on the user’s actions (e.g., opening a loan, saving a loan, etc.), loan-specific events are raised to each plugin, and every plugin is allowed to respond accordingly.

The ICE Scripting Framework allows for two-way communication between the plugin and each application. The Scripting Framework is the mechanism for each application to publish loan-specific events, for plugins to subscribe and respond to these events, and for each application to take the feedback and perform necessary action.

Process Overview

The overall process for implementing a plugin in Encompass TPO Connect involves the following high-level tasks.

1. Develop the plugin - The client developer creates the plugin.
2. Upload the plugin - The Encompass TPO Connect administrator uploads the plugin to the Encompass TPO Connect Admin Portal.
3. Manage the plugin - The Encompass TPO Connect administrator manages the plugin from the Encompass TPO Connect Admin Portal.

Managing Plugins in Encompass TPO Connect Admin Portal

The Encompass TPO Connect Admin Portal allows you to upload a new plugin, delete an existing plugin, edit an existing plugin description, or export a list of all plugins to a CSV file.

To manage your plugins, log in to the Encompass TPO Connect Admin Portal, and navigate to “Plugins” page.

To Upload a Plugin:

1. From the Plugins page, select Upload.
2. Select Browse to browse to and select the plugin (JavaScript file), or drag and drop the plugin to the file drop area.
   The file is uploaded to the Plugins page.

To Delete a Plugin:

1. From the Plugins page, select the plugin you wish to delete.
2. Click the Edit icon at the end of the row.
3. Select the Delete icon.

To make a Plugin Active/Inactive:

1. From the Plugins page, select the plugin you wish to make active or inactive.
2. Click the Edit icon at the end of the row
3. Select the Active icon to toggle the active status.

To Edit a Plugin’s Description:

1. From the Plugins page, in the Description column, place your pointer over the description of the plugin.
2. Select the Edit icon, and then enter a new description.
3. Press the Enter key or click away from the description to save your changes.

To Export a List of All Plugins to CSV:

1. From the Plugins page, select Export to CSV.
2. When asked to save the CSV file, select Yes.
   The CSV file is downloaded to your local hard drive.

Plugin Support in Encompass TPO Connect

The following Encompass TPO Connect methods, objects and events are plugin-supported: