Configuration

The configuration interface is available to users who have the access flag for this interface (see user definition documentation) or are super-administrators.

When you select the option in the system menu "Configuration", the system will take you to this version of the system. In it, you can configure system functions, application automation and view other configuration data/system dictionaries.

The section of department definitions allows us to arrange employees in the organizational structure of the plant/building. With the help of this view we have the possibility to arrange the structure of employees in the tree of departments/teams.

Upon entering the departments view, we are presented with a tree view.

Context actions allow you to edit a department or add a sub-department. Adding main departments is done by pressing the main button + Add.

Using the Users button, we have access to the view of users assigned to a given department.

Using search fields and detailed filters, we can limit the view to the selected tree/section of the system. In the tree view, we can also see information about the number of users who are assigned to a particular department. We can also call up a list of users assigned to a department (names of users).

Adding/editing a department involves invoking the appropriate option from the main view or entering to edit a currently existing department.

The window indicates at which level of the tree you are adding a new department (if at the main level then no information about the parent element appears) and you can enter information about the department name.

User management interface. Allows you to specify the permissions and identification data of employees participating in the process. The default action displays the list of users with all the basic parameters of the users.

The context menu of the main view provides actions to present additional data about the user(s).

Available actions

The + button allows you to add a new user. The Invite button allows you to invite new users by sending an email invitation. The refresh button resets the view and applied filters, and the lightning button displays the event and automation definition window.

The context menu in the user list allows you to perform operations on the selected user or user group.

Options available:

Using the 'Invite' button, you can send email invitations to join the system. The system will automatically create users and send an invitation to them to activate their accounts and set their passwords.

After activating the action, a window is displayed in which we can enter a list of email addresses (each in a new line) to which the invitation will be sent.

Next, we can specify how to create user logins. It can be a login that is only the name of a given email address or the whole email address. We choose this using the option available there.

We also have the ability to modify/extend the invitation to the system. Of course, texts with links to log in and reset your password will be added to the text of the invitation.

If an invitation for external users is created by a person with system administrator rights, you can indicate in the invitation form which rights the user should have. If the invitation is created by a person with user rights, it is not possible to indicate the user’s rights in the invitation form. We select permissions from available access profiles.

What’s more, if a user has super-administrator privileges, the flag for granting the same privileges to invited users is activated.

For users who have the right to edit users, an additional tab appears when inviting them, allowing them to define access profiles for users. If the user is a super-administrator, he can also give this flag to newly invited users.

We can also invite users from the system menu, which has a built-in Invite action at the bottom, which will open the same window as the action from the configuration section.

Access profiles provide a central point for granting authorizations to various sections and functions of the system. Each user who is logged into the system is subject to a check of his/her privileges by the profile system. If a user is not granted access to a given group of rights then:

When you enter the access profiles section, a list of profiles and information about the number of functions defined in the profile is displayed.

Editing/adding a profile allows you to specify the list of functions that are allowed in the profile.

The profile list context menu allows you to access selected functions for all access profiles.

Access profiles add up to each other, i.e., the functions that are specified in different access profiles are summed up. Each user can have multiple assigned access profiles and is permissions will be the SUM of the permissions from the different access profiles. This allows you to define access profiles by specifying a set of activities, e.g. "Service events - overview", "Service events - create and edit" and then assign such access profiles to selected users. This allows you to easily define a set of permissions for users and modify them flexibly.

Adding an access profile displays an editing window. In the common data we specify the name and description of the profile.

In the Modules and functions tab, we specify the list of permissions by module. To specify a function of your choice, select a module and then use the whiskers to specify which functions the access profile allows.

The functions are divided into modules. Only active modules in the system are visible to the defining access profile. The lists are usually divided into operations: viewing data, creating a new record, editing an existing record and deleting a record. In addition, module-specific functions appear, for which it was decided to separate permissions so that access to the execution of these functions can be better controlled.

An interface for the definition of events that result from changes in data in the system. The mechanism allows for flexible generation of email notifications/notifications in the system with full control over the handling of these events.

The event mechanism allows you to configure responses to occurring events in the system. The event mechanism operates at the Objects level. The system operator has the ability to define events for basic operations performed on objects: Creation, Modification, Deletion. Based on these basic operations, he can further configure whether the system will respond to a given event by modifying check scripts. They allow to introduce additional conditions based on the data of a specific object, e.g. state. With the help of modifying scripts, the user can change the parameters of the event based on the data coming from the object, e.g. filling the list of email recipients based on the parameters of the object, e.g. the person assigned to the service event.

