Create a Custom Indicator Field - Administrator Guide - 6.9 - Cortex XSOAR - Cortex - Security Operations

Cortex XSOAR Administrator Guide

Product
Cortex XSOAR
Version
6.9
Creation date
2022-09-29
Last date published
2024-05-22
End_of_Life
EoL
Category
Administrator Guide
Abstract

Create a custom indicator field in the Fields tab in Cortex XSOAR. Add specific indicator information to incidents.

Indicator Fields are used to add specific indicator information to incidents. When you create an indicator field, you can associate the field to a specific indicator type or to all indicator types.

  1. Go to SettingsOBJECTS SETUPIndicatorsFields.

  2. Click New Field.

  3. Configure the basic settings.

    Field

    Description

    Field Type

    Determines the acceptable values for the field. You can add the following field types:

    • Boolean (checkbox)

    • Date picker

    • Grid (table): Include an interactive, editable grid.

    • HTML: Create and view HTML content, which can be used in any type of indicator. By default, HTML fields do not use Cortex XSOAR theme styles, but can be configured to use existing user themes.

    • Long text: Long text is analyzed and tokenized, and entries are indexed as individual words, enabling you to perform advanced searches and use wildcards. Long text fields cannot be sorted and cannot be used in graphical dashboard widgets. While editing a long text field, pressing enter will create a new line. Case is insensitive.

    • Markdown: Add markdown-formatted text as a Template which will be displayed to users in the field after the indicator is created. Markdown lets you add basic formatting to text to provide a better end-user experience.

    • Multi select / Array: Includes two options a) Multi select from a pre-filled list b) An empty array field for the user to add one or more values as a comma-separated list.

    • Number: Can contain any number. Default is 0.

    • Role: Role assigned to the indicator. Determines which users (by role) can view the indicator.

    • Short text: Short text is treated as a single unit of text, and is not indexed by word. Advanced search, including wildcards, is not supported. Short text fields are case sensitive by default, but can be changed to case insensitive when creating the field. While editing a short text field, pressing enter will save the change. Maximum length 60,000 characters. Recommended use is one word entries. Examples: username, email address, etc.

    • Single select

    • URL

    • User: A user in the system.

    Case Sensitive

    If selected, the field is case sensitive, which affects how the search results for this field are returned in Cortex XSOAR.

    Mandatory

    If selected, this field is mandatory when used in a form.

    Field Name

    A meaningful display name for the field. After you type a name, you will see below the field that the Machine name is automatically populated. The field’s machine name is applicable for searching and the CLI.

    Tooltip

    An optional tooltip for the field.

    Placeholder

    Optional text to display in the field when it is empty. This text will appear in the layout, but not in the created indicator. Available for Short text, Long text, Multi select / Array, Tags.

  4. Configure the attributes.

    Field

    Description

    Script to run when field value changes

    The script that dynamically changes the field value when script conditions are met. For a script to be available, it must have the field-change-triggered-indicator tag, when defining an automation. For more information, see Indicator Field Trigger Scripts.

    Add to indicator types

    By default, the Associate to all option is selected, which means this field will be available to use in all incident types.

    Clear the checkbox to associate this field to a subset of indicator types.

    Make data available for search

    The values for this field can be returned in searches.

  5. Save the changes.

  6. (Optional) Add the custom field to a section of the indicator layout.

  7. (Optional) Map Custom Indicator Fields.

    Mapping a field enables you to automatically update the indicator without the analyst having to change it.