This document describes the HydrOffice QC Tools application (3.10). For the project page, go here.

2.2.11. Submission checks

2.2.11.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.66, 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.66, rigth side), click Submission checks v4.

submission check interface

Fig. 2.66 The Submission check interface.

  • After computing, the output window opens automatically, and the results are shown.

  • 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 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.11.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 2021 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_Records

            • Public_Relations_Constituent_Products

        • S-57_Files

          • Final_Feature_File

          • Side_Scan_Sonar_Contacts

        • Sonar_Data

          • HXXXXX_GSF 2

          • HXXXXX_HDCS 3

            • HXXXXX_MB

            • HXXXXX_SB

            • HXXXXX_SSS

            • HXXXXX_WC

            • VesselConfig

          • HXXXXX_MB 4

          • HXXXXX_SB 4

          • HXXXXX_SSS 4

          • HXXXXX_WC 4

          • VesselConfig 4

        • 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.



2.2.11.3. What do you get?

Upon completion of the execution of Submission checks you will receive a pop-up verification that the tool has completed and if there were any errors or warnings associated with the data structure (Fig. 2.67).

_images/submission_checks_results.png

Fig. 2.67 The output message at the end of Submission checks execution.

Submission checks produces a PDF document that indicates if there were errors or warnings with specific folders in the data submission structures.

Example of PDF results for submission checks

Fig. 2.68 An excerpt from the Submission checks pdf report.

The naming convention of the output files contains important information about the settings that were used to execute Submission Checks. Each setting is separated by a period in the naming convention. See Fig. 2.69.

naming convention of output file for Submission Checks

Fig. 2.69 Example naming convention for a Submission Checks output. In this example the user selected a “include TECSOU = laser”, “deconflict across grids” and Object Detection.