Setting up your Sandbox

Interactive Ordering

Setting up your sandbox environment is a multi-step process, and may involve multiple Ellie Mae products, including Encompass SmartClient ("Classic" Encompass), Encompass Loan Officer Connect, and Encompass Consumer Connect. The steps to configure your sandbox environment are as follows:

  • Receiving Encompass admin credentials
    Encompass credentials can be obtained after the EPC agreement is in place, by contacting your Ellie Mae Partner account executive.

  • Downloading and installing the Encompass Desktop client
    You can download the desktop client from this location. If you don't know how to configure it, refer to this guide for help.

  • Logging in as an administrator:
    Once you are logged in as an administrator, you need to:

  1. Provision test users via the Company/User settings. Users are added by navigating to "Encompass Setting" and selecting "Company/User Setup" > "Organization/Users." Click the green "+" icon to add additional users.
Click the green "+" icon to add usersClick the green "+" icon to add users

Click the green "+" icon to add users

  1. Set the appropriate Document Access rules for the admin user. These are persona based, and can be set under the "eFolder" tab.
Document access in Encompass is controlled by the persona, and can be managed on the "eFolder" tab.Document access in Encompass is controlled by the persona, and can be managed on the "eFolder" tab.

Document access in Encompass is controlled by the persona, and can be managed on the "eFolder" tab.

  1. Enable access to Encompass Loan Officer Connect as needed. This is also persona based.
Select the lower option button to grant a persona access to Encompass Loan Officer Connect.Select the lower option button to grant a persona access to Encompass Loan Officer Connect.

Select the lower option button to grant a persona access to Encompass Loan Officer Connect.

  1. Enable access to Encompass Consumer Connect as needed. There are two places in Encompass Settings that control access to Consumer Connect:
  • At the organization or user level, individual orgs (organizations) and/or users must be granted access to a specific Consumer Connect website. This is done on the org/user edit screen. Note that orgs and users may be assigned to the Consumer Connect website directly, or may inherit this setting from a parent organization. See the below screenshot for reference.
See Encompass Setting Help  (<F1> from this page) for additional detailsSee Encompass Setting Help  (<F1> from this page) for additional details

See Encompass Setting Help ( from this page) for additional details

  • At the persona level, there are additional settings to manage access to Consumer Connect admin features:

    • WebAdmin grants administrator access to the persona. Permissions include full access to the administration portal and website-builder features and functions.

    • WebContent grants partial access to the persona. Permissions include access to the website builder and access to the Manage Sites page of the administration portal. Users cannot create or delete websites or access other pages in the administration portal.

See Encompass Setting Help  (<F1> from this page) for additional detailsSee Encompass Setting Help  (<F1> from this page) for additional details

See Encompass Setting Help ( from this page) for additional details

  1. Disable MFA for your sandbox Loan Officer Connect. During development, you might need to disable MFA for your sandbox Loan Officer Connect if it doesn't contain sensitive data to speed up testing efforts. Please follow the process described in Disabling Ping ID MFA for your Sandbox to disable MFA for your sandbox environment.

  2. Provision your integration in Ellie Mae products

  • Using Encompass Loan Officer Services Management Setups
    To expose your integration product in the Encompass Loan Officer Connect and Smart Client, your product must be configured in the Services Management admin section. The steps to do this are described in the Launching the Application. Please note that listing your integration in Loan Officer Connect also exposes it in Encompass Smart Client, and additional configurations in Smart Client will be required.

Automated Service Ordering/1-Click Ordering

Once the manual-ordering sandbox setup is completed, the product can be extended to support Automated and 1-Click Ordering. To set up the sandbox, follow the below steps:

  1. Add support for Automated and 1-Click Ordering
    In your product configuration, add automated under the workflows attribute. For more information, please see Product Configuration.
"tags": {
            "workflows": [
                "automated",
                "interactive"
            ],
            .
            .
        },
  1. Register the adminInterfaceUrl
    Add the URL for the pre-configured order options interface to your product configuration by following the process described in Product Configuration.
"adminInterfaceUrl": "{{product_admin_interface_url}}",
  1. Turn on the automated service ordering flag for the Encompass Instance being used as Sandbox. You'll need to contact EPC support because there is no public interface for accomplishing this as of now.

  2. Create service setup on Loan Officer Connect (LOC) by following the steps below:
    i ) Log into LOC as admin.
    ii) Go to "Service Management".

Loan Officer Connect - Service ManagementLoan Officer Connect - Service Management

Loan Officer Connect - Service Management

iii) Create a new service setup by going to the category under which that product was listed, then click the "Add" button:

Add a new service setup on the Service Management PageAdd a new service setup on the Service Management Page

Add a new service setup on the Service Management Page

iv) This takes you to the service setup screen. Here you can specify the service name and automated readiness conditions (the set of loan conditions that will trigger the automation).
v) After providing the necessary information, click the "Add" button under Options to specify the parameters that will be included as part of the transaction.

Add product pre-configured options for a service setupAdd product pre-configured options for a service setup

Add product pre-configured options for a service setup

vi) Clicking the "Add" button brings up the pre-configured order options interface listed in the adminInterfaceUrl under the product configuration:

Example of a pre-configured options screenExample of a pre-configured options screen

Example of a pre-configured options screen

  1. Test the setup
    Login as a regular LOC user and make the necessary updates to meet the conditions defined above, then save the loan.
  • For 1-click Ordering, go to the Services Landing Page for the option to order the service
  • For Automated Ordering:
    i) Loan Officer Connect: Wait 15 minutes after the initial loan save
    ii) Encompass Smart Client: Exit the loan and wait 15 minutes
    iii) Watch for the Webhook listener endpoint on your end to receive the transaction Webhook. That indicates a successful Automated Ordering setup.

Did this page help you?