Working with Service

General settings of the Service

Service Localization

Service supports to localizations:

• English;
• Russian.

Press button рус|eng to change localization (Figure 1).

Figure 1. Interface localization

Service automatically refresh webpage and show english localization (Figure 2)

Figure 2. English interface

User roles and permissions

There is only one role available in Access — "administrator". The description of the "administrator" permissions is presented in Table 3.

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 Service.

A new user needs to request a login and password from the administrator of the Service.

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 3).

Unauthorized users can only view created services, controllers, devices and logs.

Figure 3. General view of the Access interface in a web browser

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

Figure 4. Login to user account

When you log in to Access, an authorization form is launched (Figure 5).

To authorize in the Access, enter your credentials (login and password) in the appropriate fields and click the Sign in button.

Figure 5. Authorization form

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 6), where he can configure and add the components of the Access.

Figure 6. Screen of the page when the user is authorized in 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 7).

Figure 7. Signing out of a user account

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.

Full name variables

The fields for entering successful_pass_message_template allow you to display the full name of recognized faces:

If the full name has more than 30 characters, then the first name will be shortened automatically to Last name with initials.

• {fullname} - full name of the person from the "Information" field (user_data). Ivanov Petr Sergeevich;
• {lastname} - Last name of the person. This is the first word from the "Information" field. Ivanov;
• {firstname} - The name of the person. This is the second word from the "Information" field. Peter;
• {middlename} - Middle name of the person. This is the third word from the "Information" field. Sergeevich;
• {short_lastname} - The first letter of the last name with a dot at the end. I.;
• {short_firstname} - The first letter of the name with a dot at the end. P.;
• {short_middlename} - The first letter of the patronymic with a dot at the end. S. .

To display the message on the terminal screen, it is required to specify the desired variants of full name in the successful_pass_message_template and unsuccessful_pass_message fields.

An example of using full name variables:

Record in settings	Output on terminal
Welcome, {fullname}!	Welcome, Ivanov Petr Sergeevich!
Welcome, {firstname} {middlename}!	Welcome, Peter Sergeevich!

Service sections

The user interface of the Access contains 5 sections in the main menu and 4 functions in the drop-down menu (Figure 8).

The main menu consists of the following sections: Services, Controllers, Devices, Pipelines, and Logs.

The drop-down menu consists of the following functions: Import settings, Export settings, Save settings, and Delete setting.

To expand the drop-down menu, click on the to the right of the user's avatar.

• 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;
• Active setting - list of available settings;
• Import settings is a function for importing settings;
• Export settings is a function for exporting settings;
• Save settings is a function that allows user to save a new setting or save data from the active setting to a new setting, for later work with a new saved setting;
• Remove setting is function that allows user to delete the active setting;
• Documentation - open online documentation.

Figure 8. Menu sections and functions available to the administration

Services

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

Figure 9. Services section

Creating a new service

To create a new service, do the following:

• click on the Add service button (Figure 10);

Figure 10. Creating a new service

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

Figure 11. Service creation form

• to expand the drop-down menu, click on the

  
  

  Figure 12. Arrow down

on the right and select the required type of service (Figure 12);

Figure 13. Selecting the type of service to create

• a form will open for filling in the service settings, in which you should add the necessary Parameters (Figure 13);

The Parameters for configuring each service are different. For a detailed description of the Parameters for each service, see the Services section.

Figure 14. Form for filling in the service settings

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

Figure 15. Documentation for the created service

• a pop-up window will display information describing the required Parameters for creating a service (Figure 15);

Figure 16. Pop-up window with the required service Parameters

• after filling in the service Parameters, click on the Save button (Figure 16).

Figure 17. Saving when creating a service

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

Figure 18. Service creation confirmation

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

Figure 19. Displaying a new service

General information about the available service

The available services are displayed on the general view page of the section (Figure 19).

Figure 20. Available services

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

Figure 21. Main Parameters of the service.

• 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 21).

Figure 22. Additional information about service Parameters

Editing the available services

To change the Parameters of an available service, do the following:

• click on the for the selected service (Figure 22);

Figure 23. Editing the available service

• a form for editing the service will open, in which the necessary changes should be made(Figure 23).

