Administration

The administration can be reached via the menu item named Administration.

You can use the breadcrumb navigation in the administration. If you have opened a tile of the administration, you can switch to the start page of the administration via the header bar.

User management

In the User management tile, you will find an overview of all existing users and have the option to manage your users and creating a user and license report.

Once you have clicked on the tile, you will be shown a list of all existing users with their individual data. The content area of this list presents columns with the user details, and each user is displayed in a separate row with personal information such as Name, User role, Language and Email.

Hint

Please note that the functions of the User management tile are not available in the mobile view.

How can I create a user?

To create a new user, click on Create user in the options panel next to the list.

This will open a dialog window where you need to enter the user’s name and email address. Additionally, you have the option to set the user’s language and assign the BIC Process Design role. Furthermore, there is an option to create the user via SSO.

To create the user, click on Create. Alternatively, you can discard the input by clicking on Cancel.

The new user will now be displayed as the first entry in the list. Upon reloading the page, the user list will be displayed in alphabetical order.

How do I edit a user’s details?

In the user details, you can set or change user-specific information. This includes Name, Email, Language, Process Design Role, Process Execution Role, and the assigned user groups. Here you can find out which permissions the BIC Process Design and BIC Process Execution roles have.

Navigate to the list of users and select the user whose details you want to edit to view their user-specific information.

In the respective input fields, you can then set or change the user details.

After making a new setting, it will be saved directly, and you will receive a success message. If the saving fails, you will receive an error message.

Which user roles are available and which permissions do they have?

In general, you have five different user roles for Process Design, with different authorizations that build on each other. Your active user role is displayed on the MyBIC page under your name or in the profile.

Reader: Readers only have access to the publication stage. This means these users are able to see published diagrams and all attributes, symbols, catalog entries and documents which are associated with these diagrams. In the publication area readers can create comments and reports and also use the print preview function. In addition they can add diagrams to their favorites.

Reviewer: Reviewers have similar access to the publication stage as Readers and possess the same permissions. Additionally, Reviewers have access to the preview stage and can view and work on assigned governance tasks (publication, depublishing, resubmission) if they are designated as a reviewing authority for a specific diagram or catalog entry. However, Reviewers are unable to initiate a governance workflow themselves.

Author: Authors have essentially the same rights as Reviewers. They also have access to the public workspace. This allows them to see all catalog entries and diagrams in the public workspace. This generally allows them to model diagrams and automatically generate catalog entries. To use these features, users with the Author role must be entered as Author in the attributes of the corresponding diagram or object. This allows Authors to be used specifically for modeling individual diagrams or editing individual objects.

Editor: Similar to authors, the role of Editor is used to edit and create diagrams. Unlike authors, Editors do not have to be set within the diagram attributes to model a diagram. Additionally, editors have the ability to make cross-diagram changes. This means users with the role of Editor have the right to manually create, edit, or delete catalog entries and are authorized to accept or decline catalog entries. Furthermore, editors have the ability to assume administrative tasks for governance workflows. They have the authority to view and manage all governance workflows. In the governance cockpit, editors have the same rights as administrators, which means they can delegate or cancel workflows.

Administrator: Administrators have all the rights that other user roles have. In addition, they have special administration rights. These include access to the administration area, the right to create, delete, and rename repositories, as well as the ability to unlock diagrams.

Accessible workspaces	Administrator	Editor	Author	Reviewer	Reader
Public workspace	entitled	entitled	entitled	not authorized(*)	not authorized(*)
Preview	entitled	entitled	entitled	entitled	not authorized(*)
Publication	entitled	entitled	entitled	entitled	entitled

(*)Read-only access can be granted to individual diagrams in the public workspace (view share diagram from public workspace)

If you use BIC Process Execution, you have the possibility to set the user’s role for this application as well.

ProcessApp Administrator: As a ProcessApp Administrator, you have access to the administration area and can manage all available options.

