Glossary
- Attribute
-
An attribute is a column of an entryset containing a value for each entry present in the entryset.
See Also:
- Entrysets
- An in-depth explanation of Proto entrysets
- Basic Module
-
A basic module is an not editable module included with Proto that is combined with other modules to build custom modules. Each basic module is available in the toolbar and is documented in the module documentation.
- Builder
-
The Builder is the main window used to create and edit custom modules by assembling modules and making connections between them. The Builder window also contains the toolbar and the Guide.
- Connection
-
A connection is made from an output connector of one module to the input connector of another module. messages travel between modules and in and out of embedded custom modules through connections.
- Connector
-
Connectors provide input to and output from a module. See Input Connector and Output Connector.
- Control
-
A control is the Viewer component of a control module that provides visual feedback and enables the interactive manipulation of the module.
- Control Module
-
A control module is any module that displays a control in the Viewer.
- Custom Module
-
Every module that is created in the Builder is a custom module. Custom modules are comprised of modules and/or custom modules that are arranged and configured to enable the custom module to perform a variety of desired functions.
- Custom Module Input Connector
-
The custom module's input connector is located along the left side of the Builder. This input will transmit messages sent to this custom module's input connectors when it is embedded in another custom module. Right-click on this connector and select 'Edit...' to open the menu editor, which allows you to define the number and names of the custom module's input connectors.
- Custom Module Output Connector
-
The custom module's output connector is located along the right side of the Builder. This connector will transmit messages out from this custom module when it is embedded in another custom module. Right-click on this connector and select 'Edit...' to open the menu editor, which allows you to define the number and names of the custom module's output connectors.
- Data Type
-
Various kinds of information can be stored, processed, displayed, or passed between modules. This information can always be classified as a specific data type according to what kind of information it is. While connections can transmit any data type, input and output connectors only accept or send messages containing a specific data type or set of data types.
See Also:
- DataTypes
- An article describing each specific data type as well as their conversions and compatibilities
- Data View
-
The Data View is a window that displays the message that most recently traveled across a specific connection.
To Open a Data View
- Click and hold a connection in the Builder to display a temporary Data View.
- Right-click on a connection and select "View Data" to open a Data View window that monitors the data traveling across that connection while you interact with the module.
-
A dynamic menu is an input or output menu that generates and removes input and output connectors to reflect the module's current properties. For example, the Excel Reader provides an output connector corresponding to each region of an Excel spreadsheet as specified in its Property Panel. When a region is added, deleted, or edited in the Excel Reader's Property Panel, its output menu adjusts dynamically to reflect its current configuration.
- Embedded Module
-
A custom module is known as an embedded module when it is used in another "parent" custom module. Embedded modules can themselves contain other embedded modules. Messages travel in and out of embedded custom modules exactly as if their contained modules were inserted directly into the "parent" custom module.
- Entry
-
An entry is a row of an entryset containing a value for each attribute defined in the entryset.
See Also:
- Entrysets
- An in-depth explanation of Proto entrysets
- Entryset
-
An entryset is an organized collection of data that can be presented, edited, processed, stored, and passed between modules. Its structure can be thought of as a table of data. Each column is an attribute and each row is an entry.
See Also:
- Error State
-
An error state occurs in a module when it encounters an execution error, which usually results from an incompatible input message. An example of this would be when an input connector that expects a number receives a date. Whenever a module enters an error state, the Builder alters the display of the modules to show where the error is and a ToolTip appears to describe the specific error.
See Also:
- Fire On Connect
-
When a connection is made from a fire-on-connect output connector, it immediately sends a message to its newly connected input connector. For more information about a specific output connector, refer to the "Output Menu" section of its module documentation.
See Also:
- Execution
- A article detailing Proto's execution logic.
- GUID
-
A GUID, or globally unique identifier, is assigned to each entryset and each individual entry. Because the contents of an entryset or an entry are constantly changing, GUIDs are necessary to keep track of them for updates and identification.
See Also:
- Entrysets
- An in-depth explanation of Proto entrysets
- Guide
-
The Guide is the region displayed on the right side of the Builder window that provides contextual help that reflects the location and activity of the mouse.
Freezing the Guide
Because the contents of the Guide are actively changing according to the state of the mouse, it is often necessary to freeze the Guide in order to click the links displayed in it. To freeze the guide, hold down the "F" key. - Host Module
-
A host module is at the receiving end of a plug-in connection. It is able to use a compatible plug-in module in a specific, internal way.
See Also:
- Plug-ins
- A document specifying the enabled plug-in relationships
- Input Connector
-
Input connectors accept incoming messages over attached connections and determine how a module will handle them. A module's input connectors are accessible via its input menu. For more information about a specific input connector, refer to the Guide or to the module documentation.
-
An input menu is a browsable interface to a module's input connectors that is accessible by clicking on the left side of any module.
- Index Value
-
An index value numerically denotes the placement of an element in a collection. Proto uses one-based index values, meaning that in a numbered collection of items such as entries in an entryset, the first element in the collection has an index value of 1.
- Edit Mode
-
Edit mode allows you to arrange and resize the controls in the Viewer.
To Toggle Edit Mode
- Select "Edit Controls" from the "Tools" menu.
- Click the "Edit Controls" button in the lower right of the Viewer window. The button has a yellow padlock for an icon.
- Right-click on the background of the Viewer and select "Edit Controls".
- Press "Ctrl+E".
- Message
-
Messages are what modules send between one another in order to communicate. Messages travel over connections and can contain data of any data type.
See Also:
- Execution
- A article detailing Proto's execution logic
- Module
-
Modules are the building blocks of Proto. All modules - including Custom Modules - can be combined to build new custom modules, which can then be used to build other custom modules.
- Output Connector
-
Output connectors send outgoing messages from a module over attached connections. A module's output connectors are accessible via its output menu. For more information about a specific output connector, refer to the module documentation.
-
An output menu is a browsable interface to a module's output connectors that is accessible by clicking on the right side of any module in the Builder.
- Passive Connection
-
A passive connection transmits messages to its receiving module's input connector, but prevents that module from sending resultant messages to any of its output connectors. When you desire the output message from a module to eventually loop back and trigger an input message to that module, use a passive connection to avoid an infinite loop by enabling this circular message path to execute exactly once. If you attempt to make a connection that would create an execution loop, Proto will refuse to make the connection unless it is passive. Passive connections are colored green in the builder.
To Make a Connection Passive
- Right-click on a connection and select "Passive".
See Also:
- Execution
- A article detailing Proto's execution logic
- Plug-in
-
Connecting a module as a plug-in creates an internal connection between the plug-in module and the host module where connected modules are able to collaborate as a part of the host module's internal processing. Only certain compatible modules can participate in a plug-in connection.
See Also:
- Plug-ins
- A document specifying the allowed plug-in relationships
- Property Panel
-
Property Panels allow you to configure how a module looks and functions. Individual modules' Property Panels are described in the module documentation.
To Open a Module's Property Panel in the Builder or Viewer
- Double-Click on the module
- Right-Click on the module and select "Properties..."
- ProtoDB
-
A ProtoDB is a database used to save, share, reuse, and maintain entrysets. A ProtoDB can be either personal or shared with other people in the same workgroup.
See Also:
- Entrysets
- An in-depth explanation of Proto entrysets
- ProtoDBReader
- ProtoDB Reader documentation
- ProtoDBWriter
- ProtoDB Writer documentation
- Toolbar
-
The toolbar is a list of modules represented by their icon that enables quick insertion of a modules in the Builder. It starts docked at the top of the Builder window.
To insert a Module in the Builder
- Double-click on the module.
- Drag the module from the toolbar onto the Builder.
- Viewer
-
The Viewer is the interactive, customizable interface of a custom module that displays its contained module's controls. You can arrange the controls in the Viewer with edit mode.