Skip to main content

Celonis Product Documentation

Recommendation
Overview

Placement

View

Required KM objects

KPI

Introduction to Recommendations

Use the "Recommendation" component on Views to list out different recommendations on how to improve a KPI. Details about the recommended improvement measures can be provided in Profile Views.

50745655.png
Basic configuration

Please find below an example of the most basic configuration of a "Recommendation" component.

Firstly create a new KPI in the Knowledge Model, which contains customAttribute of type recommendation.

Click here to see KM KPI definition.

kpis:
    - id: TOTAL_NUMBER_OF_INVOICES
      displayName: Total number of invoices
      customAttributes: #The KPI requires the customAttribute of type recommendation, which you can see below
          recommendations: 
              - id: RECOMMANDATION1 
                displayName: Underutilization of cash discount #Used for displaying in the recommendation list component
                filter: CASE WHEN COUNT_TABLE("PizzaP2P_xlsx_Sheet_0_CASES") - COUNT(DISTINCT
                    "PizzaP2P_xlsx_Sheet_0"."ACTIVITIES") > 0 THEN 1 ELSE 0 END
                firstKpi: TOTAL_NUMBER_OF_INVOICES #Used for opening a Profile View based on the KPI
                secondKpi: kpi2
                thirdKpi: kpi3
                process: AP #Referenced in the View component.

Attribute

Required

Type

Description

process

true

References the process defined in the Knowledge Model.

kpis

true

List of KPIs

Defines a list of KPIs which can be displayed in the Recommendation list.

kpi

true

KPI

References a KPIs defined in the Knowledge Model.

Info

optimised for component editor

View YAML

id: recommendation-list-7f184b57-ddc5-4b6b-ba49-d6109690c0a2
type: recommendation-list
settings:
  data:
    process: AP
    kpis:
      - kpi: TOTAL_NUMBER_OF_INVOICES
      - kpi: TOTAL_NUMBER_OF_SUPPLIERS

Lastly you can now go ahead and create a new Profile View with the knowledgeObjectId:RECOMMENDATION. When clicking on entry it will then open this Profile View.

Advanced configuration

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

Attribute

Required

Type

Possible values

Default Value

Description

name

false

String

Defines the title displayed above the component.

limit

false

Integer

Defines the number of elements displayed in the list.

actions

link

false

String

Defines a link, which will automatically show a "Show More" button.

50745653.png

id

false

String

Defines a unique identifier for the KPI. It is important in the context of Base and Extension.

order

true

Integer

Defines the order of the KPI. It is important in the context of Base and Extension.

kpiParams

false

-

-

-

Allows defining Parameters that are also used in the Knowledge Model. See here for more details on how to set a KPI parameter.

id

false

String

-

-

Defines the ID value of the parameter defined.

Note

The KPI Parameter ID value record in the view must match KPI parameter ID defined in KM to work correctly.

value

false

Views Variables

-

-

Defines the value of the parameter that will be passed from the knowledge model.

Note

This value should be defined using a variable with the input coming from e.g. a dropdown component.

id: recommendation-list-36639136-5fde-4c77-80e5-7445069aa7a0
type: recommendation-list
settings:
  name: List 
  limit: 4 
  actions:
    link: https://www.celonis.com
  data:
    kpis: 
      - kpi: TOTAL_NETWR_CONVERTED
        id: kpi1
        order: 100
        kpiParams:
          - id: kpiParamId
            value: 100
      - kpi: NUMBER_OF_PROCESS_VARIANTS
        id: kpi2
        order: 200
    process: AP