Working with Access#
Access Localization#
Access supports to localizations:
- English;
- Russian.
Press button рус|eng to change localization (Figure 6).

Access automatically refresh webpage and show english localization (Figure 7)

Для возврата к русскому интерфейсу нажмите на кнопку рус|eng еще раз.
User roles and permissions#
There is only one role available in Access — "administrator" (Table 9).
Table 3. List of available sections and permissions
Role | Section | Permission |
---|---|---|
Administrator | Services | Add/Edit/Delete services; |
Controllers | Add/Edit/Delete controllers; | |
Devices | Add/Edit/Delete devices; | |
Pipelines | Add/Edit/Delete pipeline; | |
Logs | View logs; | |
Export of logs |
Adding an account#
All user accounts are created by the administrator of the Access.
For a complete description of the user creation process, see the Administrator Manual.
Authorization in Access#
The user accesses Access by logging into a web browser to the site.
Open a web browser and go to the server where the Access was installed. Address example: http://10.16.6.241:9092/services.
The link to enter the Access web interface must be requested from the administrator.
The first time you sign in to Access, the Services page is launched (Figure 8).
Unauthorized users can only view created services, controllers, devices and logs.

For authorization in the Access, click on the to the right of the user's avatar and click on the Sign in button (Figure 9).

When you log in to Access, an authorization form is launched (Figure 10).
To authorize in the Access, enter your credentials (login and password) in the appropriate fields and click the Sign in button.

The login and password are requested from the administrator of the Access.
When entering the Access, the user is taken to the Services page (Figure 11), where he can configure and add the components of the Access.

Signing out of the Access account#
To sign out of the account, click on the to the right of the user's avatar and click on the Logout button (Figure 12).

After clicking on the Logout button, the user is redirected to a page with a general view of the Access interface in a web browser, where he will not be able to configure and add Access components.
Access sections#
The user interface of the Access contains 5 sections in the main menu and 4 functions in the drop-down menu (Figure 13).
The main menu consists of the following sections:
- Services allows user to view and create services;
- Controllers allows user to view and create controllers;
- Devices allows user to view and create devices;
- Pipelines allows user to view and create pipelines;
- Logs allows user to view logs;
The drop-down menu consists of the following functions:
- Import settings is a function for importing settings;
- Export settings is a function for exporting settings;
- Reset settings reset all settings;
- Documentation - open HTML documentation.
To expand the drop-down menu, click on the to the right of the user's avatar.

Services usage#
The Services section is designed to configure existing and add new services (Figure 14).

Creating a service#
To create a new service, do the following:
1․ click on the Add service button (Figure 15);

2․ a form for creating a service will open, in which you should select the type of service (Figure 16);

3․ to expand the drop-down menu, click on the
on the right and select the required type of service (Figure 17);

4․ a form will open for filling in the service settings, in which you should add the necessary Parameters (Figure 18);
The Parameters for configuring each service are different, see the Services section.

to get information about configurable Parameters, click on the Documentation button in the upper left corner (Figure 19);

Pop-up window will display information describing the required Parameters for creating a service (Figure 20);

5․ after filling in the service Parameters, click on the Save button (Figure 21).

After successful creation of the service, the message Service has created successfully will appear in the upper left corner of the screen (Figure 22).

Upon successful creation, the new service should appear in the list of available services in the Services section (Figure 23).

General information about service#
The available services are displayed on the general view page of the section (Figure 24).

General information about the service is located in the service description window (Figure 25).

- 1 — service status;
- 2 — service name;
- 3 — service type;
- 4 — general information about the service;
- 5 — additional information about service Parameters.
For more information about the Parameters of the service, hover over and information will appear in a pop-up window (Figure 26).

Editing a service#
To change the Parameters of an available service, do the following:
1․ click on the for the selected service (Figure 27);

2․ a form for editing the service will open, in which the necessary changes should be made(Figure 28).
The editing form for each service contains various Parameters, see the Services section.
3․ click on the Save button.

After successfully editing the service, the message Service has been updated will appear in the upper left corner of the screen (Figure 29).

Restarting a service#
To restart the service, click the for the selected service (Figure 30).

After a successful restart of the service, the message Service has been restarted will appear in the upper left corner of the screen (Figure 31).

Removing a service#
To remove an available service, do the following:
1․ click on the for the selected service (Figure 32);

