Variant management

A variant is a direct copy of the original diagram or catalog object that can be edited as required. The variant is adopted in the maintained content languages of the original diagram or catalog object. This is helpful, for example, if a process is generally used in the company but adaptations are required in individual countries.

Diagrams

How can I create a diagram variant?

As an Author, Editor, and Administrator, you have the ability to create variants of checked-in diagrams in the Public workspace.

First, open the context menu for the diagram from which you intend to create a variant and select the Create variant option.

The screenshot shows the option "Create variant" in the context menu of a diagram.

A dialog window will open, where you can adjust the name of the diagram as required. The name of the original diagram will be displayed in the input field by default.

The screenshot shows the dialog window for creating a diagram variant.

Then, click on Create to create a variant. If you want to cancel the process, click on Cancel. After the variant is created, the diagram will be displayed as the top entry in the category you are in. To obtain an alphabetically sorted list, please refresh the page.

Once the variant has been created, you will be able to locate the attribute Variant origin in the Details panel when diagram is checked-out. This will establish a reference to the original diagram from which the variant was created.

The screenshot shows the attribute "Variant origin" in the details of a diagram.

Once a variant is created, you are automatically entered as the author in the governance attribute, depending on whether you or one of your user groups is entered as the author in the original diagram. You can then check out the variant and edit it. This also applies if you are not yet stored as a person object in the catalog. In this case, the system will automatically create an accepted person object as a catalog entry.

Note

It is also possible to create variants of variants.

How can I compare diagram variants?

You have the option of comparing variants with each other. You can compare both the base diagram with a variant and a variant with another variant.

To do this, click on Variants in the options of the checked-in or checked-out diagram.

The screenshot shows the option "Variants" in the variant comparison.

You can then select a diagram variant, the stage and the version. Then click on Compare to compare a diagram variant with the diagram being displayed.

The screenshot shows the selected options with the option "Compare".

If the diagram being displayed contains at least one object that is different from the diagram variant, the object is listed in one of the following sections:

  • Not included in displayed diagram: The object is not included in the displayed diagram.

  • Only included in displayed diagram: The object is included in the displayed diagram only.

  • Different attribute value: The object has different attribute values in the displayed diagram.

How can I highlight the differences between the diagram variants in color?

To highlight a different in the diagram variant in color, you can click on the object of the corresponding section.

The screenshot shows the options of showing changes in the variant comparison.

Hint

Non-existent object cannot be colored in the diagram and appear only in the Not included in displayed diagram section.

The object is then highlighted in the section and in the displayed diagram. A green marker indicates Only included in displayed diagram and a yellow marker indicates Different attribute values.

The screenshot shows the colored highlight of a changed object in the variant comparison.

If only objects have been rearranged between the displayed diagram and the diagram variant, the diagram name has been changed, or no changes have been made, you are notified that no changes were detected during the comparison.

How can I add or remove objects when comparing diagram variants?

You can add or remove objects while you are comparing a diagram variant with the displayed diagram. To do this, you must have checked out the displayed diagram.

When you move the mouse pointer over the Not included in displayed diagram section, the Add to diagram button appears. This allows you to add the object to the diagram that is included in the diagram variant but not in the diagram being displayed.

The screenshot shows the option "Add to diagram" in the "Not included in displayed diagram" section in the variant comparison.

When you move the mouse pointer over the Only included in displayed diagram section, the Remove from diagram button appears. This allows you to remove the object from the diagram that is included in the displayed diagram but not in the diagram variant.

The screenshot shows the option "Remove from diagram" in the "Only included in displayed diagram" section in the variant comparison.

Clicking the respective button will execute the action immediately, and the change will no longer appear in the comparison. The only way to undo the action is to discard the local changes or click Undo (alternatively CTRL+Z) in the editor.

Where can I see and apply changes to attribute values between diagram variants?

To view the changes to the object’s attribute values in the displayed diagram, move the mouse pointer to the Different attribute values section. This will display the Show changes button. Click this button to view the changes.

The screenshot shows the button "Show changes" in the "Different attribute values" section in the variant comparison.

This opens a table showing the changes made to the selected object. The left column lists the changes made, while the middle and right columns allow you to compare the differences between the displayed diagram (middle column) and the diagram variant (right column). To close the table, click Close.

The screenshot shows a table with different attribute values.

If you have clicked on the Show changes button in the checked-out diagram, you will find an Update option in the displayed table. This allows you to apply the diagram variant’s attribute value to the displayed diagram. Then click Confirm to finalize the change.

The screenshot shows the option "Update" in the table for the variant comparison.

If you clicked Update for the wrong attribute value, you can undo it by clicking Undo update. To discard all changes, click Cancel.

The screenshot shows the option "Undo update" in the table for the variant comparison.

Catalog

How can I create a catalog variant?

As an Author, Editor, and Administrator, you have the ability to create variants of catalog objects in the Public workspace.

First, open the context menu for the catalog objects from which you intend to create a variant and select the Create variant option.

The screenshot shows the option "Create variant" in the context menu of an catalog object.

A dialog window will open, where you can adjust the name of the catalog object as required. The name of the original catalog object will be displayed in the input field in the active content language by default.

The screenshot shows the dialog window for creating a catalog variant.

Then, click on Create variant to create a variant. If you want to cancel the process, click on Cancel. After the variant is created, the catalog object will be displayed as the top entry if the option Open details after creation is deactivated. To obtain an alphabetically sorted list, please refresh the page.

Once the variant has been created, you will be able to locate the attribute Variant origin in the Details when you open the catalog object. This will establish a reference to the base catalog object from which the variant was created.

The screenshot shows the details of a catalog variant.

Once a variant is created, you are automatically entered as the author in the governance attribute, depending on whether you or one of your user groups is entered as the author in the base catalog object. You can then edit the variant. This also applies if you are not yet stored as a person object in the catalog. In this case, the system will automatically create an accepted person object as a catalog entry.

Note

It is also possible to create variants of variants.

Hint

Please note that Catalog variants and base catalog objects cannot be rejected if they are a catalog suggestion. However, they can be changed from an accepted catalog object back to a catalog suggestion.

What happens if the base catalog object is deleted?

When you delete a base catalog object, another dialog windows appears asking you to confirm the deletion.

Once you confirm the deletion, the base catalog object no longer exists in the catalog and can no longer be displayed in the catalog variants. However, the catalog variants still indicate that the catalog variant is a variant.

The screenshot shows the not available original catalog object of a catalog variant.