Project Logs

This page describes the implemented exceptions that are logged in a project’s exception log.

Client Side Logs

Exceptions caught on the client side are exceptions and events that occurred in the participants' browser when donating data or filling out the questionnaire.

Data Donation Logs

INVALID_ZIP
Description: Indicates that an uploader expects a ZIP-file but a different file-type was uploaded.

ZIP_READ_FAIL
Description: Indicates that an error occurred trying to read a ZIP-file. The message contains a JSON object with the underlying reader error (error), and, for a failed nested archive, its path within the container (nestedZipPath) and nesting depth (depth).

INVALID_REGEX
Description: Indicates that an invalid RegEx was provided as blueprint path.

INVALID_FIELD_REGEX
Description: Indicates that an invalid RegEx was provided as field name.

NO_FILE_MATCH
Description: Indicates that a ZIP-container did not contain the file as defined on the blueprint.

FILE_PROCESSING_FAIL_GENERAL
Description: Indicates that an unexpected error occurred during processing of a file’s content.

STRING_CONVERSION_ERROR
Description: Indicates that a file’s content could not be converted to a string.

NO_FIELDS_TO_EXTRACT
Description: Indicates no fields were defined that should be kept in the data donation. (In older logs this exception was named NO_EXTRACTION_RULES.)

PARSING_ERROR
Description: Indicates that an error occurred when trying to parse a file’s content.

UNSUPPORTED_BP_FORMAT
Description: Indicates that the file type that a blueprint wants to extract is not supported (currently, unlikely to ever occur - implemented for potential future use cases).

MORE_THAN_ONE_KEY_MATCH
Description: Indicates that more than one key (or field/variable) contained in a file matched the field name defined in an extraction rule.

NESTED_PATH_NOT_FOUND
Description: Indicates that a configured nested path was not found in the uploaded file.

EXTRACTION_ROOT_NOT_FOUND
Description: Indicates that the extraction root path configured on the blueprint could not be resolved in the uploaded file.

The following three entries are not errors. They are diagnostic summaries written once per blueprint on every successful processing run, to help monitor data quality.

EXTRACTION_STATS
Description: Contains a summary of the data extraction procedure. Includes the number of rows with a missing field (nRowsMissingField), the number of rows that were filtered out (nRowsFilteredOut), the total number of extracted rows (nRowsTotal), and information on how often and which rule fields could not be found in the file (noKeyMatches).

EXTRACTION_LOG
Description: Contains a summary of how many times each extraction rule was applied to the data during the data extraction procedure — both row filtering and regex transformations (is a dictionary where the keys represent the extraction rule IDs and the values the counts).

EXTRACTED_FIELDS_MAP
Description: Contains a summary of which field names in the extracted files where matched with which extraction rule field name during the data extraction procedure.

Questionnaire Logs

Currently, not implemented. May be implemented in the future.