Superalgos/docs/_includes/data_mine/product-definition.md

{% assign title = "Product Definition" %} {% assign definition = site.data.data_mine.product_definition %} {% assign preposition = "a" %} {% assign plural = "s" %}

{% if include.more == "yes" and include.heading == "more" %}

Click to learn more about {{ title | downcase }}{{plural}}

{% endif %}

{% if include.heading != "" and include.heading != "more" %} {{include.heading}} {{title}} {% endif %}

{% if include.icon != "no" %}

{% if include.table == "yes" and include.icon != "no" %}

{% endif %} {% if include.table == "yes" and include.icon != "no" %}

{% endif %} {% endif %} {% if include.definition == "bold" %} {{ definition }} {% else %} {% if include.definition != "no" %} {{ definition }} {% endif %} {% endif %} {% if include.table == "yes" and include.icon != "no" %}

{% endif %}

{% if include.more == "yes" and include.content == "more" and include.heading != "more" %}

Click to learn more about {{ title | downcase }}{{plural}}

{% endif %}

{% if include.content != "no" %}

A bot may feature multiple products, thus, there may be multiple product definitions. Three main aspects need to be defined in terms of products: the characteristics of the dataset, the composition of each record, and the way records are calculated.

{% include note.html content="A product definition usually references a plotter module, which provides a graphic representation of the underlying dataset" %}

{% endif %}

{% if include.more == "yes" and include.content != "more" and include.heading != "more" %}

Click to learn more about {{ title | downcase }}{{plural}}

{% endif %}

{% if include.adding != "" %}

{{include.adding}} Adding {{preposition}} {{title}} Node

To add a product definition, select Add Product Definition on the bot's node menu. A product definition is created along with the basic structure of nodes required to make up a product.

{% endif %}

{% if include.configuring != "" %}

{{include.configuring}} Configuring the {{title}}

Select Configure Product on the menu to access the configuration.

{
  "codeName": "New-Product-Name",
  "singularVariableName": "newProductName",
  "pluralVariableName": "newProductNames"
}

• codeName is the name of the product as it is used within the bot's code.

• singularVariableName is the singular form of the name of the variable representing the product, as is used on strategies (i.e.: bollingerChannel.direction, where bollingerChannel is the name of the product as defined in its configuration and direction is the name of the property.

• pluralVariableName is the plural form of the variable.

{% endif %}

{% if include.starting != "" %}

{{include.starting}} Starting {{preposition}} {{title}}

XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

{% endif %}

{% if include.more == "yes" %}

{% endif %}