Reference - Product Attribute Groups XML Import Specification

1 Introduction

This document describes the XML import specification for product attribute groups.

2 XML Definition

2.1 Root Elements

2.1.1 enfinity Element

This is the root element definition of the enfinity element. It shows what kind of objects are valid inside this element declaration.

enfinity element
	<xsd:element name="enfinity">
		<xsd:complexType mixed="false">
			<xsd:sequence minOccurs="0" maxOccurs="unbounded">
				<xsd:element ref="product-attribute-group" minOccurs="0" maxOccurs="unbounded" />
			</xsd:sequence>
			<xsd:attributeGroup ref="documentVersion" />
		</xsd:complexType>
	</xsd:element>

2.1.2 ProductAttributeGroup Element

The product-attribute-group element has id and domain-name attributes. The id attribute is the unique identifier which distinguishes each attribute group while the domain-name specifies the domain in which the attribute group was created.

The product-attribute-group element may have an optional fixed-flag sub-element and must have a mandatory type-code sub-element. It can also contain one or more optional display-names and description sub-elements for a set of locales. The product-attribute-group element may also have an optional attribute-groups sub-element.

This section applies from 7.10.5

From 7.10.5 the new element "available-via-rest" is available.


ProductAttributeGroup element
	<xsd:element name="product-attribute-group">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="fixed-flag" type="xsd:boolean" minOccurs="0"/> 
				<xsd:element name="type-code" type="xsd:int"/> 
				<xsd:element name="available-via-rest" type="xsd:string" minOccurs="0"/>
				<xsd:sequence minOccurs="0" maxOccurs="unbounded">
					<xsd:element name="display-name" type="complexType.Generic.Attribute.String" minOccurs="0" maxOccurs="unbounded"/>	
				</xsd:sequence>
				<xsd:sequence minOccurs="0" maxOccurs="unbounded">		
					<xsd:element name="description" type="complexType.Generic.Attribute.String" minOccurs="0" maxOccurs="unbounded"/>
				</xsd:sequence>
				<xsd:element ref="attribute-descriptors" minOccurs="0" maxOccurs="1" />
			</xsd:sequence>
			<xsd:attribute name="id" type="xsd:string" use="required"/>
			<xsd:attribute name="domain-name" type="xsd:string" use="required"/>
		</xsd:complexType>
	</xsd:element>

2.2 Elements of Complex Type ProductAttributeGroup

2.2.1 Attribute Descriptors Element

This element may have zero or more attribute-descriptor sub-elements. It defines the set of attributes in the product attribute group.

Attribute Descriptors element
	<xsd:element name="attribute-descriptors">
		<xsd:complexType>
			<xsd:sequence minOccurs="0" maxOccurs="unbounded">
				<xsd:element ref="attribute-descriptor" minOccurs="0" maxOccurs="unbounded" />
			</xsd:sequence>
		</xsd:complexType>
	</xsd:element>

2.2.2 Attribute Descriptor Element

The attribute descriptor element has a mandatory id attribute which is unique in the context of all attribute descriptor elements within a product attribute group. It may also contain optional positions and one or more display-name sub-elements.

Attribute Descriptor element
	<xsd:element name="attribute-descriptor">
		<xsd:complexType>
			<xsd:sequence>
				<xsd:element name="position" type="xsd:float" minOccurs="0"/>
				<xsd:sequence minOccurs="0" maxOccurs="unbounded">
					<xsd:element name="display-name" type="complexType.Generic.Attribute.String" minOccurs="0" maxOccurs="unbounded"/>
				</xsd:sequence>
			</xsd:sequence>
			<xsd:attribute name="id" type="xsd:string" use="required"/>
		</xsd:complexType>
	</xsd:element>

3 Sample XML

