Package Documentation

Storm Package: vertex-triage

The following Commands are available from this package. This documentation is generated for version 0.3.1 of the package.

Storm Commands

This package implements the following Storm Commands.

vertex.triage.queue.add

Add a new Vertex-Triage queue.

Examples:

  // Add a new queue
  vertex.triage.queue.add myqueue --desc "A queue for foo things"


Usage: vertex.triage.queue.add [options] <name>

Options:

  --help                      : Display the command usage.
  --desc <desc>               : The description of the queue.

Arguments:

  <name>                      : The name of the queue.

vertex.triage.task.add

Add a new Vertex-Triage task.

This command will create a new proj:ticket node associated
with the provided queue. Inbound nodes will be added as references
to the created task.

Examples:

  // Add a new task
  vertex.triage.task.add myqueue mynewtask

  // And a new task which references all the inbound nodes
  risk:alert#todo | vertex.triage.task.add myqueue mynewtask

  // And a new task for each inbound node
  risk:alert#todo | vertex.triage.task.add myqueue mynewtask --per-node


Usage: vertex.triage.task.add [options] <queue> <name>

Options:

  --help                      : Display the command usage.
  --desc <desc>               : The description of the task.
  --assignee <assignee>       : The name of the Synapse user to assign the task to.
  --status <status>           : The status of the task. (default: new)
  --priority <priority>       : The priority of the task. (default: medium)
  --per-node                  : Create a new task for each inbound node.
  --yield                     : Yield the newly created nodes.
  --debug                     : Show verbose debug output.

Arguments:

  <queue>                     : The name of the queue to add the task to.
  <name>                      : The name of the task.

Storm Modules

This package does not export any Storm APIs.