APPLY RESULT TEMPLATE WORKER¶
Applies a pre-defined Response Template to one or more simulations, loadcases, system models, or studies, extracting and optionally persisting KPI responses. Use this worker to automate post-processing KPI rollup within a workflow pipeline.
When to use¶
Tagged: auto_save, composite_responses, kpi_extraction, post_processing, re_extract, response_template, result_template.
Inputs¶
| Label | ID | Type | Default | Required | Description |
|---|---|---|---|---|---|
| Simulation | apply_template_worker_sim_id | remote_lookup | — | ✓ | One or more simulation records (remote lookup) to which the response template will be applied; select from the platform simulation registry. |
| Response Template | apply_template_worker_rt_id | remote_lookup | — | Remote lookup reference to the Response Template(s) to apply; repeatable to apply multiple templates in sequence. | |
| Auto Save | apply_template_worker_rt_auto_save | select | yes | Whether to automatically persist extracted response data back to the simulation record; default is ‘yes’ — set to ‘no’ to preview results without saving. | |
| Re-extract Following Responses | rextract_responses | textarea | — | Newline- or comma-separated list of response names/IDs to force re-extraction; leave blank to extract all responses defined in the template. | |
| Use Remote Hosts | use_remote_hosts | select | no | Whether to route extraction jobs to alternate remote hosts; default is ‘no’ — set to ‘yes’ only when a dedicated extraction host cluster is configured. | |
| Extraction order for Composite Responses | extraction_order | select | no | Ordering strategy for composite responses: ‘dependency’ (default) resolves responses in dependency-tree order; ‘chronological’ processes them in the order they were defined. | |
| Use Remote Hosts | return_individual_responses | select | yes | Controls whether the worker returns each extracted response record individually in addition to the aggregated records dataset; leave at default unless downstream nodes require per-response routing. | |
| Date Start | date_start | date | — | ||
| Date End | date_end | date | — | ||
| Save to File | save_to_file | select | no | Instead of sending the extracting results as a dataset, this option allows to return path to Excel file |
Outputs¶
| Label | ID | Type | Description |
|---|---|---|---|
| Simulation | simulation_id | integer | Integer ID of the simulation record against which the response template was applied; can be passed to downstream workers that require a simulation reference. |
| Records | records | dataset | Dataset of all extracted response records (KPIs, time-histories, scalars) produced by the applied template, in platform response format. |
| Records File | records_file | file | File artifact containing the serialized extracted records (e.g., CSV or JSON); useful for archiving results or passing data to file-based downstream workers. |
Disciplines¶
- cae.postprocessing.extraction
- cae.postprocessing.response
- platform.job_submission
Auto-generated from platform schema. Worker id: apply_result_template. Schema hash: 49dca45a8bdd. Hand-curated docs in workerexamples/ override this page when present.