Configuring Handlers

Handlers are way to make a dashboard interactive and to do many other useful things. They can:

  • Show object details

  • Display a form or component

  • Navigate to web page (internal or external)

  • Execute actions and action groups

  • Make changes in Kanban layout

  • Launch custom events

Handlers can return results of Success and Error types.

These Successes and Errors can have their own handlers, and this allow user to trigger chains of handlers.

Handlers can be set to dashboard elements user can interact with:

Handlers can be set in two views of configurator: old and new.

Old View Configurator

The old view is commonly used. To show it go to proper element (e.g., cell) and click "Configure Handler" button or go to element (e.g., button) editor and switch to Handler Configuration tab:

In both cases the handler editor will be shown:

Select handler type in the "Type" picklist. Depending on your selection other columns in handlers editor will contain different fields and elements.

See "Handler Types" section below to view configuring of different types of handlers.

New View Configurator

This view is available for some elements (e.g., Card Components). Go to proper element and expand "Handler" section. Click "Edit Handler" button:

Created Handler could be copied to other elements of card by using Copy/Paste buttons

The handler editor will appear in popup. By default it will contain nothing. Select handler type in the "Type" picklist. Depending on your selection different fields and elements will appear next to it:

Not all types of handlers can return an error. These handler types will display no "Add Error handler" button.

Handler Types

Form

This type of handler when triggered will show a window with specified form. To configure it:

  • Select "Form" in the "Type" field in configurator

  • Select necessary form in the "Value" lookup or click "Add New From" button to open form builder

  • Select if form will be opened in the same browser window or in the new one

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Form have 2 default parameters that should be set:

  • Mode ("edit", "new" or "view") - specifies how form should be shown

  • id - specifies source record ID which data will be taken to populate form and further work with (not necessary for "New" mode)

Click ">>" button to open parameters builder. Click "Add" link to add more parameters and specify them:

Form API

This type of handler when triggered will call specified API method of open form. To configure it:

  • Select "Form API" in the "Type" field in configurator

  • Select necessary method in the "Value" lookup (e.g., "Execute Action")

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Form API handler has no default parameters. Required parameters are determined by selected API method (e.g., "Execute Action" method needs id of the form and action name):

Note: you need to know Form API methods from your system administrator.

Visualforce Page

This type of handler when triggered will navigate you to the specified Visualforce Page from current organization (in new browser tab). To configure it:

  • Select "Visualforce Page" in the "Type" field in configurator

  • Select necessary Visualforce Page in the "Value" lookup

  • Select if Visualforce Page will be opened in the same browser window or in the new one

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Visualforce page has no default parameters:

URL

This type of handler when triggered will navigate you to the specified web page (in new browser tab). To configure it:

  • Select "Url" in the "Type" field in configurator

  • Type necessary URL in the "Value" text input

  • Select if URL will be opened in the same browser window or in the new one.

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea.

URL has no default parameters:

  • Only relative URLs (pages on the same server) can be opened in the same window. External URLs are always opened in the new window due to security reasons.

  • You should provide a full URL with network protocol prefix. Without it system will treat URL as relative.

Lightning Component

This type of handler when triggered will display the Lightning Component. To configure it:

  • Select "Lightning Component" in the "Type" field in configurator

  • Select a component in the "Value" lookup

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Lightning Component has no default parameters:

SObject

This type of handler when triggered will open the page with object specified by its ID. To configure it:

  • Select "SObject" in the "Type" field in configurator

  • Type ID or API Name(in case of new record) of the SObject in the "Value" text input. Any object is allowed - system will show its details in the same page

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

SObject has no default parameters:

Action / Action Group

This type of handler when triggered will execute the specified action or action group. To configure it:

  • Select "Action" or "Action Group" in the "Type" field in configurator

  • Select an action or action grroup in the "Value" lookup or click "Add New..." button to create new action or action group in the other browser tab

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Action or action group can have different parameters. There are 2 default parameters pre-defined (but not mandatory):

  • source - provide the ID of the record that will be a source of action data

  • variables - provide initial variables with their values in JSON format (like {"variable1":"value1","variable2":"value2"})

The action or action group can be executed successfully or with error. To do something with these results additional handlers can be added to action / action group success and error. Handlers can be added several times and form a chain - this is a simple way to program complex behavior. To remove an additional handler click "Delete Handler" button:

You can re-order handlers. Exchange positions of neighbor handlers by moving them with arrow buttons.

Note: If handler that can not have child handlers becomes parent, it will loose all children.

Kanban API

This type of handler when triggered will call the specified method of Kanban API that add some interactivity. To configure it:

  • Select "Kanban API" in the "Type" field in configurator

  • Select a Kanban API method in the "Value" picklist

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Kanban API methods do their specific actions and return successful result. This result can have an additional handler. Add this handler by clicking "Add Success Handler" button and configure it (and next-level handlers, if needed) in the same way as for Action / Action Group handler.

To learn more about Kanban API methods refer to the "Kanban API" article.

Fire Event

This type of handler when triggered will launch specified event. To configure it:

  • Select "Fire Event" in the "Type" field in configurator

  • Type event value in the "Value" field (refer to Force events documentation)

  • Click "Parameters" button to configure parameters or paste correct JSON with parameters into textarea

Last updated