Import and update a module

You can install a ready-made module into the system from an .e365 file, as well as part of a business or system solution.

To update a module, upload it to the system again, following the same steps as for the initial import. If the module IDs match, the existing module will be replaced with the imported one.

Only system administrators can import and update modules.

Preliminary steps before updating

If you are updating an existing module:

  1. For BRIX On-Premises, check the system version.

When transferring changes between BRIX instances, the target instance must be running a version that is the same as or higher than the version used to prepare the module. If the changes are incompatible with your system version, the update will either fail or cause components to work incorrectly.

  1. Save the current state of the module by creating a version.

If you have customized the module and structure versioning is enabled in your company, save its current state before updating. This will allow you to restore the previous version if any unwanted changes occur during the update

Import a module from an .e365 file

You can transfer a module from one company environment to another by first exporting it to a file. Then, upload the module to the target company environment:

  1. In the left menu of the main page, click the plus icon. Alternatively, go to Administration > Modules and click + Module.
  2. In the window that opens, select the Upload File option.
  3. Select a .e365 format file to upload from your local computer.
  4. At this step, a warning will be displayed if:
  • Your system version is lower than the one used to create the uploaded module. Choose whether to cancel or proceed with the update. If the changes are incompatible with your system version, the update will fail or some components may not work correctly.
  • The current state of the module being updated differs from its captured version. To update correctly, save the current state of the module by clicking Capture Version. Then, start the import again.
  1. Review the brief description of the module being installed. It will display the module version if it was committed in the source instance.
  2. Wait for the validation to complete, then click Next to finish the import.
     
    Note that when you update a module, it is completely replaced with the version from the uploaded file. Any changes you have made to the module in the target instance will be lost. Save the module version before updating so you can restore it if needed.
  3. Click Go to Module in the window that opens.

If structure versioning is enabled in the system, a version of the module is automatically created after a successful import or update. To learn more, read the Manage configuration versions.