# Overview

<span style="color: #1c1e3f;">The Administration Panel is the essential tool for our Partners to work with your Verestro services. The main purpose of Admin Portal is to provide a web-based environment with the ability to manage customer service actions. The presented solution is prepared for customisation with Partner's brand.</span>

<span style="color: #1c1e3f;">This document is divided into sections that describe the various components of the system. Each section contains a screen presenting the functionality and a detailed description of the states occurring in it. </span>

<span style="color: #1c1e3f;">The mechanisms described in this documentation are the most important ones for all web-based products that rely on Admin Portal. Some functionalities of Verestro have specific screens and processes that are not described here. Administration Panel is going through on-going development and changes to improve its performance so there may be differences in this description and real panel.</span>

### <span style="color: #1c1e3f;">Purpose and scope</span>

<span style="color: #1c1e3f;">This product guide provides a high-level overview of Admin Panel Management. This document covers the following topics:</span>

<div class="page" id="bkmrk-description-of-the-a" title="Page 5"><div class="page" title="Page 5"><div class="layoutArea"><div class="column">- <span style="color: #1c1e3f;">description of the all aggregates of operators, including detailed information and possible actions,</span>
- <span style="color: #1c1e3f;">description of possible configurations,</span>
- <span style="color: #1c1e3f;">granting access,</span>
- <span style="color: #1c1e3f;">description of main processes as: login, reset password,</span>
- <span style="color: #1c1e3f;">additional and optional functionalities.</span>

</div></div></div></div>### <span style="color: #1c1e3f;">Terminology</span>

<span style="color: #1c1e3f;">This section explains a number of key terms and concepts used in this document.</span>

<table border="1" id="bkmrk-name-description-cus" style="border-collapse: collapse; width: 107.161%; height: 109.983px;"><tbody><tr style="height: 35.4px;"><td bgcolor="#1C1E3F" style="width: 17.1794%; height: 35.4px;" width="353"><span style="color: #ecf0f1;">**Name**</span>

</td><td bgcolor="#1C1E3F" style="width: 82.7959%; height: 35.4px;" width="353"><span style="color: #ecf0f1;">**Description**</span></td></tr><tr style="height: 35.4px;"><td style="width: 17.1794%; height: 35.4px;"><span style="color: #1c1e3f;">Operator</span>

</td><td style="width: 82.7959%; height: 35.4px;"><span style="color: #1c1e3f;">User using the Portal regardless of role or level of rights.</span>

</td></tr><tr style="height: 39.1833px;"><td style="width: 17.1794%; height: 39.1833px;"><span style="color: #1c1e3f;">Session token</span>

</td><td style="width: 82.7959%; height: 39.1833px;"><span style="color: #1c1e3f;">Access to the system by a web application user is secured using a session token to uniquely associate the session with the user. It is required to perform any action.</span>

</td></tr></tbody></table>

## <span style="color: #1c1e3f;">Access and configuration</span>

### <span style="color: #1c1e3f;">Access solutions</span>

<span style="color: #1c1e3f;">The access to Admin Portal in available in 3 ways:</span>

<div class="page" id="bkmrk-direct-traffic-throu" title="Page 7"><div class="page" title="Page 7"><div class="layoutArea"><div class="column">- <span style="color: #1c1e3f;">direct traffic through VPN (Virtual Private Network) - requires VPN reconfiguration on both sides,</span>
- <span style="color: #1c1e3f;">block access to the domain and allow access from a particular IP address (specific IP addresses or a range</span>
    
    <span style="color: #1c1e3f;">of addresses) - configuration required on Verestro side,</span>
