Skip to content

eccparameters

Version: v1 (minor version 1) Scope: per-tenant+store — singleton (exactly one record per store) Owning service: ecc-image-render-service

eccparameters is the singleton configuration DTO for ECC rendering within a store. There is exactly one record per store, and it carries two distinct classes of configuration that the renderer needs at render time:

  1. Global rendering parameters (parameters) — a key-value map of named values that model definitions can reference using #KEY# substitution syntax inside conversion scripts, rule conditions, and field expressions. These typically encode store-wide business settings such as regional pricing rules, product classification conventions, or display flags.

  2. IPF entries (ipf_entries) — the list of Item Pricing File (presentation format) configurations active in this store. IPF controls which label layout presentation is selected for an item. Exactly one entry has is_default = true; this default IPF is applied by the renderer when an item carries no explicit presentation value.

Both collections are written and maintained by ecc-image-render-service based on ECC system configuration. The parameters map keys are kept in lexicographic order for deterministic serialisation.

ID pattern

t/{tenantid}/s/{storeid}/eccparameters

  • t/{tenantid} — tenant namespace
  • s/{storeid} — store within the tenant
  • eccparameters — fixed terminal segment; there is no variable suffix — this is a singleton per store

Example: t/10001/s/S001/eccparameters

Schema

Top-level fields

Field Type Description
id string Primary ID. Follows the singleton pattern t/{tenantid}/s/{storeid}/eccparameters
parameters repeated ParameterEntry Ordered list (lexicographic by key) of global key-value parameters available during model rendering via #KEY# substitution. See ParameterEntry below
ipf_entries repeated IpfEntry List of IPF (presentation format) configurations for this store. Exactly one entry has is_default = true. See IpfEntry below

ParameterEntry

Single key-value pair in the global rendering parameter map.

Field Type Description
key string Parameter name. Referenced in model definitions as #KEY#. Must be unique within the parameters list; the list is stored sorted lexicographically by key
value string Parameter value as a string. The model's conversion scripts and rule conditions receive this value verbatim

Known parameter keys (illustrative — not exhaustive):

Key Example value Purpose
CentralProductType Pieces Classifies the product type used in central pricing rules
IsDiscontinued false Flag indicating whether discontinued items should render differently
IsProvidedBy Local Identifies the pricing source; may affect which price fields are shown
Price 12.99 Store-level or fallback price value for rendering
ProductType FixedWeight Product type used in field expressions and conversion scripts
Region NorthEurope Regional identifier; may select region-specific layout variants
ShowConsumerPrice true Controls visibility of a consumer price field on the label
UnitCode M2 Unit of measure code used when displaying unit prices

IpfEntry

One IPF (Item Pricing File / presentation format) configuration.

Field Type Description
name string IPF identifier string. Max 20 characters (constrained by the ITEMIPF field size in ECC). Examples: NORMAL, DISCOUNT
is_default bool When true, this is the IPF that the renderer selects when an item has no explicit presentation value. Exactly one entry across all ipf_entries will have is_default = true

How IPF selection works at render time:

  1. The renderer checks whether the item being rendered carries an explicit presentation (IPF) value.
  2. If it does, the renderer looks up the matching IpfEntry by name.
  3. If it does not, the renderer uses the IpfEntry where is_default = true.
  4. The selected IPF name is passed into the model's layout selection logic to choose the correct view/presentation for that item.

Consumed by

Service Why
ecc-image-render-service Reads eccparameters at render time to resolve #KEY# substitutions in model expressions and to determine the correct IPF for items without an explicit presentation value
  • eccmodel — the per-store ECC device model definition; read alongside eccparameters during rendering
  • ecceslimage — the rendered output produced using eccparameters and an eccmodel