Product Attribute Group XML
	<enfinity
	xsi:schemaLocation="http://www.intershop.com/xml/ns/enfinity/7.10/bc_product/impex productattributegroup.xsd"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns="http://www.intershop.com/xml/ns/enfinity/7.10/bc_product/impex"
	major="6" minor="1" family="enfinity" branch="enterprise" build="build">
	<product-attribute-group id="BACKOFFICE_SEARCH_ATTRIBUTES" domain-name="inSPIRED-inTRONICS">
		<fixed-flag>true</fixed-flag>
		<type-code>0</type-code>
		<attribute-descriptors>
		</attribute-descriptors>
	</product-attribute-group>
	<product-attribute-group id="QUOTE_ITEM_ATTRIBUTES" domain-name="inSPIRED-inTRONICS">
		<fixed-flag>false</fixed-flag>
		<type-code>0</type-code>
		<display-name xml:lang="en-US">Quote Item Attributes</display-name>
		<attribute-descriptors>
		</attribute-descriptors>
	</product-attribute-group>
	<product-attribute-group id="ORDER_REQUIRED_ATTRIBUTES" domain-name="inSPIRED-inTRONICS">
		<fixed-flag>true</fixed-flag>
		<type-code>0</type-code>
		<attribute-descriptors>
		</attribute-descriptors>
	</product-attribute-group>
	<product-attribute-group id="PRODUCT_INDEX_ATTRIBUTES" domain-name="inSPIRED-inTRONICS">
		<fixed-flag>true</fixed-flag>
		<type-code>0</type-code>
		<display-name xml:lang="de-DE">Produkt-Indexattribute</display-name>
		<display-name xml:lang="fr-FR">Attributs d&apos;index de produit</display-name>
		<display-name xml:lang="en-US">Product Index Attributes</display-name>
		<description xml:lang="fr-FR">Tous les attributs de produits ajoutes au groupe sont disponibles dans les characteres des pages l&apos;&apos;index.</description>
		<description xml:lang="en-US">All product attributes added to this group are available in Index Pages Feature.</description>
		<description xml:lang="de-DE">Produktattribute dieser Gruppe stehen der Funktion zum Indexieren von Seiten zur Verfugung.</description>
		<attribute-descriptors>
			<attribute-descriptor id="ManufacturerName">
				<position>0.0</position>
				<display-name xml:lang="en-US">Manufacturer</display-name>
				<display-name xml:lang="fr-FR">Fabricant</display-name>
				<display-name xml:lang="de-DE">Hersteller</display-name>
			</attribute-descriptor>
		</attribute-descriptors>
	</product-attribute-group>
	<product-attribute-group id="PRODUCT_DETAIL_ATTRIBUTES" domain-name="inSPIRED-inTRONICS">
		<fixed-flag>false</fixed-flag>
		<type-code>0</type-code>
		<display-name xml:lang="en-US">Product Detail Attributes</display-name>
		<display-name xml:lang="de-DE">Produktdetails</display-name>
		<description xml:lang="en-US">Detailed list of product attributes for syndication/synchronization and storefront visualization.</description>
		<description xml:lang="de-DE">Detaillierte Liste von Produktattributen fur die Syndizierung/Synchronisierung und die Anzeige in der Storefront.</description>
		<attribute-descriptors>
			<attribute-descriptor id="Schlossart">
				<position>0.0</position>
				<display-name xml:lang="de-DE">Schlossart</display-name>
				<display-name xml:lang="en-US">Lock Type</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="Material">
				<position>0.0</position>
				<display-name xml:lang="de-DE">Material</display-name>
				<display-name xml:lang="en-US">Material</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="Groesse">
				<position>0.0</position>
				<display-name xml:lang="de-DE">Gro?enindex</display-name>
				<display-name xml:lang="en-US">Size</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="Innenausstattung">
				<position>0.0</position>
				<display-name xml:lang="en-US">Inside Features</display-name>
				<display-name xml:lang="de-DE">Innenausstattung</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="SonstigeAttribute">
				<position>0.0</position>
				<display-name xml:lang="en-US">Sonstige Eigenschaften</display-name>
				<display-name xml:lang="de-DE">Sonstige Eigenschaften</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="Art">
				<position>0.0</position>
				<display-name xml:lang="en-US">Type</display-name>
				<display-name xml:lang="de-DE">Art</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="Tragekomfort">
				<position>0.0</position>
				<display-name xml:lang="en-US">Carrying Features</display-name>
				<display-name xml:lang="de-DE">Tragekomfort</display-name>
			</attribute-descriptor>
			<attribute-descriptor id="Aussenausstattung">
				<position>0.0</position>
				<display-name xml:lang="en-US">Outside Features</display-name>
				<display-name xml:lang="de-DE">Aussenausstattung</display-name>
			</attribute-descriptor>
		</attribute-descriptors>
	</product-attribute-group>
</enfinity>

4 New ImpEx XML

ProductAttribute Group
Attribute

Comment
<xsd:element name="available-via-rest" type="xsd:string"/>If an attribute group is "available via REST API", then the group and all contained attributes will be included in the regular "get product data" call. Available values are "true" and "false". If there is no value "false" is used by default.

Disclaimer

The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources
Support Tickets