Properties for Business Panels

These properties configure business panels in Store Studio.

For more information, see Configuring Business Panels.

These attributes are available in the includes tag. This section lists all additional files used in the business panels. All these files must be uploaded on the configuration object to be included. The uploaded files must be Javascript files (.js). The configuration of this tag is optional.
AttributesDescriptionValues
fileDefines the JavaScript files to load for the panels configuration.Text value.
typeDefines the role of the computation methods used in the JavaScript files.
  • group: method used to compute the value of a field for a set of facings.
  • formula: method used to compute the value of a field for a facing.
  • renderer: method used to configure the data rendering in a grid of the reporting.
These attributes are available in the fields tag.
AttributesDescriptionValues
fieldidDefines the identifier of a field. This attribute is mandatory and unique.Text value.
id Defines how the field is computed if retrieved from an identifier. The identifier can be one of the following elements:
  • The identifier of a custom attribute
  • The identifier of a business information attribute
  • Predefined identifiers.
Predefined values
  • PRODUCT_ID : EAN of the product
  • ELT: section element number in which the facing is present.
  • CDT: position of the product in the consumer decision tree of the sub assortent. The sub assortment is related to the currently edited object of the product.
  • ITEM_COUNT: number of items in the facing.
  • UNIT_COUNT:number of units in the facing.
  • H_COUNT: number of horizontal visible items in the facing.
  • V_COUNT: number of vertical visible items.
  • D_COUNT: number of items in the facing in depth.
  • D_MAX_COUNT: number of maximum items in the facing and that can be placed in depth.
  • H_POSITION: horizontal position of the facing from its parent composition frame in the left-right view.
  • V_POSITION: vertical position of the facing from it parent composition frame. In addition, if the target is set to support, this indicator returns the height position of the parent support of a product.
  • D_POSITION: depth position of the facing from it parent composition frame
  • POSITION_COEFFICIENT:the position coefficient of the product. If several facings of the same product are inserted in the gondola, the position coefficient is by default the minimum of the position of all facings.
  • TARGETED_STOCK: the targeted stock of the product. By default, this field is defined by a standard Store Studio formula.
  • stock: the current inserted stock of the product.
  • linearMeters: the current linear meters of the product.
  • V_SURFACE: the vertical visible surface of the product.
  • H_SURFACE: the horizontal visible surface of the product.
select Defines the attribute name related to a product or a representation in the ENOVIA database.Text value.

You can retrieve and use custom attributes for the select attribute.

For example, if you create a custom attribute named Custom Attribute for Merchandising Product, its database name will be XP_MerchandisingProduct_Ext.Custom_Attribute. You can use this attribute as follows: <attribute select="attribute[XP_MerchandisingProduct_Ext.Custom_Attribute]"/>

You can use these extensions to retrieve custom attributes for various objects.

XP_MerchandisingAssetDrawer_Ext

XP_MerchandisingAssetGondolaSection_Ext

XP_MerchandisingAssetHangingBar_Ext

XP_MerchandisingAssetPallet_Ext

XP_MerchandisingAssetPegSupport_Ext

XP_MerchandisingAssetPeg_Ext

XP_MerchandisingAssetShelf_Ext

XP_MerchandisingAssetShortShelf_Ext

XP_MerchandisingAssetWithRepresentation_Ext

XP_MerchandisingAsset_Ext

XP_MerchandisingAssortment_Ext

XP_MerchandisingComposition_Ext

XP_MerchandisingGondola_Ext

XP_MerchandisingProduct_Ext

XP_MerchandisingRepresentation3D_Ext

XP_MerchandisingRetailCategory_Ext

XP_MerchandisingRetailCluster_Ext

XP_MerchandisingRetailStore_Ext

XP_MerchandisingScene_Ext

XP_MerchandisingStore_Ext

XP_MerchandisingStoryboard_Ext

XP_MerchandisingSubAssortment_Ext

targetDefines if the select attribute applies to the product or the representation.
  • product
  • representation
  • support

    This value is available only if the id is set to V_POSITION.

Note: The default value is product.
formulaDefines the method name described in one of the JavaScript files. The method must have the type and formula elements.Text value: name of the formula defined in one of the “formula” javascript files
typeDefines the types of data corresponding to a field. This attribute is optional.
  • float
  • string
Note: The default value is string.
titleDefines the title of a field. This attribute is optional.Text value.
localisedtitleidDefines the indicator's localization. This attribute is optional. This attribute prevails over the title attributeText value : the localization tag is either a standard tag used by store studio, either an additional tag, included in additional NLS files, uploaded on the configuration object : (Example : English additional file : Localization_en.MPNls)
unitDefines the unit of a field. This attribute is optional.
  • %
  • Euros
  • ...
decimalsDefines the default number of decimals to display. This attribute is optional.Numerical value.
Note: The default value is 2.
formulagroupDefines one of the following elements:
  • The method name described in one of the JavaScript files. The method must have the type and group elements.
  • Predefined name of a group formula.
This attribute is optional.

