Abbreviations / Glossary

  • Codabix: Communication Data Bridge. This is the name of the software which this documentation covers.

  • Codabix Web Configuration: A webpage (HTML page) that allows to configure Codabix, e.g. managing its nodes. It is served by an embedded web Server and can either be accessed using the Codabix application (on Windows), or by using an external web browser (like Mozilla Firefox, Microsoft Edge, or Google Chrome).

  • Datapoint: See Node.

  • Project Directory: A directory on the file system which stores the Codabix back-end database (when using the default, embedded database), plugin configuration files and log files.
    The Placeholder <CodabixProjectDir> in the plugin documentation refers to this directory.

  • Global Identifier: A Global Identifier of a Node is a 128-Bit Integer (GUID) expressed as hexadecimal digits that uniquely identifies a Node in a Codabix instance and can be used to synchronize Nodes across distributed Codabix instances. When a Node is created, it gets either an new Global Identifier created with a random number generator (which means the probability of duplicate identifiers is extremely low, even across distributed machines), or gets an existing GUID (if the Node is to be synchronized with an equal Node on another machine).

  • Local Identifier: A Local Identifier of a Node is a 64-Bit Signed Integer that uniquely identifies a Node within a Codabix® instance. In contrast to a Global Indentifier, Local Identifiers cannot be used to synchronize Nodes across distributed CoDaBix® instances on other machines because they are generated serially (so different Nodes may get the same Local Identifier on different machines).

  • Node: A Node is an fundamental object in Codabix that is either a Datapoint Node which can store a value, or a Folder Node which can contain child Nodes. Nodes are organized in a tree and can be configured and accessed with the Codabix® Web Configuration and additionally by the REST interface and from plugins/devices.
    Each Node is uniquely identified by a Local Identifier (ID, 64-Bit Integer) and a Global Identifier (GUID, 128-Bit). Additionally, each Node has a name that uniquely identifies this Node within its parent Node. You can retrieve the local and global identifiers of a Node in the Codabix Web Configuration using the “Access” toolbar button.

  • Node Path: A Node path is a string that says how to navigate to a specific Node from the root Node by using the Node names, similar to a path in the file system. An example of a path is "/Nodes/Demo-Nodes/Temperature".
    You can retrieve the path to a specific Node in the Codabix Web Configuration by using the “Access” toolbar button.
    Note: A Node also has a “Path” property. This is however not the same as the Node Path - the “Path” of a Node refers to a plugin specific addressing scheme, e.g. for S7 variables it is the PLC address.

  • Plugin: An extension in functionality to Codabix, delivered as binary files (.DLL). With plugins, new interfaces and devices can be added to Codabix without having to change the main Codabix program.
    A plugin is stored in the Codabix program directory; therefore it is provided by the Codabix installation, not by the selected project.

  • REST Interface: An interface to Codabix using the HTTP(S) protocol. This allows to browse, read, and write Nodes by sending HTTP POST requests using a JSON payload.
    Just like the Codabix Web Configuration, it it served by the embedded web server of Codabix.

  • Script: A lightweight Codabix extension, written in JavaScript/TypeScript and added dynamically to Codabix via the Script Editor in the Codabix Web Configuration. Script Plugins provide a simple way to program Codabix. They are executed in an isolated environment (they can only access defined Codabix APIs like managing Nodes, not OS APIs) and their program code can be changed while Codabix is running.
    Unlike a regular plugin, a Script Plugin is stored as source code in the Codabix back-end database and therefore bound to the project.

  • Script Editor: A JavaScript/TypeScript editor within the Codabix Web Configuration with a rich developer experience (like IntelliSense) which makes writing Scripts easy.

  • Subscription: A request to a device to read specific variables in a regular interval and write the read values to the corresoinding datapoint Nodes, either only if the value has changed, or every time they have been read.

  • Synchronous Read: An operation that requests a device to actually read specific variables and store the values in the corresponding datapoint Nodes. The values are guaranteed to be physically read after the point in time when the synchronous read operation has been initiated.