Introduction
Understanding Basic Concepts
Users
For the TurnKey Lender system and Knowledge Base documentation, “Users” are back-office users who have access to the back-office application (AKA “Lender’s portal”). Customers, who work via the Customer Portal and Investors using the Investor's Portal are NOT covered by the term Users.
User Roles and Permissions
Each user created in the system is granted a specific set of permissions. The permissions define what actions the user can perform in the system.
In real life, a specific set of permissions is often held by people who perform the same or similar user roles in the company. Technically, roles are not entities in the system, but for convenience, system documentation and some of the UI hints and explanations can use the names of the roles. These names are very natural and easy to comprehend, e.g. “Admin” is a person with “System administration” permission, “Underwriter” with “Underwriting” permission, etc.
Please see the User Permissions article to learn more on the matter.
Branch
The “branch offices” and “subbranches”, usually referred to in the system and documentation as “branches” are virtual representations of the company structure. Subject to the company’s decision, they may represent any allocated part of the company, e.g. a branch office, subsidiary, subdivision, department, unit, etc.
Using the branches and sub-branches, the System Administrator can replicate the company structure in the application and ensure that only the users working with this branch can access the loan applications created and loans serviced within this branch.
Access the “Users” Screen
The “Users” screen is available in the “Settings” workplace, under the “Accounts” section.
It is available to users who have “System administration” permission.
From the “Users” screen, an authorized user can:
Edit user details and permission
Delete users
Add a User: define the User detail, permissions, and branch
Navigate to the “Users” screen (Settings → Accounts → Users), and click the “Add user” button.
The “Add user” window will pop-up. This is where you can define the basic user details and permissions.
Define Basic User Details
Define the basic user details:
Login: Used to enter the system
Latin alphabet and numbersPassword: Used to enter the system. Password requirements can be defined in the Configuration.
First name and Last name
Email: Valid email address
Phone: Phone number
Phone number setting may depend on the selected edition.
Define User Permissions
User permissions define what actions the user can do in the system.
Select specific permissions: click the boxes to check them
Select all: click the button and all the permissions will be checked.
You can then uncheck some of them.Clear all: click the button to remove all the checks.
To the right of each permission, there is an information icon. Hover over the icon to see details of the permissions. Learn more about the available permission in the User Permissions article.
Assign User to a Branch
At the bottom of the page, you can define the branch to which the user will be assigned.
Click the three dots below the “Branch” header and select the branch in the drop-down menu.
If the “Allow access to loans linked to any branch” flag is enabled, the user can access all loans, regardless of their branch. This can be done if the branches are used for purposes other than access permissions (e.g. mimicking the actual company structure).
If the flag is disabled, the user can access only the loans that:
are assigned to the user’s branch
are not assigned to any branch (if this is allowed for the user’s branch)
View and Edit User Details
Find a User
To find a specific User you can filter the User List (Settings → Accounts → Users), or search for a specific key.
You can filter the list by branches or permissions.
Click the dropdown arrow and all available branches/permissions will be displayed.
Check the options and only Users that belong to at least one of these branches or have at least one of these permissions will be displayed on the list.
To search, enter a search key in the “Search” field. Only users who have the key in their name, login, or email will be displayed in the list.
View and Edit User Details
Click the pencil icon in the Actions tab to the right from the user details to get to the “Edit user” screen. It is similar to the “Add user” tab. You can redefine most of the fields in the same way as when creating a user. The only setting that cannot be edited is the user’s login.
Delete a User
Click the trash bin icon in the Actions tab to the right from the user details to delete a user.