Only authenticated users will be allowed to edit data. When a user has been authenticated, additional features for editing and publishing resources are enabled in the application.
Watercraft Manager is the starting point for all editing. The top menu (Watercraft Manager) offers creation of all types of resources to which the individual user has been assigned permissions. Each type of the resource has its own data groups; the following options are common for all resource types:
Basic editing rules¶
All resources are edited within Watercraft manager the same way. Data are divided in content groups and each group has one or more data fields for editing. When more than one record of some data (multi-line edit) is possible, the data must be added to the list below the selected data group using the ‘Add’ button.
When there is only one possible entry for the given data (single-line edit), data entry is accepted automatically.
Either way, to save data to the database, the entered data must be confirmed using the ‘Save edits’ button in the upper right corner. To discard changes, use ‘Discard edits’ button.
Basic validation rules for current data group are applied before saving data. Resource-level data validation is applied through Data validation before proceeding to the next status.
There are six types of resources:
|Early Watercraft||The main type, comprising all detailed data for Early Watercraft.|
|Early Watercraft Group||A resource for grouping similar items of Early Watercraft.|
|Activity||Activities recorded in relation to Early Watercraft.|
|Early Watercraft Event||Events recorded in relation to Early Watercraft.|
|Person/Organization||Persons and/or organizations, related to Early Watercraft.|
|Information Resource||Documents, images, 3D models, files, etc. related to Early Watercraft.|
Currently, only PLY, STL and OBJ file formats are supported in Online view of 3D models. The PLY format must first be converted to a multi-resolution format (NXS), meaning that it can take from a few seconds to a few minutes (depending on its size) before a model can be shown in the report.
To create a new resource, the top menu (Watercraft Manager) offers only resources to which user has editing permissions. For the existing resources, the ‘Edit’ button is shown only if the user has appropriate permissions.
Every authenticated user, which edits resources, must be member of one (and only one) ownership group. The user is only allowed to edit and process data from the ownership group to which the user is allocated (all other resources are locked for editing).
Any name with ‘OWNERSHIP’ prefix can serve as the name of the ownership group. Every newly created resource gets the name of the ownership group of the author (i.e. of the user who created it). From this moment on, only members of this group are authorized to edit this resource.
Current ownership groups¶
Institute for the Protection of Cultural Heritage of
Currently, Early Watercraft has only one ownership group (for this project) since there is no need for more. However, the application can support any number of ownership groups.
Early Watercraft resources are visible to public (unauthenticated) users only after they have been published. To publish a resource, a user has to fill in all required data and send the resource to the user with publishing permissions, who in turn approves the resource to be published. The publisher (i.e. the user with publishing permissions) can then either approve (publish) the resource or reject the approval. All possible process options are shown in a workflow diagram below.
Mails are only sent to others (no mail is sent if the current user is the intended recipient).
Resource status is shown only to authenticated users (all other users see only the published resources). The status is shown in parenthesis after the resource type (in resource header, resource list, report, etc).
- only status where ‘Editor’ can modify data
- only status where resource can be deleted
When ‘Editor’ (the user who created the resource) fills in all
required data, a ‘Publisher’ (i.e. the user with publisher
- modify existing data
- publish a resource
- reject approval (explanation required)
The resource is visible to public (unauthenticated) users.
An ‘Editor’ can return resource to a ‘Draft’ status and repeat the
Resource can be processed to the next status only when all conditions are met. Each resource has its own validation rules for each status. To check if all condition are met, the user needs to select ‘Validate resource’ in the sidebar menu.
When the application finds missing data, unique records, etc. the user has to amend all errors to continue processing the resource to the next status.
There are two types of data validation errors:
|Error||The user has to correct an error to continue to the next status.|
|Warning||The user can continue to the next status.|
For each validation error there is a link to the data group where the user is able to correct an error. Each data group with errors is also marked using an exclamation mark in sidebar menu.
When all conditions are met, a button for the next status is enabled.
While a document is in processing (not published yet), its icon has an additional marker in upper left corner, indicating its current status.