The event list allows you to view completed event handling in the system. If an event is defined for an object, all operations on this object will be analyzed by the system. Based on the event configuration, the system will handle the event (e.g., send an email) or determine that the event is ignored (e.g., does not meet the conditions of the check script).

The event list shows all events and the system’s response to them. The filter allows you to selectively display the data. To see details of event processing, select any event. The system will present the details of the event.

The event details show information about the event, the date it was created, processed by the system and the expiration date.

When the 'Data' tab is selected, individual system responses to an event are displayed. When an individual action is selected, the logs in the lower part of the window are presented, e.g. information about the email dispatch.

Using the views of the new/old object, we can view the structure of the saved objects. Data is shown in JSON format.

The Difference view shows the differences between the old and new records.

The event view in the configuration section allows you to view all events defined in the system by all users. However, a view has been made available for each module, which allows you to configure events and schedules for a given functional module. This is done by a dedicated lightning bolt button, which is available in the main module views.

Using it, we can access the configuration of events and schedules for a particular module. For the 'Events' module, all events defined in the system are available. For other modules, only the events defined for the module are available.

After selecting an automation action, a window is displayed that allows you to configure individual automation elements.

In the events view, we can add new events and edit already defined events. The available actions in the event view are:

Preview and Edit

Editing or creating a new event displays the event configuration window. In the event configuration window, we can define basic event parameters, such as name, event type, periodicity, and checking and preparation scripts. In this view, it is not possible to change the object that the event concerns. The object is defined at the functional module level.

There is an additional button available in the view, located next to the object name, which displays an additional window with event templates provided by AMAGE. Templates allow you to select and enter rules into the proofreading and preparation script editors. This makes using the module and events much easier for the first time.

Once an event is saved, if it is active, the events are automatically activated and the system responds to new event registrations.

To enable a full view of the events that are logged in the system, an operation logging view is available. The event history shows all events registered in the system. Information about the event, creation date, processing date and expiration date is available. The event status determines whether the event has been ignored, i.e. there are no rules for it, whether it has been executed and its final status.

The event details provide information about the event, creation date, processing date and expiration date. The 'Data' tab provides information about the old and new objects, the difference between them and data in JSON format. Using this data, we can view available fields in records and use them appropriately in scripts.

Detailed information about the operation of machines and events is available in the logs. Using the log viewer, we can view machine operations and progress in event processing.

Detailed log preview allows you to view event logs that have been recorded in the system.

Schedulers are the section of the system responsible for defining automatic actions that perform activities without the presence of the user. Examples of such activities are, for example, automatic generation of reports, transfer of information between users along with operations on the system, automatic generation of inspections on the basis of performed supervision activities, etc.

Each such scheduler has its own configuration capabilities. Each of them can also be run repeatedly with different parameters and with any recurrence period.

To see a list of all defined schedulers on the system and control their operation, select the Schedulers configuration section. The initial view shows a list of all defined schedulers.

The list contains information about all schedulers that are created. To create a new scheduler, select the (+) button. Editing of the selected scheduler is realized by the dedicated scheduler edit button. The Restart button causes the scheduler coordinator to reload all configurations.

Scheduler definition/editing consists in opening the editor window. It allows you to specify the most important information about this slot machine. It is divided into two sections. The first of them defines the basic parameters of the machine. The second is a configuration specific to the selected machine.

General options available:

Editor - configuration editor. In it, we define additional data, parameters for the automaton. After selecting the appropriate machine, the system configures this data. They are available in two forms. A text editor with any way of entering all parameters.

and a visual editor where each option has its own data editor.

Buttons next to each element allow you to select the appropriate editing field or open an editor with syntax highlighting of markup and preview of the result in HTML form.

Such editing makes it much easier to edit fields that may contain a lot of text and newline characters, e.g. email body texts or a similar automation option. With such an editor, we can visually edit the parameters and immediately preview the result that the system will generate from such formatting.

The schedule view in the configuration section allows you to view all schedules defined in the system by all users. However, a view has been made available for each module, which allows you to configure events and schedules for a given functional module. This is done by a dedicated lightning bolt button, which is available in the main module views.

Using it, we can access the event configuration and schedules for a given module. In the case of the 'Schedules' module, all schedules defined in the system are available. For other modules, only events defined for that module are available.

After selecting an automation action, a window is displayed that allows you to configure individual automation elements. The list shows all schedules defined in the system. Only active schedulers are processed by machines.

Available actions for schedules:

The context menu of individual schedules allows access to additional actions:

Detailed information about the operation of machines and events is available in the logs. Using the log viewer, we can view machine operations and progress in event processing.

Detailed log preview allows you to view event logs that have been recorded in the system.

Interface showing the history of data changes in the system tables. It allows for reverse analysis of data saved/modified in the main objects of the system. With its help, we can see a snapshot of information about individual objects.

The system includes a log viewer of the application’s internal systems. The application has several systems that generate actions in the background and are used to automate system operation. These components are:

All of the above-mentioned elements can be defined in the appropriate sections of the configuration interface. Each of these systems generates logs informing about its operation and possible errors/problems in processing.

Using the log viewer available here, we are able to view the logs that these systems generate. To access it, call the Log Viewer action from the Audit section in the configuration.

Once passed, a list of available logs appears, which we can view/monitor.

List of logs

The log view is divided into two sections. The log stream selection and the actual data preview.

In the view of the individual log stream, we have available actions:

An interface for managing keys to access the WebService interface via a generic programming API. Documentation for the API is available in the developer documentation section. This is where we manage and generate the API keys.

The call to action presents a list of available API keys, information about the key value part (key, UUID) and the activity, generation and expiration dates of the key.

For each API key, contextual actions are available that allow you to edit, delete and quickly activate/deactivate the key.

Filtering mechanisms are available in the list to display active or inactive API keys

The list of all logins allows you to view the login history of all users in the system. The list shows logins to the system via Web application (any interface) and via Legacy Desktop application (installed on computers). The 'source' column specifies with which system the user logged into the application.

Use the search filter to specify a date range or a specific user for the general view.

The window contains information about the login date, user, from what source the login occurred (Web/Mobile application, application installed on computers or other). In addition, the Description column shows what roles the user has:

Definition of dedicated mobile devices - devices working with AMAGE Fx or AMAGE CE application on dedicated devices. Possibility to work in offline mode. The device list allows you to define devices and configure them.

After entering the main menu of the Mobile → Devices configuration, a list of all defined mobile devices is presented. Adding a new device is done by selecting the (+) action.

The definition of a new mobile device allows you to specify its parameters and settings.

The technical information tab stores information from the PVD application regarding the last date of communication and the last information regarding communication with this device. This facilitates possible diagnostics.

After adding a device, additional options appear in the context menu of the tabular view:

The definition of tasks/data ranges for dedicated mobile devices allows you to specify the data range so that they work only on a separate part of them. The interface allows you to control the data sent from such devices. In the case of devices working offline, it is not possible to synchronize the entire main database due to its size. In this case, the logic of mobile tasks was created. They fulfill two roles:

In the configuration view in the Mobile section, we have access to mobile tasks through the Tasks action. After selecting it, we are presented with a list of mobile tasks and their statuses.

We can create a mobile task using the + button, editing is available directly from the list of tasks. When creating/editing tasks, we can specify the basic data:

Additional task flags allow for additional control:

In the second tab of the mobile task, information about the limitations of the given mobile task is available.

Restrictions may apply to the list of users uploaded to the device, resources from only selected locations, only specific work orders and their associated objects, and others according to the list.

For each task we have a context menu with actions available:

The list of reports in the configuration system allows you to specify the visibility of reports in the system and their visual configuration (e.g., the appearance of the default report template).

The list of available reports shows all reports currently available in the system. These reports can be system reports or user-defined reports.

After selecting a report, a window of detailed information about the report is presented.

General information is presented there, a description of which data object the report belongs to, its unique identifier (used in referring to this report in generators). In this view we can specify whether the report is available for a single item or for groups of items. The option also allows you to hide the report from users - in case for a given instance the report is not useful or not used.

The template tab allows you to define your own report design. We upload a ZIP archive of reports to this place, which are replaced during generation.

This approach allows you to modify the appearance of the report by replacing the default report appearance in the system. Due to the fact that reports can consist of sub-reports to this place we upload a ZIP archive with all reports/sub-reports that we replace.

General configuration data necessary for proper operation of systems. Determination of basic parameters and settings is realized through this view. It is accessed through the main menu 'Main' → 'System'.

The settings view is divided into two sections 'Common' and 'Counters'. The common section contains the main system settings affecting the application.

Available configuration options:

Using the default start addresses, we can specify the address at which we start the session for the mobile, desktop and configuration views. To change it to any other, use the end of the address and enter it in the given field. For example, to start the configuration view from the system data configuration, we will enter config-desktop-system because the address of this area is: config#!config-desktop-system

Dictionary data is accessed through the dedicated 'Dictionaries' main menu. After enabling this view, a list of all available dictionary configurations in the system appears in the form of a table of buttons.

The window defines accounts in the system. Accounts in the application are the connection between the AMAGE system and external finance and accounting or billing systems, e.g. with external suppliers. An account is an identifier by which we link objects in the system (e.g., work orders, warehouse storage locations) with corresponding cost centers or billing groups in external systems.

The list presents a complete list of billing accounts available and defined in the system. Accounts can be created manually or created automatically when importing data from external sources (e.g. XLS files).

The billing account editor allows you to provide a name (ID) and an additional description for the account

Contract types is a dictionary definition that allows to categorize contracts existing in the system. With the help of these definitions, the user can divide the executed works according to his own nomenclature. The list of contract types shows all active contract definitions.

The contract type editor allows you to give it a name and additional text description.

Counters is a dictionary data that allows the system to automatically number documents, events, minutes and use the counter as a source of unique (consecutive) number with a specific appearance format. The dictionary list shows all the counters defined in the system.

Creating/editing a counter displays an editor window that allows you to define the information necessary for the counter to function properly.

Available fields:

After selecting the Info button, a window with information about possible options for the pattern is displayed. This allows you to enter fields such as counter value, current month, current year or any text into the text representation generating for example PZ/1234/04/2020.

Interface for the definition of a set of employee competencies. Competencies can be verified during inspection work, e.g., at a construction site, or used to determine/select people with specific competencies to perform work at the plant.

With the help of a competency dictionary, we define a list of available competencies in a given organization - this could be a set of electrical, mechanical, machine operating, etc. competencies. Competencies then assigned to an employee can be used to select competent people to perform given activities accordingly.

The list of competence types shows a list of all competencies.

The competence editor allows you to enter is name and textual description.

The financial data dictionary area contains information about financial and accounting and billing parameters used in reporting mechanisms or data generation to external systems. These data are defined for each month separately.

The list of available financial data shows all the financial data defined in the system with an indication of the period to which they apply.

The financial data editor allows you to enter descriptive data for a given financial period and specify the FRI date.

Inventory identifiers are sets of identifiers that facilitate inventory work. The system has its own mechanism for generating unique identifiers. These identifiers are later used to uniquely identify equipment in the plant by scanning, for example, QR/2D codes with these codes. The identifiers generated in the system consist of a common part (identifying the system and the instance) and a variable part automatically incremented.

The from stock inventories are usually carried out in a location where it is difficult to access the ICT infrastructure and print space. The timing of such an inventory is also important. In order to speed up these operations, users in the system can prepare a package of badges before the inventory, print them as 2D codes and use them during quick tagging of equipment. The next step involves reading the badges and producing photo documentation. The final step is to arrange the data in the system, but this is done at any time in front of a computer screen.

The list of inventory IDs presents a list of all previously generated packages.

Using the context menu, we can enable the generation/printing of identifiers. We can also mark a given package as already printed (so as not to print/use it again).

To reserve a package of identifiers, you need to create a new entry. In it, you specify the name of the package in question (for easier handling later) and the number of identifiers that will be reserved (generated).

In addition to generating standard codes of the P99901-0000001 type, the system also allows you to use any counter defined in the system to generate such codes. This can be useful when, for example, we want to generate codes for the inventory numbers of a given company. Then we use a new counter with an appropriate pattern that will generate such a list of data to be printed.

The lease withhold definition interface allows for the definition of periods in time during which no lease is charged for selected orders/components. This is used for accrual restrictions consistent with supplier contracts.

The list of lease withholds presents a list of all lease withholds defined in the system. This list is also available within individual objects (showing withholdings for that object only). The list available in the configuration module shows all defined withholdings.

The creation/editing of a new lease hold is defined using the editor, where we specify the parameters.

In the Common tab, you define the name, the type of hold (different handling for regular hold or minor device hold) and the duration of the hold.

In the lease tab, we define percentage of the lease modification value, i.e. specifying a value of 0% means that no lease will be charged in a given period. Specifying a value of 50% means that half of the value that is required on the given days will be charged (broken down by day). In this tab we also define whether the withholding applies to all construction elements or only to selected ones, which can be specified using the list of these elements.

In the recurrence tab, we define whether a given hold is recurring and have the option to specify the type of recurrence, the period every which it will be calculated, the end date of the recurrence and the days of the week on which the recurrence will be active.

For example, you can define repetition:

This means that the system will repeat the defined hold every two weeks until the end of the year, but only if, after moving the interval, it turns out that these days are Saturday or Sunday (useful for repeating, for example, every certain number of days).

Definition interface of custom map primers. The definition allows you to upload to the system and select the map in map viewers.

