Skip to content

Getting Started

Jump to bottom
Thomas Francart edited this page Jul 3, 2020 · 3 revisions

Getting Started

Prerequisites

Make sure you have Java 11 installed.

Releases

Download latest release of ISSNBot, and unzip.

Folder content

Once unzipped, you will see:

  • issnbot-app-<version>-onejar.jar: the main application
  • input: the default folder in which to put input CSV files to load
  • output: the default folder in which ISSNBot will write its output files
  • error: the default folder in which ISSNBot will copy records in error
  • documentation: containing a few documentation files (but the main source of documentation is really this wiki)
  • parameters: parameters file to use if you want to save parameters to a file and call the command with @parameters/load_issn.properties instead of passing the options on the command line

Display the help message

Run :

java -jar issnbot-app-<version>-onejar.jar

This will display all the possibles commands and options for each command.

Commands and parameters

The synopsys for running ISSNBot is:

java -Dpassword=xxxxxxx -jar issnbot-app-<version>-onejar.jar <command> <options>

Where:

  • -Dpassword= is the password of the Wikidata account to use (by default, ISSNBot, should never be changed)
  • <command> is one of the command listed in the help message, typically load_issn or clean_serials
  • <options> is a serie of options to be passed to the command, as listed in the help message, using the = character between the option and its value, e.g. maxLag=6 limit=300 update

Using a parameters file

Instead of passing the commands in the command line, you can save them in a properties file under the parameters subfolder, and use a reference to that file preceded by the @ character when invoking the command e.g.:

java -Dpassword=xxxxxxx -jar issnbot-app-<version>-onejar.jar load_issn @parameters/load_issn.properties

Typical command line

java -Dpassword=xxxxxxx -jar issnbot-app-<version>-onejar.jar load_issn

This command will process all CSV records found in default input folder input, process them and write the expected action to be taken in the default output folder output, but will not send real updates to Wikidata, as the update flag is not set.

Clone this wiki locally