ProcessApp Analyst: As a ProcessApp Analyst, you have access to the monitoring dashboard and can monitor all processes.

ProcessApp Creator: As a ProcessApp Creator, you can model executable processes in Process Design. If you want to further edit a diagram and you have this role, you have the possibility to open the editor by right-clicking an activity in the context menu. Alternatively, you can also open the editor by selecting the activity and choosing the Editor section from the Details menu. There, you will find a button that allows you to open the editor. Only users with the ProcessApp Creator role have the option to use the Test ProcessApp button in the preview stage or in the public workspace within the diagram view in Process Design and work on tasks.

ProcessApp User: As a ProcessApp User, you can initiate processes and see how far along they are. You can use the Create Case button in the diagram view of Process Design at any stage and work on tasks if you have the ProcessApp User role.

Warning

Please note that both the ProcessApp User role and the ProcessApp Participant role are currently required to edit and manage tasks.

Hint

Please note that these roles are not hierarchical. This means that if, for example, you are assigned the role of ProcessApp Administrator, you do not automatically have access to the rights of other roles. To obtain additional rights, you need to select multiple checkboxes of the Process Execution roles.

How can I delete a user?

To delete a user, there must be at least one user existing. Click on the desired user in the list to expand their user details. Then, you will see the option Delete user.

Subsequently, a dialog window will open, where you must confirm your deletion. Click on Delete to confirm the deletion permanently, or on Cancel to abort the deletion.

Afterward, the user will be permanently deleted and removed from the list.

How can I reset a user’s password?

To reset a user’s password, navigate to a user in the list and expand their user details. Then, you will see the option to Reset password.

This will open a dialog box. If you click Reset, an automatic email with instructions on how to reset the password will be sent to the selected user. To cancel the operation, click Cancel.

How can I filter by user roles?

You have the option to filter the list of users by their roles. If necessary, switch to the Filter tab in the right sidebar. There, you will see the Process Design Role filter, and you can select which user role to filter by. Additionally, you have the option to search for users using the search field.

Afterward, only the users in the list that match your entered filter options will be displayed.

Note

If the user list is already filtered, a new search further reduces the list based on the selected filter options

How do I create a user report?

To create a user report, go to the Options and click on Create user report (Excel).

Once the user report is generated, a message will appear at the bottom right corner of the screen. This message contains a download link through which you can download the user report.

User groups

In the User groups tile, you can create and manage user groups.

After clicking on the tile, an alphabetically sorted list of all existing user groups appears.

Hint

Please note that the functions of the User groups tile are not available in the mobile view.

How can I create a user group?

To create a user group, navigate to the options area next to the list and click on Create user group.

This will open a dialog window where you need to enter the name for the new user group.

Once you have entered at least one letter or number, you can click Create to create the user group. To discard the input, click Cancel.

The new user group will now appear as the first entry in the list. Upon reloading the page, the user group will be displayed in alphabetical order.

How can I rename a user group?

To rename a user group, there must be at least one user group available. Click on the desired user group to expand it. Then, you will see an input field with the current name of the user group.

The input field is not read-only, and you can change the name as many times as you want, as long as at least one letter or number is present. Once you add, edit, or delete at least one letter or number, your changes will be immediately visible.

How can I delete a user group?

To delete a user group, click on the desired user group to expand it, and select Delete user group.

A dialog window will appear, prompting you to confirm your deletion. Click Delete to confirm the deletion permanently, or Cancel to abort the deletion.

Subsequently, the user group will be permanently deleted and removed from the list.

How can I add a user to a user group?

If there is at least one user group available, you can add users there. Click on the user group to expand it, and then select Add user.

This will open a dialog window. You will see a search field and an alphabetically sorted list of users who are not part of the user group. You can search for users and select the ones you want to add to the user group.

Once you have selected at least one user, click Add to add them to the user group. To discard the selection, click Cancel.

The newly added users will then be displayed in the user group.

How can I remove a user from a user group?

