Cafienne Reference Guide

Cafienne Reference Guide

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

›Some CMMN

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.24
  • 1.1.23
  • 1.1.22
  • 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

Modelling the Case File

In CMMN, each case instance contains a single Case File (also called a case folder, or just the case), and case workers have access to all the data in that Case File. Case workers can add, remove, and modify data in the Case File even if they are not executing any task in the case, as long as they have sufficient privileges. The Case File contains Case File Items that can be any type of data structure.

Information in the Case File serves as context for raising events and evaluating Expressions as well as point of reference for Case Parameters, such as inputs and outputs of Tasks. CaseFile also serves as container for data that is accessible by other systems and people outside of the Case, through CaseParameters.

In Cafienne, once you have created a Case, the Case File is a given and is shown in the IDE in a separate section, named Case File Items. Cafienne allows you to organise Case File Items in hierarchies by containment, so you can add childs or siblings.

Case File Item

In CMMN, Case File Items are used to represent all kinds of data, including a data value in a database, a row in a database, a document, a spreadsheet, a picture, a video, a voice recording, etc. Case File is meant as logical model. It does not imply any assumptions about physical storage of information. A Case File Item must have a Case File Item Definition that defines the structure, as well as the “language” (or format) to define the structure. This may include the definitions of Properties (“metadata”) of a Case File Item. In CMMN, Case File Item Properties have a name and a type.

In Cafienne, you explicitly can use a Case File Item, its Definition and its Properties to design a JSON object structure. In the Case File Item Section, you choose as Definition Type “Unspecified”. Then you are allowed to add Properties, being a name and a “datatype”. These properties are then not “metadata” but “attributes” of the Case File Item that by this definition is an “objct”.

In Cafienne you can use these properties to store values. The JSON structure looks like

{
 "object": "...", --the case file item
 "properties": {
   "...": "...",
   "...": "..."
 },
....
}

​​

← Modelling the Case PlanModelling the Case Team →
  • Case File Item