NOTE

IATI-Validator-Actual (v1) is Deprecated

• v1 of the IATI Validator is now deprecated and superseded by v2
• This repository is Archived and not maintained by IATI

Full Announcement

IATI Data Validator

Create data quality feedback for activity files in the data standard of the International Aid Transparency Initiative.

Please provide your feedback by using the Validator Feedback form on the tool or raise issues here on Github. Users who are unable to access Github or use the Validator Feedback form are welcome to share their feedback by emailing [email protected].

Provide feedback on specific issues

To help the IATI Technical Team sort through feedback efficiently, please provide separate comments/issues on:

• Reporting a bug (where something is not working e.g. broken links)
• Requesting a feature/enhancement e.g. improvement in visual design
• Questions/comments on how the rules and guidance are being checked by the new IATI Validator

Technical

Developer documentation is still work in progress.

The validator can be run as a Docker container, with all the required software and libraries.

Internally, the engine uses Ant for the workflow, and Saxon HE for data processing.

• Ant provides build targets to transform input files into processed files. Targets can be simple steps, or complete workflows consisting of multiple sub targets.

• Saxon HE provides XSLT transformations to process XML files, and produce XML, HTML and JSON outputs.

For more information see the online documentation

Using git

After cloning this repository, update the submodules recursively:

git submodule update --recursive

This will download the IATI-Rulesets, and within that, the Xspec testing library

Alternatively, clone the repository and submodules in one go with

git clone --recurse-submodules https://github.com/IATI/IATI-Validator-Actual.git

Building the container to run tests

Use the conventional docker build command:

docker build -t my_validator:latest .

Run the test suites:

docker run --rm my_validator test

Building/Pushing the image for deployment

Build Image

docker build -t iati-validator-actual:<version> .

Tag

docker tag iati-validator-actual:<version> gcr.io/iati-validator/iati-validator-actual:<version>

Push to Google Cloud Registry

docker push gcr.io/iati-validator/iati-validator-actual:<version>