If there is at least one user group with at least one user, you can remove the users from the user group. Click on the user group to expand it, and select Remove user next to the user.

Subsequently, the user will be removed from the user group. If necessary, you can add users back to the user group.

User logins

How can I analyse the system usage?

If you click on the menu entry for Administration in the menu bar, you will see the tile User logins.

Afterwards, a diagram appears which graphically represents the number of user logins over the last 12 months. This visualization of the user logins enables you to check how often the application is actually used by a client.

You can see the exact login frequency of a specific month in a tooltip by hovering the mouse cursor over the graph.

Hint

The number of logins can be higher than the number of users in a company because every single login of a user is counted. This means that if, e.g., a user signs in to the system several times in one day, each login will be counted.

Repository

In the Repositories tile, you will find an overview of all existing repositories and have the option to create new repositories.

After clicking on the tile, you will be presented with an alphabetically sorted list of all existing repositories in your active language. Depending on the chosen language, the alphabetical arrangement of repositories may vary.

Hint

Please note that the access restrictions defined for a repository can prevent navigation to the content of a repository within the user interfaces. In order to reliably control access to individual contents of a repository, it is recommended to apply the access restrictions specifically to the content elements such as diagrams and catalog items.

How can I create a new repository?

To create a new repository, click on the Create repository button in the upper right corner. This will open a dialog window where you need to provide a name for the new repository. Once you have entered at least one letter or number, you can click on Create. If you choose to Cancel instead, your input will be discarded, and no new repository will be created.

Your new repository will now appear as the first entry in the list in your current language. After refreshing the page, the repository will appear in the correct position in the alphabetical order.

You can now select the new repository from the drop-down menu under Diagrams and Catalog.

How can I edit a repository?

If at least one repository is available, you can edit its properties. This includes renaming the repository and adjusting access restrictions.

To edit a repository, click on the corresponding list entry. Alternatively, you can select the Edit properties option from the context menu. This will open a dialog window where you can make the desired changes.

If you want to restrict access to the repository to specific users, user groups, persons or organization units you have the option to enter the corresponding name in the Access restriction field. This input is optional and therefore not mandatory.

Afterwards, select Confirm to apply the changes or Cancel to discard the changes.

Hint

Please note that the access restrictions defined for a repository can prevent navigation to the content of a repository within the user interfaces. In order to reliably control access to individual contents of a repository, it is recommended to apply the access restrictions specifically to the content elements such as diagrams and catalog items.

How can I delete a repository?

If there is at least one repository available, you have the opportunity to delete a repository. To do this, open the context menu of the corresponding repository and select the Delete option.

Following that, a dialog box will appear where you need to enter the name of the repository you want to delete. Once you have entered the name correctly, you can click on Delete. If you wish to cancel the deletion process, click on Cancel.

Hint

Please note that the input is case insensitive.

The repository has been successfully deleted and will no longer be displayed in the list.

How can I publish a repository?

To publish a repository, you need to be assigned the Administrator role. Navigate to the Diagrams section in the menu and click on the context menu next to Repository in the category tree. Select the Publish option.

A dialog window will appear where you need to enter a comment and the name of the repository you want to publish.

Hint

Please note that the input is case insensitive.

To finalize the publishing of your repository, click Publish. Alternatively, you can cancel the process by clicking Cancel.

After successful publication, you will receive a notification at the bottom right corner of the screen. If the publication fails, you will receive an appropriate error message.

How can I export a repository?

To export a repository, you need to be assigned the Administrator role. Navigate to the Diagrams section in the menu and click on the context menu next to Repository in the category tree. Select the Export option.

Afterward, a notification will appear at the bottom right corner of the screen, indicating that the export is being created. Once the export is completed, you can download the repository archive using the provided link in the notification.

Corporate Design

How can I customize the appearance of the application?

In the Corporate Design tile, you can customize the color scheme of the application, upload a logo, and create a start diagram.

