Help and Documentation
...
Incident Configuration
Forms & Fields

Built-In Fields

11min

Overview

Rootly comes with a series of built-in incident properties that are carefully selected to meet common incident characterization requirements. These properties are used to provide incidents with additional metadata so teams can dynamically trigger automations and run metrics reports based on these properties. Please see the Incident Properties page to learn more about them.

You can access the Built-In Fields page by navigating to Configurations > Forms & Fields > Fields tab > Built-in-fields

Document image




Managing Built-In Fields



Please note that this UI is used to configure how the built-in fields appear on incident forms and which incident forms they appear on.

To configure the selectable values of each built-in field, you will need to do so Configurations.

Document image


Enable/Disable Field

Only enabled fields are considered to be live fields - meaning they can appear on UI screens and be updated during incidents. Disabled fields are NOT usable during incidents and cannot be updated by workflows either.

You can use the toggle switch next to the field name to enable/disable it.

Document image


Edit Field

You can edit a specific field by clicking on the edit icon on the right hand side of the field.

Document image


Once selected, you will see an Edit Form Field pane open. From here, you'll be able to edit how this particular field appears in the forms.

Document image


ID

This is an unique identifier for the form field. It is automatically generated for you upon field creation and cannot be edited. This id will be used to reference the specific form field in API calls and Liquid syntaxes.

Name

This field is auto generated for built-in fields and can be edited. The name entered here will be the value that appears on user-facing forms. However, it will NOT alter the Liquid syntax used to reference this property.

For example, if you set this field to ENV, it will be reflected in the forms. However, when you go to reference it using Liquid syntax, it would still be {{incident.environments[0]}}.

Field Type

Depending on the built-in field in reference, you can alter its field type. If the built-in field is an array of values (e.g. Services, Environments, etc.), you can change the field type to either a simple Select or Multiple Select type. For example, if you want to enforce that users can only select a single Incident Type, then you can update the Incident Type field to be a Select field type.

Not all built-in fields can have customizable field types. For example a checkbox field (e.g. Backfill Incident toggle, Mark as Triage toggle) can only be that type.

Default

Built-in fields can be configured to have a default value. For example, if you want all your incidents to default to SEV4 for the Severity field, then you can set it here.

Enabled

This is the same setting as the toggle described in the Enable/Disable Field section above

Only enabled fields are considered to be live fields - meaning they can appear on UI screens and be updated during incidents. Disabled fields are NOT usable during incidents and cannot be updated by workflows either.

You can use the toggle switch next to the field name to enable/disable it.

Display This Field in the Incident Details

This switch allows you to display or hide the specific field on the Details section of the Incident Details page.

Hiding a field from being displayed in the Details section does not mean this field is turned off. It just means users cannot edit it from the UI.

This is typically used when teams want to configure a custom flag that gets systematically set by workflows, not manually by users.

Document image


Delete Field

Built-in fields cannot be deleted. They can only be disabled.

Document image


Support

If you need help or more information about this page, 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?