Insites Modules

The Insites Platform is structured via modules to promote modularity and maintainability in its codebase. This design lets you choose which platform modules are updated when a new version is released. Whilst breaking changes are avoided at all costs, from time to time, they are required, and therefore, you can decide if and when your instances modules are updated via the Insites Console.

Instance UUID

The Instance Universally Unique Identifier (UUID) is a globally unique identifier assigned to each Instance. You can find the UUID of your Instance in the Insites Console:

1. Sign in to the Insites Console and open your Instance.
2. Select CLI Commands. This section is shown to members with the Developer role or above on the Instance.

The command under Add this instance as an environment includes the Instance UUID after .

Viewing an Instance Modules Change log

The change logs enable you to view the bug fixes, new features, or improvements that may have been released on each version of a Module. To view the change logs of a particular module:

1. Navigate to Settings from the main menu.
2. Select Insites Modules.
3. Find the Module whose change logs you want to view and click on its View Change Log link.

Breaking Changes

A breaking change is a change to a Module that stops existing code, API calls or data from working the same way. In other words, a breaking change causes existing functionalities or API endpoints to be updated with a new format or naming convention, potentially leading to errors or disruption of the user experience or data integrity.

Breaking changes are avoided as much as possible; however, they become necessary for certain releases. These include security updates, major restructures, adoption of new standards and technologies, or removal of outdated features.

How to handle breaking changes involving field name updates

Handling breaking changes on your Instance that involve database field name updates usually involves the following steps:

1. Export and back up the data of your Instance.
2. Before updating the Module, carefully read the module update documentation and review any dependencies.
3. Update the Module via the Insites Console.
4. Download the CSV template from the updated module.
5. Update your exported from Step 1 to the updated format in Step 4.
6. Import the updated file to the Instance.
7. Test the system functionality and features to see if they work as expected.