The editing form for each service contains various Parameters, see the Services section.

• click on the Save button.

Figure 24. The service editing form

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

Figure 25. Service update confirmation

Restarting the available services

To restart the service, click the for the selected service (Figure 25).

Figure 26. Restarting the service

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

Figure 27. Service restart confirmation

Removing an available service

To remove an available service, do the following:

• click on the for the selected service (Figure 27);

Figure 28. Removing a service

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

Figure 28. Removing a service

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

Figure 30. Service removal confirmation

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:

• PercoWEB service — PercoController;
• Salto service — SaltoController;
• Strazh service — StrazhController.

Controllers

The Controllers section is designed to configure existing and add new controllers (Figure 30).

Figure 31. **Controllers** section

Creating a new controller

To create a new controller, do the following:

• click on the Add controller button (Figure 31);

Figure 32. Creating a new controller

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

Figure 33. Controller creation form

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

Figure 34. Selecting the type of controller to create

• a form will open to fill in the controller settings, in which you should add the necessary Parameters (Figure 34);

The Parameters for configuring each controller are different. For detailed description of the Parameters for each controller see the Controllers section.

Figure 35. Form for filling in controller settings

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

Figure 36. Documentation for the controller being created

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

Figure 37. Pop-up window with the required controller Parameters

• after filling in the controller Parameters, click on the Save button (Figure 37).

Figure 38. Saving when creating a controller

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

Figure 39. Confirmation of creating a controller

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

Figure 40. Displaying a new controller

General information about the available controller

The available controllers are displayed on the general view page of the section (Figure 40).

Figure 41. The available controllers

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

Figure 42. Main Parameters of the controller

• 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 42).

Figure 43. Additional information about controller Parameters

Editing the available controllers

To edit the Parameters of an available controller, do the following:

• click on the for the selected controller (Figure 43);

Figure 44. Editing the controller

• a form for editing the controller will open, in which you should make the necessary changes (Figure 44).

The edit form for each controller contains various Parameters, which are described in detail in the relevant paragraphs of subsection 3.2;

• click on the Save button.

Figure 45. Controller editing form

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

Figure 46. Controller update confirmation

Restarting the available controllers

To restart the controller, click the for the selected controller (Figure 46).

Figure 47. Restarting the controller

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

Figure 48. Controller restart confirmation

Removing an available controller

To remove an available controller, do the following:

• click on the for the selected controller (Figure 48);

Figure 49. Removing a controller

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

Figure 49. Removing a controller

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

Figure 51. Controller removal confirmation

Upon successful removal, the controller will disappear from the list of available controllers in the Controllers section.

Devices

The Devices section is designed to configure existing and add new devices (Figure 51).

Figure 52. **Devices** section

Creating a new device

To create a new device, do the following:

• click on the Add device button (Figure 52);

Figure 53. Creating a new device

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

Figure 54. Device creation form

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

Figure 55. Selecting the type of device to create

• a form will open to fill in the device settings, in which you should add the necessary Parameters (Figure 55);

The Parameters for configuring each device are different. A detailed description of the Parameters for each device can be found in the relevant paragraphs of subsection 3.3.

Figure 56. Form for filling in device settings

• to get information about configurable

Parameters, click on the Documentation button in the upper left corner (Figure 56);

Figure 57. Documentation for the device being created

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

Figure 58. Pop-up window with the required device Parameters

• after filling in the device Parameters, click on the Save button (Figure 58).

Figure 59. Saving when creating a device

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

Figure 60. Confirmation of creating a device

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

Figure 61. Displaying a new device

General information about the available device

The available devices are displayed on the general view page of the section (Figure 61).

Figure 62. The available devices

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

Figure 63. Main Parameters of the device

• 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 63).

Figure 64. Additional information about device Parameters

Editing the available devices

To edit the Parameters of an available device, do the following:

• click on the for the selected device (Figure 64);

Figure 65. Editing the device

• a form for editing the device will open, in which you should make the necessary changes (Figure 65).

The edit form for each device contains various Parameters, which are described in detail in the relevant paragraphs of subsection 3.3;

• click on the Save button.

Figure 66. Device editing form

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

