Cortex-IP Remote Admin¶
The Remote Admin enables the administration of basic settings of a CortexEngine instance and the CortexUniplex and offers corresponding functions. This tool allows you to
- create configurations
- view general information about the users
- perform updates
- perform manual backups
- export and import backups
- install plugins
- manage licenses and users
- create report definitions
The Remote Admin window is divided into several areas.
Current log entries are displayed under 1, which are also logged in the ctxserver.log
file. The meaning of the listed messages is intuitively comprehensible.
The area (2) shows the logged-in instances that are currently connected to this server. For example, the accesses via the Remote Admin and the PHP accesses are listed here. If you have started a replication from another server, this access is also shown.
The traffic light (4) shows the runtime status of the web server, normally it should be green - the engine is running. In the event of maintenance tasks or errors, the traffic light will change to yellow or red. You can then read any errors in the log file (1).
Functions of the Remote Admin¶
The area (3) offers you various options. Your CortexEngine is managed using functions that can be accessed via individual buttons. If an administrator has the server's access credentials, they can perform remote administration.
Backup¶
The Backup function is used to perform a manual data backup.
When performing the backup, you are asked whether the data backup should be created with or without your own serial number. A backup file with a serial number can only be used with the corresponding license and cannot be read on any other server with a different license. A backup without a license is generally readable and can therefore also be restored on other servers. The corresponding backup file is only created in your backup directory once the query has been confirmed.
Depending on the scope of the engine and the logged changes, it may take a few minutes to create the backup. While a backup is being created, it is possible to continue working with the Engine. The backup only contains the information that was available up to the moment the backup was started. If additional data is recorded during the backup creation, it will only be available with the next backup.
Restore¶
The Restore function will restore a backup file.
To restore the data in your Engine, it is necessary for the corresponding backup file to be available in the backup directory. When Restore is called up, the relevant file is selected and is then read in immediately.
All content and change information is restored during the restore process. If a backup file without a license is imported, the license file (.lic file
) must be added via the License button after completing the restore.
The backup files contain all complete configurations and license entries so that the engine can be used immediately after the restore.
Info¶
When you call up this function, you will see the version and license information. If you click the link below the symbol, you will be redirected to our website where you will find further information on the Cortex-IP.
Field definition¶
You can configure, edit and delete fields for the Uniplex, import saved field definitions or export existing ones via the button Field definition.
Worth knowing
This function has now been implemented in Uniplex in a more user-friendly way, so that the maintenance of fields can be dispensed with here in Remote Admin.
Counter Definition¶
During the use of Uniplex by users, counter fields can be used. These provide the option of using unique counter readings to generate unique values (e.g. ticket numbers, invoice numbers, etc.). These fields are therefore controlled separately within the Uniplex configuration.
Variables are available for these fields in order to reset the counters after a certain time or to be able to add further information.
Abbreviation | Meaning |
---|---|
%j | year two digits, e.g. for '96' |
%J | year with four digits, e.g. for '1996' |
%m | month one-digit from 1-9, as well as A,B,C for October, November, December |
%M | month two digits, e.g. '06' for 'June' |
%z | consecutive number without automatic reset |
%Z | consecutive number with automatic reset at the end of a month or year |
For leading zeros in the consecutive numbers, the number of digits behind them can be specified. For example, it is possible to configure the following counter:
These counter fields can only be used in an interactive user environment. It is not possible to access and set the counters via API or other mechanisms.
Plugins¶
The functionality of the Cortex Engine can be extended with plugins.
Install¶
-
click the button Apps/Plugins (area 3) in the main window of the Cortex-IP Remote admin
-
the plugin is selected and installed via the buttons Directory Import (for plugin in folder form) or File Import (for plugin as XJZ file):
Remove¶
-
select the Apps/Plugins option in the main window of the Cortex-IP Remote Admin (area 3)
-
select the desired plugin and select Delete: