Note: Requires a Veslink Voyage Reporting license.
...
- On the Forms tab, do either of the following:
- To create a new form from scratch, click .
- To copy an existing custom or standard form, hold your mouse pointer over its row, click , and then click Copy.
Note: To copy a standard form, make sure it is updated to version 2.21.619 or higher.
- Configure the form:
Anchor requiredfields requiredfields Anchor voyageinstructions voyageinstructions Report Type and Form is applicable: Some Report Types are applicable only in certain places. Fields that are required for the validation of a Report Type are automatically added to forms of that type and cannot be removed.
Report Type Applicable Required Fields ArrivalIn Port Voyage Number
PortDepartureIn Port Voyage Number
PortNoonIn Port
At Sea
In Port or At SeaVoyage Number
PortVoyage Instructions
Note: Voyage Instructions will be fully functional soon.None None Other
Anchor Other Other In Port Voyage Number At Sea Voyage Number In Port or At Sea Voyage Number Other (Non-Voyage) None Fields that are required based on another field that was added are also added automatically, but they can be removed.
- When you add the field Slip %, Observed Distance and Engine Distance fields also appear because Slip % is calculated as 1 − (Observed Distance ÷ Engine Distance). However, if you remove Observed Distance and Engine Distance, Slip % cannot be calculated.
- Layout:
- Maintain Form Field Positions When Hidden: Select to have all fields maintain their position on the form whether or not they are hidden, preventing other fields from shifting.
- Workflow:
- Require Approval
- Allow Submission Prior to Voyage Commencement
- Display Chief Engineer's Name
- For Voyage Instructions only:
- Enable Revision History
- Take P&L Snapshot Upon Submission (with configuration flag CFGEnableVIFormPnlSnapshots enabled)
Click Save. Your form appears in the Form Designer, with Form Elements (sections and elements) in use on the left and a live preview on the right.
- In the Form Designer, do any of the following:
- Edit form configuration: Click .
- Create a header
- Add sections
- Add elements
- Rearrange elements
- Click . When the form is saved, the button changes to to show you that there are no changes left to save.
- To return to the list, click . To open the form from the list, click its name.
...
- Make sure the element is in the Data Dictionary. You can add a custom element there.
- Hold your mouse pointer in line with a section or element name and then click .
- Type a letter into the field. A list appears with all available elements and controls that contain that letter.
- Controls are grids with a number of rows and columns of fields. Each control is followed by this icon in the list: .
- Select the element or control.
- Edit the element:
- Hold your mouse pointer in line with its name and then click . Different options appear, depending on the type of element.
Examples:
- Change any of the following:
- Label
- Display Type (for a custom field only)
- Complex Type (for a Complex Control only)
- Data Source (for String Display Types Autocomplete and Drop Down only): Select a data source, or select Custom to create a comma separated list of allowed values.
Expression (for a Read-Only Field with Type String, Decimal, Integer, or Date only): Enter a custom expression, which can include numbers, Field IDs, addition (+), subtraction (-), multiplication (*), division (/), and parentheses.Anchor Expression Expression
Note: When using dates in an expression, Type must be String.- Text (for a paragraph only): To help you format text, the rich text editor appears.
- External Field (for Voyage Instructions only): To embed other Data Dictionary fields elements in a Boolean field Label or paragraph Text box, do either of the following:
- In External Field, search for a field and then click . The Field ID appears inside curly brackets.
- Type a Field ID inside curly brackets. For example, to embed Aft Draft, type {AFTDraft}.
- Width (Pixels) (for a Field with Type String, Integer, Decimal, or Time Span or a Paragraph only)
- Decimal Places (for a Field with Type Decimal only)
- Read-Only Field
- Required Field
Anchor VisibleWhen VisibleWhen - Visible When: Specify that the field is visible when a condition based on the value of another field is true; for each field, select an operator and enter a value.
- For a field within a Row Details section of a table, other fields in its row are available as operators.
- Valid When: Specify that the field is valid when a condition based on the value of another field is true; for each field, select an operator and enter a value.
The form cannot be submitted with a validation error. A field with an error is marked with a red line, and a message describes the required value. - Tooltip: Enter text to appear when the mouse pointer is held over the field name, overriding any value from the Data Dictionary.
A dotted line under the field name on the form indicates that it has a tooltip. - Use External Data Source (for Voyage Instructions only): To link this element to a Platform field or table, select the check box, search for a field or table name, and then select it.
- Show Distinct Values Only (for fields in one-to-many joins only): Outputs a comma-separated list of distinct values.
Anchor RowDetails RowDetails
- Show Distinct Values Only (for fields in one-to-many joins only): Outputs a comma-separated list of distinct values.
- Enable Row Details (for a table only): Show additional fields that relate to each table row. Under the table in the Form Elements column, drag and drop additional fields under the Row Details heading.
- Static Table (for a table only): When selected, a drop-down menu appears of all fields in the table. To determine the number of rows that automatically appear, click a Field ID.
Example: In the drop-down menu, if you click Engine_Type and there are four possible values for that field, four tables rows automatically appear with the Engine Type column completed. - Display association with another field (for a field in a table only): To highlight the current field and another field in the same table, select the check box and then search for a field name.
Anchor ColumnCalculation ColumnCalculation - Column Calculation (for a field in a table, of Type Integer or Decimal only): Select Total or Average to add or average the values in the column.
- Click Save.
- Hold your mouse pointer in line with its name and then click . Different options appear, depending on the type of element.
...