Manual for browser based interface
After installing locally, you can use the web interface by opening a web browser and type the address http://localhost:8080/. Then you can click on Start validating to start a new validation session. You can also always use the New validation button in the upper right corner to start over with a new validation.
At the top of the web page is a menu bar and a progress indicator. The logo to the left always take you to the start page. Validations in the menu will show recent done validations, GitHub will take you to our page with documentation and the source code and New validation will start over with a new validation. You can also use Go back to navigate to a previous step.
To start a validation, you first decide if you want to use a premade configuration package or use a custom configuration. The packages are predefined with schemas and rules that are commonly used together. To select your own combination of schemas and rules you can do a custom configuration.
If you select to use the premade packages you are presented with a list to select from. Select the one that works best with your validation requirements. When you click on one of the packages you continue to the selection of files.
With the custom configuration you can be more detailed in which NeTEx Profile and combination of rules to use. In the list of rules, you get brief description of each rule. Zero or more rules can be selected by clicking the checkbox for each rule.
Some rules use parameters as input to the validation. Those rules have a default value that can be changed by clicking on the Configure icon to the right.
The last step is to upload the files to be validated, it can be single files or multiple files compressed in an archive. Click Select file(s) to select which files to upload and then wait until all files has been uploaded, see the Status indicator in the files list.
If you want to get back to the selection of rules you can use the Go back button
When all files are uploaded you start the validation by clicking on Validate.
Each file is validated against the selected schema and rules, all validations run in parallel. Depending on the number of files and their sizes the validation can take some time to complete.
When the validation is done you get an overview of the result. You can see the status of the validation for each file. If there are any errors, you can get all the details by clicking on the down arrow to the right of each file.
The details display the number of times that specific error occurs in the file, and you can page between them with the arrows to the right. For each error you get information about the type, line number in the file and a more detailed explanation.
You can download the result for each error or the complete validation to a file in json or csv format to process it further. For example, to give as documentation to someone who can correct the error
Example of the saved data in json format.
At the bottom of the result page, you have an option Validate with this configuration to go back and start a new validation with the same configuration but with new files. You can also see recent validation by using the menu selection Validations at the top of the page. By clicking on the name of a job you will see the result page for that validation again.
Sometimes the web interface will show error messages if the Greenlight tool stops to execute. Often that occurs when the communication to the web server is lost, or the local Docker version has stopped. Check the status of your connection and that the Docker container is running if using it locally.
