The default External Connection add-in provides a single-component External Connection system in the External Connection Systems toolbox. This system acts as a proxy for the external application, enabling the external application to define and expose input and output parameters within the Workbench Schematic window. You can manipulate these External Connection-defined parameters in the same way as standard Workbench parameters—for example, in terms of design point creation, update, and state. Specifically, the External Connection add-in enables you to use the Design Exploration application’s capabilities with any external application.
Every External Connection system exposes a Read Configuration user interface operation as a component context menu. This user interface operation’s underlying command reads a Component Configuration XML file that contains all the information that the external process wants to provide to Workbench (see Configuration XML File Details for more information). At a minimum, the configuration file contains the following elements:
The definition of input and output parameters, including the parsing rules for reading the values from a file.
An operating system executable or a Python script to be executed during the component Update command. Python scripts execute within the Workbench Python interpreter; as a result, scripts have full access to the scriptable Workbench API (Using Journals and Scripts in the Workbench User's Guide).
External Connection reads and stores all the information defined within the Component Configuration file. You can access the stored configuration information through the Edit Configuration user interface operation on the external connection component’s context menu. Only infrastructure/integration changes within the external application should result in configuration file changes; otherwise, users should not modify loaded configuration settings.
When you invoke an Update on the External Connection component, the add-in:
Writes the current input parameter values to the file specified in the Component Configuration file.
Launches the external application.
Upon the completion of the external application, the add-in:
Verifies successful execution (and sends an error message if it was not successful).
Reads the current output parameter values provided by the external application in the file location specified in the Component Configuration file.
After you read a Component Configuration file into an External Connection component, Workbench disables the Read Configuration user interface operation. The Reset user interface operation, also a context menu operation on an External Connection component, discards the imported configuration information. Workbench re-enables the Read Configuration user interface operation upon Reset as you must load a new Component Configuration file to proceed.