Devices

Owned by Olesya Tantsyura
Last updated: Mar 12, 2024
7 min read

1. Description

The page is intended for creating Devices and displays information on all Devices in the system: Device - registration data for SIP phones, WebRTC.

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. Devices page

1.1. Creation tool

Use the Add button to create a new Device (Fig.1(1)). The New device modal window (Fig.2) opens after clicking the button. The following types of Devices are available:

  • Device - SIP phone registration data;
  • Hot desking device  - the ability to use one SIP phone by several Users.

Fig. 2. New device modal window 

1.1.1. Device

You can only register for a User who has a license.

If the Device is unlinked from the User or the license has expired, then its registration data will become invalid, and the Device will not be registered.

If the User was created from a concurrent license, the Device will not be registered until the User logs in.

Select Device in the New device modal window and click the Add button to create a new Device. The General tab opens after clicking the button.

When creating a Device, the following tabs are available for filling:

1.1.2. Hot desking device

The device that will always register, but cannot call anywhere. It is not bound to a license. It can only register. It does not have an extension number when not associated with the User. You can bind the User through the API or through the service number:

  • *11 */extension/" - bind with the User;
  • *11 - unbind

Select the Hot decking device in the New device modal window and click the Add button to create a new Hot desking device. The General tab opens after clicking the button. 

When creating a Hot desking device, the following tabs are available for filling:

 You can open tabs for an existing Device through the entries editing tool (see paragraph 1.5.7).

1.2. Search field

The search is performed on the Name column.

It consists of an input field and a close button () displayed when the cursor is placed in the input field. To search by part of a word or a number, use the * symbol. You can also use the * character to replace any number of characters.

1.3. Import tool

Use the import button (Fig.1(3)) to load Devices 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 opens (Fig.3).

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.3(1));
  2. Preview block (Fig.3(2));
  3. Selection block (Fig.3(3)).

Fig. 3. 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 lines from the table that is being imported.

1.3.1.3. Selection block

Select the column names (used in the .csv file) in the drop-down lists whose data must match the parameter for which the selection is being made. For example, select account in the account drop-down list.

Consists of fields:

  • account - login of a Device;

  • name - the name of a Device;

  • vendor - manufacturer;

  • model - model of a Device; 

  • mac - MAC address, unique identifier;

  • ip - IP address;

  • password - password of a Device.

If you do not set a password, it will be the same as the account.

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

Updating the register table is performed by clicking on the refresh button -

(Fig.1 (4)).

1.5. Registry

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

  1. Checkbox;
  2. Name;
  3. Auth ID;
  4. User;
  5. Presence;
  6. History tool;
  7. Editing tool;
  8. Removal tool.

If there is no entry on the page, then an additional Add button is displayed in the register, the functionality of which duplicates the Add button in paragraph 1.1.

1.5.1. Checkbox

Used to select one or more entries. An additional removal tool appears after selecting one or more entries. Information about the number of entries chosen for deletion appears when you hover over this tool. When you click on it, a modal confirmation window appears. It contains the Yes, No, and close () buttons. Clicking the Yes button deletes the entries. Clicking the No button closes the modal window, and the entries are not deleted.

All records on the page will be selected if you select the checkbox in the header.

Fig. 4. Confirm deletion modal window

1.5.2. Name

The name of the Device is displayed here.

1.5.3. Auth ID

Login of a Device. It is specified when creating a Device and issued automatically when creating a Hot desking device.

1.5.4. User

The User who can use this Device is displayed.

1.5.5. Presence

Displays the status of the Device at the time of entering or refreshing the Devices page.

There are:

  • Not registered - the Device is not connected;

  • Registered - the Device is connected and ready to use.

1.5.6. History tool

After clicking the  button, the Device history modal window opens (Fig. 5).

Fig. 5. Device history modal window

1.5.7. Editing tool

The General tab opens after clicking on this button. You can change the object's data and go to other tabs for editing.

1.5.8. Removal tool

It is used to remove an object with confirmation through a modal window. A modal confirmation window appears after clicking the button. Clicking the Yes button - deletes the object and the entry. Clicking the No button closes the modal window, and the object is not deleted.

Fig. 6. Confirm deletion modal window

1.6. Pagination

It consists of the Rows per page field, which indicates the number of entries (it is possible to set from 1 to 1000) per page, and forward and backward buttons for switching pages.

2. Opportunities

2.1. Create a new Device

Goal

Create a new Device

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to create in the Devices section.

Steps


  1. Click the Add button. The New devices modal window opens.
  2. Select a Device.
  3. Click the Add button. The General tab opens.
  4. Enter data. The Save button becomes active.
  5. Click the Save button. Access to the Permissions tab is opened.
  6. Fill in the required data in the other tabs.
  7. Click the Save button.

Result

Data saved. The Device is created.

2.2. Create a new Hot desking device

Goal

Create a new Hot desking device

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to create in the Devices section.

Steps


  1. Click the Add button. The New devices modal window opens.
  2. Select a Hot desking device.
  3. Click the Add button. The General tab opens.
  4. Enter data. The Save button becomes active.
  5. Fill in the required data in other tabs.
  6. Click the Save button.

Result

Data saved. The Hot desking device is created.

2.3. Delete a Device/Hot desking device

Goal

Delete a Device/Hot desking device

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to select and delete in the Devices section;
  4. The presence of at least one Device/Hot desking device.

Steps


  1. Find the Device/Hot desking device you want to delete in the registry;
  2. Click on the delete button - . A modal window opens to confirm the deletion;
  3. Click the Delete button.

Result

The modal window closes. Device/Hot desking device is deleted.

2.4. Delete several Devices

Goal

Delete several Devices

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to select and delete in the Devices section;
  4. The presence of at least one Device.

Steps


  1. Find the Devices you want to delete in the registry. 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. The Devices are deleted.

2.5. Edit a Device/Hot desking device

Goal

Edit a Device/Hot desking device

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to edit in the Devices section;
  4. The presence of at least one Device.

Steps


  1. Find the Device you want to edit in the registry.
  2. Click on the edit button in the entry of this Device. The General tab opens.
  3. Open the tab you need.
  4. Make changes.
  5. Click the Save button.

Result

Data saved.

2.6. Add Device/Hot desking device by importing a .csv file

Goal

Add Device/Hot desking device by importing a .csv file

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to select in the Devices section;
  4. The .csv file with Devices data.

Steps


  1. Click the import CSV file button . The file selection window opens.
  2. Select a .csv file with Devices data. Click the Open button (the file selection window may differ depending on the OS). The Import CSV modal window opens.
  3. Сhange the punctuation mark in the Separator field, if necessary.
  4. Select the column names (used in the .csv file) in the drop-down lists whose data must match the parameter for which the selection is made. The Save button becomes active.
  5. Click the Save button.

Result

The modal window is closed. The Devices from the .csv file are added to the registry.

2.7. View device history

Goal

View device history

Preconditions
  1. Access to the Admin application;
  2. Access to the Devices section in the Admin application;
  3. Permission to select in the Devices section;
  4. The presence of at least one Device.

Steps


  1. Find the Device for which you want to view history.
  2. Click the  button.

Result

The Device history modal window opens.