Loan
Methods
| Method | Encompass | Encompass Web | TPO | Consumer Connect | Notes |
|---|---|---|---|---|---|
| all | ✖️ | ✔ | ✖️ | ✖️ | |
| applyLock | ✖️ | ✔ | ✖️ | ✖️ | |
| calculate | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -<br /> PUI scripting object return type -> void <br />Encompass Web return type -> loan object |
| commit | ✖️ | ○ | ✖️ | ✖️ | Encompass Web - <br />PUI scripting object return type is void, but EncompassWeb return type is boolean for failure scenario & loanId for successful execution |
| execAction | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -<br /> PUI scripting object return type -> Promise<LoanObject><br />Encompass Web return type -> Promise<{[key:string]: string}> |
| getCurrentApplication | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -<br /> PUI scripting object return type -> Promise<Record<string, string>void<br />Encompass Web return type -> Actual data returned may contain integer for index e.g. {"index":0,"id":"9826a78d-b9a0-4965-a1c5-d3b31bde4b1c","legacyId":"_borrower1"} |
| getCollection | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -<br />PUI scripting object return type - Promise<Record<string, string>><br />EncompassWeb return type -<br />ICollection {<br />add(applicationIndex: number): any;<br />removeAt(index: number, applicationIndex: number): any;<br />} |
| getField | ✖️ | ✔ | ✖️ | ✖️ | |
| getFields | ✖️ | ✔ | ✖️ | ✖️ | |
| getFieldOptions | ✖️ | ✔ | ✖️ | ✖️ | |
| isReadOnly | ✖️ | ✔ | ✖️ | ✖️ | |
| merge | ✖️ | ✔ | ✖️ | ✖️ | |
| setCurrentApplication | ✖️ | ✖️ | ✖️ | ✖️ | |
| setFields | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -<br /> PUI scripting object return type -> void <br />Encompass Web return type -> string or boolean |
| setEditMode | ✖️ | ✖️ | ✖️ | ✖️ |
Events
| Event | Encompass | Encompass Web | TPO | Consumer Connect | Notes |
|---|---|---|---|---|---|
| ApplicationSelected | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -> sample invocation<br />ssfHost.raiseEvent('loan', 'applicationselected', currentApplication);<br />where currentApplication -> loan object data for application{index: currentAppIndex,id: application.id,legacyId: application.legacyId} |
| Close | ✖️ | ✔ | ✖️ | ✖️ | |
| Change | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -> sample invocation<br />ssfHost.raiseEvent('loan', 'change',params);<br />where params are<br />{ fieldID, op, oldVal, newVal } |
| Committed | ✖️ | ✔ | ✖️ | ✖️ | |
| EditModeChange | ✖️ | ✖️ | ✖️ | ✖️ | |
| ExternallyModified | ✖️ | ✖️ | ✖️ | ✖️ | Notifies that the loan was modified outside the current UI (e.g. automation, another user, developer connect). Does not include what changed. |
| FieldChangeSync | ✖️ | ✖️ | ✖️ | ✖️ | |
| MilestoneCompleted | ✖️ | ✔ | ✖️ | ✖️ | |
| Open | ✖️ | ✔ | ✖️ | ✖️ | |
| PreCommit | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -> sample invocation ssfHost.raiseEvent('loan', 'precommit', { cause }, { timeout }); |
| PreMilestoneComplete | ✖️ | ○ | ✖️ | ✖️ | Encompass Web -> sample invocation<br />ssfHost.raiseEvent('loan','premilestonecomplete', { mileStone }, { timeout })<br />where mileStone is _MilestoneLogs of loan object for current applicationIndex |
| Sync | ✖️ | ✔ | ✖️ | ✖️ |