Features/RDFa

RDFa (Resource Description Framework in attributes) is a way to provide structured information about online store websites.

Good Relations is a web vocabulary for e-commerce to publish all the details of shop products and services to search engines, mobile applications or browser extensions.

We implemented RDFa format using Good Relations vocabulary to provide extended information on OXID eShops.

You can find more information about RDFa format and Good Relations on this pages:


 * http://www.heppnetz.de/projects/#goodrelations
 * http://wiki.goodrelations-vocabulary.org/Quickstart.

Here is short description, how to setup RDFa in OXID eShop.

= RDFa activation =

To enable RDFa you have to switch on “Enable automatic data embedding” option (Master Setting-&gt;Core Settings-&gt;RDFa -&gt; Global configuration). By default, this option is disabled.

= RDFa format usage =

Extended eShop information in RDFa format using Good Relations will be displayed in 4 places:


 * 1) company data info page
 * 2) product details page
 * 3) shipping methods info page
 * 4) payment methods info page

Company data
A business entity has at least a primary mailing address and contact details. For this, by default the main data from your OXID eShop will be used like the address, the company name and the shop URL. Additionally data like e.g. location can be added in admin panel under Master Setting-&gt;Core Settings-&gt;RDFa.

Configuration
1. First you have to select the content page where main shop information shall be displayed, e.g. “About Us”. Select option Global configuration-&gt;In which content page the RDF data of the provider shall be embedded?

2. Add extended shop data in Shop information:


 * URL of the logo: The Web address (URL) of a logo or image. The corresponding RDFa relation is vcard:logo foaf:logo.
 * Geo-position only numbers shall be entered): The geo position of the store as longitude and latitude. The corresponding RDFa relation is vcard:geo.
 * GLN - Global Location Number (GLN) for the company. The corresponding RDFa relation is gr:hasGlobalLocationNumber.
 * NAICS - North American Industry Classification System (NAICS) code for your company (see http://www.census.gov/eos/www/naics/). The corresponding RDFa relation is gr:hasNAICS.
 * ISIC - ISIC code for your business (see http://unstats.un.org/unsd/cr/registry/isic-4.asp). The corresponding RDFa relation is gr:hasISICv4.
 * D-U-N-S - The Dun &amp; Bradstreet DUNS is a nine-digit number used to identify legal entities (but usually not branches or locations of logistical importance only). The corresponding RDFa relation is gr:hasDUNS.

Example
How looks Demo Shop information in RDFa format in “About US” content page:

&lt;div xmlns="http://www.w3.org/1999/xhtml" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#" xmlns:xsd="http://www.w3.org/2001/XMLSchema#" xmlns:gr="http://purl.org/goodrelations/v1#" xmlns:foaf="http://xmlns.com/foaf/0.1/" xmlns:vcard="http://www.w3.org/2006/vcard/ns#" xmlns:rdfs="http://www.w3.org/2000/01/rdf-schema#" xml:base="http://features/en/About-Us/"&gt; &lt;div typeof="gr:BusinessEntity" about="http://features/en/About-Us/#companydata"&gt; &lt;div property="gr:legalName vcard:fn" content="Your Company Name" datatype="xsd:string"&gt;&lt;/div&gt; &lt;div rel="vcard:adr"&gt; &lt;div typeof="vcard:Address"&gt; &lt;div property="vcard:country-name" content="United States"&gt;&lt;/div&gt; &lt;div property="vcard:locality" content="Any City, CA"&gt;&lt;/div&gt; &lt;div property="vcard:postal-code" content="9041"&gt;&lt;/div&gt; &lt;div property="vcard:street-address" content="2425 Maple Street"&gt;&lt;/div&gt;&lt;/div&gt; &lt;/div&gt; &lt;div property="vcard:tel" content="217-8918712"&gt;&lt;/div&gt; &lt;div property="vcard:fax" content="217-8918713"&gt;&lt;/div&gt;&lt;/div&gt; &lt;/div&gt;

Shipping methods
A shipping method specifies in eShop available shipping costs. This specification includes shipping cost rule’s id, name, description, assigned country, assigned eShop shipping methods, price parameters, currency and whether this charge includes VAT or not.

Configuration

 * 1) First you have to select in which content page not assigned to RDFa shipping information is displayed, e.g.“Shipping and charges”. Select option Master Setting-&gt;Core Settings-&gt;RDFa-&gt;Global configuration-&gt; In which content page the RDF data of not assigned shipping method shall be embedded?
 * 2) Assign if delivery costs includes VAT or not. Select option Master Setting-&gt;Core Settings-&gt;RDFa-&gt;Global configuration -&gt;Are the prices and costs shown to the purchaser incl. or excl. VAT?
 * 3) Specify the time of the validity of the shipping costs (e.g. 1 day, 1 week). Select option Master Setting-&gt;Core Settings-&gt;RDFa-&gt; Global configuration -&gt;Select the time of the validity of your prices and costs (Product, Delivery methods, and Payment methods)? (in RDFa has properties gr:validFrom and gr:validThrough)
 * 4) Assign defined RDFa shipping methods to existing shop shipping methods: Shop Settings-&gt;Shipping Methods-&gt;RDFa.

Payment methods
Payment method is used for specifying the types of payment accepted by the shop owner. This specification includes payment method name and description. It includes assigned shipping cost rules.

Configuration

 * 1) First you have to select the content page where not assigned payment information for RDFa shall be displayed, e.g.“Terms and Conditions”. Select the option Master Setting-&gt;Core Settings-&gt;RDFa-&gt;Global configuration-&gt;In which content page the RDF data of not assigned payment method shall be embedded?
 * 2) Assign defined RDFa payment methods to existing shop payments: Shop Settings-&gt;Payment Methods-&gt;RDFa.

Product details
An offering (product details page in our case) specifies the type or condition of a product, which business function is offered (sales, rental etc.) and a set of entered product details. It includes available shipping methods, payment methods and shipping rules that fit to the current product.

Configuration
For extended product infoformation configuration go to Master Setting-&gt;Core Settings-&gt;RDFa-&gt;Global configuration


 * 1) Assign if the product prices include VAT or not. Select the option Master Setting-&gt;Core Settings-&gt;RDFa-&gt;Global configuration -&gt; Are the prices and costs shown to the purchaser incl. or excl. VAT?
 * 2) Specify the time of the validity of the product price (e.g. 1 day, 1 week). Select the option Master Setting-&gt;Core Settings-&gt;RDFa-&gt;Global configuration -&gt;Select the time of the validity of your prices and costs (Product, Delivery methods, and Payment methods)? The RDFa properties for it are gr:validFrom and gr:validThrough
 * 3) Special product Information:
 * 4) *Show the really available product stock - If this option is activated it embeds the real product stock. If this option off, it skips the stock at all.
 * 5) *How many review stars can purchasers assign to a product minimum/maximum? - The min/max values refer to the scale used for ratings in your shop system, NOT for the lowest/highest actual rating. By default OXID eShop is using a scale from 0 to 5.
 * 6) *In which condition are the offered product items, new, used or refurbished? The RDFa property is gr:condition.
 * 7) *Which function have your orders? - This specifies the business function of the product, i.e. whether the company is offering to sell, to lease, or to repair the particular type of product. The RDFa property for it is gr:hasBusinessFunction.
 * 8) *Which customer group is addressed by your offers? - The types of customers for which shop products are valid (End users, Resellers, Business or Public). Prooperty in RDF: gr:eligibleCustomerTypes
 * 9) *Which duration have your offerings? - This property specifies the time of the validity of the products (e.g. 1 day, 1 week). Property in RDFa: gr:validFrom and gr:validThrough.