Publish your data on Données Québec¶
Once created, your catalog can be published on Données Québec using the CKAN module developed by Isogeo.
Prerequisites¶
In order for your data to be uploaded to Données Québec, it must meet several criteria:
- be in a catalog shared by the CKAN server and OpenCatalog ;
- contain at least one operational download link. Recognized download links are :
- link to a WFS service capable of delivering the data in GeoJSON format in WGS84 (4326): see assign a WFS service ;
- link to vector (GeoJSON, Shapefile Zipped and Geopackage), raster (ECW, JPEG2000 and GeoTIFF) or tabular (csv, xls and xlsx) data files: see assign download link.
List of completed metadata fields¶
| Data fieldsquebec.ca | Isogeo fields |
|---|---|
| Title | Title |
| Description | Mixing several fields |
| Organization | Organization Data Quebec |
| Labels | Keywords |
| Category | Theme whose character string is identical to the donneesquebec.ca categories) |
| License | Conditions |
| Manager | Working group name |
| E-mail address of the contact associated with the "Point of contact" role | |
| Update frequency | Update frequency |
| Geographical coverage | Not filled (entered by donneesquebec.ca) |
| Time coverage | Period of validity |
| Source (URL) | Link to the OpenCatalog file associated with the same share as CKAN |
| Diffusion modification | Not filled (entered by donneesquebec.ca) |
| Initial release | Not filled (entered by donneesquebec.ca) |
| Identifier | Not filled (entered by donneesquebec.ca) |
Description¶
The description is formatted as follows:
Description : Summary
Collection context: Data collection context (if any)
Collection method: Data collection method (if any)
Attributes: array containing field name, type and alias (or basic comment).
List of fields automatically completed in the Quebec data sheet resources¶
When you edit a resource on Données Québec, you can add information about it (see screenshot).
Here is the list of resource fields that CKAN Isogeo automatically fills in:
| Fields Data Quebec | Automatically completed selection |
|---|---|
| Field description | Provided in the metadata description |
| Comma separator (CSV only) | Yes |
| utf-8 | Yes |
| EPSG 4326 / EPSG 32198 | Yes |
| The file is not compressed | Yes for zip or shp formats; No for all other formats |
| Unknown/unavailable values = empty | Yes |
| Number format = decimal with a ".", SI units (meters) or $ CAD | Yes |
| Boolean (single value) | Yes |
Update frequency¶
The update frequency is entered according to this correspondence:
| Isogeo | Quebec data |
|---|---|
| Every hour | Schedule |
| Every day | Daily |
| Every week | Weekly |
| Monthly | Monthly |
| Every 3 months | Quarterly |
| Every 6 months | Half-yearly |
| Every year | Annual |
| Every 2 years | Biennial |
| Every 3 years | Triennial |
The "Real time", "Irregular" and "Archive" values must be filled in manually, as they have no equivalent in Isogeo.
Links to services, data downloads and interactive maps¶
Several types of links can be added to the Quebec Data sheet.
- service links:
- link to a WMS (Web Map Service) visualization service ;
- link to an EMS (Esri Map Service) visualization service ;
- download links:
- link to a file uploaded to Isogeo (hosted) ;
- link to vector (GeoJSON, Shapefile Zipped, Geopackage KML/GML, CSV), raster (GeoTIFF and JPEG2000) or tabular (csv and xlsx) data files as a "Data" type link with the download action ;
- link to a WFS service:
- the number of entities must be less than the map server's threshold ( MaxRecordCount=1000 parameter by default for ArcGIS Server, maximum number of objects parameter for Geoserver, etc.)
- the 4326 coordinate system must be available in all capacities
- geojson export format too
- interactive map links: links to a "Data" or "Links" resource with the visualization action.
Generating and monitoring valid data sets¶
- To generate a new harvesting link, go to
Administration,Sharesand click onNew; - Then choose the CKAN application, a catalog and a Name for sharing;
- Click on
Create; - A link is automatically generated to launch the synchronization process and publish your data on Données Québec.
For your information, data sheets without a download link meeting the above requirements are considered invalid.
CKAN Module¶
Home Page¶
The CKAN module is presented in the form of a table containing information about the synchronization of your shared catalog with the module.
The following information is available for each data:
- The title of the data;
- The link to the associated CKAN data;
- The link to the Isogeo data;
- The synchronization status;
- Additional information (details of an error, incompatible resources, etc.);
- The date the data was published on the CKAN platform;
- The date the data was last modified on the CKAN platform via synchronization.
Tip
The header contains hyperlinks that allow you to navigate more easily between sites:
- “CKAN module” redirects to this online documentation;
- The link to the CKAN platform where the records are published;
- The link to the APP Isogeo working group.
Types of synchronization¶
When you start synchronization, you can choose the type. There are two types of synchronization:
- Classic synchronization, to publish or update records;
- Synchronization with orphan record detection.
An orphan record is a record that has been synchronized on the CKAN platform but is no longer present on the Isogeo side for various reasons:
- The record is no longer present in the catalog shared with the application;
- The record has been deleted.
When an orphaned record is detected, this allows you to delete the CKAN record if necessary, if it is no longer relevant.
Synchronization statuses¶
The list of possible statuses and their meanings:
| Status | Meaning |
|---|---|
| Published | The record has been published on the CKAN portal |
| Unchanged | The Isogeo record has not been modified since the last synchronization |
| Updated | The record has been updated in the CKAN portal |
| Duplicate | The CKAN organization already has a record with this identifier, the new published record is indexed |
| Orphan | The record is present in the CKAN portal but is no longer in the Isogeo catalog |
| Missing resources | The publication of records with no associated resources is disabled, the attached record is affected |
| Missing summary | The publication of records with no summary is disabled, the attached record is affected |
| Failed | Unable to update data (usually an authorization or configuration issue) |
Synchronization history¶
The “History” tab allows you to view a list of recent synchronizations. The following information is available for each synchronization:
- The synchronization date;
- The synchronization type, with or without orphan record detection;
- The record synchronization table.