Database Item Reference

image

This section provides the complete reference to integrate products and shelf tools in your PlanogramBuilder database.

The properties are listed in the same order they appear in the exported database columns.

Database Item Properties

image

Property Name (Column header)

Property Value (Column content)

Reference

A compulsory unique reference code for each item. You can use the EAN, UPC, SKU code or any other unique reference. (ex: 045631)

Note: valid characters are [0-9][A-Z][a-z][the space character]$&@=.,;-_!^~)(][}{

Invalid characters are replaced by an underscore [_].

Note: the number symbol [#] is not allowed in Database Editor field, but can be used with a special meaning when importing or exporting the database.

 

Classification property A *1 *2

(ex: Category)

(default value: empty)

For each item, the value corresponding to the selected property. (ex: Drinks)

Classification property B *1 *2

(ex: Brand)

(default value: empty)

For each item, the value corresponding to the selected property. (ex: Coca-Cola)

Classification property C *1 *2

(ex: Product line)

(default value: empty)

For each item, the value corresponding to the selected property. (ex: Zero)

Name *2

(default value: empty)

The name of the item as it will appear in the catalog. This is usually the actual product name as printed on the product packaging (ex: Coca-Cola Zero 500ml).

 

Width *3

(default value for products and

shelf tools: 10cm/100mm/5in)

 

the physical width of the item in the selected measurement unit (ex: 6).

 

Height *

(default value for products and

shelf tools: 10cm/100mm/5in)

 

the physical height of the item in the selected measurement unit (ex: 20).

 

Image

(default value: empty)

For each item, an image can be used to achieve a more realistic look.

This property is the filename + extension of the item picture. (ex: 045631.png)

Note: Pictures are not compulsory. If you don't have a picture, the product will appear as a solid color, white by default, with its name printed on the front if it uses the box shape. See Color below for details on this property.

Note: The maximum supported size for image files is 5 MB.

Note for batch importing: If you type in only the image filename without extension in your Excel file, the importer will try to automatically find your image with the supported extensions in the following order: png, jpg, jpeg, jpe, jfif, bmp, tif, tiff, gif, tga, ico.

Please see Guidelines for Images for instructions to prepare your images.

Behavior

(product default: standard)

(shelf tools default: panel)

The Behavior property is specific to PlanogramBuilder. It determines how and where an item will be positioned when dragging it to the bay.

Behaviors for products:

Please see Product Behaviors for the list of possible values.

Behaviors for shelf tools:

Please see Shelf Tool Behaviors for the list of allowed values.

Note: The Behavior value can be overridden per facing in any planogram: see Item Info.

Collisions

(default value: 1)

1 (checked in GUI): the item will collide with other items.

0 (unchecked in GUI): the item will be able to overlap other items in the planogram. It can be necessary to disable collisions for items that have overhanging parts or are slanted.

Note: Collisions have no effect if the general collisions parameter in settings is disabled. See Collisions.

Width gap [...]

(default value: empty)

Only applicable to products. Sets the horizontal gap between products with multiple facings wide.

By default, products with multiple facings wide are placed with no gap between each others. You can however override this behavior by specifying in the database a predefined gap between items.

 

Note: For products pegged on pegboard type panels, the value entered corresponds to the minimal gap: the product will be placed on the nearest hook guaranteeing this minimal gap.

Note: The Width gap can also be overridden per facing in any planogram: see Item Info.

Height gap [...]

(default value: empty)

Only applicable to products. Sets the vertical gap between products with multiple facings high.

By default, products are stacked along the height axis with no gap between each others. You can however override this behavior by specifying in the database a predefined gap between items. Example: a value of 1 will force a gap of 1 measurement unit (cm or inch) between each repetition of this product in height.

Note: For products pegged on pegboard or slatwall type panels, the value entered corresponds to the minimal gap: the product will be placed on the nearest hook guaranteeing this minimal gap.

Tip: This parameter is also very convenient if you want to represent products nested into each others on a pile. In this case, enter a negative value corresponding to the amount of space the product should be nested inside the one below. Ex: enter -3 for a bowl which is nested 3 units inside the bowl below itself. Each bowl on the pile with this reference will also use this value.

Note: The Height gap can also be overridden per facing in any planogram: see Item Info.

Lateral offset […]

(default value: empty)

Lateral offset (pegged products only) lets you shift products to the left or to the right. This is convenient when the product hanging tab is not centered on the product.

·          Default empty value = 0cm or 0”

·          value of 0 = the product is centered on the peg hole

·          positive values = moves the product right

·          negative values = moves the product left

Note: The offset can be previewed in database Editor if Show Peg Hooks is ON.

Vertical offset […]

(default value: empty)

Vertical offset (pegged products only) lets you shift products higher or lower by a specified distance. This is convenient to define the position of the hanging hole on a product.

·          default empty value = a negative offset of 1cm or 0.39"

·          value of 0 = the product top edge is aligned to the peg hole on the back panel

·          positive values = moves the product up

·          negative values = moves the product down

 

Note: The offset can be previewed in database Editor if Show Peg Hooks is ON.

Color

(default value: empty.)

Empty values are treated as if a white color was applied)

The Color property lets you specify a solid color for each item in the database. The color has the following effect on items:

If no image is specified for an item, the specified color is also applied instead of the image. The color is also applied in Schematic view in box & text mode.

The color value is specified in the database using the standard HTML color codes (ex: #FF0000 for red). A complete reference of theses HTML color codes is available at http://www.colorpicker.com/ or https://html-color-codes.info/ for example.

In Database Editor, the item color can also be picked from a color palette by clicking on the color swatch, or by activating and clicking the color picker tool over the item preview area.

Caption

(default value: empty)

Applicable to shelf tools with the Tag behavior only.

Enter the text you want to display on the selected Tag item.

Allowed values are:

·          A text string (ex: On Sale)

·          [br]: insert a line break

·          [number]: display the Number of the nearest product. The number helps indentifying the product position and is the same as shown in report listings when choosing the Number column.

·          [reference]: display the Reference of the nearest product.

·          [name]: display the Name of the nearest product.

·          [custom1]: display the Custom Property 1 of the nearest product. Replace [custom1] by the actual property name you defined in Item Custom Properties. Ex: [Weight]

·          [custom2], [custom3], [custom4], [custom5] and [custom6]: same as [custom1] above, to display other custom property values.

·          Any combination of the above values

An empty value results in no text shown on the tag

Example: On Sale ! [br] 20% OFF [br] [name]

Note: Make sure to actually type the square brackets when applicable.

Text height

(default value: empty

= auto-height)

Applicable to shelf tools with the Tag behavior only.

Enter a numeric value to set the selected Tag item caption height.

The measurement unit used is the same as selected in Settings.

Example: 0.3

Note: with an empty Text height or a value of 0, an automatic allocation of the text height is applied based on the item height.

Text color

(default value: empty = black)

Applicable to shelf tools with the Tag behavior only.

Enter the color of text captions for the selected Tag item in hexadecimal format (with or without the # prefix, not case-sensitive).

Example: #0000FF results in blue text captions.

Note: with an empty value, text is black.

Custom property 1 *1 *2

(ex: Weight)

(default value: empty)

For each item, the value corresponding to the selected property. (ex: 5kg)

Custom properties 2, 3, 4, 5, 6 *1 *2

(default value: empty)

Same as Custom property 1. For each item, the value corresponding to the selected custom property.

Enabled

(default value: 1)

1 (checked in GUI): the item is available in the product or shelf tool catalog.

0 (unchecked in GUI): the item exists in the database, but is not available in the product or shelf tool catalog.

This is useful to prevent other users in your company from using some items in planograms, such as for products that are no longer sold but you may want to reactivate later.

Type

(default value: 0)

The Type of item:

0 = Product

1 = Shelf Tool

This property can be used to Batch Import Database Items. In Database Editor, it corresponds to the radio button to toggle Products / Shelf Tools.

Shelf Tool

(default value: 0)

Deprecated: now replaced by the Type property, but still supported for backwards compatibility.

The Shelf Tool property indicates:

0 = Product

1 = Shelf Tool

This property can be used to Batch Import Database Items. In Database Editor, it corresponds to the radio button to toggle Products / Shelf Tools.

 

Important Note: If you have set the language of the user interface to a language other than English, the above properties have different names. Ex: the Width property is named Largeur in French.

Note *1: Please see Database Setup for details on these properties.

Note *2: Denotes a property where you can use Unicode characters for non-Latin text values.

Note *3: Please see Measurement unit for information on how to select your preferred measurement unit.

 

Guidelines for Images

image

For each product and shelf Tool, one image can be used to achieve a more realistic representation. You can use existing images or take photos of your product.

Please follow the instructions below to prepare your images:

Choosing the right product view

·         take a picture of the product front face.

Taking the pictures

·         Don't use a flash as it creates bright hotspots on the photo.

·         Take the picture straight on, not from an angle.

Using a transparent background

·         PlanogramBuilder supports transparent backgrounds in images: the transparent area will be invisible when you place your product or shelf tool on shelf.

Note: the following image formats support transparency in PlanogramBuilder:

·          png and tif 32 bits with 256 levels of gray for variable transparency (alpha channel).

·          png and gif 8 bits with 1 transparent color.

Cropping your images

·         Auto-crop: if your images have a transparent background as explained above, PlanogramBuilder performs an automatic crop to remove the unwanted area surrounding the product.

·         Manual crop: images that don't have a transparent background should be cropped manually to the outer limits of your product (i.e. the image must be cropped so that the outline of the product touches the 4 edges of the image as much as possible). Please see the image examples below.

Image formats and resolution

·         Save the picture in a supported format: jpg, png, bmp, gif or tif. (use only gif, tif or png for transparency support)

·         Each picture file must be smaller than 5 MB for PlanogramBuilder. Otherwise it won’t be uploaded.

·         Images are automatically downsized by PlanogramBuilder if larger than 786'432 pixels (=1024x768 or 500x1573 for example). Uploading images larger than this will not provide better quality.

·         Make sure the image size is just large enough to distinguish the desired detail. Typically you want to be able to read the text on the product or packaging.

Batch importing products with images

·         If you intend to use the Batch Import feature, make sure you save your images in the same folder as your products *.txt list file, or in one of its child folders.

·         If you type in only the image filename without extension in your Excel file, the importer will try to automatically find your image with the supported extensions in the following order: png, jpg, jpeg, jpe, jfif, bmp, tif, tiff, gif, tga, ico.

·         Please see Batch Import Database Items for detailed instructions.

 

Please look at the examples of good and bad pictures below. The dotted lines represent the edges of each image:

image   image   image   image   image

 


Product Behaviors

image

Four types of products can be created with PlanogramBuilder, each of them corresponding to a specific value for the database Behavior field. Here are the possible values, descriptions and images showing example products for each Behavior value:


 Behavior value

 Description

Example

standard

(default value)

A standard product.

It sits on shelves.(ex:  a bottle of soda)

image

stackable

Stackable products are the same as standard products except they can be stacked onto different products which also have the stackable behavior.

Use this behavior for all products which must often be stacked on or below different products. Note: a stacked product is centered laterally on the product below, so it is best suited for stacking different products of the same width.

Do not use this behavior if you want to create vertical piles of the same product. In this case see instead Change Product Facing Count. Exception: if you have created project with products stacked as separate items, keep the stacked behavior for your products (typically projects saved before October 2019).

image

tester

A tester product.

It sits on shelves, but is placed at the front edge of the shelf. You can place standard products behind it. (ex: a perfume tester, which will be placed in front the packaged perfumes)

image

pegged

A pegged product.

It hangs on pegs. (ex: blister packs)

image

Note: Even if you choose a language other than English for the user interface, the names of the behaviors remain as listed above.

Shelf Tool Behaviors

image

Several types of shelf tools can be created with PlanogramBuilder, each corresponding to a specific value for the database Behavior field. Here are the possible values, descriptions and example images showing sample shelf tools for each Behavior value (listed alphabetically):


 Behavior value

 Description

Example

bay header

A shelf tool which snaps to the top of any back panel.

Note: if the bay has no back panel, you cannot place a bay header. In this case we suggest creating a small back panel as a crossbar to support your desired bay header.

Use this to place header panels above your back panels.

image

panel

(default value)

A shelf tool which snaps onto the back of any bay.

Note: if the bay has no back panel, the header can be positioned between the lowest and highest shelves.

Use this to create posters, back cards or any other hanging POS.

image

Shelf strip

A shelf tool which snaps onto the front edge of any shelf. It is horizontally centered and aligned to the top of the shelf.

Use this to create single shelf strips.

image

sticker

A shelf tool which snaps to the front of a shelf or shelf strip at any lateral position.

Use this to create cards, typically used to show information or specials.

image

tag

A box which can be placed on the front edge of a shelf to display as a label for the actual product name, pricing or other  text (no image).

Tags have dedicated parameters:

Caption

Text height

Text color

See details for each above parameter in the Database Item Properties.

image

shape defined

This is a special behavior to use only if you have been instructed to.

 

Note: Even if you choose a language other than English for the user interface, the names of the behaviors remain as listed above.

 




PlanogramBuilder Light User Guide - © Copyright zVisuel, 2001-2020