Skip to content
Switch branches/tags
Go to file

Latest commit


Git stats


Failed to load latest commit information.
Latest commit message
Commit time


Copyright (C) 2018-2020 The Open Library Foundation

This software is distributed under the terms of the Apache License, Version 2.0. See the file "LICENSE" for more information.


git clone ...
cd mod-erm-usage
mvn clean install

Run plain jar

cd mod-erm-usage-server
env \
DB_USERNAME=folio_admin \
DB_PASSWORD=folio_admin \
DB_HOST=localhost \
DB_PORT=5432 \
DB_DATABASE=okapi_modules \
java -jar target/mod-erm-usage-server-fat.jar

Run via Docker

Build docker image

$ docker build -t mod-erm-usage .

Run docker image

$ docker run -p 8081:8081 -e DB_USERNAME=folio_admin -e DB_PASSWORD=folio_admin -e DB_HOST= -e DB_PORT=5432 -e DB_DATABASE=okapi_modules mod-erm-usage

Register ModuleDescriptor

$ cd target
$ curl -w '\n' -X POST -D - -H "Content-type: application/json" -d @ModuleDescriptor.json http://localhost:9130/_/proxy/modules

Register DeploymentDescriptor

Change nodeId in DockerDeploymentDescriptor.json to e.g. your hosts IP address (e.g. Then execute:

$ curl -w '\n' -X POST -D - -H "Content-type: application/json" -d @DockerDeploymentDescriptor.json http://localhost:9130/_/discovery/modules

Activate module for tenant

$ curl -w '\n' -X POST -D - -H "Content-type: application/json" -d '{ "id": "mod-erm-usage-1.0.0"}' http://localhost:9130/_/proxy/tenants/diku/modules

Upload sample data

Sample data resides in the folder sample-data. The data need to be posted in the following order:

  1. The folder sample-data/vendor-storage/vendors/ contains vendors which are referenced by the sample data. These need to be posted to http://okapiHost:9130/vendor-storage/vendors
  2. The folder sample-data/aggregator-settings/ contains an aggregator. This file needs to be posted to http://okapiHost:9130/aggregator-settings
  3. The folder sample-data/usage-data-providers/ contains the usage-data-providers. A usage-data-provider references a vendor and eventually an aggregator. These files need to be posted to http://okapiHost:9130/usage-data-providers

Additional information

Issue tracker

See project MODEUS at the FOLIO issue tracker.

Other documentation

Other modules are described, with further FOLIO Developer documentation at


Store ERM usage statistics and access data to these statistics




No packages published