Help and Documentation
Incident Configuration

Functionalities

11min

Overview

Functionality allows you to specify the impacted features during an incident. This can help you with identifying which responders to bring in, which on-call to page, which customers to inform, etc. Individual functionalities can be mapped to your status pages.

Document image


Field Type

Functionality can be customized to be either a select or multi-select field type. This means you can configure it to allow only one functionalities value to be selected per incident or allow multiple functionality values to be selected for a single incident.

Document image


Attributes

Functionalities can be configured with the following attributes. Each functionality attribute can be referenced via Liquid syntax.

Since the functionality field can be either a select or multi-select field type, the Liquid syntax to reference each field type will differ.

Select will follow a single-value syntax

{{incident.raw_functionalities | get: '<attribute>'}}

Multi-select will follow an array syntax. Where i references the specific functionality object in the list of functionalities.

{{incident.raw_functionalities[i] | get: '<attribute>'}}

ID

This is the unique identifier of the functionality. This field cannot be customized. Rootly will auto assign the ID upon creation. It is typically used in Liquid references and API calls.

The following Liquid syntax will allow you to list out the functionality ID(s) that are selected for an incident:

{{ incident.functionality_ids }}

OR

{{ incident.raw_services | get: 'id'}} for select field type

{{ incident.raw_services[i] | get: 'id' }} for multi-select field type

Name

This is the value that is displayed on the UI for the functionality. This field is customizable.

The following Liquid syntax will allow you to list out the functionality name(s) that are selected for an incident:

{{ incident.functionalities }}

OR

{{ incident.raw_functionalities | get: 'name'}} for select field type

{{ incident.raw_functionalities[i] | get: 'name' }} for multi-select field type

Slug

This is the string that is used to reference the functionality in Liquid references. This field is auto generated by lower-casing and hyphenating the functionality name.

The following Liquid syntax will allow you to list out the functionality slug(s) that are selected for an incident:

{{ incident.functionality_slugs }}

OR

{{ incident.raw_functionalities | get: 'slug'}} for select field type

{{ incident.raw_functionalities[i] | get: 'slug' }} for multi-select field type

Description

This value is displayed on the UI to further explain each functionality. This field is customizable.

The following Liquid syntax will allow you to list out the functionality description(s) that are selected for an incident:

{{ incident.raw_functionalities | get: 'description'}} for select field type

{{ incident.raw_functionalities[i] | get: 'description' }} for multi-select field type

Color

Each functionality can be assigned a color, which will be used for color-coding on metrics graphs.

Rootly uses color-hex codes. E.g. #000000 is black, #ffffff is white. Use this page to help you find the exact hex code for the color you want.

The following Liquid syntax will allow you to list out the functionality color(s) that are selected for an incident:

{{ incident.raw_functionalities | get: 'color'}} for select field type

{{ incident.raw_functionalities[i] | get: 'color' }} for multi-select field type

Slack Channels

Each functionality can be linked to one or more Slack channels. By default, Rootly does not notify the linked channel(s) when a functionality is selected for an incident. Notification needs to be explicitly called out as Attached Functionality Channels in workflow configurations.

Systematically, each Slack channel is stored as an object containing an id and name.

The following Liquid syntax will allow you to list out the functionality Slack Channel(s) that are selected for an incident:

{{ incident.raw_functionalities | get: 'slack_channels'}} for select field type

{{ incident.raw_functionalities[i] | get: 'slack_channels' }} for multi-select field type

Slack Aliases

Each functionality can be linked to one or more Slack user groups (aka aliases). By default, Rootly does not invite users in the linked user group(s) when a functionality is selected for an incident. Invitations need to be explicitly called out as Attached Functionality Aliases in workflow configurations.

The following Liquid syntax will allow you to list out the functionality Slack Alias(es) that are selected for an incident:

{{ incident.raw_functionalities | get: 'slack_aliases'}} for select field type

{{ incident.raw_functionalities[i] | get: 'slack_aliases' }} for multi-select field type

Notify Emails

Each functionality can be linked to one or more emails. By default, Rootly does not send emails to the linked address(es) when a functionality is selected for an incident. Notification needs to be explicitly called out as {{ incident.raw_functionalities | map: 'notify_emails' | flatten | join: ',' }} in workflow configurations.

The following Liquid syntax will allow you to list out the functionality Notify Email(s) that are selected for an incident:

{{ incident.raw_functionalities | get: 'notify_emails'}} for select field type

{{ incident.raw_functionalities[i] | get: 'notify_emails' }} for multi-select field type

Import Functionalities

Instead of creating functionalities from scratch, Rootly allows you to import functionalities from PagerDuty or Opsgenie. Imported functionalities will be automatically kept in sync on a daily basis.

The ability to import teams will only become available once you have PagerDuty or Opsgenie installed on the integrations page .

The following Liquid syntax will allow you to list out the corresponding ids from each of the external paging applications:

PagerDuty

{{ incident.raw_functionalities | get: 'pagerduty_id' }} for select field type

{{ incident.raw_functionalities[0] | get: 'pagerduty_id' }}for multi-select field type

Opsgenie

{{ incident.raw_functionalities | get: 'opsgenie_id' }} for select field type

{{ incident.raw_functionalities[0] | get: 'opsgenie_id' }}for multi-select field type

Support

If you need help or more information about this integration, please contact [email protected] or start a chat by navigating to Help > Chat with Us.

Updated 04 Sep 2024
Doc contributor
Doc contributor
Did this page help you?