Update workspace

This feature allows you to update an existing workspace by importing an .e365 file without creating a new workspace in the system.

Suppose one of your company’s departments changes how it processes orders, and the change works well. To apply the same setup in your other departments, you can export that workspace and use the file to update other workspaces. This is much faster and more reliable than applying changes manually.

This article covers the preparation steps before updating a workspace, running the update process, and resolving conflicts when comparing components, access permissions, and registration settings for Document type apps.

Only system administrators can update workspaces.

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

Related articles:

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

Prerequisites for updating

Before updating a workspace:

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

If you transfer a workspace between BRIX instances, the target instance version must be equal to or higher than the version where the workspace was prepared. If changes are incompatible with your system version, the update will fail or components may work incorrectly.

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

If you modified the workspace and structure versioning is enabled in your company, save its current state before updating. This allows you to revert to the previous version if unwanted changes occur during the update.

Start update

  1. Go to the workspace you want to update. To the right of its name, click the gear icon and select Update Workspace.

section-update-1

  1. In the window that opens, select an .e365 file from your computer or from system files with a previously exported workspace. Click Next.

section_update-2

At this step, a warning appears if:

  • The system version is lower than the version where the workspace was prepared. Choose whether to cancel or continue the update process. If changes are incompatible with your system version, the update will fail or components may work incorrectly.
  • The current state of the workspace differs from its captured version. To update the workspace correctly, save its current state by clicking Capture Version. Then start the update.
  1. The system checks the workspace version from the uploaded file. If errors are found, such as duplicate pages, you cannot update the workspace. If the check succeeds, click Next.

update_workspace_02

  1. The system starts comparing the existing and uploaded workspace versions.
  2. When the update finishes successfully, click Go to Workspace.

section_update-4

If structure versioning is enabled in the system, a new version of the workspace is automatically created after a successful update. To learn more about working with workspace versions, see Manage configuration versions.

Comparison of existing and uploaded workspace versions

During comparison, current settings and components of the workspace are automatically matched against the version from the uploaded file. Depending on the detected changes and conflicts, step-by-step dialog windows appear to select your next actions.

Let us review the conflict resolution order, rules for updating access permissions, and synchronizing registration settings for Document type apps.

Check workspace component changes

Components already existing in the target workspace are checked for changes against the new version. If you added new components to the existing workspace before updating (such as business processes or apps), the update will not affect them.

You will see a list of updates and conflicts, and can accept all incoming changes or cancel the update. You cannot resolve conflicts individually.

To continue the update:

  1. Review the list of modified components. They are grouped into three tabs:
  • Change Conflicts. Components modified simultaneously in both the existing workspace and the uploaded version, such as fields added to the same app or edited settings in a business process.

The table displays the name and code of the conflicting component, along with modification timestamps for both the existing and uploaded versions.

During the update, the version from the .e365 file applies to conflicting settings.

section_update-5

  • Namespace Conflicts. Different components sharing the same code created independently in both the existing workspace and the uploaded version, such as two pages with the code info.

The table displays the component name from the uploaded version. Next to it, the current workspace component code appears along with the uploaded component code appended with a digit, such as _1.

If you proceed, the uploaded component is added with the modified code, while the existing component remains unchanged.

section_update-6

  • New Versions. Modified components without conflicts.
  1. To accept all changes, click Confirm Workspace Update.

Check access permissions alignment

If access permissions were edited in the current BRIX instance, a window listing mismatches appears. Select which settings to update to the new version. Unchecked permissions remain unchanged. You can also update all access settings or cancel the update.

section_update-7

Check registration settings alignment in Document-type apps

If registration settings differ between the current and uploaded versions, a list of differing document files appears. They are highlighted as follows:

  • Green for folders listed in the registration settings of the new workspace version but missing in the current version. Select the checkbox next to a folder to add it to Document Categorization and the current company's registration settings.
  • Red for folders used in app registration settings in the current company but missing in the uploaded workspace version. Select the checkbox for folders you want to keep. Unselected folders are removed from app registration settings but remain in Document Categorization. You can add them back to registration settings later.

section_update-8

Choose whether to import only selected settings or all changes.