Persona ACL Contract Attributes
The following objects and attributes make up the PersonaAclContract. When passing the PersonaAclContract, all attributes are optional unless otherwise specified.
| ATTRIBUTE | DESCRIPTION |
|---|---|
| id string | Persona ID. |
| name string | Name of the persona. |
| defaultAccess string | Whether the persona has access granted to all Encompass features or access to no features. Possible values are All and None. |
| isInternal boolean | Whether the persona is an Internal persona |
| isExternal boolean | Whether the persona is an external persona. A persona can be internal and/ or external. |
| displayOrder integer | The order in which the persona is to be displayed. |
| aclRights UserAclRightsContract | Access Rights associated with the persona. All the rights that are enabled for the persona are returned as part of this object. |
User ACL Rights Contract
The User ACL Rights contract comprises of all the categories that a persona can have permissions for. They have been classified into some major and minor categories. By querying on any number of these categories, you can retrieve all the relevant categories that you want to determine the persona's permissions for.
The major categories are :
- Contacts
- Pipeline
- EFolder
- Settings
- Tools
- Loan
- TpoConnect
- ExternalSettings
- Forms
- Access
- Home
The minor categories are :
- MoveLoans
- Services
- ImportLoans
- DuplicateLoans
- ManageServiceProviders
- MilestoneWorkflowManagement
- PipelineServices
- AdditionalServices
- AusTracking
- BorrowerContacts
- BusinessContacts
- BusinessRules
- ClosingDocs
- CompanyUserSetup
- ConditionsHistory
- ConsumerConnect
- ContactSetup
- Dashboard
- DisclosureTracking
- DocsSetup
- Documents (contains UnprotectedDocuments, UnassignedFiles, and ProtectedDocuments)
- DynamicDataManagement
- EDisclosures
- EFolderSetup
- FileContacts (comes under Loan category, not Contacts category. Contains GrantWriteAccess for ability to grant write access to team members)
- GseServices
- ItemizationFee
- LoanSetup
- PersonalSettings
- PersonalTemplates
- PostClosingConditions
- PreliminaryConditions
- PurchaseConditions (newly added, may not yet be in SmartClient UI)
- Reports
- SecondarySetup
- SmartClient (may be deprecated – features specific to SmartClient)
- SystemAdministration
- TablesAndFees
- TpoCompanyDetails
- TpoConnectSiteManagement
- TpoContacts
- TpoFees
- TpoInformation
- TpoOrganizationSettings
- TqlServices
- Trades
- UnderwritingConditions
| ATTRIBUTES | DESCRIPTION |
|---|---|
| access Array of strings | Other access rights (currently, access to pipeline tab). |
| additionalServices RightsContract | Access rights for Encompass Settings > Additional services. |
| ausTracking RightsContract | Access rights for Encompass Tools > AUS tracking. |
| borrowerContacts RightsContract | Access rights for Encompass Contacts > Borrower contacts. |
| businessContacts RightsContract | Access rights for Encompass Contacts > Business contacts. |
| businessRules RightsContract | Access rights for Encompass Settings > Business Rules. |
| closingDocs Array of strings | Details from Encompass Loan > Closing documents. |
| companyUserSetup RightsContract | Access rights for Encompass Settings > Company/User Setup. |
| contacts RightsContract | Access rights for Encompass Contacts not otherwise specified under business or borrower contacts. |
| contactSetup RightsContract | Access rights for Encompass Settings > Contact setup. |
| consumerConnect Array of strings | Consumer Connect rights. |
| dashboard RightsContract | Details for Dashboard rights. |
| disclosureTracking RightsContract | Access rights for Encompass Tools > Disclosure Tracking. |
| docsSetup RightsContract | Access rights for Encompass Settings > Docs Setup. |
| documents documentRightsContract | Access rights for Encompass eFolder > Document Settings, including attachments and protected/unprotected documents, and other settings. |
| documentRightsContract.access boolean | Specifies whether the parent access feature is on or off. If the core code comes in correctly, this should never be false if any of the listed Rights are nonempty. |
| documentRightsContract.rights Array[string] | Specifies rights belonging directly to this category. |
| documentRightsContract.protected Documents Array[string] | Manage user's rights for protected documents. |
| documentRightsContract.unprotected Documents Array[string] | Manage user's rights for unprotected documents. |
| documentRightsContract.unassignedFiles Array[string] | Manage user's rights for attachments not assigned to a document. |
| duplicateLoans Array[loanTemplateEntityReferenceContract] | Duplicate loan data from the Pipeline. |
| loanTemplateEntityReferenceContract. entityId string | Required. |
| loanTemplateEntityReferenceContract. entityName string | RetrieveOnly. |
| loanTemplateEntityReferenceContract. entityUri string | RetrieveOnly. |
| loanTemplateEntityReferenceContract. entityType string | EntityPath used for template files and folders, since it is not an ID. If ID is added later, we can use the EntityID property. |
| loanTemplateEntityReferenceContract. entityPath string | |
| loanTemplateEntityReferenceContract. itemizationType string | ItemizationType will be used only in case of closing cost template. |
| loanTemplateEntityReferenceContract. description string | Template description. |
| loanTemplateEntityReferenceContract.hasSubFolders boolean | Indicates whether the loan template has subfolders. |
| dynamicDataManagement RightsContract | Access rights for Encompass Settings > DDM. |
| eDisclosures RightsContract | Access rights for Encompass Encompass eFolder > EDisclosures. Depends on Documents access. |
| eFolderHistory RightsContract | Access rights for Encompass eFolder history tab. |
| eFolderSetup RightsContract | Access rights for Encompass Settings > EFolder setup. |
| externalSettings Array[string] | External settings not otherwise specified. |
| eVault EVaultRightsContract | Access rights to eVault tab. |
| EVaultRightsContract.eVaultPortal RightsContract | Access details to eVaultPortal. |
| fileContacts fileContactsRightsContract | Rights to Encompass Tools > File contacts. Includes assigning write access to loan team members. |
| fileContactsRightsContract.access boolean | Specifies whether the parent access feature is on or off. If the core code comes in correctly, this should never be false if any of the listed Rights are nonempty. |
| fileContactsRightsContract.rights Array[string] | Specifies rights belonging directly to this category. |
| fileContactsRightsContract.grantWriteAccess loanTeamRightsContract | Specifies roles (milestones and free roles) that can be granted write access. |
| grantWriteAccess.loanTeamRightsContract. access boolean | Indicates whether the milestones and free roles can be granted write access. |
| grantWriteAccess.loanTeamRightsContract. loanTeam Array[LoanTeamMemberContract] | The LoanTeam as decribed by the milestone and roles entityReferenceContracts. |
| forms Array[EntityReferenceContract] | Encompass Forms >Input forms accessible to the user. |
| gseServices RightsContract | Access rights for Pipeline Tasks > GSE services. |
| home Array[string] | Home tab: specifies mobile access and company's My Account module and pages. |
| importLoans Array[EntityReferenceContract] | Pipeline: Import loans from loan import folders. |
| services Array[serviceRightsContract] | Investor services, Warehouse Lenders, and other services: shows if access setting is custom, all, or none. Custom case can be ambiguous, so default access setting specifies if services are allowed/disallowed by default. |
| serviceRightsContract.category string | Category specifies service type: Investor, WarehouseLender etc. |
| serviceRightsContract.accessSetting string | Upon read, this is set to Custom if some but not all settings are on. To turn all settings on, set the AccessType to All. = ['None', 'Custom', 'All', 'Unspecified'] |
| serviceRightsContract.defaultAccess string | If DefaultAccess is "Allow", all services are allowed unless otherwise specified. If "Disallow", then only the specified services are allowed. = ['Allow', 'Disallow'] |
| serviceRightsContract.allowedServices Array[string] | Explicitly allowed services, in the case where the default access is "Disallow." |
| serviceRightsContract.disallowedServices Array[string] | Explicitly disallowed services, in the case where the default access is "Allow." |
| itemizationFee Array[string] | Loan: Manage itemization fees. |
| loan Array[string] | Loan: Loan rights not otherwise specified. |
| loanSetup RightsContract | Access rights for Settings: Loan setup. |
| manageServiceProviders loanServiceProviderRightsContract | Specifies which service providers the user can manage. Depends on the Manage Service Providers setting in Pipeline Tasks. |
| loanServiceProviderRightsContract. accessSetting string | Upon read, this is set to Custom if some but not all settings are on. To turn all settings on, set the AccessType to All. = ['None', 'Custom', 'All', 'Unspecified'] |
| loanServiceProviderRightsContract.rights Array[string] | Specifies rights belonging directly to this category. |
| milestoneWorkflowManagement milestoneWorkflowManagementContract | Loan: Specifies which milestone changes the user can make, and which milestones and free roles the user can assign loan team members to. |
| milestoneWorkflowManagementContract. acceptFiles Array[EntityReferenceContract] | Details about the users who can accept files for these milestones. |
| milestoneWorkflowManagementContract. returnFiles Array[EntityReferenceContract] | Details about the users who can return files for these milestones. |
| milestoneWorkflowManagementContract. changeExpectedDate Array[EntityReferenceContract] | Details about the users who can change the expected date of these milestones. |
| milestoneWorkflowManagementContract. finishMilestones Array[EntityReferenceContract] | Details about the users who can complete these milestones. |
| milestoneWorkflowManagementContract. assignLoanTeamMembers | Details about the users who can assign loan team members to these milestones or free roles. |
| milestoneWorkflowManagementContract. Array[EntityReferenceContract] | Details about the users who can edit comments on the specified milestones. |
| moveLoans loanMoveRightsContract | Move loans from one folder to another. |
| loanMoveRightsContract.access boolean | Specifies whether the parent access feature is on or off. If the core code comes in correctly, this should never be false if any of the listed Rights are nonempty. |
| loanMoveRightsContract.rights Array[string] | Specifies rights belonging directly to this category. |
| loanMoveRightsContract.moveFrom Array[EntityReferenceContract] | Folders user can move loans from. |
| loanMoveRightsContract.moveTo Array[EntityReferenceContract] | Folders user can move loans to. |
| personalSettings Array[string] | Settings: Personal setting. |
| personalTemplates RightsContract | Settings: Personal templates. |
| pipeline pipelineRightsContract | Pipeline: main tasks and access. Parent access to pipeline controls access to loan and several other features. |
| pipelineRightsContract.access boolean | Specifies whether the parent access feature is on or off. If the core code comes in correctly, this should never be false if any of the listed Rights are nonempty. |
| pipelineRightsContract.rights Array[string] | Specifies rights belonging directly to this category. |
| pipelineRightsContract.pipelineTasks Array[string] | Pipeline tasks. |
| pipelineRightsContract.pipelineViews Array[EntityReferenceContract] | Names of pipeline views. |
| pipelineRightsContract.nonAccessible Columns Array[pipelineColumnNameContract] | Non-accessible pipeline columns. |
| nonAccessible.pipelineColumnNameContract. canonicalName string | Canonical name, used for pipeline column filtering. |
| nonAccessible.pipelineColumnNameContract. description string | Description of pipeline field. |
| exportServices exportServiceRightsContract | Pipeline: pipeline services. |
| exportServiceRightsContract.accessSetting string | Upon read, this is set to Custom if some but not all settings are on. To turn all settings on, set the AccessType to All. = ['None', 'Custom', 'All', 'Unspecified'] |
| exportServiceRightsContract.defaultAccess string | If DefaultAccess is "Allow", all services are allowed unless otherwise specified. If "Disallow", then only the specified services are allowed. = ['Allow', 'Disallow'] |
| exportServiceRightsContract.allowedServices Array[string] | Explicitly allowed services, in the case where the default access is "Disallow." |
| exportServiceRightsContract.disallowedServices Array[string] | Explicitly disallowed services, in the case where the default access is "Allow." |
| postClosingConditions RightsContract | Access rights for eFolder > Post-Closing conditions. |
| preliminaryConditions RightsContract | Access rights for eFolder > Preliminary Conditions. |
| purchaseConditions RightsContract | Access rights for eFolder > Purchase Conditions. |
| reports Array[string] | Reports: Loan reports, borrower contact reports, and others. |
| print RightsContract | Access rights for Loan > Printing. |
| secondarySetup RightsContract | Access rights for Encompass Settings > Secondary Setup. |
| deliveryConditions RightsContract | Access rights for eFolder > Delivery Conditions Renamed Sell Conditions to Delivery Conditions. |
| settings Array[string] | Settings not otherwise specified. |
| smartClient Array[string] | Settings: Rights specific to SmartClient. |
| systemAdministration RightsContract | Access rights for Encompass Settings > System Administration. |
| tablesAndFees RightsContract | Access rights for Encompass Settings > Tables and fees. |
| tools Array[entityNameOnlyContract] | Rights not otherwise specified. Currently does not support entity IDs or types. |
| entityNameOnlyContract.entityName string | Feature to which user is granted permission. |
| tpoCompanyDetails RightsContract | Access rights for Encompass External Settings > Company Details. |
| tpoConnectSiteSettings RightsContract | Access rights for Encompass External Settings > TPO Connect settings. |
| tpoContacts RightsContract | Access rights for Encompass External Settings > TPO Contacts. |
| tpoFees RightsContract | Access rights for Encompass External Settings > TPO Fees. |
| tpoInformation RightsContract | Access rights for Encompass Tools > TPO information. |
| tpoOrganizationSettings RightsContract | Access rights for Encompass External Settings > Company Details > TPO organization settings. |
| tqlServices RightsContract | Access rights for Encompass Tools > TQL services. |
| trades RightsContract | Access rights for Access > Trades tab. |
| underwritingConditions RightsContract | Access rights for eFolder > Underwriting Conditions. |
| enhancedConditions enhancedConditionsRightsContract | Access rights for Encompass EnhancedConditions > Condition Types. |
| enhancedConditionsRightsContract.access boolean | Specifies whether the parent access feature is on or off. If the core code comes in correctly, this should never be false if any of the listed Rights are nonempty. |
| enhancedConditionsRightsContract.rights Array[string] | Specifies rights belonging directly to this category. |
| enhancedConditionsRightsContract. conditionType inline_model_19 | ConditionType. |
| loConnectTasks RightsContract | Access rights for Encompass LoConnect > LoConnect Tasks. |
| encompassWebServices RightsContract | Access rights for Encompass LoConnect > Encompass Web Services. |
| underwritingCenter RightsContract | Access rights for Encompass LoConnect > Underwriting Center. |
Rights Contract Attributes
The following objects and attributes make up the RightsContract. When passing the RightsContract, all attributes are optional unless otherwise specified.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| access boolean | Specifies whether the parent access feature is on or off. If the core code comes in correctly, this should never be false if any of the listed Rights are nonempty. |
| rights Array[string] | Specifies rights belonging directly to this category. |
Entity Reference Contract
The following objects and attributes make up the entityReferenceContract. When passing the entityReferenceContract, all attributes are optional unless otherwise specified.
| ATTRIBUTES | DESCRIPTION |
|---|---|
| entityId string | Required. |
| entityName string | RetrieveOnly. |
| entityUri string | RetrieveOnly. |
| entityType string | Possible values are: Default, User, Role, Condition, Application, Attachment, Document, MilestoneSetting, ReoProperty, NonBorrowingOwner, Milestone, BorrowerContact, BusinessContact, Organization, Persona, Form, FieldDefinition, ExternalOrg, PipelineView, PersonaView, UserView, LoanTemplateSet, TemplateFolder, ClosingCostTemplate, LoanFolder, LoanDuplicationTemplate, Loan, Borrower, CoBorrower, ResourceLock, CorrespondentMaster, CorrespondentTrade, LoanTrade, MBSPool, Trade, UserGroup, DocumentTemplate, ConditionView, Company, CompanyExtension, Branch, BranchExtension, Vod, Voe, Vol, Vom, Vor, CustomPlanCode, EMPlanCode, StandardForm, CustomForm, ConditionType, ConditionTemplate, LoanProgramTemplate, DisclosureTracking2015Log, SettlementServiceProviderTemplate, AffiliatedBusinessArrangements, RateLock |
© ICE Mortgage Technology, Inc. All rights reserved.