Available translations

Product Definition

foundations.png
product-definition.png
The product definition node holds all definitions that make up a product, including how the product is calculated and the datasets the product is comprised of.
Content
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.
Configuring
Product Definition Configuration
Properties
  • codeName is the name of the product as it is used within the bot's code.
  • pluralVariableName is the plural form of the variable.
Initial Values
These are the Initial Values for Product Definition configuration: 
 {
    "codeName": "Product-Name",
    "singularVariableName": "productName",
    "pluralVariableName": "productNames"
}
Examples
This is a list of properties featured by the Product Definition configuration. Expanding a property shows sample values for the property extracted from the current Workspace.
Product Definition Menu
The Product 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 Install Product menu item has the following properties:
  • action: Install Product
  • label: Install Product
  • askConfirmation: true
  • confirmationLabel: Confirm to Proceed
  • workDoneLabel: Done
  • relatedUiObject: Product Definition
  • actionFunction: payload.executeAction
  • relatedUiObjectProject: Foundations
The Add Record Definition menu item has the following properties:
  • action: Add UI Object
  • disableIfPropertyIsDefined: true
  • propertyToCheckFor: record
  • label: Add Record Definition
  • actionFunction: payload.executeAction
  • actionProject: Visual-Scripting
  • relatedUiObjectProject: Foundations
The Add Dataset Definition menu item has the following properties:
  • action: Add UI Object
  • actionFunction: payload.executeAction
  • actionProject: Visual-Scripting
  • relatedUiObjectProject: Foundations
The Add Missing Items menu item has the following properties:
  • action: Add Missing Children
  • label: Add Missing Items
  • 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
Product Definition Children
The Product Definition node has the following childrenNodesProperties:
The Datasets node property features the following properties:
  • name: datasets
  • type: array
  • autoAdd: true
The Record node property features the following properties:
  • name: record
  • type: node
  • autoAdd: true
The Calculations node property features the following properties:
  • name: calculations
  • type: node
The Data Building node property features the following properties:
  • name: dataBuilding
  • type: node
The Api Query Parameters node property features the following properties:
  • name: apiQueryParameters
  • type: node
  • autoAdd: false
The Api Path Parameters node property features the following properties:
  • name: apiPathParameters
  • type: node
  • autoAdd: false
Product Definition Attaching Rules
The following are the Node Attaching Rules that govern the attachment of Product Definition with other nodes:
Compatible Types:
Product Definition Referencing Rules
The following are the Node Referencing Rules that determine which nodes Product Definition may establish a reference to:
Compatible Types: