OXIDwiki

Features/RDFa

From OXIDwiki

Revision as of 14:54, 24 February 2012 by Vilma liorensaityte (Talk | contribs)
Jump to: navigation, search

RDFa (Resource Description Framework in attributes) is a way to provide structured information about web shop to search engines.

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 eShop information.

More information about RDFa format and Good Relations you can find in http://www.heppnetz.de/projects/#goodrelations and http://wiki.goodrelations-vocabulary.org/Quickstart .

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

Contents

RDFa activation

To enable RDFa you have to switch on “Enable automatic data embedding” option (Master Setting->Core Settings->RDFa -> Global configuration).

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 main eShop data will be used, like address, company name or shop URL. Additional like location data can be attached in admin interface under Master Setting->Core Settings->RDFa.

Configuration

1. First you have to select in which content page main eShop information is displayed, e.g. “About Us”. Select option Global configuration->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. (in RDFa has relation vcard:logo foaf:logo)
  • Geo-position (should be entered only numbers) - The geo position of the store as longitude and latitude. (in RDFa has relation vcard:geo)
  • GLN - Global Location Number (GLN) for the company. (in RDFa has property gr:hasGlobalLocationNumber)
  • NAICS - North American Industry Classification System (NAICS) code for your company (see http://www.census.gov/eos/www/naics/ ). (in RDFa has property gr:hasNAICS)
  • ISIC - ISIC code for your business (see http://unstats.un.org/unsd/cr/registry/isic-4.asp). (in RDFa has property gr:hasISICv4)
  • D-U-N-S - The Dun & Bradstreet DUNS is a nine-digit number used to identify legal entities (but usually not branches or locations of logistical importance only). (in RDFa has property gr:hasDUNS)

Example

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

 <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/">
<div typeof="gr:BusinessEntity" about="http://features/en/About-Us/#companydata">
<div property="gr:legalName vcard:fn" content="Your Company Name" datatype="xsd:string"></div>
<div rel="vcard:adr">
<div typeof="vcard:Address">
<div property="vcard:country-name" content="United States"></div>
<div property="vcard:locality" content="Any City, CA"></div>
<div property="vcard:postal-code" content="9041"></div>
<div property="vcard:street-address" content="2425 Maple Street"></div></div> 
</div>
<div property="vcard:tel" content="217-8918712"></div>
<div property="vcard:fax" content="217-8918713"></div></div>
</div>

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->Core Settings->RDFa->Global configuration-> 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->Core Settings->RDFa->Global configuration ->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->Core Settings->RDFa-> Global configuration ->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->Shipping Methods->RDFa.

Payment methods

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

Configuration

1. First you have to select in which content page not assigned to RDFa payment information is displayed, e.g.“Terms and Conditions”. Select option Master Setting->Core Settings->RDFa->Global configuration->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->Payment Methods->RDFa.

Product details

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

Configuration

For extended product info configuration go to Master Setting->Core Settings->RDFa->Global configuration-> In which content page the RDF data of not assigned payment method shall be embedded?

1. Assign if product prices includes VAT or not. Select option Master Setting->Core Settings->RDFa->Global configuration -> 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 option Master Setting->Core Settings->RDFa->Global configuration ->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)

3. Special product Information:

  • Show real available product stock - If option is on, embeds the real product stock. If option off, skips the stock at all.
  • How many 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.
  • In which condition are the offered product items? - It is a description of the condition of the product (new, used and refurbished). (in RDFa has property gr:condition)
  • 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. (in RDFa has property gr:hasBusinessFunction)
  • Which customer group is addressed by your offers? - The types of customers for which

shop products are valid (End user, Reseller, Business and Public). (in RDFa has property gr:eligibleCustomerTypes)

  • Which duration have your offerings? - This property specifies the time of the validity of the products (e.g. 1 day, 1 week). (in RDFa has properties gr:validFrom and gr:validThrough)

4. For payment methods configuration go to Shop Settings->Payment Methods->RDFa.

5. For shipping methods configuration go to Shop Settings->Shipping Methods->RDFa.

Personal tools