Available translations

Record Property

foundations.png
record-property.png
A record property is a piece of information that may be stored as part of the dataset or made available as a calculated property.
Content
Foundations->Node->Record Definition->Record Properties
What are the Record Properties used for?
In general this is the mechanism to define what information is going to be available to the consumers of data of this product.
When properties don't have a Formula, they define the format of the file that stores this data on disk. These record properties defines, the data type (string, number, etc), and in which order the data is saved. At the file there are no headers, just the data, because the header information is available here, for any process writing or reading the data from disk.
The formulas nodes there are used to expand the record definition adding fields that are not actually going to be saved on disk, to minimize space used, and they are going to be calculated at runtime. This allows processes that consume this data to have ell the fields available at runtime even though some were not actually saved on disk.
Records may have as many properties as required.
Configuring
Property Configuration
Properties
  • codeName is the name of the record as it is used in the bot's code.
  • isString determines if the field is a text string or if, in turn, is a numeric field. Dates are stored in the epoch format, which is numeric. The reason why this configuration is important is that fields that are strings need to be stored between “double quotes”.
  • isCalculated determines if the field is stored in the dataset or if, instead, is calculated at a later stage. A value true* means that the record is not stored. In the case isCalculated is not defined in the configuration, it is assumed to be false.
  • aggregationMethod defines which is the method that is going to be used in order to aggregate information when converting one Dataset Type into another which requires data aggregation.
  • apiQueryResponse identifies which API Query Response to use in creating this record property. For example you can specify a successful response (200) or too many requests response (429) allowing you to store different properties based on the response of the api. This setting is also important to define if you are using automation to connect the record property's API Response Field Reference nodes.
Foundations->Topic->Data Mining - Fetching Data From APIs->Data Aggregation
How Does Data Aggregation Work?
When Raw Data is fetched from the Internet, it needs to be converted into a Dataset Type either of Multi-Time-Frame-Daily or Multi-Time-Frame-Market types. Usually Raw Data is a timestamped dataset with a timesStamp field, or it has begin and end properties if they are fragmented in time slots of one minute.
From there the conversion process needs to generate elements with time slots of 2 min, 3 min, 4 min, 5 min, 10, min,... up to 24hs. To achieve this, each field needs to be aggregated in a certain way.
At the Bot where this conversion happens, the Record Property nodes needs to have an aggregationMethod config property that defines how this is going to be handled. Here is a list of the supported aggregation methods that can be used during this conversion procedure:
  • First: This means that the first value found within the time range being processed, will define the value of the Record Property.
  • Last: This means that from all values found at the current time range, the last will be selected for the final value of the Record Property node being evaluated.
  • Min: This means that the mathematical minimum value from all values found in the time range will be used as the value for the Record Property.
  • Max: This means that the mathematical maximum value from all values found in the time range will be used as the value for the Record Property.
  • Sum: This means that the sum of all values found in the time range will be used as the value for the Record Property.
  • Avg: This means that the average of all values found in the time range will be used as the value for the Record Property.
Initial Values
These are the Initial Values for Record Property configuration:
 {
    "codeName": "",
    "isString": false,
    "isCalculated": false
}
Examples
This is a list of properties featured by the Record Property configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Record Property Menu
The Record Property 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 Add Formula menu item has the following properties:
  • action: Add UI Object
  • disableIfPropertyIsDefined: true
  • propertyToCheckFor: recordFormula
  • label: Add Formula
  • actionFunction: payload.executeAction
  • actionProject: Visual-Scripting
  • relatedUiObjectProject: Foundations
The Add Field Reference menu item has the following properties:
  • action: Add UI Object
  • disableIfPropertyIsDefined: true
  • propertyToCheckFor: apiResponseFieldReference
  • label: Add Field Reference
  • actionFunction: payload.executeAction
  • actionProject: Visual-Scripting
  • relatedUiObjectProject: Foundations
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
Record Property Children
The Record Property node has the following childrenNodesProperties:
The Record Formula node property features the following properties:
  • name: recordFormula
  • type: node
The Api Response Field Reference node property features the following properties:
  • name: apiResponseFieldReference
  • type: node
Record Property Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Record Property with other nodes:
Compatible Types: