Docs »

Automations »

Toolbars

This page previews features in the upcoming 10.0 release.

A toolbar is a collection of interactions and menus.

Top-level toolbar items are displayed as buttons. Items within a menu are displayed as links.

KATA

Toolbars are configured using a KATA dialect, which can pass custom input to the interaction using placeholders (current worker, record, etc).

interaction:

An interaction begins when it is clicked in the toolbar.



interaction/participants:
  label: Participants
  badge: {{record_participants|length|default(0)}}
  uri: cerb:automation:cerb.ticket.participants.manage
  inputs:
    ticket@key: record_id
  #hidden@bool: no
  after:
    refresh_widgets@csv: Actions

interaction/locationByIp:
  uri: cerb:automation:example.interaction.locationByIP
  label: Location by IP
  icon: globe
  after:
    refresh_widgets@list: Actions


Req’d Key  
uri: The URI of the interaction.web.worker automation to start when clicked.
  inputs: The optional inputs dictionary for the interaction.
  label: The label to describe the interaction in buttons and menu links. This may be omitted if an icon is provided.
  icon: The optional icon to display in buttons and menu links. This can be in addition to, or instead of, the label.
  tooltip: If a button only has an icon and not a label, the tooltip can show a label when hovering over it.
  badge: The optional counter to display on buttons.
  hidden@bool: Conditionally determine whether to display this toolbar item or not. For instance, check worker permissions or record fields.
  after: Actions to take when the interaction completes successfully. For instance, a completed interaction on a dashboard can refresh any number of widgets by name to show updated data. Options here depend on the toolbar.

Menus may contain any combination of interactions and submenus.



menu/moreMenu:
  icon: more
  tooltip: More
  items:
    menu/tools:
      label: Tools
      items:
        interaction/debug:
          uri: cerb:automation:example.interaction.echo
          label: Debug
          icon: bug


Req’d Key  
label: The label to describe the menu in buttons and menu links. This may be omitted if an icon is provided.
  icon: The optional icon to display in buttons and menu links. This can be in addition to, or instead of, the label.
items: A list of menu and interaction items.
  default: Display a “split” menu button. Clicking on the left-side immediately runs this default interaction by name. Clicking on the right-side opens a menu of alternative options.

Records

Toolbars can be configured from Search » Toolbars.

Toolbar  
global.menu Global interactions from the floating icon in the lower right
mail.compose Composing new email messages
mail.read Reading email messages
mail.reply Replying to email messages
record.card Viewing a record card popup
record.profile Viewing a record profile page