Webitel: Documentation
Webitel: Documentation
Breadcrumbs

Global variable

1. Description

Directory for saving variables in encrypted form.

It consists of the following elements:

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

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

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

  4. Registry (Fig.1(4));

  5. Pagination (Fig.1(5)).

Global variable page.png
Fig. 1. Global variable page

1.1. Creation tool

Use the Add button to create a new Global variable (Fig.1(1)). After clicking the button, the New global variable modal window (Fig.2) opens. 

New global variable modal window.png
Fig. 2.  New global variable modal window

The New parameter modal window consists of the following:

  • Key - the key of the variable;

  • Value - the value of the variable;

  • Encrypted - switch is responsible for encryption of data entered in the Value field;

  • Save button - clicking the button creates a new global variable if all data are entered;

  • Cancel button - clicking on the button closes the modal window without saving data.

1.2. Search field

The search is performed on the Key column.

It consists of an input field and a close button ( image-20241218-160723.png ) 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. Refresh button

Updating the register table is performed by clicking on the refresh button - image-20241220-111256.png .

1.4. 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. Parameter;

  3. Value;

  4. Editing tool;

  5. Removal tool.

1.4.1. Checkbox

Used to select one or more entries. An additional removal tool appears next to the search field 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 ( image2024-3-7_15-21-56.png ) 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.

Confirm deletion modal window.png


Fig. 3. Confirm deletion modal window

1.4.2. Parameter

The parameter names are displayed here.

1.4.3. Value

The parameter value is displayed here.

1.4.4. Editing tool

When you click the image2024-3-28_20-1-8.png?version=1&modificationDate=1711648874213&cacheVersion=1&api=v2&width=20  button, the Edit parameter modal window opens (Fig.3), where you can make changes.

Edit global variable modal window.png
Fig. 4. Edit global variable modal window

1.4.5. Removal tool

It is used to remove an object with confirmation through a modal window. A modal confirmation window appears after clicking the image-20241231-121409.png 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.

Confirm deletion modal window.png

Fig. 5. Confirm deletion modal window

1.5. 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  Global variable

Goal

Create a  Global variable

Preconditions

  1. Access to the Admin application;

  2. Access to the Global variable section in the Admin application;

  3. Permission to create in the Global variable section;

  4. Role permissions - Manage global variables.

Steps

  1. Click the Add button. The New parameter modal window opens.

  2. Enter data. The Save button becomes active.

  3. Click the Save button.

Result

The modal window closes. Global variable is created

2.2. Delete a Global variable

Goal

Delete a Global variable

Preconditions

  1. Access to the Admin application;

  2. Access to the Global variable section in the Admin application;

  3. Permission to select and delete in the Global variable section;

  4. Role permissions - Manage global variables;

  5. The presence of at least one Global variable.

Steps

Find the Global variable you want to delete in the registry;

  1. Click on the delete button - %D0%A1%D0%BD%D0%B8%D0%BC%D0%BE%D0%BA%20%D1%8D%D0%BA%D1%80%D0%B0%D0%BD%D0%B0%202024-03-13%20181713.png?version=1&modificationDate=1711648985807&cacheVersion=1&api=v2&width=20 . A modal window opens to confirm the deletion;

  2. Click the Yes button.

Result

The modal window closes. The Global variable is removed.

2.3. Delete several Global variables

Goal

Delete several Global variables

Preconditions

  1. Access to the Admin application;

  2. Access to the Global variable section in the Admin application;

  3. Permission to select and delete in the Global variable section;

  4. Role permissions - Manage global variables;

  5. The presence of at least one Global variable.

Steps

  1. Find the Global variables 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 Yes button.

Result

The modal window closes. Global variables are removed.

2.4. Edit a Global variable

Goal

Edit a Global variable

Preconditions

  1. Access to the Admin application;

  2. Access to the Global variable section in the Admin application;

  3. Permission to edit in the Global variable section;

  4. Role permissions - Manage global variables;

  5. The presence of at least one Global variable.

Steps

  1. Find the Global variable you want to edit in the registry.

  2. Click on the edit button in the entry of this Global variable. The Edit global variable modal window opens.

  3. Make changes.

  4. Click the Save button.

Result

The modal window closes. Data saved.