Configuration

CIB Seven weblient is configured through two primary configuration files: UI configuration file config.json, which is transferred to the browser and manages its behavior, and application.yaml file, which serves as the core configuration for the webclient.

Webclient UI Configuration

The UI configuration is stored in the config.json file, which can be found in the webapps\webapp\WEB-INF\classes\public directory.

Themes and Logo

A theme defines the visual aspect of the webclient, such as its colors, fonts and the appearances of the UI controls.
Themes are located inside the webapps\webapp\WEB-INF\classes\public\themes directory. By default, CIB seven webclient uses the cib theme. You can slightly modify the appearance of the webclient by editing the user stylesheet file styles.css or by replacing the logo image within the specified theme directory. The active theme can be specified with the cibseven.webclient.theme property in the application.yaml configuration file.

Localization

CIB seven webclient supports localization. CIB seven maintains English, German, Russian, Spanish and Ukrainian translation files. The webclient automatically selects a locale based on the browser’s language settings. You can set the supportedLanguages property in the configuration file config.json to provide a list of available locales.

"supportedLanguages": ["de", "en"],

Each locale in the list must have a locale file with the corresponding language code.

If the browser uses a language which is not available, the weblient uses English as a fallback.

Keyboard Shortcuts

To make working with the CIB seven webclient easier, you can use keyboard shortcuts to jump to certain parts or to perform special operations. You can customize these shortcuts by editing the shortcuts section in the config.json file. By default, we support the following actions via keyboard shortcuts:

All shortcuts can be modified in the config.json file.
Additionally, available shortcuts can be viewed in the webclient’s Help menu.

Refresh intervals

Refresh interval can be configured for Tasklist, Processes and Dashboard views. The interval is specified in milliseconds and determines how often data in these views is refreshed from the database.

"dashboard": {
  "autoUpdate": {
    "enabled": true,
    "interval": 60000
    }
 },

  "processes": {
    "autoUpdate": {
      "enabled": false,
      "interval": 0
    }
  },

Webclient Core Configuration

The core webclient configuration is stored in YAML format. For CIB seven Tomcat or WildFly distributions, the configuration is typically located in the application.yaml file. For CIB seven Run distrubution, the webclient configuration can be combined with the distrubution configuration files.

Authentication

Authentication means verifying a user’s identity against the CIB seven webclient.

A user authenticates on the login page by providing a username and password. If the authentication is successful, the user gets access to the webclient and can work on tasks in Tasklist or perform operations in Cockpit, for example.

The authentication information consists of the following:

• Process engine name
• Username
• Group memberships
• Tenant memberships

The CIB seven webclient correlate the authentication information against authorizations to determine what data the user can query for and which operations the user can perform. There are several options to configure authentication in CIB seven, see cibseven.webclient.authentication.

LDAP

If you connect CIB seven with the LDAP identity service, you have read-only access to the users and groups. Create new users and groups via the LDAP system, but not in the admin application. Find more information about how to configure the process engine in order to use the LDAP identity service here. Options to configure CIB seven webclient with LDAP support: cibseven.webclient.ldap.

Multi-engine support

The multi-engine feature allows using a single webclient instance to view and manage multiple CIB seven engines. This is particularly useful for developers or administrators who need to switch quickly between environments such as testing, development or production. Additional engines can be optionally specified via the additionalEngineRest sub-property:

cibseven:
  webclient:
    engineRest:
      url: http://localhost:8080
      path: /engine-rest
      displayName: Local Server
      tooltip: Local environment
      additionalEngineRest:
        - url: https://dev.cibseven.de/
          path: /engine-rest
          displayName: Dev Server
          tooltip: Development environment
        - url: https://qa.cibseven.de/
          path: /engine-rest
          displayName: QA Server
          tooltip: QA environment

Other Core Configuration Options

Complete list of the core webclient options with short descriptions can be found here: CIB seven webclient options.