Qualifications Dataset Register User Manual: Publishing Workflow

Transcription

1 Qualifications Dataset Register : Publishing Workflow

2 Contents Introduction... 3 Overview... 3 Publishing new datasets... 4 Creating dataset versions... 6 Successful preparation of a dataset... 8 Failed preparation of a dataset... 8 Editing and updating your datasets and dataset versions... 9 Editing your datasets... 9 Editing your dataset versions...0 Other functions...0 December 7-2

3 Introduction Welcome to the user guide for the Qualifications Dataset Register (QDR) platform. In this manual, you will learn how to publish your Qualification datasets, and set preferences for uploading and updating it. If you have not registered on the platform and created a profile for your organisation yet, please visit the user manual for registration, follow the described steps, and then return here to find out how to publish your data. Overview On your organisation s profile page (Figure : Overview of your organisation's page), you can find the section Published datasets []. Here, you can always find the sets of data you have published. 2 3 Figure : Overview of your organisation's page December 7-3

4 Publishing new datasets On the right side of your organisation s profile page (Figure : Overview of your organisation's page), click on the yellow button Publish new dataset [2] to upload a new dataset. This will take you to a new page where you can fill out the information of this dataset, as well as decide how you want your data to be updated. After you clicked create new, you will be directed to this screen: Figure 2: Creating a new dataset - First, fill out the title of your data (see [] in the image), then add a brief description [2]. 7 Note: You can name and structure your published data as you wish (based on education level, country regions or another categorisation) - In the field Publishing scheme [3], select the right option from a top-down menu. The two options are Qualification metadata schema (v.0) and EQF Schema. If you have participated in the EACEA 03/204 call for proposals, the second option is for you. If not, the first is applicable to you. - Namespace [4] refers to a unique string used to identify and represent your dataset. You can fill in, for example, the URL of your organisation or the base December 7-4

5 URI you use for your concepts to complete the namespace and to create a unique string. - For the Publishing method [5], there are two main distinctions: o Upload or Hosted on your server: do you wish to upload your data in a file, or do you wish to provide a URL from which the platform fetches your data? If you choose upload, you will upload a new file every time your data is updated. o Hosted on your server Manual/Automatic Update; if you choose the first, you will provide a new URL from which we can fetch the updated data every time a new version is released. If you choose the second, the updates will happen automatically. If you choose Automatic Update, a field will appear where you can paste the download URL, from which we will create the new versions as your website is updated. In the field type of provided file you can see which file types are supported, and you can indicate the option that applies to you. Note: If you select the publication method Hosted on your server - Automatic Update, you will not be able to create new versions manually; they will always be created automatically with regular refresh. Note: You can change the publishing method of a specific dataset at any time in case you decide that you want to provide future versions using a different method. - In the field What is included in your dataset [6] you can choose between Qualification Standard and Individual Qualification. The distinction is as follows: o Qualification Standard refers to more general qualifications which are applicable to more than one institution in your country, for example a Master of Science, which several institutions in one country offer, and for which many sub-categories exist. o Individual Qualification refers to datasets which are applicable to qualifications which one specific institution offers. For example a Master of Science in Business Engineering from the University of Ghent. - Then, you can save everything by clicking save at the bottom of the page [7]. o After you save, you will be redirected to the previous page. o If at any point you wish to close the page, you can find the x button on the top right [8]. December 7-5

6 Creating dataset versions Once you have create a new dataset you will have to create its first version. To do this you first have to access this dataset by clicking on the name of the desired dataset on your organisation s profile page (see [3] Figure : Overview of your organisation's page), under published datasets. This leads you to a listing of the different versions published under this dataset as seen on image below: Figure 3: Overview dataset and its versions To publish a new version you can click Publish new version [5] on this page. December 7-6

7 This will direct you to a page similar to the page for creating new datasets, but focused on providing information about your new version. The page has the following look: 2 3 Figure 4: Creating a new version Here you should provide a following information: - Fill out the title of the new version and add a brief description [] in the image above; - Upload your file or provide a URL [2] depending on your publishing method chosen for this dataset; - Choose whether your provided file is in XML or RDF (RDF+XML) format under Type of provided file [3]. Once you have created a new version you will see it in the listing on Overview dataset and its versions (see Figure 3: Overview dataset and its versions). Now it is ready for preparation of the data. During the preparation, the platform takes your data and transforms it into a unified RDF format according to the qualification metadata schema. This process also applies validations of the compliance of the data with the schema. The content of your data is not modified by this process. To initiate the preparation you should click Start preparation (see [6] Figure 3: Overview dataset and its versions) The preparation may take some time and will result in either success or failure. December 7-7

8 Successful preparation of a dataset In case a dataset is prepared successfully you will receive a confirmation indicating this. You will also see green approval circles in the diagram below the related dataset version: Failed preparation of a dataset Figure 5: Processing was a success If there are any problems with the provided dataset (for example the file is not supported or provided metadata are incorrect) you will receive an informing you about this, which will redirect you to the platform where you can see and resolve the problem. If there was a problem, you will see this warning right underneath the newly created version: 2 Figure 6: Processing failure You can then click on your version, and perform any necessary actions, such as upload of new data or change in the version metadata. Once this is done you will be able to retry processing. Retry of the preparation is initiated by a related button Preparation failed, retry (see [2] Figure 6: Processing failure). To help you understand the problems in your dataset, the platform provides a report which lists the identified errors in a JSON format. This report can be accessed using the button Get report (see [] Figure 6: Processing failure). Below you can see an example of this report: Figure 7: Failure report December 7-8

9 Editing and updating your datasets and dataset versions In your dataset, you can change several things: you can change the details of the dataset as a whole, which you provided when you originally created it. You can also create new versions and make changes to those versions of the dataset. Editing your datasets To make changes to the overarching dataset (not its versions), you can go to your organisation s profile page (Figure : Overview of your organisation's page), and click on the dataset you wish to edit. The next page shows you the detailed information of this dataset as well as the different versions published in it (see Figure 3: Overview dataset and its versions). On top of this page you can see a button Show/Edit data : when you click, the following section will expand: Figure 8: Editing dataset information Here you can click on the edit icon [] on the right, to change the details of your dataset. Don t forget to click save at the bottom when you have finished. December 7-9

10 Editing your dataset versions To make changes to the different versions within the dataset, you need to go one step deeper: within the dataset, the different versions are listed under the header Published Versions of Dataset X (see [3] in Figure 3: Overview dataset and its versions). Click on the version you wish to edit, which will take you to the version overview: 2 3 Figure 9: Details of a dataset version Here you can click Show/Edit data (see [] in Figure 9: Details of a dataset version) and make the desired changes in a same fashion as for your dataset (see Editing your datasets ) If you want to update your dataset and create a new version, follow the steps described above in the section Creating dataset versions. In the section Published versions of X dataset on the dataset page (see [3] in Figure 3: Overview dataset and its versions), as well as Files of the version on the version page (see [2] Figure 9: Details of a dataset version), you can download your files. You can download a copy of the file you have uploaded, or a copy of the content from the link you provided. To download, simply click the Download button on the right (see [4] in Figure 3: Overview dataset and its versions, and [3] in Figure 9: Details of a dataset version). Note: The files for download can have two icons next to them (clouddownload/drive-download), these indicate whether that file is hosted on a remote server (cloud) or in the QDR (drive). Other functions To log out and exit the platform, click the yellow Logout button at the top right of each page, you will be automatically logged out from both the QDR and your EU login session. December 7-0