Documents

Overview

With Documents you can upload or link to documents that should be linked to a dataset or data service, such as a specification, a license agreement or other documents related to the dataset or data service. This can be PDF files, web pages via links, or anything else. At the moment, these three document types are supported: Documentation, License and Standard/Recommendation/Specification.

Create document

To create/add a new document, go to Documents and click on the "Create" button.

If the document is available on the web, enter the web address (URL). In other case, click on "File" and upload the file. Document type and Title are mandatory fields, but it's recommended to also enter a Description of the document.

If it is a specification that you want to link to or upload, it is important that you choose the document type "Standard/Recommendation/Specification" so that EntryScape can interpret it as a specification.

Then, click on "Create" down to the right.

The document is now created but exists in EntryScape Catalog as a loose file not linked to anything yet. See below on how to link the document to an existing or other entity.

Link to specification or document

The field "Conforms to" in the entities datasets, dataset series, or data services refers to a specification or similar that the dataset, dataset series, or data service conforms to.

For other types of related documentation, there is the “Document” field, which is more general and can be used to link a dataset, data service, or distribution to any documentation.

Link to specification

To link to a specification or similar that a dataset, dataset series, or data service conforms to, turn on "Recommended fields" at the top and scroll or click down to the "Conforms to" field. (On some instances still running DCAT 2, you need to turn on "Optional fields" to see the field.)

You can refer to a specification that you have uploaded or linked to via the "Documents" function in EntryScape.

Search for a specification using the search field or click on the magnifying glass to browse among specifications. Note that documents you have uploaded yourself must be of the document type "Standard/Recommendation/Specification" in Catalog to be visible here.

Link to documentation

For other types of documentation related to datasets, data services, and distributions, there is a field “Documentation”. There, you can refer to a documentation file or documentation link that you have already described under the “Documents” function in EntryScape.

To link to a document, go to the dataset/data service/distribution and select “Edit.” Turn on optional fields. Please note that the document must be of the type “Documentation” in Catalog in order to be visible here. It is also not certain that the order of the documents visible in the editing interface will be the same as the order displayed in the presentation.

Edit, replace or remove document

You can edit the information about your document by clicking on the edit pen in the list of documents.

You may also edit the description, replace the document or remove the document with the Edit, Replace and Remove buttons on the overview page.

Download document

You can download a document by clicking the ""Download" button.

Publish document

Documents get the same publication status as the catalog they are located in. If the catalog is public, the document will also be public (green globe). If the catalog is not published, the document will not be published (black globe).

See detailed information

If you want to see more detailed information about your document, click on the information icon.

Then you get a popup dialog where you can see metadata as well as all entities linking to or from your document. Read more about detailed information.