.. _auto_plm_connection:

*PLM CONNECTION*
================

Connects to PLM systems (Siemens Teamcenter, CATIA/3DEXPERIENCE) to search parts, retrieve part details and bill-of-materials, download geometry files, and create assemblies. Use this worker whenever a workflow needs to pull CAD/BOM data from a corporate PLM into the d3VIEW platform.

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

Tagged: ``3dexperience``, ``assembly``, ``bom``, ``cad``, ``catia``, ``geometry``, ``iges``, ``integration``.

Inputs
------

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

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - PLM Server URL
     - plm_url
     - text
     - —
     - ✓
     - Base URL of the target PLM server (e.g., https://teamcenter.example.com); must be reachable from the execution environment.
   * - PLM System
     - plm_system
     - select
     - teamcenter
     - ✓
     - PLM platform to connect to; select 'teamcenter' for Siemens Teamcenter or '3dexperience' for Dassault 3DEXPERIENCE (defaults to 'teamcenter').
   * - Username
     - username
     - text
     - —
     - ✓
     - Username for authenticating against the selected PLM system.
   * - Password / Token
     - password
     - text
     - —
     - ✓
     - Password or API token for authenticating against the selected PLM system; treat as a secret and avoid logging.
   * - Operation
     - operation
     - select
     - search_parts
     - ✓
     - Action to perform: 'search_parts' (keyword search), 'get_part_details' (metadata for one part), 'download_geometry' (fetch CAD file), or 'get_bom' (bill of materials tree); defaults to 'search_parts'.
   * - Search Query
     - search_query
     - text
     - —
     - 
     - Free-text keyword, name, or ID string used to filter parts; required when operation is 'search_parts', ignored otherwise.
   * - Part / Item ID
     - part_id
     - text
     - —
     - 
     - Unique part or item ID in the PLM system; required for 'get_part_details', 'download_geometry', and 'get_bom' operations.
   * - Revision
     - revision
     - text
     - —
     - 
     - Specific revision label of the part (e.g., 'A', 'B'); leave empty to automatically retrieve the latest released revision.
   * - File Format
     - file_format
     - select
     - step
     - 
     - CAD file format to download when operation is 'download_geometry': 'step' (.stp), 'stl', 'jt', or 'iges' (.igs); defaults to 'step'.
   * - Assembly Name
     - assembly_name
     - text
     - —
     - 
     - Name to assign to a newly created assembly in the PLM system; used only when the operation involves assembly creation.
   * - Design Step ID
     - designstep_id
     - text
     - —
     - 
     - Target design step for the assembly (optional)
   * - Project ID
     - project_id
     - text
     - —
     - 
     - Target project for the assembly (optional)

Outputs
-------

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

   * - Label
     - ID
     - Type
     - Description
   * - Status
     - status
     - string
     - Human-readable status string indicating operation outcome (e.g., 'success', 'part_not_found', or an error message).
   * - Results
     - results
     - dataset
     - Tabular dataset of returned records (parts list, BOM rows, or part-detail attributes) depending on the operation performed.
   * - Raw Response
     - raw_response
     - json
     - Full JSON payload returned by the PLM API, useful for debugging or extracting fields not surfaced in the structured outputs.
   * - Assembly Id
     - assembly_id
     - integer
     - Integer identifier of the newly created assembly in the PLM system; populated only when an assembly-creation operation is executed.
   * - File Paths
     - file_paths
     - string
     - Comma-separated local file path(s) of downloaded geometry file(s) (STEP/STL/JT/IGES); populated only when operation is 'download_geometry'.

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

- 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>plm_connection</code>. Schema hash: <code>1cfd3d009122</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>