Skip to content

cibseven/cibseven-webclient

Repository files navigation

CIB seven webclient

License Build Status Version

The CIB seven webclient is the official web application interface for the CIB seven process automation platform. It includes the Cockpit, Tasklist, and Admin applications for process monitoring, user task management, and administrative controls.

Overview

This project contains the following integrated top-level web applications:

  • Cockpit – Monitoring and operation of running process instances.
  • Tasklist – Interface for end-users to complete and manage workflow tasks.
  • Admin – Management of users, groups, and authorizations.

Getting Started

Prerequisites

  • Java 17+
  • Maven 3.8+
  • Node.js (for frontend development tasks)

Build

Clone the repository and build all applications using Maven:

git clone https://github.com/cibseven/cibseven-webclient.git
cd cibseven-webclient
mvn clean install

Configuration

The webclient can be configured using Spring Boot properties. Key configuration options include:

Engine REST API Configuration

cibseven:
  webclient:
    engineRest:
      url: http://localhost:8080          # Base URL of the CIB seven engine
      path: /engine-rest                  # Configurable REST API path (default: /engine-rest)

The path property allows you to customize the engine REST API path to support different Jersey application configurations. For example, if your Spring Boot application defines a custom Jersey path:

# Custom Jersey path example
cibseven:
  webclient:
    engineRest:
      url: http://localhost:8080
      path: /different-path               # Custom path instead of default /engine-rest

Development Configuration

When developing the frontend, if you are using a custom engine REST path, you should also update the frontend development proxy configuration in frontend/vite.config.js:

// Set ENGINE_REST_PATH environment variable to match your backend configuration
const engineRestPath = process.env.ENGINE_REST_PATH || '/engine-rest'

You can set this environment variable when running the development server:

# For custom path
ENGINE_REST_PATH=/different-path npm run dev

# For default path (no environment variable needed)
npm run dev

Documentation

Contributing

We welcome contributions!

Have a look at our contribution guide for how to contribute to this repository.

  1. Fork the repository.
  2. Create your feature branch: git checkout -b feature/my-feature
  3. Commit your changes: git commit -am 'Add new feature'
  4. Push to the branch: git push origin feature/my-feature
  5. Submit a pull request.

Releases

Check out the Releases page for version history, features, and patch notes.

License

This project is licensed under the Apache 2.0 License – see the LICENSE file for details.

CIB seven uses and includes third-party dependencies published under various licenses. By downloading and using CIB seven artifacts, you agree to their terms and conditions. Refer to https://docs.cibseven.org/manual/latest/introduction/third-party-libraries/ for an overview of third-party libraries and particularly important third-party licenses we want to make you aware of.

Authors

Developed and maintained by the CIB software GmbH.

Related Repositories

About

CIB seven web client

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 18