.. _auto_simulation_save_attachment:

*SAVES ANY FILE TO AN SIMULATION*
=================================

Attaches any file to an existing simulation record in the d3VIEW platform, storing it with optional metadata such as an alternate name, tags, and description. Use this worker whenever a workflow needs to persist a result file, report, or artifact against a specific simulation for later retrieval or audit.

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

Tagged: ``attachment``, ``file_save``, ``platform``, ``simulation``, ``user``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simulation
     - simulation_id
     - remote_lookup
     - —
     - 
     - Remote-lookup ID of the target simulation record to which the file will be attached; must resolve to a valid simulation via the `remote_lookup_simulations` primary key.
   * - Attachment To Save
     - attachment_file
     - file
     - —
     - ✓
     - The file to be saved as an attachment; accepts any file type and is required — no default exists.
   * - Alternate File Name
     - alt_name
     - text
     - —
     - 
     - Optional alternate filename to store the attachment under; if omitted, the original filename of `attachment_file` is used.
   * - Tags
     - tags
     - text
     - —
     - 
     - Optional comma-separated or space-separated tag string applied to the attachment for search and filtering purposes; leave blank if no tagging is needed.
   * - Description
     - description
     - textarea
     - —
     - 
     - Optional free-text description of the attachment, providing context about its contents or origin; leave blank if no annotation is required.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Simulation
     - simulation_id
     - integer
     - Integer ID of the simulation record to which the file was attached; mirrors the input and can be forwarded to downstream workers targeting the same simulation.
   * - Attachments
     - attachments
     - dataset
     - Dataset of all attachment records currently associated with the simulation after the save operation, including metadata fields such as filename, tags, and description.
   * - First Saved Attachment ID
     - first_attachment_id
     - integer
     - Integer ID of the first attachment saved during this operation; useful when the worker processes a batch and the earliest record is needed downstream.
   * - Last Saved Attachment ID
     - last_attachment_id
     - integer
     - Integer ID of the most recently saved attachment from this operation; use this to reference the just-created attachment in subsequent workflow steps.

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

- data.io.file
- platform.integration

.. raw:: html

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