Skip to content

Changelog

API Version 1 (current)

Released with HydroSym 2025.55

Initial release of the HydroSym Plugin API.

Methods

Lifecycle - GetInfo — plugin metadata, capabilities, menu declarations - Initialize — connect, authenticate, read config - Finalize — close connections, release resources

Menu & UI - OnMenuAction — handle menu item clicks; supports resultType none, component, openFile, projectId, variables - GetMenuItemState — dynamic enable/disable/check state - ShowSettings — show the plugin's settings dialog

Document Management - CheckOut — lock a file in PDM - CheckIn — release a lock and create a new version - GetFileStatus — query PDM status (unknown / checkedIn / checkedOut / released) - SaveFile — upload a file to the PDM vault

Project Metadata - GetProjectVariables — pull title-block data from ERP/PLM - SetProjectVariables — push title-block data to ERP/PLM - GetProjectId — request a project identifier from the external system

Component Data - GetComponentParameters — enrich a component with ERP data - GetPartFamilyMembers — list variants in a part family

BOM - GetBom — retrieve a BOM from the external system - UploadBom — push a BOM to the external system (structured or file)

Output / Export - UploadDrawing — upload generated PDF/DXF drawing files

Manifolds - GetManifoldIds — retrieve manifold block identifiers for an i-border

Transports

  • DLL transport (in-process native DLL)
  • Process transport (out-of-process JSON-RPC over stdin/stdout)