.. _auto_physicaltest_apply_result_template:

*PHYSICALTEST APPLY RESULT TEMPLATE WORKER*
===========================================

Applies a response template to one or more physical tests to extract and optionally persist structured responses (KPIs). Use this worker to batch-process physical test records against a defined response template, with control over pagination, re-extraction, and auto-save behaviour.

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

Tagged: ``apply_template``, ``auto_save``, ``batch``, ``extraction``, ``pagination``, ``physical_test``, ``reextract``, ``response_template``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Physicaltest
     - apply_template_worker_pt_id
     - remote_lookup
     - —
     - ✓
     - One or more physical test records (remote lookup into the `physicaltests` datatype) to which the response template will be applied; required, repeatable.
   * - Response Template
     - apply_template_worker_rt_id
     - remote_lookup
     - —
     - 
     - The response template (remote lookup into the `templates` datatype) that defines which channels/KPIs to extract; leave blank to use the template already associated with each physical test.
   * - Save Extracted Responses
     - apply_template_worker_rt_auto_save
     - select
     - no
     - ✓
     - Controls whether extracted responses are written back to the physical test record (`yes`) or returned transiently without saving (`no`, default); choose `no` during development/debugging to avoid overwriting existing responses.
   * - Re-extract Existing Responses
     - reextract
     - select
     - no
     - ✓
     - When set to `yes`, forces a full re-extraction of channels even if responses already exist for the test; default `no` re-uses previously extracted responses to save processing time.
   * - Number of responses per page
     - num_responses_per_page
     - text
     - -1
     - 
     - Maximum number of responses returned per page; default `-1` returns all responses in a single page; set a positive integer together with `page_num` to paginate large result sets.
   * - Page Number
     - page_num
     - text
     - 1
     - 
     - 1-based page index to retrieve when paginating results; default `1` (first page); only meaningful when `num_responses_per_page` is a positive integer.
   * - Max File Size
     - max_value_size
     - text
     - 0
     - 
     - Target maximum payload size (bytes) used to auto-select the number of records per page; default `0` disables size-based pagination and defers to `num_responses_per_page`.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Physicaltest
     - physicaltest_id
     - dataset
     - Dataset of the physical test record(s) that were processed, returned as a `physicaltests` dataType for downstream reference or chaining.
   * - Responses
     - responses
     - dataset
     - Dataset of extracted response objects (`responses` dataType) containing the channel values and KPIs produced by applying the template; reflects the current page when pagination is active.
   * - Page
     - page
     - integer
     - Integer indicating the page number of the response dataset that was returned; useful for loop-based pagination in a parent workflow.
   * - Records per Page
     - limit
     - integer
     - Integer indicating the actual number of records per page that was used for this execution, which may be auto-computed from `max_value_size` if that parameter is non-zero.

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

- cae.postprocessing.response
- data.dataset.ingest
- platform.job_submission

.. raw:: html

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