Working with Access

Access Localization

Access supports to localizations:

• English;
• Russian.

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

Figure 1. Interface localization

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

Figure 2. English interface

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

User roles and permissions

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

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

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.

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.

Figure 8. Menu sections and functions available to the administration

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

Interaction with Access components occurs according to a common algorithm:

• creation of components
• getting information about a component
• grouping of components (available only for controllers and devices)
• editing of a component
• restart of a component
• deletion of a component

Creating a component

To create a new component, do the following:

1․ click on the Add component button (Figure 9);

Figure 9. Creating a new component

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

Figure 10. component creation form

3․ to expand the drop-down menu, click on the

Figure 11. Arrow down

on the right and select the required type of component (Figure 11);

Figure 12. Selecting the type of component to create

4․ a form will open for filling in the component settings, in which you should add the necessary Parameters (Figure 12);

The Parameters for configuring each component are different, see the components section.

Figure 13. Form for filling in the component settings

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

Figure 14. Documentation for the created component

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

Figure 15. Pop-up window with the required component Parameters

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

Figure 16. Saving when creating a component

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

Figure 17. component creation confirmation

Upon successful creation, the new component should appear in the list of available components in the components section (Figure 17).

Figure 18. Displaying a new component

General information about the component

The available components are displayed on the general view page of the section.

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

Figure 19. Main Parameters of the component

• 1 — status;
• 2 — name;
• 3 — type;
• 4 — general information ;
• 5 — additional information about Parameters.

For more information about the Parameters of the component, hover over and information will appear in a pop-up window (Figure 19).

Figure 20. Additional information about component Parameters

Component grouping

When creating a component, the user can create/select a component group.

By default, components are assigned to the "No group" group.

Component grouping allows you to visually separate components by features that interest the user: location, type, manufacturer, etc.

To create a group in the component parameters editing window:

1․ click on the group input field 2․ specify the group name 3․ click Create (Figure 20) 4․ save the component changes.

It is not recommended to enter more than 30 characters.

Figure 21. Create group

The component is placed in the group (Figure 21).

Figure 22. component group

To add a component to an existing group:

1․ go to editing the component 2․ select the desired group in the group drop-down list (Figure 22) 3․ save the component changes.

Figure 23. Add to group

Editing component

To edit the Parameters of component, do the following:

1․ click on the for the selected component (Figure 23);

Figure 24. Editing the component

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

To get a description of the component parameters, you need to go to the corresponding section.

3․ click on the Save button.

Figure 25. Component editing form

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

Figure 26. Component update confirmation

Restarting a component

To restart the component, click the for the selected component (Figure 26).

Figure 27. Restarting the component

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

Figure 28. Component restart confirmation

Removing a component

To remove an available component, do the following:

1․ click on the for the selected component (Figure 28);

Figure 29. Removing a component

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

Figure 29. Removing a component

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

Component removal confirmation

Upon successful removal, the component will disappear from the list of available components in the components section.

Deleting a component also deletes its child components.

The child components are the corresponding controllers:

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