ESSnet on SDMX ESSnet on SDMX WP3 Functional and Technical Specifications WP: 3 – SDMX Data Express WP Responsible: João Poças Date: 25/11/2009 File: WP3_Functional_and_Technical_Specifications.doc Annex: WP3_Functional_and_Technical_Specifications_AnnexI.doc WP3 – Functional and Technical Specifications Pag. 1/14 ESSnet on SDMX Revision history Version Date Description Author 1.0 28/12/2009 Initial document João Poças 1.5 20/01/2009 Revised João Poças 2.0 25/11/2010 Revised João Poças WP3 – Functional and Technical Specifications Pag. 2/14 ESSnet on SDMX Table of Contents 1. INTRODUCTION .............................................................................................................. 4 1.1. PURPOSE ....................................................................................................................... 4 1.2. PROJECT SCOPE ............................................................................................................ 4 2. OVERALL DESCRIPTION .............................................................................................. 5 2.1. PRODUCT PERSPECTIVE ............................................................................................... 5 2.2. PRODUCT FEATURES .................................................................................................... 7 2.3. OPERATING ENVIRONMENT ......................................................................................... 9 2.4. DESIGN AND IMPLEMENTATION CONSTRAINTS ............................................................ 9 2.5. USER DOCUMENTATION ............................................................................................. 10 3. SYSTEM INTERFACE ................................................................................................... 11 3.1. WEB APPLICATION - SDMX.DX ................................................................................. 11 3.2. WEB SERVICE - SDMX.WS ......................................................................................... 12 3.3. LIBRARY - SDMX.LIB ................................................................................................ 12 4. REFERENCES ................................................................................................................. 13 5. ANNEX I – C# RULES AND NAMING CONVENTIONS .......................................... 14 WP3 – Functional and Technical Specifications Pag. 3/14 ESSnet on SDMX 1. INTRODUCTION 1.1. Purpose This document provides the requirements and functional specifications and also some technical issues fundamental to the development of SDMX Data Express1. SDMX Data Express corresponds to Work Package 3 (WP3), which is part of the project ESSnet on SDMX, and aims to develop a software application that can explore data files in SDMX format. 1.2. Project Scope The main purpose of this WP is to deliver an application that allows the users to visualize SDMX data files under different perspectives and in a user-friendly way. These visualization perspectives includes tabular (html and CSV) and graphic (charts). The user may use any SDMX data file (local or remote) whereas the related DSD (local or remote) is also provided. It will also provide a way to convert among different SDMX data messages formats (generic, cross sectional, compact) and provide an interface to help users to build a SDMX query (based on a given DSD file). Additionally it will be able to build a SDMX query message useful to retrieve data through an URL (invoking a web service, for instance). 1 Previous name “SDMX Data Express” was “SDMX Data Explorer” WP3 – Functional and Technical Specifications Pag. 4/14 ESSnet on SDMX 2. OVERALL DESCRIPTION 2.1. Product Perspective The produced application will be supported by a generic SDMX class library that can be reused in any future SDMX application. Using this generic library, programmers will be able to develop applications that operates SDMX-ML messages (create, read and write any SDMX file) in an easier way. The library will bind SDMX 2.0 standard schemas with .net classes representation, making it easy for .net developers to manipulate SDMX message files in any application (web or stand-alone). This work package will produce the following software products: a) A web application that will allow end-users to explore SDMX data; b) A generic SDMX class library, useful for programmers; c) Some web-services that will allow SDMX messages manipulation (SDMX conversion and schema validation). In the next diagram are represented the main components of the system, with user inputs and outputs expected, to help to understand the conceptual idea of SDMX Data Express. All these components will be discussed with more detail in this document. WP3 – Functional and Technical Specifications Pag. 5/14 ESSnet on SDMX Figure 2-1 – Context diagram for the SDMX Data Express WP3 – Functional and Technical Specifications Pag. 6/14 ESSnet on SDMX 2.2. Product Features SDMX Data Express provides a Graphic User Interface (SDMX.dx) to the common user with the following features: • SDMX Data load User can load an SDMX data file either locally, when the SDMX document is located in his computer, or by using an external URL, if the SDMX data file is located in an internet address. • Data Structure Definition (DSD) load In order to be able to manipulate the loaded SDMX data file, user must provide the corresponding DSD. To achieve this, the user may use a local DSD file, a remote DSD file (URL) or, if the Registry service is available, get the DSD from the Registry. • Tabular view In Tabular view, user may consult the loaded data either in HTML format or Comma Separated Format (CSV), which can be easily read by any Text reader or Spreadsheet application. • Chart view Using Chart view, the user is able to visualize data using a chart. The user can decide what kind of chart is the most convenient for the data (bars, columns or line chart). • Converter The Converter is a function that is able to convert from a SDMX data message format to another. WP3 – Functional and Technical Specifications Pag. 7/14 ESSnet on SDMX • Query builder The Query builder helps user to build a SDMX query message, through a visual interface, using the previously loaded DSD. • Validation After a data and structure files are loaded, user may confirm if the data file is valid. In a similar way, any SDMX query can also be validated. Beside all the previous features, available to any user, SDMX Data Express also provides some extra resources to developers: • SDMX library (SDMX.lib) The SDMX library is responsible for providing methods to manipulate any SDMX document. This library is able to represent, using .net classes, SDMX 2.0 standard schemas and, as a consequence, any SDMX data message file. The functions available to the user (using a graphic user interface) should be produced in this library. • Web Service (SDMX.ws) The web service exposes operations responsible for validation and conversion, of SDMX documents, through http request. WP3 – Functional and Technical Specifications Pag. 8/14 ESSnet on SDMX 2.3. Operating Environment SDMX Data Express will be delivered, primarily, as a web application. It should run on any 32-bits Microsoft Windows operating system but, considering it’s a web application, it’s necessary to have also installed the Internet Information Services (or Internet Information System) to be able to run. The option of having SDMX Data Express delivered as a web application was adopted because it was considered a better way to have this kind of tool available to the user, through a browser, anywhere and anyplace. To achieve this, the SDMX Data Express will be available in a web server over the internet. It should be available in the ESSnet on SDMX web site. In addition, a web service will also be produced and exposed in the same web site. 2.4. Design and implementation constraints • Programming language The programming language adopted for the development of SDMX Data Express is C-Sharp (C#), which is part of Microsoft .Net framework 3.0. In order to assure that all participants will develop the software modules in a similar way, it is recommended to use some C# conventions and rules (see Annex I). • Development Environment As the preferable Integrated Development Environment (IDE), it is proposed to be used the Visual Studio 2008, although Visual Web Developer 2008 Express WP3 – Functional and Technical Specifications Pag. 9/14 ESSnet on SDMX can also be used (this IDE is freely available at Microsoft web site, http://www.microsoft.com/express/vwd/). • Software licence and support All software produced must be developed under European Union Public Licence (EUPL). Although all the software will be delivered as open source the development team will not guarantee to give support to developers or users after the conclusion of this project. • Standards-based SDMX Data Express should comply with established industry standards, like XML, SDMX and HTML. The standards-compliance will not only apply to application development but also to design, platform/infrastructure and other parts of the SDMX Data Express. In terms of web service, cross-platform interoperability should be guaranteed according to the WS-I Basic Profile 1.1 (see http://www.ws-i.org/). 2.5. User documentation Along with the software delivered some documentation will also be produced. This documentation includes user manual and installation guide, but additionally some basic developer guide will also be delivered. WP3 – Functional and Technical Specifications