wiki.gpii.net · web viewthe vocabulary of eastin taxonomy is not intended to be static but...

60
Cloud platforms Lead to Open and Universal access for people with Disabilities and for All ID203.2. Harmonization guidelines Project Acronym Cloud4all Grant Agreement Number FP7-289016 Deliverable No. ID203.2 Work package No. WP203 Work package Title Federating Repositories of Solutions and Components Authors Valerio Gower (FDCGO) Status Draft Dissemination Level Consortium Delivery Date 30/04/2012 Number of Pages 60

Upload: others

Post on 14-Apr-2021

0 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All

ID203.2. Harmonization guidelines

Project Acronym Cloud4allGrant Agreement Number FP7-289016

Deliverable No. ID203.2Work package No. WP203

Work package Title Federating Repositories of Solutions and Components

Authors Valerio Gower (FDCGO)Status Draft

Dissemination Level ConsortiumDelivery Date 30/04/2012

Number of Pages 45

Page 2: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for AllEuropean Commission, FP7 Project 289016http://www.cloud4all.info

Keyword ListAssistive Technology databases. Federation. AT Information providers. EASTIN network.

Version HistoryTable 1. Version history

Revision Date Author Organization Description

1 26/02/2013 Valerio Gower FDCGO First draft

2 06/03/2013 Valerio Gower FDCGO Advanced draft

3 22/03/2013 Valerio Gower FDCGO More detail added

Statement of originalityThis deliverable contains original unpublished work except where clearly indicated otherwise. Acknowledgement of previously published material and of the work of others has been made through appropriate citation, quotation or both.

2

Page 3: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Table of contentsCloud platforms Lead to Open and Universal access for people with Disabilities and for All. . .1

ID203.2. Harmonization guidelines...........................................................................................1

1 Executive Summary............................................................................................................7

2 Introduction.......................................................................................................................8

3 The EASTIN harmonized data structure.............................................................................8

3.1 EASTIN Product dataset..............................................................................................9

3.2 The vocabulary for product features.........................................................................10

3.2.1 Connection of the taxonomy items with ISO 9999 divisions................................12

3.2.2 EASTIN Subdivisions.............................................................................................13

3.2.3 Vocabulary management procedure....................................................................13

4 Datasets of other databases of Assistive Technology......................................................14

4.1.1 AbleData...............................................................................................................14

5 Web Service communication in the EASTIN system.........................................................14

6 Dataset for the AT product of the Unified Listing............................................................15

6.1 Proposed dataset for the AT product in the GPII Unified Listing...............................16

7 Communication between EASTIN and the Unified Listing...............................................18

7.1 Retrieving information from EASTIN - Output Web service......................................19

7.2 Making the information included in the GPII Unified Listing available to the EASTIN website – Input Web Service...............................................................................................21

8 Conclusions......................................................................................................................22

9 References.......................................................................................................................22

10 Annex 1 – The EASTIN taxonomy.....................................................................................23

11 Annex 2 – Specifications for the EASTIN Input Web services...........................................28

12 Annex 3 – Specifications for the Output Web Services....................................................41

3

Page 4: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

List of TablesTable 1. Version history............................................................................................................ 2

Table 2. List of abbreviations....................................................................................................6

Table 3...................................................................................................................................... 9

Table 4 list of Titles included in the taxonomy........................................................................10

Table 5 example of relations between taxonomy items and ISO divisions.............................12

Table 6.................................................................................................................................... 13

4

Page 5: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

List of FiguresFigure 1 connection between EASTIN website and the databases of the information providers.................................................................................................................................11

Figure 2 Information flowing from the EASTIN database to the GPII Unified listing...............13

Figure 3 Example of a product record in the EASTIN website showing the citation of the source of information............................................................................................................. 15

Figure 4 connection of the Unified Listing database to the EASTIN network..........................16

Figure 5 Scheme of the overall connection between EASTIN and GPII Unified Listing............16

5

Page 6: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

List of abbreviationsTable 2. List of abbreviations

Abbreviation Definition

AT Assistive Technology

EASTIN European Assistive Technology Information Network

IAATIP International Alliance of Assistive Technology Information Providers

ETNA European Thematic Network on Assistive Information Technologies

GPII Global Public Inclusive Infrastructure

API Application Programming Interface

IPR Intellectual Property Rights

WS Web Service

UL Unified Listing

6

Page 7: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

1 Executive SummaryThis deliverable is aimed at defining two key elements for the federation of Assistive Technology databases (WP 203):

definition of an harmonized dataset for describing AT products within the Unified Listing database;

definition of the technical specifications for the communication between the EASTIN system and the Unified Listing database.

The experience of the EASTIN network, that aggregates the contents of six databases on AT products, represented the basis for the definition of both points listed above.

....

7

Page 8: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

2 IntroductionThe Unified Listing of solutions for ICT access will be based upon a federation of resources (for details on the approach for the federation process see the deliverable ID203.1). This means that the information included in the listing will be drawn from many different source databases that store the information in different ways (i.e. using different platforms and representing the data in different ways). This calls for a process of harmonization and integration of the information included in the different databases. A core collection of databases for the Unified Listing will be the EASTIN network (Andrich, R. 2011).

The objective of this deliverable is twofold: on the one side defining the dataset for describing AT products within the Unified Listing database, taking into account the existing dataset used in the different federated databases; and on the other side defining the technical specifications for the communication between the federated databases and the Unified Listing.

The starting point for the AT section of the Unified Listing will be the EASTIN network that aggregates the contents of the following eight national databases on AT products:

