CaseFabric Reference Guide

CaseFabric Reference Guide

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

›Getting Started

Overview

  • CaseFabric
  • A short introduction
  • Product Overview

Getting Started

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

Some CMMN

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

CaseFabric IDE

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

CaseFabric Engine

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

Extensions

  • Do we need extensions?
  • Fault Handling
  • 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.34
  • 1.1.33
  • 1.1.32
  • 1.1.31
  • 1.1.30
  • 1.1.29
  • 1.1.28
  • 1.1.27
  • 1.1.26
  • 1.1.25
  • 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

CaseFabric Generic UI

CaseFabric provides a generic user interface to enable quick testing of the case that you are creating. The user interface is agnostic to the type of case model that it renders.

In most use cases you will want to develop your own user interface, that fits better with the domain it is intended for.

Overview of Cases and Tasks

The Generic UI has a simple structure. When a user logs in, the list of tasks and cases that the user has access to will be rendered.

  • My Tasks are the tasks assigned to the current user.
  • Unclaimed Tasks are not assigned to a user, and the current user is allowed to claim them.
  • Start Case will render a list of possible cases that the user can start.
  • My Cases contains the list of cases in which the user participates.

Image

Individual Case and Task Instances

Navigating into a task or case will render that specific instance.

  • For a case, the items in the case plan and their state will be rendered.
  • For a task, buttons to e.g. claim or complete the task are rendered.

Rendering Case and Task Data with JSON Schema

For starting a Case or completing a Task, in most use cases it is required to pass data. The logic of the case depends on the data entered by the user. In most applications using the CaseFabric Engine this is built into the custom User Interface of that application. However, the CaseFabric Engine also provides for a placeholder in which you can store e.g. a JSON document that holds rendering information.

To be more concrete, the Generic UI can render Start Case and Task screens that hold such a JSON schema to enable you to test the wiring of data into the case model.

For instance, the JSON for starting the business application Hello World looks like:

{
  "schema":  {
    "title": "Greeting",
    "type": "object",
      "required": [
      "Greeting"
    ],
    "properties": {
      "Greeting": {
      "title": "Your greeting to the World",
      "type": "object",
        "properties": {
           "Message": {
              "type": "string",
              "title": "Your message"
            },
            "To": { 
              "type": "string",
              "title": "To whom?"
              },
            "From": {
              "type": "string",
              "title": "From",
              "default": "$CURRENT_USER"
              }
            }
          }
       }
     }
   }

If you want to learn more on how to use this method, go to How to use task UI rendering.

← Introducing CaseFabric DemoHow to use task UI rendering →
  • Overview of Cases and Tasks
  • Individual Case and Task Instances
  • Rendering Case and Task Data with JSON Schema