Users

Owned by Olesya Tantsyura
Last updated: Aug 05, 2024
6 min read

1. Description

The page is designed for creating Users. It displays information about all Users in the domain.

It consists of the following elements:

  1. Creation tool (Fig.1(1));

  2. Search field (Fig.1(2));

  3. Import tool (Fig.1(3));

  4. Refresh button (Fig.1(4));

  5. Registry (Fig.1(5));

  6. Pagination (Fig.1(6)).

Fig. 1. Users page

1.1. Creation tool 

Use the Add button (Fig.1 (1)) to create a new object. Access to the General tab opens after clicking. You can open tabs for an existing User with the entries editing tool (see paragraph 1.5.7).

Tabs:

1.2. Search field

The search is performed on the Name column.

Consists of an input field and a close button (), which is displayed when you enter data in the input field.

You can create a search query in regex format, and the system will display the results that match it.

1.3. Import tool

Use the import button (Fig.1(3)) to load Users from a CSV file. Hovering over this button will display - Upload. Clicking the button () opens a file selection window.

Select the desired file on your Device and click the Open button (the file selection window may differ depending on the OS). The Import CSV  modal window will open (Fig.2).

The import document must have headers!

1.3.1. Import CSV  modal window 

It is designed to configure data import.

It consists of the following elements:

  1. Configuration block (Fig.2(1));

  2. Preview block (Fig.2(2));

  3. Selection block (Fig.2(3)).

Fig. 2. Import CSV modal window 

1.3.1.1. Configuration block

The Skip headers checkbox allows you to skip headers. At the moment, the parameter is not available for changes.

The Char set field is used to select the encoding. At the moment, the parameter is not available for changes. UTF-8 is used by default.

In the Separator field, enter the punctuation mark used in the imported file. The comma is used by default

1.3.1.2. Preview block

This block displays the names of the fields and a few filled rows from the table being imported.

1.3.1.3. Selection block

From the drop-down lists, select the names of the columns (used in the CSV file) whose data should correspond to the parameter for which the selection is being made. For example, select Name in the username drop-down list (Fig.3).

Fig. 3. Customize CSV file import

Consists of fields:

  • Username - User's unique login;

  • name - Username;

  • extension - User extension number;

  • email - User's email address.

The Save button becomes active after setting the required fields. Required fields are marked with *. The modal window closes after clicking the Save button, and entries from the CSV file are added to the registry.

1.4. Refresh button

(Fig.1 (4)).

1.5. Registry

The registry is a list of entries of existing objects in this section, each of which consists of a set of fields:

  1. Checkbox;

  2. Name;

  3. Status;

  4. Login;

  5. Extensions;

  6. DnD;

  7. Editing tool;

  8. Removal tool.

1.5.1. Checkbox

Fig. 4. Confirm deletion modal window

1.5.2. Name

The names of the Users are displayed here.

1.5.3. Status

This column displays four statuses (badges):

  • Web;

  • SIP;

  • Dlg;

  • DnD.

Badges have two states: 

  • active - yellow color ,

  • inactive - gray color .

The passive state is displayed by default.

Web - a WebSocket connection has been established (exchange of events). It becomes active when the WebSocket connection is opened - the User is logged into the Workspace.

SIP - a SIP connection has been established. Becomes active in the following cases:

  • Registration of the Device to this User via the SIP protocol;

  • The User is logged into the Workspace and has a Default Device set.

Dlg - the state 'in conversation'. Becomes active at the moment when a call occurs;

DnD - displays 'Do Not Disturb' mode. It becomes active when this mode is set. You can install it in:

  • register of the User records (see clause 1.5.6);

  • Workspace.

1.5.4. Login

This column displays User logins in the system.

1.5.5. Extensions

This column displays the extension numbers of Users.

1.5.6. DnD

Dnd - Do Not Disturb.
Use the switch in this column to enable/disable DnD.  The DnD badge in the Status column is displayed as active or inactive (Fig.5), respectively.

Fig. 5. DnD

1.5.7. Editing tool

1.5.8. Removal tool

Fig. 6. Confirm deletion modal window

1.6. Pagination

2. Opportunities

2.1. Create a new User

Goal

Create a new User

Goal

Create a new User

Preconditions

  1. Access to the Admin application;

  2. Access to the Users section in the Admin application;

  3. Permission to create in the Users section.

Steps

 

  1. Click the Add button. The General tab opens.

  2. Enter data. The Save button becomes active.

  3. Click the Save button. Access to the Permissions tab opens.

  4. Enter the required data.

  5. Click the Save button

Result

Data saved. The User is created.

2.2. Delete a User

Goal

Delete a User

Goal

Delete a User

Preconditions

  1. Access to the Admin application;

  2. Access to the Users section in the Admin application;

  3. Permission to select and delete in the Users section;

  4. The presence of at least one User.

Steps

 

  1. Find the User you want to delete in the registry;

  2. Click the delete button -

    . A modal window opens to confirm the deletion;

  3. Click the Delete button.

Result

The modal window closes. The User is removed.

2.3. Delete several Users

Goal

Delete several Users

Goal

Delete several Users

Preconditions

  1. Access to the Admin application;

  2. Access to the Users section in the Admin application;

  3. Permission to select and delete in the Users section;

  4. The presence of at least one User.

Steps

 

  1. Find the Users you want to delete in the registry entries. Select them using the checkbox;

  2. Click on the delete button at the top of the registry. A modal window opens to confirm the deletion.

  3. Click the Delete button.

Result

The modal window closes. Users are removed.

2.4. Edit a User

Goal

Edit a User

Goal

Edit a User

Preconditions

  1. Access to the Admin application;

  2. Access to the Users section in the Admin application;

  3. Permission to edit in the Users section;

  4. The presence of at least one User.

Steps

 

  1. Find the User you want to edit in the registry entries.

  2. Click on the edit button in the entry of this User. The General tab opens.

  3. Open the tab you need.

  4. Make changes.

  5. Click the Save button.

Result

Data saved.

2.5. Enable/disable DnD status for a User

Goal

Enable DnD status for a User

Goal

Enable DnD status for a User

Preconditions

  1. Access to the Admin application;

  2. Access to the Users section in the Admin application;

  3. Permission to select in the Users section;

  4. The presence of at least one User.

Steps

 

  1. Find the User who needs to change status.

  2. Move the switch in the DnD column to the active position.

Result

The DnD indicator in the Status column becomes active. The User is in DnD status.

2.6. Add Users by importing a CSV file

Goal

Add Users by importing a CSV file

Goal

Add Users by importing a CSV file

Preconditions

  1. Access to the Admin application;

  2. Access to the Users section in the Admin application;

  3. Permission to select in the Users section;

  4. CSV file with User data.

Steps

 

  1. Click the import CSV file button

    . The Import CSV modal window opens.

  2. Сhange the punctuation mark in the Separator field, if necessary.

  3. Select the column names (used in the CSV file) in the drop-down lists whose data should match the parameter for which the selection is being made. For example, select login in the Username drop-down list (Fig.3). The Save button becomes active.

  4. Click the Save button.

Result

The modal window is closed. The Users from the CSV file have been added to the registry.