Predefined formula values

  • AVG: computes the average of the values.
  • MAX: computes the maximal value.
  • MIN: computes the minimal value.
  • SUM: adds the values.
  • VALID_COUNT: the number of defined values.
  • MOST: shows the value of the product with most occurrences.

These attributes are available in the interface3d tag.
AttributesDescription
These attributes are available in the import tag.
context

Defines the default server.

The following values are available:

  • server: import source is the server.
  • excelFile: import source is the Excel file.

If the Excel file includes a Data worksheet, data are imported from this worksheet. If not, data are imported from the first worksheet.

The file must include a column with the UPC (or EAN). Other columns correspond to business indicators (header columns correspond to indicators' identifiers).

Each row corresponds to a product defined by the UPC.

Note: If one of these values is removed from the .xml file, only one source is displayed in Store Studio.
checktrue
Note: If the attribute is set to true, one of the import source is pre-selected in Store Studio.
These attributes are available in the attribute tag.
data
Note: This attribute is valid only if the value of the import attribute is server.

The following values are available:

  • dateRange: business information of a specific period.
  • storesGroups: business information corresponding to sales history in a group of stores.
  • subsEAN: substitute EAN/UPC for new products without sales history.

Configure the attributes in the attributes tag. This tag defines the product attributes list that the user can select to group products. This list is displayed in the Indicators panel in Store Studio.
These attributes are available in the groups tag.
groupIdDefines a unique id of the group. A group without a group id is ignored. If two groups have the same groupid, the second group is ignored
localisedTitleIdDefines the NLS tag of the group. To be displayed correctly, the tag should be contained in the configuration NLS.
Note: This attribute must not contain any spaces or '.' characters.
DefaultDefines which group appears when the Store Studio is opened for the first time.
Notes:
  • If no group has the attribute set to true, the first defined group appears.
  • If several groups have the attribute set to true, the first group is considered as the default.
available

Defines if a group is available for Store Studio, 3DPlay, or both. It can have the following values:

  • 3dplay: available only for 3DPlay
  • storestudio: available only for Store Studio
  • all: available for both. By default, the value is set to all.

Under the groups node, you can define the group nodes.
field

It defines which field is included in the group. The first defined field in the group is the first field displayed in the group.

Notes:
  • Ensure that formatting of the xml file is correct, else an error message appears if you try to upload it.
  • Only a correctly defined group is loaded.
  • It is mandatory to define all the fieldid of each field.
  • If a field is defined multiple times, only the first defined field is loaded.
  • The same field can be added in multiple groups.
These attributes are available in the views tag.
AttributesDescriptionValues
viewidDefines the identifier of a report. This attribute is mandatory.Text value.
titleDefines the title of a report. This attribute is optional.Text value.
localisedtitleidDefines the title's localization. This attribute is optional.Text value.
Configure the attributes in the grid tag.
Configure the attributes in the tree tag. The configuration of this tag is optional. This tag defines the field that represents the tree column of the tree grid. Without this section, the facings are grouped by products.
These attributes are available in the field tag.
fieldidDefines the identifier of a field. This attribute is mandatory.Text or numerical value.
visibleDisplays or hides a column. This attribute is optional.
  • true: displays the column by default.
  • false: hides the column by default.
Note: The default value is true.
rendererDefines the method name described in one of the JavaScript files. The method must have the type and renderer elements. This attribute is optional.Text value: name of the renderer function
maxlevel
Note: This attribute is valid only if the fieldid id attribute is CDT.
Defines the maximum depth of the consumer decision tree. Numerical value.
widthDefines the width of the column (pixels). This attribute is optional.Numerical value.
flexDefines the widths among the child elements of a container. Automatically resizes the column width if the width is not defined. This attribute is optional.Numerical value.
Note: The default value is 1.
Configure the attributes in the bar tag. The theme attribute defines the theme of bar chart. This theme refers to a color.
These attributes are available in the field tag. This tag defines the identifier of a field for the charts. The level attribute applies to the field tag. It defines the depth of the consumer decision tree. This attribute is valid only if the fieldid attribute is CDT.
These attributes are available in the pie tag. The theme attribute defines the theme of pie chart. This theme refers to a color.
Attribute and Description
Configure the attributes in the field tag. Defines the identifier of a field for the pie. The fieldid attribute is mandatory.

The first field defined corresponds to the grouping field.

The second field defined correspond to the displayed field.

The user cannot define more than two field in a pie chart.

The level attribute applies to the field tag. It defines the depth of the consumer decision tree. This attribute is valid only if the fieldid attribute is CDT .

These attributes are available in the exports tag. The configuration of this tag is optional. This section lists all exports available in the print panel. Each export is defined by an excel tag.
AttributesDescriptionValues
These attributes are available in the excel tag.
exportidDefines the identifier of an export. This attribute is mandatory.Text value.
titleDefines the title of the export option displayed in Store Studio. This attribute is optional.Text value.
localisedtitleidDefines the title's localization. This attribute is optional.Text value.
templatefileDescribes the path and name of the .xls template. This attribute is optional.Text value.
Configure the attributes in the field tag. This tag defines the identifier of a field for the export. The fieldid attribute is mandatory. Each defined field corresponds to a column in the export file.