2․ a form for editing the service will open, in which you should click on the Delete button in the lower left corner (Figure 33).

After successfully deleting the service, the message Service has been removed will appear in the upper left corner of the screen (Figure 34).

Upon successful removal, the service will disappear from the list of available services in the Services section.
Deleting a service also deletes its child components.
The child components are the corresponding controllers:
- Apacs service — ApacsController;
- PercoWEB service — PercoController;
- Salto service — SaltoController;
- Strazh service — StrazhController.
Controllers usage#
The Controllers section is designed to configure existing and add new controllers (Figure 35).

Creating a controller#
To create a controller, do the following:
1․ click on the Add controller button (Figure 36);

2․ a form for creating a controller will open, in which you should select the type of controller (Figure 37);

To expand the drop-down menu, click on the on the right and select the required type of controller (Figure 38);

3․ a form will open to fill in the controller settings, in which you should add the necessary Parameters (Figure 39);
The Parameters for configuring each controller are different, see the Controllers section.

To get information about configurable Parameters, click on the Documentation button in the upper left corner (Figure 40);

A pop-up window will display information describing the required Parameters for creating a controller (Figure 41);

4․ After filling in the controller Parameters, click on the Save button (Figure 42).

After successfully creating the controller, the message Controller has been created succsesfully will appear in the upper left corner of the screen (Figure 43).

Upon successful creation, the new controller will be displayed in the list of available controllers in the Controllers section (Figure 44).

General information about the controller#
The available controllers are displayed on the general view page of the section.
General information about the controller is located in the window with a description of the controller (Figure 45).

- 1 — controller status;
- 2 — controller name;
- 3 — controller type;
- 4 — general information about the controller;
- 5 — additional information about controller Parameters.
For more information about the Parameters of the controller, hover over and information will appear in a pop-up window (Figure 46).

Controller grouping#
When creating a controller, the user can create/select a group of controllers.
By default, controllers are assigned to the "No group" group.
Controller grouping allows you to visually separate controllers by features that interest the user: location, type, manufacturer, etc.
To create a group in the controller parameters editing window, click on the group input field, specify the group name, click Create (Figure 47) and save the controller changes.
It is not recommended to enter more than 30 characters.

The controller is placed in the group (Figure 48).

To add a controller to an existing group, go to controller editing, select the desired group in the group drop-down list (Figure 49) and save the controller changes.

Editing the available controllers#
To edit the Parameters of an available controller, do the following:
1․ click on the for the selected controller (Figure 50);

2․ a form for editing the controller will open, in which you should make the necessary changes (Figure 51).
The edit form for each controller contains various Parameters, which are described in detail in the relevant paragraphs of subsection 3.2;
3․ click on the Save button.

After successfully editing the controller, the message Controller has been updated will appear in the upper left corner of the screen (Figure 52).

Restarting the available controllers#
To restart the controller, click the for the selected controller (Figure 53).

After a successful restart of the controller, the message Controller has been restarted will appear in the upper left corner of the screen (Figure 54).

Removing an available controller#
To remove an available controller, do the following:
1․ click on the for the selected controller (Figure 55);

2․ a form for editing the controller will open, in which you should click on the Delete button in the lower left corner (Figure 56).

After successfully deleting the controller, the message Controller has been removed will appear in the upper left corner of the screen (Figure 57).

Upon successful removal, the controller will disappear from the list of available controllers in the Controllers section.
Devices usage#
The Devices section is designed to configure existing and add new devices (Figure 58).

Creating a device#
To create a new device, do the following:
1․ click on the Add device button (Figure 59);

2․ a form for creating a device will open, in which you should select the type of device (Figure 60);

To expand the drop-down menu, click on the on the right and select the required type of device (Figure 61);

3․ a form will open to fill in the device settings, in which you should add the necessary Parameters (Figure 62);
The Parameters for configuring each device are different, see Devices

To get information about configurable parameters, click on the Documentation button in the upper left corner (Figure 63);

A pop-up window will display information describing the required Parameters for creating a device (Figure 64);

4․ after filling in the device Parameters, click on the Save button (Figure 65).

After successfully creating the device, the message Device has been created will appear in the upper left corner of the screen (Figure 66).

Upon successful creation, the new device will be displayed in the list of available devices in the Devices section (Figure 67).

