Result Types (Original)

Result Processing

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

---

Tree Results

{
  "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 Results

{
  "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 (source → target) with optional labels.

• Effect in UI:

• Displays an interactive node‑link diagram.

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

---

Error Results

{ "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?

Yes, this kit supports internal dealing of it.

Tree Type Result

sierra.create_tree_result

Python

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

Create a tree result containing a list of results.

PARAMETER	DESCRIPTION
results	List of results, where each result is either a string or a dictionary with a single key-value pair. The key in the dictionary must be "children" and the value is a list of strings. TYPE: list[Union[str, dict[str, list[str]]]]

RETURNS	DESCRIPTION
str	A JSON-formatted string containing the tree result.

Example of tree type result.

Network Type Result

sierra.create_network_result

Python

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

Create a network result containing a list of nodes and edges.

PARAMETER	DESCRIPTION
origins	List of origin node IDs. TYPE: list[str]
nodes	List of node definitions, where each node is a dictionary with a single key-value pair. The key in the dictionary must be "id" and the value is a string representing the node ID. TYPE: list[dict[str, str]]
edges	List of edge definitions, where each edge is a dictionary with two key-value pairs. The keys in the dictionary must be "from" and "to", and the values are strings representing the node IDs. TYPE: list[dict[str, str]]

RETURNS	DESCRIPTION
str	A JSON-formatted string containing the network result.

Example of network type result.

Manage Errrors

sierra.create_error_result

Python

create_error_result(message: str) -> str

Create an error JSON result.