After clicking on the tile, you can choose the primary color of the application, upload a logo, and adjust its background color. When selecting colors, you can either enter a HEX code manually or choose a color from the color palette.

To select a start diagram, which will then be displayed for every user on the myBIC page, at least one diagram must already be published.

Once you have made at least one change, it will be automatically saved and applied. To view the changes, refresh the page.

Hint

Please note that the functions of the Corporate Design tile are not available in the mobile view.

Catalog

How can I edit the details of catalog object types?

In the Catalog tile, you have the option to edit the catalog object types.

Once you have clicked on the tile, you will be directed to the details page, where all object types are listed in alphabetical order according to the browser language. Each entry in the list shows the name and symbol of the object type.

If you click on an entry in the list, you will be taken to the object type settings, where you can make various settings for the respective object type.

On the left-hand side, you have various setting options for how the selected object type should be managed and displayed. These can be activated or deactivated using a toggle switch.

On the right-hand side is a list of attributes that are available as filters in the catalog for this object type. These can be activated or deactivated by clicking on the respective checkbox.

Note

A maximum of 127 facets can be selected for a catalog object type. The facets are displayed according to the selected attributes.

Click on the arrow at the top right to collapse the object type settings for the selected object and return to the list of all object types.

Note

If saving the new value fails, an error notification is automatically sent in the form of an error message.

Hint

Please note that the functions of the Catalog tile are not available in the mobile view.

Languages

How can I define languages for my users?

In the tile Languages, you can set the default languages as well as additional content and alternate languages for your users.

After clicking on the tile, an alphabetically sorted list of all languages supported by BIC will appear. By clicking on a selected language, you can define the content and alternate languages. To set a language as the default, click on the Web icon within the language entry.

Hint

Please note that the functions of the Languages tile are not available in the mobile view.

Archive

In the Archive tile, you can configure the settings for the archive and define the access permission for Reader.

Hint

Please note that the functions of the Archive tile are not available in the mobile view.

How can I change archive settings?

As an administrator, you have the option of customizing the settings for the archive in the Public workspace, Preview, and Publication areas across all diagrams. In addition to activating or deactivating the archive, it is also possible to configure the retention period individually.

The archiving status can be activated or deactivated using the toggle switch. If you activate archiving, the input field becomes active and can be edited. If archiving is deactivated, the input field remains locked, and the corresponding value is displayed in read mode.

If archiving is activated, you can use the input field to change the retention period as required. Any changes are saved immediately, and a notification of the successful changes appears at the bottom right-hand side of the screen.

How can I set access permission for Reader?

In the archiving settings, you can set access permissions to archives for the Reader user role. If you have disabled access, Reader cannot access or compare archived versions of diagrams and objects in the publication.

To set access permissions, scroll down to the bottom of the archiving settings and toggle the switch under Access.

Method

In the Method tile, you can manage your methods, customize the colors of the symbol types and configure the diagram layout.

Hint

Please note that the functions of the Method tile are not available in the mobile view.

How can I import a method?

When you open the Method tile, you will find the Options in the right sidebar. To import a method, click on Import.

You can then select and import a JSON file from your local storage.

If the import was successful, you will receive a corresponding message and can view the current method in the read-only field.

How can I export a method?

When you open the Method tile, you will find the Options in the right sidebar. To export your current method, click on Export.

The current method will be exported directly as a JSON file.

How can I configure the standard colors of the symbols?

You have the option to set the color scheme of a symbol type to a personal standard for all stages of your BIC Process Design. Diagrams from the archive will always be displayed with the current color settings. For each symbol type, you can set the border, background, and font color.

Warning

Please note that the colors you choose here will affect all stages, including diagrams in publication. Also, please consider the notes on configuring certain symbol types.

When you open the Method tile, navigate to the Symbol types tab. You will see a list of all the configurable symbol types from your current method. Select the desired symbol type to adjust the color.

Next, click on the respective color field that you want to adjust. You can select a color value from the color palette or enter a HEX code.

Note

