.. _auto_hypergraph_importer_worker:

*HYPERGRAPH IMPORTER*
=====================

Parses a HyperGraph session file (.hgs/.hgd) and imports its channel references, math expressions, and response definitions into the d3VIEW platform. Use this worker to convert an existing HyperGraph template into a reusable response template and Simlytiks layout for downstream post-processing workflows.

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

Tagged: ``expressions``, ``hgd``, ``hgs``, ``hypergraph``, ``import``, ``layout``, ``references``, ``response_template``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Hypergraph File
     - hg_file
     - file
     - —
     - ✓
     - The HyperGraph session file (.hgs or .hgd) to be parsed and imported; required — no default.
   * - Extract Expression
     - extract_expressions
     - select
     - no
     - ✓
     - Whether to extract math/derived-channel expressions from the HyperGraph file and emit them as a separate dataset; set to 'yes' when downstream workers need the expression definitions, default is 'no'.
   * - Save Template
     - save_template
     - select
     - no
     - ✓
     - Whether to persist the imported response template to the platform database and return a template_id; set to 'yes' to reuse the template across studies, default is 'no'.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Responsetemplate
     - template_id
     - integer
     - Integer ID of the saved response template in the platform database; only populated when save_template is 'yes'.
   * - References
     - references
     - dataset
     - Dataset listing all channel/data references (paths, subcase IDs, component labels) extracted from the HyperGraph file.
   * - Expressions
     - expressions
     - dataset
     - Dataset of math/derived-channel expression definitions found in the HyperGraph file; only populated when extract_expressions is 'yes'.
   * - Responses
     - responses
     - dataset
     - Dataset of response definitions (response name, type, units, channel mapping) parsed from the HyperGraph template, typed as platform responsetemplate responses.
   * - Layout
     - simlytiks_layout
     - json
     - JSON Simlytiks layout object (sl-layout) reconstructed from the HyperGraph page/window arrangement, ready for direct use in a Simlytiks dashboard.
   * - Logs
     - logs
     - dataset
     - Dataset containing import process logs, warnings, and any parsing errors encountered during HyperGraph file ingestion.

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

- cae.postprocessing.extraction
- cae.postprocessing.response
- 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>hypergraph_importer_worker</code>. Schema hash: <code>8b2ffcffda13</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>