General

When the application is first launched by the user, it displays a welcome screen to the user. The text informs about the application and wishes the user a successful use of the application.

In addition, depending on the user’s privileges and system properties, it displays appropriate messages about the availability of other types of interfaces. If the user has permissions to access the Mobile, Desktop section then depending on the login to the section, the system reminds about the existence of another version of the interface and indicates where to switch between interfaces.

If a user logs in without his or her first and last name, an additional message appears in the welcome window asking for this information.

For simplicity, the documentation will use abbreviations for the names of individual application sections or entire systems. Below is the list and its explanation:

If the system instance is a test instance (e.g. an additional test instance for training/functionality verification), then when logging into the application, information about working on a test instance is displayed and a bar informing about working on a test instance is always displayed at the bottom of the screen.

For systems without trial time, a standard message is shown.

In the case of a time-limited version, information about the validity period of the license/temporary version appears in the bottom bar and in the tool menu.

The system also informs when there is no license for an instance, when a license expires, etc.

Depending on the settings, the application has the ability to authorize using different sources. The supported mechanisms are: internal authorization, authorization via an LDAP server or authorization via an external OAuth2 system (e.g. Azure Active Directory/Oauth).

The primary method of authorization is through passwords stored in the main database. This allows authorization of any user based on comparison of the entered login data with the internal representation of it.

Opening the main address of the system in a web browser will present a basic login window in which you can enter your login and select the language of the application interface.

Based on the entered data, further user authorization is carried out. If the user is a local user, a password entry window is displayed. In the case of corporate users with an external authorization system, the user is redirected to that system and then returned to the AMAGE system and authorized based on the data received from that system.

After a correct login, the user is presented with the main window. Depending on the license permissions and the type of device (desktop, laptop or mobile device), a window is presented with an interface adapted to the capabilities of the device (screen size, resolution).

In the main menu there is an action to access the system menu. It is a button with a cog icon. This is a menu that allows you to perform additional system operations.

It allows you to change your settings, configure instances and payments (for versions of systems that support this functionality, e.g. AMAGE24) and perform additional operations.

After selecting the Settings action, the information window of the user in question is displayed. It displays user identification information including first name, last name and email address.

For local users, this is where the user can change the password. After selecting the Change password action, you are taken to the password change form. In this window, the user can also change the PIN code for devices working in offline mode (applications such as AMAGE Fx working in this mode). The PIN is a four-digit code that is used to authorize the user on such devices.

The user can also enter/change the current email address and upload a scan of his or her signature and photo. All these operations are available in this user’s background.

After selecting the action to change the password, the application displays a window with options to enter the current password and a new one.

The password change window provides information on the strength of the password - this is due to the use of the appropriate types of characters found in the new password (upper/lower case letters, special characters, numbers). In addition, when checking the new password, other elements set in the password policy such as the minimum password length, etc. are verified. The user can use the "Generate" button to generate a random password. The password will be automatically copied into the appropriate fields of the form and displayed in an additional window. NOTE! Once the window is closed, it is not possible to display the given password in plaintext again.

The application comes with its own help portal. This portal can also be accessed directly from the website, but is also built into the application adding several new features. Help in the system is available in several places, depending on the context, the selected system version and access privileges.

In the Desktop interface, contextual help is available in the system menu of the application (upper right corner of the window) under the question mark button. Selecting the action of this button displays a menu with options related to help.

The help menu allows access to several options:

If new information appears in the help portal - messages or information about new system functions, an overlay with information about the number of unread information appears next to the help button.

When you select the help action, we additionally display information about unread messages and new features. Clicking on the numbers will open a pop-up window with this information and navigation.

In the application element details view, there is an option to display a list of all presented information. After turning it on with the button, a list appears at the top of the screen, which allows you to go to the information you are interested in without having to go through all the elements in the change list.

In the Mobile interface, help is accessed through a separate "Tools" menu. When this menu is selected, a view with options appears. Selecting "Help" will display context-sensitive help.

After selecting one of the above-mentioned actions, an additional window with contextual help content is opened. Help is specific to each type of application and view. If you open the help in the Desktop interface, it will display the documentation of that part of the system and with a list of functionalities specific to the system instance, e.g. leases, maintenance, etc.

Buttons appear at the top of the window that allow you to view help in a pop-up window, navigate to the documentation or academy section, and additional portal/help/tutorial functions.

If a user has permission to access the system’s configuration interface (user management, etc.), he or she gets access to the documentation portal, which contains full documentation of the AMAGE system - all types of applications, use cases, tutorials, change logs, etc. To access the documentation portal, go to the configuration interface (Config) and in it select the main menu "Tools" → "Help Portal".

When this option is selected, user documentation will be loaded in the form of a help portal. You can browse the portal like any other website. The portal is divided into sections containing user documentation, use cases, instructions on how to use the various components of the system, and a programming API area (reports, etc.) that allows you to design reports yourself.

After selecting the context help action, we go to a specific place in the system documentation.

Part of the functionality is common to all components of the system. In this section, we describe the common part available in different parts of the interface.

When starting an instance, the system does not have a specific default location, i.e. the one from which we start. This may be the location of a plant or construction site. In such a case, the system displays a message (for people with appropriate permissions!) allowing you to set this default location.

Location selector on geographic maps or defined plans. Where the system allows you to define such a location (location, product, order, contract), a location selector is available. When it is selected, an additional window with a map view appears.

If you have your own definable maps, changing the view (underlay) can be done by selecting the layers icon. Changing the zoom is realized by (+/-) buttons has the map view.

The view also allows you to search for a geographic location. If we enter text in the search field and confirm it with the search button, the system will present a list of potential places corresponding to such a search. Each of them is selected by clicking on a given entry.

The app also allows you to search for a place by providing geographic coordinates in the form of two numbers, such as "50.125 20.195".

The current geographic position can be obtained by clicking on the next pointer button. It is required to add permissions in the browser to access location data. After permission, we have the opportunity to specify our location.

Additional internal viewers are a PDF document viewer and an image viewer. Other documents are opened by the system with the default applications available on the user’s computer.

Object selectors are available in various places in the system. They allow you to select, in a given context, the object necessary to further specify the actions being performed.

Using it, we can add identifiers manually or by scanning using a code scanner attached to the computer. The ID form remembers the last selected ID type and uses it as the default the next time the form is opened by a given user.

An (I) information button appears in most object detail windows or edit dialogs. After pressing this button, a window appears that displays all unique identifiers of a given object. They are always a local identifier from the database and a unique identifier (UUID) generated in the AMAGE system. In addition, if an object comes from e.g. an import from a BIM/IFC system, it may contain additional information fields such as GlobalId or IFC Tag. This window allows you to use this ID to create scripts or external integrations.

Editors allow you to enter and configure objects in the system. Depending on the type of object, the editors may differ. However, all editors have some common elements. These are: save, cancel changes, save and close the edit window buttons. Each editor also has its own mechanisms for checking the correctness of the entered data and its completeness. In case of errors, the system displays appropriate messages and marks incorrect/missing elements with an appropriate border and an additional message. A message about the need to correct the data also appears in the bottom bar.

Each selectable element, e.g. employee selection, may have an additional button to delete the selection. Once selected, the item is removed from the list of selected items. Only optional items have this option. Additionally, in the system, each button has its own additional description, which appears when you hover the cursor over it. This is the so-called tooltip. This is especially useful when the button does not have a visible description.

The system allows you to create users by inviting them with their email addresses. This allows information to be sent to these users from the so-called authorization token. Only with this link or token can the user set their own password to log in to the system and thus gain access to the system.

The functionality of the invitation is described in the section regarding users and the main tool menu. Here we only describe the views and information displayed during password procedures.

Users can be invited to the system through a simple interface in which we enter e-mail addresses and, optionally, an additional message for them. They will be sent an email with an activation link. For details, refer to the User Configuration section where this feature is described in more detail.

If the system is configured and linked to external authorization sources such as Azure AD/Google/Oauth2, etc., links for direct login through these systems are provided. This allows integration with parent applications and provides full SSO (Single-Sign-On) login without having to enter the login in the initial window. Depending on your system configuration, use the following addresses:

Errors occur in every application. The AMAGE system displays error messages in a dialog box. Production versions display a general error message, while beta versions display a detailed error message.

AMAGE system instances that have completed their active mode of operation, e.g. construction has been completed, may still be available to users, but in archive mode. Archive mode allows users to view data, but does not allow them to make changes to the data. Archive instances of the AMAGE system are identified by the corresponding information when you log in to them. Information about the operation of the instance in archive mode appears at the bottom of the screen. Archive mode allows you to view the contents of the instance, but does not allow you to make changes to the data.