Skip to content

Results

Result ProcessingLink

After your Invoker script runs, SIERRA reads its JSON output and integrates it into the investigation graph according to the type field.


Tree ResultsLink

JSON
1
2
3
4
{
  "type": "Tree",
  "results": [  ]
}
  • Interpretation:

  • Each string in results becomes a leaf node.

  • Each object maps a parent node to its child array.
  • Effect in UI:

  • Renders a collapsible hierarchy.

  • Parent nodes can be expanded to reveal children.

Network ResultsLink

JSON
1
2
3
4
5
6
{
  "type": "Network",
  "origins": [  ],
  "nodes": [  ],
  "edges": [  ]
}
  • Interpretation:

  • origins mark starting nodes in the graph.

  • nodes defines all entities with unique IDs and content.
  • edges defines directed relationships (sourcetarget) with optional labels.
  • Effect in UI:

  • Displays an interactive node‑link diagram.

  • You can trace connections from each origin through the network.

Error ResultsLink

JSON
{ "type": "Error", "message": "…" }
  • Interpretation:

  • Any script error or validation failure.

  • Effect in UI:

  • Shows a prominent error banner with your message.

  • Halts further result rendering for that invocation.

Internal hanlding of results?Link

Yes, this kit supports internal dealing of it.

Tree Type ResultLink

sierra.create_tree_result Link

Python
create_tree_result(
    results: list[typing.Union[str, dict[str, list[str]]]],
) -> dict[str, typing.Any]

Create a Tree type result.

PARAMETER DESCRIPTION
results

The tree results.

TYPE: list[Union[str, dict[str, list[str]]]]

RETURNS DESCRIPTION
TreeResult

The formatted tree result.

Image title
Example of tree type result.

Network Type ResultLink

sierra.create_network_result Link

Python
create_network_result(
    origins: list[str],
    nodes: list[dict[str, str]],
    edges: list[dict[str, str]],
) -> dict[str, str]

Create a Network type result.

PARAMETER DESCRIPTION
origins

List of origin node IDs.

TYPE: list[str]

nodes

List of node definitions.

TYPE: list[dict[str, str]]

edges

List of edge definitions.

TYPE: list[dict[str, str]]

RETURNS DESCRIPTION
NetworkResult

The formatted network result.

Image title
Example of network type result.

Manage ErrrorsLink

sierra.create_error_result Link

Python
create_error_result(message: str) -> dict[str, str]

Create an Error type result.

PARAMETER DESCRIPTION
message

The error message.

TYPE: str

RETURNS DESCRIPTION
ErrorResult

The formatted error result.