Skip to content

HowTo ConfigureSKOSPlay

Jump to bottom
tfrancart edited this page Oct 6, 2017 · 31 revisions

How to configure SKOS Play

skosplay-application.properties

SKOS Play is configured with a main properties file called skosplay-application.properties.

Where is located skosplay-application.properties ?

  1. If that file is not present, the application assumes default or empty values for every properties.

  2. By default, the application tries to read the system property "skosplay.home", and tries to read the configuration file under <skosplay.home>/conf/skosplay-application.properties; to set the system property "skosplay.home", you typically need to insert an option "-Dskosplay.home=/where/skosplay/config/lives" to the Java command line that runs Tomcat. Typically this is done either with :

    • if you installed Tomcat manually (not through the package), create and edit a setenv.[sh | bat] file in Tomcat bin directory, and assign the JAVA_OPTS variable in it. More details in Tomcat documentation;
    • if you installed Tomcat using a package on Linux (Ubuntu), the Tomcat startup scripts reads a config file in /etc/default/tomcat7, in which the JAVA_OPTS option is defined. Edit this line, that can typically look like this :
#!bash


JAVA_OPTS="-Djava.awt.headless=true -Xmx1024m -Xms256m -XX:+UseConcMarkSweepGC -Dskosplay.home=/var/lib/tomcat7/skosplay -Dfile.encoding=UTF-8"
  1. If the "skosplay.home" system property is not present, the application tries to read the file skosplay-application.properties in the current folder; this defaults to the Tomcat "bin" directory if you have installed tomcat manually (not with the packages);

Configuration properties

skosplay.thesaurus.directory

  • Path to the directory containing additionnal thesaurus examples. This directory should contain one subdirectory for every thesaurus you wish to make available by default in the application. Each subdirectory should contain one or more RDF files containing the thesaurus data.
  • This directory should also contain a file named "thesaurus-label.properties" that contain as keys the name of the subdirectories containing the data, and as values the label to display. This file is read as a Java resource file if you need multilingual labels (so in this case, you can create e.g. "thesaurus-label_en.properties" and "thesaurus-label_fr.properties").
  • Exemple :
#!properties

skosplay.thesaurus.directory=/home/thomas/skosplay/data
  • Exemple of thesaurus-labels.properties
#!properties

01-unesco=UNESCO Thesaurus
02-eurovoc=EUROVOC Thesaurus (26 lang. + mapping to INSPIRE)
03-reegle=Reegle clean energy thesaurus

skosplay.concepts.limit

  • Maximum number of concepts that the installation can process
  • Exemple :
#!properties

skosplay.concepts.limit=5000

skosplay.display.disabled

  • comma-separated list of display identifier to exclude from the list of possible displays. Possible values are :
    • CONCEPTLISTING
    • TRANSLATION_TABLE
    • ALPHABETICAL
    • ALPHABETICAL_EXPANDED
    • HIERARCHICAL
    • COMPLETE_MONOLINGUAL
    • COMPLETE_MULTILINGUAL
    • PERMUTED_INDEX
    • KWIC_INDEX
    • ALIGNMENT_ALPHA
    • ALIGNMENT_BY_SCHEME
  • Exemple :
#!properties
# disable the options to display alignments
skosplay.display.disabled=ALIGNMENT_ALPHA, ALIGNMENT_BY_SCHEME

skosplay.viz.disabled

  • comma-separated list of visualisation identifiers to exclude from the list of possible visualisations. Possible values are :

    • PARTITION
    • TREELAYOUT
    • SUNBURST
    • AUTOCOMPLETE

  • Exemple :

#!properties
# disable the autocomplete field generation
skosplay.viz.disabled=AUTOCOMPLETE

skosplay.output.disabled

  • an output type (PDF or HTML) to disable. Typically used to disable PDF rendering. Onely one value is allowed. Possible values are :

    • PDF
    • HTML

  • Exemple :

#!properties
# disable the PDF output
skosplay.output.disabled=PDF

skosplay.mode.publishing

  • A boolean value to set the application in publishing-only mode. False by default. In publishing mode :
    • the user can only select a vocabulary from the ones included in the application (other input methods, like file upload, are disabled);
    • advanced options panel is hidden;
  • Exemple :
#!properties
skosplay.mode.publishing=true

skosplay.customCss.path

  • Path to a CSS file on the disk to customize the screen rendering.
  • Exemple :
#!properties
skosplay.customCss.path=${skosplay.home}/style/myCustomCss.css

skosplay.application.title

  • Title that will be inserted in the application pages
  • Exemple :
#!properties
skosplay.application.title=SKOS Play! Thesaurus & Taxonomies
Clone this wiki locally