Purpose:

Provide Partner applications with a mechanism to uniquely identify the host application they are embedded within, primarily for logging, troubleshooting, or analytics.

Sample Usage:

async function setApplicationDescriptor() {
  try {
    const applicationObject = await elli.script.getObject('application')
    const applicationDescriptor = applicationObject.getDescriptor()

    applicationState.hostApplicationId = applicationDescriptor.id
  } catch (error) {
    console.log({error})
  }
}

setApplicationDescriptor()
elli.script.getObject('application')
  .then(
    (applicationObject) => {
      const applicationDescriptor = applicationObject.getDescriptor()

      applicationState.hostApplicationId = applicationDescriptor.id
    }
  )
  .catch(
    (error) => {
      console.log({error})
    }
  )

Interface:

Input:

None

Returns:

Type: Object

Object containing a unique id and name attribute for each host Encompass application

{
  id: "<HOST_APP_ID>",
  name: "<HOST_APP_NAME>"
}

Encompass Application

ID

Name

`Encompass Desktop`

ENC

ENC

`Encompass Web`/`Loan Officer Connect`

ENCW

ENCW

`Encompass Web Admin`

ENCW-ADMIN

ENCW-ADMIN

`Consumer Connect`

ECC

ECC

`TPO Connect`

TPOC

TPOC