DeploymentDatabase
The original Deployment Database (DDB) is an MS-Access database which contains information about all deployments, instruments, personnel and sites for a specific location. Other specific-user database can be used if a minimum interface requirements are met.
In the toolbox, the DDB/executeDDBQuery function acts as a wrapper around the DDB, and returns query results as vectors of matlab structs. This means that no conversion between Java-Matlab types is necessary.
The complete MS-Access DDB schema is shown below:
If one is willing to build its own deployment database, there is a minimum list of requirements to respect in order to prevent the current version of imos-toolbox from crashing (only for versions strictly above 1.5.5).
The following subsection details these requirements:
- All of these tables and fields must be present
- Table and field names must be identical (case sensitive)
- Field types must be identical/compatible
- A few fields may not be mandatory if they are removed from the default NetCDF template (GA -> global attribute in NetCDF\template\global_attributes.txt, VA -> variable attribute in NetCDF\template\variable_attributes.txt)
| Table Name | Field Name | Data Type | Description | Status | NetCDF default template |
|---|---|---|---|---|---|
| FieldTrip | FieldTripID | Text | Field Trip ID - use AIMS Log Req Number | Mandatory | |
| FieldTrip | FieldDescription | Memo | Descriptive text for field trip | Mandatory | |
| FieldTrip | DateStart | Date/Time | Start date for field trip | Mandatory | |
| FieldTrip | DateEnd | Date/Time | End date for field trip | Mandatory | |
| DeploymentData | DeploymentId | Text | Code-generated unique ID | Mandatory | |
| DeploymentData | EndFieldTrip | Text | Field Trip number | Mandatory | |
| DeploymentData | Site | Text | Use to link to sites data table (which contains lat and long) | Mandatory | |
| DeploymentData | InstrumentID | Text | Use to link to Instruments_Id in Instruments table (Instrument description) | Mandatory | |
| DeploymentData | FileName | Text | Catalogue number/Sample number/File name - should ideally be a unique identifier | Mandatory | |
| DeploymentData | TimeSwitchOn | Date/Time | Time instrument is switched on | Mandatory | |
| DeploymentData | TimeFirstWet | Date/Time | Time instrument first in water | Mandatory | |
| DeploymentData | TimeFirstInPos | Date/Time | Time instrumentfirst in position | Mandatory | |
| DeploymentData | TimeLastInPos | Date/Time | Time istrument last in position | Mandatory | |
| DeploymentData | TimeOnDeck | Date/Time | Time instrument on deck | Mandatory | |
| DeploymentData | TimeSwitchOff | Date/Time | Time instrument switched off | Mandatory | |
| DeploymentData | TimeFirstGoodData | Date/Time | Time of first good data | Mandatory | |
| DeploymentData | TimeLastGoodData | Date/Time | Time of last good data | Mandatory | |
| DeploymentData | TimeZone | Text | Time zone eg UTC,CST etc | Mandatory | |
| DeploymentData | InstrumentDepth | Number | Depth of instrument/sample | Mandatory | GA.geospatial_vertical_min, GA.geospatial_vertical_max, VA.sensor_depth |
| DeploymentData | Comment | Memo | Any additional comment to be attached to record | Optional if removed from template, otherwise mandatory | GA.comment |
| Instruments | InstrumentID | Text | Unique ID for instrument | Mandatory | |
| Instruments | Make | Text | Select existing make from list or add new one | Mandatory | GA.source |
| Instruments | Model | Text | Select existing model from list or add new one | Mandatory | GA.source, GA.keywords |
| InstrumentSensorConfig | InstrumentID | Text | Unique ID for instrument | Mandatory | |
| InstrumentSensorConfig | SensorID | Text | Unique ID for sensor | Mandatory | |
| InstrumentSensorConfig | CurrentConfig | Yes/No | Is this the current Instrument/Sensor configuration | Mandatory | |
| Sensors | SensorID | Text | Unique ID for sensor | Mandatory | |
| Sensors | Parameter | Text | IMOS parameter codes, comma separated, measured by the sensor | Mandatory | |
| Sensors | SerialNumber | Text | Enter serial number for sensor | Mandatory | VA.sensor_serial_number |
| Sites | Site | Text | Unique Site ID | Mandatory | |
| Sites | SiteName | Text | Site Name (Not unique) | Mandatory | |
| Sites | Longitude | Number | Longitude in decimal degrees of Deployment | Optional if removed from template, otherwise mandatory | GA.geospatial_lon_min, GA.geospatial_lon_max |
| Sites | Latitude | Number | Latitude in decimal degrees of Deployment | Optional if removed from template, otherwise mandatory | GA.geospatial_lat_min, GA.geospatial_lat_max |
| Sites | Description | Text | Enter description of site: eg, Scott Reef Lagoon | Mandatory | GA.abstract |