.. _auto_assembler_create_assembly:

*CREATE ASSEMBLY*
=================

Creates a new assembly (or replaces an existing one) in the platform by bundling one or more CAE deck files under a named, typed, and project-scoped record. Use this worker whenever a workflow needs to register or refresh a structured assembly — such as a BIW or chassis — before downstream simulation or design-exploration steps.

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

Tagged: ``BIW``, ``assembler``, ``assembly``, ``cae_assembly``, ``chassis``, ``create_assembly``, ``deck``, ``structure``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Assembly Name
     - assembly_name
     - text
     - —
     - ✓
     - Human-readable name for the new assembly (e.g. 'BIW_v3'); required and must be unique within the project.
   * - Description
     - description
     - textarea
     - —
     - 
     - Optional free-text description of the assembly's purpose, variant, or configuration; leave blank if no additional context is needed.
   * - Type
     - type
     - text
     - structure
     - ✓
     - Assembly category string such as 'structure', 'BIW', or 'Chassis'; defaults to 'structure' and drives ontology classification in the platform graph.
   * - Color
     - color
     - color
     - #000000
     - ✓
     - Hex color code (e.g. '#FF5733') used to represent this assembly node in the graph visualization; defaults to '#000000'.
   * - Design Step
     - designstep_id
     - remote_lookup
     - —
     - 
     - Optional platform ID of the design step to associate with this assembly; leave blank if the assembly is not tied to a specific design step.
   * - Project
     - project_id
     - remote_lookup
     - —
     - ✓
     - Platform ID of the project that will own this assembly; required — select from the project lookup dropdown.
   * - Systemmodels
     - systemmodel_ids
     - remote_lookup
     - —
     - 
     - Optional list of platform system-model IDs to link to this assembly; supports multi-select for assemblies that span multiple system models.
   * - Tags
     - tags
     - text
     - —
     - 
     - Optional comma-separated metadata tags (e.g. 'release_1,frontal,steel') for filtering and search within the platform.
   * - Files
     - files
     - file
     - —
     - ✓
     - One or more CAE deck files to attach to the assembly; accepted formats are .key, .k, .zip, .tar, and .incl — at least one file is required.
   * - Existing Assembly Id to Update
     - assembly_id
     - text
     - —
     - 
     - Optional platform ID of an existing assembly to overwrite; if provided the existing assembly record is replaced rather than a new one being created.
   * - Parent Assembly
     - parent_id
     - remote_lookup
     - —
     - 
     - Parent from which the current Assembly was inherited
   * - Create one Assembly per File attached
     - create_one_assembly_per_file
     - select
     - no
     - 
     - If set to yes, each file will be used to create a new assembly. Assemblies will be post-fixed with a number in the order of files received

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Assembly ID
     - assembly_id
     - integer
     - Integer platform ID of the newly created or updated assembly; pass this downstream to simulation setup or design-exploration workers that require an assembly reference.

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

- cae.preprocessing.scenario
- platform.workflow

.. raw:: html

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