User_Interface - ALIADA/aliada-tool GitHub Wiki

User Interface

The User Interface module provides the ALIADA’s capabilities to the end-user, these capabilities comprises ALIADA tool administration, content conversion to RDF and publication.

ALIADA´s target users are librarians, curators and IT staff using a library or collection management system (LMS/CMS). These professionals are usually non‐experts in Linked Data underneath technology, but as technical staff they have the know‐how in the specific data and standards used in their environment. Likewise, the Heads of the cultural institutions holding the data should decide what data will be published and what return they want after publishing the dataset.

To summarize, the user interface component will interact with the rest of the components of ALIADA to provide the user commands into ALIADA and to show ALIADA`s feedback to the user.

Relational DB tables used

In this module, the end-user configures the different settings to work with ALIADA tool. The tables used are the following:

  • Table aliada.user. This table is used to save the application's users accounts. This table is managed from the UI module.
  • Table aliada.organisation. This table is used to save data related to the organisation and data related to the URIs and HTML pages creation processes.
  • Table aliada.dataset. This table is used to save data related to the datasets belonging to the institutions. This table is managed from the UI module.
  • Table aliada.subset. This table is used to save data related to the subsets belonging to the datasets. This table is managed from the UI module.
  • Table aliada.profile. This table is used for saving the profiles to be used in the file importing and validation process.
  • Table aliada.template. This table is used for saving the templates to be used in the conversion process.
  • Table aliada.xml_tag. This table is used for saving the different tags, that the end-user could select to use in the conversion or not.
  • Table aliada.template_xml_tag. This table is used for saving the selected tags in the template.
  • Table aliada.t_character_set. This table is a type table for saving the different character sets that ALIADA's tool could use for the conversion module.
  • Table aliada.t_external_dataset. This table is used for saving the external datasets that ALIADA tool could use for the linking module.
  • Table aliada.t_file_format. This table is used for saving the file formats that ALIADA tool could use for the conversion module.
  • Table aliada.t_file_type. This table is used for saving the file types that ALIADA tool could use for the conversion module.
  • Table aliada.t_metadata_scheme. This table is used for saving the file formats that ALIADA tool could use for the conversion module.
  • Table aliada.t_profile_type. This table is used for saving the profile types that ALIADA tool could use for the conversion module.
  • Table aliada.t_user_role. This table is used for saving the user roles.
  • Table aliada.t_user_type. This table is used for saving the user types.
  • Table aliada.t_xml_tag_type. This table is used for saving the xml tag types.
  • Table aliada.user_session. This table is used for saving the users' jobs. This table is managed from the UI module.
  • Table aliada.t_template_entity. This table is used for saving the entities of the templates.
  • Table aliada.t_language. This table is used fo saving the available languages.

Table aliada.user

This table contains the following fields:

  • user_name: end-user name to log in the application.
  • user_password: end-user password.
  • user_email: the email of the end-user.
  • user_type_code: end-user user type.
  • user_role_code: end-user user role.
  • organisationId: the identifier of the organisation to which the user belongs to.

Table aliada.organisation

This table contains the following fields:

  • organisationId: the organisation identifier.
  • org_name: organization name in CKAN Datahub.
  • org_path: the directory where the file will be imported.
  • org_logo: the logo of the organisation, by default it is ALIADA's logo.
  • org_catalog_url: the url of the organisation catalog.
  • org_description: organization description.
  • org_home_page: organization home page.
  • aliada_ontology: the url of ALIADA's ontology. It is used by the RDF-izer and CKAN Datahub Page Creation modules.
  • tmp_dir: the name of the temporary folder to be used by the Links Discovery and CKAN Datahub Page Creation modules.
  • linking_client_app_bin_dir: the name of the folder where the links-discovery-task-runner.sh shell script has been installed.
  • linking_client_app_user: the machine´s user to execute the links-discovery-task-runner.sh shell script.
  • store_ip: IP address of the machine where the RDF store resides.
  • store_sql_port: port of the RDF store for SQL access.
  • sql_login: the login of the SQL access.
  • sql_password: the password of the SQL access.
  • isql_command_path: full path to the ISQL command.
  • isql_commands_file_dataset_default: full path of the ISQL commands default file to execute for the dataset. If the dataset.isql_commands_file_dataset field is null or it does not exist, this one will be used.
  • isql_commands_file_subset_default: full path of the ISQL commands default file to execute for the subset. If the subset.isql_commands_file_subset field is null or it does not exist, this one will be used.
  • isql_commands_file_graph_dump: full path of the ISQL commands file to dump the triples of a graph in Virtuoso into a compressed file, used in CKAN Datahub Page Creation module
  • virtuoso_http_server_root: full path of Virtuoso HTTP server root folder, where the web page for the dataset will be created from the Linked Data Server module
  • ckan_api_url: URL of the RESTful API of CKAN Datahub, used in CKAN Datahub Page Creation module
  • ckan_api_key: Key to use the RESTful API of CKAN Datahub, used in CKAN Datahub Page Creation module.
  • ckan_org_url: URL of the organization in CKAN Datahub. The value of this field will be written by the CKAN Datahub Page Creation module.
  • dataset_author: dataset default author name. E.g.: Aliada Consortium.
  • isql_commands_file_dataset_creation: full path of the ISQL commands file to create a dataset physically in Virtuoso. It will be called when the dataset is created from the admin area of the UI of ALIADA tool.

Table aliada.dataset

This table contains the following fields:

  • datasetId: the dataset identifier.
  • organisationId: the identifier of the organisation to which the dataset belongs.
  • dataset_desc: dataset name/short description.
  • domain_name: dataset domain name, e.g.: data.artium.org. This value will be configured by the systems administrator of the organization for the domain name to exist and to correspond with the port number specified in dataset.listening_hostfield.
  • uri_id_part: used to generate Identifier URI-s, e.g.: ”id”, URI: http://data.szepmuveszeti.hu/id/museumcollection/E18_Physical_Thing/szepmuveszeti.hu_object_29
  • uri_doc_part: used to generate Document URI-s, e.g.: ”doc”, URI: http://data.szepmuveszeti.hu/doc/museumcollection/E18_Physical_Thing/szepmuveszeti.hu_object_29 . It can be NULL, only if dataset.uri_concept_part is not NULL.
  • uri_def_part: used to generate the Ontology URI-s, e.g.: ”def”, URI: http://data.szepmuveszeti.hu/def/museumcollection
  • uri_concept_part: used in all URI types as a prefix to give a description of the dataset in the URI, e.g.: ”data”, URI: http://data.szepmuveszeti.hu/id/data/museumcollection/E18_Physical_Thing/szepmuveszeti.hu_object_29 . It can be NULL, only if dataset.uri_doc_part is not NULL.
  • uri_set_part: used to generate the subsets URI-s, e.g.: ”set” URI: http://data.artium.org/set/library/bib
  • listening_host: The address of the network interface the Virtuoso HTTP server uses to listen and accept connections. It will have the form of ":port_number". When creating a new dataset, it will never be located in the default port of Virtuoso indicated in “virtuoso.ini” file (8890 by default), because the default page of Virtuoso would be overridden. Possible values: 8891, 8892, 8893, 8894 ...
  • virtual_host: It will be the virtual host name that the browser presents as Host: entry in the request headers. i.e. Name-based virtual hosting. It will have the same value than dataset.domain_name.
  • sparql_endpoint_uri: SPARQL endpoint URI. The value of this field will be: http:// + dataset.virtual_host + “/sparql-auth”.
  • sparql_endpoint_login: SPARQL endpoint user name. The value of this field will be the "SPARQL-AUTH USERNAME" specified in Step 1: Install and configure Open Link Virtuoso.
  • sparql_endpoint_password: SPARQL endpoint password. The value of this field will be the "SPARQL-AUTH PASSWORD" specified in Step 1: Install and configure Open Link Virtuoso.
  • public_sparql_endpoint_uri: public SPARQL endpoint URI. The value of this field will be: http:// + dataset.virtual_host + “/sparql”.
  • dataset_author: the author of the dataset.
  • dataset_author_email: the e-mail of the author of the dataset.
  • ckan_dataset_name: dataset name in CKAN datahub. It cannot contain neither upper-case characters nor spaces. E.g.: datos-artium-org
  • dataset_long_desc: dataset long description to be used in CKAN datahub.
  • dataset_source_url: URL of the data source from where the dataset has been generated.
  • license_ckan_id: CKAN license identifier of the dataset to be published in CKAN datahub. E.g.: cc-zero. See http://opendefinition.org/licenses/ and http://datahub.io/api/action/license_list for possible values of the licences in CKAN Datahub.
  • license_url: license URL of the dataset to be published in CKAN datahub. E.g.: http://creativecommons.org/publicdomain/zero/1.0/
  • isql_commands_file_dataset: full path of the ISQL commands file to execute for the dataset. If it is null or it does not exist, the organisation.isql_commands_file_dataset_default field will be used.
  • dataset_web_page_root: full path of the dataset web page folder.

Table aliada.subset

This table contains the following fields:

  • datasetId: the identifier of the dataset to which the subset belongs.
  • subsetId: the subset identifier.
  • subset_desc: the description of the subset.
  • uri_concept_part: used in all URI types as a prefix to give a description of the subset in the URI, e.g.: ”museumcollection”, URI: http://data.szepmuveszeti.hu/id/data/museumcollection/E18_Physical_Thing/szepmuveszeti.hu_object_29.
  • graph_uri: URI of the graph in Virtuoso where the generated RDF triples are saved.
  • links_graph_uri: URI of the graph in Virtuoso where the discovered links are saved.
  • isql_commands_file_subset: full path of the ISQL commands file to execute for the subset. If it is null or it does not exist, the linkeddataserver_job_instances.isql_commands_file_subset_default field will be used.

Table aliada.profile

This table contains the following fields:

  • profile_id: the profile identifier.
  • profile_name: the profile name.
  • profile_type_code: the profile type code. The options are: ILS, TMS, Drupal.
  • profile_description: the profile description.
  • metadata_scheme_code: the metadata scheme code. The options are: MARC21 Bibliographic, MARC21 Authority,LIDO, Dublin Core.
  • file_type_code: the file type code. The options are: Bibliographic, Authority, Museum Resource, Dublin Core.
  • file_format_code: the file format code. The option is: XML.
  • character_set_code: the character set code. The options are: MARC standard, AMICUS, Latin1.

Table aliada.template

This table contains the following fields:

  • template_id: the template identifier.
  • template_name: the template name.
  • template_description: the template description.
  • file_type_code: the code of the file type related to the template.

Table aliada.xml_tag

This table contains the following fields:

  • xml_tag_id: the xml tag identifier.
  • xml_tag_mandatory: if the xml tag is mandatory or not.
  • xml_tag_description: the xml tag description.
  • template_entity_code: the entity type code. The options are differents depending on the xml_tag_type_code.
  • xml_tag_type_code: the xml tag type code. The options are: MARC21 Bibliographic, MARC21 Authority, LIDO, DC.
  • language: the current language.

Table aliada.template_xml_tag

This table contains the following fields:

  • template_id: the template identifier.
  • xml_tag_id: the xml tag identifier.

Table aliada.t_character_set

This table contains the following fields:

  • character_set_code: the character set identifier.
  • character_set_name: the character set name.
  • character_set_description: the character set description.
  • language: the current language.

Table aliada.t_external_dataset

This table contains the following fields:

  • external_dataset_code: the external dataset identifier.
  • external_dataset_name: the external dataset name (e.g.: DBPedia, BNE).
  • external_dataset_name_ckan: the external dataset name in CKAN Datahub (e.g.: dbpedia, datos-bne-es).
  • external_dataset_description: the external dataset description (e.g.: Linked Data version of Wikipedia).
  • external_dataset_homepage: the external dataset homepage (e.g.: http://dbpedia.org).
  • external_dataset_linkingfile: template file to create the SILK configuration file (e.g.: /home/aliada/links-discovery/config/silk/aliada_dbpedia_config.xml).
  • external_dataset_linkingnumthreads: number of threads to configure the SILK process for searching links in the corresponding external dataset.
  • external_dataset_linkingreloadtarget: flag indicating whether the external dataset should be reloaded or not. It will be 0 by default, as the external dataset won´t change that much and it takes long to load it. It is enough to set this flag on once a year or so.
  • external_dataset_linkingreloadsource: flag indicating whether the ALIADA dataset should be reloaded or not. It will be 1 by default, as the imported dataset with ALIADA tool may change.
  • language: the current language.

Table aliada.t_file_format

This table contains the following fields:

  • file_format_code: the file format identifier.
  • file_format_name: the file format name.
  • file_format_description: the file format description.
  • language: the current language.

Table aliada.t_file_type

This table contains the following fields:

  • file_type_code: the file type identifier.
  • file_type_name: the file type name.
  • file_type_description: the file type description.
  • file_type_conversion_file: the file type conversion file for the input validation.
  • language: the current language.

Table aliada.t_metadata_scheme

This table contains the following fields:

  • metadata_code: the metadata scheme identifier.
  • metadata_name: the metadata scheme name.
  • metadata_description: the metadata scheme description.
  • metadata_conversion_file: the metadata scheme conversion file for the input validation.
  • language: the current language.

Table aliada.t_profile_type

This table contains the following fields:

  • profile_code: the profile identifier.
  • profile_name: the profile name.
  • profile_description: the profile description.
  • language: the current language.

Table aliada.t_user_role

This table contains the following fields:

  • user_role_code: the user role identifier.
  • user_role: the user role name.
  • user_role_descprition: the user role description.
  • language: the current language.

Table aliada.t_user_type

This table contains the following fields:

  • user_type_code: the user type identifier.
  • user_type: the user type name.
  • user_type_description: the user type description.
  • language: the current language.

Table aliada.t_xml_tag_type

This table contains the following fields:

  • xml_tag_type_code: the xml tag type identifier.
  • xml_tag_type_name: the xml tag type name.
  • xml_tag_type_description: the xml tag type description.
  • language: the current language.

Table aliada.user_session

This table contains the following fields:

  • user_name: name of the end-user logged in the application.
  • file_name: the imported file name.
  • datafile: the folder where the imported file is located.
  • profile: the selected profile identifier.
  • template: the selected template identifier.
  • graph: the graph identifier of the selected subset.
  • status: the status of the process.
  • job_id: the job identifier to recovery the rdfizer process.
  • links_disc_job_id: the links discovery job identifier to recovery the linking process.
  • linked_data_server_job_id: the linked data server job identifier to recovery the linking process.

Table aliada.t_template_entity

This table contains the following fields:

  • template_entity_code: The entity identifier.
  • template_entity_name: The entity name.
  • template_entity_description: The entity description.
  • xml_tag_type_code: The xml tag type identifier.
  • language: the current language.

Table aliada.t_language

This table contains the following fields:

  • language_code: The language code.
  • lang_code: Another language code.
  • lang_country: The language country.
  • language_name: The language name.
  • language_description: the language description.
  • language: the language identifier.