To provide your users with all the features of the Encompass Partner Connect platform, your application's user-interface needs to interact with three primary objects exposed by our JavaScript API:
You only need 1 of each!
The scripting objects exposed by the JavaScript API should ideally be utilized as
singletons- single instances that are shared across your application's components.
Transaction Object
The transaction object provides your applications lender/borrower-facing view (registered as the $.interfaceUrl property in your product configuration) with the necessary handles to model your application's transactional interaction with the EPC platform. It allows you to access an interactive session's origination context, create a new transaction, update an existing transaction, create events/messages for a transaction, and more.
Accessing the transaction object
Object ID: transaction
let transactionObject = await elli.script.getObject('transaction')
Application Object
The application object provides your lender/borrower-facing view (registered as the $.interfaceUrl property in your product configuration) with the necessary handles to discover the host application's capabilities, enabling the user to perform certain actions, and invoke certain features of the host application (such as launching its document viewer).
Accessing the application object
Object ID: application
let applicationObject = await elli.script.getObject('application')
Transaction Template Object
The transactionTemplate object provides your application's administrator-facing view (registered as the $.adminInterfaceUrl property in your product configuration) with the necessary handles for enabling Lender administrators to create transaction request templates, which they can associate with a 1-click/automated ordering business condition set.
Accessing the transactionTemplate object
Object ID: transactionTemplate
let transactionTemplateObject = await elli.script.getObject('transactionTemplate')