Update a solution

This feature allows you to update an installed solution by uploading a new version as an .e365 file. During the update, you can apply all changes or use the soft update mode to preserve custom modifications to forms, processes, and other components.

This article describes the steps to take before updating a solution, how to start the update process, and how to resolve conflicts when comparing components, access settings, and registration parameters in Document-type apps. It also explains how soft updates work and provides examples.

Only system administrators can update solutions.

начало примечание

Useful articles:

конец примечание

Step to take before updating

Before updating a solution:

  1. Check the system version (for BRIX On-Premises).

When transferring changes between BRIX company environments, the version in the target environment must be the same as or higher than the version in which the solution was prepared. If the changes are incompatible with your system version, the update will fail or some components may not work correctly..

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

you have customized the solution and structure versioning is enabled in your company, save its current state before updating. This allows you to restore the previous version if the update introduces unwanted changes.

  1. Check that you have the required licenses.

If the new solution version includes licensed components or features, activate the required license before updating.

Start update

  1. Upload an .e365 file from your PC or from the system files and click Next.

At this step, a warning appears if:

  • The system version is lower than the version in which the solution was prepared. Choose whether to cancel or continue 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 solution differs from its committed version. To update the solution correctly, save its current state by clicking Capture Version. Then start the update again.
  1. The system checks the components in the solution version uploaded from the file. If any errors are found, you won't be able to complete the update. For example, errors may occur if dependencies from another solution have been added to the new version or the solution's integrity has been compromised due to component deletion.

If the new solution version contains apps, widgets, or business processes with fields that reference apps from licensed system solutions, a notification will appear. You can proceed with the update, but you must activate the required license to ensure these components work correctly.

Once the solution successfully passes the check, click Next.

update_solution_01

  1. The uploaded solution version is compared with the existing solution in the system. If any conflicts are found, resolve them to complete the update.

If structure versioning is enabled in the system, a new solution version is automatically created after a successful update. For more information, see Manage configuration versions.

Comparing existing and uploaded solution versions

At this stage, the current solution components and settings are automatically compared with those in the uploaded version. Depending on the changes and conflicts detected, a series of windows will appear, prompting you to choose how to proceed.

This section explains how to resolve conflicts, update access permissions, and synchronize registration settings for Document-type apps.

Checking changes to solution components

Components that already exist in the solution being updated are checked for changes in the new version. If you have added new components to the existing solution before updating it, such as business processes or apps, these components will not be affected by the update.

You will see a list of changes and conflicts. You can apply all changes, perform a soft update to preserve your modifications, or cancel the operation.

To proceed with the update:

  1. Review the list of components to be updated. They are grouped into three tabs::
  • Change Conflicts. Components that have been modified both in the current company and in the uploaded solution version. For example, fields have been added to the same app, or settings have been edited in the same business process.
     
    The table displays the names and codes of components with conflicts. It also shows components that depend on them, such as processes associated with an app that has conflicts. You can also view the dates when changes were made in the current company and in the uploaded solution version.
     
    If you confirm the update, the settings from the .e365 file will replace the conflicting settings. To preserve the current settings, use soft update;

solution-update-5

  • Namespace Conflicts. Different components with the same code that were created independently in the current company and in the uploaded solution version. For example, two pages with the code info.

The table displays the name of the component from the uploaded version, as well as the codes of the existing and uploaded components. The code of the uploaded component is modified by adding a number, for example, _1.

If you proceed with the update, the uploaded component will be added with the modified code, while the existing component will remain unchanged.

solution-update-6

  • New Versions. Components with changes that do not cause conflicts.
  1. Select an update option:
  • Confirm the solution update. Then the new version of the solution will completely replace the existing one. Your changes will not be saved.
  • Perform a soft update.
  • Cancel the update.

Check for mismatched access permissions

If there are edited permissions in the target site, select which permission settings you want to update to the new version. Unchecked permissions will remain unchanged. You can also update all access settings or cancel the update.
update_solution04

