A cruise in OpenVDM moves through a defined lifecycle from creation to finalization.

1. Setup New Cruise

Web UI: Configuration → Main → Setup New Cruise

Provide the Cruise ID and optional metadata (start date, vessel, PI, etc.), then click Setup New Cruise. OpenVDM will:

  1. Create <warehouse_base_dir>/<cruiseID>/ and its subdirectories, including the lowering base directory (Vehicle/ by default) when lowering components are on.
  2. Create the MD5 summary files and the data dashboard directory and manifest.
  3. Export the current OpenVDM configuration to <warehouse_base_dir>/<cruiseID>/.
  4. Clear out the PublicData share, if transferPublicData is on.
  5. Run any post-hook commands configured under postSetupNewCruise in openvdm.yaml.

2. Active Cruise

During the cruise:

  • Collection system transfers run on the configured interval, ingesting data from each system.
  • The data dashboard updates automatically after each transfer.
  • Cruise data transfers (backup drives, NAS) copy the growing cruise package.
  • The ship-to-shore transfer sends selected files to the shoreside data warehouse.
  • Lowerings can be created and finalised independently within the cruise.

Manual Actions

Transfers can be started from the main page at any time. The Configuration page also lists these Maintenance Tasks (named with your CRUISE_NAME):

Task Description
Rebuild Cruise Directory Re-create any missing subdirectories, and fix permissions
Rebuild Data Dashboard Re-run the plugins on all the cruise’s files
Rebuild MD5 Summary Recompute all checksums
Re-export the OpenVDM Configuration Re-export the configuration snapshot
Sync PublicData within Cruise Directory Copy the PublicData share into the cruise

3. Finalize Current Cruise

Web UI: Configuration → Main → Finalize Current Cruise

Finalization prepares the cruise package for archival:

  1. Runs post-hook commands under preFinalizeCurrentCruise.
  2. Runs every collection system transfer one last time, which also updates the data dashboard and MD5 summary.
  3. Copies the PublicData share into the cruise.
  4. Exports a final OpenVDM configuration snapshot.
  5. Runs post-hook commands under postFinalizeCurrentCruise.
  6. Runs every enabled cruise data transfer, so the backups include everything above.

Cruise ID Conventions

Cruise IDs must be filesystem-safe (no spaces or special characters). Common conventions include:

  • RR2401 — vessel prefix + year + sequential number
  • AT50-01 — vessel prefix + cruise number
  • NBP2310 — vessel code + year + month

The cruise ID is used as the top-level directory name and appears in all filenames generated by OpenVDM, so choose it carefully before starting.

Updated: