Activiti & Activiti Cloud Developers Guide
  • Introduction
  • Overview
    • 12 Factor Apps
    • Personas
    • Previous Versions (5.x & 6.x)
    • References
    • Cloud Native BPMN support
    • BPMN Comformance
      • BPMN Comformance Set 0
      • BPMN Comformance Set 1
      • BPMN Comformance Set 2
      • BPMN Comformance Set 3
      • BPMN Comformance Set 4
      • BPMN Comformance Set 5
      • BPMN Comformance Set 6
  • Getting Started
    • Getting Started - Activiti Cloud
      • Amazon EKS
      • Google Cloud GKE
      • Docker Compose
      • Jenkins X
        • Amazon EKS
        • Google GKE
    • Getting Started - Activiti Core
  • Components
    • Spring Cloud
    • Activiti Cloud Infrastructure
      • Gateway
      • Identity Management / Single Sign On
    • Activiti Cloud Application
      • Activiti Cloud Runtime Bundle
      • Activiti Cloud Connectors
      • Activiti Cloud Query Service
      • Activiti Cloud Audit Service
      • Activiti Cloud Notification Service
  • FAQs
    • Activiti Core FAQs
    • Activiti Cloud FAQs
  • BluePrints
    • Trending Topic Campaigns
  • Community
    • Roadmap
    • Repositories
    • Contributing
  • Releases
    • 8.2.0
    • 8.1.0
    • 8.0.0
    • 7.11.0
    • 7.10.0
    • 7.9.0
    • 7.8.0
    • 7.7.0
    • 7.6.0
    • 7.5.0
    • 7.4.0
    • 7.3.0
    • 7.2.0
    • 7.1.0-M17
    • 7.1.0-M16
    • 7.1.0-M15
    • 7.1.0-M14
    • 7.1.0-M13
    • 7.1.0-M12
    • 7.1.0-M11
    • 7.1.0-M10
    • 7.1.0-M9
    • 7.1.0-M8
    • 7.1.0-M7
    • 7.1.0.M6
    • 7.1.0 M5
    • 7.1.0 M4
    • 7.1.0 M3
    • 7.1.0 M2
    • 7.1.0 M1
    • 7.0.0 SR1
    • 7.0.0 GA
    • 7.0.0 RC1
    • 7.0.0 Beta5
    • 7.0.0 Beta4
    • 7.0.0 Beta3
    • 7.0.0 Beta2
    • 7.0.0 Beta1
    • 7.0.0 Early Access 201802
    • 7.0.0 Early Access 201801
    • 7.0.0 Early Access 201712
    • 7.0.0 Early Access 201711
    • 7.0.0 Early Access 201710
    • 7.0.0 Early Access 201709
Powered by GitBook
On this page
  • Specification
  • Parameters
  • Security and Permissions
  • Spring Boot Starters
  • Implementations
  • Docker Images
  1. Components
  2. Activiti Cloud Application

Activiti Cloud Audit Service

PreviousActiviti Cloud Query ServiceNextActiviti Cloud Notification Service

Last updated 3 years ago

The Audit Service module provides Audit capabilities. This module is in charge of consuming one or more Runtime Bundle Events and storing them into the Event Store. Our default implementation consists of a simple JPA implementation which consumes messages emitted by Runtime Bundles and store them as they arrive. The audit service doesn't do any data manipulation. There is also a MongoDB implementation, which makes your life easier if you want to query events that are stored in JSON format.

Specification

Parameters

Queries to REST endpoints can be restricted using parameters to match data fields. For example:

/audit/v1/events?processInstanceId={processInstanceId} /audit/v1/events?eventType={eventType}

Security and Permissions

By default only admin users can access everything. The endpoints that begin with /admin/ can be opened up by passing the role 'user' as the value of the ACTIVITI_ADMIN_ROLE environment variable.

Event data can be restricted to particular users or roles. This can be done by adding properties such as:

activiti.cloud.security.user.testuser.rb-app-name.policy.read=defKey1 activiti.cloud.security.user.hruser.rb-app-name.policy.read=defKey2

Or a wildcard '*' can be used.

Here rb-app-name is the name of a runtime bundle application. Or environment variables can be used such as

ACTIVITI_CLOUD_SECURITY_USER_HRUSER_RBMYAPP_POLICY_READ=SimpleProcess ACTIVITI_CLOUD_SECURITY_GROUP_HR_RBMYAPP_POLICY_WRITE=SimpleProcess ACTIVITI_CLOUD_SECURITY_GROUP_TESTGROUP_RBMYAPP_POLICY_WRITE=*

Spring Boot Starters

Implementations

Docker Images

The core business logic for the Audit Service module can be found . You can take these implementations as the specification for the Audit component and use them as the base for your own custom implementation. We recognise that different use cases might require different technologies to perform under different circumstances. For that reason we provide a reference implementation that does the work, but we promote alternative approaches when needed. If you are interested in contributing an alternative or extensions for our reference implementations we encourage you to get in touch.

You can find the Spring Boot 2.x starters used to create our Docker Images and Spring Boot enabled services in the following repository:

here
Activiti Cloud Audit Services & Spring Boot Starters
Activiti Cloud Audit Service - JPA (Reference )using Spring Data JPA
Activiti Cloud Audit Service - Mongo DB
Activiti Cloud Audit Service -> JPA (Reference) Docker Image
Activiti Cloud Audit Service -> MongoDB Docker Image