Connector Types

<< Click to Display Table of Contents >>

Navigation:  Web UI > Top Menu Toolbar > Preferences Menu >

Connector Types

 

The Connector Types Dialog lets you manage the Connector Types available in your Projects.

These connector types must be based on an existing Category (either one of the built-in connectors, or a registered custom one).

Connector Types dialog

Connector Types dialog

 

The existing elements in the Connector Types list are read-only - their fields cannot be modified.

The Used By section shows the list of Connectors of each specific type defined in the environment in the form [Project Name]/[Connector Name].

The fast-arrow-down expand symbol will be present for each item on the list.

To expand this list, click on its respective row/tile. The expanded section contains buttons for opening the Environment and Volumes editors for the selected connector type, as well as a full expanded list of the project/connectors that are currently using it.

To delete an entry, click the Delete garbage-can button.

exclamation_mark_16px Please note that you can only delete connector types that are not currently in use.

 

connector type not in use

connector type not in use

 

 

Add new Connector Type

 

To add a new Connector Type click on the add Add button.

Select a Category from the drop-down , then enter a Variety. The Variety is used to differentiate between Connector Types of the same Category. It can be anything, but must be unique for the Category.

 

Add New Connector Type

Add New Connector Type

 

 

To save an entry, click the Save save button.

Information-icon_16px The save button will only become available when all the required fields are filled.

 

Information-icon_16px * These fields are required

 

exclamation_mark_16px Connector Types are required for creating Connectors within projects. A Connector cannot directly use a Connector Category.

 

 

Edit a Connector Type

 

The only editable properties for a Connector Type are its lists of Environment Variables and Volume Mappings, which are accessible by clicking the Environment and Volumes buttons respectively.

conn-type-edit-environment

The Environment Variables Editor allows you the Edit, addAdd and garbage-canDelete System Environment Variables that will be set in all containers running this Connector Type. They present as Key-Value Pairs where the key is the name of the variable and the value is the value assigned to the variable.

Environment variables are generally used for setting useful file paths or parameters for the Producer running in the container.

 

 

conn-type-edit-volumes

 

The Volume Mappings Editor allows you to Edit, addAdd and garbage-canDelete Volume Mappings between the host machine and the containers running this Connector Type. They present as Key-Value Pairs where the key is a path on the Host Machine and the value is the mapped path inside Producer Containers.

Volume Mappings are generally used to provide access to files on the host to the Producer running in the container.