User Guide

Vertex-Triage User Guide

Vertex-Triage adds new Storm commands and Workflows to manage queues and tasks.

Getting Started

Check with your Admin to enable permissions.

Examples

Create a new queue

Queues can also be created via the dedicated workflow.

> vertex.triage.queue.add alerts --desc "A queue for work items relating to alerts"
proj:project=cbd3b4fd95636804ae27c8febfa5e00a
        .created = 2025/03/04 16:55:15.205
        :created = 2025/03/04 16:55:15.206
        :creator = root
        :desc = A queue for work items relating to alerts
        :name = alerts

Create a new task within the “alerts” queue that references a risk:alert node

Tasks can also be created from a Node Action in the Research Tool.

> risk:alert#newalerts | vertex.triage.task.add alerts "alert investigation" --assignee visi --yield
proj:ticket=cd8bd0612e40512a1c24a5c6d6f0c1e6
        .created = 2025/03/04 16:55:15.377
        :assignee = visi
        :created = 2025/03/04 16:55:15.370
        :creator = root
        :name = alert investigation
        :priority = medium
        :project = cbd3b4fd95636804ae27c8febfa5e00a
        :status = new
        :type = task
        :updated = 2025/03/04 16:55:15.370

Create a trigger to add a task when media:news:title is set and contains a keyword

This example creates a new task when :title contains the keyword malware, and adds it to the malware queue. The title is used to populate the task name.

> trigger.add prop:set --prop media:news:title
--query { +:title~=malware | vertex.triage.task.add malware `triage "{:title}"` }
Added trigger: dee722edbde880b2241e0a19b95944f5

> [ media:news=* :title="an article about malware" ]
media:news=701d0bf8fa15d73455c19b730bcc3278
        .created = 2025/03/04 16:55:15.609
        :title = an article about malware

> proj:project:name=malware -> proj:ticket
proj:ticket=2804da207ed9f428aeb5818bdf0b69c2
        .created = 2025/03/04 16:55:15.752
        :created = 2025/03/04 16:55:15.744
        :creator = root
        :name = triage "an article about malware"
        :priority = medium
        :project = 095ecbea19571bea2099dac38dca4e9a
        :status = new
        :type = task
        :updated = 2025/03/04 16:55:15.744

The task will also have a reference to the inbound node.

> proj:project:name=malware -> proj:ticket -(refs)> *
media:news=701d0bf8fa15d73455c19b730bcc3278
        .created = 2025/03/04 16:55:15.609
        :title = an article about malware

Create a cron to check an external system and create a task based on the results

This example calls a placeholder module, and creates tasks in the extsys queue. A similar ingest routine could be written for calling an HTTP API.

> cron.add --hour +8 {
    $mod = $lib.import(somemodule)
    $data = $mod.getData()
    for $item in $data {
      vertex.triage.task.add extsys $item.name --desc $item.details
    }
  }
Created cron job: bf5a235a2c06aea4dc3e2080916dd2c0

Use of meta:source nodes

Vertex-Triage uses a meta:source node and -(seen)> light weight edges to track created nodes.

> meta:source=62cbf38be08a5fc8933790a68c41d103
meta:source=62cbf38be08a5fc8933790a68c41d103
        .created = 2025/03/04 16:55:15.186
        :name = vertex-triage