Skip to main content

Cyware Orchestrate

Configure Labels in Orchestrate

A label is an identifier attached to a Playbook that helps Orchestrate to automatically trigger the execution of Playbooks on the occurrence of an event. Security analysts can create a label and use these labels to map events and Playbooks. You can use Filters to select labels and view the associated Playbooks.

Before you Start

Ensure that you have permission to View Labels, Create Labels, and Update Labels.

For more information about the required permissions to utilize the labels feature, contact your Orchestrate Administrator.

Steps

  1. Create a Label

  2. Use Labels in a Playbook

  3. Update Labels

Create a Label

You can create a label and then use the created labels to execute Playbooks based on the events that you have created manually or the events that are automatically triggered from other applications.

To create a label:

  1. Click the Main Menu.

  2. Click Labels.

  3. Click Add Label. A New Label screen appears.

  4. Enter a unique name for a Label and enter the Label Description.

  5. Choose a colour you want to associate with a label.

  6. Set the label status as Active or Inactive using the toggle button.

    Note

    If you want to execute a Playbook or an event that is associated with a label, then the label must be in active status.

  7. Click Create. The created label appears in the labels list.

Use Labels in a Playbook

You can use labels in a Playbook and in an event, to execute a Playbook based on an event. You can select one or more labels to a Playbook while creating a Playbook.

Important

You can use labels in configured events and triggered events. For more information about using labels in configured events and triggered events, refer to the References section.

To use labels in a Playbook:

  1. Click the Main Menu.

  2. Click Manage Playbooks and click the New Playbook icon on the top right corner.

  3. In the Playbook canvas, drag and drop an app action node to build a Playbook.

  4. Click Playbook Overview and configure the required fields.

  5. In Select Labels field, select the required labels from the dropdown list.

  6. Add the remaining nodes to the Playbook and click Save.

Update a Label

You can update a label to modify the required fields of a label.

To update a label:

  1. Click the Main Menu.

  2. Click Labels.

  3. In the search or filter results bar, enter the label name you want to update. You can also filter the labels using Create Range filter or Modified Range filter.

  4. Select the label you want to update.

  5. You can update the following fields of a label:

    • Label name

    • Description

    • Color

    • Status

  6. After updating the required fields of a label, click Save.

References