Application Programming Interface (API) changes for 2027

The following features are new, changed or deprecated with this release.

Improved Command Line in Synergy

The Moldflow Synergy Command line now includes an integrated scripting environment. Output and errors generated when running scripts are now displayed, making it easier to review results and diagnose issues.

Enhanced Python API Experience

The Python virtual environment used in Synergy is available in the Moldflow Synergy Command Line. The Synergy Command Line has been redesigned to support Moldflow API.

Python Virtual Environment Integration

Python developers can now access the Moldflow Python API module and virtual environment directly within the Moldflow Synergy Command Shell. This provides a consistent Python environment that matches the one used when executing Python scripts in Synergy.

New Synergy API calls for 2027

See the Synergy API reference in the product help for full details.

Class Function/Property Notes
CadDiagnostic CreateEntityList Creates an empty EntList object.
CadDiagnostic Compute CAD quality assessment to identify any potential geometric issues in the CAD model.
CadDiagnostic GetEdgeEdgeIntersectDiagnostic Retrieves intersecting CAD edge-to-edge information.
CadDiagnostic GetFaceFaceIntersectDiagnostic Retrieves intersecting CAD face-to-face information.
CadDiagnostic GetEdgeSelfIntersectDiagnostic Retrieves self intersected CAD edges.
CadDiagnostic GetFaceSelfIntersectDiagnostic Retrieves self intersected CAD faces.
CadDiagnostic GetNonManifoldBodyDiagnostic Retrieves CAD non manifold bodies.
CadDiagnostic GetNonManifoldEdgeDiagnostic Retrieves non manifold edges.
CadDiagnostic GetToxicBodyDiagnostic Retrieves toxic bodies.
CadDiagnostic GetSliverFaceDiagnostic Retrieves sliver faces.
Synergy Log Log a message to the Command Line Dialog.
PlotMgr ExportToVTK Export geometry and result data in Visual ToolKit (VTK) format.
Viewer ImageExportOptions Creates a new ImageExportOptions object for configuring image export settings.
PlotMgr SaveImage5 Saves a view image to a file using advanced options.
PlotMgr AnimationExportOptions Creates a new AnimationExportOptions object for configuring animation export settings.
PlotMgr SaveAnimation4 Saves the animation frames to a file using advanced options.
ImageExportOptions FileName Path where the image will be saved.
ImageExportOptions SizeX Image dimensions in pixels (width).
ImageExportOptions SizeY Image dimensions in pixels (height).
ImageExportOptions ShowResult Include the physical plot.
ImageExportOptions ShowLegend Include the color legend.
ImageExportOptions ShowRotationAngle Include the rotation angle values.
ImageExportOptions ShowRotationAxes Include the rotation axes indicators.
ImageExportOptions ShowScaleBar Include the scale bar.
ImageExportOptions ShowPlotInfo Include plot name and information.
ImageExportOptions ShowStudyTitle Include study title.
ImageExportOptions ShowRuler Include the model ruler.
ImageExportOptions ShowHistogram Include histogram data.
ImageExportOptions ShowMinMax Include min/max probes.
ImageExportOptions FitToScreen Auto scale the image to fit the view.
ImageExportOptions CaptureMode Determines what is captured: Active view only, All views, or Entire multi-document client.
AnimationExportOptions FileName Path where the animation will be saved.
AnimationExportOptions SizeX Animation dimensions in pixels (width).
AnimationExportOptions SizeY Animation dimensions in pixels (height).
AnimationExportOptions Animation Speed Animation speed: Slow, Medium, or Fast.
AnimationExportOptions ShowPrompts Whether to show prompts during the export process.
AnimationExportOptions CaptureMode Determines what is captured: Active view only, All views, or Entire multi-document client.

Deprecated Synergy API calls for 2027

Class Function Notes
Synergy Log Output logs to Synergy command line
Viewer SaveImage Please use SaveImage5 function
Viewer SaveImage2 Please use saveImage5 function
Viewer SaveImage3 Please use saveImage5 function
Viewer SaveImage4 Please use saveImage5 function
Viewer SaveAnimation Please use SaveAnimation4 function
Viewer SaveAnimation2 Please use SaveAnimation4 function
Viewer SaveAnimation3 Please use SaveAnimation4 function
MeshEditor FillHole Use FillHoleFromNodes instead. This method calls FillHoleFromNodes for backwards compatibility and will be removed in a future release
MeshEditor FillHole2 Use FillHoleFromTriangles instead. This method calls FillHoleFromTriangles for backwards compatibility and will be removed in a future release.
ImportOptions MDLKernel If present in script, it will be ignored
MeshGenerator Mesher3DType The LEGACY option is no longer supported. if present, an error is raised and the script halts
MeshGenerator AutomaticTetraOptimization If present in script, it will be ignored
MeshGenerator ElementReduction If present in script, it will be ignored
MeshGenerator UseFallbacks If present in script, it will be ignored
MeshGenerator UseTetrasOnEdge If present in script, it will be ignored
MeshGenerator TetraMaxAR If present in script, it will be ignored