Available translations

Dataset Definition

foundations.png
dataset-definition.png
A data set is a collection of files stored in the designated location, as per the definitions on the referenced data product in the corresponding data mine.
Content
A good part of what makes datasets easy to consume by other bots is the fact that they are standardized in terms of their structure. It is that structure that is specified in the dataset definitions.
Configuring
Dataset Definition Configuration
Properties
  • codeName is the name of the dataset as used within the code.'Single-File'is a special value. Use it for datasets that do not depend on Time Frames and that have a timestamp Record Property instead of the regular Begin and End. When this type of datasets are a dependency of Market or Daily datasets, they need the codeName'Single-File'in order to be found on disk.
  • type refers to the type of dataset; possible values are market files and daily files.
  • validTimeFrames refers to the time frames handled by the dataset.
  • filePath sets the path on which files are stored; the proper name of the data mine, the bot and the product need to be entered.
  • fileName sets the name of the files that constitute the dataset.
  • timeFrames sets the name and path of the file indicating which time frames shall be filtered when the users sets a time frames filter.
Multi-Time-Frame-Market
 {
    "codeName": "Multi-Time-Frame-Market",
    "type": "Market Files",
    "validTimeFrames": [
        "24-hs",
        "12-hs",
        "08-hs",
        "06-hs",
        "04-hs",
        "03-hs",
        "02-hs",
        "01-hs"
    ],
    "filePath": "Project/@Project/@MineType/@Mine/@Bot/@Exchange/@BaseAsset-@QuotedAsset/Output/@Product/@Dataset/@TimeFrame",
    "fileName": "Data.json",
    "timeFrames": {
        "filePath": "Project/@Project/@MineType/@Mine/@Bot/@Exchange/@BaseAsset-@QuotedAsset/Output/@Product/@Dataset",
        "fileName": "Time.Frames.json"
    }
}
Multi-Time-Frame-Daily
 {
    "codeName": "Multi-Time-Frame-Daily",
    "type": "Daily Files",
    "validTimeFrames": [
        "45-min",
        "40-min",
        "30-min",
        "20-min",
        "15-min",
        "10-min",
        "05-min",
        "04-min",
        "03-min",
        "02-min",
        "01-min"
    ],
    "filePath": "Project/@Project/@MineType/@Mine/@Bot/@Exchange/@BaseAsset-@QuotedAsset/Output/@Product/@Dataset/@TimeFrame/@Year/@Month/@Day",
    "fileName": "Data.json",
    "dataRange": {
        "filePath": "Project/@Project/@MineType/@Mine/@Bot/@Exchange/@BaseAsset-@QuotedAsset/Output/@Product/@Dataset",
        "fileName": "Data.Range.json"
    },
    "timeFrames": {
        "filePath": "Project/@Project/@MineType/@Mine/@Bot/@Exchange/@BaseAsset-@QuotedAsset/Output/@Product/@Dataset",
        "fileName": "Time.Frames.json"
    }
}
Initial Values
These are the Initial Values for Dataset Definition configuration: 
 {
    "configuration": "Get the appropriate configuration from the documentation"
}
Examples
This is a list of properties featured by the Dataset Definition configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Dataset Definition Menu
The Dataset Definition node has the following Node Menu items:
The Configure menu item has the following properties:
  • action: Configure
  • label: Configure
  • iconPathOn: configuration
  • iconPathOff: configuration
  • dontShowAtFullscreen: true
  • actionFunction: uiObject.configEditor.activate
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
Dataset Definition Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Dataset Definition with other nodes:
Compatible Types: