Administration
From the Administration section in the MDM Web App Admin Center, you can:
-
Upload performance configuration and retrieve performance statistics.
-
View and edit MDM-specific runtime parameters.
-
Update logging levels for easier troubleshooting.
-
View the server status and latest configuration, stop and start the server, and manage the MDM repository.
Template Manager
This section displays the template status, error log, a list of loaded templates, and a list of entities without a template.
Select Reload Templates to refresh templates, or Drop Templates to revert to standard templates.
Performance Tuning
This section allows you to download and upload performance settings as well as download performance statistics. This feature helps optimize and monitor the performance of SQL queries in the application, enabling developers to make the necessary adjustments to enhance overall performance.
| Performance tuning is only available for PostgreSQL databases. |
To optimize the performance of SQL queries:
-
Select Download CSV to download performance settings. Optionally, to detect queries that cause performance issues, download performance statistics as well: select Download under Performance stats.
-
Adjust the settings as needed in the CSV file.
-
In Upload performance settings section, drag and drop the modified file or use the Browse files option. To confirm your choice, select Upload CSV.
The configuration is now updated with the new settings.
Runtime Parameters
This section shows the MDM-specific runtime parameters that are used by the engine.
To edit a value, select the pencil icon next to the value.
After you edit a parameter, an undo option becomes available. Select the icon to revert the parameter to the previous value.
| After you save your changes, you can also revert the new value to the default one. |
Once you’re done editing, select Save all changes to have your changes applied at once.
Similarly to committing configuration changes, try to save changes once per session, especially if you are modifying several properties related to the same functionality. This helps ensure consistency and prevent issues due to potentially incompatible configuration.
Note that some parameters require a server restart to take effect. This is indicated in the Restart needed column.
A dot next to the parameter value helps you keep track of the configuration history:
-
A green dot means that the current value is already in use.
-
A yellow dot means that the current value is saved but not yet applied. In that case, a server restart is required.
To be able to perform Runtime Parameters actions, you must have the role defined by the ataccama.one.mdm.admin-center.manager.required-roles MDM Server application property.
For more information, see MDM Admin Center permissions.
|
Logging Configuration
This section allows you to dynamically adjust logging levels for issue identification and debugging purposes. These changes are temporary and are not kept after the application is restarted.
To be able to perform Logging Configuration actions, you must have the role defined by the ataccama.one.mdm.admin-center.manager.required-roles MDM Server application property.
For more information, see MDM Admin Center permissions.
|
Server Dashboard
This section provides information about the MDM Server status, current MDM configuration, and latest commits. In addition, it allows you to stop and start the server, reset the environment, and perform Git operations: clone repository, fetch changes, and apply a specific commit.
To be able to perform Server Dashboard actions, you must have the role defined by the ataccama.one.mdm.admin-center.manager.required-roles MDM Server application property.
For more information, see MDM Admin Center permissions.
|
Server Status
This section provides information about the MDM Server status and the time when the server was started. It also allows you to stop and start the server and reset the environment.
The ability to start and stop the server cannot be restricted for roles with manager access.
Possible server statuses are:
| Status | Description |
|---|---|
Starting |
The server is starting. |
Started |
The server started and is running. |
Stopping |
The server is stopping. |
Stopped |
The server stopped and is no longer running. |
Failed |
Starting the server failed. |
Stop MDM Server
If the MDM Server is running, the information about the status and the server start time is displayed.
It is possible to stop the server when the server status is Started or Starting.
To stop MDM Server, select Stop server and confirm your choice in the window that opens. The server status changes to Stopping and then to Stopped.
| For production environments, it is not possible to stop the server. |
Start MDM Server
The option to start the server is available when the server status is Stopped or Failed. To start the server, select Start server.
The server status changes to Starting. In this state, the option to stop the server is available.
If the server fails to start, the status changes to Failed. After fixing the issue, you can start the server again.
If the server successfully started, the status changes to Started.
Maintenance Status
In this section, you can view the information about the configuration and environment status. Additionally, from here you can reset the environment, migrate runtime parameters, or manually clone the configuration repository.
Environment status
In this subsection, the information about the status of Reset environment operation is displayed.
| Status | Description |
|---|---|
Idle |
No operation is currently running. |
Failed |
The operation failed. |
Running |
The operation is running. |
Reset environment
The process of resetting the environment includes clearing all database tables and deleting resource files (specified in the ataccama.one.mdm.server.refresh.dirs-to-delete application property, see MDM Server Application Properties, section MDM features).
The action does not affect the configuration. This functionality can be useful for development and testing purposes.
|
You can only use the feature for PostgreSQL databases, otherwise an error is thrown. For production environments, it is not possible to reset the environment. |
To reset the environment:
-
Make sure the server status is Stopped or Failed. Otherwise, stop the server by selecting Stop server in the Server Status section.
-
In Maintenance Status, select Reset environment.
-
Confirm your choice. The environment status now changes to Running.
In this state, the option to stop the server is available.
-
Once the resetting is finished, the environment status is changed to Idle. You can now start the server.
To disable the functionality, use the ataccama.one.mdm.features.environment.reset.enabled property (see MDM Server Application Properties, section MDM features).
Migrate runtime parameters
Use this option to make sure the runtime parameters are up to date.
|
Manual migration is intended to be used as a last resort option in cases where the configuration must be reset to a previous version and no other options are available. Once the initial migration is completed, which is done automatically after upgrading, we strongly recommend editing MDM-specific runtime properties only in the MDM Web App Admin Center. |
For example, you can run migration after resetting your environment or after changing your configuration in the repository. This overwrites the runtime parameters with the latest configuration. If you reset your environment but skip the migration, the default configuration values are used instead.
If you changed configuration in the repository, fetch the latest changes first and then run the migration.
In case the migration fails due to incorrect configuration, check the log to find the root cause of the issue. Fix the issue in the configuration file, then fetch the latest changes and rerun the migration.
To migrate runtime parameters:
-
Make sure the server status is Stopped. Otherwise, stop the server by selecting Stop server in the Server Status section.
-
In Maintenance Status, select Migrate runtime parameters.
-
Confirm your choice and wait for the migration to complete. The environment status now changes to Running.
-
Once the migration is finished, the environment status changes to Idle.
You can now start the server.
Configuration status
In this subsection, the status of the following operations is displayed:
Only one operation can be run at a time.
| Status | Description |
|---|---|
Idle |
No operation is currently running. |
Failed |
An operation failed. |
Running |
An operation is running. |
Clone repository
It is possible to clone the repository from MDM Web App. Manual cloning can be useful if initial cloning process during startup failed.
To clone the repository:
-
Make sure the server status is Stopped or Failed. Otherwise, stop the server by selecting Stop server in the Server Status section.
-
In Maintenance Status, select Clone config repository.
-
Confirm your choice. The configuration status now changes to Running.
-
Once the status changes to Idle, you can start the server.
Current configuration
In this section, the following information about the last applied configuration change is displayed:
-
Date and time
-
Commit message
-
Commit identifier
-
Commit author
Latest commits
In the Latest commits section, the information about 20 latest commits is displayed. In addition, from this section you can perform the following operations: fetch changes and apply a specific commit.
Fetch changes
You can run the fetch operation regardless of the current server status.
To see the latest changes made to the Git remote repository:
-
Select the circular arrow icon next to the section name. The configuration status changes to Running.
-
Once the operation is complete, the configuration status changes to Idle. The information about newer commits is now displayed at the top of the commit list with the Apply option (see Apply commit).
Apply commit
Only the commits that are newer than the one displayed in the Current configuration section can be applied.
To apply the changes:
-
Make sure the server status is Stopped or Failed. Otherwise, stop the server by selecting Stop server in the Server Status section.
-
Select Apply in the corresponding row.
-
Confirm your choice by selecting Apply. The configuration status changes to Running.
Once the changes are applied, the configuration status changes to Idle. The corresponding commit is now displayed in the Current configuration section.
-
You can now start the server.
To disable the functionality, use ataccama.one.mdm.server.git.enabled property (see MDM Server Application Properties, section Git operations).
Was this page useful?