Synergy Application Programming Interface (API)

The Synergy Application Programming Interface (API) is an Object Linking and Embedding (OLE) programming interface that enables certain functionality of this product to be automated.

Accessing Moldflow API Documentation

For Moldflow Synergy 2026.0.1 and newer:

• From the toolbar, click (Help > Moldflow Python API Reference) to access the Moldflow Python API documentation
• View the complete online reference
• From the toolbar, click (Help > Synergy API Reference) to access the Synergy API documentation with PowerShell examples

For earlier versions:

• From the toolbar, click (Help > Synergy API Reference) to access the Synergy API documentation with VBScript examples

Both documentation sources provide the reference materials and examples that you'll need for your scripting work.

For enhanced control of the OLE interface, use the Moldflow Python API.

Alternative automation clients for direct access to the OLE interface include:

• Python
• PowerShell
• Windows Script Host that can process VBScript (VBS), JScript, and other programming languages
• Visual Basic for Applications (VBA), a fully featured client that is part of the Microsoft Office application suite
• Visual Basic (VB)
• Internet Explorer
• Perl

Synergy can be automated by using the API in the following ways:

• Macros can be recorded and played from within Synergy and played from the Synergy command line.
• Python, PowerShell, and VBScript scripts can be run from the Synergy command line with or without command line arguments. These scripts can also be treated as macros and played through Synergy.
• To run recorded or written Python scripts outside Synergy, ensure you have installed Python 3.10 or later and the Moldflow Python API.

You can start a macro for a specific instance of Synergy on the local machine, using the InstanceID that you can find in the About box. To call a specific instance, your macro must include as its first line the following:

For Python and PowerShell

# %RunPerInstance

For VBScript

'%RunPerInstance

Note:

• Macros or scripts made for newer Synergy versions may fail on older versions due to missing features.
• The OLE interface opens the latest version of Synergy which was run with Administrative rights. This occurs during installation or when explicitly running Synergy as Administrator.