AyMINE Modules

Modules are managed during the client account definition.

Information on this page address the system administrators tasks.

• How to add a module
  • What to do when installing
• When to update
• When updating the module is not necessary
• How to update a module
• You should know

The system administrator page is used to upload modules to the operating environment. Functions require developer permissions and are intended solely for installing new modules or changes.

How to add a module

Default condition
A new module can only be added after it is physically placed on the operating server. This needs to be prepared directly on the server, this screen is not used for this.

The Upload function takes you to the menu to add a module. The system knows nothing about the module at the moment, so you must enter its name. The system then analyses what installation options the module offers and you can select which ones you want to run.

What to do when installing

When installing, the system registers all the module components that the server needs to know, retrieves data about the module objects and stores the information needed for the server to function.

When installing a module, data useful for further development (support for programmers) is also created. It is therefore practical to install modules as soon as possible in the development environment.

When to update

• When to develop a module, updating the module allows you to generate system code constants into the back-end code.
• When testing back-end functionality, especially PDF outputs, you will need updated translations
• When changing anything that defines the module installation script – the extent of installation is always dependent on the module and you need to consult the technical documentation of the specific module.

When updating the module is not necessary

• Changes to the definition of an object that is already registered in the system do not require updating (reinstallation). However, it is necessary to clear the system cache (with installation it is done automatically, but it is possible to start manually).

How to update a module

A module uploaded once may need updating when a major change is made to it. Specifically, it needs updating:

• After adding an object
• After changing extensions
• After changing system or user (client) dials

As part of the update, it is also possible to import system privilege settings (system roles) that can be transferred from one environment to another (typically from development to test and operation).

You should know

For once uploaded modules, there is no feature that would exclude them from the operating environment. It is not expected that once added modules would need to be removed.

Uploading of modules is provided by back-end functions and controlled via the back-end interface. Therefore, functions are not available within the mobile application.

Uploading and installing modules is not enabling them to clients. Of course, modules must be uploaded before they can be enabled to clients, but enabling clients of systems is done in the administration of individual clients. For managing modules with clients, a system privilege is sufficient, no developer privilege is necessary.

You must have a privilege to start the installation. This is not possible without the system module being installed. You will create the first user and the associated privileges within the installation – see the technical manual for installation.