Figure 67. Device update confirmation

Restarting the available devices

To restart the device, click the for the selected device (Figure 67).

Figure 68. Restarting the device

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

Figure 69. Device restart confirmation

Removing an available device

To remove an available device, do the following:

• click on the for the selected device (Figure 69);

Figure 70. Removing a device

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

Figure 70. Removing a device

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

Figure 72. Device removal confirmation

Upon successful removal, the device will disappear from the list of available devices in the Devices section.

Pipelines

The Pipelines section is designed to configure existing and add new pipelines (Figure 72).

Figure 73. **Pipelines** section

Creating a new pipeline

To create a new pipeline, do the following:

• click on the Add pipeline button (Figure 73);

Figure 74. Creating a new pipeline

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

Figure 75. Pipeline creation form

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

Figure 76. Selecting the type of pipeline to create

• a form will open to fill in the pipeline settings, in which you should add the necessary Parameters (Figure 76);

The Parameters for configuring each pipeline are different. A detailed description of the Parameters for each pipeline can be found in the relevant paragraphs of subsection 3.4.

Figure 77. Form for filling in pipeline settings

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

Figure 78. Documentation for the pipeline being created

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

Figure 79. Pop-up window with the required pipeline Parameters

• after filling in the pipeline Parameters, click on the Save button (Figure 79).

Figure 80. Saving when creating a pipeline

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

Figure 81. Confirmation of creating a pipeline

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

Figure 82. Displaying a new pipeline

General information about the available pipeline

The available pipelines are displayed on the general view page of the section (Figure 82).

Figure 83. The available pipelines

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

Figure 84. Main Parameters of the pipeline

• 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 84).

Figure 85. Additional information about pipeline Parameters

Editing the available pipelines

To edit the Parameters of an available pipeline, do the following:

• click on the for the selected pipeline (Figure 85);

Figure 86. Editing the pipeline

• a form for editing the pipeline will open, in which you should make the necessary changes (Figure 86).

The edit form for each pipeline contains various Parameters, which are described in detail in the relevant paragraphs of subsection 3.4;

• click on the Save button.

Figure 87. Pipeline editing form

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

Figure 88. Pipeline update confirmation

Restarting the available pipeline

To restart the pipeline, click the for the selected pipeline (Figure 88).

Figure 89. Restarting the pipeline

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

Figure 90. Pipeline restart confirmation

Removing an available pipeline

To remove an available pipeline, do the following:

• click on the for the selected pipeline (Figure 90);

Figure 91. Removing a pipeline

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

Figure 91. Removing a pipeline

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

Figure 93. Pipeline removal confirmation

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

Logs

The Logs section is designed to display all system logs and search for the necessary logs in the history. Receiving and displaying new logs is performed with minimal delays in near real time.

The service can store up to one million logs. After reaching one million logs, the first 500,000 logs are deleted.

The general view of the Logs section is shown below (Figure 93).

Figure 94. **Logs** section

In order to expand detailed information about the recorded log, click on the to the right of the required log (Figure 94).

Figure 95. Detailed information on the logs

Next, the log information will open, which displays detailed changes (Figure 95).

Figure 95. Detailed information on the logs

Log filtering

The Logs section allows user to filter the latest logs in order to limit the display of logs on the screen (Figure 96). Using filters, the user can quickly find the required log.

Figure 97. Filters in the **Logs** section

Filters available to the user in the Logs section:

• Time period — selection of time period for logging;
• Logging levels — selection of logging level (Error, Info, Warning);
• Components — selection of component to view the logs (Services, Controllers, Devices, Pipelines).

The user needs to tick the required filter(s), and click the Filter button so that the settings are applied (Figure 97).

Figure 98. Filter selection

If the filters are applied successfully, information with logs should be displayed, considering the selected filters. (Figure 98).

Figure 99. Displaying logs after filtering

To reset the selected filters, click the Reset button(Figure 99).

Figure 100. Resetting the filter settings

User can export the recorded logs if necessary. To do this, click on the Export button (Figure 100). The logs will be saved to the local computer in the filters.txt format.

Figure 101. Log export

To collapse the Filters section, click on the in the upper left corner (Figure 101).

Figure 102. Hiding the filters

Active Setting Parameter

The Active setting Parameter is designed to display a list of available settings and switch between them.

In order to select the desired setting, do the following:

• click on the to the right of the Active setting field to expand the drop-down menu (Figure 102);

Figure 103. **Active Setting** Parameter

• select the required setting from the drop-down menu and click on it (Figure 103);

Figure 104. Selecting the active setting

After selecting the active setting, all the components contained in this setting will be displayed in the corresponding sections: Services, Controllers, Devices, and Pipelines.

Active settings can be imported (see par. 2.2.7), exported (see par. 2.2.8), saved (see par. 2.2.9), and deleted (see par. 2.2.10).

Import settings function

The Import settings function is designed to import settings from the local computer to the Access. In order to import settings, do the following:

• in the upper right corner, click on the to the right of the user's avatar to expand the drop-down menu (Figure 104);

Figure 105. Switching to the **Import settings** function

• select Import settings in the drop-down menu (Figure 105);

Figure 106. **Import settings** function

• a form for importing a file will open, in which click on in order to select a file with saved settings in json format (Figure 106);

Figure 107. Selecting a settings file

• in the Setting name field, write the name of the setting to be imported (Figure 107);

Figure 108. The **Setting name** field

• click on the Add button (Figure 108).

Figure 109. Adding a settings file

After successfully importing the setting, the message Setting has been loaded will appear in the upper left corner of the screen (Figure 109).

Figure 110. Setting upload confirmation

If added successfully, the new setting will be displayed in the list of available settings in the Active setting Parameter (Figure 110).

Figure 111. Displaying the new setting

If the setting was created and imported correctly, then switch to this setting and check that all the components contained in this setting are displayed in the corresponding sections: Services, Controllers, Devices, and Pipelines.

Export settings function

The Export settings function is designed to export settings to a local computer from the Access. In order to export settings, do the following:

• select the required setting for export (for more details about selecting the active setting, see para. 2.2.6);
• in the upper left corner, click on the to the right of the user's avatar to expand the drop-down menu (Figure 111);

Figure 112. Switching to the **Export settings** function

• select Export settings in the drop-down menu (Figure 112);

Figure 113. **Export settings** function

• a file with the saved settings will be downloaded to the local computer in json format with all the components that are contained in this setting.

Save settings function

The Save settings function is designed to save a new setting or save data from the active setting to a new setting, for later work with a new saved setting. In order to save the settings, do the following:

• select the required setting to save (for more details about selecting the active setting, see para. 2.2.6);
• in the upper left corner, click on the to the right of the user's avatar to expand the drop-down menu (Figure 113);

Figure 114. Switching to the **Save settings** function

• select Save settings in the drop-down menu (Figure 114);

Figure 115. **Save settings** function

• a form for saving the setting will open, in which in the Setting name field write the name of the setting to be created (Figure 115);

Figure 108. The **Setting name** field

• click on the Save button (Figure 116).

Figure 117. Saving the setting

After successfully saving the setting, a message «Settings created» will appear in the upper left corner of the screen (Figure 117).

Figure 118. Setting Creation Confirmation

Upon successful creation, the new setting will be displayed in the list of available settings in the Active setting Parameter (Figure 118).

Figure 111. Displaying the new setting

If the setting was created correctly, then switch to this setting and check that it displays all the components that were contained in the setting from which the saving was performed.

If the setting was created for the first time, then switch to this setting and check that it displays all the components that were created in the Access for the first time.

Delete setting function

The Delete setting function is designed to delete the active setting. In order to delete a setting, do the following:

• select the required setting to delete (for more details about selecting the active setting, see para. 2.2.6);
• in the upper left corner, click on the to the right of the user's avatar to expand the drop-down menu (Figure 119);

Figure 120. Switching to the **Delete setting** function

• select Delete setting in the drop-down menu (Figure 120);

Figure 121. **Delete setting** function

After successfully deleting the setting, the message Setting has been removed will appear in the upper left corner of the screen (Figure 121).

Confirmation of setting deletion

Upon successful deletion, the setting will disappear from the list of active settings in the Active Setting Parameter.