- <span style="color: #1c1e3f;">free access for everyone, who have an account in Admin Portal (no matter if VPN configuration or IP</span>
    
    <span style="color: #1c1e3f;">address are set.</span>

</div></div></div></div><span style="color: #1c1e3f;">Admin Portal is available on two environments:</span>

<span style="color: #1c1e3f;">▪ test environment (dev/UAT environment),</span>  
<span style="color: #1c1e3f;">▪ production environment.</span>

<span style="color: #1c1e3f;">Sample of test environment (URL): **https://admin-panel-nameofclient.verestro.dev/** </span>  
<span style="color: #1c1e3f;">Sample of production environment (URL): **https://admin-panel-nameofclient.verestro.com/**</span>

<span style="color: #1c1e3f;">**IMPORTANT**: There is also option to use custom domains.</span>

### <span style="color: #1c1e3f;">Configuration of Admin Portal</span>

<span style="color: #1c1e3f;">Admin Panel has a several default parameters related to the time of each action. Table below describes particular action and time of session token.</span>

<table border="1" id="bkmrk-action-description-a" style="border-collapse: collapse; width: 100%; height: 261.2px;"><tbody><tr style="height: 50px;"><td bgcolor="#1C1E3F" style="width: 22.3678%; height: 50px;" width="353"><span style="color: #ecf0f1;">**Action**</span></td><td bgcolor="#1C1E3F" style="width: 48.9254%; height: 50px;" width="353"><span style="color: #ecf0f1;">**Description**</span></td><td bgcolor="#1C1E3F" style="width: 28.6821%; height: 50px;" width="353"><span style="color: #ecf0f1;">**Accessibility time**</span>

</td></tr><tr style="height: 35.2px;"><td style="width: 22.3678%; height: 35.2px;"><span style="color: #1c1e3f;">Reset password</span>

</td><td style="width: 48.9254%; height: 35.2px;"><span style="color: #1c1e3f;">Validity of link to reset password.</span>

</td><td style="width: 28.6821%; height: 35.2px;"><span style="color: #1c1e3f;">60 minutes</span>

</td></tr><tr style="height: 35.2px;"><td style="width: 22.3678%; height: 35.2px;"><span style="color: #1c1e3f;">Create an account</span>

</td><td style="width: 48.9254%; height: 35.2px;"><span style="color: #1c1e3f;">Validity of link to first login to Admin Panel.</span>

</td><td style="width: 28.6821%; height: 35.2px;"><span style="color: #1c1e3f;">60 minutes</span>

</td></tr><tr style="height: 35.2px;"><td style="width: 22.3678%; height: 35.2px;"><span style="color: #1c1e3f;">Login to the panel</span>

</td><td style="width: 48.9254%; height: 35.2px;"><span style="color: #1c1e3f;">Validity of code (4 numbers) to login.</span>

</td><td style="width: 28.6821%; height: 35.2px;"><span style="color: #1c1e3f;">10 minutes</span>

</td></tr><tr style="height: 35.2px;"><td style="width: 22.3678%; height: 35.2px;"><span style="color: #1c1e3f;">User session</span>

</td><td style="width: 48.9254%; height: 35.2px;"><span style="color: #1c1e3f;">Session after successful login to the panel.</span>

</td><td style="width: 28.6821%; height: 35.2px;"><span style="color: #1c1e3f;">15 minutes</span>

</td></tr><tr style="height: 35.2px;"><td style="width: 22.3678%; height: 35.2px;"><span style="color: #1c1e3f;">User lock</span>

</td><td style="width: 48.9254%; height: 35.2px;"><span style="color: #1c1e3f;">Time of lock due to incorrect password.</span>

</td><td style="width: 28.6821%; height: 35.2px;"><span style="color: #1c1e3f;">max 24h (until midnight next day)</span>

</td></tr><tr style="height: 35.2px;"><td style="width: 22.3678%; height: 35.2px;"><span style="color: #1c1e3f;">Registration link</span>

</td><td style="width: 48.9254%; height: 35.2px;"><span style="color: #1c1e3f;">Validity of invitation link.</span>

</td><td style="width: 28.6821%; height: 35.2px;"><span style="color: #1c1e3f;">60 minutes</span>

</td></tr></tbody></table>

These are the default values, they can be changed at the request of the customer.

## <span style="color: #1c1e3f;">Security</span>

<span style="color: #1c1e3f;">The systems offered by Verestro are fully secure, which is confirmed by current third-party certificates. As we store card and payment data we are obliged to comply with strict legal requirements. Card and user data are stored in a specially designed environment - Data Core. This environment is PCI DSS certified. The PCI-DSS standard guarantees the security of payment card data. It ensures that sensitive information is properly guarded and provides maximum security in the payment process. The portal operators' passwords are kept in a different database from the end users' data for security reasons. To encrypt them the algorithm Bcrypt with a cost of 10 is used. The cost parameter specifies a key expansion iteration count as a power of two, which is an input to the crypt algorithm.</span>

<span style="color: #1c1e3f;">We achieve high security standards by, among other things :</span>

<div class="page" id="bkmrk-building-and-maintai" title="Page 8"><div class="page" title="Page 8"><div class="layoutArea"><div class="column">1. <span style="color: #1c1e3f;">Building and maintaining network security - the need to build and maintain a firewall configuration that protects cardholder data, not using manufacturers' default passwords and settings.</span>
2. <span style="color: #1c1e3f;">Protecting cardholder data - protecting stored cardholder data, encrypting data transmissions when using public networks.</span>
3. <span style="color: #1c1e3f;">Maintaining a payment management program - using regularly updated anti-virus systems, developing secure systems and applications.</span>
4. <span style="color: #1c1e3f;">Implementing strong access control methods - limiting access to cardholder data to only those with a business need, assigning each user a unique ID, limiting physical access to cardholder data.</span>
5. <span style="color: #1c1e3f;">Regular network monitoring and testing - testing security systems and processes, controlling access to network resources and cardholder data.</span>
6. <span style="color: #1c1e3f;">Maintaining information security policies - relying on security policies for employees and vendors.</span>

</div></div></div></div><span style="color: #1c1e3f;">[![image-1651662192595.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662192595.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662192595.png)</span>

## <span style="color: #1c1e3f;">Architecture</span>

<span style="color: #1c1e3f;">Admin Panel uses Verestro's distributed systems to provide the highest quality of service. It is practically the best architectural solution these days. As mentioned in the previous chapter, the communication between services is completely secure, maintaining the highest security standards. This kind of system guarantees not only high efficiency, due to the division of responsibilities between the components, but also allows for easy and fast scaling of the system according to the customer's requirements.</span>

<span style="color: #1c1e3f;">Below is a sample architecture for the product VCP or in other words Admin Panel MDES along with MCBP Wallet.</span>

<span style="color: #1c1e3f;">[![image-1651662217484.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662217484.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662217484.png)</span>

## <span style="color: #1c1e3f;">Login procedure</span>

### <span style="color: #1c1e3f;">First login (activation)</span>  


<span style="color: #1c1e3f;">Users could be added only from the panel. It is not possible to register in the system without an invitation. Basic administrators accounts that can be used to create a user hierarchy are provided with the panel instance.</span>

<span style="color: #1c1e3f;">In order to create a new user account you have to log in to the panel using your e-mail address, which is user login. Then go to the "Administrators" tab and fill in the required data. After filling in the role, personal data and e-mail address there will be sent a welcome message with an activation link for new account.</span>

<span style="color: #1c1e3f;">[![Frame 6.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/scaled-1680-/frame-6.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/frame-6.png)</span>

<span style="color: #1c1e3f;">Once the email send process is complete, the invited user will receive a message. It contains a welcome and an activation link - used to set a password to access the system.</span>

<span style="color: #1c1e3f;">[![image-1651662342529.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662342529.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662342529.png)</span>

<span style="color: #1c1e3f;">Clicking on the link redirects to the login page, where the employee will have to set a password during the first logging in. The required password standard is a minimum of 8 characters, at least one digit, one capital letter and one letter.</span>

<span style="color: #1c1e3f;">[![image-1651662395526.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662395526.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662395526.png)</span>

### <span style="color: #1c1e3f;">Login procedure</span>

<span style="color: #1c1e3f;">Operator must provide correct pair – e-mail and password. If the provided login is incorrect, a message informing the employee of an error “Incorrect e-mail or password” and the possibility of another attempt will be displayed.</span>

<span style="color: #1c1e3f;">[![image-1651662481851.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662481851.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662481851.png)</span>

<span style="color: #1c1e3f;">If the data provided is correct, an authentication code is sent. This is required to complete the next step of the two-step login.</span>

<span style="color: #1c1e3f;">[![image-1651662508108.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662508108.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662508108.png)</span>

<span style="color: #1c1e3f;">As last step application asks for code. Sent code has set validity time. If code will not be provided in this time, login procedure must be started from first step.</span>

<span style="color: #1c1e3f;">[![image-1651662524289.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662524289.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662524289.png)</span>

## <span style="color: #1c1e3f;">Reset password procedure</span>

<span style="color: #1c1e3f;">In order to reset password, admin has to open the login page and click option “reset password” (located under e-mail and password inputs). In next step, admin must provide correct e-mail address.</span>

<span style="color: #1c1e3f;">[![image-1651662594872.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662594872.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662594872.png)</span>

<span style="color: #1c1e3f;">If the provided e-mail is correct, reset password link will be send to the employee's company e-mail address.</span>

<span style="color: #1c1e3f;">[![image-1651662613161.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662613161.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662613161.png)</span>

<span style="color: #1c1e3f;">Clicking on the link redirects to the reset password page, where the employee will have to provide his e-mail address and set a new password. The required password standard is a minimum of 8 characters, at least one digit, one capital letter and one small letter.</span>

<span style="color: #1c1e3f;">[![image-1651662637637.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662637637.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662637637.png)</span>

## <span style="color: #1c1e3f;">Main view</span>

<span style="color: #1c1e3f;">Once the authentication process is properly completed, the bank employee has access to the panel. He is shown the main screen of the system. Depending on the assigned rights group its appearance may vary. Different roles in the system have different tabs available. </span>

<span style="color: #1c1e3f;">[![image-1651662664655.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651662664655.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651662664655.png)</span>

<span style="color: #1c1e3f;">The components that make up the Admin Portal are:</span>  
<span style="color: #1c1e3f;">1) Main menu contains aggregates as: customers, cards, devices, payment history, IBANs, project administration (administrators, visuals, logs).</span>  
<span style="color: #1c1e3f;">2) Admin Panel adjusted to the client’s colours and logotype. </span>  
<span style="color: #1c1e3f;">3) Filters allows to select multiple filter options and display results that contain information all the selected criteria. </span>  
<span style="color: #1c1e3f;">4) List of the most important information referring to each aggregate (example: customers). </span>  
<span style="color: #1c1e3f;">5) Actions allows admin to change the status of aggregate or edit data. </span>

##   
<span style="color: #1c1e3f;">Operator administration</span>  


### <span style="color: #1c1e3f;">Roles and permissions</span>

<span style="color: #1c1e3f;">From the actions of the bank's operations team or call centre point of view, three types of authorization are characterized by diverse access levels have been created:</span>  
<span style="color: #1c1e3f;">• employee, </span>  
<span style="color: #1c1e3f;">• manager, </span>  
<span style="color: #1c1e3f;">• administrator. </span>

<span style="color: #1c1e3f;">Above levels are characterized by privileges with access to operational functionalities, which significantly influence the portal operators. The basic tasks at this level is customer verification, data preview and potential editing. </span>

  
<span style="color: #1c1e3f;">Below are the default function descriptions divided into areas.</span>

<table id="bkmrk-aggregate-action-adm" style="height: 212.8px;" width="827"><tbody><tr style="height: 35.2px;"><td bgcolor="#1C1E3F" style="width: 14.1188%; height: 35.2px;" width="353"><span style="color: #ecf0f1;">**Aggregate**</span>

</td><td bgcolor="#1C1E3F" style="width: 14.1188%; height: 35.2px;" width="353"><span style="color: #ecf0f1;">**Action**</span>

</td><td bgcolor="#1C1E3F" style="width: 14.1188%; height: 35.2px;" width="353"><span style="color: #ecf0f1;">**Admin**</span>

</td><td bgcolor="#1C1E3F" style="width: 14.1188%; height: 35.2px;" width="353"><span style="color: #ecf0f1;">**Manager**</span>

</td><td bgcolor="#1C1E3F" style="width: 14.1188%; height: 35.2px;" width="353"><span style="color: #ecf0f1;">**Employee**</span>

</td></tr><tr style="height: 29.6px;"><td rowspan="6" style="height: 177.6px;"><span style="color: #1c1e3f;">Portal management - Operators</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">View</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">-</span></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><span style="color: #1c1e3f;">Create</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">-</span></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><span style="color: #1c1e3f;">Edit</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">-</span></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><span style="color: #1c1e3f;">Delete</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">-</span></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><span style="color: #1c1e3f;">Lock</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">-</span></td></tr><tr style="height: 29.6px;"><td style="height: 29.6px;"><span style="color: #1c1e3f;">Unlock</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">x</span></td><td style="height: 29.6px;"><span style="color: #1c1e3f;">-</span></td></tr></tbody></table>


<span style="color: #1c1e3f;">With the default setting of permissions according to the table above, the administrator can see operators in all roles in the list (including other admins, managers and employees) and can add operators with any role. The Manager, on the other hand, only can see operators with Employee status and can only create such operators.</span>

### <span style="color: #1c1e3f;">Operators list</span>

<span style="color: #1c1e3f;">Administration Panel Accounts list contains filters and columns with dates. In this section detailed lists don’t occur. The filters are used for dynamic searching, such data as: e-mail, first name, last name, group (available: admin, manager, employee). </span>

<span style="color: #1c1e3f;">[![image-1656331005778.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/scaled-1680-/image-1656331005778.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/image-1656331005778.png)</span>

<span style="color: #1c1e3f;">Basic list includes following information:</span>

<table id="bkmrk-parameter-descriptio-13"><tbody><tr><td bgcolor="#1C1E3F" style="width: 349.5px;" width="353"><span style="color: #ecf0f1;">**Parameter**</span>

</td><td bgcolor="#1C1E3F" style="width: 349.5px;" width="353"><span style="color: #ecf0f1;">**Description**</span>

</td></tr><tr><td width="141"><span style="color: #1c1e3f;">Group</span>

</td><td width="567"><span style="color: #1c1e3f;">Group determines the access level.</span>

</td></tr><tr><td width="141"><span style="color: #1c1e3f;">E-mail</span>

</td><td width="567"><span style="color: #1c1e3f;">Admin e-mail address.</span>

</td></tr><tr><td width="141"><span style="color: #1c1e3f;">First name</span>

</td><td width="567"><span style="color: #1c1e3f;">Admin first name.</span>

</td></tr><tr><td width="141"><span style="color: #1c1e3f;">Last name</span>

</td><td width="567"><span style="color: #1c1e3f;">Admin last name.</span>

</td></tr><tr><td width="141"><span style="color: #1c1e3f;">Status</span>

</td><td width="567"><span style="color: #1c1e3f;">Admin status (described in admin statuses part).</span>

</td></tr><tr><td width="141"><span style="color: #1c1e3f;">Actions</span>

</td><td width="567"><span style="color: #1c1e3f;">Action which can be performed on particular admin (described in admin actions part).</span>

</td></tr></tbody></table>

### <span style="color: #1c1e3f;">Account statuses</span>

<div class="table-wrap" id="bkmrk-name-of-status-descr"><div class="table-wrap"><div class="table-wrap"><table class="relative-table confluenceTable tablesorter tablesorter-default stickyTableHeaders" role="grid" style="width: 100%;"><thead class="tableFloatingHeaderOriginal"><tr class="tablesorter-headerRow" role="row"><td bgcolor="#1C1E3F" style="width: 17.1794%;" width="353"><span style="color: #ecf0f1;">**Name of status** </span>

</td><td bgcolor="#1C1E3F" style="width: 82.7959%;" width="353"><span style="color: #ecf0f1;">**Description**</span></td></tr></thead><tbody aria-live="polite" aria-relevant="all"><tr role="row"><td class="confluenceTd" style="width: 28.1913%;"><span style="color: #1c1e3f;">Inactive</span></td><td class="confluenceTd" style="width: 71.8087%;"><span style="color: #1c1e3f;">The inactive status means that the operator account was created with the is\_active=false flag. No invitation has been sent to the system. This is an optional status.</span></td></tr><tr role="row"><td class="confluenceTd" style="width: 28.1913%;"><span style="color: #1c1e3f;">Invited</span></td><td class="confluenceTd" style="width: 71.8087%;"><span style="color: #1c1e3f;">The invited status means that the invitation to the system (password setting link) has been sent to the operator. This is possible in two cases:</span>  
<span style="color: #1c1e3f;">1. the account was created with the flag is\_active=true.</span>  
<span style="color: #1c1e3f;">2. the account was created with the flag is\_active=false and then activated.</span></td></tr><tr role="row"><td class="confluenceTd" style="width: 28.1913%;"><span style="color: #1c1e3f;">Active</span></td><td class="confluenceTd" style="width: 71.8087%;"><span style="color: #1c1e3f;">The active status means that the operator has properly completed the registration and activation process, i.e. has created a password to the portal (using the link with the invitation or the resetPassword procedure if the link has expired). In this status the access to the portal is possible - it is the only status that allows a proper login. </span>

</td></tr><tr role="row"><td class="confluenceTd" colspan="1" style="width: 28.1913%;"><span style="color: #1c1e3f;">Locked</span></td><td class="confluenceTd" colspan="1" style="width: 71.8087%;"><span style="color: #1c1e3f;">The locked status clearly indicates that the operator has been locked by another operator. This status can be applied to all statuses except deleted. From locked status operator can return to his previous status. Moreover, if an operator with status invited has been moved to locked status and in the meantime has completed registration, then after removing the lock it will have active status - not invited as it was before the lock.</span>

</td></tr><tr role="row"><td class="confluenceTd" colspan="1" style="width: 28.1913%;"><span style="color: #1c1e3f;">Deleted</span></td><td class="confluenceTd" colspan="1" style="width: 71.8087%;"><span style="color: #1c1e3f;">The deleted status means that the portal operator has been irreversibly removed from the system. It is not possible to restore an operator account from this status.</span></td></tr></tbody></table>

</div></div></div><span style="color: #1c1e3f;">Referring to the above tables, the possible transition of operator states is presented in the diagram below.</span>

<span style="color: #1c1e3f;">Standard flow - operator is created in status invited (Admin Panel MDES/VCP scenario).</span>

<span style="color: #1c1e3f;">[![image-1651747168588.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651747168588.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651747168588.png)</span>

<span style="color: #1c1e3f;">Alternative flow - operator is created in status inactive.</span>

<span style="color: #1c1e3f;">[![image-1651747318434.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651747318434.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651747318434.png)</span>

### <span style="color: #1c1e3f;">Accounts actions</span>

<span style="color: #1c1e3f;">Administration Panel user can perform the following actions for the particular user (admin, manager, employee):</span>  
<span style="color: #1c1e3f;">a) add admin/manager/employee – necessary to input following data: group (select: admin, manager, employee), first name, last name, e-mail. In order to confirm “Save” button should be clicked. Added user should receive e-mail with link to activate account and set the password. </span>

<span style="color: #1c1e3f;">[![image-1656331146694.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/scaled-1680-/image-1656331146694.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/image-1656331146694.png)</span>

<span style="color: #1c1e3f;">b) edit admin/manager/employee – possible to change following data: group (select: admin, manager, employee), first name, last name, e-mail. There's no option to edit operator with status "invited", in this particular case it's necessary to delete invitation and add a new operator.</span>

<span style="color: #1c1e3f;">[![image-1656331033302.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/scaled-1680-/image-1656331033302.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/image-1656331033302.png)</span>

<span style="color: #1c1e3f;">c) lock admin/manager/employee – temporary lock of user.</span>

<span style="color: #1c1e3f;">[![image-1656331068038.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/scaled-1680-/image-1656331068038.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-06/image-1656331068038.png)</span>

## <span style="color: #1c1e3f;">Notifications in the system</span>

<span style="color: #1c1e3f;">This section contains all email messages that are sent in the system to the portal operator.</span>

<span style="color: #1c1e3f;">Emails from Admin Panel to operator.</span>

<table id="bkmrk-process-topic-detail" style="width: 87.4074%;"><tbody><tr><td bgcolor="#1C1E3F" style="width: 17.1794%;" width="353"><span style="color: #ecf0f1;">**Process**</span>

</td><td bgcolor="#1C1E3F" style="width: 17.1794%;" width="353"><span style="color: #ecf0f1;">**Topic**</span>

</td><td bgcolor="#1C1E3F" style="width: 17.1794%;" width="353"><span style="color: #ecf0f1;">**Details**</span>

</td><td bgcolor="#1C1E3F" style="width: 17.1794%;" width="353"><span style="color: #ecf0f1;">**Comment**</span>

</td></tr><tr><td style="width: 17.8218%;" width="80"><span style="color: #1c1e3f;">Invitation to the system</span>

</td><td style="width: 20.3654%;" width="131"><span style="color: #1c1e3f;">Set password to administration panel.</span>

</td><td style="width: 36.4946%;" width="317"><span style="color: #1c1e3f;">Hello!</span>

<span style="color: #1c1e3f;">You are receiving this e-mail because an account was created for you, and you need to set a new password.</span>

<span style="color: #1c1e3f;">&lt;button to set password&gt;</span>

<span style="color: #1c1e3f;">Regards,</span>

<span style="color: #1c1e3f;">&lt; NameOfClient &gt;</span>

</td><td style="width: 25.3182%;" width="179"><span style="color: #1c1e3f;">Standard email sent when portal operator added new operator.</span>

</td></tr><tr><td style="width: 17.8218%;" width="80"><span style="color: #1c1e3f;">Login process</span>

</td><td style="width: 20.3654%;" width="131"><span style="color: #1c1e3f;">Login code.</span>

</td><td style="width: 36.4946%;" width="317"><span style="color: #1c1e3f;">Hello!</span>

<span style="color: #1c1e3f;">Your login code: &lt;code&gt;</span>

<span style="color: #1c1e3f;">Regards,</span>

<span style="color: #1c1e3f;">&lt; NameOfClient &gt;</span>

</td><td style="width: 25.3182%;" width="179"><span style="color: #1c1e3f;">Standard AP email sent when portal operator entered correct email and password.</span>

</td></tr><tr><td style="width: 17.8218%;" width="80"><span style="color: #1c1e3f;">Reset password</span>

</td><td style="width: 20.3654%;" width="131"><span style="color: #1c1e3f;">Reset password to administration panel.</span>

</td><td style="width: 36.4946%;" width="317"><span style="color: #1c1e3f;">Hello!</span>

<span style="color: #1c1e3f;">You are receiving this mail because someone initialized password reset for your account. If it was not you, you can ignore this mail.</span>

<span style="color: #1c1e3f;">&lt;button to reset password&gt;</span>

<span style="color: #1c1e3f;">Regards,</span>

<span style="color: #1c1e3f;">&lt;NameOfClient&gt;</span>

</td><td style="width: 25.3182%;" width="179"><span style="color: #1c1e3f;">Standard Admin Panel email sent when portal operator uses "reset password" button on login page.</span>

</td></tr><tr><td style="width: 17.8218%;" width="80"><span style="color: #1c1e3f;">Additional password policy</span>

</td><td style="width: 20.3654%;" width="131"><span style="color: #1c1e3f;">Password expiration reminder.</span>

</td><td style="width: 36.4946%;" width="317"><span style="color: #1c1e3f;">Hello!</span>

<span style="color: #1c1e3f;">Your password will expire in &lt;NumerOfDays&gt; days. Please change your password to avoid losing access to the portal.</span>

<span style="color: #1c1e3f;">Regards,</span>

<span style="color: #1c1e3f;">&lt;NameOfClient&gt;</span>

</td><td style="width: 25.3182%;" width="179"><span style="color: #1c1e3f;">Related to additional policy to force password changes.</span>

</td></tr><tr><td style="width: 17.8218%;" width="80"><span style="color: #1c1e3f;">Inactive account policy</span>

</td><td style="width: 20.3654%;" width="131"><span style="color: #1c1e3f;">Inactive account reminder.</span>

</td><td style="width: 36.4946%;" width="317"><span style="color: #1c1e3f;">Hello!</span>

<span style="color: #1c1e3f;">Due to inactivity your account will be blocked in &lt;NumerOfDays&gt; days. Please log into the portal to avoid losing access to the portal.</span>

<span style="color: #1c1e3f;">Regards,</span>

<span style="color: #1c1e3f;">&lt;NameOfClient&gt;</span>

</td><td style="width: 25.3182%;" width="179"><span style="color: #1c1e3f;">Related to the additional policy of automatically deactivating unused accounts.</span>

</td></tr></tbody></table>

## <span style="color: #1c1e3f;">Additional features</span>

<span style="color: #1c1e3f;">This section focuses on additional functionality in the system. By default they are disabled, they can be enabled upon request during panel creation or panel version upgrade.</span>

### <span style="color: #1c1e3f;">Token blacklisting </span>

<span style="color: #1c1e3f;">For better security, a mechanism for blacklisting session tokens has been prepared. This makes it possible to prevent unauthorized access to the portal and data using the session token of a logged out user (if the token life has not expired yet). </span>

<span style="color: #1c1e3f;">It should be noted that during the logout process the session token in the user's browser is destroyed, regardless of whether the blacklisting mechanism is enabled. Also, closing the browser deletes the token.</span>

<span style="color: #1c1e3f;">However, a theoretical scenario is that the user's token is intercepted and used for unauthorized access to the system. Access possible for the lifetime of the token. </span>

<span style="color: #1c1e3f;">When this mechanism is enabled, the token is blacklisted (and therefore prevented from further use despite the active life time) and each query to the backend (API Admin Panel) checks whether the token used by the user is not blacklisted. </span>

### <span style="color: #1c1e3f;">Session extension popup </span>  


<span style="color: #1c1e3f;">Sometimes the session time may not be sufficient to perform the portal user's operations. For this reason a mechanism has been created to ask the user if there is a need to extend the current session. </span>

  
<span style="color: #1c1e3f;">It should be noted that by default when half of the session time elapses and the user performs some action (moves to another tab, clicks a button) the session time is renewed. By session time renewal it is meant that a new session token is assigned to the user and the session time counter is restored to its default, maximum value.</span>

  
<span style="color: #1c1e3f;">When the mechanism is active at a certain time before the end of the session the user is asked if he needs more time (screen below). If user chooses affirmative answer, there is assigned a new session token and the session time is restored to the default, maximum. Selecting no closes the dialog. Not selecting an option will close the dialog when the session time expires and the user is logged out.</span>

<span style="color: #1c1e3f;">[![image-1651747543966.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651747543966.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651747543966.png)</span>

### <span style="color: #1c1e3f;">Tooltip for table row values</span>

<span style="color: #1c1e3f;">Depending on the resolution and screen size, the appearance of each screen may vary cosmetically. Admin Panel is responsive but values in tables can be of different length (up to 255 characters). It is not always possible to display the entire value in a single table cell. For this reason, a mechanism was created to display a tooltip for table cell values. </span>

  
<span style="color: #1c1e3f;">The default mechanism is to show the user as many characters as fit into the table cell - depending on the screen size of the device. It is possible in this case to copy the whole, valid value of the cell. Unfortunately it is not possible to preview it by user in simple way - it is necessary to copy cell value e.g. to text document to know its characters that do not fit in the cell. </span>

  
<span style="color: #1c1e3f;">By enabling described mechanism the tooltip is displayed when the user hovers the mouse over a particular value in the table and waits for 1 second without moving the mouse. The user can easily see the entire value of such a variable.</span>  
<span style="color: #1c1e3f;"> </span>

<span style="color: #1c1e3f;">[![image-1651747568528.png](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/scaled-1680-/image-1651747568528.png)](https://bookstack.verestro.dev/uploads/images/gallery/2022-05/image-1651747568528.png)</span>

### <span style="color: #1c1e3f;">Password policies </span>

<span style="color: #1c1e3f;">As it is extremely important for us to ensure the security of the portal operators' data and the data to which the operators have direct access, we are providing an additional policies for passwords.</span>

#### <span style="color: #1c1e3f;">Force password change </span>

<span style="color: #1c1e3f;">The first of the additional policies that can be used on the admin instance of the panel is to force the operators to change the password every specified number of days. In the case of inactivity on the part of the operator the account is locked - its unlocking is possible through a password reset mechanism. Before the account is blocked, an email notification is sent about the need to change the password - the time when the email is to be sent is configurable. </span>

#### <span style="color: #1c1e3f;">Force unique password </span>

<span style="color: #1c1e3f;">A second, additional safeguard in password security policies is to prevent a user from setting a password that they have already used in the past. With this mechanism, it is possible to configure how many previous passwords should be excluded from reuse. Of course, for data security reasons, previously used passwords are not stored but only their unique hash, which is used for uniqueness comparison. </span>

#### <span style="color: #1c1e3f;">Deactivate inactive accounts</span>

<span style="color: #1c1e3f;">In order to ensure the safety of the data contained on the portal, an automatic deactivation mechanism for unused accounts has been created. It allows to define the time without logging in after which the operator will be blocked. Unblocking the account is possible by using the password reset mechanism, which is tantamount to confirming your identity and access to your e-mail address.</span>

### <span style="color: #1c1e3f;">Handling an unavailable service </span>

<span style="color: #1c1e3f;">As Admin Panel consists of multiple services (as a reminder, individual services are responsible for the corresponding sections in the side menu), it is important to ensure the availability of the application when any of the individual components is not working (for example, due to a scheduled maintenance outage). For this reason, a mechanism for graying out unavailable services in the side menu has been implemented and enabled by default. If any product/service is temporarily unavailable, the portal operator can still use the functionality provided by the other services. In the case that the unavailable service becomes operational, the section becomes available again after refreshing the page. </span>