Skip to main content

Celonis Product Documentation

Comments

Enabling comments allows users to add text based comments to objects within a view.

Comments_example.png
Basic comments configuration

When configuring basic comments, the following attributes are available:

Attribute

Required

Type

Description

objectId

Yes

String

Defines the identifier under which the comment gets stored

  • If you want to have comments associated with a specific record (e.g. using profile views), set objectID to ${id}.

  • If your comment is not dependent on a specific item but should be generic for a view, you can also hardcode the objectId e.g. 1234

The example YAML for basic comment configuration:

id: comments-cba6a50d-7db7-4dc2-8f36-e29454afe15d
type: comments
settings:
  objectId: ${id}
Advanced comments configuration

When configuring advanced comments, the following attributes are available:

Attribute

Required

Type

Possible Values

Default

Description

name

No

String

Comments

Defines the name shown at the top of the comments component.

commentLimit

No

Integer

5

Defines the number of comments displayed on one page.

dateFormat

No

Boolean

 

yyyy-MM-dd hh:mm

Defines the format of the comment timestamp.

The example YAML for advanced comment configuration:

id: comments-cba6a50d-7db7-4dc2-8f36-e29454afe15d
type: comments
settings:
  objectId: 1234
  name: Comments
  dateFormat: yyyy-MMM-dd hh:mm
  commentLimit: 10