inst-reports

README

Inst Reports
============

This program generates reports with publication lists of Jülich institutes.
The lists contain only those publications that are countable for the current
annual report of the research centre Jülich.


Running the server
------------------

Prerequisites are currently simple since only Go and LibreOffice Calc must be
installed.

Then, you run the server by installing it with
::

    go install jugit.fz-juelich.de/fdm/inst-reports@latest

and then calling ``inst-reports``.  It listens for HTTP connections on
port 8000.

It takes the following required environment variables:

MONGODB_HOST
  This is the URL to the MongoDB server.  It defaults to ``mongodb://mongodb``.

MONGODB_NAME
  Name of the database in the MongoDB.  It defaults to “datapubs”.

JUSER_USERNAME
  The name of a user on JuSER that is allowed to see the timestamps of last
  modification in the 961\__ fields.

JUSER_PASSWORD
  The password of that user.

JUSER_LOGIN_METHOD
  The login method, e.g. “``FZJ eMail-Account``”.

The directory ``/var/cache/inst-reports`` must be writeble to the process.
Make sure that the \*.tpl files and the ``static`` directory (and its content)
are in the current working directory of the process.


Routes
------

``/``
  Main page with the institute list.

``/<institute ID>``
  Publication report for that institute.  Note that the ID is not the
  abbreviated name, but its JuSER ID, e.g. ``I:(DE-Juel1)ZB-20090406``.

``/<institute ID>/ods``
  Publication report for that institute in the OpenDocument ODS format.


Setting up test database
------------------------

::

  mongodump --archive=/tmp/datapubs.dump --db=datapubs && \
    mongorestore --archive=/tmp/datapubs.dump --drop --nsFrom='datapubs.*' --nsTo='datapubs_test.*'


Todos
-----

``getCurrentInsts`` should use the MongoDB collection “institutes”.  This way,
there would be no Invenio dependency left.

Documentation

Overview

inst-reports is a web server that presents publications lists of the current report year to Jülich institutes. The institutes can check whether all their publications are properly counted. It works stateless and only caches some results.

This file contains code for retrieving the current full set of institutes.