Skip to main content

# Scripting Object API

## Interfaces​

Interface | Description
--- | ---
IAnalytics | Methods to collect various business analytics & performance related events and report the same
IApplication | Allows access to application-level UI elements, behaviors and events
IAuth | Methods to get information about the user and access token
IEvent | base class for events
IForm | Methods to get information about the custom form
IGlobal | The Global object allows for data to be shared between custom forms/tools/plugins within a user's session. Unlike the Session scripting 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
IHttp | Provides methods to make call-outs to 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. This is critical for situations where the guest's code is running in a strict-mode sandbox (where the "allowSameOrigin" flag is false).
ILoan | Methods & Events for interacting with an open loan in the application
IMemStorage | Get or set values in host application javascript memory. Values stored in memory are not persisted across sessions.
IModule | Exposes MicroApp module specific methods
IScriptingObject | base type for scripting object
IScriptingObjectProxy | base type for scripting object proxy
IService | Scripting object to work with service orders, such as launching a service order integration etc.,
ISession | store and retrieves values in host application's session storage
IStyling | Interface for managing dynamic styling of fields and table rows Allows conditional styling based on field values and criteria
ITransaction | Provides your applications lender/borrower-facing view with the necessary handles to model your application's transactional interaction with the EPC platform. Allows access to an interactive session's origination context, create a new transaction, update an existing transaction, create events/messages for a transaction, and more.
ITransactionTemplate | Provides application's administrator-facing view 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.
IWebSocket | Scripting object for WebSocket communication with the server.

## Enumerations​

Enumeration | Description
--- | ---
EditModes | List of supported edit modes
FormType | type of the form
LoanCollection | Loan collection names
LoanLevelActions | Loan level actions
LogLevels | Log levels
ModalSize | size of the modal
ModalType | type of the modal
NavigationType | areas in the application where the user can navigate to
OpenMode | module open mode
OpenType | type of the item to open
OriginContext | user type context
RecordActions | loan record actions
RecordViewType | loan record view types
SCOPE | product scopes
ScriptingObjectNames | -
ServiceSetupCategory | type of service setup categories
ToastType | toast message type
TokenType | token type
WebSocketErrorCode | Well-known WebSocket command error codes

## Type Aliases​

Type Alias | Description
--- | ---
AcceptFile | -
ActionInfo | Action information
ActionResponse | Return type for action execution
AdditionalServices | -
AppInfo | additional information about the application
ApplicationActionCompletedListener | event handler that handles action completed event
ApplicationContext | application context
ApplicationEvents | events related to the application
ApplicationInfo | Selected application related information
ApplicationLoginListener | event handler that handles user login event
ApplicationNavigationStartListener | event handler that handles navigation start event
AssignLoanTeamMember | -
AusTracking | -
BAEvent | Business analytics event
BorrowerContacts | -
BusinessContacts | -
BusinessRules | -
Capabilities | capabilities exposed by the application
ChangeExpectedDate | -
CommitInfo | Loan commit event parameters
CompanySettingsQueryOptions | set of query options to get company settings
CompanyUserSetup | -
ConditionOperator | Condition operators for style criteria matching
ConditionType | -
Contacts | -
ContactSetup | -
CurrentApplicationOptions | options for setting current application
Dashboard | -
DeliveryConditions | -
DescriptorInfo | metadata about the application descriptor
DisclosureTracking | -
DocsSetup | -
Documents | -
DynamicDataManagement | -
EDisclosures | -
EditComment | -
EditModeOptions | options for setting loan edit mode
EFolderHistory | -
EFolderSetup | -
EncompassWebServices | -
EnhancedConditions | -
EntityOptions | entity options (used by EPC)
Environment | environment details
EvaluatorOptions | -
EVault | -
EVaultPortal | -
EventObjects | -
Events | -
ExportServices | -
FieldOptions | option name and its value
FieldOptionsParam | Parameters for getting field options
FileContacts | -
FilterOperator | -
FilterOption | -
FinishMilestone | -
Form | -
FormDescriptor | metadata about the form descriptor
FormEvents | events that notifies the form's lifecycle
FormInfo | metadata about the form
FormLoadListener | event handler for form load event
FormUnloadListener | event handler for form unload event
GlobalChangeListener | event handler for global state change event
GlobalEvents | events fired from Global scripting object
GrantWriteAccess | -
GseServices | -
ImportLoan | -
LaunchCategoryOptions | options to launch service order integration by category
LaunchProviderOptions | options to launch service order integration by specific service provider
LaunchServiceSetupOptions | options to launch service order integration by specific service setup
LIB_NAME | -
Listener | callback for event
LoanApplicationSelectedListener | event handler for loan application selected event
LoanChangeEventInfo | Loan change event parameters
LoanChangeListener | Event handler for loan data change event
LoanCloseListener | event handler for loan close event
LoanCollectionObject | Loan collection object
LoanCommittedListener | Event handler for loan commited event
LoanEditModeChangeListener | event handler for loan edit mode change event
LoanEditModeEventInfo | Loan edit mode change event info
LoanEvents | Event types available for loan-related operations.
LoanExternallyModifiedListener | Event handler for loan externally modified event
LoanFieldChangeSyncListener | Event handler for synchronous loan field change event
LoanMilestoneCompletedListener | event handler for loan milestone completed event
LoanObject | v3 loan object
LoanOpenListener | event handler for loan open event
LoanPreCommitListener | Event handler for loan precommit event
LoanPreMilestoneCompleteListener | event handler for loan pre milestone complete event
LoanRecord | -
LoanSetup | -
LoanSyncListener | Event handler for loan sync event
LoanTeam | -
LoConnectTasks | -
LogMessage | log message
ManageServiceProviders | -
Milestone | -
MilestoneInfo | Milestone related information
MilestoneWorkflowManagement | -
ModalContent | content for warning / success / error / info modal types
ModalOptions | modal options
ModuleCloseInfo | module close event info
ModuleCloseListener | event handler that handles module close event
ModuleEvents | events that notifies the module's lifecycle
ModuleOpenInfo | module open event info
ModuleOpenListener | event handler that handles module open event
ModuleParameters | MicroApp module specific parameters
ModuleUnloadInfo | module unload event info
ModuleUnLoadingListener | event handler that handles module unload event
MoveFrom | -
MoveLoans | -
MoveTo | -
NavigationOptions | navigation options
NavigationStartInfo | navigation start event info
OpenOptions | -
OriginDetails | transaction origination context
PerfMark | Performance mark
PersonalTemplates | -
Personas | Personas information
Pipeline | -
PipelineView | -
PluginInfo | Plugin information
PostClosingConditions | -
PreliminaryConditions | -
Print | -
PrintOptions | Options for printing the document
PurchaseConditions | -
RecordOptions | options for updating records
RemotingScriptingObject | serialized scripting object
ResourceDetails | details of the transaction resource
ResourceOptions | name of the document to be uploaded
ReturnFile | -
Role | -
Role2 | -
Route | navigation type
ScriptingObjectTypes | list of scripting object names and their types
SecondarySetup | -
Service | -
ServiceSetup | details of a service setup
StandardWebForm | -
StateInfo | state information
StyleOptions | CSS style properties that can be applied to fields and table rows All color values should be valid CSS color strings (hex, rgb, named colors, etc.)
SubscribeOptions | Options for subscribing to a WebSocket resource event.
SubscribeResult | Result returned after a successful subscription
SubscriptionFilter | Filter criteria for WebSocket subscription.
SystemAdministration | -
TableRowCriteria | Criteria for conditional styling of table rows Maps table column name/key to condition operators that determine when styles should be applied
TableRowStyleOptions | Style configuration for table rows with conditional criteria Styles are applied to rows that match all specified criteria
TablesAndFees | -
TimingOptions | additional details related to the timing measure
ToastOptions | options for toast message
TokenInfo | Token information
Tool | -
TpoCompanyDetails | -
TpoConnectSiteSettings | -
TpoContacts | -
TpoFees | -
TpoInformation | -
TpoOrganizationSettings | -
TqlServices | -
Trades | -
TransactionDetails | details about the transaction
TransactionEvent | -
TransactionInfo | details about the transaction that is created / updated
TransactionRequest | Transaction request object
TransactionResource | file attachment information
TransactionTemplateDetails | Transaction Template object
UnAuthorizedError | Error thrown when the microapp / customization is not authorized to receive child token
UnderwritingCenter | -
UnderwritingConditions | -
User | User information
UserAccessRights | user access rights object
UserInfo | User information
WebSocketErrorDetail | Error detail returned by the WebSocket server
WebSocketEventMessageInfo | Payload delivered with a WebSocket event message
WebSocketEvents | Event types available for WebSocket operations.
WebSocketMessageListener | Event handler for incoming WebSocket event messages.