Cafienne Reference Guide

Cafienne Reference Guide

  • Overview
  • Getting Started
  • CMMN
  • Cafienne IDE
  • Cafienne Engine
  • Extensions
  • API Reference
  • Releases

›Getting Started

Overview

  • Cafienne
  • A short introduction
  • Product Overview

Getting Started

  • Introducing Cafienne Demo
  • Generic UI
  • How to use task UI rendering
  • Two business applications
  • Obtaining Cafienne Demo

Some CMMN

  • What is CMMN
  • Modelling the Case Plan
  • Modelling the Case File
  • Modelling the Case Team
  • Other things to model

Cafienne IDE

  • An IDE?
  • Designing
  • Tasks and Parameters
  • Expressions
  • Deploying
  • Debugging

Cafienne Engine

  • The Cafienne Engine
  • Authentication
  • Authorization
  • Pictorial overview
  • Logging
  • Configuration
  • Repository

Extensions

  • Do we need extensions?
  • Workflow
  • Business Identifiers

API Reference

  • Introducing the API
  • Joining the platform
  • Start a Case
  • Case Team membership
  • Executing the case
  • Retrieving cases and tasks
  • Casefile requests

Releases

  • Overview
  • 1.1.21
  • 1.1.20
  • 1.1.19
  • 1.1.18
  • 1.1.17
  • 1.1.16
  • 1.1.15
  • 1.1.14
  • 1.1.13
  • 1.1.12
  • 1.1.11
  • 1.1.10
  • 1.1.9
  • 1.1.8
  • 1.1.7
  • 1.1.6
  • 1.1.5
  • 1.1.4
  • 1.1.3
  • 1.1.2
  • 1.1.1
  • 1.1.0

Obtaining Cafienne Demo

In order to get access to the demo environment, you need to be registered with Cafienne. You can fill out the form at cafienne.io.

Prerequisites

In order to run Cafienne Demo, you need to have

  • Docker installation
  • a GitHub account

The demo runs as a set of docker images, and the configuration of these images is available in a git repository. We assume you have some basic knowledge of working with GitHub and Docker.

Clone the repository and get started

When authorized, you can clone the repository from Github by running the following command in a terminal: git clone https://github.com/cafienne/getting-started.

Now, you can pull the latest Cafienne docker images by running docker-compose pull and bringing it up by running docker-compose up. You can now start working with Cafienne.

There are two methods to stop and/or remove the environment.

  • docker-compose down will stop the running environment and remove all created containers. Only use this method if you want to rebuild all containers and start with a clean environment, because everything is completely removed.

  • docker-compose stop only stops the running containers. All data is preserved. Use this method if you want to preserve all your running cases.Once stopped, you can start the containers by running docker-compose -f cafienne-demo.yml start

Exposed URLs of the Cafienne Demo environment

After starting up the Cafienne Demo environment, the following URL allow you to access the various parts of the environment:

  • Cafienne IDE: http://localhost:2081
  • Cafienne task user interface: http://localhost:8081
  • Cafienne API (exposed through Swagger): http://localhost:2027
  • MailCatcher web UI: http://localhost:1080

You can logon to these parts by using admin for the username and cafienne for the password. Next to the admin there are four predefined users: Lara lara@example.com/lara, Hank hank@example.com/hank, Gerald gerald@example.com/gerald and Suzy suzy@example.com/suzy.

More information

More information about running the Cafienne Demo environment is available in the documentation of the getting-started repository in GitHub.

← Two business applicationsWhat is CMMN →
  • Prerequisites
  • Clone the repository and get started
  • Exposed URLs of the Cafienne Demo environment
  • More information