The Atom Syndication Format (Atom) is an XML language used for web feeds to publish content. In the case of INSPIRE, it can be used with data services to publish Predefined Dataset Download Service in addition to, or alternatively to, INSPIRE Download Services version 3.1.
Note:
You can also create INSPIRE Feature Download Services.
Input files for INSPIRE Predefined Dataset Download Services
To enable the INSPIRE Predefined Dataset Download Service, the following input files are required:
- Service Atom file—The top level service Atom file that contains links to the dataset Atom file or files. Links to each dataset Atom file will be a separate entry. An example is provided below.
- Dataset Atom file—This file contains links to the dataset or datasets. It can have multiple entries in the file for the dataset, and each entry represents a CRS and data format combination for the dataset. An example is provided below.
- OpenSearch descriptor file—This file defines the OpenSearch operations for the Atom-based INSPIRE Download Service that includes: q, free text parameter search, describe spatial dataset, and get spatial dataset operation. An example is provided below.
Multiple service and dataset Atom files can be created to support multiple languages in a single service. The mutual links across those files need to be properly populated so that the correct content returns for language-specific operations. See the technical guidance for the implementation of download services available on the INSPIRE website for detailed descriptions regarding language specifications.
Enable the Predefined Dataset Download Services
The INSPIRE Predefined Dataset Download Service can be enabled on any map service. It is recommended that you enable this in combination with an INSPIRE View Service or Feature Download Service. Complete the steps below:
- Start ArcCatalog.
- Select the service you want to add to the INSPIRE Predefined Dataset Download Service.
- Right-click the service and click Service Properties.
- Browse to the Capabilities section and enable the INSPIRE Predefined Dataset Download Service.
- Click INSPIRE Predefined Dataset Download Service Capabilities.
- Click Choose Download service ATOM file, select the service Atom file, and click Open.
- Click OK.
If there are input file validation errors, repeat these steps until the errors are fixed.
Once the service restarts, the configured INSPIRE Predefined Dataset Download Service is exposed in the ArcGIS Server REST directory (for example http://servername:6080/arcgis/rest/services/<servicename>/MapServer/exts/InspirePredefinedDatasetDownload).
Samples
The following are sample files for the service Atom file, dataset Atom file, and OpenSearch descriptor file:
- Service Atom
Input files for INSPIRE Predefined Dataset Download Service <?xml version="1.0" encoding="UTF-8"?> <!--please reference Technical Guidance for the implementation of INSPIRE Download Services (http://inspire.jrc.ec.europa.eu/documents/Network_Services/Technical_Guidance_Download_Services_v3.1.pdf) for detailed descriptions of each elements--> <feed xmlns="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss" xmlns:inspire_dls="http://inspire.ec.europa.eu/schemas/inspire_dls/1.0" xml:lang="en"> <!-- title for the Download Service Atom (required), see example below --> <title>a human readable title for the feed</title> <!-- subtitle (optional), see example below --> <subtitle>The subtitle of an Atom feed</subtitle> <!-- metadata link for this Download Service Atom (required), see example below --> <link href="http://servername/geoportal/rest/document?id={5A0A943B-D6AE-403D-886B-B02944D0E4B3}" rel="describedby" type="application/xml"/> <!-- link to service Atom file itself (required), please match the file name with the actual name of the Download Service Atom file, it should be a local file path (absolute or related), not remote URLS see example below --> <link href="serviceatoma1.xml" hreflang="en" rel="self" title="This document" type="application/atom+xml"/> <!-- link to opensearch description document (required), please match the actual Download Service Atom file name used for the opensearch description document, see example below --> <link title="Open Search Description" type="application/opensearchdescription+xml" rel="search" href="opensearchdescriptiona1.xml" hreflang="en"/> <!-- id references to the Download Service Atom file (required), it should match with the href attribute value of the link with the rel value "self". see example below --> <id>serviceatoma1.xml</id> <!-- rights or restrictions for Download Service Atom (required), see example below --> <rights>Copyright (c) 2012, XYZ; all rights reserved</rights> <!-- updated (required), contain the date, time and timezone at which the Download Service Atom was last updated --> <updated>2012-03-31T13:45:03Z</updated> <!-- author (required), contact information for an individual or organisation responsible for the Download Service Atom --> <author> <name>FirstName LastName</name> <email>[email protected]</email> </author> <!-- dataset entry ( at least one entry is required, you can add multiple entries if you need to serve multiple dataset Atom files) --> <entry> <!-- spatial dataset uri code (required), spatial_dataset_identifier_code and spatial_dataset_identifier_namespace elements together define the Spatial Dataset Unique Resource Identifier for the dataset --> <inspire_dls:spatial_dataset_identifier_code>waternetwork</inspire_dls:spatial_dataset_identifier_code> <!-- namespace (required) --> <inspire_dls:spatial_dataset_identifier_namespace>http://www.esri.com/inspire/atom</inspire_dls:spatial_dataset_identifier_namespace> <!-- link to the dataset metadata record (required) --> <link href="http://servername/geoportal/rest/document?id={5A0A943B-D6AE-403D-886B-B02944D0E4B3}" rel="describedby" type="application/xml"/> <!-- link to dataset Atom file (required) --> <link rel="alternate" href="datasetatoma1.xml" type="application/atom+xml" hreflang="en" title="dataset link"/> <!-- optional link to Download Services getcapabilities (only required for hybrid implementations) --> <link rel="related" href="http://servername/arcgis/rest/services/a4iatom/MapServer/exts/InspireFeatureDownload/service?Request=GetCapabilities&service=WFS" type="application/xml" title="Service implementing Direct Access operations"/> <!-- id to the dataset Atom file (required), the file should match with link to dataset Atom file --> <id>datasetatoma1.xml</id> <!-- title for the dataset (required) --> <title>The dataset title</title> <!-- updated (required), the date, time and timezone at which the entry was last updated --> <updated>2012-03-31T13:45:03Z</updated> <!-- rights (optional, only required if different from the feed section) --> <rights>Copyright (c) 2012, XYZ; all rights reserved</rights> <!-- author (optional, only required if different from the feed section) --> <author> <name>FirstName LastName</name> <email>[email protected]</email> </author> <!-- summary (optional), detailed description of the dataset entry --> <summary>this is a summary data for this dataset</summary> <!-- georss (optional), the bounding box of the dataset --> <georss:polygon>47.202 5.755 55.183 5.755 55.183 15.253 47.202 15.253 47.202 5.755</georss:polygon> <!-- CRS (required), refer to a known definition of a coordinate reference system --> <category term="http://www.opengis.net/def/crs/EPSG/0/4258" label="ETRS89"/> </entry> <!-- add additional entry section if needed --> </feed>
- Dataset Atom
<?xml version="1.0" encoding="UTF-8"?> <!--please reference Technical Guidance for the implementation of INSPIRE Download Services (http://inspire.jrc.ec.europa.eu/documents/Network_Services/Technical_Guidance_Download_Services_v3.1.pdf) for detailed descriptions of each elements--> <feed xmlns ="http://www.w3.org/2005/Atom" xmlns:georss="http://www.georss.org/georss" xmlns:inspire_dls="http://inspire.ec.europa.eu/schemas/inspire_dls/1.0" xml:lang="en"> <!-- title for the dataset Atom (required), see example below --> <title>Title of dataset Atom</title> <!-- subtitle for the dataset Atom (optional), see example below --> <subtitle>Subtitle of dataset Atom</subtitle> <!-- metadata link for this dataset Atom (required), see example below --> <link href="http://servername/geoportal/rest/document?id={5A0A943B-D6AE-403D-886B-B02944D0E4B3}" rel="describedby" type="application/xml"/> <!-- link to dataset Atom file itself (required), please match the file name with the actual name of the dataset Atom file, it should be a local file path (absolute or related), not remote URLs, see example below --> <link href="datasetatoma1.xml" hreflang="en" rel="self" title="This document" type="application/atom+xml"/> <!-- link to parent Download Service Atom (optional) --> <link href="serviceatoma1.xml" rel="up" type="application/atom+xml" hreflang="en" title="The parent service feed document"/> <!-- id references the dataset Atom file (required), it should match with the href attribute value of the link with the rel value "self". see example below --> <id>datasetatoma1.xml</id> <!-- rights or restrictions for Download Service Atom (required), see example below --> <rights>Copyright (c) 2012, XYZ; all rights reserved</rights> <!-- updated (required), the date, time and timezone at which the dataset Atom was last updated --> <updated>2012-03-31T13:45:03Z</updated> <!-- author (required), contact information for an individual or organisation responsible for the dataset Atom --> <author> <name>Firstname Lastname</name> <email>[email protected]</email> </author> <!-- link to spatial object type (required), the link shall refer to the INSPIRE Registry unless the data does not conform to any Data Specification in which case a link to a local definition of the Spatial Object Type shall be used instead. --> <link href="http://inspire-registry.jrc.ec.europa.eu/registers/FCD/items/412" rel="describedby" type="text/html" hreflang="en" title="title"/> <!-- downloadable file entry (at least one entry is required), there should be one entry for each format and CRS combination --> <entry> <!-- title for this dataset entry (required) --> <title>title for the dataset entry</title> <!-- updated (required), the date, time and timezone at which the dataset entry was last updated --> <updated>2012-03-31T13:45:03Z</updated> <!-- id to this dataset entry (required) --> <id>CCM21_WGS84_Lakes</id> <!-- link to dataset (required). Note that the type attribute must reflect one of the types listed in the openSearch descritor document --> <link rel="alternate" href="http://inspire-geoportal.ec.europa.eu/demos/ccm/files/CCM21_WGS84_Lakes.zip" type="application/x-filegdb" hreflang="en" length="34987" title="The dataset encoded as a dataset in WGS84 in zip format"/> <!-- NOTE: if you have multiple dataset, a description of the dataset structure shall be provided either in an Atom 'content' element as free text, or in an external document. See example below--> <!-- <content>description of the dataset that has multiple physical files</content> <link rel="alternate" href="http://xyz.org/data/abc/waternetwork_description.html" type="text/html" title="Description of Water Network files"/> --> <!-- link to each file for dataset containing multiple datasets, only apply if there are multiple files in a dataset, one link for each physical file. --> <!-- <link rel="section" href="http://inspire-geoportal.ec.europa.eu/demos/ccm/files/CCM21_WGS84_Lakes1.zip" type="application/x-filegdb" hreflang="en" title="Water Network encoded as a GeoTiff – part 1" bbox="50.0 5.0 50.9 5.9" time="2012-06-01T13:00:00Z" /> <link rel="section" href="http://inspire-geoportal.ec.europa.eu/demos/ccm/files/CCM21_WGS84_Lakes2.zip" type="application/x-filegdb" hreflang="en" title="Water Network encoded as a GeoTiff – part 2" bbox="50.0 5.0 50.9 5.9" time="2012-06-01T13:00:00Z" /> --> <!-- CRS (required), refer to a known definition of a coordinate reference system --> <category term ="http://www.opengis.net/def/crs/EPSG/0/4258" label=" ETRS89"/> <!-- georss (optional), the bounding box of the dataset --> <georss:polygon>47.202 5.755 55.183 5.755 55.183 15.253 47.202 15.253 47.202 5.755</georss:polygon> </entry> <!-- add additional entry section if needed --> </feed>
- OpenSearch descriptor
<?xml version="1.0" encoding="UTF-8"?> <!--please reference Technical Guidance for the implementation of INSPIRE Download Services (http://inspire.jrc.ec.europa.eu/documents/Network_Services/Technical_Guidance_Download_Services_v3.1.pdf) for detailed descriptions of each elements--> <OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/" xmlns:inspire_dls="http://inspire.ec.europa.eu/schemas/inspire_dls/1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <!-- shortname (required by the opensearch specification)--> <ShortName>a4iopensearch</ShortName> <!-- description (required by the opensearch specification)--> <Description>ArcGIS for INSPIRE OpenSearch Description</Description> <!-- name of the opensearch document (required), the name should match with the name of the actual file--> <Url type="application/opensearchdescription+xml" rel="self" template="opensearchdescriptiona1.xml"/> <!-- url template for general search queries required, do not modify the URL. The prefix URL will be replaced with what is defined in ArcCatalog for Predefined Download Service settings (online resource) when the service is created, the url may depend on web adaptor settings--> <Url type="text/html" rel="results" template="http://inspiresrv2:6080/arcgis/rest/services/a4imxd/MapServer/exts/InspirePredefinedDatasetDownload/openSearch?q={searchTerms}"/> <!-- url template for describe spatial dataset operation (required), the prefix URL will be replaced with what is defined in ArcCatalog for Predefined Download Service settings (online resource) when the service is created, the url may depend on web adaptor settings--> <Url type="application/atom+xml" rel="describedby" template="http://inspiresrv2:6080/arcgis/rest/services/a4imxd/MapServer/exts/InspirePredefinedDatasetDownload/openSearch?spatial_dataset_identifier_code={inspire_dls:spatial_dataset_identifier_code}&spatial_dataset_identifier_namespace={inspire_dls:spatial_dataset_identifier_namespace}&language={language}"/> <!-- NOTE: the following sections may need modifications --> <!-- url template for get spatial dataset operation (required). The prefix URL will be replaced with what is defined in ArcCatalog for Predefined Download Service settings (online resource) when the service is created, the url may depend on web adaptor settings. The following is an example for get spatial dataset operation for format type application/x-filegdb, if you have other format types, add additional url templates. --> <Url type="application/zip" rel="results" template="http://inspiresrv2:6080/arcgis/rest/services/a4imxd/MapServer/exts/InspirePredefinedDatasetDownload/openSearch?spatial_dataset_identifier_code={inspire_dls:spatial_dataset_identifier_code}&spatial_dataset_identifier_namespace={inspire_dls:spatial_dataset_identifier_namespace}&crs={inspire_dl:crs}&language={language}&type=application/x-filegdb"/> <!-- query element (required)--> <Query role="example" inspire_dls:spatial_dataset_identifier_namespace="http://www.esri.com/inspire/atom" inspire_dls:spatial_dataset_identifier_code="waternetwork" inspire_dls:crs="http://www.opengis.net/def/crs/EPSG/0/4326" language="en" title="a4i" count="1"/> <!-- at least language element required--> <Language>en</Language> </OpenSearchDescription>
Note:
- ArcGIS Desktop must be installed on the ArcGIS Server machine to create the Predefined Dataset Download Service.
- If you want to update the Predefined Dataset Download Service, you should update the Atom files first, then republish or upload those files.