.. _auto_dashboard_build_graph:

*DASHBOARD BUILD GRAPH*
=======================

Builds a server-side ontology graph (nodes and edges) from d3VIEW dashboard entities — simulations, workflows, HPC jobs, databases, physical tests, files, and more — using PHP Filter classes instead of multiple frontend API calls. Use this worker to generate a relationship graph for a project or user scope, optionally filtered by entity type, date range, and row limits.

When to use
-----------

Classification: **default**.

Tagged: ``dashboard``, ``edges``, ``entity``, ``filter``, ``graph``, ``nodes``, ``ontology``, ``relationships``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Project
     - project_id
     - remote_lookup
     - —
     - 
     - Optional project to scope the graph to; when set, only entities belonging to this project are fetched. Leave null to include entities across all projects.
   * - User
     - user_id
     - remote_lookup
     - —
     - 
     - Optional user to scope the graph to; when set, only entities owned by or associated with this user are fetched. Leave null to include all users.
   * - Entity Types
     - entity_types
     - select
     - *(complex)*
     - 
     - Multi-select list of entity type keys (e.g. simulations, workflows, hpcjobs) to include as graph nodes; defaults to all 12 supported types — narrow the list to reduce graph size.
   * - Limit Per Entity Type
     - limit
     - integer
     - 500
     - 
     - Maximum number of records fetched per entity type from the database; default is 500 — lower this value on large tenants to keep graph generation fast.
   * - Date Start
     - date_start
     - datetime-local
     - —
     - 
     - ISO-8601 datetime lower bound (inclusive) on entity creation date; leave null for no lower bound.
   * - Date End
     - date_end
     - datetime-local
     - —
     - 
     - ISO-8601 datetime upper bound (inclusive) on entity creation date; leave null for no upper bound.
   * - Include Node Types (Post-Filter)
     - include_node_types
     - select
     - —
     - 
     - Optional post-filter that retains only the specified node types in the assembled graph; leave empty to keep all node types returned by entity_types.
   * - Validate Edges
     - validate_edges
     - boolean
     - False
     - 
     - Whether to validate that all edge endpoints exist as nodes.
   * - Server Breakdown
     - server_breakdown
     - boolean
     - False
     - 
     - When enabled, creates derived nodes for queues, solver types, and compute nodes from HPC job data, connected to their HPC server nodes.
   * - Create Graph File
     - create_file
     - boolean
     - False
     - 
     - Whether to write the graph JSON to a temporary file.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Graph
     - graph
     - graph
     - The fully assembled ontology graph object containing typed nodes (PRJ_, SIM_, WF_, etc.) and typed directed edges; suitable for direct rendering in d3VIEW graph widgets.
   * - Graph File
     - graph_file
     - file
     - The same ontology graph serialised as a downloadable JSON file ({nodes: [], edges: []}) for offline inspection or further processing.
   * - Nodes
     - nodes
     - dataset
     - Flat tabular dataset of all graph nodes, one row per node, with columns for id, type, label, color, and entity metadata.
   * - Edges
     - edges
     - dataset
     - Flat tabular dataset of all directed graph edges, one row per edge, with columns for source node id, target node id, and relationship type.
   * - Node Count
     - node_count
     - number
     - Integer count of the total number of nodes present in the assembled graph after all filters have been applied.
   * - Edge Count
     - edge_count
     - number
     - Integer count of the total number of directed edges present in the assembled graph after all filters have been applied.
   * - Summary
     - summary
     - text
     - Human-readable text summary listing the total node and edge counts together with the filter parameters (project, user, date range, entity types) that were applied.
   * - Statistics
     - statistics
     - json
     - JSON object providing a breakdown of node counts and edge counts by type (e.g. {node_types: {simulation: 42, …}, edge_types: {produces_response: 18, …}}).
   * - Validation Result
     - validation
     - json
     - JSON object containing graph validation results (dangling edges, unknown node references, etc.); populated only when the validate_edges option is enabled, otherwise null.

Disciplines
-----------

- platform.dashboard
- platform.ontology
- platform.workflow

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>dashboard_build_graph</code>. Schema hash: <code>397961f24a8e</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>