Customization Safety Overview
To ensure safe updates of Hopex environments, you should not modify Hopex standard data but instead safely enrich it.
If you need to change the Hopex standard data, you can override the standard data without overloading it. This ensures that customizations remain isolated and are not impacted by standard Hopex upgrades, while still benefiting from the standard fixes and enhancements.
*See Customization.
Especially when migrating from an earlier Hopex version that did not yet support overriding, you can evaluate the volume, nature, and quality of your customizations to assess their upgradeability and overall safety.
How to check customization safety overview:
1. Launch the detection tool.
A JSON file is generated.
2. Convert the JSON file to an Excel file using Python.
3. Analyze the Excel file.
Launching the Safe Customization Detection Tool
Safe customization detection is performed by the Repository Health Customization Check job.
This job is scheduled to run once a week, every Monday at 04:00 GMT. If needed, you can:
• modify its schedule
• run the job immediately (outside its regular schedule)
The result of the job execution is generated as a JSON file:
• Location:
C:\ProgramData\MEGA\Hopex Application Server\<name of the HAS instance>\LocalData\RepositoryHealth folder
Example:
C:\ProgramData\MEGA\Hopex Application Server\5000\LocalData\RepositoryHealth
• Name:
RepositoryHealthCustoSafeInfo-<yyyy-mm-dd>-HAS_<name of the HAS instance>_<environment name>_<module version>-<repository name>
Example:
RepositoryHealthCustoSafeInfo-2026-07-08-HAS_5000_backup.envtestlab_62_12_39+32-SystemDb
To launch the safe customization detection tool:
1. Connect to the Hopex Administration desktop
2. Click the Scheduling navigation menu.
3. Display the Jobs page.
The list of jobs displays.
4. Select the Repository Health Customization Check job
*Use the list filtering tool to find the job.
5. Click Execute.
The result is written to a JSON file.
Launching the File Conversion (Python)
To analyze the JSON file generated for repository customization check, you need to convert the JSON file to an Excel file using Python.
To launch the JSON file conversion:
1. Access the Utilities > Customization Tools folder of your Hopex installation.
Location: C:\ProgramData\MEGA\Hopex Application Server\<name of the HAS instance>\.shadowFiles\hopex.core\<module version>\Utilities\Customization Tools
2. In the Customization Tools folder, read the Documentation file:
• Install Python 3.8 or later.
• Install the required libraries:
Enter: pip install pandas openpyxl
*If you get troubles with the library installation, you might need to add the Python paths to your environment variables:
<installation path>\Python\pythoncore-<version number>
<installation path>\Python\pythoncore-<version number>\Scripts
• Launch the program:
Enter: python generate_excel_from_json.py
3. In the JSON to Excel Utility, browse and select the safe customization JSON generated file.
4. Click Process.
The safe customization JSON file is converted to an Excel file
Analyzing Customization Safety
Customization safety levels and examples
Safe
These customizations follow the recommendations. They are safe and ensure safe updates of Hopex environments.
Medium safe
These customizations are safe but not recommended. A standard alternative is available.
Examples:
• To add a MetaAttribute to a standard MetaClass, do not create custom MetaAttributes.
Instead use the easy property feature.
• To modify a standard MetaAttributes, do not create custom MetaAttributes.
Instead use the override feature available on the MetaAttribute.
• To rename a standard MetaClass/MetaAttribute, do not create a custom MetaClass/MetaAttribute.
Instead use the override feature available on the MetaClass/MetaAttribute.
Unsafe
These customizations are unsafe. They are not recommended and might generate issues. An override alternative is available.
Examples:
• To modify (add, remove, reorder) a desktop navigation menus, do not add items to its corresponding Working Environment Template.
Instead use the override feature.
• Do not add a Data Access Rule to a standard MetaClass or standard profile.
Instead use the override feature available on the MetaClass or profile.
• Do not add a Report Display Context to a standard profile.
Instead use the override feature available on the profile.
• Do not modify a Display Context associated with a standard profile.
Instead use the override feature available on the Display Context associated with the profile.
• Do not update a standard Set of UI Access Rights, but use the Customizing Set of UI Access Rights feature.
Blocking
These customizations are unsafe and forbidden. There is no alternative.
Example:
• Do not modify a standard macro.
• Do not create an Abstract MetaClass.
Safe customization Excel file description
With the RepositoryHealthCustoSafeInfo Excel file you get all the information to understand the details of your customization safety. Several sheets detail the customizations:
• version sheet:
Indicates your Hopex version.
• MEGAUpdates sheet:
The "Authorize Hopex data modification" option (Environment Options > Installation > Customization) must not be selected for safe customizations.
Indicates blocking when selected.
• a sheet for each customization type
Each row details a customization, the safe cell indicates the safety level of the customization, and the Recommendations cell gives a recommendation.
• Stats sheet: gives a summary of the number of each customization type
For example here,368 System Objects and 2 Custom MetaClasses are blocking.
• CustoSafe: indicates your global customization safety level: safe, medium safe, unsafe, blocking