Skip to content

jeap-admin-ch/jeap-process-context-service

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

227 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

jEAP Process Context Service

Service to check and visualize process context data. This project provides a common library for the process context service, which can be used to set up a process context service instance. It also provides a UI to visualize the process context data and an example application that uses the process context service.

Changes

Change log is available at CHANGELOG.md

Prerequisites

Before you begin, ensure you have the following installed:

  • Java 25 or higher
  • npm (Node Package Manager) 22 or higher

Note: Use the provided Maven Wrapper (mvnw / mvnw.cmd) to build and run the project - no separate Maven installation required.

Getting started

Normally you will not use this project directly, but instead set up your own process context service depending on this common library. If you want to test this library locally, you can use the example project jme-process-context-example, which is available in a separate repository. Check the documentation for details.

Build the library

To build the library, run the following command in the root of the repository:

# Linux / macOS
./mvnw clean install
# Windows
mvnw.cmd clean install

The UI will also be built as part of this command, so there is no need to build it separately if you just want to use the library.

Build the UI

The UI can be built independently of the Spring Boot application, so it can be started separately. This is especially useful for development, as it allows to start the UI with hot reload and without the need to restart the Spring Boot application after every change. To build the UI, run the following command in the root of the repository:

cd jme-process-context-ui
# Force is currently needed to resolve some dependency conflicts.
# This is a technical debt that will be resolved in the future by aligning the dependencies of the UI.
npm install --force
npm run build

Start the UI locally

To start the UI locally, run the following command in the root of the repository:

cd jme-process-context-ui
npm run start

or via Angular CLI:

cd jme-process-context-ui
npx ng serve --open

These will start the UI on http://localhost:4200/. The UI will automatically reload after every change, so you can see the changes immediately in the browser. To run an example backend locally, you can use the example project jme-process-context-example or an own implementation of the process context service. The UI will also automatically connect to the process context service running on http://localhost:8080/.

Local Cypress Component Tests

Testing in Browser with UI:

cd jeap-process-context-ui
npx cypress open --port 7000

Testing in Console:

cd jeap-process-context-ui
npm run cypress:run

Note

This repository is part of the open source distribution of jEAP. See github.com/jeap-admin-ch/jeap for more information.

License

This repository is Open Source Software licensed under the Apache License 2.0.

About

The jEAP Process Context Service (PCS) is a service template library that provides a way to store and retrieve context information pertaining to a process. This context information might be required to be stored for audit purposes or due to business requirements.

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors