External Connection

External Connection
This container hold data for an instance of the External Process Connector.

Methods

ExecuteOperation

Command that wraps the script invoked by a custom GUI Operation

Required Arguments

Operation    The name of the operation to execute
    Type     string

GetExternalConnectionProperties

A Query to return a reference to the ExternalConnectionProperties entity

Return     A reference to the requested data entity.
    Type     DataReference

ReadConfiguration

Reads a External Connection configuration file.

Required Arguments

FilePath    The full path to the configuration file.
    Type     string

ReadParameterValues

Populates all the values of the parameters of a given type within a container.

Required Arguments

ParameterType    Type of parameter. Should be "input" or "output".
    Type     string

Data Entities

ExternalConnectionProperties

This entity holds the properties used to connect a Workbench project to an external process or application.

Properties

ConfigFile

The path to the configuration file defining application settings.

Type     string
Read Only    No
DisplayText

The general property that defines the user-visible name of an entity. This property is defined for all data entities but is used only in those entities that present a label in the user interface.

Type     string
Read Only    No
WorkingDirectory

The path to the working directory. This is optional. If this value is not set, it defaults to the add-in directory corresponding to the system ("project_files/dpN/sysDir/addinDir")

Type     string
Read Only    No