This section provides a reference for the different objects exposed to the guest application running within ICE Mortgage Technology applications. Each object described in the following sections includes a list of methods and events exposed by the object. Currently, each method/event is available in the Lender API context for the following integration types:

• Custom Form
• Custom Tool
• Plugin

Unless otherwise noted, each object is a singleton and is exposed using an object identifier that is always lowercase. For example, the application object would be exposed with the object identifier of "application".

📘

Objects are accessed using a lowercase string, and the string is case-sensitive.

Objects are accessed in the guest application using the elli.script.getObject() method, as in the following example for loan object: const loan = await elli.script.getObject("loan");

Summary of Objects/Methods

Summary of Events

👍

An Encompass Web Custom Form Toolbox guide that provides working code examples is also available in the ICE Resource Center. For more information, log in to this resource center and review the following Knowledge Article:

• Resource Center Article Number: 000116670 - Understand Advanced Customization of Encompass Web Forms using JavaScript

Object Details

📘

For additional details, see the individual Objects, Methods and Events listed below.

Application Object

The Application Object (ObjectID = "application") allows for access to application level UI elements, behaviors and events.

Accessibility

The Application Object is accessible from the following scripting contexts:

• Custom Form
• Custom Tool
• Plugin

Events

Methods

The following methods are provided by the Application Object.

Code Examples

{
  "env": {
    "apiHost": "https://api.elliemae.com"
  },
	"route": {
		“url”: “https://encompass.ice.com/pipeline/12345b77-11ac-11c2-ae12-00fdadf8b0fd/custom-tools-tool”,
		“type”: “CUSTOM_TOOL”,
		“name”: “My Pipeline”,
		“id”: “GUID“
	}
}

