Available translations
loading results
Data Mine
A data mine is a hierarchy that contains definitions of sensor and indicators bots, and their plotters. These definitions are consumed from the actual code of such bots.
Content
In a way, data mines are catalogs of bots that anyone may create. This hierarchy provides all the tools required to create sensors, indicators, and plotters, with minimal coding required.
Because the hierarchy provides definitions, it does not intervene in the execution of bots. Instead, the definitions in data mines are instantiated from the network hierarchy by bot instances. Bot instances and process instances are the ones running the code according to the definitions in the corresponding data mine.
Configuring
Data Mine Configuration
Properties
-
codeNameis the name of the data mine as used within the code of the system.
Initial Values
These are the Initial Values for Data Mine configuration:
{
"codeName": "Type a name with no spaces or dashes"
} Examples
This is a list of properties featured by the Data Mine configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Data Mine Menu
The Data Mine node has the following Node Menu items:
The Configure menu item has the following properties:
- action: Configure
- label: Configure
- iconPathOn: configuration
- iconPathOff: configuration
- iconProject: Foundations
- dontShowAtFullscreen: true
- actionFunction:
uiObject.configEditor.activate
- actionProject: Foundations
The Add Sensor Bot menu item has the following properties:
- action: Add UI Object
- label: Add Sensor Bot
- relatedUiObject: Sensor Bot
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Data-Mining
The Add API Data Fetcher Bot menu item has the following properties:
- action: Add UI Object
- label: Add API Data Fetcher Bot
- relatedUiObject: API Data Fetcher Bot
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Data-Mining
The Add Indicator Bot menu item has the following properties:
- action: Add UI Object
- label: Add Indicator Bot
- relatedUiObject: Indicator Bot
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Data-Mining
The Add Study Bot menu item has the following properties:
- action: Add UI Object
- label: Add Study Bot
- relatedUiObject: Study Bot
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
- relatedUiObjectProject: Data-Mining
The Add Plotter menu item has the following properties:
- action: Add UI Object
- label: Add Plotter
- relatedUiObject: Plotter
- relatedUiObjectProject: Foundations
- actionFunction:
payload.executeAction
- actionProject: Visual-Scripting
The Delete menu item has the following properties:
- action: Delete UI Object
- actionProject: Visual-Scripting
- askConfirmation: true
- confirmationLabel: Confirm to Delete
- label: Delete
- iconPathOn: delete-entity
- iconPathOff: delete-entity
- actionFunction:
payload.executeAction
Tip: When a menu item is grayed out, it means that Data Mine already has the required child type that the menu item may add, and only that child is allowed for that case.
Data Mine Children
The Data Mine node has the following childrenNodesProperties:
The Sensor Bots node property features the following properties:
- name:
sensorBots
- type: array
- childType: Sensor Bot
The Api Data Fetcher Bots node property features the following properties:
- name:
apiDataFetcherBots
- type: array
- childType: API Data Fetcher Bot
The Indicator Bots node property features the following properties:
- name:
indicatorBots
- type: array
- childType: Indicator Bot
The Study Bots node property features the following properties:
- name:
studyBots
- type: array
- childType: Study Bot
The Plotters node property features the following properties:
- name: plotters
- type: array
- childType: Plotter
- project: Foundations