Available translations

Data Mining - Indicator Frameworks

foundations.png
Summary: Indicator Bots are ready to run custom code, or run code provided by a framework in order to do their job.
Types of Indicator Implementations
  • Custom Code: This means the Indicator Bot will use custom made code to handle all data transformations.
  • UI-Defined: This means that the Indictor Bot will base its behaviour on the definitions at the UI including available frameworks, as well as the code snippets provided by the user.
Custom Code Indicators
Examples
These two indicators are currently implemented with custom code.
  • Candles-Volumes: Located at the Candles Data Mine
  • Bollinger-Bands: Located at the Bollinger Data Mine
How to Implement Custom Code
The way to implement a Custom Code Indicator is to set up the config for the Bot's Process Definition using the botModule property. This tells the bot that there will be custom code used for this Indicator. This is an example of what it should look like:
 {
    "codeName": "Multi-Time-Frame-Market",
    "description": "Produces different files with Multi-Time-Frame candles and volumes for entire markets.",
    "deadWaitTime": 0,
    "normalWaitTime": 0,
    "retryWaitTime": 10000,
    "botModule": "Candles Volumes Multi Time Frame Market"
}
Then you will need to locate the Project Schema File for the project your bot belongs to. Inside of that file you will need to add some definitions in order for the system to be able to load your new module at runtime and later execute it once users run your bot implemented in this way.
The definition you will need to add in the Schema file should look something like this:
 "botModules": [
                {
                    "name": "Candles Volumes Multi Time Frame Market",
                    "propertyName": "candlesVolumesMultiTimeFrameMarket",
                    "functionName": "newDataMiningBotModulesCandlesVolumesMultiTimeFrameMarket",
                    "fileName": "CandlesVolumesMultiTimeFrameMarket.js",
                    "folderName": "Indicator-Bot/Candles-Volumes"
                },
Finally, you will need to add a new Javascript module with your code to the codebase using the same file name you defined in the Schema file.
UI-Defined Indicators
In this case the list is long, as almost all other indicators in existence were build using a framework and defined at the UI with the minimun amount of code written by the users who created them.
Indicator Frameworks
This is the complete list of available Indicator Frameworks
How to Use an Indicator Framework
In order to use a framework at your Indicator Bot, all you need to do is specify the framework name at the Process Definition under the framework property.
In this example, the process will use the From-One-Min-To-Multi-Time-Frame-Daily framework.
 {
    "codeName": "From-One-Min-To-Multi-Time-Frame-Daily",
    "normalWaitTime": 0,
    "retryWaitTime": 10000,
    "framework": {
        "name": "From-One-Min-To-Multi-Time-Frame-Daily"
    }
}
Here is an example using the Multi-Time-Frame-Market framework.
 {
    "codeName": "Multi-Time-Frame-Market",
    "normalWaitTime": 0,
    "retryWaitTime": 10000,
    "framework": {
        "name": "Multi-Time-Frame-Market"
    }
}
Previous
Data Mining - Datasets Type Conversions
Next
Data Mining - Data Mine Hierarchy