Include
At the beginning stands the row Include. From this results the integration of
the files for the different article groups with the centrally defined default
product characteristics. The standard included files are:
v_2_0/<type>/<language>/Templates.xml
Here, <type> is one of:
* frames
* lenses
* contactlenses
* global
Here, <language> is one of:
* EN
* DE
* NL
* FR
* IT
* DA
With further Include tags it is possible to include files for further
product groups in which product properties are described that aren’t defined in
the standard.
The definition of further properties and relations takes place subsequently and
is divided into the following areas:
Feature templates
Here you are able to define own product properties that aren’t included in the
standard.
This can be done also in a separate file PrivateTemplates that is also
included with the tag Include.
Standard-Features
You will find the list of the FeatureTemplates in the Template
documentation.
FeatureEnumTemplateEx
For some features the value ranges can’t be defined in the standard because they are catalog or
supplier specific. The most important cases would be e.g. material or colour specifications which are
vendor-specific and therefore must be defined on catalog level. In the FeatureEnumTemplateEx area,
corresponding assignments (e.g. color code and colour label of the supplier) can be defined.
Example code:
<FeatureTemplateEx templateID="Line">
<LabeledValue value="FUSION" label="FUSION"/>
<LabeledValue value="KICK" label="KICKER"/>
<LabeledValue value="KIDSP" label="KIDSPORT"/>
<LabeledValue value="OPTICS" label="OPTICS"/>
<LabeledValue value="PERF" label="PERFORMANCE"/>
<LabeledValue value="SNAKES" label="SNAKES"/>
</FeatureTemplateEx>
Resources for FeatureEnumValues
Version 1.5 created the ability to attach resources to single LabeledValues.
The allocation can be done globally in the general definition range under
FeatureTemplateEx and FeatureTemplate or for individual articles
(schema extension in template.xsd).
This means that for a specification of a product property (e.g. color = red) one
or more product views of the red article variant can be linked. Thus, you can
visualize individual product versions respectively properties.
Example code 1:
<FeatureTemplateEx templateID="Color">
<LabeledValue value="A41" label="bright green (clear pupil)">
<Resources>
<Resource templateID="imgMedium"
uri="http://mediathek.microstep-it.de/zdyh7rna.view"/>
<Resource templateID="imgSmall"
uri="http://mediathek.microstep-it.de/kfdxe4ra.view"/>
</Resources>
</LabeledValue>
<LabeledValue value="A41X" label="dark green (clear pupil)"/>
</FeatureTemplateEx>
Example code 2:
<FeatureTemplates>
<FeatureValueTemplate step="0" formatString="N0" unit="mm"
alwaysSigned="false" id="FrameTempleLength" label="Temple length"
labelShort="" descr="" includeInOrder="false"/>
<FeatureValueTemplate step="0" formatString="N0" unit="mm"
alwaysSigned="false" id="FrameShapeLength" label="Shape length"
labelShort="" descr="" includeInOrder="false"/>
<FeatureValueTemplate step="0" formatString="N0" unit="mm"
alwaysSigned="false" id="FrameShapeHeight" label="Frame shape height"
labelShort="" descr="" includeInOrder="false"/>
<FeatureValueTemplate step="0" formatString="N0" unit="mm"
alwaysSigned="false" id="FrameShapeMaxRadius" label="Shape max radius"
labelShort="" descr="" includeInOrder="false"/>
<FeatureValueTemplate step="0" formatString="N0" unit=""
alwaysSigned="false" id="LensBaseCurve" label="Base curve" labelShort=""
descr="" includeInOrder="false"/>
<FeatureValueTemplate step="0" formatString="N0" unit="mm"
alwaysSigned="false" id="FrameDbl" label="Bridge width" labelShort=""
descr="" includeInOrder="hidden"/>
<FeatureEnumTemplate id="Lining" label="Lining" labelShort="Lining"
descr="Lining" includeInOrder="false">
<LabeledValue value="Chopper gray" label="Chopper gray">
<Resources>
<Resource templateID="imgMedium"
uri="http://mediathek.microstep-it.de/h3yz4rca.view"/>
<Resource templateID="imgSmall"
uri="http://mediathek.microstep-it.de/dhwxmffa.view"/>
</Resources>
</LabeledValue>
</FeatureEnumTemplate>
</FeatureTemplates>
DefaultValues
The defaultValue generally applies to the entire article or to specific delivery ranges. A
combination is not possible. DefaultValues can only be available for order-relevant features,
not for optional or other feature types.
Example code:
<Features>
<FeatureValue templateID="EdgeFlattening" deliveryTypeID="STD" defaultValue="0.3"
rangeMin="0.3" rangeMax="0.5" rangeStep="0.2" includeZero="false" />
</Features>
Relationship templates
Here possible kinds of product relationships (including spare parts,
accessories, option item, alternative product …) are defined. They can be used
later in the article area to define relations between articles (e.g. article E
and F are spare parts of article A).
Standard:
| id |
label |
|---|
accessory |
Accessory |
alternativeProduct |
Alternative product |
consistsOf |
Consists of |
fittingTemples |
Fitting temples |
optionalArticle |
Optional article |
productVariant |
Product variant |
sparePart |
Spare part |
Resource templates
Here different kinds of resource files can be defined:
| id |
mimetype |
Max. size |
label |
|---|
animation360 |
html/php |
|
360 degree animation |
deliveryInfo |
html |
|
Delivery range info |
formData36Points |
txt |
|
Form data 36 points |
formData360Points |
txt |
|
Form data 360 points |
formDataTracerEssilor |
mo1 |
|
Form data of tracer Essilor |
formDataTracerNIDEK |
nid |
|
Form data of tracer NIDEK |
formDataTracerOMA |
oma |
|
Form data of tracer OMA |
formDataTracerWECO |
wec |
|
Form data of tracer WECO |
formDataXML |
xml |
|
Form data XML |
handlingInfo |
html |
|
Handling info |
imgFrameColourPreview |
image/jpg |
|
Preview Frame colour |
imgFrameFront |
image/jpg |
|
Image frame front |
imgFrameHalfSideLeft |
image/jpg |
|
Image frame half side left |
imgFrameHalfSideRight |
image/jpg |
|
Image frame half side right |
imgFrameLeft |
image/jpg |
|
Image frame left |
imgFrameRight |
image/jpg |
|
Image frame right |
imgLarge |
image/jpg |
1024X1024px |
Large image (e.g. pop-up window) |
imgMedium |
image/jpg |
200/200px |
Medium-sized image (e.g. for article description) |
imgSmall |
image/jpg |
80/80px |
Small image (e.g. for product lists) |
imgSmallUnselected |
image/jpg |
80/80px |
Small inactive image (e.g. fotos with white layer) |
productInfo |
html |
|
General product description |
shapeID |
txt |
|
Form data ID |
technInfo |
html |
|
Technical info |
We suggest defining the path information in the header for each resource type as
entities. So the path information can be centrally defined once and adjusted at
any time with a record.
Example code:
<?xml version="1.0" encoding="UTF-16"?>
<!DOCTYPE ResourcePath [
<!ENTITY imgLPath "http://www.firmaXY/pics/">
<!ENTITY imgMPath "http://www.firmaXY/pics/">
<!ENTITY imgSPath "http://www.firmaXY/pics/">]>
The mapping at Article looks like that:
Example code:
<Resources>
<Resource templateID="imgLarge" uri="&imgLPath Produkt_ImgL.jpg"/>
<Resource templateID="imgSmall" uri="&imgLPath Produkt_ImgS.jpg"/>
</Resources>
DeliveryType templates
Here the global definition of different delivery areas takes place.
| id |
label |
priority |
|---|
Stock |
Ex stock |
10 |
Standard |
Fabrication standard |
20 |
Production |
Fabrication individually |
30 |
The following rules apply to the evaluation:
- A higher priority beats a lower
- If selecting a feature with higher priority (lower value) the complete
product will receive this delivery type
Example code:
<DeliveryTypeTemplates>
<DeliveryType id="STANDARD" priority="1" label="STANDARD"/>
</DeliveryTypeTemplates>
ClientGroup templates
Definition of individual customer groups that are assigned to each product
under Article.
This allows controlling permissions and views of individual products for a
product group or automatic creation of individual catalogs for different product
groups from a centrally maintained master catalog.
Example code:
<ClientGroups>
<ClientGroup templateID="Client group 1"/>
<ClientGroup templateID="Client group 2"/>
</ClientGroups>
Articles
Here the detailed description of each item takes place.
An article can have the following attributes:
| Attribute |
Type / Use |
Description / Example |
|---|
formerArticleID |
xs:NMTOKEN optional |
Article code that has been used before for this article (e.g. in other ERP systems) (e.g. A2777) |
configLines |
xs:positiveInteger optional |
Number of configuration rows (contact lenses=2, glasses=2 > in pairs, commodity=1) (e.g. 2) |
descr |
xs:string optional |
Article description (e.g. `` Biocompatible, highly compliant spherical monthly exchange system for daily, extended wear``) |
id |
xs:NMTOKEN required |
Unique supplier article ID (e.g. A2780) |
maxQuantity |
xs:positiveInteger optional |
Maximal order quantity of article (e.g. 10) |
minQuantity |
xs:positiveInteger optional |
Minimal order quantity of article (e.g. 1) |
name |
xs:string required |
Article name (e.g. Contact Life Spheric Box) |
price |
xs:decimal optional |
Article price, purchase price (e.g. 18.50) |
quantityStep |
xs:positiveInteger optional |
Step size for order quantity (e.g. 1) |
validEndDate |
xs:dateTime optional |
Valid to date (e.g. 2012-01-01T00:00:00) |
validStartDate |
xs:dateTime optional |
Valid from date (e.g. 2011-01-01T00:00:00) |
electronicOrderingAllowed |
xs:boolean optional |
Default value = true |
Example code:
<Article id="SLOD30" name="SofLens one day 30er Box"
descr="One day contact lens" price="19.90" maxQuantity="1" configLines="2">
The article definition is divided into the following areas:
ClientGroups: assignment to client groups > e.g. for indication of
Private LabelsMetaData: definition of search terms and additional links to products,
e.g. for evaluation in applicationsRelationships: definition of product relations > e.g.
spare parts/accessoriesResources: assignment of resource files to the product, e.g. pictures,
HTML or PDF documents, shape data etc.Features: definition of unique product propertiesDeliveryRanges: definition of the delivery ranges per product, at
frames possible model variants
ClientGroups
Mapping of individual customer groups to the article. Hereby can be defined for
which customer groups the article is available.
So the indication of individual products for individual customers can be
controlled (e.g. in the supplier’s own shop or an industry software) or used as
the basis for creating special catalogs for customer groups (such as
individual catalogs for purchasing groups).
Example code:
<ClientGroups>
<ClientGroup templateID="Client group 1 "/>
</ClientGroups>
Relationships
Here relationships between articles can be defined. Besides the standard
relations also individual relation types can be defined (for individual
applications).
Example code:
<Relationships>
<Relationship templateID="accessory" articleID="Special case"/>
</Relationships>
Resources
Here the definition takes place of the information that is available for the
product in external files (resources). In addition to the standard resource
types also own resource types (for ind. applications) can be defined.
Example code:
<Resources>
<Resource templateID="productInfo"
uri="http://www.rodenstock.de.de/de/1234-50_PI.html"/>
<Resource templateID="imgMedium"
uri="http://look4mediathek.de/e2dr2zza.view"/>
<Resource templateID="imgSmall"
uri="http://look4mediathek.de/z23znc3a.view"/>
<Resource templateID="imgSmallUnselected"
uri="http://look4mediathek.de/xnwyzfpa.view"/>
</Resources>
Features
The product properties of individual products are assigned with Features.
Standard properties (centrally defined in Templates.xml) but also vendor-specific
properties can be assigned (e.g. for use in vendor-specific applications).
Again counts the distinction in FeatureValue- (assignment of a numerical value) and
FeatureEnum- items (select list of multiple values - colours, brands, characteristics …).
Example code:
<Features>
<FeatureEnum templateID="ArticleType" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="sunglasses"/>
</FeatureEnum>
<FeatureEnum templateID="Brand" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="Bollé"/>
</FeatureEnum>
<FeatureEnum templateID="Line" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="Fusion"/>
</FeatureEnum>
<FeatureEnum templateID="UserGroup" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="unisex"/>
</FeatureEnum>
<FeatureEnum templateID="FrameRimType" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="fullRim"/>
</FeatureEnum>
<FeatureEnum templateID="FrameMaterialType" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="metal"/>
</FeatureEnum>
<FeatureEnum templateID="FrameRx" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="true"/>
</FeatureEnum>
<FeatureEnum templateID="FrameBridgeType" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="padsSilicon"/>
</FeatureEnum>
<FeatureEnum templateID="FrameSpringHinge" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="true"/>
</FeatureEnum>
<FeatureEnum templateID="NickelFree" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="false"/>
</FeatureEnum>
<FeatureEnum templateID="CountryOfOrigin" deliveryTypeID="STANDARD"
includeInOrder="false">
<FeatureEnumItem value="FR"/>
</FeatureEnum>
</Features>