The procedure for adding maps requires specifying a map name and basic map information (minimum zoom/maximum and default). When the map is created, a unique identifier is assigned to the map, which will be used to upload the map’s tiled backing to the server.

The system also allows you to add a default map by selecting the Default button, which will automatically add a map based on Open Street Map (OSM) primers. The system will then create a local copy of OSM tiles to serve to users while speeding up transfers and minimizing communication with public OSM servers.

When defining your own maps, it is important to define the maximum/minimum map level and default zoom.

If we mark the map as a map overlaid on geographic maps, it will appear above the selected main layer. Using the "Opacity" slider, we can determine how transparent the layer is. 0% - fully transparent, 100% - completely masking.

The system has the ability to define any parameters for types/resources in the system. Usually between devices/types, some of the parameters are repeatable, e.g. electrical parameters, environmental parameters, etc. To make it easier to give such parameters in a repeatable way, the system introduces something like parameter templates.

Parameter templates are user-definable groups of parameters that can be used when creating/defining new types of resources so as to facilitate and speed up these operations.

The list of parameter templates shows all templates available in the system.

Adding/editing a new template is accomplished either by the (+) button or by selecting a template for editing.

In the template editor, we define its name and specify the list of parameters that make up the parameter template. Using the dedicated Copy button, we can quickly copy parameters and edit them later in a simplified manner.

The definition of a single parameter allows you to specify its value and additional information.

Available fields:

Interface for definition of service event states and definition of possible flows/changes between states of an event.

To create or edit an event, select the (+) button at the top of the window or select the state you want to edit and then select the 'Edit' button.

Only one service event state must have the "Default state" flag. This will be the state that is set first when the service event is created.

Public states determine the mappings of the list of service event states to the states visible in the Customer Portal.

The list of allowed transitions allows you to specify the possible flow between states. If it is filled, the system user will be able to move from a given state only to selected states from the list

The flags of required confirmations are used when performing service work and entering data using mobile devices. The requirement to enter signatures of relevant people will result in showing dialogs with the need for signatures (or using signatures stored in the system - see the definition of users).

The list of required services allows you to specify what services must be entered into a service event in order for the system to allow you to move to that state. This allows you to determine which services (e.g. number of hours worked, trip amount, etc.) are to be entered into a service event before moving to the next step (service event state).

The application allows you to define colors for individual service event states. These colors are used in various places in the application, e.g. in the list view of service events, in the detailed view of a service event, etc. In the 'Visual' tab there is an option that allows you to enable non-standard colors and define these colors

After saving data in this section, the colors defined for individual service event states will be visible in the views that include service events.

Using the Security tab, you can specify who has the right to change service event statuses. By enabling the appropriate flags, you can specify who has the right to change service event statuses. The Limit execution field allows you to specify that only selected people can change the service event status. Using the list of users or departments to which users are assigned, you can specify who has the right to change service event statuses. Only the indicated users or departments will be able to change service event statuses.

Definition of service event types. Defining event type for easier event categorization.

The editor allows you to define the following parameters:

Flags relevant to event type definition:

Services are a cost component of service events, service protocols or inspection work performed. Using it, additional information can be written to the aforementioned objects to estimate the cost of executing a given order. With the help of services, you can define costs that are not costs of items from the warehouse (handled by warehouse outgoings), but also that are part of the load of a given request/protocol/inspection. In the dictionaries we define such things as:

The list of available service types allows you to view all the services defined in the system and edit/create new ones.

Creating a new type of service allows you to enter all the basic data about that service

Possible data entry:

Warehouses are the central clearinghouse of warehouse management. Each warehouse can divide into multiple storage locations (locations where items are stored in the warehouse). Definition of warehouses is done manually using the interface below or automatically when importing project/contract structures or integrating with external ERP systems.

After entering the warehouse configuration, the user is presented with a list of all defined warehouses and their basic properties.

Adding/editing a warehouse is possible by selecting the (+) button or by selecting a specific warehouse.

Available parameters for the warehouse:

A storage location is defined as descriptive information of the location. You can also assign a billing account and a location to a storage location, which allows you to display the storage location on a map and send this information to users and suppliers (where to deliver materials).

The details of the storage site are:

Parameters - allow you to define what parameters should be displayed directly in the view of a given warehouse in the form of additional columns with data.

The system allows you to define units of measurement and their representation in the system. To go to the definition of units, select the 'Unit of measurement' option in the dictionary configuration.

After selecting this option, a window with predefined units in the system appears. During the first startup, the system defines the units in the system and determines their parameters. We can change these parameters and/or define new units of measurement.

The unit of measurement has the following parameters: