Introduction to examples

This section contains general and uncategorized examples. The documentation presents the general mechanisms and functions of the system and shows how to use the system and additional devices/materials to implement specific business processes.

Examples available

Helpdesk creating a request

The document describes how any user of the AMAGE system can communicate and submit comments through the so-called Helpdesk request system. Any user of the system has access to a mechanism through which they can submit a comment/support request.

Authorization

AMAGE Shell - Azure AD connection setup

The document describes how the AMAGE Shell application communicates during authorization with external Microsoft Azure AD (Active Directory) authorization servers when the user profile has additional security established for the company profile and device verification through Microsoft Intune.

Automatic user login

The document describes how to automatically authorize a user to enable the AMAGE system as a visualization panel in the conference room. The goal is to provide all conference room users with access to the system visualization and access to some of the data e.g. list of contracts and appointments. Such functionality must be made available without the need to log in to the system but with full privilege verification.

Authorization - Configuring Azure Entra ID for AMAGE system authorization

The document describes the authorization and configuration mechanism of the Microsof Entra ID system to authorize AMAGE system users using the central Active Directory/Entra ID user mechanism.

Adding a new user

The document describes the mechanism of creating new users in the system and explains the options and functions of authentication mechanisms. Each user in the system must have an account. We log in to the system using the login identifier (login). The remaining data in the user definition allow you to define access mechanisms and places to which the user has access. In this document, we explain the authorization mechanism, the different types of users, and the functions that allow you to determine the level of access for each of them.

Configuration of access to the application with the use of profiles

The document describes the management of access to system functions based on a definable list of permissions.

Automation

Examples of event rules for system functions

The document describes examples of event rule configuration for event processing automations for the system. Details of the general event configuration are described in the 'howto' documentation in the documentation portal.

Notifications - Configuration of notifications and events

The document describes the mechanism of events and defining system reactions based on information about changes in object states. Sometimes there is a need to automatically notify system users (or other people) in response to such actions. This is what the event mechanism is for. It allows you to define a number of rules that will be processed by the server and, based on the defined parameters, will generate appropriate actions. Such actions may include, for example, sending an email with specific content to a selected list of people.

Schedules - Configure schedule events

The AMAGE system has a built-in set of predefined tasks that, if a configuration is prepared for them, can be run periodically. This article describes their operation and configuration. Scheduler internally uses the Quartz library and CRON-style scheduling. This article gives specific examples of scheduling for specific tasks, but without explaining how the fields are written and what they mean.

Generating reports and sending them by e-mail

The document describes how to configure the system through automatic functions (scheduler). In this example, we analyze the possibility of receiving reports to an email box with a specified period of time. In order for there to be the possibility of receiving a report to an email inbox, you need to do two things. Define a report tab, which will store information about the configuration of a given report, i.e. how to generate a report and from what data. Then such a bookmark is enabled to automatically generate a report at a certain time and send it to selected email addresses. All these steps are described in this document.

Programming interfaces

Documentation of the AMAGE database structure

The document describes the database schema documentation provided by AMAGE in the form of an interactive schema viewer and database documentation. A tool for people with access to data and the ability to create queries/views based on database records.

Use and use of REST API communication in the AMAGE system

Documentation and example of using the AMAGE REST API interface, which allows access to system data and generation of information useful in external integrations.

Equipment

General - definition, and pairing of the devices for offline operation

The document shows how to add and pair a terminal for offline operation. These terminals are most often rugged devices for work in demanding environments. They have the ability to work offline, i.e., in a mode where we do not need access to the network to do our work (on a construction site, or in an industrial plant).

Configuration of hardware components

This document describes the configuration of selected hardware components to work correctly with the AMAGE application. These devices include label printers, industrial terminals, etc.

Rugged devices for online/offline work

The AMAGE system is dedicated to work in demanding industrial environments. During implementations, we usually use standard mobile solutions that are available in every company and individual employees, whether they are phones or simple tablets with Android/iOS operating systems. However, sometimes there is a need or requirement to use devices with a special design due to the working environment (dust, humidity, water). The document provides an overview of such devices.