TABLE OF CONTENTS
- 1. Uploading an SOF document to the voyage
- 2. Validating the SOF
- 2.1 Starting to validate
- 2.2 Selecting relevant pages, lines and line thickness
- 2.3 Changing events, adding timestamps / durations
- 2.4 Cascading same settings to other lines
- 2.5 Validation warnings & how to navigate them
- 2.6 Copy reference to page / line URL
- 2.7 Marking the file as "Done"
- 2.8 Exporting the output to CSV
1. Uploading an SOF document to the voyage
- Login to Voyager Portal.
- Use your email & password to log in.
- Go to the Voyages.
- Open the voyage you need to process the SOF for.
- Navigate to the 'Documents' tab.
- Upload a file and classify it as type SOF (statement of facts).
- Click on Add Document > Upload.
- Browse or drag-drop the file.
- Select the category: SOF
- Save.
- Once you have selected the relevant document, it will start parsing the file automatically.
- You can upload multiple files at once (these load in parallel) and/or continue with other actions.
- You can safely close the window while the 'pending' icon is circling, this will not affect the process.
- After the file has completed loading (average 40 seconds, depending on the size of the PDF) you can proceed with the human validation step.
- It is encouraged (but not required) to upload PDFs that contain only the SOF.
2. Validating the SOF
2.1 Starting to validate
- In the Voyage > Documents tab, identify the SOF to validate and click on the magnifier icon, Validate SOF, to open the SOF parser.
- Select the portcall.
- Review the Vessel and Cargo details.
- Validate the Events listed in the SOF.
2.1.1 Types of events (Timestamp and durations)
- Timestamp event - An event that occurred with a single time allocated to it.
- Duration event - Where in the SOF an activity was described with a start and end time.
2.2 Selecting relevant pages, lines and line thickness
In the SOF file, not all the pages may contain events' information. If that is the case, you can select the relevant pages to work with.
- From the SOF file, note the page number on which the data can be found.
- Go to the Relevant Events Filter.
- Select the page number (next to the Show Errors toggle).
- The pages not selected will be hidden from the view.
- Relevant events can be selected or deselected by clicking on them. This will highlight the row on the PDF, and allow the user to allocate a timestamp/duration stamp to it.
- Multiple entries can be made to each line, depending on what information is given on the highlighted line on the PDF.
- To add multiple events to a line or card, simply click on the icons Add timestamp event / Add duration event within the card.
- Line thickness can be adjusted to accommodate the size of letter used on the PDF. This will reduce clutter, and prevent the green lines from overlapping each other.
- You are able to zoom in and out on the PDF page by accessing the same control panel as used for adjusting the highlight thickness.
2.3 Changing events, adding timestamps / durations
- To change an event, simply select the relevant entry you want to change, and scroll through the drop-down list to the desired item.
- The right side panel automatically scrolls up/down as you move your cursor over the lines on the PDF document.
- To reposition the PDF to align with the card on the right side, click the magnifying-glass icon on the card and the PDF will scroll to align with the selected card.
- To add a timestamp or duration stamp:
- Click on the line you wish to add (if not already recognized by the parser)
- Select either timestamp or duration stamp on the right side panel.
- Select the relevant category from the drop-down list, or start typing to filter the list of select options.
- Select the relevant subcategory from the second drop down list.
- Note: There can be more than one entry made for each selected line on the PDF. Example: EOSP/Vessel arrived requires 2 entries to be made on the right side panel.
- Please find a dictionary cheat-sheet attached at the bottom of this guide.
2.4 Cascading same settings to other lines
If similar strings exist in the SOF, you can cascade the same settings to other lines with the same or similar strings:
- Select the line.
- Go to the card and type the event to add.
- If similar strings exist, a pop-up window will display them: Apply changes to similar events?
- Select the event you would like to apply the same changes to.
- Click on Apply.
2.5 Validation warnings & how to navigate them
There are 2 levels at which the tool checks for errors on events:
- Warning (marked as orange): indicates an atypical entry, but allows the user to save. E.g. when the events are not chronological.
- Error (marked as red): indicates an impossible entry (such as a date in the future) and will block the user from saving.
- There are also checks to ensure that certain key events exist. For example, the presence of nor_tendered and operations (load or discharge) events are checked. These warnings appear at the top.
For quick reference to all the errors in your document, you can activate "Show errors" in the top right corner of the screen.
- Note, you will not be able to mark your file as ‘DONE’ until all errors have been corrected.
2.6 Copy reference to page / line URL
Should you wish to discuss a line in the document with others, relating to a particular string in the document that you are working on, an option is available to copy a link that will direct your service provider directly to the page & line you are referring to.
- Simply move your cursor to the page & line you would like to copy over the written "Page:(x), Line:(x)".
- Once your cursor is over the desired line, you will have the option to ‘copy link’.
- To copy the link, simply click on the "Page:(x), Line:(x)"
- The link will now be copied to your clipboard, allowing you to simply use the ‘paste’ function on an email, etc.
2.7 Marking the file as "Done"
Once the validation has been completed, mark the file as done.
By doing this, the file becomes available at other parts of the platform, such as for laytime calculations or insight reports.
2.8 Exporting the output to CSV
After the validation is complete, you can also export the outcome in CSV format:
- Go to the Export button, in the top left of the screen, next to Save.
- Select the format in which you want to download the file.
- Export .CSV
- Export .JSON
- The file will be saved into your local folder in the selected format.