Geomant Scripting AddOn v2.0

Scripting Terms

Term	Description
Action	A shortcut link placed on a card that when clicked loads a 'far away' (otherwise not connected) card, while also setting explicit values to any variables that other node might rely on.
Agent	For the purposes of this documentation, an agent is anybody who is actually executing the published script, interacting with the cards.
Card	A card is a node in the script that gets presented to the agent. Cards contain elements the agents interact with. A script can have any number of cards connected via connections.
Card design	Elements on a card are organized into rows and columns to maintain UI appeal on computing equipments with vastly different screen sizes (e.g. laptop, desktop monitor, phone, tablet, etc). Cards can also contain navigation elements, and actions.
Column	A visual card UI component for placing elements into different columns within a row. A preset number of columns can be inserted and reorganized within a row.
Connection	The agent can jump or switch between connected nodes. There can only be a single connection between any two nodes but the limit to the number of connections on a single node is set only by the total number of other nodes in the script. A connection can have a routing logic associated to it.
Connection wizard	This is a list of all outward connections of the selected node, visible in the General tab of the properties panel. The list can be reorganized to affect the routing logic of the connections from top to bottom when the agent wishes to navigate to the next node.
Design view	One of the modes the Script Editor presents the script for editing. This is activated when the Design tab is clicked in the properties panel. The workspace changes to present the selected node in the activated screen size. For card nodes it will show the UI as if the agents would see it and the properties panel provides the necessary building blocks to build it up. For integration nodes the properties panel presents the integration options to set up.
Designer (person)	For the purposes of this documentation a designer is anybody who creates, modifies, publishes, or generally manages scripts for agents to work with.
Elements	An element is a single visual unit an agent can interact with on a card. These can present static or editable texts, the value of variables, multimedia objects (e.g. video), web links. Can be any type of standard HTML form elements like edit fields to add / change textual data, radio button groups, check boxes, dropdowns, etc.
General view	One of the modes the Script Editor presents the script for editing. It is activated when the General tab is clicked in the properties panel. In this mode the workspace presents the whole graph of the connected nodes and the properties panel shows the settings of the selected node (name, ID). It also shows the Connection Wizard.
Integration node	A type of node that does not provide any user interface for the agent, but performs data input and output with a designated data source. There can be any number of integration nodes at any part of the script. Data exchanged with the data source is kept in the variables. When an agent jumps from a visual card to an integration node, the agent will only see the subsequent card that follows that integration node.
Navigation	A special row with columns containing dedicated elements that when clicked allows the agent to jump back and forth between the predecessor and successor nodes.
Node	A node is the building block of the script. It could either be a visual card or an integration node.
Query parameter	Information passed to the Script Runner engine via the URL when launching a version of the script. Data passed in a query parameter is loaded into an associated variable for use. There can be any number of query parameters defined, though since these are passed in the URL, their use case is limited to unsecured data free to travel on public networks.
Properties panel	The are of the Script Editor application showing up at the right when editing a script. It provides configuration capabilities to the object selected in the workspace.
Routing logic	A set of filtering criteria associated to a single connection that gets evaluated when the agent decides to jump from a node to another one. Evaluation is based on the contents of variables. If there are more than one connection on a node, the routing logic on those connections are evaluated in an ordered sequence. The first logic that matches will designate the next node, no further connections are considered in the ordered list.
Row	A visual card UI component for organizing the various other items into rows. Rows can contain columns of elements, and navigation and action items. Rows can be reorganized.
Screen size	The screen is the physical area where all cards are displayed and agents work in. Script Editor allows the creation of any number of screen sizes (defined in pixels) so designers can preview how the cards would look like in them. Only one of the created screen sizes can be set active. These screen sizes are not used by the Script Runner service. During execution, Script Runner will either occupy the available space provided in a 3rd party application the screen is embedded in, or size the screen as per the values specified in specific query parameters.
Script	Also known as flow or workflow a script encompasses all visual card nodes, integration nodes, variables, connections and routing logic. A script also has a version.
Script Editor	The service allowing designer personnel to manage (create, alter, delete, publish, etc) the scripts.
Script Runner	The service responsible for loading and executing a script for the agents to use.
Variable	A single piece of data unit with a name, type and optional value. Data entered by agents on a card, fetched from a data source via an integration node, or passed using a query param are loaded to / from variables. In turn, the value of variables are getting evaluated in routing decisions between nodes. Variables can be read and modified in any nodes.
Version	Modified scripts can be retained by applying a version to them. When running a script, it is basically a version of it that gets executed. Any version can be configured to be executed, depending on the configuration of the service that executes it.
Workspace	The are of the Script Editor application showing up at the left when editing a script. It shows all the nodes and connections in a graphical format.