This document describes the HydrOffice QC Tools 2 application (2.7). For the project page, go here.
2.2.10. Submission checks¶
2.2.10.1. How To Use?¶
Ensures the required directory structure and completeness of survey deliverables.
- Select the Submission checks tab on the bottom of the QC Tools interface.
Drag-and-drop (or browse “+” to) the directory to be examined. This can be at the survey level (“X#####”). Alternatively, the root folder may be at the project level (“OPR-X###-XX-##”), which will then examine all survey folders and project reports found within.
Flag the Non-OPR project check if the submission survey folder does not start with OPR-.
In Parameters (Fig. 2.32, left side):
- Turn the knob to select either the Field or Office profile.
- Turn the knob to select either Exhaustive or Recursive settings. If an error is found, Recursive will stop at the level of the error; conversely, Exhaustive will continue to check sub-folders that are likely to perpetuate the error found at the higher level.
- Turn the knob to select the applicable year as pertaining to required Hydrographic Survey Specifications.
- Flag the HXXXXX_GSF (NOAA only) check if the submission is from a NOAA field unit.
In Execution (Fig. 2.32, rigth side), click Submission checks v3.
Fig. 2.32 The Submission check interface.
- After computing, the output window opens automatically, and the results are shown (Fig. 2.33).
Fig. 2.33 The Submission check output message.
Note that the project level (“OPR-X###-XX-##”) contains all the results from the surveys (“X#####”) contained within; thus the number of errors and warnings is equivalent to the sum of the individual components.
The results are printed to PDF, one for each root folder.
The output names adopt the following convention:
- [project].SCv3.[“project” | “X#####” | “report”].[HSSD].[profile].[“rec” for recursive | “exh” for exhaustive]
The output will be exported under a subfolder (H#####) in the output location defined on the data import tab. If “sub-folders” is selected in the import tab, the file will be placed in an additional “submissions” sub-folder within the survey folder.
2.2.10.2. How Does It Work?¶
Root folders have the following requirements:
- A project root folder must be in the format of “OPR-X###-XX-##” or “OPR-X###-XX-##_Locality_Name” (unless the Non-OPR project check is on).
- A survey root folder must be in the format of “X#####” or “X#####_Sublocality_Name”.
- A project reports root folder must be in the format of “Project_Reports”.
The ensuing submission check will scan the directories of the root folders to ensure compliance with Appendix J of the HSSD.
The logic for the 2018 QC Tools submission check is shown below. For previous years, refer to the HSSD for that year.
- OPR-X###-XX-##
- X##### [1]
- Raw
- Features
- MBES
- SBES
- SSS
- SVP
- WC
- Processed
- GNSS_Data
- SBET
- Multimedia
- Reports
- Project
- DAPR
- Report
- Appendices
- HVCR
- Digital_A-Vertical_Control_Report
- Digital_B-Horizontal_Control_Data
- ATON_Data
- Base_Station_Data
- Project_Correspondence
- Survey
- Descriptive_Report
- Appendices
- I_Water_Levels
- II_Supplimental_Survey_Records_Correspondence
- Public_Relations_Constituent_Products
- Separates
- I_Acquisition_Processing_Logs
- Detached_Positions
- Digital_Data
- Crossline_Comparisons
- Sound_Speed_Data_Summary
- S-57_Files
- Final_Feature_File
- Side_Scan_Sonar_Contacts
- SVP
- Water_Levels
Additional Checks:
- An empty folder will be flagged as an error.
- No filepaths may exceed 200 (field) or 260 characters (office).
Footnotes
| [1] | Subfolders will not be checked if an error is found at this level (Recursive setting only). |
| [2] | For NOAA only submissions. |
| [3] | For submissions with CARIS projects. |
| [4] | (1, 2, 3, 4, 5) For submissions without CARIS projects. |
