Skip to main content
Version: 2.x (upcoming)

Evaluator services

These are the settings of the shipped evaluator services. Every evaluator also reads the settings common to all plugin services: IDP_ISSUER_URI, IDP_CLAIMS_ROLES_PATH, and SECURITY_AUDIENCE for authentication, PROFILE, and the logging settings. To make an evaluator available, register it in the API service with the RDA JSON transformer as its rdaTransformerId; see Registering plugin services.

Evaluator RDA maDMP​

Validates the plan's RDA JSON export against the RDA maDMP schema. Image opencdmp/evaluator-rda-madmp on Docker Hub, plugin id rda-maDMP.

Env VariableDescriptionRequiredDefault ValueExample
RDA_MADMP_RDA_SCHEMAJSON schema of the RDA maDMP standard that plans are validated against.Noclasspath:schema/rda-schema.jsonfile:/config/rda-schema.json
RDA_MADMP_HAS_LOGOShow the evaluator's logo in the user interface.Notruetrue
RDA_MADMP_LOGO_PATHImage of the logo.Noclasspath:rda.pngfile:/config/rda.png
RDA_MADMP_USE_SHARED_STORAGEReceive the RDA JSON file through a shared folder; see Shared storage. Uses STORAGE_PATH.Nofalsetrue

Evaluator OSTrails​

Sends the plan's RDA JSON export to the OSTrails DMP Evaluation Service. Image opencdmp/evaluator-ostrails-dmp-evaluation-service on Docker Hub, plugin id ostrails.

Env VariableDescriptionRequiredDefault ValueExample
OSTRAILS_EVALUATOR_BASE_URLBase URL of the OSTrails DMP Evaluation Service that the evaluator calls.Yes-https://dmp-evaluation.example.org
OSTRAILS_EVALUATOR_USE_REMOTE_BENCHMARKSRead the available benchmarks from the OSTrails service. When false, the evaluator offers the benchmarks listed in its configuration file.Notruetrue
OSTRAILS_EVALUATOR_USE_REMOTE_TESTSRead the available tests from the OSTrails service. When false, the evaluator offers the tests listed in its configuration file.Notruetrue
OSTRAILS_EVALUATOR_HAS_LOGOShow the evaluator's logo in the user interface.Notruetrue
OSTRAILS_EVALUATOR_LOGO_PATHImage of the logo.Noclasspath:ostrails.pngfile:/config/ostrails.png
OSTRAILS_EVALUATOR_USE_SHARED_STORAGEDeclared by the evaluator, which has no shared folder. Leave it false.Nofalsefalse

Evaluator OpenAIRE FAIR​

Asks the OpenAIRE validator to assess the published record of each asset against the FAIR guidelines. Plugin id openaire-fair.

Env VariableDescriptionRequiredDefault ValueExample
FAIR_EVALUATOR_BASE_URLBase URL of the OpenAIRE service that evaluates records against the FAIR guidelines.Yes-https://validator.example.org
FAIR_EVALUATOR_USE_REMOTE_BENCHMARKSRead the available guidelines from the OpenAIRE service. When false, the evaluator offers the guidelines listed in its configuration file.Notruetrue
FAIR_EVALUATOR_HAS_LOGOShow the evaluator's logo in the user interface.Notruetrue
FAIR_EVALUATOR_LOGO_PATHImage of the logo.Noclasspath:openaire.pngfile:/config/openaire.png
FAIR_EVALUATOR_USE_SHARED_STORAGEDeclared by the evaluator, which has no shared folder. Leave it false.Nofalsefalse

See also​