Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 8.97 KB

README-EN.md

File metadata and controls

80 lines (52 loc) · 8.97 KB

RNDT metadata converter

License: EUPL 1.2

>> Italiano

RNDT metadata converter is a reusable solution that allows to query an OGC CSW (Catalog Service for the Web) and transform the metadata records returned, from a former metadata profile to another one revised, as long as both based on ISO Standard TS 19139.

In Italy, from the 2011 Italian metadata profile (aligned with and extending the INSPIRE metadata TG v. 1.3) to 2020 Italian metadata profile (aligned with and extending the INSPIRE metadata TG v. 2.0).

The solution can be used for a stricter transformation of metadata from INSPIRE TG v.1.3 to INSPIRE TG v.2.0 by using the XSLT script for INSPIRE transformation. Also, the XSLT script can be adapted in order to transform metadata records against other (own) metadata profiles.

For further information about the use of the converter see the quick user guide.

A working installation of the converter is available on the RNDT portal.

Specification

RNDT metadata converter makes GetRecords requests using the GET method to query the CSW service and transform the metadata records returned through the XSLT script. The parameters to be used for the requests are included in the table below:

Parameter Description Notes
organisationName The name of the organisation (i.e. public administration) provider of metadata records to be transformed. This parameter can be changed, updating the GetRecords request value in the $defaultGetRequest variable in the file function/config.properties. In such a case, the corresponding label in the form (defined in the file index.php) shall be updated consequently. Be careful that the update of this parameter will affect the name of the compressed (zip) folder, that is the transformation output.
maxRecords number of records that should be returned from the result set of the query and transformed. The maximum number is set to 100, but it can be updated in the $MaxRecords variable in the file function/config.properties. Value must be a positive integer.
startPosition The first record to start querying. Value must be a non-zero positive integer.

The transformation output is a compressed folder (zip) including the following files:

  • ReadMe.txt: a text file with a brief description of the folder content;
  • CSWResponseOLD.xml: the CSW GetRecords response from the catalogue queried, based on the former metadata profile (such as 2011 Italian profile or INSPIRE TG v.1.3);
  • CSWResponseNEW.xml: the CSW GetRecords response from the catalogue queried, based on the new metadata profile (such as 2020 Italian profile or INSPIRE TG v. 2.0), i.e. the response CSWResponseOLD.xml transformed through the XSLT script;
  • MetadataRecords.zip: a compressed folder that includes the individual metadata records transformed.

Installation instructions

RNDT metadata converter is developed in PHP 7.1 and runs on top of any web server hosting that PHP version. The converter has been tested on Linux, Windows and iOS with Apache 2.

The EasyRDF and the ML/JSON-LD PHP libraries are used and are available in the repository.

The repository includes all what is necessary for the installation and running of the converter. Before running it, update the following configuration information:

  • in the file function/config.properties:

    • set the root URL of the CSW service to query in the $defaultSiteCSW variable. This URL must be accessible directly from the calling client;
    • set the root URL to access the CSW server in the $defaultSiteServerCSW variable. This URL must be accessible from the Web server application (i.e. the PHP function); thus if public, it can be the same URL used for the $defaultSiteCSW variable;
    • set the path of the XSLT script (included in the same folder) in the $FileXSLT variable;
    • the CSW GetRecords request in the $defaultGetRequest variable may (but not necessarily required) be customised modifying the queryable (in the default request "apiso.OrganisationName") and/or the comparison operator (in the default request "PropertyIsEqualTo"). In such a case, the corresponding label in the form (defined in the file index.php) shall be updated consequently. Be careful that the update of this parameter will affect the name of the compressed (zip) folder, that is the transformation output.

  • in the file function/function.php:

    • set the URL of the server where the converter is installed as value of the constant PATH_ROOT.

Pay special attention to the file/ folder, that will be initially empty. To add the folder in the repository, the empty file .gitkeep was included in the folder; that file may be removed after the installation. This folder will hold the subfolders containing the results of the query. Be sure that everything inside this folder has the right read/write/execute permissions.

NOTE 1 - publiccode.yml is a metadata file required for the public software developed in Italy and it is not functional to the use of the converter. It is included in the repository to enable the Developers Italia crawler to collect the information for feeding the national open source software catalogue.

NOTE 2 - The images/ folder contains the images used in the wiki and it is not functional to the use of the converter.

NOTE 3 - The default XSLT script included in the function/ folder is based on the Italian metadata profile. An INSPIRE XSLT script is also provided to transform metadata against INSPIRE TGs (see also "Transformation against INSPIRE TGs or other metadata profiles"). Reusers are invited to test that XSLT script and provide any feedback via the issue tracker in order to update and improve it.

English description

The description shown at the top in the converter homepage is in Italian. To show the English version of this description, comment the Italian description and uncomment the English one in the $Description variable in the file function/config.properties. In a future release a wider use of label constants will be adopted.

Transformation against INSPIRE TGs or other metadata profiles

If you want to use the converter for transforming metadata records against the INSPIRE Technical Guidelines (from v. 1.3 to v. 2.0), i.e. without considering the Italian extensions, the INSPIRE XSLT script should be used by copying and pasting it in the function/ folder.

Be aware that:

  • the trasformation refers to metadata records using the English language;
  • if the services are not network services (i.e. serviceType='other'), it is assumed that the service is an invocable spatial data service. If that is not the case, further interventions will be needed to add the missing metadata elements;
  • in any case, manual checks could be needed.

Other XSLT scripts available for transformation either against INSPIRE TGs (see, e.g., GeoNetwork) or against specific national metadata profiles (see, e.g., the list of some national scripts available on GeoNetwork guide) may be used instead of that one provided in the repository.

Finally, the XSLT script provided in the repository may be adapted to other specific metadata profiles.

In any case, the XSLT file is required to be renamed "__Transformation.xslt" and pasted in the function/ folder.

License

The licence applied is European Union Public License v. 1.2.

Credits

The solution is developed by ESRI Italia for AgID under the contract for the SPC National Common Infrastructures.