formsflow.ai leverages Camunda for workflow and decision automation.

To know more about Camunda, visit https://camunda.com/.

1. Prerequisites
2. Solution setup
   • Step 1 : Keycloak Configuration
   • Step 2 : Installation
   • Step 3 : Running the Application
   • Step 4 : Health Check
3. How to Deploy Process
4. How to Enable SSL
5. forms-flow-bpm Listeners

• For docker based installation Docker need to be installed.
• Admin access to Keycloak server.

Skip this step if you are already having a setup ready.

1. Login to KeyCloak Realm with admin privileges
2. For client forms-flow-bpm creation, follow the instructions given on link

• Make sure you have a Docker machine up and running.
• Make sure your current working directory is "forms-flow-ai/forms-flow-bpm".
• Rename the file sample.env to .env.
• Modify the environment variables in the newly created .env file if needed. Environment variables are given in the table below,
• NOTE : {your-ip-address} given inside the .env file should be changed to your host system IP address. Please take special care to identify the correct IP address if your system has multiple network cards

ℹ️ Variables with trailing 🚩 in below table should be updated in the .env file

• Modify the file mail-config.properties (under forms-flow-bpm/src/main/resources/). The default settings provided are for the Gmail server, and you need to change the credentials at the bottom of the file. Note that you want to configure your own Gmail setting to allow unsecure apps first.

Additionally, you may want to change these

• The value of Datastore credentials (especially if this instance is not just for testing purposes)

• forms-flow-bpm service uses port 8000, make sure the port is available.
• cd {Your Directory}/forms-flow-ai/forms-flow-bpm
• Run docker-compose up -d to start.

NOTE: Use --build command with the start command to reflect any future .env changes eg : docker-compose up --build -d

• Run docker-compose stop to stop.

The application should be up and available for use at port defaulted to 8000 in http://localhost:8000/camunda/

REST service /camunda/engine-rest/deployment/create will be used for deployment of process.

CURL commands are leveraged for this action.

      export token=`curl -X POST "{your keycloak url}/auth/realms/{realm}/protocol/openid-connect/token" -H "Content-Type: application/x-www-form-urlencoded" -d "username=test" -d "password=test" -d "grant_type=password" -d "client_id=forms-flow-bpm" -d "client_secret=xxxxxxxxxxxxxx" | jq -r ".access_token"`

   curl -H "Authorization: Bearer ${token}" -H "Accept: application/json" -F "deployment-name=One Step Approval" -F "enable-duplicate-filtering=false" -F "deploy-changed-only=falses" -F "one_step_approval.bpmnn=@one_step_approval.bpmn"  http://{your-ip-address}:8000/camunda/engine-rest/deployment/create

• NOTE: If POST request fails with permission issue, login to Camunda and go to Admin -> Authorizations -> Deployment. Then, verify the account existence under "deployment" service. If does not, please add it manually.

openssl pkcs12 -export -out bpm1.pkcs12 -in combined.pem
keytool -genkey -keyalg RSA -alias tomcat -keystore truststore.ks
keytool -delete -alias tomcat -keystore truststore.ks

keytool -import -v -trustcacerts -alias tomcat -file fullchain.pem -keystore truststore.ks
keytool -genkey -keyalg RSA -alias tomcat -keystore keystore.ks

keytool -v -importkeystore -srckeystore bpm1.pkcs12 -srcstoretype PKCS12 -destkeystore keystore.ks -des

server:
  port: 8443
  ssl:
    key-store: file:/certs/keystore.ks
    key-store-password: password
    key-store-type: pkcs12
    key-alias: tomcat
    key-password: password
  servlet.context-path: /camunda

• NOTE: Alternatively, you can directly place your ssl cert under the classpath "/forms-flow-bpm/src/main/resources". Your configuration for the key-store in application.yaml would be key-store: classpath:/keystore.ks.

This section elaborates on listeners created for use.

• The complete usage instructions on Listeners used with information on purpose, how-it-works and how-to-use is mentioned here.