Ship profiles (edit/add/delete)

Users with administrative rights can add new fields to ship profiles. Under Settings there is a section giving administrator the option to:

• Edit existing field
• Add new field
• Delete existing field

Other ship profile settings:

• Display settings
• Change order of fields
• Map fields to data sources
• Map fields to master fields 
• Categories
• Consumption tables
• Auxiliary engines tables
• File tags
• Charterer questionnaires (for ship owner only)
• Event types

Add field

The following screenshot shows the interface for adding a new field.

Basic settings

When adding a new field, there is some basic information that must be given

• Connect this field to the following master field - when creating new fields, administrators are encouraged to check if a similar field has already been defined as master field in Ankeri and use that as a template for the new field. Using an existing master field simplifies mapping. If no master field is selected, a new one is created. Optional field.
• Field title / display name - description of the field as displayed to users working with the ship profile where the field is visible. Required field.
• Unit - select the appropriate unit based on the field type. The Unit dropdown is searchable among available units while new/custom units can also be added. Optional field.
• Description (short/long) - Short and long descriptions of each field are used on various locations on Ankeri to provide better information to the user about the content of each field. Both short and long descriptions are required fields.
• Category - each field must be added to one of the 15 available categories. Custom entries are not yet allowed so please contact Ankeri if new categories are needed. Required field.
• Value type - the field can be set up to accept one of the following value types. Required field.
  • Numeric: Numbers can either be of type integer (number without a fractional component, decimals) or float (number with a fractional component). Numeric fields can, but do not have to, be limited to certain range. Numeric values can not be negative and are marked invalid if they include a thousand separator.
  • Text: Normal text based values with a limit of 200 characters.
  • Yes/No: Yes/No values are represented with buttons, giving the user option to select Yes or No answers. Display of other fields can be limited/conditioned by the answers of this type of field (see advanced settings).
  • Dropdown: Dropdown with options provided, where the options are ordered in alphabetical order. Dropdown also provides two mutually exclusive options:
    1. Allow custom entries: allows the user to insert custom value in addition to the options provided
    2. Allow multiple enties: allows the user to select one or more options from the options provided
  • Alphanumeric: Only letters a-z and/or numbers without all other characters or spaces.
  • Country: Automatic completion and validation of the countries in the world.
  • Email: Valid Email address structure.
  • Date (datepicker): Datepicker provided to select a correct format of specific date.
  • Document: Dropdown showing all files that have been uploaded for the given ship profile. Only one file can be selected.

While the value types shown above are used to validate manual inputs for ship profiles, all data types are accepted during update from automatic data sources.

New fields are always ordered at the end of existing list and hence at the end of the category they are put in. Custom order will be allowed in future versions.

Advanced settings

To get access to advanced settings, the user must press the Show/hide advanced settings link.

• Add this field to all existing ship profiles? - If yes, the field will be automatically added to all your vessels. Otherwise is has to be manually added to each vessel. Note that new fields are only added to ship profiles that you control - it will not be added to ship profiles that are being shared with you.
• Add this field to future ship profiles? - If yes, the field will be added to all ship profiles created from now on.
• Hide this field from shared ship profiles - all fields are by default shared when ship profiles are shared. Set this to No if the field should not be shared. Hidden field name is shown italic on Specification with a tooltip showing 'Private field'.
• Make this a required field? - If yes, the field will be required before confirming values in a review process. This setting can be changed per field per existing ship (on a ship by ship basis) in tabular view of each ship profile.
• Limit who can print and export this field? - If yes, only users with Full export rights will be allowed to export and print this field
• Limit display of this field and only show if - Field display will be limited to yes or no conditions of the field selected in the dropdown, i.e. the field will only be shown if the dropdown field is either yes or no.

Mapping to available data sources

Fields can be automatically mapped to existing data sources. Note that this is only possible to do in the Edit field view as described below.

More information on how to configure mapping of a field to data source can be found at Mapping configuration.

Edit field

Editing a field follows the same procedure as given above for the addition of a new field.

Exceptions:

• Make this a required filed - does only apply to future ship profiles, i.e. this field will not affect existing ship profiles but will on the other hand affect all ship profiles created from the date of edit.
• Add this field to all ship profiles? - all edits made to a field (except Make this a required field) affect all existing profiles. This control is therefore not needed when editing a field.
• Value type? - value types for fields that are connected to Events must have type date and are therefore disabled for fields that are connected to Event types. This does not apply to event attributes.

Fields can be automatically mapped to existing data sources. Note that if a given mapping is not found or returns an error, it will be ignored and no error will be raised.

• ShipDB field name - Field will be mapped to the ShipDB data source matching the given node name. This only applies to first level results from master_data_with_ids.json.
• Navigator Insight BI/XML XPath - Field will be mapped to XML file export from Navigator Insight according to the given XPath. For information about XPath refer to XPath with lxml (external link).
• IHS Fairplay XLSX column name - Field will be mapped to column name from IHS Fairplay XLSX file as uploaded under Settings.
• Equasis CSV - Field mapped by Ankeri only. Used for information about last and next dry docking information.

More information on how to configure mapping of a field to data source can be found at Mapping configuration.

When fields are moved between categories, they will keep their order location based on their original addition. Custom order will be allowed in future versions.

Although administrators can edit value type of a field it may not always lead to desired results. Converting a filed of type 'Document' to 'Text' is one of those cases.

Delete field

Note that this action is permanent and cannot be reversed.

Fields can be deleted from Ankeri in a similar way as they can be edited. To delete a field, browse to Delete field and select the field to be deleted from the field dropdown.

Once the correct field has been selected from the dropdown - all its properties are displayed. If the field is being used for a ship and has been filled out, the number of ships affected will be displayed as shown below.

A warning is also given for fields that are connected to Events in Event types . Those connections between Specification and Events are removed if a connected field is deleted.

To permanently delete the filed, the user must press the Delete field button.

Other settings

Change order of fields

Refer to Change order of fields.

Fields mapping

Overview showing which fields are connected to which data sources. Refer to Mapping of fields to data sources for more information.

Categories

Refer to Categories 

Consumption tables

Refer to Consumption tables.

File tags

Refer to Create and edit file tags.