Device grouping#
When creating a device, the user can create/select a device group.
By default, devices are assigned to the "No group" group.
Device grouping allows you to visually separate devices by features that interest the user: location, type, manufacturer, etc.
To create a group in the device parameters editing window, click on the group input field, specify the group name, click Create (Figure 68) and save the device changes.
It is not recommended to enter more than 30 characters.

The device is placed in the group (Figure 69).

To add a device to an existing group, go to editing the device, select the desired group in the group drop-down list (Figure 70) and save the device changes.

General information about device#
The available devices are displayed on the general view page of the section.
General information about the device is located in the window with a description of the device (Figure 71).

- 1 — device status;
- 2 — device name;
- 3 — device type;
- 4 — general information about the device;
- 5 — additional information about device Parameters.
For more information about the Parameters of the device, hover over and information will appear in a pop-up window (Figure 72).

Editing device#
To edit the Parameters of an available device, do the following:
1․ click on the
for the selected device (Figure 73);

2․ a form for editing the device will open, in which you should make the necessary changes (Figure 74).
The edit form for each device contains various Parameters, see Devices;
3․ click on the Save button.

After successfully editing the device, the message Device has been updated will appear in the upper left corner of the screen (Figure 75).

Restarting device#
To restart the device, click the for the selected device (Figure 76).

After a successful restart of the device, the message Device has been restarted will appear in the upper left corner of the screen (Figure 77).

Removing device#
To remove an available device, do the following:
1․ click on the for the selected device (Figure 78);

2․ a form for editing the device will open, in which you should click on the Delete button in the lower left corner (Figure 79).

After successfully deleting the device, the message Device has been removed will appear in the upper left corner of the screen (Figure 80).

Upon successful removal, the device will disappear from the list of available devices in the Devices section.
Pipelines usage#
The Pipelines section is designed to configure existing and add new pipelines (Figure 81).

Creating pipeline#
To create pipeline, do the following:
1․ click on the Add pipeline button (Figure 82);

2․ a form for creating a pipeline will open, in which you should select the type of pipeline (Figure 83);

To expand the drop-down menu, click on the on the right and select the required type of pipeline (Figure 84);

3․ a form will open to fill in the pipeline settings, in which you should add the necessary Parameters (Figure 85);
The Parameters for configuring each pipeline are different, see Pipelines

To get information about configurable Parameters, click on the Documentation button in the upper left corner (Figure 86);

A pop-up window will display information describing the required Parameters for creating a pipeline (Figure 87);

4․ after filling in the pipeline Parameters, click on the Save button (Figure 88).

After successfully creating the pipeline, the message Pipeline has been created will appear in the upper left corner of the screen (Figure 89).

Upon successful creation, the new pipeline will be displayed in the list of available pipelines in the Pipelines section (Figure 90).

General information about pipeline#
The available pipelines are displayed on the general view page of the section (Figure 91).

General information about the pipeline is located in the window with a description of the pipeline (Figure 92).

- 1 — pipeline status;
- 2 — pipeline name;
- 3 — pipeline type;
- 4 — general information about the pipeline;
- 5 — additional information about pipeline Parameters.
For more information about the Parameters of the pipeline, hover over and information will appear in a pop-up window (Figure 93).

Editing pipelines#
To edit the Parameters of pipeline, do the following:
1․ click on the for the selected pipeline (Figure 94);

2․ a form for editing the pipeline will open, in which you should make the necessary changes (Figure 95).
The edit form for each pipeline contains various Parameters, see Pipelines;
3․ click on the Save button.

After successfully editing the pipeline, the message Pipeline has been updated will appear in the upper left corner of the screen (Figure 96).

Restarting the pipeline#
To restart the pipeline, click the for the selected pipeline (Figure 97).

After a successful restart of the pipeline, the message Pipeline has been restarted will appear in the upper left corner of the screen (Figure 98).

Removing an available pipeline#
To remove an available pipeline, do the following:
1․ click on the for the selected pipeline (Figure 99);

2․ a form for editing the pipeline will open, in which you should click on the Delete button in the lower left corner (Figure 100).

After successfully deleting the pipeline, the message Pipeline has been removed will appear in the upper left corner of the screen (Figure 101).

Upon successful removal, the pipeline will disappear from the list of available pipelines in the Pipelines section.