.. _auto_keyvalue_write_to_file:

*EXTRACT THE VALUE OF A RESPONSE NAME FROM A KEYVALUE*
======================================================

Extracts the value associated with a named response from a KeyValue input and writes it to a file. Use this worker when you need to persist a specific KeyValue response entry as a standalone file within a workflow.

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

Classification: **process**.

Tagged: ``extract``, ``file``, ``keyvalue``, ``response``, ``scalar``, ``write``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Response To Extract From
     - responsetoextractfrom
     - keyvalue
     - —
     - 
     - KeyValue map containing named response entries; the worker will locate and extract the target response value from this input — leave unset if the upstream node passes the KeyValue directly.
   * - File Name
     - file_name
     - scalar
     - Unknown
     - 
     - Name of the output file to write the extracted value into (string, no extension enforced); defaults to 'Unknown' if not specified.

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - keyvalue_write_to_file_output_1
     - keyvalue_write_to_file_output_1
     - bulk
     - Bulk output containing the file artifact produced by writing the extracted KeyValue response value to disk; consumed by downstream file-handling or reporting workers.

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

- cae.postprocessing.extraction
- data.io.file

Runnable example
----------------

A runnable example is registered for this worker. Open the example workflow on the d3VIEW canvas: `/api/workflow/example?id=keyvalue_write_to_file <https://www.d3view.com/api/workflow/example?id=keyvalue_write_to_file>`_

.. raw:: html

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