Giter VIP home page Giter VIP logo

cawemo-engine-plugin-spring-boot-starter's Introduction

Spring Boot starter for the Cawemo engine plugin

About

This project provides a Spring Boot starter for the Cawemo engine plugin. The starter makes it more convenient to use the plugin in Spring Boot-based applications like Camunda Platform Run, by providing an easy configuration mechanism via application properties.

Disclaimer

This library is not production-ready and not actively maintained. It rather serves as an example of how you could use the Cawemo engine plugin with Spring Boot.

How it works

If the class CawemoEnginePlugin is found on the classpath, the starter will automatically instantiate it as a Spring bean.

Configuration

The plugin can be configured with the following application properties (please refer to the Camunda Docs for a detailed description of the different properties).

Required properties

  • camunda.cawemo.cawemo-url
  • camunda.cawemo.user-id
  • camunda.cawemo.api-key
  • camunda.cawemo.project-name
  • camunda.cawemo.auth-mode (BASIC or QUERY_PARAM)

Optional properties

(can be used with authMode=QUERY_PARAM only)

  • camunda.cawemo.custom-basic-auth.user
  • camunda.cawemo.custom-basic-auth.password

How to use it with Camunda Platform Run

  1. Download the Cawemo engine plugin JAR file as described in the Camunda Docs
  2. Clone this repository
  3. Build a JAR file with mvn clean package
    • You'll find the file cawemo-engine-plugin-spring-boot-starter-1.0.0.jar in the target folder
  4. Copy both JAR files to the configuration/userlib folder of your Camunda Platform Run distribution
  5. Configure the Cawemo plugin in the configuration/default.yml or configuration/production.yml file (depending on your use case) with the properties listed above
  6. Start Camunda Platform Run
  7. Check if the integration is working by deploying a process to the Camunda Platform; if everything is set up correctly, the process will be synced to an "Engine deployment" project in Cawemo

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.