Entando - Process Driven Apps Plugin

Jenkins:

Jenkins X:

Introduction

For more information and documentation visit: https://developer.entando.com, or https://forum.entando.org. Or for the latest news or product information please visit the main website: https://www.entando.com.

Information below is for running locally or building from source. For usage information see the links above.

Scope

The scope of this service is to provide a clean and simple API to allow Micro Frontend Widgets to integrate with BPM Providers:

Environment Configuration

You'll need these environment variables set in order to run the project. Some variables are required and MUST be set in order to run the server:

Required Environment Variables:

• PORT: TCP Port where the server will run. Default: 8081
• KEYCLOAK_AUTH_URL: The keycloak authentication URL. Default: http://localhost:8081/auth
• KEYCLOAK_REALM: The keycloak realm. Default: entando-development
• KEYCLOAK_CLIENT_ID: The keycloak resource/clientId. Default: entando-pda
• KEYCLOAK_CLIENT_SECRET: The keycloak client secret.

Optional Environment Variables:

• LOG_LEVEL: Log level. Default: INFO

Development

Entando PDA Plugin uses Entando web-commons and keycloak-connector.

In order to make it work on dev environment, you have to clone and install the dependencies or just add to your IntelliJ workspace.

• Web Commons: https://github.com/entando/web-commons
• Keycloak Connector: https://github.com/entando/keycloak-commons

mvn spring-boot:run -Dspring-boot.run.profiles=dev

API Docs

Swagger Docs are available at http://localhost:8080/swagger-ui.html

Docker Hub

Latest version deployed on Docker Hub:

• https://hub.docker.com/r/entando/entando-process-driven-plugin

Sonar Cloud Report:

• https://sonarcloud.io/dashboard?id=entando_entando-process-driven-plugin

Configuration and Manual Steps

Initial Deploy

1. Log in to Keycloak as an admin and add the PDA roles to your user account.
   • Go to Users → admin → Role Mappings and add the roles for the entando-pda-plugin-server
2. Log in to the App Builder and configure the PDA Connection.
   • The Page Templates hardcode the name of the datasource. You can choose to change the name there or simply use 'pam-demo' as the connection name.
   • Set the engine to 'pam' which will work for jBPM or PAM.
   • Provide your connection URL to the KIE Server rest services, e.g http://my.server.net:8080/kie-server/services/rest/server
   • Username/password should be for a service account user in jBPM or PAM itself, e.g. krisv.
   • The Timeout is in milliseconds, e.g. 60000.
3. (If you didn't use pam-demo as your datasource name) Go to Pages → Management and for the following pages configure the data source for their widgets. Click Design on the page, then Settings on any widgets with Settings to review and update the config settings.
   • PDA Dashboard
   • PDA Process Definition
   • PDA Smart Inbox
   • PDA Task Details

Setup the project directory after customization

1. Prepare the bundle directory: cp -r bundle_src bundle
2. Initialize the project: ent prj init
3. Initialize publication: ent prj pbs-init (requires the git bundle repo url)

Publish the bundle after customization

1. Build: ent prj build (build the frontend and backend) or ent prj fe-build -a (to just build the frontend, including changes from bundle_src)
2. Publish: ent prj pub or ent prj fe-push (publish all or just the frontend)
3. Deploy (after connecting to k8s): ent prj deploy
4. Install the bundle via 1) App Builder, 2) ent prj install, or 3) ent prj install --conflict-strategy=OVERRIDE on subsequent installs.
5. Iterate steps 1-4 to publish new versions.