Built-In Dynamic Fields

Dynamic fields are not properties in the data you upload. They are built-in properties, whose values may change depending on user interaction with the planogram.

As such, these properties should only be used to create expressions for parts of your site that interact with the display itself (such as heatmaps, labels, planogrammed product tooltips, report properties), and not other sections (such as catalog filters, catalog sorters, or catalog tooltips).

Dynamic fields may be used in calculations as well as 1-1 property mappings (they appear in the final section of the property dropdown).

A brief description of each follows:

Field Expression Description
Aisle Returns the name of the aisle / endcap a product is on. Floorplan only.
Area The area of a product, in square units, taking into account its current orientation.
Barcode128 Returns the UPC (or ProductID, if no UPC found) of the product as a scannable Code 128 barcode, only in reports below images
Barcode39 Returns the UPC (or ProductID, if no UPC found) of the product as a scannable Code 39 barcode, only in reports below images
BarcodeEAN13 Returns the UPC (or ProductID, if no UPC found) of the product as a scannable EAN-13 barcode, only in reports below images
Bay The rack bay number, from left to right, a product is on. This will be 0 if a product is not on a rack. A synonym for BayNumber.
BayNumber The rack bay number, from left to right, a product is on. This will be 0 if a product is not on a rack. A synonym for Bay.
Capacity Returns the number of product that could fit in its current peghook or shelf. This accounts for product orientation. Default value is 1. A synonym for FacingsDeep.
ContainerIndex Returns the index of the container this product is in. If the product's container is on a shelf, the containers on it are ordered from 1 to N, left to right. If the product's container is parented to a rack, all containers on it are ordered from top left to bottom right, 1 to N. If the product's container is not on a shelf or a rack, this returns "Not in container".
ContainerPosition Returns the position of a product in a container, ordered from 1 to N, top to bottom. If product is not in a container, returns "Not in container".
ContainerQuantity Returns the quantity of this product you have specified (perhaps within its container), or 1 if product quantity has not been specified. A synonym for Quantity.
CostFits A decimal number specifying the cost of the product multipled by how many can fit on its current fixture / peghook. If the product is part of a facing group, this is still the cost per facing, not for all facings in the group.
CostQty A decimal number specifying the cost of the product multipled by how many the user has specified at that location. If the product is part of a facing group, this is still the cost per facing, not for all facings in the group. See also Quantity.
FacingsDeep Returns the number of product that could fit in its current peghook or shelf. This accounts for product orientation. Default value is 1. A synonym for Capacity.
FacingsHigh Returns the number of vertical facings in this position (facing group). Default value is 1.
FacingsWide Returns the number of horizontal facings in this position (facing group). Default value is 1.
FixtureDepth Returns the depth of the product's containing fixture. If the product is not on a fixture, returns 0.
Fixture The name of the fixture a product is on, or the empty string if the product is not on a fixture. A synonym for FixtureName.
FixtureDepth() Returns the depth of the product's containing fixture. If the product is not on a fixture, returns 0.
FixtureName The name of the fixture a product is on, or the empty string if the product is not on a fixture. A synonym for Fixture.
Gondola Returns the name of the gondola a product is on.
IsOnPegboard() Returns 1 if the product is on a pegboard, 0 otherwise.
IsOnShelf() Returns 1 if the product is on a shelf, 0 otherwise.
LocationID A number identifying a product location on a planogram. LocationID's are assigned left to right, top to bottom, per bay, per fixture.
Orientation Returns the orientation of this product (i.e. Front 90, Top, etc..)
PositionAcross A decimal number specifying the horizontal position of the product on its fixture.
  • For pegboards, this is the number of pegholes from the left edge of the pegboard.
  • For shelves, this is a unique number, from 1 to N (where N is the number of products / fixture groups on the shelf), from left to right
  • For containers, this is the same as ContainerIndex
  • For all other fixtures, this is the number of inches / cm across from the left edge of the fixture.
PositionDown A decimal number specifying the vertical position of the product on its fixture.
  • For pegboards, this is the number of pegholes down.
  • For shelves, this is always 0
  • For all other fixtures, this is the number of inches / cm down from the top of the fixture.
PriceFits A decimal number specifying the price of the product multipled by how many can fit on its current fixture / peghook. If the product is part of a facing group, this is still the price per facing, not for all facings in the group.
PriceQty A decimal number specifying the price of the product multipled by how many the user has specified at that location. If the product is part of a facing group, this is still the cost per facing, not for all facings in the group. See also Quantity.
Quantity Returns the quantity of this product you have specified (perhaps within its container), or 1 if product quantity has not been specified. A synonym for ContainerQuantity.
Rack The name of the rack the product is on, even if the product is in a different fixture that is attached to a rack. See also Fixture.
RackArea The area of the rack a product is on, in square units. If the product is not on a rack, this is 0. See also Area.
RackDepth Returns the depth of the rack this product is on, or 0 if product is not on a rack.
RackHeight Returns the height of the rack this product is on, or 0 if product is not on a rack.
RackWidth Returns the width of the rack this product is on, or 0 if product is not on a rack.
ShelfDepth Returns the depth of the shelf this product is on, or 0 if product is not on a shelf.
ShelfHeight Returns the height of the shelf this product is on, or 0 if product is not on a shelf.
ShelfIndex Returns the index of the product's shelf. Shelves on racks are ordered by vertical position. The highest shelf is index 1, and the lowest index N. Shelves with equal vertical positions are sorted based on their horizontal positions, leftmost shelves first. If the product is not on a shelf on a rack, this returns -1.
ShelfSegment Returns which shelf segment this product is on (from 1 to N, left to right). If the product is not on a segmented shelf, returns -1. See also ShelfSegmentAlpha.
ShelfSegmentAlpha Returns which shelf segment this product is on, parsed as a letter, where 1 -> "A", 2 -> "B" and so on. If the product is not on a segmented shelf, returns -1. See also ShelfSegment.
ShelfWidth Returns the width of the shelf this product is on, or 0 if product is not on a shelf.