Note |
---|
Project specific best practices and recommendations are listed under "§ Projects" Questions, feedback? Contact o2a-support@awi.de or the respective chief editor(s) for your project data team |
An item is a general term for describing platforms, devices or sensors. Platforms generally carries 1-n devices which in turn may also have their own (sub)devices.
Every item must be assigned to a type. For example the platform "Polarstern" is an item of type "Vessel" whereas the "TM_Ice_Corer_2 and UAF_TM_Ice_Corer_3" is an item of type "Corer". A full list of available item types (with more or less helpful descriptions) can be found here.
While creating a new item, you need to consider whether it should be tagged to a classical platform type (e.g. Vessel, Station, Vehicle, etc) or not. When in doubt, please send a support request to o2a-support (at) awi.de or consult directly with a chief editor assigned to your project.
You will be requested to assign a short name for all items you want to create. Items are uniquely identified via a local URN identifier (URN means Uniform Resource Locator) using the item type and individual short name syntax .. Example: vessel:ms_hel:fb_740602 points to the ferrybox on MS Helgoland.
While creating a short name for your device, keep in mind that the short names cannot be modified once created because they are in-use within INGEST and STORAGE (for setting the path to data files for a particular item). Be also aware that you cannnot create items with the same short name under one parent item.
In case you do need to change a short name, please contact o2a-support@awi.de
Children Display | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
|
The "Contact" tab supports different roles:
Make sure the following contacts have been at least assigned to your item:
In addition to entering the roles "editor" and "affiliation" of an item, we advise you to also enter the principal investigator. This is particular relevant as metadata for our data services. As you can see in the figure some roles are inherited from the parental device.
If in doubt, please send a support request to o2a-support (at) awi.de or consult directly with a chief editor assigned to your project.
example json of the action created above:
In order to add certain "Actions" to the devices, several ways are available:
Name | Description | Mandatory/Optional |
---|---|---|
Label | reasonable, coherent, and unique name of the event | Mandatory |
Event Type | see table below | Mandatory |
From | point in time when the event started | Mandatory |
To | point in time when the event ended | Mandatory |
Description | detailled description of the event, its circumstances, background, etc. | Optional |
Latitude | aka N or S | Optional |
Longitude | aka E or W | Optional |
Elevation | applies to depth too, below water surfaces rather negative integers, else positive integers | Optional |
Some of the assigned Actions automatically create a new version of the device (including a handle, such as https://hdl.handle.net/10013/sensor.177e9789-d85f-4c68-b6e0-fd496078a6e7) which is mandatory to find the ingested data sets in the data web service (https://dashboard.awi.de/data-xxl/) if the device is reassigned.
Event Type | ID | Description |
---|---|---|
Calibration | 15 | The item was recalibrated, the respective Calibration certificates and/or associated documents should be supplied via the Resources tab in the upper navigation banner. |
Commissioned | 215 | This Event Type applies to large-scale platforms, such as land-based stations, research vessels, and aircrafts. It describes the beginning of the operational use of this device. |
Decommissioned | 216 | This Event Type applies to large-scale platforms, such as land-based stations, research vessels, and aircrafts. It describes the end of the operational use of this device. |
Deployment | 187 | A device is deployed, means it is in operational use. Deployment applies to small-scale vehicles and ship-operated devices, such as CTD rosettes, buoys, etc.. |
Maintenance | 16 | The Event Type Maintenance describes functional checks, servicing, repairing or replacing of parts. The device might still be operational, but the device's measurements might be affected by means of maintenance. |
Mission | 182 | A Mission refers to the device's operation within a defined range of time and purpose. |
Mount | 25 | The device installed/attached to a parental device. The Event Type Mount mostly applies to ship- and airborne sensors. |
Partial Failure | 200 | The Event Type Partial Failure should be set if the device's functionality somehow is restricted or limited. |
Recovery | 188 | When a device is retrieved from water or ice the Event Type Recovery should be set. Then it is no longer operational. This usually applies to buoys or moorings. |
Total Failure | 201 | The Event Type Total Failure denominates the total loss of functionality of the respective device. Any re-use is foreclosed. |
Unmount | 26 | The device is extracted from a parental device. The Event Type Unmount mostly applies to ship- and airborne sensors. |
Information | 50 | The description has a bunch of redundancy: Describes issues associated with this item relevant for its operation. Includes failure and maintenance information. |
Processing | 470 | tbc |
Configuration | 317 | The Event Type Configuration depicts a change in the device's setup, e.g. something new has been mounted, a software update was conducted, etc.. |