Check for differences in the registration settings of the Document-type apps

If the registration settings do not match in the current and downloaded versions of the workspace, a list of differing document registration folders will open. They are highlighted:

  • In green. Folders that are specified in the registration settings in the new version of the workspace, but are missing in the current version. Check the box next to the folder to add it to the Document Categorization workspace and to the registration settings in the current company.
  • In red color. Folders that are used in the app registration settings in the current company, but are missing in the downloaded version of the workspace. Check the box next to the folders you want to keep. The unchecked folders will be removed from the app registration settings, but will remain in the Document Categorization workspace. You can re-add them to the registration settings.
    update-solution-5

Soft update of the solution

You can use this update option if there are conflicts between the installed and the new version of the solution. The option allows you to save the changes you have made to components such as business processes, apps, forms, pages, and widgets. During the soft update process:

    • Components with conflicts will not be updated, your changes will be saved.
    • Other solution components will be updated if they are not in the conflict list and they don’t contain links to components with conflicts.
    • New solution components will be added if they do not contain links to components with conflicts.

Let’s look at some examples.

Case 1: Conflict in the solution component

You have added property A to the context of an app that is part of a solution. In the new version of the solution:

  • Property B is added to the context of this app.
  • Widget C is placed on the app creation form.

The result of the soft update:

  1. There will be a conflict in the app, it will not be updated. Property B will not be added to its context, property A will remain.
  2. The app creation form will be updated, it will not have a conflict. Widget C will be added.

Рисунок 1

Case 2: Reference to a component with a conflict

The initial solution contains:

  • The app in the context of which you have added property A.
  • A business process that has a variable that refers to this app.

In the new version of the solution, property B is added to the app context, and a task is added to the process diagram.

The result of the soft update:

  1. There will be a conflict in the app, it will not be updated. Property B will not be added to its context, property A will remain.
  2. The business process will not be updated because it refers to the app in which the conflict occurred.

Рисунок 2

Case 3: A new solution component contains a reference to a component with a conflict

You have added property A to the context of an app that is part of a solution.

In the new version of the solution:

  • Property B is added to the app context.
  • A new process is added that refers to this app.

The result of the soft update:

  1. There will be a conflict in the app, it will not be updated. Property B will not be added to its context, property A will remain.
  2. A new business process will not be added because it refers to the app with the conflict.

Рисунок 3

Soft update of a locked workspace

If the solution contains a locked workspace, the soft update ignores dependencies between this workspace and the unlocked workspace where conflicts are found. In this case, the components of the locked workspace (apps, processes, widgets) will be updated.

Let’s consider the specifics of such an update. Components of a locked workspace:

    • Will be updated if they refer to components of an unlocked workspace in which conflicts are found.
    • Will be updated if they are referred by components of an unlocked workspace in which conflicts are found.
    • Will NOT be updated if they contain conflicts.
    • Will NOT be updated if there are dependencies between them and components of another locked workspace where conflicts are found.

Let’s analyze the case on the example of the HR solution that contains a locked HR workspace and an HR Settings workspace available for changes:

  1. In the installed version of the solution, within the HR Settings workspace, add a task to the process that references the locked HR workspace app.
  2. Let’s assume that in the new version of the solution:
  • Within the HR workspace, property A is added to the context of the app that is associated with the changed process.
  • Within the HR Settings workspace, property B is added to the context of the process we have changed.
  1. Let’s run the solution update.
  2. During its checking phase, it will show conflicts in the process that is changed within the HR Settings workspace. In this conflict, we will see dependencies with the app in the locked HR workspace.
  3. Let’s apply a soft update to the solution and get the following result:
  • The app within the locked HR workspace will be updated, and property A will be added to the app context. Dependencies found in the conflict will be ignored.
  • The process within the unlocked HR Settings workspace will not be updated. The task in it will be saved, property B will not be added to the process context.

Рисунок 4