APPLY RESULT TEMPLATE TO A STUDY¶
Applies a response template to all simulations or physical tests in a Study, extracting and optionally saving KPI responses in bulk. Use this worker to populate or refresh study-level results from a shared response template, with fine-grained control over which simulations are processed and which extraction mode is applied.
When to use¶
Tagged: auto_save, design_variables, doe, extraction, kpi, response_template, responses, simulations.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Choose Study | study_id | remote_lookup | — | ✓ | ID of the target Study (selected via remote lookup from /api/user/studies); all simulations or physical tests in this study will be processed — required. |
| Choose Template | responsetemplate_id | remote_lookup | — | ID of the response template to apply (selected via remote lookup from /api/user/responsetemplates); if left empty, the common responses already defined in the study are used instead. | |
| Save Extracted Responses | auto_save | select | no | Whether to persist extracted responses back to the study (‘yes’) or only return them as output datasets without saving (‘no’, default). | |
| Alternate Study Name | alternate_study_name | text | — | Optional display name override for the study within this extraction run; leave blank to use the study’s existing name. | |
| Extraction Type | extraction_type | select | 0 | Controls which responses are extracted: 0 = only missing, 1 = only stale (template newer than existing), 2 = remove existing and re-extract all, 3 = transformations only, 4 = all except views, 5 = only existing, 6 = remove existing, 7 = remove empty/null values, ‘report’ = report mode; defaults to 0 (Only Missing). | |
| Include Design Variables | include_design_variables | select | no | When the study is linked to a DOE, controls whether design variables are included: ‘no’ (default) to skip, ‘yes’ to pull them from the simulations, or ‘use_existing’ to supply a pre-built design-variables dataset via the input below. | |
| Simulations | simulations | dataset | — | Optional dataset of simulation records to restrict processing to a specific subset; if omitted, the worker processes all simulations in the study. | |
| Verify Required Responses | verify_required_responses | select | no | ||
| Required Responses to Check | reqd_responses | textarea | — | List of responses to check for their availability | |
| Choose Reference Test | physicaltest_id | remote_lookup | — | If a reference test is provided, the responses from those test are included and the error is computed for the responses that are commmon between the test and the simulations | |
| Reference Responses to compute Error | reference_responses | textarea | — | Multiple responses can be separated by a comma. Mapping can be specified using Test_Response:Sim_Response,… | |
| Merge Test Data with Simulations | merge_test_data | select | no | ||
| Compute Errors | compute_errors | select | no | ||
| Include Test Responses Names | include_test_responses_names | select | no | If a reference test is selected, response that match test-responses will be included in the simulation results | |
| Design Variables | user_design_variables | dataset | — | The order is expected to be in the same order as simulations |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Study ID | study_id | integer | Integer ID of the study that was processed, passed through for chaining to downstream workers. |
| Simulations | simulations | dataset | Dataset of all simulations (or physical tests) that were included in the extraction run, one row per simulation. |
| Responses | responses | dataset | Dataset of extracted response values keyed by simulation and response name, in wide or long format depending on template configuration. |
| Responses Summary | responses_summary | dataset | Aggregated summary dataset of response statistics or metadata across all processed simulations (e.g., min, max, coverage counts). |
| Num Simulations missing Responses | num_sims_missing_responses | scalar | Scalar count of simulations for which one or more responses could not be extracted, useful for validation and alerting. |
Disciplines¶
- cae.postprocessing.response
- platform.workflow
Auto-generated from platform schema. Worker id: study_apply_result_template. Schema hash: 4f1d2a823d93. Hand-curated docs in workerexamples/ override this page when present.