Please note that if no color is set, the symbol will be displayed in BIC Process Design’s default color. If you have set a color value and want to return to the default color, please clear the input field.

After configuring the symbol type colors, select the Mass application option in the right sidebar. This will open a dialog window where you need to confirm your changes.

To apply your color changes to all diagrams in all stages, click on Apply changes. To cancel the process, click on Cancel.

Your changes will then be visible in all diagrams after a refresh.

Note

It is also possible to format individual symbols using the symbol palette. The color formatting done there will be applied to all stages and will not be overwritten by later changes to the general color configuration explained here.

How can I import or export symbol colors?

You can import and export your own color settings for symbol types. This allows you to switch between different symbol colors.

Hint

Please note that changing the symbol colors will affect all diagrams in all stages.

To import or export your symbol type colors, open the Method tile and navigate to the Symbol types tab. In the right sidebar, you will find the respective options.

Import:

If you have edited your symbol type color settings externally or want to re-upload and use previous versions, select the Import option.

Select a JSON file and click on the Mass application option to apply the color settings.

Warning

Please note that if you upload your own JSON file, all symbol IDs you use in it must be correct and present in your method. If you use symbol types that are not present in the currently used method, this may result in unexpected behavior.

Export:

To export your current color settings as a JSON file, click on Export.

How can I set the layout of a diagram type?

The layout assistant is designed to assist you in arranging the process flow, focusing on sequence flow and activities. You can configure and customize the EPK, WKD, and BPMN diagram types by default.

When you open the Method tile, navigate to the Diagram layout tab. On the right sidebar, you will find a list of the available diagram types and their corresponding diagram IDs. To edit the layout of a diagram, click on a diagram type.

In the main section, you will find the settings for the selected diagram type, which are described in detail below:

Modeling orientation: Here, you can choose between Horizontal and Vertical to determine the alignment of the layout assistant. The direction refers to the process flow, represented by, for example, sequence and message edges between activities.

Horizontal/Vertical distance (cm): This defines the distance in the process flow by entering numbers. It represents the horizontal and vertical distance in centimeters between two symbols connected by a sequence or message edge.

Horizontal/Vertical satellite distance (cm): This input defines the horizontal and vertical distance between satellites in centimeters.

Satellite positioning: To set the position of satellites, click on the corresponding quadrant and edit the input field. Specify which object type with which relationship to the activity should be automatically placed here during layouting. You can also set the maximum number of symbols arranged vertically above each other. If the number exceeds during layouting, a new column of vertical arrangement will be created. Once you’ve saved your input by pressing the Enter key, it will be displayed as a chip in the quadrant. If needed, you can remove the chip by clicking on the quadrant.

Quadrant Ports: Quadrant ports correspond to the edge ports of the satellites of an activity. By clicking on a quadrant, you can choose between two selectable ports - Horizontal and Vertical. Your selection is saved immediately.

The default settings defined for the layout assistant will be overridden with this configuration. If no individual behavior is defined, the layout assistant uses the default.

Note

Chips can only be generated for object types that exist in the method. There is no further validation of your input. Note the existing object types and association types.

Search

How can I select attributes as search facets?

In the Search tile, you can select attributes as search facets to set filters for the central search and the list of diagrams.

Click on the Search tile to access the details page. The alphabetically sorted list displays all attribute types from the current method.

By clicking on an attribute, you can activate or deactivate it. As an administrator, you have the option to remove an attribute type as a search filter or save an unselected attribute type as a search filter.

Hint

Please note that the functions of the Search tile are not available in the mobile view.

Workflows

How can I set the validation scope for language-dependent mandatory attributes?

In the Workflows tile, you can configure the validation scope for mandatory attributes to specify the languages to be checked.

After selecting the tile, you can choose the validation scope for mandatory attributes from the available options:

• Arbitrary content language: The mandatory attribute must be maintained in at least one content language.

• Only enabled default content language: The mandatory attribute must be maintained in the activated default content language, even if it has been maintained in other languages.

• All enabled content languages (default setting): The mandatory attribute must be maintained in all enabled content languages.

Note

You can define the default and content languages in the administration.

When a new validation scope is selected, the publishing workflow verifies that all mandatory language-dependent attributes for entities and diagrams comply with the selected scope.

Note

Please note that the new validation scope will only apply to a publishing workflow that has been started after the change was made.

Hint

Please note that the functions of the Workflows tile are not available in the mobile view.

How can I set the workflow task reminder?

You can also configure a reminder interval for unfinished tasks in the Workflows tile. Therefore, click on Reminders to display the setting options for Task reminders.

This section allows you to set the reminder interval (in days) for open, unfinished tasks. The default interval is 7 days, meaning that users with open tasks will receive reminders once within this timeframe. You have the flexibility to customize the interval by entering your preferred number of days in the corresponding field. The changes to the reminder interval take effect immediately and will be applied to all new tasks. A notification confirming the successful changes will appear at the bottom right of the screen.

Hint

Please note that the functions of the Workflows tile are not available in the mobile view.

How can I set the resubmission reminder?

In the Workflows tile, you as an administrator can configure when reminders for upcoming resubmissions should be sent. To do this, click on Reminders to display the setting options for Resubmissions.

The time (in weeks) for resubmission reminders is specified here. The respective responsible individuals receive a one-time notification at the chosen time regarding the remaining validity period. Changes are saved instantly, and a notification confirming the successful update is displayed at the bottom right of the screen. This update applies to all new resubmissions.

Hint

Please note that the functions of the Workflows tile are not available in the mobile view.

MyBIC

In the MyBIC tile, you can create standard favorites and make them available to your users on the MyBIC page.

After clicking on the tile, a list will appear sorted in descending order based on the creation date. This list displays the names of the standard favorites and the assigned user groups. If the name is not available in your browser language, a corresponding hint will be provided.

Hint

Please note that the functions of the MyBIC tile are not available in the mobile view.

How can I create a new standard favorite?

After clicking on the MyBIC tile, you can create a new standard favorite by clicking the button located at the bottom right.

This will open a dialog window where you must enter the URL of the search result or diagram for the standard favorite, along with a name. Optionally, you can also enter user groups and the name in other languages.

Once you have entered a URL and a name, you can create the standard favorite by clicking on Create. It will then be displayed as the first entry in the list. To discard the input, click on Cancel.

How can I delete a standard favorite?

To delete a standard favorite, there must be at least one standard favorite. Click on the standard favorite you want to delete in the list to expand it.

You will then see the option to delete the standard favorite at the top right of the entry.

After clicking on the Delete favorite option, the standard favorite will be deleted immediately and removed from the list.

Print

How can I configure the default settings for the header and footer?

In the Print tile, you have the option to configure the header and footer by default for each printout.

After clicking on the tile, three selection fields for the header and footer will be displayed. Here, you can specify what information should be displayed on the left, centered, and/or right side of the header and footer. For example, you can choose the logo, date, or page number, with many other options available.

Hint

Please note that the functions of the Print tile are not available in the mobile view.

Reports

In the Reports tile, you can create reports and configure existing reports.

After clicking on the tile, a list of all existing reports is displayed.

Hint

Please note that the functions of the Reports tile are not available in the mobile view.

How can I create a new report?

After clicking on the Reports tile, you will find the button Create new report located at the bottom right corner of the screen. Click on it to create a new report.

This will open a dialog window where you can configure the report’s content in JSON format.

Click on Create to create your custom report. To cancel the process, click on Cancel.

Once the report is created, you will be redirected to the details page of the new report, where you can further configure the report as needed.

How can I configure an existing report?

To configure an existing report, there must be at least one report in the list. When you click on a report, you will be taken to the report descriptor where you can configure the report in JSON format.

In the descriptor editor, you can change the following settings:

1. Availability: You can activate or deactivate a report for diagrams or categories for BIC Process Design by using the variable enabled. The report is activated if the value is set to “true”. To deactivate the report you have to change the value to “false”.

2. ReportId: BIC Process Design provides the following default reports: Manual (diagramManual), Manual with assignments (diagramManualWithAssignments), Process costs/simulation (processCostAnalysis), Matrix report (diagramMatrix) and Profile (diagramProfile bzw. entityProfile). The default reports are described in the section about available exports.

The reportId defines which default templates will be shown and taken as fallback to generate an export if no customized template has been uploaded for a diagram type. Please note that - currently - there is only a default template for the reportId “diagramManual” as fallback.

3. Format: You can use the outputFormat variable to specify the format of the output of the report. The following formats are supported for the respective reports:

   • Profile (diagram): docx, pdf, pdfa, pdfa2b

   • Profile (catalog entry): docx, pdf, pdfa, pdfa2b

   • Manual: docx, pdf, pdfa, pdfa2b, html, mhtml, txt, odt, rtf

   • Manual with assignments: docx, pdf, pdfa, pdfa2b

   • Matrix Report: xlsx, pdf, pdfa, pdfa2b

   • Process costs/Simulation: xlsx, pdf, pdfa, pdfa2b

Here pdfa corresponds to the “PDF/A-1b” format and pdfa2b to the “PDF/A-2b” format.

Note

The format pdfa does not support images with transparency. Therefore it is recommended to use pdf2b if images and icons should be present in the report.

4. Names: The variable names specifies the displayed name of the report within the user interface of BIC Process Design. For each language that is supported by BIC Process Design you can set a different value. This difference can be seen as soon as the browser language has been changed.

5. User roles: With the roles variable you can define the user roles which are authorized to export the respective reports.

6. Context: Here you can specify whether the report is available in the context of a diagram, category, catalog entry, or the entire catalog. You can do so by setting the value of the variable type to “diagram”, “category”, “entity”, or “catalog”. Within one descriptor, there can only be one value for the context variable. Therefore, there are two different descriptors for reports that should be available in both contexts. These can be edited separately. If your report is available for a catalog entry, such as the profile, “catalog” should remain entered here.

7. Stereotypes: For reports that are available in the diagram or catalog entry context, you can define which diagram or object types are allowed to use this report. This is possible by writing the IDs of the respecting diagram/object types into the include variable. The report is available for all types if no value has been set for this variable or if the variable contains the value “all”.

Once you have made changes and adhered to the JSON format, you can click on Save. Your changes will then be saved immediately.

If you want to exit the report descriptor without saving your changes, you will receive a notification.

How can I upload a new report template?

To upload a new report template, there must be at least one report in the list. Click on a report to access its details, then select the Report templates tab. From there, you can find the Upload report template button located at the bottom right of the screen.

Once you click on the button, you can select and open a file from your local storage. A dialog window will open where you can select the diagram type and language for the uploaded file. All diagram types of the current method and all content and alternate languages defined in the administration are available for selection.

Click on Save to upload the report template. The uploaded report template will then appear in the list, sorted alphabetically by file name. To cancel the process, click Cancel.

How can I update an existing report template?

To upload a new report template, there must be at least one report in the list. Click on a report to access its details, then select the Report templates tab. If there is at least one report template available, click on the context menu (three dots) of the report template to be updated and select Upload.

Afterward, you can select a new file from your local storage to update your report template. The file name will be adjusted according to the new file, while the diagram type and language will remain unchanged.

How can I download a report template?

To download a new report template, there must be at least one report in the list. Click on a report to access its details, then select the Report templates tab. If there is at least one report template available, click on the context menu (three dots) of the report template to be updated and select Download.

The report template will then be downloaded immediately.

How can I delete a report template?

To upload a new report template, there must be at least one report in the list. Click on a report to access its details, then select the Report templates tab. If there is at least one report template available, click on the context menu (three dots) of the report template to be updated and select Delete.

The report template will then be immediately and irreversibly deleted.

Note

Please note that only custom report templates can be deleted. If you have updated a standard template and want to delete it, the report template will be reset to the standard template.

Details

In the Details tile, you can set the visibility of the attribute bar in the publication and configure the profile for diagram and object types.

Hint

Please note that the functions of the Details tile are not available in the mobile view.

How can I display the attribute bar in the publication?

After clicking on the Details tile, you can choose either the list of available diagram types or the list of available object types from your method. You can expand a list entry by clicking on it.

The Display attribute bar in publication option is enabled by default for all diagram and object types. To hide the attribute bar in the publication, toggle the switch. Your changes will be applied immediately.

How can I change the visibility of the profile?

In the Details tile, you can set whether the associated profile should be displayed for each diagram and object type. To open the detail settings for a list entry, simply click on it.

The current visibility status is shown in the Show profile for this type field, where type is replaced by either Diagram type or Object type. To change the active setting, simply click on the corresponding toggle switch. Your changes will be applied immediately.

Clicking on the diagram or object type will return you to the overview.

How can I configure the profile?

In the Details tile, you can configure the profile for both diagram and object types. Initially, you will see the default settings, which you can then modify. This includes attributes such as description, as well as relationships to other object types like responsible and contributing roles, input, and output.

To modify the profile, click on a list entry to open its detail settings. If necessary, adjust the visibility of the profile. You can then view the existing configuration in the editing field and make any changes needed.

• Attributes: You can add or remove diagram or object attributes using the attribute type ID. In the following example, the object attribute “Name” is displayed next to the “Description”. To do this, the attribute type ID must be added to the "attributes" section:

"attributes": [
             "AT_DESCRIPTION",
             "AT_NAME"
     ],

• Associations and entities: In "sections", specific relationships to object types, selected association types or specific object types can be output individually. Its representation takes place in various subsections named "titles", in which the issues and designations in the profile are defined. The following subsection example looks for “roles” contained in the diagram with “C - Consulted” the relationship to another entity. For this, the ID of the "entityType", in this case "ET_ROLE", and the "associationType", here "AST_CONSULTED", must be specified. These roles are then listed in the profile section named "Cooperation" in English browser language and "Mitwirkung" in German browser language.

{
                     "titles": [
                             {
                                     "locale": "en",
                                     "value": "Cooperation"
                             },
                             {
                                     "locale": "de",
                                     "value": "Mitwirkung"
                             }
                     ],
                     "entityType": "ET_ROLE",
                     "associationType": "AST_CONSULTED"
 },

If only one relationship type or entity type is requested, the other type should remain undefined by "".

To save your changes, click on the Save button located at the bottom right within the detail settings. You may need to scroll down to locate the button. Subsequently, the configuration will be validated, meaning the syntax of the JSON structure will be checked, and upon successful validation, it will be saved.

Clicking on the diagram or object type will return you to the overview.

Tip

For a list of existing stereotypes and related IDs, see this section.

Translation Service

If you click on the menu entry for Administration in the menu bar, you will see the tile Translation Service.

You have the option to grant your users access to the translation service in the public workspace by linking your DeepL account. Your account must be created through DeepL.

How can I test my DeepL API configuration?

In the Translation Service tile, you have the option to enable or disable the Translation Service Connector.

Clicking on the tile will take you to the configuration page. Here, you can enter the API key from your DeepL account and test the access. If no API key has been entered, the option to test the configuration will be disabled at this point.

Note

With the test option enabled, you will send a test request to the DeepL translation endpoint. The entered API key will be used for authorization. If the authorization fails, you will receive an error message.

How can I remove my DeepL API configuration to delete my login data?

If your DeepL credentials are linked, you can delete the DeepL API configuration and login information.

Deleting the login information will remove your access credentials from the database. After requesting deletion, you will receive either a success message or an error message indicating the current status.

Note

Please note that the option to delete the login information is disabled if no login credentials are linked.