Portale SIVA (Italy) (http://portale.siva.it/)

Rehadat (Germany) (http://www.rehadat.de/)

HMI-Basen (Denmark) (http://www.hmi-basen.dk/)

DLF Data (UK) (http://www.dlf-data.org.uk/)

Handicat (France) (http://www.handicat.com/

Vlibank (Belgium) (http://www.vlibank.be/)

Catàlogo de Ayudas Técnicas (Spain) (http://www.catalogo-ceapat.org/)

Vlans (Holland) (http://www.vilans.nl/)

This deliverable is one of the outcomes of the activity A 203.1 “Approach and mechanism for federating solution repositories while maintaining data source/credit” included in the WP 203 "Federating Repositories of Solutions and Components”

3 The EASTIN harmonized data structureSince 2004, the partners of the EASTIN network have worked together to harmonize their databases according to common requirements. The result of this work is the harmonized data structure used to present the information in the EASTIN website.

The EASTIN Portal provides information on the following three categories of resources: Assistive Products, Organizations (Manufacturer/suppliers, Service Providers, Projects), and

8

Page 9: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Basic information Technical details

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Associated Information (Articles, Case Descriptions, Ideas, FAQs, Forums, News, Regulations). Recently, within a European funded project called ETNA (European Thematic Network on Assistive Information Technologies) (ETNA, n.d.), the EASTIN data structure has been improved by defining a Taxonomy1 for the description of the three categories of resources mentioned above. In practical terms the EASTIN taxonomy is composed of three datasets (for AT products, Organizations, Associated Information) and a collection of terms (i.e. a vocabulary) used for the description of the technical details of AT products.

Figure ... represent an example of a product record included in the EASTIN portal described according to this new Taxonomy.

3.1 EASTIN Product datasetAs shown in figure …., the EASTIN product dataset is composed of two parts: the basic information and the technical details. Table ... presents the information included in the EASTIN product dataset.

Table 3Field TypeProduct Name StringProduct Code String (representing the unique ID in the information

provider DB)Information provider Custom type representing the information provider

(including name, country, contact information, ...)Primary ISO code Custom type representing the ISO codeManufacturer info Custom type representing the manufacturer

(including name, country, address, website, ...)Text description in original language

String

Text description in English StringThumbnail image String representing the url

1 Within the scope of this deliverable, the term taxonomy is intended as a structure for identifying and naming concepts and arranging them into classifications

9

Page 10: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Large Image String representing the urlSource webpage (in original language)

String representing the url

Source webpage (in English) String representing the urlDownload or purchase webpage (in original language)

String representing the url

Download or purchase webpage (in English)

String representing the url

Product state Custom Enumeration type: Undefined; Active; OutOfDate; Deleted

Insert Date DateTimeLast update date DateTimeLinks to further information Array of custom type representing further

information urlsOptional ISO codes Array of custom type representing the ISO codesProduct technical details Array of Custom type representing the product

features

As shown in table …, while the basic information is made up of a set of separate fields, the product technical details consist of a single field that contains of an array of Features selected among the collection of all possible features (i.e. the vocabulary) identified in the ETNA taxonomy.

3.2 The vocabulary for product featuresFor what concerns the product detailed dataset, the EASTIN taxonomy can therefore be basically seen as a Vocabulary used to standardize the description of technical details. The Vocabulary is based on a two level hierarchy made up of Titles and Features. Groups of homogeneous Features are clustered together under the same Title. For example the Features “Windows”, “Mac OS”, “Linux”, “Chrome OS” , etc... are all clustered under the Title “Operating System”, while “Printer”, “Visual display”, “Tactile display”, etc... are clustered under the Title “Output devices”. Features can be of two types: Measures, that can have a numeric value or an interval specified (e.g. weight, length, ....), and Attributes, that do not have a specified value (i.e. are Boolean features). Overall 19 Titles and 266 Features have been identified. In Error: Reference source not found all the Titles included in the current ETNA taxonomy are listed.

Table 4 list of Titles included in the taxonomy Overall dimensions Activation modalities Browsers Linguistic representations Input adjustments Connectivity Subdivisions

Capacity/Range Operating systems Languages Functionalities Output devices License

Energy type Operating system versions Visualization Input devices Output adjustments Price

10

Page 11: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Table .... gives an example of some of the items included in the Vocabulary of the EASTIN taxonomy. The current version of the complete vocabulary is attached in Annex ....

Name TypeOverall dimensions TitleWidth (cm) Feature – MeasureLength (cm) Feature – MeasureHeight (cm) Feature – MeasureWeight (kg) Feature – Measure… ...Capacity / Range TitleMagnification (x) Feature – MeasureNumber of keys Feature – MeasureNumber of input channels Feature – MeasureNumber of output channels/Devices Feature – MeasureSignal range (m) Feature – Measure… ...Output TitleSpeakers/headphones Feature – AttributePrinter Feature – AttributeVisual screen/display Feature – AttributeTactile display Feature – AttributeVibrator Feature – AttributeVoice synthesis Feature – Attribute…. ...

The model that has been used for identifying the clusters of features of an ICT based product (i.e. the Titles of the taxonomy) is represented in Figure ..... The idea behind the model is that in an ICT based product the following conceptual “elements” can be considered: Input, Central Unit (for processing and storage), Output, Connectivity (with other products or services), Environment (in which the product operates), Physical characteristics, and Software characteristics.

11

Page 12: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

ENVIRONMENT

INPUT:•Device input devices (or software components) the product includes or is designed to be used with

•Modalityhow the device is activated (inclination, eyegaze, acoustic, …)

•Adjustmentsavailable input adjustment, filtering options

OUTPUT•Deviceoutput devices (or software components) the product includes or is designed to be used with

•Adjustmentsavailable output adjustment/options

CENTRAL UNIT:•Functionalitiese.g. word prediction, spell check, real time content adjustment,….

•Linguistic representation e.g. Simbolic, Alphabetic, Sign language, simplified,…

•Languagee.g. Italian, Spanish, English,….

•Capacity/Rangee.g. Magnification, Num. input channels, Num. of keys, ….

PRODUCT (HW/SW)

Connectivityhow the product connects to devices/services

Platform/OS/BrowserOther SWServices

Physical char.Overall dimension

Materials/structureEnergy type

Device positioning/ fixing

Software char.Licence type (free sw, proprietary, …)

Price (free, bundled with OS, …)Programming language

Figure 1 – model of an ICT based product

3.2.1 Connection of the taxonomy items with ISO 9999 divisionsA mechanism has been created to put the items of the vocabulary in relation with the divisions (i.e. the product categories) identified by the ISO 9999 standard (ISO, 2011) – that defines a three level hierarchical classification of assistive products for persons with disability. A matrix has been created to indicate, for each of the item in the vocabulary, the “relevance” for the ISO 9999 divisions. Currently a subset of 38 ISO divisions has been considered (including those more strictly related to ICT products). The relevance of a vocabulary item for each of the identified ISO divisions is evaluated by means of a 5-points scale (1 ‘absolutely irrelevant’ to 5 ‘absolutely relevant’). For instance, for the ISO division “22.36.18 Input Software”, the item “Width (Overall dimensions)” is ranked “1” while item “Accelerometer (Input Devices)” is ranked “3” and item “Windows (Operating Systems)” is ranked “5” (Error: Reference source not found).

Table 5 example of relations between taxonomy items and ISO divisionsISO divisions

Taxonomy items

22.36.03 Keyboards

22.36.18 Input Software

22.39.12 Special output

software

Width (Overall dimensions) 5 1 1 …Windows (Operating Systems) 4 5 5 …Accelerometers (Input devices) 3 3 1 …... … … … …

One of the advantages of this approach, is related to the possibility of presenting, in a data entry form, the taxonomy items ordered by relevance with respect to the specific product category (for example when data of an on screen keyboard are entered into a database the

12

Page 13: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

items related to the supported operating systems are presented before the items related to the input devices, while the items related to the dimensions are not presented).

3.2.2 EASTIN SubdivisionsAs part of the Taxonomy a list of product typologies have also been identified. Those typologies are intended to be a refinement of some of the divisions included in the ISO 9999 standard and are therefore called Subdivisions in the EASTIN Taxonomy. Similarly to the ISO 9999 standard, each subdivision has a code, a title, and an explanatory note. For example the Subdivisions identified within the ISO division “22.39.12 – Special output software” are reported in Table ....

Table 6Code Title Explanatory noteISO 22.39.12 Special output

softwareIncluded are, e.g., software that enlarges the text and graphics displayed on a computer screen, software that reads the display and converts it to speech (screen reader).

223912.01 Magnifying software Software that enlarges the text and graphics displayed on the screen of a computer or other electronic devices. May feature screen reading, colour choice and focus enhancement etc.

223912.02 Screen reader software

Software that interprets what is being displayed on the screen and presents it to the user with text-to-speech, sound icons, or a Braille output device.

223912.03 Software for adjusting color combination and text size

Software that allows adjusting the color of text, background, images and other elements displayed on the screen, and/or to adjust the font size, to improve visualization.

223912.04 Software to modify the pointer appearance

Software to modify the size, color, and/or shape of the pointer on the screen

3.2.3 Vocabulary management procedureThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and features) if they are needed. For instance, a new operating system appearing on the market will require that a new item is introduced under the Title “operating system” in order to describe products compliant with it; likewise, a new innovative product may not fit in any of the current EASTIN subdivisions, thus a new subdivision should be created. A consensus procedure for deciding on the introduction of new items in the taxonomy has been defined. The procedure foresees the involvement of the Online Community that will be established within the ATIS4All project (ATIS4All, n.d.) – a sister network of the ETNA thematic network - that will include all the stakeholders of the ICT AT field (end users, manufacturer, researchers, developers, AT professionals, ....). The proposal to create a new item will be discussed online and eventually

13

Page 14: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

submitted for voting by authorised members of the Community. If the vote is successful, the new item is entered in the taxonomy by an administrator of the ETNA information system.

A number of experts, selected within the online community, will also have the possibility to decide on the “relevance” of the taxonomy items for the different ISO divisions by means of a 5-points scale (as described above).

4 Datasets of other databases of Assistive TechnologyIn the following paragraphs the data structure of other AT databases are reported. Those databases are not currently included in EASTIN but formal contacts have been started to include them in the network.

4.1 Open Accessibility Everywhere GroupThe key industrial partners of the AEGIS consortium, a European Funded project (AEGIS, n.d.), together with users’ representatives and the active support of the Scientific Advisory Board have developed an Open Accessibility Everywhere Group (OAEG) with the aim to promote the uptake of the AEGIS accessibility open source solutions through a coherent set of incentives and ultimately standardisation, and maintain and upgrade the AEGIS Open Accessible Framework and the individual open source software resulting from the project, after the project’s lifetime. The OAEG website includes information on accessibility standards, a blog aggregator, and a Repository of open source AT software and resources for development. The dataset of the software repository is reported in table...

Field ExampleTitle of the prototype Enable ViacamDeveloper(s) contact details Cesar Mauri - Sant Isidre 4 - 43120 Spain -

[email protected] (organization the developer belongs to) CREA Software SystemsRelease (version) 1.4Date of current release 15/11/2010Authoring rights (c) Cesar Mauri LobaShort description Enable Viacam (aka eViacam) is a mouse

replacement software that moves the pointer as you move your head....

Long description Enable Viacam can be used as a full alternative or as a complement to a conventional computer mouse. It is especially useful for people with motor impairments in their hands or their arms...

Target groups Moderate restriction on hand use, Severe or complete restriction on hand use

Links https://sourceforge.net/project/showfiles.php?group_id=248049

SVN link http://sourceforge.net/projects/eviacam/files/Type of software Accessible applications - OAF Step 5 - Use - Outside

14

Page 15: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

AEGISAssistive Technologies and support libraries - OAF Step 6 - Use - Outside AEGIS

The fields “target groups” and “type of software” are selected from the lists of pre-defined elements reported in the table below:

Target groups Type of software Partly sighted Blind Dexterity difficulties or slight restriction on

arms or hands Moderate restriction on hand use Severe or complete restriction on hand use Slight cognitive limitation and low support

need Moderate and severe cognitive limitation and

medium and high support need Slight or moderate hearing limitation Severe limitation or total deafness Aphasia, loss of the ability to produce and/or

comprehend language Stuttering & Dysarthria-motor speech disorder Web developers Developers of ICT infrastructure, applications

and services

Definitions of accessibility - OAF Step 1 - Creation

Stock elements - OAF Step 2 - Creation Developer and Authoring tools - OAF

Step 3 - Creation Platform support - OAF Step 4 - Use Accessible applications - OAF Step 5 –

Use Assistive Technologies and support

libraries - OAF Step 6 - Use Test tools

4.2 AbleDataAbleData is a website, based in the USA, that provides objective information on assistive technology and rehabilitation equipment available from domestic and international sources to consumers, organizations, professionals, and caregivers within the United States. AbleData's most significant resource is the AbleData database of assistive technology, which contains objective information on almost 40,000 assistive products. For each product, a detailed description is provided of the product's functions and features, price information (when available), and contact information for the product's manufacturer and/or distributors.

Field Example

15

Page 16: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

4.3 Emptech

4.4 OATSOFT

5 Web Service communication in the EASTIN systemThe communication between the EASTIN search engine and the databases of the information providers is ensured by Web Services. Those web services, used to provide data in input to the EASTIN system, are called Input Web Services (to distinguish them from the Output Web Services, described in the following, that are used to export data from EASTIN). The EASTIN Input Web Service Client sends a request to all the Input Web Services Server of the information providers that retrieve the data from the databases and send it back to the EASTIN website (Figure 2).

Figure 2 connection between EASTIN website and the databases of the information providers

The EASTIN system currently uses the XML-SOAP 1.2 protocol for input web services. The current version of the input web service specification is included in annex ...

6 Dataset for the AT product of the Unified ListingIn order to have a “lossless” storage of information coming from different databases, the dataset representing the AT products in the Unified Listing has to include the union of the fields of the source databases. On the other hand, to avoid redundancy of fields representing the same data, a “conversion table” will be developed to map similar concepts represented by different fields in different databases (for example in the “product name” field EASTIN databases is conceptually the same as the “software name” in the OATSOFT database).

16

Page 17: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

In the Unified Listing database each record will be represented by a “multi layer” structure: there will be a layer for storing the product description of each of the source databases and a layer for the product description of the GPII Unified Listing as well as each available translation of each database. Specific product settings will also be part of the record. There will also be a “unique product ID” that will allow the Unified Listing to track the same product coming from different databases – and different versions of the same product. GPII global unique product sync number

5475

GPII Product Name Dasher

GPII Manufacturer Name Cavendish Labs-Inference group

GPII Description Dasher is a special on screen keyboard that….

... ...

Information Provider (name-country)

EASTIN-SIVA (IT) EASTIN-HMI (DK) AbleData (US)

Product Name Inference group Dasher Dasher Dasher

Product Code 15478 5478 487

Primary ISO code 22.36.18 Input Software 22.36.18 Input Software -

Manufacturer info The Inference group Cavendish laboratory Inference group

Text description in original language

Dasher è un software gratuito che permette di scrivere…

Auf dem Bildschirm erscheint ein vertikal angeordnetes...

Dasher is a text entry system…

Large Image -

... … … …

Specific Settings

Setting name values

Font size 10- 38 pt

Scanning speed slow, medium, fast

Voice output on; off

<DECISIONS to be taken:

Classifications and taxonomies: import (and keep aligned) classification and taxonomies (e.g. ISO codes, EASTIN taxonomy, …) or store the data “agnostically” as “strings”

Create a structured relational database including entities such as “companies”, “Information providers”, … or have a “flat” database of products (a single data table)>

6.1 Proposed dataset for the AT product in the GPII Unified ListingThe following table

Field Single field or Array?

Type Example

GPII global unique product sync number

Single Integer 5475

Product Names Array (one Array of strings [Inference Group Dasher; Dasher; Dasher]

17

Page 18: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

for each source database)

Product ID in original DB

Array (one for each source database)

Array of Strings (each representing the unique ID in the source DB)

[15478; 5478; 487]

Information provider names

Array (one for each source database)

Array of Strings [SIVA; Rehadat; AbleData]

Information provider country

Array (one for each source database)

Array of Custom Enumeration type (Two letter country code, ISO 3166-1-alpha-2.)

[IT; DE; US]

Information provider network

Array (one for each source database)

Array of Strings (representing the network that the DB belongs to, if any)

[EASTIN; EASTIN; Null]

Primary ISO 9999 codes

Array (one for each source database)

Array of Strings (each representing ISO code and name)

[22.36.18 Input Software; 22.36.18 Input Software; Null]

Manufacturer names

Array (one for each source database)

Array of Strings [The Inference group; Cavendish laboratory; Inference group]

Manufacturer country

Array (one for each source database)

Array of Custom Enumeration type (Two letter country code, ISO 3166-1-alpha-2.)

[GB; GB; GB]

Manufacturer website

Array (one for each source database)

Array of Strings [http://www.inference.phy.cam.ac.uk/is/; http://www.inference.phy.cam.ac.uk/dasher/deutsch; Null]

Text description in info providers languages

Array (one for each source database)

Array of Strings [Dasher è un software gratuito che permette di scrivere…; Auf dem Bildschirm erscheint ein vertikal angeordnetes; Dasher is a text entry system…]

Text descriptions in English

Array (one for each source database)

Array of Strings [Dasher is an information-efficient text-entry interface...; a vertically arranged alphabet from which the user... ; Text entry system…]

Image Array (one for each source database)

String representing the url

[http://portale.siva.it/Img/Ausili/18967_b.jpg; null; null]

Source webpages (in info providers

Array (one for each source

String representing the url

[http://portale.siva.it/bancadati/ausili/SchedaAusilio.asp?id=18967; ...]

18

Page 19: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

languages) database)Source webpage (in English)

Array (one for each source database)

String representing the url

Download or purchase webpage (in original language)

Array (one for each source database)

String representing the url

Download or purchase webpage (in English)

Array (one for each source database)

String representing the url

Product state Single Custom Enumeration type: Undefined; Active; OutOfDate; Deleted

Insert Date Array (one for each source database)

Array of DateTime

Last update date

Array (one for each source database)

Array of DateTime

Links to further information

2D Array (one array for each source database)

Array of Arrays of strings representing further information urls

Optional ISO codes

2D Array (one array for each source database)

Array of Arrays of strings (each representing ISO code and name)

{ [22.36.03 keyboard; 22.36.12 Alternate input devices]; [22.36.03 keyboard; 22.36.12 Alternate input devices]; null}

Product technical details

2D Array (one array for each source database)

Array of Arrays of strings (each representing the product features including the parent feature)

{ [Input devices:switch; Input devices:mouse; Input adjustments: Font size on controls/keys;....]; [Input devices:switch; Input devices:mouse; Input adjustments: Font size on controls/keys;....]; null}

Product specific settings

Single?? Ulr pointing to a JSON file??

http://settings/gpii_unique_sync_number/...

7 Communication between EASTIN and the Unified ListingA bidirectional communication between EASTIN network and GPII Unified Listing will be established in such a way to allow the users of the GPII Unified Listing web portal to access

19

Page 20: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

information coming from the EASTIN databases, and users of the EASTIN Web Portal to access information coming from the GPII Unified Listing. The overall connection scheme is depicted in figure....

As already described above, the EASTIN search engine provides a specific set of APIs to receive input data from the EASTIN information providers (online databases) and make them visible in the EASTIN portal. The EASTIN search engine calls a set of Web Services that must be implemented by any information provider that aims to send data to the engine. Both the Web Service functions and the exchanged data format have been standardized by the EASTIN consortium and these standards must be followed by the external information providers (see technical specifications in Annex...). As already stated above those web services are called Input Web Services

To provide data retrieved by the EASTIN search engine from the EASTIN databases to the GPII Unified Listing, a specific set of Web Services will be implemented within the Cloud4all project that contains functions to extract data using the EASTIN search engine. These Web Services will be exposed by the EASTIN search engine and will be accessed by a specific application aimed at collecting the data retrieved from EASTIN into the GPII Unified Listing database. It is worth noticing that, since the data source is marked when a search is carried out, the fact that the GPII Unified Listing will be part of the EASTIN network will not cause a problem since the data received by GPII Unified Listing from the GPII Unified Listing (Because because it is part of the EASTIN network) can be filtered out. In the following those Web Services will be called Output Web Services.

In the following chapters the details of input and output Web services are described

7.1 Retrieving information from EASTIN - Output Web service The process of getting the information from the EASTIN databases, in order to store it in the GPII Unified Listing, is the following (see Figure 3):

1. The GPII Output Web Service Client sends a query to the EASTIN Output Web Service Server

20

Page 21: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

2. The EASTIN search engine in turn sends the request to all the information providers (using the Input Web Service Client)

3. The information providers answer the request with the list of products (using the Input Web Service Servers)

4. The search engine sends the list back to the GPII Unified Listing database (using the Output Web Service Server)

5. Retrieved information is validated2 and stored in the Unified Listing DatabaseFigure 3 Information flowing from the EASTIN database to the GPII Unified listing

Since the scope of the EASTIN databases is broader than just ICT assistive devices, the query sent by the GPII Unified Listing will be restricted to Assistive products for ICT access. This filtering3 will be done on the basis of the EASTIN Classification of Assistive Technology based on the ISO 9999 standard (ISO 9999, 2011).

The procedure described above will be used to initially populate the database of the Unified Listing and will be repeated periodically to keep the list updated. Of course in the following queries only updated records and new records will be considered (this will be based on the “last update date” information included in each record). The time period for repeating the query will be initially set to two weeks and will be adjusted on the basis of the number of new record and updated record retrieved in each query.

2 See the wiki page http://wiki.gpii.net/index.php/Unified_%28Federated%29_Listing_validation_procedure for details on the validation procedure

3 For details on the ISO codes that will be included see the wiki page: http://wiki.gpii.net/index.php/Unified_%28Federated%29_Listing_validation_procedure

21

Page 22: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

The specifications for the Output Web Services are included in Annex ..... Those Web Services will be based on the JSON REST protocol. The output web service server will implement two methods:

FindSmallProducts: this is the method that searches for AT product in the databases of the EASTIN network. Input parameters that can be specified for the search are: an array of ISO Codes; an array of features (according to the ETNA taxonomy), a product Name, a Manufacturer name, an insert Date interval (to search for recently added products). The methods returns an array of “SmallProducts” objects that include some basic information on the product (ProductCode, RepositoryCode IsoCodePrimary IsoCodesOptional, ProductName, ManufacturerCode, ManufacturerName, InsertDate LastUpdateDate ThumbnailImageUrl)

GetProduct: this method returns the detailed information of a specific product (i.e. the complete EASTIN dataset described above). The methods requires as input parameters the ProductCode and RepositoryCode.

7.2 Making the information included in the GPII Unified Listing available to the EASTIN website – Input Web Service

For the inverse process, i.e. for making the information included in the GPII Unified Listing available to the EASTIN website, GPII will become one of the Information provider of the EASTIN network. In order to plug the GPII Unified Listing to EASTIN search engine, a specific Input Web Service (Server) will be implemented following the technical specification already in place for the other databases participating into the network (Figure 4). This requires that the GPII Unified Listing provides data in a form that is compliant with the EASTIN standard. The Input Web Service specifications are included in annex .... Those Web Services are based on the XML-SOAP 1.2 protocol.

Three methods has to be implemented to comply with the specifications:

integer GetIsoClassProductCount(string isoCode): returns the number of products belonging to the ISO class whose ISO code is passed as a string parameter to the method

SmallProductDto[] FindSmallProducts(string[] isoCodes, FeatureDto[] features, string commercialName, string manufacturer, dateTime insertDateMin, dateTime insertDateMax)

ProductDto GetProduct(string productCode)

22

Page 23: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Figure 4 connection of the Unified Listing database to the EASTIN network

GPII Unif. listing

EASTIN search engine

EASTIN Web Portal

QueriesRetrieved data

SIVA (Italy)

DLF (UK)

Rehadat(Germany) …

EASTIN Distributed DB of AT products

Input W.S. (server)

Input W.S. (server)

Input W.S. (server)

Input W.S. (server)

Input Web Service (client)

Input W.S. (server)

EASTIN User

8 Conclusions...

9 References(2011). ISO 9999:2011. Assisitive products for person with disability – Classification and terminology.

Standard.

23

Page 24: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

10 Annex 1 – The vocabulary of the EASTIN taxonomyID name type1 Overall dimensions title2 Width (cm) measure3 Length (cm) measure4 Height (cm) measure5 Weight (kg) measure6 Capacity/Range title7 Magnification (x) measure8 Number of keys measure9 Number of input channels measure10 Number of output channels/Devices measure11 Signal range (m) measure12 Energy type title13 Battery - disposable attribute14 Battery - rechargeable attribute15 Mains electric attribute16 Power via USB attribute17 Activation modalities title18 Electro Myo Graphic Signal (EMG) attribute19 Eye blink attribute20 Acoustic attribute21 Eye gaze attribute22 Voice Recognition attribute23 Mechanical (push, pull, grasp,…) attribute24 Sip/Puff attribute25 Inclination attribute315 Operating systems title316 Windows attribute317 Mac OS attribute318 Linux attribute319 Chrome OS attribute320 iOS attribute321 Android attribute322 Windows mobile/phone attribute323 Symbian attribute26 Operating system versions title27 Mac OS X attribute28 Mac OS 9 attribute29 Mac OS 8 attribute30 Windows 8 attribute31 Windows 7 attribute32 Windows Vista attribute33 Windows XP attribute34 Windows 2000 attribute35 Windows 98 attribute36 Windows 95 attribute37 iOS 6.x attribute38 iOS 5.x attribute39 iOS 4.x attribute40 iOS 3.x attribute41 iOS 2.x attribute42 iOS 1.x attribute43 Android 4.x attribute44 Android 3.x attribute45 Android 2.x attribute46 Android 1.x attribute47 Windows phone 8 attribute48 Windows phone 7 attribute49 Windows mobile 6 attribute50 Windows mobile 5 attribute51 Windows mobile 2003 SE attribute52 Linux Ubuntu attribute53 Linux Fedora attribute54 Linux Redhat attribute314 Linux Debian attribute313 Linux SUSE attribute

24

Page 25: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

57 Browsers title58 Chrome attribute59 Firefox attribute60 Internet Explorer attribute61 Safari attribute62 Opera attribute63 Languages title64 Danish attribute65 Dutch attribute66 English attribute67 French attribute68 German attribute294 Greek attribute295 Italian attribute296 Portuguese attribute297 Spanish attribute298 Bulgarian attribute299 Czech attribute300 Estonian attribute301 Finnish attribute302 Hungarian attribute303 Latvian attribute304 Lithuanian attribute305 Maltese attribute306 Norwegian attribute307 Polish attribute308 Romanian attribute309 Slovak attribute310 Slovenian attribute311 Swedish attribute69 Visualization title70 Black/white display attribute71 Colour display attribute72 3D attribute73 Linguistic representations title74 Sign language attribute75 Braille attribute76 Alphabetic attribute77 Symbolic attribute78 Simplified attribute89 Functionalities title90 Word prediction attribute91 Word completion attribute92 Spell correction attribute93 Abbreviation expansion attribute94 Highlights each word/sentence as it is read aloud attribute95 Allows creation of macro function attribute96 Programmable/configurable attribute97 Calendar function attribute98 Reminder attribute99 Environmental control attribute100 Portable attribute101 Built-in microphone attribute102 Speech or acoustic signals on menus attribute103 Switch controlled scanning attribute104 Input devices title105 Joystick (direct) attribute106 Joystick (switch) attribute107 Keys/keyboard attribute108 Chording keyboard attribute109 Mouse attribute110 Speech recognition attribute111 Switch attribute112 Touch screen attribute113 Track pad (touch pad) attribute114 Trackball attribute115 Movement tracking system attribute116 Eyegaze control system attribute117 Video camera/webcam attribute118 Microphone attribute119 Accelerometer attribute

25

Page 26: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

120 Biosignals sensor (EMG, EOG, EEG) attribute121 Input adjustments title122 Speed attribute123 Controls/keys activation delay attribute124 Type of scanning attribute125 Sensitivity attribute126 Scanning speed attribute127 Size of controls/keys attribute128 Number of controls/keys configuration attribute129 Font size on controls/keys attribute130 Colour of controls/keys attribute131 Filter on repeated activations attribute132 Key repeat rate attribute133 Microphone volume attribute79 Output devices title80 Speakers/headphones attribute81 Printer attribute82 Visual screen/display attribute83 Tactile display attribute84 Vibrator attribute85 Voice synthesis attribute86 Recorded sound attribute87 Environmental control devices attribute88 Haptic device attribute134 Output adjustments title135 Enlargement/zoom attribute136 Font size attribute137 Contrast attribute138 Colours attribute139 Image reversal attribute140 Equalization control attribute141 Volume attribute142 Sound feedback attribute143 Connectivity title144 PS2 attribute145 Serial attribute146 USB attribute147 Bluetooth attribute148 Infrared attribute149 Jack (specify size) (mm) attribute150 Other wireless attribute151 WiFi attribute152 Cloud or internet based application attribute153 Induction loop attribute154 Inductive coupling attribute155 Bluetooth A2DP compatible attribute156 Bluetooth - not A2DP compatible attribute157 License title158 Free software attribute159 Proprietary attribute160 Price title161 Free of charge attribute162 Bundled with operating system attribute163 Subdivisions title164 Stationary image-enlarging reading apparatus attribute165 Stationary image-enlarging reading apparatus with connection units for computers attribute166 Portable image-enlarging reading apparatus attribute167 Accessories for image-enlarging reading apparatus attribute169 Concha/in-the-ear hearing aids attribute170 Completely in-the-canal hearing aids attribute172 Behind-the-ear hearing-aids attribute173 Power behind-the-ear hearing-aids attribute175 Voice amplifiers for personal use attribute177 Electric typewriters without memory attribute178 Electric typewriters with memory attribute179 Braille typewriters attribute180 Stenotype machines attribute181 Electric Braille typewriters attribute183 Word-processing software attribute184 Desktop publishing software attribute186 Equipment for recording and/or replaying digital books attribute

26

Page 27: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

187 Digital note recorders attribute188 Cassette recorders attribute189 Accessories for recording and/or replaying sound attribute191 Real time captioning systems attribute192 Delayed captioning systems attribute193 Captioning services attribute195 Infrared (IR) systems for audio information attribute197 Induction-loop amplifiers attribute198 Small induction-loop amplifiers attribute199 Induction-loops attribute201 Symbolic voice output communication devices attribute202 Alphabetic communication devices attribute204 Face-to-face communication software attribute205 Tools for developing grids for communication software attribute207 Mobile telephones attribute209 Telecommunication and telematics software attribute210 Voice over IP Services attribute212 Indicators with visual signal attribute214 Indicators with acoustic signals attribute216 Indicators with mechanical signals attribute218 Calendar software attribute219 Electronic calendars attribute221 Memory support products attribute223 Registration of persons without identification attribute224 Remote video monitoring systems attribute225 Satellite navigation systems attribute227 Digital documents readers attribute228 Digital document reading (text to speech) service attribute230 Paper documents reading devices attribute231 OCR software attribute232 Portable scanner with electronic dictionary attribute234 Braille note taking devices attribute236 Software interfaces for computers and mobile devices attribute237 Operating systems attribute239 Web browsers attribute241 Keyboards with a special design attribute242 Programmable (concept) Keyboards attribute243 Keyboard shields and keyboard gloves attribute244 Programmable keyboard configuration tool attribute246 Software for accessing the computer in scanning mode attribute247 Eyegaze systems attribute248 Speech recognition software attribute249 Optical scanner, stationary attribute250 Optical scanner, hand held attribute251 Datagloves attribute252 EEG, EOG or EMG controlled input devices attribute254 Switch interface attribute255 Accessories for input devices attribute257 On screen keyboards attribute258 Mouse control software attribute259 Word prediction and word termination software attribute260 Software for adjusting input devices response attribute261 Software based electronic dictionaries attribute262 Computer based sound collections attribute264 Touch screens attribute265 Trackballs, mousetrappers and touchpads attribute266 Traditional mouse devices and pen mouse devices attribute267 Joystick mouse device attribute268 Switch operated computer mice attribute269 Computer and console joysticks attribute271 Computer monitors attribute272 Screen filters attribute274 Braille displays attribute276 Speech synthesizers attribute278 Magnifying software attribute279 Screen reader software attribute280 Software for adjusting color combination and text size attribute281 Software to modify the pointer appearance attribute283 Single switches (switches with only one function) attribute284 Two-four function control switches attribute285 Five-or-more-function-contacts attribute

27

Page 28: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

287 Remote controller attribute288 Receiver unit for environmental control attribute289 Switch latches and timers attribute291 Environmental control software attribute293 Software for composing music attribute312 Body movement controlled mice attribute

28

Page 29: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

11 Annex 2 – Specifications for the EASTIN Input Web services

EASTIN Input Web services specsIn EASTIN Input Web services there are two groups of Web methods: the batch methods and the live ones. Batch methods are invoked by automatic processes which run in EASTIN central server and are used to update some almost-static information inside the EASTIN Portal (for example the ISO tree, the keyword lists, etc.). These methods are called with different frequencies (from once a day to once a month), depending on how often the retrieved information content is supposed to change inside each EASTIN partner’s local system. For example the method which returns the description of ISO classes, used to update the ISO tree in EASTIN Portal, is called once a month, because the ISO classification is supposed to be almost constant. Instead the method which returns the number of products for a given ISO class is invoked once a day because new products could be often added inside the EASTIN partners’ local systems or perhaps their description could have been modified.On the other side live methods are invoked directly by the end users through the EASTIN Portal Web pages and they return the results of searches inside EASTIN partners’ databases about products, actors (also called “organisations” in the EASTIN Web pages), and associated information.

In the following description the name of basic data types derives from the SOAP – XML Schema Definition standard (XSD). Each partner must cast these types to the specific types of the language/platform adopted to implement the Input Web services.

Batch methodsinteger GetIsoClassProductCount(string isoCode)Input parameters:

string isoCode: a string representing a single ISO class (for example “12.22”).Returns:

integer representing the number of products contained in the ISO class passed in the input parameter. Returns zero if no product belongs to the ISO class.

Frequency: Once a day; the first call to the Web method is executed at any moment between

04.00 AM (GMT +1:00) and 04.59 AM (GMT +1:00). The time at which the last call is executed is not defined.

This is a batch method which returns the number of products belonging to the ISO class whose ISO code is passed as a string parameter to the method. If no product belonging to the ISO class is found the method returns zero. The method is designed to work in batch

29

Page 30: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

mode. Once a day the ISO classification tree which is stored in the EASTIN central repository is visited by the batch process and for each node which is a leaf of the ISO tree the method is called, passing the ISO code of that node as parameter (so the number of calls to the Web method is equal to the number of leaf nodes of the EASTIN ISO classification tree). The method retrieves the number of products belonging to that ISO class and this information is updated in the EASTIN ISO tree.

IsoClassLocalizationDto GetIsoClassLocalization(string isoCode)4

Input parameters: string isoCode: a string representing a single ISO class (for example “12.22”).

Returns: IsoClassLocalizationDto object containing the description of the ISO class passed in

the input parameter. If no description is found returns the null object.Frequency:

Once a month; the first call to the Web method is executed on the second day of every month at any moment between 03.00 AM (GMT +1:00) and 03.59 AM (GMT +1:00). The time at which the last call is executed is not defined.

This is a batch method which returns a single object belonging to the class IsoClassLocalizationDto, which represents an element of the ISO classification. The method searches into the local database for information about the ISO class whose ISO code is passed as string parameter to the method. For example if the value "12.22" is passed, the method will search for information about 12.22 ISO class. The information items retrieved by the method and stored in the IsoClassLocalizationDto object are:

the ISO code; the title of the ISO class; the scope note of the ISO class (if it exists).

If no information for the ISO class is found the method returns the null object. The method is designed to work in batch mode. Once a month the ISO classification tree which is stored in EASTIN central repository is visited by the batch process and for each node, which represents an ISO class, the method is called, passing the ISO code of that node as parameter (so the number of calls to the Web method is equal to the number of nodes of the EASTIN ISO classification tree). The method retrieves the information about that ISO class and this information is updated in the EASTIN Portal ISO tree. For a complete description of the IsoClassLocalizationDto object see below.

KeywordDto[] GetKeywords()5

4 This method has to be implemented only by a restricted set of authorized partners, responsible for providing the localization in different languages of the ISO 9999 classification. For further information please contact the EASTIN portal administrators.

5 This method has to be implemented only by a restricted set of authorized partners, responsible for providing the localization in different languages of the keyword list. For further information please contact the EASTIN

30

Page 31: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Input parameters: none.

Returns: KeywordDto[]: an array of KeywordDto objects containing information about

keywords. If no keyword is found returns a not null KeywordDto[] array with zero elements.

Frequency: Once a month; the unique call to the Web method is executed on the third day of

every month at any moment between 03.00 AM (GMT +1:00) and 03.59 AM (GMT +1:00).

This is a batch method which returns an array of objects belonging to the class KeywordDto. The method searches into the EASTIN partners’ local databases for the dictionary of (keywords –> ISO classes) which will be used in the keyword research of the EASTIN portal. This method requires no parameter. Each KeywordDto object contains the following information:

the keyword id in the partner’s local database; the keyword text; an array of ISO codes which are related to this keyword.

If no keyword is found the method returns a not null array with zero elements. The method is designed to work in batch mode. Once a month the method is called and the returned information are updated in the EASTIN portal keyword lists. For a complete description of the KeywordDto object see below.

Live search methods6

1. Product searches

SmallProductDto[] FindSmallProducts(string[] isoCodes, FeatureDto[] features, string commercialName, string manufacturer, dateTime insertDateMin, dateTime insertDateMax) Input parameters:

string[] isoCodes: an array of strings representing ISO classes (for example [“12.22”, “09.03.03”]);

FeatureDto[] features: an array of FeatureDto objects (for a complete description of the FeatureDto object see below);

string commercialName: the whole or a part of the commercial name of the products to be searched;

portal administrators.

6 All the “Live search methods” must be implemented. For methods that retrieve a typology of data that is not available in the partner’s database an empty array or a null value (depending on the specific method) must be returned.

31

Page 32: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

string manufacturer: the whole or a part of the manufacturer name of the products to be searched;

dateTime insertDateMin: the lower bound for the insert date of the products to be searched;

dateTime insertDateMax: the upper bound for the insert date of the products to be searched.

Returns: SmallProductDto[]: array of SmallProductDto objects containing each a light set of

information about a product (for a complete description of the SmallProductDto object see below). If no product is found returns a not null SmallProductDto[] array with zero elements.

This method returns an array of objects belonging to the class SmallProductDto. The method implements five different kinds of searches:

1. If the isoCodes array is not void the method searches for all products belonging to the ISO classes passed, using an OR statement. For example if [“12.22”, “09.03.03”] is the isoCodes array, all products belonging to the 12.22 ISO class OR to the 09.03.03 class are returned.

2. If the features array is not void the method searches for all products that possess the indicated FeatureDto objects and whose measures for the respective features are compatible with the measure boundaries specified in the FeatureDto objects. For example if features contains the FeatureDtos [{“Width (cm)”, 30, 50}, {“Height (cm)”, 80, 100}] the method will search for all products having some widths in the range [30, 50] AND having some heights in the range [80, 100]. Note that if a product declares for example to have a fixable width between 20 and 40 it should be included in the search results since for some of its configurations it satisfies the boundaries. The product is included in the search results only if the compatibility between its measures and the given boundaries present in in the FeatureDto objects are satisfied for all FeatureDto objects.

3. If commercialName is not void the method searches a matching between the words contained in the commercialName parameter and the respective data in the EASTIN partner’s local database. Since into the commercialName parameter there could be one or more words, the method must split the words and search inside its database for products whose commercial name contains all these words (even if present as substrings inside of biggest strings). For example if commercialName = “quickie xenon” the method must search for all products whose commercial name contains both words “quickie” AND “xenon”.

4. If manufacturer is not void the method executes the search using the same criteria specified in 2 but applied to products’ manufacturer name.

5. If insertDateMin and insertDateMax are both not null all products whose insert date is included within the interval [insertDateMin, insertDateMax], endpoints included, are returned. These two parameters must be both not null or both null.

32

Page 33: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

If more than one parameter is not void at the same time, the results coming from the matches for each parameter are merged together with an AND logic: only results satisfying the conditions specified for each parameter are returned. If no product is found the method returns a not null SmallProductDto[] array with zero elements.

ProductDto GetProduct(string productCode)Input parameters:

string productCode: the id of the product in the EASTIN partner’s system.Returns:

ProductDto: an object containing detailed information about a single product. If no product is found than returns the null object.

This method returns an object belonging to the class ProductDto (for a complete description of the ProductDto object see below). The method searches into EASTIN partner’s local databases for the product which has the id matching with the method parameter productCode. If no product is found the method returns the null object.

2. Actor searches

SmallActorDto[] FindSmallActors(string actorType, string[] isoCodes, string[] icfCodes, string actorName, dateTime insertDateMin, dateTime insertDateMax)Input parameters:

string actorType: the type of the actor; string[] isoCodes: an array of strings representing ISO classes (for example [“12.22”,

“09.03.03”]); string[] icfCodes: an array of strings representing the EASTIN ICF classes (for example

[“b1”, “d2”]) which are a subset of the official ICF classification; string actorName: the whole or a part of the name of the searched actor; dateTime insertDateMin: the lower bound for the insert date of the actors to be

searched; dateTime insertDateMax: the upper bound for the insert date of the actors to be

searched.Returns:

SmallActorDto[]: an array of SmallActorDto objects containing each a light set of information about an actor (for a complete description of the SmallActorDto object see below). If no actor is found returns a not null SmallActorDto[] array with zero elements.

This method returns an array of objects belonging to the class SmallActorDto. The method implements five different kinds of searches:

33

Page 34: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

1. If the type parameter is not void the method searches for all actors belonging to the specified type; the possible values for type are: “companies”, “projects” and “serviceproviders”.

2. If the isoCodes array is not void the method searches for all actors belonging to the ISO classes passed, using an OR statement. For example if [“12.22”, “09.03.03”] is the isoCodes array, all actors belonging to the 12.22 ISO class OR to the 09.03.03 class are returned.

3. If the icfCodes array is not void the method searches for all actors belonging to the ICF classes passed, using an OR statement. For example if [“b1”, “d2”] is the icfCodes array, all actors belonging to the b1 ICF class OR to the d2 class are returned.

4. If actorName is not void the method searches a matching between the words contained in the actorName parameter and the respective data in the EASTIN partner’s local database. Since into the actorName parameter there could be one or more words, the method must split the words and search inside its database for actors whose name contains all these words (even if present as substrings inside of biggest strings). For example if actorName = “metlex ltd” the method must search for all actors whose name contains both words “metlex” AND “ltd”.

5. If insertDateMin and insertDateMax are both not null all actors whose insert date is included within the interval [insertDateMin, insertDateMax], endpoints included, are returned. These two parameters must be both not null or both null.

If more than one parameter is not void at the same time, the results coming from the matches for each parameter are merged together with an AND logic: only results satisfying the conditions specified for each parameter are returned. If no actor is found returns a not null SmallActorDto[] array with zero elements.

ActorDto GetActor(string actorType, string actorCode)Input parameters:

string actorType: the type of the actor; string actorCode: the id identifying a single actor inside the EASTIN partner’s local

system.Returns:

ActorDto: an object containing detailed information about a single actor (for a complete description of the ActorDto object see below). If no actor is found than returns the null object.

This method returns an object belonging to the class ActorDto. The method searches into EASTIN partner’s local database for the actor of the type specified in the actorType parameter which has the id matching with the method parameter actorCode. If no actor is found the method returns the null object.

3. Associated information searches

34

Page 35: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

SmallAssociatedInfoDto[] FindSmallAssociatedInfos(string infoType, string[] isoCodes, string[] icfCodes, string title, string author, dateTime insertDateMin, dateTime insertDateMax)Input parameters:

string infoType: the type of the associated information document; string[]isoCodes: an array of strings representing ISO classes (for example [“12.22”,

“09.03.03”]); string[]isoCodes: an array of strings representing EASTIN ICF classes (for example

[“b1”, “d2”]); string title: the whole or a part of the title (in the original language or in English) of

the searched associated information document; string author: the whole or a part of the author names of the searched associated

information document; dateTime insertDateMin: the lower bound for the insert date of the associated

information documents to be searched; dateTime insertDateMax: the upper bound for the insert date of the associated

information documents to be searched.Returns:

SmallAssociatedInfoDto[]: an array of SmallAssociatedInfoDto objects containing each a light set of information about an associated information document (for a complete description of the SmallAssociatedInfoDto object see below). If no associated information document is found returns a not null SmallAssociatedInfoDto[] array with zero elements.

This method returns an array of objects belonging to the class SmallAssociatedInfoDto. The method implements six different kinds of searches:

1. If the type parameter is not void the method searches for all associated information documents belonging to the specified type; the possible values are: “articles”, “casedescriptions”, “ideas”, “faqs”, “forums”, “news” and “regulations”.

2. If the isoCodes array is not void the method searches for all associated information documents belonging to the ISO classes passed, using an OR statement. For example if [“12.22”, “09.03.03”] is the isoCodes array, all associated information documents belonging to the 12.22 ISO class OR to the 09.03.03 class are returned.

3. If the icfCodes array is not void the method searches for all associated information documents belonging to the ICF classes passed, using an OR statement. For example if [“b1”, “d2”] is the icfCodes array, all associated information documents belonging to the b1 ICF class OR to the d2 class are returned.

4. If title is not void the method searches a matching between the words contained in the title parameter and the respective data in the EASTIN partner’s local database. Since into the title parameter there could be one or more words, the method must split the words and search inside its database for associated information documents whose title (in original language OR in English if present) contains all these words (even if present as substrings inside of biggest strings). For example if title = “a guide

35

Page 36: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

to wheeled walking frames” the method must search for all associated information documents whose original title or whose English title contain all words “a”, “guide”, “to”, “wheeled”, “walking” and “frames”.

5. If the author parameter is not void the method executes the search using the same criteria specified in 4 but applied to the name of the authors of the associated information document (in this case no distinction is needed between original language and English).

6. If insertDateMin and insertDateMax are both not null all associated information documents whose insert date is included within the interval [insertDateMin, insertDateMax], endpoints included, are returned. These two parameters must be both not null or both null.

If more than one parameter is not void at the same time, the results coming from the matches for each parameter are merged together with an AND logic: only results satisfying the conditions specified for each parameter are returned. If no associated information document is found the method returns a not null SmallAssociatedInfoDoc[] array with zero elements.

AssociatedInfoDto GetAssociatedInfo(string infoType, string associatedInfoCode)Input parameters:

string infoType: the type of the associated information document; string associatedInfoCode: the id identifying a single associated information

document inside the EASTIN partner’s local systems.Returns:

AssociatedInfoDto: an object containing detailed information about a single associated information document (for a complete description of the AssociatedInfoDto object see below). If no associated information document is found than returns the null object.

The method searches into the EASTIN partner’s local database for the associated information document of the type specified in the infoType parameter which has the id matching with the method parameter associatedInfoCode. If no associated information document is found the method returns the null object.

EASTIN custom data types

As we have seen EASTIN Input Web services return basic SOAP types, such as String, Int and DateTime, but also custom defined types. A complete description of EASTIN custom defined types follows below. All mandatory fields are marked with a “*” (all the other fields can be considered as nullable). For the array fields in case they are empty do not assign a null value to them but a not null array of zero elements.

36

Page 37: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

IsoClassLocalizationDto string IsoCode*: the code of the ISO class; string Title*: the name of the ISO class ; string ScopeNote: the ISO class description.

KeywordDto string KeywordId*: the id of the keyword in the partner’s local database; string Text*: the keyword text; string[] IsoCodes*: the array of all ISO classification codes related to the keyword (for

example [“12.22”, “09.03.03”]).

FeatureDto integer FeatureId*: the id of the EASTIN Taxonomy item; decimal ValueMin: the lower bound value of the measure specified for this feature; decimal ValueMax: the upper bound value of the measure specified for this feature.

SmallProductDto string ProductCode*: the id of the product in the partner’s local database; string IsoCodePrimary*: the primary ISO Code of the product (for example

“09.03.03”); string[] IsoCodesOptional: the array of all secondary ISO classification codes of the

product (for example [“12.22”, “09.03.03”]); string CommercialName*: the commercial name of the product; string ManufacturerCode*: the id of the product’s manufacturer in the partner’s local

database; string ManufacturerOriginalFullName*: the full name in the original language of the

product’s manufacturer; dateTime InsertDate*: the insert date of the product; dateTime LastUpdateDate*: the last update date of the product; string ThumbnailImageUrl: the URL of the small format picture of the product (used

when displaying list of products in EASTIN Portal). The URL must be accessible on the Web by the end user’s browser.

ProductDto string ProductCode*: the id of the product in the partner’s local database; string IsoCodePrimary*: the primary ISO Code of the product (for example

“09.03.03”); string[] IsoCodesOptional: the array of all secondary ISO classification codes of the

product (for example [“12.22”, “09.03.03”]); string CommercialName*: the commercial name of the product; string ManufacturerCode*: the id of the product’s manufacturer in the partner’s local

database;

37

Page 38: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

string ManufacturerOriginalFullName*: the full name in the original language of the product’s manufacturer;

dateTime InsertDate*: the insert date of the product; dateTime LastUpdateDate*: the last update date of the product; string ThumbnailImageUrl: the URL of the small format image of the product (used

when displaying list of products in the EASTIN portal). The URL must be accessible on the Web by the end user’s browser.

bool IsReviewAllowed*: if true the end user is authorized to review this product; string ManufacturerAddress: the address of the product’s manufacturer; string ManufacturerPostalCode: the postal code of the product’s manufacturer; string ManufacturerTown: the town of the product’s manufacturer; string ManufacturerCountry*: the country code of the product’s manufacturer in ISO

3166-1-alpha-2 code (for example “IT”, “US”, etc.); string ManufacturerPhone: the phone of the product’s manufacturer; string ManufacturerFax: the fax of the product’s manufacturer; string ManufacturerEmail: the email of the product’s manufacturer; string ManufacturerSkype: the Skype account name of the product’s manufacturer; string ManufacturerWebSiteUrl: the Web site URL of the product’s manufacturer; string[] ManufacturerSocialNetworkUrls: an array of URLs linking to the product’s

manufacturer page inside the main social networks (for example Facebook, Twitter, LinkedIn, etc.);

string ImageUrl: the URL of the big format image of the product (used when displaying the detail view of the product in the EASTIN portal). The URL must be accessible on the Web by the end user’s browser;

string OriginalDescription: the description of the product in the original language; string EnglishDescription: the description of the product in English; string OriginalUrl: the URL of the Web page in the original language on the original

EASTIN partner’s Web site in which the product is presented. The URL must be accessible on the Web by the end user’s browser;

string EnglishUrl: the URL of the Web page in English on the original EASTIN partner’s Web site in which the product is presented. The URL must be accessible on the Web by the end user’s browser;

string OriginalDownloadUrl: the URL of the download Web page in the original language on the original EASTIN partner’s Web site in which the product is presented. The URL must be accessible on the Web by the end user’s browser;

string EnglishDownloadUrl: the URL of the download Web page in English on the original EASTIN partner’s Web site in which the product is presented. The URL must be accessible on the Web by the end user’s browser;

string[] UserManualUrls: an array containing the URLs of product’s user manuals; string[] VideoUrls: an array containing the URLs of product’s demo videos; string[] BrochureUrls: an array containing the URLs of product’s brochures; string[] FurtherInfoUrls: an array containing the URLs of other possible information

present on the Web related to the product;

38

Page 39: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

FeatureDto[] Features: an array of FeatureDto objects containing all the EASTIN Taxonomy features (with the measure values if needed) for this product.

SmallActorDto string ActorCode*: the id of the actor in the EASTIN partner’s local database; string OriginalFullName*: the full name of the actor in the original language; string Country*: the country code of the actor in ISO 3166-1-alpha-2 code (for

example “IT”, “US”, etc.); dateTime InsertDate*: the insert date of the actor in the EASTIN partner’s local

database; dateTime LastUpdateDate*: the insert date of the actor in the EASTIN partner’s local

database.

ActorDto string ActorCode*: the id of the actor in the EASTIN partner’s local database; string OriginalFullName*: the full name of the actor in the original language; string Country*: the country code of the actor in ISO 3166-1-alpha-2 code (for

example “IT”, “US”, etc.); dateTime InsertDate*: the insert date of the actor in the EASTIN partner’s local

database; dateTime LastUpdateDate*: the insert date of the actor in the EASTIN partner’s local

database; string ShortName*: the short name of the actor; string EnglishFullName*: the full name of the actor in English; string OriginalDescription: the description of the Actor in the original language; string EnglishDescription: the description of the Actor in English; dateTime StartDate*: the start date of the actor dateTime EndDate: the end date of the actor string ContactBody: the reference organization of the actor; string Address: the address of the actor; string PostalCode: the postal code of the actor; string Town: the town of the actor; string Phone: the phone of the actor; string Fax: the fax of the actor; string Email: the email of the actor; string Skype: the Skype account name of the actor; string WebSiteUrl: the Web site URL of the actor. The URL should be accessible on

the Web by the end user’s browser; string ContactPersonFullName: the complete name of the contact person for the

actor; string OriginalUrl: the URL of the Web page in the original language on the original

EASTIN partner’s Web site in which the actor is presented. The URL must be accessible on the Web by the end user’s browser;

39

Page 40: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

string EnglishUrl: the URL of the Web page in English on the original EASTIN partner’s Web site in which the actor is presented. The URL must be accessible on the Web by the end user’s browser

string[] SocialNetworkUrls: an array of URLs linking to the actor page inside the main social networks (for example Facebook, Twitter, LinkedIn, etc.);

string[] IcfCodes*: the array of all EASTIN ICF classification codes of the actor (for example [“b1”, “d2”]);

string[] IsoCodes*: the array of all ISO classification codes of the actor (for example [“12.22”, “09.03.03”]);

SmallAssociatedInfoDto string AssociatedInfoCode*: the ID of the associated information document in the

EASTIN partner’s local database; string Authors*: a string containing the names (or the initials) of the authors of the

associated information document (this is not an array but a single string); string OriginalTitle*: the original title in the native language of the associated

information document string EnglishTitle*: the English translation of the original title of the associated

information document string OriginalLanguage*: the ISO 639-1 code of the native language of the associated

information document (for example: "en", "it", "de"); dateTime InsertDate*: the insert date of the associated information document in the

EASTIN partner’s local database; dateTime LastUpdateDate*: the last update date of the associated information

document in EASTIN partner’s local database.

AssociatedInfoDto string AssociatedInfoCode*: the ID of the associated information document in the

EASTIN partner’s local database; string Authors*: a string containing the names (or the initials) of the authors of the

associated information document (this is not an array but a single string); string OriginalTitle*: the original title in the native language of the associated

information document string EnglishTitle*: the English translation of the original title of the associated

information document string OriginalLanguage*: the ISO 639-1 code of the native language of the associated

information document (for example: "en", "it", "de"); dateTime InsertDate*: the insert date of the associated information document in the

EASTIN partner’s local database; dateTime LastUpdateDate*: the last update date of the associated information

document in EASTIN partner’s local database integer PublicationYear*: the publication year of the associated information

document;

40

Page 41: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

string PublishingDetails: the publishing details (for example the publishing house) of the associated information document;

string OriginalAbstract: the abstract of the associated information document in the original language;

string EnglishAbstract: the abstract of the associated information document in the original language;

string OriginalUrl: the URL of the Web page in the original language on the original EASTIN partner’s Web site in which the associated information document is presented. The URL must be accessible on the Web by the end user’s browser;

string EnglishUrl: the URL of the Web page in English on the original EASTIN partner’s web site in which the associated information document is presented. The URL must be accessible on the Web by the end user’s browser;

string OriginalDownloadUrl: the URL for the download of the associated information document in the original language;

string EnglishDownloadUrl: the URL for the download of the associated information document in English;

string ImageUrl: the URL of the picture related to the associated information document (used when displaying the detail view of the associated information document in EASTIN Portal). The URL must be accessible on the Web by the end user’s browser;

string[] FurtherInfoUrls: an array containing the URLs of other possible information present on the Web related to the associated information document;

string[] IcfCodes*: the array of all EASTIN ICF classification codes of the associated information document (for example [“b1”, “d2”]);

string[] IsoCodes*: the array of all ISO classification codes of the associated information document (for example [“12.22”, “09.03.03”]);

41

Page 42: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

12 Annex 3 – Specifications for the Output Web ServicesEASTIN Output Web services specs

Version 1.0To provide data retrieved by the EASTIN search engine to the GPII Unified Listing, a specific set of Web Services has been implemented that contains functions to extract data using the EASTIN search engine. These Output Web Services Servers are exposed by the EASTIN search engine and will be accessed by a specific application (Output Web Service Client) aimed at collecting the data retrieved from EASTIN into the GPII Unified Listing database.

The EASTIN output Web Services use the REST protocol and the response is provided in JSON format.

Method FindSmallProductsSmallProductDto[] FindSmallProducts(string isoCodes, string commercialName, string manufacturer, string insertDateMin, string insertDateMax)

This method is used to search for products in the databases of the EASTIN network according to the specified parameters. The method returns an array of “SmallProductDto” including the basic product information (see EASTIN Custom Data Type paragraph for details).

This method can be accessed at the url: http://localhost:50080 /searches/products/list

The template for the input parameters is the following:"/products/list?isoCodes={isoCodes}&commercialName={commercialName}&manufacturer={manufacturer}&insertDateMin={insertDateMin}&insertDateMax={insertDateMax}"

Input parameters: string isoCodes: a string representing the ISO 9999 codes of the products to be

searched. Each code must be written without separators (i.e. 223618, not 22.36.18). Separator among different codes is “-“ (e.g. “223618-223612”).

string commercialName: the whole or a part of the commercial name of the products to be searched;

string manufacturer: the whole or a part of the manufacturer name of the products to be searched;

string insertDateMin: the lower bound for the insert date of the products to be searched. Insert date must be written in the format: “dd-mm-yy hh.mm.ss”

string insertDateMax: the upper bound for the insert date of the products to be searched. Insert date must be written in the format: “dd-mm-yy hh.mm.ss”

42

Page 43: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Returns: SmallProductDto[]: array of SmallProductDto objects, each containing a light set of

information about a product (for a complete description of the SmallProductDto object see EASTIN Custom Data Type paragraph). If no product is found returns a not null SmallProductDto[] array with zero elements.

This method returns an array of objects belonging to the class SmallProductDto. The method implements five different kinds of searches:

6. If the isoCodes string is not void the method searches for all products belonging to the ISO classes passed, using an OR statement. For example if “223618-223612” is the isoCodes string, all products belonging to the 223618 ISO class OR to the 223612 class are returned.

7. If commercialName is not void the method searches a matching between the words contained in the commercialName parameter and the respective data in the EASTIN partner’s local database. Since into the commercialName parameter there could be one or more words, the method must split the words and search inside its database for products whose commercial name contains all these words (even if present as substrings inside of biggest strings). For example if commercialName = “quickie xenon” the method must search for all products whose commercial name contains both words “quickie” AND “xenon”.

8. If manufacturer is not void the method executes the search using the same criteria specified in 2 but applied to products’ manufacturer name.

9. If insertDateMin and insertDateMax are both not null all products whose insert date is included within the interval [insertDateMin, insertDateMax], endpoints included, are returned. These two parameters must be both not null or both null.

If more than one parameter is not void at the same time, the results coming from the matches for each parameter are merged together with an AND logic: only results satisfying the conditions specified for each parameter are returned. If no product is found the method returns a not null SmallProductDto[] array with zero elements.

Method GetProduct

ProductDto GetProduct(string database, string productCode);

This method is used get the detailed description of a specific product in one of the databases of the EASTIN network. The method returns an object belonging to the class “ProductDto” (see EASTIN Custom Data Type paragraph for details).

This method can be accessed at the url: http://localhost:50080 /searches/products/detail/

The template for the input parameters is the following:"/products/detail/{database}/{productCode}"

43

Page 44: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

Input parameters: string database: the name of the database where the product record is

stored string productCode: a string representing the unique ID in the specified

databaseReturns:

ProductDto: an object containing detailed description of a single product. If no product is found a null object is returned.

This method returns an object belonging to the class ProductDto (for a complete description of the ProductDto object see below). The method searches into the EASTIN partner’s local database, specified in the parameter “database”, for the product which has the id matching with the parameter “productCode”. If no product is found the method returns the null object.

EASTIN custom data types

EASTIN Output Web services return custom defined types. A complete description of EASTIN custom defined types follows below. All mandatory fields are marked with a “*” (all the other fields can be considered as nullable). For the array fields in case they are empty a not null array of zero elements is returned.

SmallProductDto: string Database*: the name of the database where the product record comes from string ProductCode*: the id of the product in the partner’s local database IsoNodeDto IsoCodePrimary*: Custom data type (see below) representing the Primary ISO 9999

classification code for the product IsoNodeDto[] IsoCodesOptional: the array of all secondary ISO 9999 classification codes of the product string CommercialName*: the name of the product string ManufacturerOriginalFullName*: the full name in the original language of the product’s

manufacturer DateTime InsertDate*: the insert date of the product; DateTime LastUpdateDate*: the last update date of the product; string ThumbnailImageUrl: the URL of the small format picture of the product (used when displaying

list of products in EASTIN Portal).

ProductDto: string Database*: the name of the database where the product record comes from string ProductCode*: the id of the product in the partner’s local database IsoNodeDto IsoCodePrimary*: Custom data type (see below) representing the Primary ISO 9999

classification code for the product IsoNodeDto[] IsoCodesOptional: the array of all secondary ISO 9999 classification codes of the product string CommercialName*: the name of the product string ManufacturerOriginalFullName*: the full name in the original language of the product’s

manufacturer string ManufacturerAddress: the address of the product’s manufacturer;

44

Page 45: wiki.gpii.net · Web viewThe vocabulary of EASTIN taxonomy is not intended to be static but dynamically changing. New items can in fact be added to the vocabulary (both titles and

Cloud platforms Lead to Open and Universal access for people with Disabilities and for All European Commission, FP7 Project 289016

http://www.cloud4all.info

string ManufacturerPostalCode: the postal code of the product’s manufacturer; string ManufacturerTown: the town of the product’s manufacturer; string ManufacturerCountry*: the country code of the product’s manufacturer according to the two

letter ISO standard 3166-1-alpha-2 code (for example “IT”, “US”, etc.); string ManufacturerPhone: the phone of the product’s manufacturer; string ManufacturerEmail: the email of the product’s manufacturer; string ManufacturerWebSiteUrl : the Web site URL of the product’s manufacturer; DateTime InsertDate*: the insert date of the product; DateTime LastUpdateDate*: the last update date of the product; string ThumbnailImageUrl: the URL of the small format picture of the product (used when displaying

list of products in EASTIN Portal). string ImageUrl the URL of the big format image of the product (used when displaying the detail view

of the product in the EASTIN portal). string EnglishDescription: the description of the product in English; string OriginalUrl: the URL of the Web page in the original language on the original EASTIN partner’s

Web site in which the product is presented. The URL must be accessible on the Web by the end user’s browser;

string EnglishUrl: the URL of the Web page in English on the original EASTIN partner’s Web site in which the product is presented. The URL must be accessible on the Web by the end user’s browser;

FeatureDto[] Features : an array of FeatureDto objects (see the custom data type below) containing the product features according to the EASTIN Taxonomy.

IsoNodeDto string Code: the numeric code of the ISO 9999 item (e.g. “223618”) string Name: the name of the ISO 9999 item (e.g. “Input devices”)

FeatureDto: int FeatureId: the ID of the feature in the ETNA taxonomy string FeatureName: the name of the feature according to the ETNA

taxonomy (e.g. “Weight (Kg)”) string FeatureParentName: the name of the “cluster” the feature belongs

to (e.g. “Overall dimensions”) decimal ValueMin: for features that can have an associated numeric value

(e.g. “Magnification”), is the minimum value of the feature for the specific product

decimal ValueMax: for features that can have an associated numeric value (e.g. “Magnification”), is the maximum value of the feature for the specific product

45