{
	“url”: “https://encompass.ice.com/pipeline/12345b77-11ac-11c2-ae12-00fdadf8b0fd/custom-tools-tool”,
	“type”: “GLOBAL_CUSTOM_TOOL”,
	“name”: “East Side Pipeline”,
	“id”: “ <GUID> “
} {
	“url”: “https://encompass.ice.com/pipeline/12345b77-11ac-11c2-ae12-00fdadf8b0fd/custom-tools-form”,
	“type”: “CUSTOM_FORM”,
	“name”: “My IFB Custom Form”,
	“id”: “04ae03f8-f63d-4019-8f65-94920e28712a“
}
{
	“route”: {
		“url”: “https://encompass.ice.com/pipeline/12345b77-11ac-11c2-ae12-00fdadf8b0fd/custom-tools-tool”,
		“type”: “CUSTOM_TOOL”,
		“name”: “My Pipeline”,
		“id”: “GUID“
	}
{
	“url”: “https://encompass.ice.com/pipeline/12345b77-11ac-11c2-ae12-00fdadf8b0fd/custom-tools-standardform”,
	“type”: “STANDARD_FORM”,
	“name”: “My IFB Standard Form1 ",“
	id”: “64326cca-ccc9-4e30-9510-c944840401ef“
} {
	“url”: “https://encompass.ice.com/pipeline/12345b77-11ac-11c2-ae12-00fdadf8b0fd/custom-tools-form”,
	“type”: “STANDARD_FORM "“
	name”: “LO Standard Form”,
	“id”: null
} {
	“url”: “https://encompass.ice.com/pipeline/03409b76-22ac-44c2-ae12-99fdadf8b1fd/standard-forms/64326ccaccc9-4e30-9510-c944840401ef”,
	“type”: “STANDARD_TOOL”,
	“name”: “COR PURCHASE ADVICELO Standard Form”,
	“id”: <GUID>
} {
	“url”: “https://encompass.ice.com/pipeline”,
	“type”: “OTHER”,
	“name”: null,
	“id”: null
}

{
   "id":"<app_id>",
   "name":"<app_name>"
}

{
  "target": "Borrower Summary Origination", 
    // Name of form as it appears in left navigation
  "type": "STANDARD_FORM",
  "context": {
  	"loanId": "c73a2639-225d-4720-97aa-5bcf834fd9a7"
  }
}

//Types
STANDARD_FORM // All standard Forms (LO & Web IFB)
STANDARD_TOOL // All standard tool (LO & Web IFB)
CUSTOM_FORM // Web IFB Custom Form
CUSTOM_TOOL
GLOBAL_CUSTOM_TOOL 
OTHER // All other routes e.g.
pipeline/opportunities (global) and services/documents/conditions (loan)
Navigate to different form/tool from within same loan

{
  "target": "Borrower Information", // Name of form as it appears in left navigation
  "type": "CUSTOM_FORM",

  // If Loan Id is missing from Context then it navigate to same loan's form/tool
}
Navigate to Global Custom Tool
{
  "target": "Test Global Tool", // Name of form as it appears in left navigation
  "type": "GLOBAL_CUSTOM_TOOL",
  "context": {
  "loanId": "c73a2639-225d-4720-97aa-5bcf834fd9a7"
}
  
}
Navigate to OTHER global routes i.e. Pipeline/Opportunities
{
  "target": "pipeline", // Possible values Pipeline & Opportunities
  "type": "OTHER"
}
Navigate to OTHER loan routes i.e. services, documents & conditions
{
  "target": "services", // Possible values services, documents & conditions
  "type": "OTHER"
}

{
  target: string | {
    entityType: "...",
    entityId: "..."
  },
  type?: "..."
}

{
  target: "..." | | {
    entityType: "...",
    entityId: "..."
  },
  name: "...",
  type?: "...",
  size: 'sm/md/lg',
  // Any context-specific options (example  - 'type' : 'form/tool')
}

const appObj = await elli.script.getObject(‘application’);
const modalOptions = {
  'type': 'form',
  'size': 'md',
  'name': 'Borrower Information',
  'showFooter': true/false,
  'formType': 'CUSTOM_FORM'
};
const modalResp = await appObj.openModal(modalOptions);

const appObj = await elli.script.getObject('application'); 
const modalOptions = {
  'type': 'form',
  'size': 'md',
  'name': 'Fee Itemization',
  'formType': 'STANDARD_FORM'
};
const modalResp = await appObj.openModal(modalOptions);
// name - form name
// size - sm/md/lg/xl - defaults to xl
// formType - STANDARD_FORM

{
  supportedActions: [ "Action1","Action2"],
  supportedFeatures: [ "Feature1","Feature2"]
}

async function btnPrint_click(ctrl) {
  try {
    const data = await fetch('<URL_TO_PDF_OR_JPG_FILE>'); 
    const blob = await data.blob();
    const printOptions = { blob };
    const appObj = await elli.script.getObject('application'); 
    await appObj.print(printOptions);
  } catch (err) {
  	console.log('Error occurred while printing ', err);
  }
}

Auth Object

The Auth object (ObjectID = "auth") provides access to identity and authorization-related functionality.

Accessibility

The Auth Object is accessible from the following scripting contexts:

• Custom Form
• Custom Tool
• Plugin

Methods

The following methods are provided by the Auth Object.

Code Examples

{  
  "access_token": string,  
  "token_type": string,  
  "host_name": string  
}

{
"id": string,
"realm": string,
"firstName": string,
"lastName": string,
"phone": string,
"cellPhone": string,
"personas": [
{
"entityId": string,
"entityType": string,
"entityName": string
},
],
"email": string,
"clientId": string,
"chumId": string,
"employeeId": string,
"nmlsOriginatorId": string,
"isAdmin": boolean,
"instanceId": string
}

const userData = await authObject.getUser();
console.log('Here is your user data from host: ', userData);
const { access_token } = await authObject.getAccessToken();
console.log('Accesstoken from Host:', access_token);

Http Object

The Http object provides APIs to make call-outs to external systems via HTTPS. By exposing this object from the host, it ensures that the call will bear the "Origin" header of the host application (e.g., https://encompass.ice.com). This is critical for situations where the guest's code is running in a strict-mode sandbox (where the "allowSameOrigin" flag is false).

Accessibility

The Http Object is accessible from the following scripting contexts:

• Custom Form
• Custom Tool
• Plugin

Methods

The following methods are provided by the Http Object.

Code Example

async function getNormalizedAddress() {
 const http = await elli.script.getObject("http");
 const resp = await http.post("https://mysite.com/api", {
  addr: "1234 5th Str",
  city: "Pleasanton",
  state: "CA"
 }, "40f2qx8ywn62d");
 console.log('Normalized value is ' + resp.addr);
}

Loan Object

The Loan object provides methods for interacting with an open loan in the application's editor screen(s).

Accessibility

The Loan Object is accessible from the following scripting contexts:

• Custom Form
• Custom Tool
• Plugin

Methods

The following methods are provided by the Loan Object.

Events

Code Examples

// get entire loan object
const responseFromHostWithLoan = await loanObject.all();
console.log('Here is your loan response from host: ', responseFromHostWithLoan);

// To get value of field with fieldId 4002, you would do:
const fieldValue = await loanObject.getField(4002);
console.log('FieldId 4002 has value: ', fieldValue);
await loanObject.setFields(fieldIdMap);

// To set fieldId 4002 to be "Justin", you would do :
const fieldMap = { '4002': 'Justin' };
await loanObject.setFields(fieldMap);

// Check the loan is read only
const isReadOnly = await loanObject.isReadOnly();
console.log('Loan is read only: ', resp);
// trigger calculations
await loanObject.calculate();
// sync the loan workspace with any changes made by other users
await loanObject.merge();

await loanObject.execAction("calculateEEMMortgage");

[{
"op":"merge",
"value":"35000", "contractPath":"loan.fhaVaLoan.energyEfficientMortgageAmount"
},
{
"op":"performAction","value":"calculateEEMMortgage"
}]

Script Object

The Script object (elli.script) is the root object exposed by the Scripting Framework guest system and is available as a global in the guest application context.

Accessibility

The Script Object is accessible from the following scripting contexts:

• Custom Form
• Custom Tool
• Plugin

Methods

The following methods are provided by the Script Object.

Service Object

The Service object enables you to work with service orders, such as launching a service order integration etc. The object enables applications to place service orders, independent of SLP (Service Landing Page) application. Errors returned by the service order integration are returned to the caller of this scripting object method.

Accessibility

The Session Object is accessible from the following scripting contexts:

• Custom Form
• Plugin

Methods

The following methods are provided by the Service Object.

Notes

Keep the following in mind regarding the launchBy... methods listed above:

• Commit all unsaved loan changes using loan.commit, before calling the launchBy... methods.
• The launchBy... methods will unload the current microapp and navigate to the service order integration.
• After the integration flow is complete, the user will be redirected to the location provided in the input parameter.
• Service order transaction id (transactionId) and service order id (orderId) will be appended as query parameters to the url in case of new order. For example, if redirect requested to services area, the url will have query string as services?query={'transactionId':123, 'orderId':456}

Session Object

The Session object provides session-level state storage for a guest application. Each guest's state is isolated from all others based on a unique identifier for the guest (e.g., an extension ID or Form ID). This object is provided in contexts where sandboxing will not allow the guest app to access the sessionStorage of the browser.

Accessibility

The Session Object is accessible from the following scripting contexts:

• Custom Form
• Plugin

Methods

The following methods are provided by the Session Object.

Notes

• Each valueObj, when stringified, cannot exceed 5 KB.
• An individual guest is limited to 5 session values.

Guests that require persistent storage will need to implement an external (service-based) mechanism for this.

Global Object

The Global object allows for data to be shared between custom forms/tools/plugins within a user's session. Unlike the Session object, where data is isolated to be visible/accessible only by the form/plugin that writes the variables, values written to the Global store are visible to all such customizations.

Accessibility

The Global Object is accessible from the following scripting contexts:

• Custom Form
• Custom Tool
• Plugins

Methods

The following methods are provided by the Global Object.

Notes

This object writes the global state data to the host application's sessionStore and ensures that the state is isolated away from the host application's state variables. The key must be unique across all applications.

In order to ensure that guest applications cannot consume significant amounts of sessionStorage, the following restrictions are placed on the number and size of the stored data:

• Each value when stringified, cannot exceed 5 KB.
• Total global state should be limited to 50 values.

Debugging via Browser Tools

The following online tutorial is available for understanding how to use Chrome’s DevTools:
• Get Started with Debugging JavaScript in Chrome DevTools