{% extends "page.html" %} {% block subtitle %}{{ _("Etsin instructions") }}{% endblock %} {% block breadcrumb_content %}
{{ _('This help page will guide you through the most common tasks in Etsin. Use the links on the left side of the page to quickly navigate to the desired section.') }}
{{ _('Also, have a look at the FAQ page. It might give you an answer to a specific question in mind.') }}
{{ _('Search can be accessed from the Datasets page. You can submit your queries using the Search tab or the Advanced search tab, which will provide a guided interface for more complex queries. Note that you can also provide more complex queries to the search field by providing a correct syntax, which will be discussed later in this section.') }}
{{ _('The right side of the search page provides facets from different categories. You can choose multiple and from different categories with a mouse click. You can remove a facet selection by pressing the "x" button. For example choosing free licenses from the License facet selection would search through the free data.') }}
{{ _('Advanced search feature makes it easy for you to construct more complex searches. You can add as many search criteria as you want from the "ADD" button: Choose the desired target field from the menu and add logical operators from the leftmost menu. Note that the AND operators are grouped together so that they will take precedence over criteria bound by OR.') }}
{{ _('The searches support two different wildcard characters. Symbol "?" provides a single character wildcard search. The following search would match both "text" and "test": ') }}
{{ _('To match multiple characters you can use the symbol "*". It matches 0 or more characters and can be placed in the middle of the term as well as the end: ') }}
{{ _('The search engine used by Etsin supports the boolean operators AND, "+", OR, NOT and "-". Note that the boolean operators must be provided as upper case characters. To search datasets containing both "climate" and "rain" you would type: ') }}
{{ _('To search for datasets that must contain climate and may also contain rain the search would be: ') }}
{{ _('NOT and "-" work similarly. These can be used to rule out words. For example, to search for datasets containing "climate" but not the word "rain" you would search for: ') }}
{{ _('If needed, you can group the search criteria with parentheses. This will enable sub queries. For example, to search for either "sun" or "rain" and "climate", use query: ') }}
{{ _('With fuzzy search you can match a word that is similar to the given one. Fuzzy search is constructed with symbol "~". To search spellings similar to "roam" you could make a search: ') }}
{{ _('The range searches work for both date fields and non-date fields. You can search for datasets added between the lower and upper bounds of the provided dates with: ') }}
{{ _('You can raise any word\'s importance by boosting it with the symbol "^" and a number. The number is so called boost factor and the higher the number is, the more relevant the word will be. For example, to search for terms "northern hemisphere" and "southern hemisphere" with the "northern hemisphere" wanted to be more relevant, you could construct a search like: ') }}
{{ _('Choosing a dataset from the search result will show the dataset\'s information. The dataset page also provides additional features:') }}
{{ _('If you are logged in you will find "Add Dataset" button for example from the Datasets and Dashboard pages. This button brings you to the Add Dataset form. The Add Dataset page encourages and guides you to fill in the metadata as well as possible to ensure that metadata is of good quality and your data is as well described as possible. The fields are accompanied with a tooltip, "?", which will give instructions for that specific field.') }}
{{ _('Basic information about the dataset:') }}
{{ _('Agents and roles:') }}
{{ _('Identification information of data:') }}
{{ _('Usage information tells where the data is located and/or how it can be accessed:') }}
{{ _('Beneath the required information are the recommended data fields that are by default hidden but can be toggled visible. It is useful to describe your data as well as possible, so if the fields in recommended information are valid to your data, please fill them. Here are short explanations of the fields:') }}
{{ _('Coverage provides fields for spatial and temporal coverage:') }}
{{ _('Relations:') }}
{{ _('File information is especially technical information about your data:') }}
{{ _('Dataset lifecycle events:') }}
{{ _('Free description:') }}
{{ _('Etsin contains several other features which are shortly covered here.') }}
{{ _('User profile provides basic information about you, your dataset and actions. The user profile can be accessed from the upper right corner. The upper right corner also provides a direct link to your own datasets. Note that if you have logged in using Haka, you can not change your profile information from Etsin: the changes must be done by your home organisation.') }}
{{ _('The Stats link will take you to the statistics page. The page will show you some general information about Etsin, its datasets and users.') }}
{{ _('Etsin is integrated to a REMS service, Reetta. This means that you can define your data to be accessible only after an application form is filled and sent to you to accept in the REMS service. You can create your own workflow or use the automatically generated simple form. When a REMS application is done user can go to fill the application from the download link of the data. Read more from: ') }} {{ _('REMS manual') }}
{#{{ _('The Collections page shows categories which may have datasets under them, grouped together under one set. You can also add a new collection and from the collection page also add a dataset under this collection. Note, that for now only collections\' administrators can add datasets under it.') }}
#}{{ _('From the dataset view page you can choose a link to administer dataset rights if you have sufficient privileges to do so. From the administration page, you can add editors and admins (if you have admin privileges) for the dataset. Type and accept the username with enter or mouse click in the "User" field, choose a role from "Role" menu and press "Add". If you don\'t find the user, he or she probably hasn\'t logged in to Etsin yet. In this case you can send an email with your own message added to it. The message is not obligatory. Note, that for spam protection you must also fill the CAPTCHA field. If the displayed words are too messy, you can reload the CAPTCHA to get a new string from its reload button.') }}
{{ _('From the top of the page, from the member list table, you can remove users from their roles in this dataset. Note, that you can not remove the built-in user accounts, like visitor and logged_in, nor yourself.') }}
{{ _('If you have additional documents that describe your data beyond required and recommended fields, you can provide such extra information in metadata supplements. An example of a useful supplement would be a detailed description of variables in your data.') }}
{{ _('Metadata supplements are separate documents that appear to viewers of the dataset as downloadable resources. In many cases the dataset will also appear in search results based on the contents of its metadata supplements. Searching works for many common file formats (e.g. plain text, PDF, and many office document formats) but is not guaranteed to work for all files.') }}
{{ _('Adding supplements to the metadata requires that you have editor privileges to the dataset.') }}
{{ _('To add metadata supplements for a dataset, follow these steps:') }}
{{ _('Etsin supports standard')}} CKAN API {{ _('commands. In addition, Etsin supports addition and deletion of dataset editors with dataset_editor_add and dataset_editor_delete, respectively. ') }} {{ _('To add a dataset editor, provide also attributes: name (dataset\'s name), role (usually editor) and username (user login to add) ') }}
{{ _('The metadata model of Etsin is more complex than the default model in CKAN. An example of a dataset that can be created in Etsin, using Curl: ') }}
curl http://etsin.avointiede.fi/api/3/action/package_create --data-urlencode '{ "agent": [ { "URL": "http://url", "fundingid": "{{ _('Funding id') }}", "name": "{{ _('Funder') }}", "organisation": "{{ _('Project name') }}", "role": "funder" }, { "name": "{{ _('Owner') }}", "role": "owner" }, { "name": "{{ _('Author') }}", "organisation": "{{ _('Organization') }}", "role": "author" } ], "algorithm": "{{ _('Algorithm') }}", "availability": "access_request", "checksum": "{{ _('Checksum') }}", "contact": [ { "URL": "http://url", "email": "email@domain.com", "name": "{{ _('Contact name') }}", "phone": "{{ _('Phone') }}" } ], "direct_download_URL": "", "access_application_URL": "", "access_request_URL": "http://url", "discipline": "{{ _('Discipline') }}", "event": [ { "descr": "{{ _('Description') }}", "type": "{{ _('Eg. collection') }}", "when": "{{ _('Date in ISO 8601 format') }}", "who": "{{ _('Eg. person') }}" } ], "geographic_coverage": "{{ _('Geographic coverage') }}", "langtitle": [ { "lang": "{{ _('Title language, eg. fin') }}", "value": "{{ _('Title') }}" }, { "lang": "{{ _('Title language, eg. fin') }}", "value": "{{ _('Title') }}" } ], "language": "{{ _('Dataset\'s language(s), eg. eng,fin') }}", "license_id": "{{ _('Eg. cc-by') }}", "mimetype": "{{ _('MIME type') }}", "name": "{{ _('Automatically generated, if left empty') }}", "pids": [ { "id": "PID", "provider": "{{ _('Provider of the identifier') }}", "type": "{{ _('Eg. data') }}", "primary": "{{ _('True, if primary data identifier') }}" }, { "id": "PID", "provider": "{{ _('Provider of the identifier') }}", "type": "{{ _('Eg. version') }}" } ], "notes": "{{ _('Description') }}", "projdis": "True", "tag_string": "{{ _('Subjects as a comma separated string') }}", "temporal_coverage_begin": "{{ _('Time in ISO8601 format, eg. 2000-01-01T00:00:01') }}", "temporal_coverage_end": "{{ _('Time in ISO8601 format, eg. 2000-01-01T00:00:01') }}", "version": "{{ _('ISO8601 format, eg. 2014-06-06T07:07:07') }}", "owner_org": "{{ _('Organization, see organizations in Etsin web user interface.') }}", "private": "{{ _('True or false, private datasets are not added to the search index.') }}" }' -H "Authorization: {{ _('YOUR-API-KEY') }}"
{{ _('For additional help send email to: ')}}
{{ _('servicedesk (at) csc.fi') }}