Difference between revisions of "Data Validation module"
m |
m |
||
| Line 4: | Line 4: | ||
The Data Validation module accepts the data as [[#CSVFiles|CSV]] files from a researcher and validates the file content against the values defined in the data dictionary. It then creates [[#SubmissionPackage|a submission package]]. If everything is OK, the Data Validation module creates a submission ticket and submission package. After that data a good for uploading. | The Data Validation module accepts the data as [[#CSVFiles|CSV]] files from a researcher and validates the file content against the values defined in the data dictionary. It then creates [[#SubmissionPackage|a submission package]]. If everything is OK, the Data Validation module creates a submission ticket and submission package. After that data a good for uploading. | ||
| − | If any validation errors or warnings are found, the module provides [[# | + | If any validation errors or warnings are found, the module provides [[#ErrorLog|a detailed report]] of any data discrepancies, [[#ErrorMessages|errors, and warnings received]]. |
Validation warnings are just warnings and they did not prevent creating of the submission package. However, if any validation errors are found, [[#SubmissionPackage|a submission package]] cannot be created. In that case, the researched should edit data to fix all errors, first, and then re-validate the data. | Validation warnings are just warnings and they did not prevent creating of the submission package. However, if any validation errors are found, [[#SubmissionPackage|a submission package]] cannot be created. In that case, the researched should edit data to fix all errors, first, and then re-validate the data. | ||
| Line 17: | Line 17: | ||
For more information about CSV files for data uploading, contact the data dictionary operations team - TBD. | For more information about CSV files for data uploading, contact the data dictionary operations team - TBD. | ||
| + | <div id="SubmissionPackage"><div> | ||
== Submission package == | == Submission package == | ||
The submission package includes: | The submission package includes: | ||
| − | * A submission ticket (XML), | + | * A submission ticket (XML), see an example below |
* A data file (XML) | * A data file (XML) | ||
| + | '''An example of a submission ticket:''' | ||
<code> | <code> | ||
<?xml version="1.0" encoding="UTF-8" standalone="true"?> | <?xml version="1.0" encoding="UTF-8" standalone="true"?> | ||
| − | -<submissionTicket environment="production" version="2.0.2.108">-<submissionPackage types="CLINICAL" crcHash="55830a2aa77164ea834942e65e319a38" dataFileBytes="241686" bytes="19233" name="dataFile-1373248220203">-<datasets><dataset crcHash="82ff11c787fc3086ce5bbd9e7518e279" bytes="19233" name="WardMinus2DemoGUIDS.csv" type="CLINICAL" path="C:\Users\ | + | -<submissionTicket environment="production" version="2.0.2.108">-<submissionPackage types="CLINICAL" crcHash="55830a2aa77164ea834942e65e319a38" dataFileBytes="241686" bytes="19233" name="dataFile-1373248220203">-<datasets><dataset crcHash="82ff11c787fc3086ce5bbd9e7518e279" bytes="19233" name="WardMinus2DemoGUIDS.csv" type="CLINICAL" path="C:\Users\user1\Documents\TBI 2013\CSV\sampleCSV.csv"/></datasets><associatedFiles/></submissionPackage> |
| + | </submissionTicket> | ||
</code> | </code> | ||
== Running the Data Validation module == | == Running the Data Validation module == | ||
| + | |||
| + | <div id="ErrorLog"><div> | ||
| + | == Error log == | ||
Revision as of 16:30, 23 July 2013
In order to ensure the quality of uploaded data and also to make data easy to query, data should be submitted in a specific format and range values should comply with the values defined in the data dictionary. All submitted research data must be validated against the values defined in the data dictionary prior to submission. To facilitate this process, we provide the Data Validation module that assists researchers with the submission of their data.
Contents
Introduction
The Data Validation module accepts the data as CSV files from a researcher and validates the file content against the values defined in the data dictionary. It then creates a submission package. If everything is OK, the Data Validation module creates a submission ticket and submission package. After that data a good for uploading.
If any validation errors or warnings are found, the module provides a detailed report of any data discrepancies, errors, and warnings received.
Validation warnings are just warnings and they did not prevent creating of the submission package. However, if any validation errors are found, a submission package cannot be created. In that case, the researched should edit data to fix all errors, first, and then re-validate the data.
System requirements
The most recent version of Java Runtime Environment (JRE) (6 or 7) is required in order to run the Data Validation module.
CSV files
The structure of a [CSV file should match a corresponding form structure queryable by the query tool.
For more information about CSV files for data uploading, contact the data dictionary operations team - TBD.
Submission package
The submission package includes:
- A submission ticket (XML), see an example below
- A data file (XML)
An example of a submission ticket:
<?xml version="1.0" encoding="UTF-8" standalone="true"?>
-<submissionTicket environment="production" version="2.0.2.108">-<submissionPackage types="CLINICAL" crcHash="55830a2aa77164ea834942e65e319a38" dataFileBytes="241686" bytes="19233" name="dataFile-1373248220203">-<datasets><dataset crcHash="82ff11c787fc3086ce5bbd9e7518e279" bytes="19233" name="WardMinus2DemoGUIDS.csv" type="CLINICAL" path="C:\Users\user1\Documents\TBI 2013\CSV\sampleCSV.csv"/></datasets><associatedFiles/></submissionPackage>
</submissionTicket>
