Skip to main content

Celonis Product Documentation

Text
Overview

Placement

View

or

Profile View

Required KM objects

None

Introduction to Text Boxes

This component allows you to add text blocks to your View. Textbooks can contain a title, text, and HTML elements.

57541778.png
Basic Textbox Configuration

Please find below an example of the most basic configuration of a "Textbox" component. You must specify at least the component title or content to get started.

Attribute

Required

Type

Description

name

false

String

Defines the component name that will be displayed at the top of the textbox.

57541782.png

title

false

String

Defines the title that should be displayed above the textbox content.

57541782.png

content

false

String

Defines the content that should be displayed within the textbox component.

57541782.png

Info

optimized for component editor

- id: "textBox1"
  type: "text-box"
  settings:
    title: "Title of the text box"
    content: "Text in the text box"
Advanced Configuration

In addition to the above mentioned configuration following additional configuration options are available.

Attribute

Required

Type

Description

placeholders

false

String

Defines attributes, KPIs, or variables from your knowledge model that you want to reference in the textbox content. Once these have been defined in your parameter configuration, you can use them in your textbox by referencing them using the format "Placeholder {X}" where "X" is the order placement you listed it in.

Note

When referencing the parameter in the text field, the ordering reference should start at {0}. Therefore, if you have three fields listed, you can reference these as :

  • Placeholder {0}

  • Placeholder {1}

  • Placeholder {2}

Additional Design Properties

Description

HTML Elements

Defines additional stylist properties using HTML elements within the title or content configurations.

Some HTML elements used in the example above:

  • <br> - line break in text

  • <code> - displays its contents styled in a fashion intended to indicate that the text is a short code snippet

  • <ul> - unordered list

  • <li> - item in a list

Further HTML elements can be used such as e.g.: <code> <p> <hr> <ul> <ol> <li> <a> <b> <i><div>

If you are new to HTML, we recommend the following external resource.

Info

optimized for component editor

- id: "textBox4"
  type: "text-box"
  settings:
    title: Textbox Component
    content: This is an example textbox <br/> component you can make use of in your
         views. In this text box you can do things such as <ul><li> Create bulleted
         list </li><li><code>Insert Code Snippets</code></li><li>Reference Attributes
         or KPIs from your Knowledge Model. For example, The avg. number of open
         invoices is Placeholder {0} <br/> </li><li>And many more!
    placeholders: 
      - field: NUMBER_OF_OPEN_INVOICES