Report on resource replace variants

Context

Standard workspace structure specifies the appearance of a workspace in censhare Web. Resource replace variants specifically adapt individual elements of the workspace for all users or specific roles.

Prerequisites

• Extensive knowledge about the standard workspace structure and the possible adaptations

Introduction

Resource replace variants can be used to customize a page of the standard workspace structure with its containers (tabs) and widget configurations. If an asset in the standard workspace is to behave differently for several roles, the asset can also have several resource replace variants. This means that resource replace variants with different roles can exist at many different points in the standard workspace structure in the censhare system. A report in the system asset provides an overview of all resource change variants for the standard workspace structure.

The report for "workspace replace variants" list all resource replace variants (1), workspace containers (2) and workspace widget configurations (3).

The list shows the pages, containers (tabs), and widget configurations for which resource replace variants exist. The report displays the most important changes to the standard workspace asset for the resource replace variants. This makes it easier to see which adjustments you have made.

The report also shows which roles are linked to each resource replace variant. The role determines whether a resource replace variant applies to a user. In a report, you can also recognize if role assignments are not unique. These can cause conflicts during the construction of the workspace.

Note: The report does not display whether the standard workspace asset of a resource replace variant has changed. Patches or updates can change the configuration of default workspace assets. This can lead to resource replace variants no longer being compatible. This will then need to be manually corrected.

There is a similar report for the workspace templates created in censhare.

The report

You can find the report in the "Workspace replace variants" widget on the Administration tab. It lists the following resource replace variants:

• Pages (asset pages)

• Container (tab)

• Widgets (widget configurations)

There is a separate section for each of the three asset types. It lists the original asset of the standard workspace structure. This is followed by all resource replace variants for this asset.

In the "Pages" section, the report also displays which container assets of the standard workspace assets are also used by the resource replace variant. The report also lists which container assets have been added to or removed in comparison to the standard workspace assets. With one click you can jump to the respective container assets.

Similarly, in the "Container" section, you can see which widget configurations:

• Are unchanged

• Added

• Have been deactivated in the resource replace variant

With one click you can jump to the respective widget configuration assets.

In the "Widgets" section you can see all resource replace variants for configuration widgets.

For every replace variant, censhare also lists whether there are definitions for these roles too. For example, you can see for which roles there are already variants and for which you still have to define them. However, you can also recognize conflicts in role assignment:

• However, only one resource replace variant without a role can exist for each asset. If there are several, the behavior how censhare selects is undefined.

• A role may only be used in one resource replace variant of the same standard workspace asset. To do this, you must go through all roles below a standard workspace asset and check whether a role appears more than once.

Find more information in the article about resource replace variants.

Each standard workspace asset listed in the report and its resource replace variants are linked to the assets. You can therefore double-click at any time to jump to the asset to edit its configuration.

If you open the "Workspace" tab of the system asset, censhare automatically updates the reports on this page. If you make changes to the resource replace variants while the report is open, censhare does not display them automatically. You have to update it first. To do that, click the "Refresh data" button in the top bar of the Workspace replace variants widget.

Configuration of the Report widget

By default, you can find the report on the "Workspace" tab of the system asset. If you want to display the report on another tab, use the "csReportWidget" widget. You can add the widget to a tab in Developer mode. Use the entry "Add widget type" in the action menu of the respective page. Select the "Report" entry in the selection list.

censhare generates the report using an XSLT script. This is stored in the asset with the resource key "censhare:report.workspace.replace-variants". In the corresponding widget, go to the upper right and click the "Configure widget" entry in the widget action menu. In the following dialog, select the "Workspace changes" entry in the "Transformation" field of the "Report" section.

Result

You have an overview of all resource replace variants that exist in the system and to which roles they are assigned.