Skip to main content

Celonis Product Documentation

Activity History
Overview

Placement

Profile View

Required KM objects

Record.Attribute

KPI

Augmented Attribute

Introduction to Activity History

Use the "Activity History" component on Profile Views to give your users a quick overview of all activities for a specific object. It can be used to display comments, case activities, or executed tasks.

50745628.png
Basic configuration

You can build a simple case explorer by combining the Activity History with a table showing cases and profile views.

1. Make sure you have a Record "case" defined in your Knowledge Model

This also works with other records like invoices etc. Make sure you have an identifier of the record defined.

2. Add a table showing cases

In the table, define at least one column displaying an attribute of the record and activate linkToRecordProfile.

      data:
        columns:
        - field: CASE.ID
          onClick:
            linkToRecordProfile: true
3. Add a Default Profile View for cases with Activity History

Publish before use

Make sure you publish the view you create here (or full package) so it will be registered as the default profile view for the table defined above.

metadata:
  key: "profile-view"
  template: false
  name: "Profile View for Cases"
  knowledgeModelKey: "<key of your knowledge model>"
  knowledgeObjectId: "CASE" #Defines that we want to display invoice information in this View.
  profileView: true #Defines that a View becomes a Profile View.
variables: #Variables allow you to create variables in your View. For see link above.
  - name: "id"
    type: "string"
layout:
  rows:
    columns:
      componentId: activity-history
components:
  - id: activity-history
    type: activity-history
    settings:
        knowledgeModelKey: "<key of your knowledge model>"
        recordMetadataId: CASE #required - identifier for the item
        objectId: ${id} #required - itemid which we need the logs

Attribute

Required

Type

Description

knowledgeModelKey

true

Knowledge Model Key

References the Knowledge Model ID.

recordMetadataId

true

String

References the Activity, which should be displayed.

objectId

true

Integer

References the object for which the Activity should be displayed.

Info

optimised for component editor

id: Activity
type: activity-history
settings:
  knowledgeModelKey: SEMANTIC_LAYER
  recordMetadataId: ACTIVITY
  objectId: "1.20135055264769997E181432715361000"
Advanced configuration

Attribute

Required

Type

Possible values

Default Value

Description

name

false

String

Defines the title name displayed above the component.

pageSize

false

integer

5

Defines the number of Activities displayed on one page.

sortDirection

false

Enum

DESC

ASC

DESC

Defines in which order the Activities should be sorted.

usernameAttribute

false

String

References the username column in the Knowledge Model.

activityAttribute

false

String

References the activity column in the Knowledge Model.

dateFormat

false

Timestamp

dd-MM-yy hh:mm

Defines the timestamp format of each listed activity.

groupDateFormat

false

Timestamp

dd-MM-yy

Defines the timestamp format grouped activities.

hideSources

false

Enum

comments

skill

workflow

task

comments

false

Boolean

true

false

false

Defines if Comments should be hidden.

skill

false

Boolean

true

false

false

Defines if Skills should be hidden.

workflow

false

Boolean

true

false

false

Defines if Workflows should be hidden.

task

false

Boolean

true

false

false

Defines if Tasks should be hidden.

activity

false

Boolean

true

false

false

Defines if Activity should be hidden.

Info

optimised for component editor

id: Activity
type: activity-history
settings:
    knowledgeModelKey: SEMANTIC_LAYER 
    usernameAttribute: ACTIVITY.USERNAME
    activityAttribute: ACTIVITY.ACTIVITY_NAME 
    name: Activity History 
    recordMetadataId: ACTIVITY 
    objectId: "1.20135055264769997E181432715361000"
    pageSize: 1 
    sortDirection: DESC 
    dateFormat: "yy-MM-dd" 
    groupDateFormat: "yy-MM-dd"
    hideSources:
        comments: true 
        skill: true
        workflow: true
        task: true
        activity: true