Working with Access

Access Localization

Access supports to localizations:

• English;
• Russian.

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

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

Для возврата к русскому интерфейсу нажмите на кнопку рус|eng еще раз.

User roles and permissions

There is only one role available in Access — "administrator" (Table 10).

Table 10. 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.

You need to open a web browser and go to the server where Access was installed. Example of an address: http://ip_address: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 are not allowed to view and create components 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 4).

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.

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.

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

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

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.

Components of the same type (Services, Controllers, Devices, or Pipelines) must have unique names (the name parameter).

Services usage

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

Creating a service

To create a new service, do the following:

1․ click on the Add service button (Figure 10);

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

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

4․ 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, see the Services section.

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

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

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

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

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

General information about service

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

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

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

Editing a service

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

1․ click on the for the selected service (Figure 22);

2․ 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.

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

Restarting a service

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

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

Removing a service

To remove 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 you should click on the Delete button in the lower left corner (Figure 28).

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

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

Creating a controller

To create a controller, do the following:

1․ click on the Add controller button (Figure 31);

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

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

3․ 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, see the Controllers section.

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

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

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

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

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

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

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

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 42) and save the controller changes.

It is not recommended to enter more than 30 characters.

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

To add a controller to an existing group, go to controller editing, select the desired group in the group drop-down list (Figure 44) 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 45);

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

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

Restarting the available controllers

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

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

Removing an available controller

To remove 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 click on the Delete button in the lower left corner (Figure 51).

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

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

Creating a device

To create a new device, do the following:

1․ click on the Add device button (Figure 54);

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

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

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

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 58);

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

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

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

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

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 63) and save the device changes.

It is not recommended to enter more than 30 characters.

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

To add a device to an existing group, go to editing the device, select the desired group in the group drop-down list (Figure 65) 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 66).

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

Editing device

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

1․ click on the for the selected device (Figure 68);

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

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

Restarting device

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

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

Removing device

To remove 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 click on the Delete button in the lower left corner (Figure 74).

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

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

Creating pipeline

To create pipeline, do the following:

1․ click on the Add pipeline button (Figure 77);

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

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

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

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 81);

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

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

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

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

General information about pipeline

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

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

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

Editing pipelines

To edit the Parameters of pipeline, do the following:

1․ click on the for the selected pipeline (Figure 89);

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

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

Restarting the pipeline

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

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

Removing an available pipeline

To remove an available 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 click on the Delete button in the lower left corner (Figure 95).

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

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