User_Manual

xmolero edited this page Oct 30, 2015 · 60 revisions

Introduction

Architecture

User Guide

Developer Guide

  • [User interface] (User_Interface)
  • [RDFizer] (RDFizer)
  • [Links Discovery] (Links_Discovery)
  • [Linked Data Server] (Linked_Data_server)
  • [CKAN Datahub Page Creation] (CKAN_Datahub_Page_Creation)

Release Notes

  • [Release Notes 1.0] (Release_Notes1)
  • [Release Notes 2.0] (Release_Notes2)
  • [Release Notes 2.1] (Release_Notes_2.1)

RoadMap

Links

Clone this wiki locally

User manual

Login page

This is the starting page of ALIADA. To access to the ALIADA tool it's necessary a correct username and password. Also there will be the option to choose the language, using the flags at the bottom of the page.

Logon

Log out

Every page has the options to:

  • Change the language.
  • Change the ALIADA settings.
  • Jobs panel control.
  • Access to the user manual.
  • Log out and close the session.

Log out

Job panel control

This page has the options to:

  • Delete all the jobs with the current session.
  • Delete the not finished jobs with the current session.
  • Choose one job to finish the process with the current session.

Jobs

ALIADA settings tabbed panel

Settings Tabbed Panel

Institution configuration

This page shows some information about the institution and gives the option to change some of them as the logo or the URL of the catalogue. When the user has made the changes, he has to click the “Save” button for these changes to take effect. If the changes have been applied well, it will display a changes apply message, otherwise it will show an error message. At the bottom, it’s the users’ button to access to the users' page and a next button to advance to the file importation page.

Institution configuration

Profiles management

This page functionality is very similar to the users' one; it allows adding, seeing, editing and deleting profiles. These profiles will be used in the file importation.

Profiles

Add profile

To add a profile the user must click the add button to display the form and then complete it and click the add button. If any value is wrong it will display an error message.

Add a new profile

See profile

This option lets you view the information of the selected profile without enabling the edition.

See a new profile

Edit profile

To edit a profile the user must select a profile from the list and then click the edit button. After that the user must do the changes and click the edit button.

Edit a profile

Delete profile

To delete a profile the user must select a profile from the list and click the delete button. The user can´t delete the predefined profiles.

Templates management

This pages functionality is very similar to the profile management it allows to add, edit and delete templates. These templates will be used in the RDF conversion.

Templates

Add template

To add a template the user must click the add button to display the form and then fill the gaps, select the fields sorted by entities that he wants to take into account and click the add button.

Add a template

See template

This option lets you view the information of the selected template without enabling the edition.

See a template

Edit template

To edit a template the user must select a template from the list and then click the edit button. After that the user must do the changes and click the edit button.

Edit a template

Delete template

To delete a template the user must select a template from the list and click the delete button. The user can´t delete the predefined templates.

Users' page

This page allows managing the users: adding, editing or deleting them.

Users

The types of users are:

  • Advanced : It allows linking with the datasets he decides on the list of those. The selected datasets are stored in the database for basic users.
  • Basic: This role does not allow linking to the datasets chosen by the user (only with the selected by any advanced user previously).

Then there are the roles of each user who is information. The roles of users are:

  • Administrator
  • Administrative Officer
  • Programmer
  • Librarian
  • Archivist
  • Manager
  • Cataloguer
  • Supervisor
  • Library Director

Add User

To create a new user the ALIADA user must click the add button first to display the form and then, complete it with the correct values, among them a valid e-mail. Finally, it has to click the add button. If any value is wrong it will display an error message.

Add a user

Edit User

To edit a user the ALIADA user must select a user from the list and then click the edit button. After that the user must do the changes and click the save button.

Edit a user

Delete user

To delete a user the ALIADA user must select a user from the list and click the delete button. The user can´t delete the current user in the session.

Datasets and subsets management

Datasets management

This page shows some information about the datasets and gives the option to add, see, edit and delete a dataset.

Datasets configuration

Add a dataset

To add a dataset the user must click the add button to display the form and then complete it and click the add button. If any value is wrong it will display an error message.

Add a dataset

See a dataset

This option lets you view the information of the selected dataset. Furthermore, the user can manage the subsets.

See a dataset

Edit a dataset

To edit a dataset the user must select a dataset from the list and then click the edit button. After that the user must do the changes and click the edit button.

Edit a dataset

Delete a dataset

To delete a dataset the user must select a dataset from the list and click the delete button. If the user delete a dataset, the subsets also are deleted.

Subsets management

This page shows some information about the datasets and gives the option to add, see, edit and delete a dataset.

Subsets configuration

Add a subset

To add a subset the user must click the add button to display the form and then complete it and click the add button. If any value is wrong it will display an error message.

Add a subset

See a subset

This option lets you view the information of the selected subset.

See a subset

Edit a subset

To edit a subset the user must select a subset from the list and then click the edit button. After that the user must do the changes and click the edit button.

Edit a subset

Delete a subset

To delete a subset the user must select a subset from the list and click the delete button.

External datasets reload management

This pages functionality is according to the linking process with the external datasets. Here, it can select the external datasets that want to reload at the linking process. The user must know the process takes a long time. It´s only required the first time the linking process is performed in the tool.

External Datasets configuration

File importation

This page imports and validates files that will be used in the process. These files are validated depending in their format so there are different kinds of validation. These validations are defined in the profiles that can be selected. So if the user tries to import a MARC bibliographic file he must select a corresponding profile for it and then click the import file. When, import is done, ALIADA will provide a message with the information of the process. The imported files will be displaying in a list, where it can see the status of the file at start it will have a clock icon but when the file has been already imported the state will show a tick icon. To advance, the user must select one of the files and click the next button.

Import a file

Conversion to RDF

This page does the conversion to RDF of the records of the imported file. This conversion can be different depending on the template selected. Also, the user has to select the dataset and subset where the data is going to be stored, there is an option to clean the graph and remove all the data that is stored there previously. For that, the user has to select the graph that he wants to clean and click the clean button, after the user has to confirm the action and then it will appear a message telling that the graph has been cleared. Once the necessary template, dataset and subset are selected, the user can click the RDF-ize button to start the conversion.

Conversion a file

In case this button is clicked the conversion information is displayed. When the conversion is finished the query and the next button will be enabled. The former allows the user to go to the query page and the latter to go to the linking page.

Conversion information

Query page

This page gives the option to make queries to virtuoso and see the data that has been generated.

Queries

Linking page

In this page the user can click with all the external datasets and then must click in the link button to start the discovery of the links and creation of the URIs.

Linking with external datasets

After the link button is clicked, check button is enabled.

Linking checked

Linking information

This page shows the information of the discovery process (on the right side) and URI creation process (on the left side).

Linking information

When this two processes finish you can done the previous options:

  • "Links validation" button is enabled to show the generated links by the selected external datasets.
  • "Queries" button is also enabled to make queries to virtuoso.
  • "Dataset Web" button is enabled to show the dataset web page.
  • "Add another file" button is enabled to return to the import page and select another file to process.
  • "Publish" button is enabled to do the dataset publication.

Linking information status finished

Linking validation (Ambiguous links and all the links)

This page shows the generated links by the selected external datasets where the user can delete one by one.

Links validation

Dataset Web

This page shows the information about the selected dataset.

Dataset Web

Publication

This process is the step to publish the dataset at the Semantic Web. Firstly, clicked in the publish button and the tool does the publication. The tool where uploads the data is Datahub.

Publication

Then, this page shows the link to the datahub page where the dataset is been published.

CKAN publication

Finally, this page is the dataset with a predefined license to distribute.

CKAN Dataset