Skip to main content

Celonis Product Documentation

Histogram

The histogram is a type of chart that helps users understand the distribution of their data. Although it looks very similar to a bar chart, instead of making comparisons between different items or categories or showing trends over time,a histogram is a plot that lets you show the underlying frequency distribution. To show this distribution your data is divided into groups (“buckets'') on the x-axis and the y-axis will show the frequency (count) based on the data that falls in each bucket.

image5.png

Overview

Placement

View or

Profile View

Required KM objects

Record Attribute

To configure a basic histogram, you must have at least the following features defined. Ensure that prior to creating a new Table component you have all data you wish to include in the histogram properly defined in the Knowledge Model.

id:histogram-59edfcdb-f90c-4e9e-a954-2ba2cba246c5
type:histogram
settings:
attribute: INVOICE.DEVIATION_FROM_DUE_DATE
name:Distribution of how early or late invoices are paid

Attribute

Required

Type

Description

attribute

true

Record Attribute

References attributes defined in the Knowledge Model. This is the data table column that will be used to create the buckets distribution.

Note

Only attributes with numerical (integer and float) data types are supported.

name

false

String

Defines the histogram name that will be displayed on the top left corner of the component.

Advanced Configuration

In addition to the basic configuration the following additional configuration options are also available.

id:histogram-59edfcdb-f90c-4e9e-a954-2ba2cba246c5
type:histogram
settings:
   attribute: INVOICE.DEVIATION_FROM_DUE_DATE
   name:Distribution of how early or late invoices are paid
   orientation:vertical
   distributionAxis:
     title:Time of payment (days)
     format:",.2f"
   occurrenceAxis:
     title: Case Count
     format:",.2f"
   annotations:
    -value:-4,
     label: ← early
     labelAlign:start
     color: GRAY
     line:solid
     forceBucketBoundary:true
    -kpi:ON_TIME_ZERO
     label:On Time
     labelAlign:middle
     color:BLACK
     line:none
     forceBucketBoundary:false
  additionalKpis:
   -kpi:SUM_TOTAL_INVOICE_VALUE
  suggestedBucketWidth:1
   displayContentRule:COLOR_THRESHOLDS_RULE

Attribute

Required

Type

Possible values

Description

orientation

false

String

vertical

horizontal

Defines if the bars in the histogram should be drawn on the horizontal or vertical axis.

Vertical

image6.png

Horizontal

image14.png

distributionAxis

false

-

-

Defines display settings for the main distribution axis.

format

false

Format type

Format options

Defines the format display for the indicated attribute on the distribution axis.

title

false

String

Defines the title displayed for the indicated attribute on the distribution axis.

occurrenceAxis

false

-

-

Defines display settings for the histogram’s occurrence axis. This axis shows the frequency count for each bucket on the distribution axis.

format

false

Format type

Format options

Defines the format display for the indicated attribute on the distribution axis.

title

false

String

-

Defines the title displayed for the indicated attribute on the distribution axis.

displayContentRule

false

Display Rule

-

Defines custom coloring rules that can be used to color specific bars in the histogram.

Note

The buckets displayed will be updated based on the “value” defined in the display rule.

image7.png

Display content rule in Knowledge model

customObjects:

-id:COLOR_THRESHOLDS_RULE

displayName:Color thresholds rule

customAttributes:

-comparator:LESS_THAN

value:-4

style:

backgroundColor:blue

-comparator:BETWEEN

kpi:

- KPI_NEG_4

- KPI_7

style:

backgroundColor:"#5FD5A9"

-comparator:GREATER_THAN

value:KPI_7

style:

backgroundColor:"#CC8899"

suggestedBucketCount

false

Integer

-

Defines the number of buckets that will be displayed in the histogram. This count does not include outliers buckets.

Note

Any value indicated here will be treated as a suggestion. The bucket calculation will always prioritize “nice” bucket sizes with integer bounds (i.e. avoiding decimal values). Also, including annotation lines or custom coloring groups will also impact these bucket calculations. The histogram calculation will always aim to keep the bucket count as close to the indicated values while keeping nice bucket sizes and taking into account position lines and coloring groups.

suggestedBucketWidth

false

Integer

-

Defines the width for each bucket that will be displayed in the histogram.

Note

Any value indicated here will be treated as a suggestion. The bucket calculation will always prioritize “nice” bucket sizes with integer bounds (i.e. avoiding decimal values). Also, including annotation lines or custom coloring groups will also impact these bucket calculations. The histogram calculation will always aim to keep the bucket width as close to the indicated values while keeping nice bucket sizes and taking into account position lines and coloring groups.

additionalKPIs

false

KPI

-

Define additional KPIs to be displayed in the histogram tooltip.

image1.png

annotations:

false

-

Add custom annotation lines to the distribution axis.

image11.png

value

false

Integer

View or runtime variable

Defines the value on the distribution axis that the annotation line should be placed on by either a hardcoded integer or variable value.

Note

The “value” and “kpi'' fields should not both be used. You should define the annotation line with either an integer value or a defined KPI.

kpi

false

KPI

Defines the value on the distribution axis that the annotation line should have with a defined KPI from the Knowledge Model.

Note

The “value” and “kpi'' fields should not both be used. You should define the annotation line with either an integer value or a defined KPI.

line

false

boolean

solid (default)

dashed

none

Defines the type of annotation line displayed.

Solid

image12.png

Dashed

image2.png

None

image15.png

label

false

string

-

Defines the label displayed for the annotation line.

labelalign

false

boolean

start

middle

end

Defines how the label is displayed with the position line. These will appear differently depending on the histogram’s orientation.

Alignment type

Horizontal orientation

Vertical orientation

“end”

image8.png
image4.png

“start”

image13.png
image10.png

“middle”

image3.png
image9.png

color

false

boolean

BLUE, GREEN, RED, PURPLE, YELLOW, BLACK, CYAN, GRAY, PINK, PURPLE, ORANGE, TEAL, RED, WHITE

Defines the color of the annotation line.

forceBucketBoundary

false

boolean

true

false

Defines if the bucket sizes should be calculated to ensure a bound falls along the position line.

interactions:

filters: true

false

boolean

true

false

Defines if the histogram bars can be selected to apply view filters. If set to false, these bars can not be selected.