- SDMX Editor
Contents
1. lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt lnvalid diffusion status code 4 lt MessageText gt lt StatusMessage gt lt TinyRegistry gt 3 1 16 Test Service operation functionality description This operation allows retrieving the version of the Service Name of service operation Test Version optional Grouping optional Behavior Provides service version Preconditions Postconditions The version is returned Errors General access error 3 1 16 1 Test Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status code lt TinyRegistry gt lt StatusMessage status Success gt lt MessageText gt TinyRegistry version 0 9 4 24911 lt MessageT ext gt lt StatusMessage gt www sdmx ch Page 24 38 4 4 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 lt TinyRegistry gt2. www sdmx ch Page 25 38 vs TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 4 Quick evaluation with SAE Editor This chapted describes how to proceed to a quick overview and evaluation of the solution linked to the SAE editor This evaluation allows you to skip the TinyRegistry installation to an IIS application server It allows a simulation of the service on the same machine that holds the SAE Editor Of course for a real usage the service has to be deployed in IIS application server 4 1 Copy SAE Install root dir on your local drive If you intend to use only SAE editor without Repository support you can ignore most of this documentation See only 1 4 SAE Editor configuration 4 2 Install NET runtime 4 2 1 Install Microsoft visual web developer express This will allows running TinyRegistry for quick trial without an IIS installation Note For a real usage the TinyRegistry must be deployed under IIS server environment Get free Visual studio 2008 from http www microsoft com express downloads Run installation 2 Visual Studio 2008 Express Editions Setup Visual Studio Re al GE Bem S cr J Ey isual Basic 2008 a xpress Edition aT y n H Visual Web Developer 2008 D FXPTESS Edition View Readme file Visit the Visual Studio Express Web site to learn more gt Select Visual Web Developer 4 3 Configure TinyRegistry Once dot Net and MS Developer are fully installed run Visual Web Developer
3. Ensures that SupportedLanguages list matches the one in TinyRegistry config If desired you can reconfigure some info on generated header for SDMX documents It is possible to add a direct load from registry for some categories and organisations available through the Categories menu of SAE The screen sample shows a specific usage Leave the 3 values empty if not used at first value Reports the URL copied from the web service page in TinyRegistryUrl Leaves the value empty if you do not intend to use Repository access Save modified file 4 5 Test SAE Editor with Repository access Now Run the Editor and test access to TinyRegistry 1 Selects CodeLists in Tree www sdmx ch Page 31 38 m ee y TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Activate popup menu and selects New Child Fill Detail screen with ID Agencyld and Name Open child node and selects Codes Activate popup menu and selects New Child Fill Detail screen with CodeValue and OfficialTitle Select the codelist you just created if you check IsFinal a validity test against schema is done 8 Choose Menu Repository Submit Artefact to Repository NO OT D koa SAE SdmxML Structure Editor with Tiny registry support V 0 98 En ee qe ie A ee Repository Find Import Export Categories Data Utilities Help LS Define Repository WS source CL_TEST Test SDMX Target SDMX20
4. 1 Introduction This document serves as a technical specification of the repository component of the SAE SDMX ML Editor system The repository is a NET 2 0 web service of the TinyRegistry It must be deployed under Internet Services IIS 5 1 or later It requires Microsoft NET runtime 2 0 or later This service provides all operations required by the SAE Editor in order to manage the metadata artefacts in a centralized manner It is also a distribution point for the SDMX ML artefacts 1 1 RESTful service A RESTful service is also provided It acts as a wrapper on the TinyRegistry It allows consulting SDMX ML documents according to the syntax defined in the SDMX Guidelines for web services April 2011 version 2 1 More detail in paragraph RESTful Web Service description 2 System Context The Application Server IIS contains the TinyRegistry repository service and all artefact documents managed through the web service deployment SAE Overview execution environment Windows Client execution environment us 1 Reads Writes 1 1 SDMX ML Files Actsasa SDMX ML Repository The repository manages structured artefacts by artefact type It supports internationalization and must be configured according to the SAE editor internationalisation subset support A set of languages must be specified when the repository is empty and cannot be changed once it is used All artefacts are organized by artefact Typ
5. e conceptscheme e codelist e hierarchicalcodelist e organisationscheme e dataflow e metadataflow e reportingtaxonomy e structureset e process 5 1 Parameters used for identifying a resource Parameter Type Description agencylD A string compliant with the The agency maintaining the artefact to be SDMX agencylD returned resourcelD A string compliant with the The id of the artefact to be returned SDMX common IDType version A string compliant with the The version of the artefact to be returned SDMX VersionType The parameters mentioned above are specified using the following syntax http ws entry point resource agencylD resourcelD version Furthermore some keywords may be used Keyword Scope Description all agencylD Returns artefacts maintained by any maintenance agency all resourcelD Returns all resources of the type defined by the resource parameter all version Returns all versions of the resource latest version Returns the latest version in production of the resource Note If identifications parameters are missing in the request the key words all all latest are assumed 1 As all is a reserved keyword in the SDMX RESTful API it is recommended not to use it as an identifier for agencies resources or a specific version Default if parameter not specified www sdmx ch Page 34 38 wr ad TINYREGISTRY WEB SERVI
6. With the command Menu File Open Web Site select the TinyRegistry folder www sdmx ch Page 26 38 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 P Start Page Visual Web Developer 2008 Express Edition File Edit View Tools Window Help Oy GF id 4 23 5 w Er EL gt e LE arrLang T Toolbox A X StartPage Custom General There are no usable controls in this group Drag an item onto this text to add it to the toolbox Recent Projects Microsoft Visual Web Developer Express Open Web Site 7 a File System Select the folder you want to open File System ie Artefacts_empty amp Artefacts full amp Editor Less Siti e smx amp Service FTP Site Shape E C2 SQL Server Management Studio p E O T l chargements Remote Site e uss78 amp C2 Visual Studio 2005 amp Visual Studio 2008 Visual Studio 2008Templates Voyages M Poste de travail B lt SYSTEM C iH E 433163b8ba c607d82f7d8af Ia Altova Folder H SAE_SRC SAE_Install SAE TinyRegistry The application signals that the site is configured for NET 2 0 and asks for updating NET Framework 2 0 Web Site Found The Web site H TinyRegistry is configured to run on the NET Framework version 2 0 Do you want to upgrade the Web site to use the NET Framework version 3 5 You can change the target version later by using the Project Properties dialog box
7. pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 elArtefact xml XML element representing a valid SDMX ML document Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status www sdmx ch Page 20 38 wer TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 code lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unable to locate Artefact NSI CL_QUALITY 1 0 in submitted XML Document lt MessageText gt lt StatusMessage gt lt TinyRegistry gt 3 1 14 DeleteArtefact Service operation functionality description This operation allows removing the specified artefact from the repository Caution This will not remove artefacts referred by the targeted artefact It is the responsibility of the user to decide if referenced artefacts must also be removed When Ownership is managed by the service only mem
8. ESTAT CL_FREQ 1 1 lt MessageText gt lt StatusMessage gt lt TinyRegistry gt 3 1 10 GetArtefactBackupList Service operation functionality description This operation retieves the list of all backups for an Artefact This list is embedded as an xml element representing a NET DataSet with its schema Name of service operation GetArtefactBackupList Version optional 1 0 Grouping optional Behavior Returns an Information list of all backups available for an artefact of specified type The list is an XML element with embedded scheme Preconditions The artefact type is supported by service Post conditions Informative no changes in Repository Errors General access error Empty list as empty Dataset 3 1 10 1 GetArtefactBackupList Interface Request Responses synchronous Request Message Parameter name Data type Card Description semantics artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 www sdmx ch Page 16 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Response Message Parameter name Data type Card Description semantics Dataset Dataset as xml The dataset representing the of backup element with matching the specified artefact type embedded schema Error Message Parameter name
9. Get Artefact Reserves Artefact check out Submit Artefact check in _ Age Version VaidFom 2 Valid To DEMO v 10 g amp Submit Aggregated Artefacts to Repository Import Submit selected artefact to repository S E CodeLists CL_TEST Test E Is Final E Is Etemal Ref Is Partial 5 Codes N Description 1 HierarchicalCodelists i ConceptSchemes This is a test for repository storage i Metadata Structure Definitions i Data Structure Definition i a URI Link to resource with additional information ing Taxonomies 1 Processes G DataSet MetadataSet Child Count 1 Total 2 Registry DEMO http localhost 49285 TinyRegistry Repository asmx State Ok 9 Authenticate to Registry Note Authentication sample is automatic and uses window user The tree reflects the saving by displaying a green icon SdmxML Standalone Edito C2 OrganisationSchemes C2 Dataflows C2 Metadataflows C CategorySchemes 1 CodeLists amp CL_TEST Test E Codes HierarchicalCodelists 10 Uses Menu Files Clear All to get an empty tree 11 Activates Menu Repository Get Artefact A dialog box is displayed Activates the List button The list of codelists registered is displayed last one is the newly Only one if you selected Artefacts _empty folder in web service configuration www sdmx ch Page 32 38 x TINY
10. This organization scheme must contain a hierarchical structure of Agencies where the leaves are the different groups owning some NSI artefacts Inside each group the Maintenance contact is required Other collaborators can also be added into the group as other persons for Contact Each person defined as Contact must have his ID filled in together with his MS Window identity name For example for a Window identity of EDI U0021 the ID is filled with U0021 Once defined and used the NSI OrganisationScheme could still be modified by its owners However such modifications should be done with caution i e the existing groups which already posses SDMX artefacts should not be removed from the Agencies hierarchy or their IDs modified It is also required to define one or more administrators for the file repository The administrators are allowed to operate on any artefact such that they could mainatine for example non NSI artefacts the SDMX ML artefacts provided by external to the NSI organisation institutions In order to activate the ownership management the service configuration file must contain values in the following keys lt Support for Ownership managment gt lt add key GroupOrganisationScheme value gt for ex value NSItORG_NSI 1 0 lt add key GroupFullAdministrators value gt for ex value U4578 U3422 The Ownership support is disabled when these values are empty or as long as the GroupOrganisationScheme is n
11. an invalid status message is returned In case of Ownership support this method do not allow to retrieve NO diffusion status artefacts NOTE Fullld AgencyId Id Version GetArtefactBackup NEW Returns in a SDMX Message document the versionned artefact type instance matching the specified full Id In case of error an invalid status message is returned In case of Ownership support this method allows to retrieve NO diffusion artefact for the users of the Agency Group NOTE Fullld AgencyId Id Version indicates versionNumber as backup number GetArtefactBackupList NEW Retieve the list of all backups for an Artefact GetArtefactOS Returns in a SDMX Message document the artefact type instance matching the specified full Id In case of error an invalid status message is returned In case of Ownership support this method allows to retrieve NO diffusion artefact for the users of the Agency Group NOTE Fullld AgencyId Id Version This page displays the list of functionalities available through the TinyRegistry Copy the URL of the web site to update the configuration of the SAE editor in order to access the repository from the editor Now leave always the repository service running before working with the SAE editor www sdmx ch Page 30 38 ee y TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 4 4 Configure SAE Editor Edit he file SAE exe config located in SAE_SRC SAE_In
12. Answers No Selects web config in the solution Explorer Change the SupportedLanguages value if needed Change the ArtefactRootPath value to reflect the root directory for artefacts Select Artefacts_empty folder to start from scratch lt l Path to root directory for artefact repository gt lt add key ArtefactRootPath value C SAE SRC SAE Install SAE Artefacts empty gt Or selects Artefacts_full to uses sample files already registered in repository lt Path to root directory for artefact repository gt lt add key ArtefactRootPath value C SAE SRC SAE Install SAE Artefacts full gt www sdmx ch Page 27 38 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 TinyRegistry Visual Web Developer 2008 Express Edition File Edit View Website Build Debug XML Tools Window Help a Ha guad ca TLN m C dE E aA Lal arrLang a El EEE OO oa Aa Toolbox A X web config Start Page x Solution Explorer vax pat lt xml version 1 0 2 gt al d T R Faos a H TinyRegistry EntityDataSource SDMX Artefact Tiny Repository A repository for SAE Editor LE App_Code DynamicDataManager ii Copyright Ci 2010 Philippe Prati CR App_Data DynamicContral ver Global asax Yalidation 444 This program is free software you can redistribute it a License txt 5 fff it under the terms of the GNU General Public License SmX P
13. Data type Card Description semantics Dataset XML Element The XmlElement contains a nil Dataset 3 1 11 GetArtefactOS Service operation functionality description This operation returns in a SDMX Message document element the artefact type instance matching the specified full Id In case of error an invalid status message is returned In case of Ownership support this method allows to retrieve artefact with NO diffusion status The retrieval is allowed for users that are members of the agency group of the artefact as well as for repository administrator s This operation is used by SAE editor in replacement of the operation GetArtefact The SAE editor when retrieving an artefact checks the references to others artefacts contained in the artefact and makes the subsequent calls to load the referred information Name of service operation GetArtefact Version optional Grouping optional Behavior Returns a SDMX Message document element containing the specified artefact information Preconditions The artefact type is supported The artefact exists in repository If the artefact has NO Diffusion status the user must be a repositora administrator or a member of the artefact agency group only in case of ownership support Postconditions Informativ no changes in Repository Errors General access error Invalid artefact type Artefact does not exist Unauthorized user according
14. Page i Full Path Exclude From Project cut You can now run the Service ual Web Developer 2008 Express Edition Build Debug XML Tools Start Page web config Domes x we You should have received a copy of the GNU Gen 4 along with this program If not see lt http eee Z The following page should be displayed dynamically select an available port www sdmx ch Page 29 38 ee i TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 F SST CESSER TEEN EU PPT TU Fichier Edition Affichage Historique Marque pages Outils 2 4 _ Repository Service Web YE Plie Repository foal Les op rations suivantes sont prises en charge Pour une d finition formelle prenez connaissance de la Description du service BackupAutomaticEnable NEW Indicates option value for Backup automatic on WS side CheckOut Reserves specified artefact for user with indicated Windows Identity DeleteArtefact Deletes selected artefact event if currently checked out a ia Dirinfo Returns an Information list of all artefacts of specified type The list is an XML document with embedded scheme ExistArtefact Returns a Success status if an artefact of specified type holds the given fullld parameter GetArtefact Returns in a SDMX Message document the artefact type instance matching the specified full Id In case of error
15. code list lt structure Name gt lt structure CodeList gt lt structure CodeList id CL_AREAS version 1 0 isExternalReference true agencyID ECB gt lt structure Name xml lang en gt Areas code list lt structure Name gt lt structure CodeList gt lt structure CodeList id CL_COUNTRIES version 1 0 isExternalReference true agencyID ECB gt lt structure Name xml lang en gt Countries code list lt structure Name gt lt structure CodeList gt lt structure CodeList id CL_COUNTRY version 1 0 isExternalReference true agencyID ESTAT gt lt structure Name xml lang en gt Codelist country lt structure Name gt lt structure Name xml e gt Wertebereich Lander lt structure Name gt lt structure Name xml gt Domaine de valeurs pays lt structure Name gt lt structure Name xml it gt Settore di valori paesi lt structure Name gt lt structure CodeList gt lt structure CodeList id CL_DECI version 1 0 isExternalReference true agencyID ESTAT gt lt structure Name xml lang en gt Codelist Decimals lt structure Name gt lt structure Name xml lang de gt Wertebereich Dezimal lt structure Name gt ectrictiura Nama vmb lann fr Nnmaina da valaure ddcimalac ctriictiira Narma e All codelists of SDMX agency with all versions complet http edixp1695 edi intra admin ch Restful codelist SDMX all all e All codelists of SDMX agency with all versions e
16. metadata SAMPLE value ownership value NSI ORG NSI 1 0 The value must match the Full Id of the organisationScheme lt configuration gt lt add Optional lt appSettings gt key GroupFullAdministrators Must be filled for using value Ownership support It consists of the list of user ID separated by a semi column SAMPLE value These will be the repository value U4578 U0021 administrators lt configuration gt lt add key AutomaticBackup Indicates if backup on already lt appSettings gt value False gt submitted artifact is done automatically or on user demand only Default is on demand false lt configuration gt lt add key SlidingBackupSize The backup is incremental on lt appSettings gt value 5 gt each artifact This parameter indicates the number of backup that are conserved in sliding history 3 Web Service description This chapter describes the SOAP WebService offered by the Tiny Registry system in details and defines its functionality its parameters etc www sdmx ch Page 5 38 4 ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Note The Service URI given in the following documentation is based on an IT implementation It can differ according to your specific publication of the service Currently the following Service Operations are being offered BackupAutomaticEnable CheckOut DeleteArtefact Dirlnfo ExistArtefact GetArtefact GetArtefactBac
17. must be reserved by the user before it can be submitted for an update When ownership support is activ only users members of the agency group of the artefact can submit update of the artefact It is always possible for repositoty administrator to submit artefacts The SDMX ML document must contain the artefact type and Identification that is given in request parameters It is allowed to submit document that contains others artefacts but they can only be retrieved as a whole through the id used in request parameter Name of service operation SubmitArtefact Version optional Grouping optional Behavior Submits a new artefact to registry or updates existing one if checked out by same user Preconditions The artefact type is supported The artefact exists in the submitted SDMX ML document www sdmx ch Page 18 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 In case of update the artefact is already checked out In case of update the user is member of the agency group of the artefact Postconditions Informativ no changes in Repository Errors General access error Invalid artefact type Artefact is not reserved checked out Unauthorized user according to artefact agencyld in case of ownership support 3 1 12 1 SubmitArtefact Interface Request Responces synchronous Request Message Parameter name Data type Card Desc
18. to artefact agencyld in case of ownership support 3 1 11 1 GetArtefactOS Interface Request Responces synchronous www sdmx ch Page 17 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Request Message Parameter name Data type Card Description semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 Response Message Parameter name Data type Card Description semantics SDMX ML SDMX ML The SDMX ML containing requested artefact document as The document contains others artefacts in case XML Element of aggregated document Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unknown Artefact ESTAT CL_FREQ 1 1 lt MessageT ext gt lt StatusMessage gt lt TinyRegistry gt 3 1 12 SubmitArtefact Service operation functionality description This operation stores a new SDMX ML document containing the artefact specified in the request parameters If the artefact is already present in the repository it
19. 695 edi intra admin ch Restful codelist or e http edixp1695 edi intra admin ch Restful codelist all all all or e http edixp1695 edi intra admin ch Restful codelist all all all deta il allstubs Answer sample w amp http ffedixp1695 edi intra admin ch REstful codelist gt 6 mm Page Of Outils a lt Structure xmins http www SDMX org resources SDMXML schemas v2_0 message xmlins common http www SDMX org resources SDMXML schemas v2_0 common xmins structure http www SDMX org resources SDMXML schemas v2_0 structure mins utility http www SDMX org resources SDMXML schemas v2_0 utility xmins xsi http www w3 org 2001 XMLSchema instance xsi schemaLocation http www SDMX org resources SDMXML schemas v2_0 message SDMXMessage xsd gt lt Header gt lt ID gt a7017cd4 ef4d 4c2e 97e2 6a91b8d81b50 lt 1D gt lt Test gt false lt Test gt lt Name gt SMS FMR SAE lt Name gt lt Prepared gt 2011 07 047T16 19 09 00 00 lt Prepared gt lt Sender id SAE gt lt Name gt SMS FMR lt Name gt lt Contact gt lt Name gt Prati Philippe lt Name gt lt Department gt SMS_FMR lt Department gt lt Telephone gt 41 32 863 14 30 lt Telephone gt lt Fax gt lt Fax gt lt Contact gt lt Sender gt lt Header gt lt CodeLists gt lt structure CodeList id CL_AREA_EE version 1 0 isExternalReference true agencyID ESTAT gt lt structure Name xml lang en gt Area
20. CES REPOSITORY V 1 0 1 5 2 Parameters used to further describe the desired results Param tre de Type Description D faut query detail String This attribute specifies the desired amount of full information to be returned For example it is possible to instruct the web service to return only basic Except if key information about the maintainable artefact i e id word all for agency id version and name id and agency id Possibles values are In this last case e allstubs tout est ramen comme stub allstubs is e referencestubs tous les art facts usedias GEAL r f renc s par l artefact demand seront en stub e full tout le d tail est ramen pour tous les artefacts references String This attribute instructs the web service to return or none not the artefacts referenced by the artefact to be returned for example the code lists and concepts used by the data structure definition matching the query Supported values aret e none no referenced artefact returned e children direct references e descendants r f rences de r f rences www sdmx ch Page 35 38 ve TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 5 3 Request samples Samples are based to the protocol edixo1695 edi intra admin ch It has to be changed according to your NSI installation of the Rest service e All codelists of all agencies with all versions in stub http edixp1
21. REGISTRY WEB SERVICES REPOSITORY V 1 0 1 Get Artefact From SMS Filter Artefact Type Agencyld Version CodeLists AND v y DRE E List X Delete Check Out Import Version Agency ValidFrom ValidTo Name Is Final Diffusion Last mod Updated By 12 Double click on it to retrieve it on editor or Activate button Check Out to reserve it for your usage In this case you can the place your updated version in Repository with Menu Export Submit Artefact to Repository 13 For more details on SAE Editor see User manual in Editor SMS directory or in Editor itself Menu jos User Manual Documentation SMS gt Documentation SDMX Send Feed back About www sdmx ch Page 33 38 wr ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 5 RESTful Web Service description In April 2011 the SDMX community published a new version of Guidelines for use of web services This version documents the implementation of services based on REST Representational State Transfer The documentation is for the version 2 1 of SDMX standard This RESTful wrapper is based on this documentation but works currently with SDMX 2 0 artefacts managed in TinyRegistry The actual version provides the following ressources These are ressources of Structural Metadata Queries e datastructure e metadatastructure e categoryscheme
22. age 13 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 msdata UseCurrentLocale true gt lt xs complexType gt lt xs choice minOccurs 0 maxOccurs unbounded gt lt xs element name CodeLists gt Error Message Parameter name Data type Card Description semantics Dataset XML Element The XmlElement contains an empty Dataset 3 1 8 GetArtefact Service operation functionality description This operation returns in a SDMX Message document element the artefact type instance matching the specified full Id In case of error an invalid status message is returned Caution In case of Ownership support this method does not allow to retrieve artefact with a NO diffusion status This operation is not used by associated SAE editor instead it uses the GetArtefactOS operation Name of service operation GetArtefact Version optional Grouping optional Behavior Returns a SDMX Message document element containing the specified artefact information Preconditions The artefact type is supported The artefact exists in repository The artefact does not have a NO Diffusion status only in case of ownership support Postconditions Informativ no changes in Repository Errors General access error Invalid artefact type Artefact does not exist 3 1 8 1 GetArtefact Interface Request Responces synchronou
23. antics StatusMessage XML Element The XmlElement contains a Sucess status code lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unable to locate Artefact NSI CL_QUALITY 1 0 in submitted XML Document lt MessageT ext gt lt StatusMessage gt lt TinyRegistry gt 3 1 15 SetDisseminationStatus Service operation functionality description This operation allows updating the dissemination status associated to artefacts managed in repository By default an artefact that is submitted in repository holds the Internal status www sdmx ch Page 22 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 With this operation it is possible to modify the status Availables statuses are 0 No diffusion 1 Public 2 Internal When Ownership is managed by the service artefact with NO diffusion can only be accessed by the users of the agency group that owns the artefact or by repository administrators In this case it is also only the Maintenance contact of the group that is allowed to modify the status associated to the artefact or the repository administrator s Name of service operation SetDisseminationS
24. at artefact must be reserved by the user before it can be submitted for an update When ownership support is activ only users members of the agency group of the artefact can submit update of the artefact It is always possible for repositoty administrator to submit artefacts The SDMX ML document must contain the artefact type and Identification that is given in request parameters It is allowed to submit document that contains others artefacts but they can only be retrieved as a whole through the id used in request parameter Name of service operation SubmitArtefact Version optional Grouping optional Behavior Submits a new artefact to registry or updates existing one if checked out by same user Preconditions The artefact type is supported The artefact exists in the submitted SDMX ML document In case of update the artefact is already checked out In case of update the user is member of the agency group of the artefact Postconditions Informativ no changes in Repository A backup is created with previous document content Errors General access error Invalid artefact type Artefact is not reserved checked out Unauthorized user according to artefact agencyld in case of ownership support 3 1 13 1 SubmitArtefactBackup Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics user string Windows Identity
25. bers of the artefact agency group or repository administrator s can remove the artefact Name of service operation DeleteArtefact Version optional Grouping optional Behavior Deletes selected artefact event if currently checked out Preconditions The artefact type is supported The artefact exists in repository In case of ownership management the user is the maintenance contact of the agency group Postconditions The status associated to the artefact is updated Errors General access error Invalid artefact type Artefact is not part of repository Unauthorized user according to artefact agencyld in case of ownership support www sdmx ch Page 21 38 wr 4 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 3 1 14 1 DeleteArtefact Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact type fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 diffusionCd string A one character string representing the number coding the status 0 No 1 Public 2 Internal Response Message Parameter name Data type Card Description sem
26. de and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unknown Artefact ESTAT CL_FREQ 1 1 lt MessageText gt lt StatusMessage gt lt TinyRegistry gt 3 1 5 UndoCheckOut Service operation functionality description This operation cancels any previously reservation done on the specified artefact It is not an error to operate on anon reserved artefact Name of service operation UndoCheckout Version optional Grouping optional Behavior Cancel Reservation by user on specified artefact Preconditions The artefact exists in repository www sdmx ch Page 10 38 we ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 The artefact was reserved by same user The user is part of the agency group that owns the artefact only in case of ownership support Postconditions The artefact is no more reserved The service keeps track of cancelled reservation Errors General access error Invalid artefact type Artefact does not exist Unauthorized user according to artefact agencyld in case of ownership support 3 1 5 1 UndoCheckOut Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in t
27. e defined in the Contact Others area 12 Each person of the group must have its ID matching its MS Windows user identity For example mediaRoomiprati has the ID defined as prati 13 Only the Group administrator maintenance contact is allowed to change the diffusion status of an artefact owned by the group 14 When Group Ownership support is activated the web service method GetArtefact will not provides artefacts with a no diffusion status set 15 A web service method GetArtefactOS is provided to allow owners of a non diffused artefact to access it in reading mode 16 From 1 0 An incremental backup mechanism is provided for each artifact 3 1 4 CheckOut Service operation functionality description CheckOut is part of the lock unlock mechanism available for modifying artefacts already present in the registry It is provided in order to avoid that different users operate on the same artefact in same time CheckOut is the operation of reservation of an artefact by a specific Windows user The unlock is automatically done when the user submit the updated artefact document or if the user invoke the UndoCheckOut operation Name of service operation Checkout Version optional Grouping optional Behavior Reserves lock the specified artefact for the user with indicated Windows Identity Only this user can then modifiy or unlock the specified artefact Preconditio
28. e in file structure under a root directory which is specified in the configuration file Write amp create permissions for the web service access should be specified for the root directory which contains all artefact documents This directory is also specified in the web config file of the repository 2 1 Demonstration passwords For this www sdmx ch distribution the operations password is always fixed at 44533231702B32 SAE user Password is now removed www sdmx ch Page 4 38 wr gt TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 2 2 TinyRegistry configuration file The XML file named web config is used to parametrize the TinyRegistry Services Location Tag Description lt configuration gt lt add key ArtefactRootPath The directory root path under lt appSettings gt value which all types of managed artefacts will be located SAMPLE value A sub directory exists for each value C SAE SRC type of artefact Artefacts full See the samples directories Artefacts_fullor artefacts empty lt configuration gt lt add key SupportedLanguages Defines the set of supported lt appSettings gt value languages It must match the set defined in SAE Editor SAMPLE value value en de fr it lt configuration gt lt add Optional lt appSettings gt key GroupOrganisationScheme Is filled with the NSI organization value scheme including NSI owners groups for managing
29. he service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status code lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unknown Artefact ESTAT CL_FREQ 1 1 lt MessageText gt lt StatusMessage gt lt TinyRegistry gt www sdmx ch Page 11 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 3 1 6 ExistArtefact Service operation functionality description This operation allows interrogating repository about existance of an artefact of a specified type Name of service operation ExistArtefact Version optional Grouping optional Behavior Returns a Success status if an artefact of specified type holds the given full Id parameter Preconditions The artefact exists in repository Postconditions Informativ no changes in Repository Errors General access error Invalid artefact type Warning A
30. kup GetArtefactBackupList GetArtefactOS IsAdministrator SetDisseminationStatus SubmitArtefact SubmitArtefactBackup Test UndoCheckOut www sdmx ch Page 6 38 wr ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 3 1 Repository 3 1 1 Distinct Service Identification Service Name TinyRegistry Repository Service Version 1 0 0 Service functionality This service provides all the operations required to manage the repository of SDMX ML artefacts documents Service functionality Version 1 0 0 Service URI To be defined in your NSI Sample http SAE MyNSl TinyRegistry Repository asmx 3 1 2 Detailed functionality description The Repository service manages SDMX ML artefacts Each artefact is identified by its full id That is Agency ID Artefact ID Artefact Version All artefacts are managed into the predefined root directory as specified in the web config of the service Each type of artefact e g Codelists ConceptSchemes MSD etc is located under a sub directory named after the artefact type Generally an SDMX ML document contains only the identified artefact However it is also possible to manage aggregated SDMX ML artefacts in packages In such case the set of artefacts present in the document can only be retrieved as a package identified by the artefact s full ID which is defined selected during the first submission of the agregated SDMX ML document The a
31. n stubs http edixp1695 edi intra admin ch Restful codelist SDMX all all det aii allstubs e All codelists of ESTAT agency but only last version and as stubs http edixp1695 edi intra admin ch Restful codelist ESTAT all latest detail allstubs e Detail of Hierarchicalcodelist HCL SAMPLE of ESTAT in version 2 with d tail of referred codelists http edixp1695 edi intra admin ch Restful hierarchicalcodelist ESTA T HCL SAMPLE 2 0 references children www sdmx ch Page 36 38 wr ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 e All concept schemes of all agencies with all versions in stub http edixp1695 edi intra admin ch Restful conceptscheme NOTE If some SDMX document are saved in TinyRegistry as aggregated documents The content returned is complete even with option detail referencestubs is used 5 4 Installation of REST service deployment RESTful deploy 7 execution environment NSI Serveur device IIS 6 0 RESTful services SDMX ML TinyRegistry Web Services AE manage l Repository http ws entry point Restful notes Query URN SDMX ML Artefacts execution environment NSI PC web browser or other tool Retrieve structural metadata maintainable artefacts via HTTP GET Using a combination Id agencyld and version with some options 5 41 Configuration file The Restful directo
32. ns The artefact exists in repository The artefact is not already reserved by some other user The user is part of the agency group that owns the artefact only in case of ownership support Postconditions The artefact is reserved for specified Window identity The service keeps track of date and identity of reservation Errors General access error Invalid artefact type Artefact does not exist Artefact already reserved Unauthorized user according to artefact agencyld in case of ownership support www sdmx ch Page 9 38 wer 4 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 3 1 4 1 CheckOut Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status code lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status co
33. orter it the Free Software Foundation either version 2 of the Dynamicvalidator ii at your option any later version Custom fie EEE This program is distributed in the hope that it will k ii but WITHOUT ANY WARRANTY without even the implied war There are no usable controls in ii MERCHANTABILITY or FITNESS FOR PARTICULAR PURPOSE Reg eg fem oio 44 GNU General Public License for more details toolbox fee 444 You should have received a copy of the GNU General Puk jit along with this program If not see lt http www qnu 44 4 Contact ph prati bluewin ch Les lt configuration gt 4 lt appSettings gt lt Set of languages must match the a a in SAE Edi lt add key SupportedLanguages valui lt Path to root directory for art a pe gt lt add key ArtefactRootPath value C rtefacts full gt vi lt i al njde fr it Properties wh Xe Li est Encoding Unicode UTF 8 Output ee a ai x Output z Schemas C Program Files oa Show output from rfl tly EX el Stylesheet Now indicates to the web service to uses always the same port number Selects TinyRegistry in the solution Explorer Change the Use dynamic ports value to false www sdmx ch Page 28 38 w TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 TinyRegistry 2 Visual Web Developer 2008 Express Edition File Edit View Website Build Debug Tools Wind
34. ot submitted to the repository Requirements for ownership support Request Description 1 The support for management of Group Ownership can be activated in the configuration file of the TinyRegistry services The Repository administrators can manage every metadata of the Repository The Repository administrators are defined in the configuration file of the TinyRegistry services 4 It is required to have at least one repository administrator 5 Only Repository administrator can manage non NSI artefacts 6 The Full ID of the Organization Scheme where Ownership Agencies Groups and Users are defined is specified in the configuration file of TinyRegistry services www sdmx ch Page 8 38 wr x TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 7 As long as this Organization Scheme is not present in the repository the service acts as if group ownership support is deactivated 8 When the content of this organization scheme is updated the service takes care of the modifications 9 NSI Metadata owner Groups are defined in the OrganisationScheme Agency as leaves of the Agency Hierarchy 10 NSI Metadata owners are defined in the Organisation Agency Group Contacts area of the Organization Scheme 11 The Group administrator of the group is defined as the Maintenance contact of the group It is required for defining an owner group Others members of the group ar
35. ou should see the middle section of the text in the box change from to the full file path This should now make the OK button active 5 43 The IIS 6 0 version NET 2 0 The fix for IIS 6 0 is to add a WildCard ISAPI Filter handler for the site in question That is 1 Open IIS right click and select Properties for your site 2 Click on Home Directory 3 Click on the Configuration button 4 Add a WildCard application map to the bottom window a Click Insert b Browse to windows microsoft net framework your version c Add aspnet_isapi dll d Make sure Verify that file exists is UNchecked 5 Save everything 6 RESTART IIS lt important www sdmx ch Page 38 38
36. ow Help arrLang Start Page lt xml version 1 0 gt A lt EntityDataSource SDHX Artefact Tiny Repository A repository for SAE E EE DynamicDataManager dii Copyright C 2010 Philippe Prati gy DynamicControl tee E Validatios 444 This program is free software you can redistr z 4 it under the terms of the GNU General Public L Paneer 44 the Free Software Foundation either version 2 DynamicValidator fi at your option any later version Custom O OZ oOo fee 444 This program is distributed in the hope that i 44 but WITHOUT ANY WARRANTY without even the imp There are no usable controls in 444 MERCHANTABILITY or FITNESS FOR PARTICULAR PU RE groun Oe it GNU General Public License for more details M toolbox Emmen 44 App_Data Global asax B License txt 2 Repository asmx E web config Lo Beans Explorer Za Database Explorer Developer Web Server Always Start When C True Full Path Use dynamic ports Enable the ASP NET Development Server to Toolbox Manage Styles B Error List Output EA Fnd Results 1 Indicates Repository asmx as the start page TinyRegistry CS App_Code 24 App_Data Global asax License txt Open Open With View Code View Markup View in Browser Browse With gt Set As Start Page E Build
37. ription semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 elArtefact xml XML element representing a valid SDMX ML document Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status code lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unable to locate Artefact NSI CL_QUALITY 1 0 in submitted XML Document lt MessageText gt lt StatusMessage gt lt TinyRegistry gt www sdmx ch Page 19 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 3 1 13 SubmitArtefactBackup Service operation functionality description This operation stores a new SDMX ML document containing the artefact specified in the request parameters If the artefact is already present in the repository it is copied as a backup file with incremental number before the submitted artifact Note th
38. rmation Preconditions The artefact type is supported The artefact exists in repository The specified artefact backup exists Postconditions Informativ no changes in Repository Errors General access error Invalid artefact type Artefact does not exist 3 1 9 1 GetArtefactBackup Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version www sdmx ch Page 15 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Ex ESTAT CL_FREQ 1 0 VersionNumber Incremental backup number desired Response Message Parameter name Data type Card Description semantics SDMX ML SDMX ML The SDMX ML containing requested artifact in document as its backup state The document contains others XML Element artefacts in case of aggregated document Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unknown Artefact
39. rtatus Version optional Grouping optional Behavior Defines Dissemination status for artefact 0 NO 1 Public 2 Intern Preconditions The artefact type is supported The artefact exists in repository The status code is valid In case of ownership management the user is the maintenance contact of the agency group Postconditions The status associated to the artefact is updated Errors General access error Invalid artefact type Invalid status code Artefact is not part of repository Unauthorized user according to artefact agencyld in case of ownership support 3 1 15 1 SetDisseminationStatus Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics user string Windows Identity pwd string Valid Password according to authorization mechanism implemented in service artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 diffusionCd string A one character string representing the number coding the status 0 No 1 Public 2 Internal Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status code www sdmx ch Page 23 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1
40. rtefact does not exist As Warning 3 1 6 1 ExistArtefact Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 Response Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a Sucess status code lt TinyRegistry gt lt StatusMessage status Success gt k TinyRegistry gt Warning Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a warning status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Warning gt lt MessageText Unknown Artefact codelists ESTAT CL_FREQ 1 1 lt MessageText gt lt StatusMessage gt lt TinyRegistry gt www sdmx ch Page 12 38 wer 4 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Invalid Artefact Type Survey lt MessageText gt lt StatusMessage g
41. rtefact types supported by the service are identified by the following strings OrganisationSchemes Dataflows Metadataflows CategorySchemes CodeLists HierarchicalCodelists Concepts MetadataStructureDefinitions KeyFamilies StructureSets ReportingTaxonomies Processes 3 1 2 1 Maintained informations The service maintains a set of information about each artefact INFO Comment Sample ID Artefact ID CL_FREQ Al Artefact Agency ID SDMX VER Artefact Version 1 0 VF Artefact valid from 2010 01 01 VT Artefact valid to 2010 12 31 Name_xx Artefact name in each supported language Code list for Frequency one tag per language The set of supported www sdmx ch Page 7 38 wr x TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 languages is specified in the service web configuration file IF Artefact is Final or not true LU Last update in repository YYYY MM DD 2010 07 01 UB Last update By Windows Identity Name mediaRoom prati CO Check out Reserved by Windows Identity Name EDI U67878 CA Check out in repository at YYYY MM DD 2010 07 12 DI informative the default is Intern 2 Diffusion Status available codes 0 No 1 Public 2 Intern 3 1 3 Optional Ownership management The service can optionally manage the artefacts ownership inside your NSI organization In this case you must provide an OrganisationScheme document to the service
42. ry is installed in IIS The web config file in the restful directory has to be modified to access the NSI deployed TinyRegistry The set of languages has to match the one defined in TinyRegistry config The resful main directory name used must also be correctly specified lt appSettings gt lt add key TinyRegistryUrl value http localhost 3490 TinyRegistry Repository asmx gt lt add key TinyRegistryVers value 44533231702B32 gt lt Set of languages used gt lt add key SupportedLanguages value en de fr it gt lt add key RestDir value Restful gt www sdmx ch Page 37 38 LE TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 lt Header default information in SDMX ML document gt The Rest service has been installed on IIS 5 1 and 6 0 with anonymous connexion The configuration procedures are slightly different 5 4 2 The IIS 5 1 version NET 2 0 It requires the following steps e Open the website properties in IIS e Select the Home tab e Click the Configuration button e In new window select the Mappings tab e Click the Add button e In new window s executable field Browse to the ASP NET ISAPI DLL usually something like CAWINDOWS Microsoft NET Framework v2 0 50727 aspnet_isapi dll e Inthe Extension field type dot star e Unclick the Check that file exists box and click OK N B There is a bug that if your OK button is not active you need to click the executable field text box y
43. s Request Message Parameter name Data type Card Description semantics artType string A string matching one of the supported Artefact types fullld string AgencylD Artefact ID Artefact Version Ex ESTAT CL_FREQ 1 0 www sdmx ch Page 14 38 wer ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 Response Message Parameter name Data type Card Description semantics SDMX ML SDMX ML The SDMX ML containing requested artefact document as The document contains others artefacts in case XML Element of aggregated document Error Message Parameter name Data type Card Description semantics StatusMessage XML Element The XmlElement contains a failure status code and an explanatory message lt TinyRegistry gt lt StatusMessage status Failure gt lt MessageText gt Unknown Artefact ESTAT CL_FREQ 1 1 lt MessageText gt lt StatusMessage gt lt TinyRegistry gt 3 1 9 GetArtefactBackup Service operation functionality description This operation returns in a SDMX Message document element the required backup of the artefact type instance matching the specified full Id In case of error an invalid status message is returned Name of service operation GetArtefact Version optional Grouping optional Behavior Returns a SDMX Message document element containing the specified backup version of artefact info
44. stall SAE Editor SAE exe config web config A lt configSections gt lt appSettings gt lt Set of languages used gt lt add key SupportedLanguages vers amp eniaertese 5 oredr information in SDMX ML document gt lt add tructureHeaderIsTest value false gt lt add key StructureHeaderMsgName value SMS Metadata gt lt add key StructureHeaderContactName value FMR gt lt add key StructureHeaderContactDept value Couvet gt lt add key StructureHeaderContactInfoTel value 41 32 863 14 30 gt lt add key StructureHeaderContactinfoFax value gt lt add key StructureHeaderSenderld value SMS gt lt add key StructureHeaderSenderName value SAE gt lt Help Doc sub directories gt lt add key DocSdmx value sdmx gt lt add key DocSms value sms gt lt Categories display type gt lt add key CategoryFullidDisplay value true gt lt add key ProcessStepFullIdDisplay value true gt lt Artefacts to load through TinyRegistry inside ivegories Nena D lt add key HarmoOrganisation value NSI ORG NSI 1 0 ESTAT ORG ESTAT 1 0 gt lt add key HarmoNomenclature value gt lt add key HarmoActivity value NSI CAT STAT ACTIVITIES 1 0 gt lt TinyRegistry repository access URL D lt add key TinyRegistryUrl Ql lt add key TinyRegistryVers value 44 lt appSettings gt lt startup gt m 5
45. t lt TinyRegistry gt 3 1 7 DirInfo Service operation functionality description This operation provides the list of managed artefacts of the specified type The list contains all the items of the maintained information This list is embedded as an xml element representing a NET DataSet with its schema Name of service operation Dirlnfo Version optional Grouping optional Behavior Returns an Information list of all artefacts of specified type The list is an XML element with embedded scheme Preconditions The artefact type is supported by service Postconditions Informativ no changes in Repository Errors General access error Invalid artefact type as empty Dataset 3 1 7 1 Dirlnfo Interface Request Responces synchronous Request Message Parameter name Data type Card Description semantics artType string A string matching one of the supported Artefact types Response Message Parameter name Data type Card Description semantics Dataset Dataset as xml The dataset representing the list with an element with element matching the specified artefact type embedded schema lt DataSet xmins http fmr sms sae ch gt lt xs schema id NewDataSet xmins xmins xs http www w3 org 2001 XMLSche ma xmins msdata urn schemas microsoft com xml msdata gt lt xs element name NewDataSet msdata lsDataSet true www sdmx ch P
46. tion 12 3 1 7 Dirinfo Service operation functionality description 13 3 1 8 GetArtefact Service operation functionality description 14 3 1 9 GetArtefactBackup Service operation functionality description 15 3 1 10 GetArtefactBackupList Service operation functionality description 16 3 1 11 GetArtefactOS Service operation functionality description 17 3 1 12 SubmitArtefact Service operation functionality description 18 3 1 13 SubmitArtefactBackup Service operation functionality description 20 3 1 14 DeleteArtefact Service operation functionality description 21 3 1 15 SetDisseminationStatus Service operation functionality description 22 3 1 16 Test Service operation functionality description 24 4 QUICK EVALUATION WITH SAE EDITOR 26 4 1 Copy SAE Install root dir on your local drive 26 4 2 Install NET runtime 26 4 2 1 Install Microsoft visual web developer express 26 4 3 Configure TinyRegistry 26 44 Configure SAE Editor 31 4 5 Test SAE Editor with Repository access 31 5 RESTFUL WEB SERVICE DESCRIPTION 34 www sdmx ch Page 2 38 vs TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 5 1 Parameters used for identifying a resource 34 5 2 Parameters used to further describe the desired results 35 5 3 Request samples 36 5 4 Installation of REST service 37 54 1 Configuration file 37 5 4 2 The IIS 5 1 version NET 2 0 38 5 4 3 The IIS 6 0 version NET 2 0 38 www sdmx ch Page 3 38 wr 4 TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1
47. wr ad TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 TinyRegistry Repository Service Guide V 1 0 1 ii Copyright C 2010 2011 Philippe Prati hy iT This program is free software you can redistribute it and or modify it under the terms of the GNU General Public License as published by aA the Free Software Foundation either version 3 of the License or Fi at your option any later version a This program is distributed in the hope that it will be useful but WITHOUT ANY WARRANTY without even the implied warranty of Le MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE See the 1d GNU General Public License for more details You should have received a copy of the GNU General Public License a along with this program If not see lt http www gnu org licenses gt lad Contact sdmx nextsoft ch Download http www sdmx ch www sdmx ch Page 1 38 wr TINYREGISTRY WEB SERVICES REPOSITORY V 1 0 1 0 Table 0 TABLE 2 1 INTRODUCTION 4 1 1 RESTful service 4 2 SYSTEM CONTEXT 4 2 1 Demonstration passwords 4 2 2 TinyRegistry configuration file 5 3 WEB SERVICE DESCRIPTION 5 3 1 Repository 7 3 1 1 Distinct Service Identification 7 3 1 2 Detailed functionality description 7 3 1 3 Optional Ownership management 8 3 1 4 CheckOut Service operation functionality description 9 3 1 5 UndoCheckOut Service operation functionality description 10 3 1 6 ExistArtefact Service operation functionality descrip
Download Pdf Manuals
Related Search