Welcome to Union VMS!

What is Union VMS? 

Union VMS provides you with real-time information on ship movements and ports. It allows you to track active assets through live position reporting.
Union VMS also allows you to view, export and print reports to secure that responsible and legitimate fishing is performed.

Who should use Union VMS?
It is intended that the on-site team who is responsible for the asset tracking and reporting system, is to be responsible for maintaining the Union VMS. It can be used by several users with different accounts.

Using the Union VMS manual
This guide will help you learn how to use the Union VMS software and navigate through the system. For information on specific Union VMS features, refer to one or more of the following sections or appendices.

Section 1: Login Instructions on how to login to Union VMS.
Section 2: Main navigation & Settings A brief overview of the system, understanding the navigation and how to configure the basic settings.
Section 3: Assets Step-by-step guide on how to search for assets and how to add new ones into the system.
Section 4: Mobile terminals Step-by-step guide on how to search for terminals, how to add new terminals to the system and how to link assets to terminals.
Section 5: Reports Shows a live view over the geographical position of the sending assets. This page displays all the accessible reports for the user in a manner similar to other GIS (Geographic Information System) applications.
Section 6: Positions Step-by-step guide how to search for position reports and how to send out manual reports.
Section 7: Polling Step-by-step guide how to send out poll requests to active mobile terminals.
Section 8: Alarms How to set what rules the system should check to be followed. Any infraction results in an alarm notification.
Section 9: Exchange Overview of all incoming and outgoing messages in the system. Exchange is working as the systems communication hub.
Section 10: Area management How to create, save and manage user and system defined zones.
Section 11: User management Step-by-step guide of the user authentication, user authorisation and the management of user data and related data.
Section 12: Glossary A glossary list of all technical terms and shortenings used in the system.

Section 1 Login

Login

• From your computer's browser, access the link location of the UVMS installation.
• Fill in your username and password in the text fields.
• Click on the "Login" button.

Incorrect credentials

• A notification text shows, saying that the credentials are invalid.
• Please try to fill in your username and password again.

Forgot your password?

• Click on the "Forgot your password" link.
• Fill in your username in the pop-up window and click on the "Reset password" button.
• A new prompt will appear asking you to answer your security questions. Here can you set a new password.

Section 2 Layout description & Settings

The picture below provides a brief overview of Union VMS. It also provides instructions for basic language and user account settings.

Main navigation bar

• Once logged in, the main navigation bar becomes visible. This navigation bar is consistent throughout the system and will be shown at all times.
• You navigate through the system by clicking on the links in the navigation bar to reach desired page.

Date and time

• Date and time is shown on top of the page.

Active Alarms Icon

• An Icon showing how many alarms are currently active.
• By clicking on the icon, you automatically link to the alarm page where you find extended information regarding the alarms.
• More information about the Alarms, see Section 8: Alarms.

Language Setting

• A flag icon is illustrating the language of your choice.
• To change language settings, click on the flag icon and choose preferred language in the dropdown list by clicking at it.

User Settings

All personal user settings are listed in a dropdown list under the username found up in the right corner of the page. For more information, see Section 10: User management.

• Click on the arrow next to the user name to reach a dropdown list with different choices.

Update contact details

• Select the option "Update contact details" in the dropdown list.
• Fill in your new contact details in the pop-up window and the click on the "Save" button.

Change password

• Select the option "Change password" in the dropdown list.
• Fill in the mandatory information in the pop-up window and then click on the "Save" button.
• The new password will now be saved.

Change security answer

• Select the option "Security answer" in the dropdown list.
• Fill in all mandatory information in the pop-up window and then click on the "Save" button.

Sign out

• Click on the "Sign out" button in the dropdown list.
• Sign out from the system and end up on the start page again.

Symbols

There are recurrent symbols throughout the system. They are illustrated with each function description in the Table 1 below.

Table 1: Symbols

Section 3 Assets

The Assets view provides a list of all existing assets. This is where to add new assets to the system.

Search for assets

• Search by using the simple search or the advanced options.
• It is also possible to perform wildcard searches. Type in the letter followed by a star * in order to search for all matches.

Advanced Search

Expanded search area to reveal advanced search options.

• For more search options, click on the link "Advanced search". See pictures below.
• To speed up the search functionality, perform search through specific fields only.

Save assets in a dynamic group

When performing an advanced search, it is possible to save that search as a dynamic asset group. What this means is that the assets in this Dynamic Asset Group will update based on whether they fulfill the search criteria or not.
For example, saving a search for Flag state = "SWE" & Gear type = "Demersal" & Length = "12 – 14,99m" as a dynamic group, would mean the group always updates when new assets are added/removed in the system that match that criteria.

• Click on the "save group" link.
• Type in a title for the dynamic group and click on the "Save" button.

Save assets in a static group

Selecting out specific assets in the results list and saving them as a group will result in a "static" group. As opposed to the dynamic one, the assets included in this will always be the ones you selected.

• Select which results should be saved by clicking in the box left to it. See picture below.

• Once the selection has been made, choose the alternative "Save as a group" in the dropdown list under "Actions". See picture below.

• Add a title to name the group or choose to save as an already existing group by select an alternative in the dropdown list. See picture below.

Adding assets to a group

• Select which assets should be added by clicking in the box left to it. A modal will come up asking which group would you like to add to. See picture below.

Removing assets from a group

• Select the group you would like to edit from the dropdown on the right.
• Select which assets should be removed by clicking in the checkboxes next to them.
• Under the Actions dropdown, select Remove assets.

Sort assets

• The result can be sorted in descending order, click on the arrow in preferred column of the result list to change the order of the presented result. See picture below.
• Click again on the arrow and it sorts the list in an ascending order.

Export asset selection

It is possible to export one or multiple mobile terminals from the list to a CSV file.

• Select required assets by clicking in the box left of them. See picture below.
• Once the selections have been made, choose the alternative "Export selection" in the dropdown list under "Actions". See picture below.
• The file will be downloaded to the computer and stored in "Downloaded files".

View details

• To view extensive details about the asset, click on the "Edit" button under the column "Details" in the result list, See picture below.

  Note: The icon next to an asset shows Edit (pen-icon) if the asset is editable and View (eye-icon) if the item is not. In this case, the item is read from the national assets database (alternatively from the EU register) each time a new position comes in. Therefore you cannot edit this asset locally.

  
  

• The upper half of the screen shows the asset details, followed by the connected mobile terminals on the lower part.
• Details can be exported by clicking the "Export CSV" button.
• To go back to the previous page, click on the "Close" button.

Update details

• Once you have opened the asset details, you can start making changes to the information.
• The source must be "INTERNAL" in order to have the rights to update details. See marking in the picture below. If your system installation is coupled to a national asset registry/database, then changes in the information need to be made there.
• Fill in changes in the text fields and click on the "Save/Update" button to save changes. Once the new changes have been saved they will show up in the "Asset History" column down in the left corner. See marking in the picture below.

Add new asset

• Click in the "New Asset" button.

• Fill in all needed details in the form and click on the "Save asset" button.

  Note: that at the moment License types are not fully supported.

  
  
  

  Note: that all required fields must be correct filled in. Otherwise a feedback message will appear saying that the asset cannot be created. See picture below.

  

• Once the asset is added, a feedback message will confirm that.

Assign mobile terminal to asset

• See more in Section 4: Mobile Terminal: Assign to asset.

Archive asset

• To archive an asset, click on the "Details" button to open up the asset settings.
• Click on the "Archive" button up to the right, see picture below.

• Then add a comment to why the asset is archived and click "Yes" in the pop-up window.

• A feedback message will show for a few seconds, confirming that the asset has been archived.

Section 4 Mobile terminals

In order to access the mobile terminals page, click on "Mobile terminals" in the main menu bar. The default view of this page shows an overview of registered mobile terminals and their current status.

Detailed information

• To reach more detailed information about a terminal, click on the "Details" button to the right in the list. See illustration above.

Status

The status of a mobile terminal can be Active or Inactive. When a mobile terminal has been made inactive, it will be greyed out in the list.

View terminals by asset group

By selecting a group, all terminals assigned to the assets in that group get listed.

Search for mobile terminals

Use the search fields to find mobile terminals.

• Fill in the different fields with information of choice.
• Click on the "Search" button to find matching mobile terminals.
• The search result will be listed below with all relevant information.

Add new mobile terminal

When adding a new terminal, click on the "Add new" button to reach the "New mobile terminal" page.
Please follow the following instruction steps in order to add a new mobile terminal to the system.

Note: It is always possible to cancel and go back to the previous screen. Click on the close icon .

1. Select transponder system Select which transponder system to be used. The list of available systems will be shown as a dropdown menu when clicking on the icon. This list is dynamic and is based on whether your system has a plugin installed for a certain transponder system. See picture below.

2. Insert relevant information.
Select ocean region from the four available options in the dropdown list. It is possible to select multiple alternatives. Continue by adding mobile terminal information in their respective fields.

3. Add communication channels At least one communication channel must be added in order to complete the form. It is possible to add several channels.

Assign mobile terminal to asset

The first communication channel in the list should be the main one used by the terminal to communicate. This is marked by the Default checkbox. The user can select which channel to use for manually Polling the asset and which to use when sending Configuration polls.

4. Save the mobile terminal Save the mobile terminal by clicking the Save button in the upper right corner.

• If you have just saved the terminal, then you should immediately get more options to link it to an asset. These become available on the top of the screen.
• Otherwise, from the main Mobile terminals page, use the search field to find a mobile terminal to link. Click on the "Details" button in the right column in the list.

• Click on "Link asset" to open search field for assets. See pictures below.

• Use the search fields to find asset and then click on the search button. See picture below. If the asset you want to link to does not exist, you first need to create one under Assets.
• Choose asset by clicking on the "Select" button. See picture below.

• Click on the "Link" button to connect the asset to the mobile terminal. If this is not the wanted asset, then you can go back by clicking "Go back to the search result." See picture below.

• Type in reason for linking mobile terminal to asset and click on the "Link" button.

• A feedback message will show for a few seconds confirming the action.

Unlink asset from mobile terminal

• To unlink a mobile terminal from an asset, select the mobile terminal by clicking on the "Details" button in the right column in the list.

• Click on the "Unlink" button.

• Type in reason for unlinking and click on the "Unlinking" button to save changes.

• A feedback message will show for a few seconds, confirming the action.

Access mobile terminal history

• Select mobile terminal through the "Edit" button under the "Details" column.

• The mobile terminal's details will open. In the lower left corner is the "View history" link, click in it to open the history information.

• To close the history window and go back to previous view, click on the "Close" button.

Activate mobile terminal

• Select mobile terminal through the "View Details" button.

• Click on the "Activate" button.

• Type in a reason and click on the "Activate" button.

• A feedback message will show for a few seconds, confirming the action.

Inactivate mobile terminal

• Select mobile terminal through the "View Details" button.

• Click on the "Inactivate" button.

• Type in reason for changes and click on the "Inactivate" button.

• A feedback message will show for a few seconds, confirming the action.

Section 5 Reports

The "Reports" in the main menu shows a live view over were reporting assets are located. This page displays all the accessible reports for the user. The "Reports" page is divided into "Line view" and "Reports"

Live view

Map

Measure distance

Allows calculation of estimated time of arrival based on the criteria selection of measure configuration panel (supported units are meters, nautical miles and miles):

Export Map

Export the current map view to an image format (supported formats are PNG, JPEG and PDF):

Bookmarks

Bookmarks helps the user to save the current state of the map

• User can create the new bookmark, name the bookmark and click on "Add bookmark" to save the bookmark.
• All the bookmarks are displayed as a list.
• Click on the "globe" button to view the selected bookmark and on "remove" to remove the bookmark from the list.

Zoom in/out

Zoom in/out the map (also works with "+"and "-" keys and mouse wheel)

History

Go back/forward between map navigations (keeps track of the latest 50 steps)

Eraser

Clear map highlights (related to the zoomTo and panTo functionality)

Full-screen

Activates full-screen mode

Layer tree handle

Opens the layers tree and legend panels:

On the layers panel you can specify which layers are visible. Here you can also order the layers (drag and drop) to control the order of the layers over the map.

select the position node to view all the positions and click on any position to see the position details.

For the segments, you can do the same but instead you have to select it on the segments node:

click on the  icon to watch the same information in the table .

There are 4 types of tables

• Positions
• Segments 
• Tracks  
• Trips

• It's also possible to export this data if you click on the export button on the right side of table toolbar in csv format with wkt.
• On this specific table there's a filter panel where you can define a parameter for each column. The filtered result will consider all the filters applied.
• - Option for every row, to Zoom to the position or segment or track or trip in the map.
•  - Option for every row, to pan to the position or segment or track on the map.

Now, we will briefly look into the trips tab.

Trips 

•  - click on the details button to open the summary view of the trip as shown below:

Catch Details

catch details page display the details of the cathes in the tabular format.

• click on the "eye" icon of Reports panel to view the selected fishing activity details.
• user can click on the navigator to navigate across the all the fishing activities in the current trip as shown below

Report List

This page displays all the accessible reports of the current user to search, update, run and delete existing reports and create new ones.

• Refresh – refreshes the report list
• Edit report – edits settings on report
• Delete report – removes the report
• New report – allow to create a new report
• Run report – runs the selected report and open it on live view like in the following picture:

Creating a New Report

There are two types of reports:

• Standard Reports
• Summary Reports

Standard Reports:

On this page the user can create a report and configure different filters. These filters will be applied to the result when the user runs the report.

• click "save" button to create the new report
• click "clear" button to clear the all the fileds and the selected filters.
• click "cancel" button to cancel the report creation.  

Areas Filters

Area There are two types of area filter. They are System areas and user areas.

• The area can be selected by "select area on map" or by "search by area properties".
• click on "tick" icon to add the area into area selection and also "Add all" is available to add all at once. 
• "search" and "reset" options are available to search the areas and clear the selected search respectively.

An example of the areas filter is shown below:

Assets Filter

Assets are selected either by selecting assets or asset group from the dropdown.

• click on "tick" icon to add the asset or assets group into assets selection and also "Add all" is available to add all at once. 
• "clear all" button helps to clear all the selected assets from "assets selection".

• For assets "search" option is available to search the assets and "reset" to clear the search .

Positional Data Filter

Fill all the required fields as per the requirement. see the below example of positional data filter

Fishing Activity Data Filter

select all the required filters as per the requirement, see the below example of fishing activity data filter:

Map configurations

The following are the different map configurations available. See the picture below. click on the ">" icon to add different configuration settings.

Summary Reports:

On this page the user can create a report and configure different filters. These configurations will be applied to the result when the user runs the report.

• click "save" button to create the new report
• click "clear" button to clear the all the fileds and the selected filters.
• click "cancel" button to cancel the report creation.  

Note: "select area", "select assets" and "select fishing activity data" are same as the filters of standard report. please refer the standard report for the detailed description. 

Output Criteria Filter

Filters can be added from the right side dropdown and then all the selected options are displayed in a tree structure.See illustration in picture below

Section 6 Positions

In order to find all incoming position reports, click on "Positions" in the main menu bar. The page will automatically update every minute. The Position reports are divided into "Positions Reports" and "Manual Reports".

Position reports

Position reports show all incoming position reports listed in a table. It is possible to search through different search variables and sort functions.

Search

• Searching through position reports can be done based on assert's external marking or name. Type in this in the text field "Name".
• Select what timeline the search should include from the alternatives in the drop down list.
• Select what flag stat the search should include from the alternatives in the drop down list.

• It is possible to sort the search result in descending order by clicking on the arrows in the result table. Se illustration in picture below.

Search result

• Once the search has been performed, only incoming position reports that are relevant to that search will be displayed. The rest of the position reports will be gathered under an automatically updated ticker.
• Click on the ticker to reset to the latest list. See picture below.

Advanced search

• Advanced search presents a more range of flexible search criteria that can be used to sort through incoming position reports. Click on the link "Advanced search" to see the expanded search criteria.

Save search

• It is possible to save searches. These are user specific and will appear under the dropdown list in "Saved Searches". See picture below.

• To save a search, fill in all desired search fields and then click on the link "Save search". A pop-up window will appear.

• Choose a title for your search or replace it with an already existing saved search. Then click on the "Save" button.

• Saved searches can also be removed by the cross icon to the right of the saved search name in the dropdown list.

Export position reports

The Export Selection creates a CSV file with the selected position reports' information.

• Click on "Export selection" in the "Actions" dropdown list. The CSV file will be downloaded to the computers "Downloaded files".

Manual position report

Click on "Manual Position Reports" under "Positions" in the main menu. Manual position reports show all the sent position reports as well as the drafts that have been saved locally. A manual position report can be created when an asset cannot report automatically.

Search for locally stored manual position reports

• To search through the manual position reports, fill in the available search fields and the results will be listed automatically. 

Create new manual position report

It is possible to create a new manual position report under the Manual Position Reports page.

• Click on the "New manual report" button under Manual positions reports, a pop-up window will appear.

• Fill in all information fields.
• Once the asset name is filled in, its last position will be displayed on the map.
• Fill in date and time, please note that it need to be set previous to the current time.
• Fill in coordinates. The indicator will show on the map where those coordinates point to.
• Fill in measurement speed. Note that it cannot be set higher than 15knts.
• To add another new manual position report, click in the box "Add another" before click on the "Save" and "Send" button.
• To clear all content, click on the "Clear" link.
• To cancel and go back, click on the "Cancel" link.
• Click on the "Send" button to send the report. Note that all fields are mandatory and needs to be filled in for the report to be send. Before sending, a confirmation window will show. Review the report and click "Send" if approving it.
• There is also an option of saving without sending the report. Instead the report is saved locally under the workspace. To do that, click on the "Save" link.

• When a report is send, it disappears from the workspace and can only be found under incoming position reports.

Edit manual position reports

A saved report can be reopened and edit until it is send. It can also be deleted. However, as soon as the report is send it cannot be edited anymore.

• To edit a report, click on the edit symbol.
• To delete a report, click on the delete symbol.

Export manual position reports

The Export Selection creates a CSV file with the selected position reports' information.

• Click on "Export selection" in the "Actions" dropdown list. The CSV file will be downloaded to the computers "Downloaded files".

Section 7 Polling

In order to ask a mobile terminal located on an asset for information, click on "Polling" in the main menu bar. The page will show currently running program polls. The Polling tab is divided into "Polling logs" and "New poll".

Polling logs

New poll

Create a new poll in order to ask a mobile terminal for current updated information. Go to "New Poll" under "Polling" in the main menu.

Choose assets to poll

• Fill in all relevant fields to search for the asset to contact, then click on the "Search" button to continue.
• Choose among the search results, which asset to send a new poll to. Then click on the "Add" button, it will then turn green. Note that it is possible to send a new poll to all listed asset through the "Add all" button. See picture below.

• When asset or assets is selected, click on the "Next" button to continue. See picture below.

Select Polling options

• Choose between the following types of polling:
• Manual poll; Request position from asset once.
• Programmed poll; Enables to schedule for several manual polls.
• Configuration poll; Set new configuration settings to the mobile terminal.
• Samplings poll; Collect samples of assets internal reporting. Many reports are sent together at once, instead of distributed over several polls.

• When finished with the poll settings, click on the "Run poll" button or click on the "Cancel" button to cancel the new poll.

Polling results

• Once the poll is send, a feedback message shows for a few seconds confirming that. The poll result will be shown in in the Polling Logs.

Section 8 Alarms

Click on "Alarms" in the main menu bar to see all active alarms or to set a new rule with demands for the system to track. The Alarms tab is divided into "Holding table", "Notifications" and "Rules".

The alarm system works as follow;
The "Rules" tab shows activated rules that the system is supposed to check that they are being correctly followed. It is also where settings for new rules are found. For more information, see "Rules" in this chapter.
"Holding table" lists registered rules that are put in quarantine since they are for some reason incomplete. For more information, see "Holding table" in this chapter.
"Notifications" shows the alarm reports from discrepancies from the active rules. For more information, see "Notifications" in this chapter.
For more specific information about each of these functions, see the following pages.

Holding Table

Holding table shows set rules that are automatically put in quarantine by the system since they in some way are incomplete.

There is mainly one of three things making a rule incomplete and appearing in the Holding table;

• Incomplete data
• Asset not found
• Mobile terminals not found

Incomplete data

The position report misses information.
Action:

• Reprocess the rule by selecting it in the Holding list and select the alternative "Reprocess reports" in the "Action" dropdown list. See picture below.

Asset not found

The position report cannot be matched against an asset.
Alternative actions;

• Reprocess the rule by selecting it in the Holding list and select the alternative "Reprocess reports" in the "Action" dropdown list. See picture below.
• Add a new assert to either a national database or a local placeholder. For more information of how to add a new assert, See section 3 Assets.

Mobile terminals not found

Alternative actions;

• Add a new mobile transfer in the national or in a local place holder. For more information of how to add a new one, see section 4 Mobile transformers.
• Reprocess the rule by selecting it in the Holding list and select the alternative "Reprocess reports" in the "Action" dropdown list. See picture below.

Searching the holding table

• It is possible to search in the Holding table by choose time period or set specific date and time in the search fields, then click on the "Search" button.
• It is also possible to search by typing name or sender, then click on the "Search" button.

Rules

Rules shows activated rules that the system is supposed to check so they are being correctly followed. It is also where settings for new rules are found.

Create new rule

• Click on the "Create new rule" button to open the settings for creating a new rule.

• Fill in a rule name and a description for what the rule is regarding.
• Fill in rule availability, if it should it be a;
• private rule for only the user to see,
• public rule for other users to be able to subscribe to or,
• global rule that generates notifications to all users in the organization. Note that this global rule alternative is only for Admin users.
• Fill in rule status, if the rule should be active or inactive.
• It is possible to set a time interval for when the rule should be active. Choose date and time by using the calendar. Click on the link "add another interval" for more.
• Fill in the rule definition. It is possible to use several rows in order to set the desirable rule and action. Form the rule definition by using following parameters:
  • Operator; operators should be used only when building sets of conditions which the user would like to result in the same actions taken by the system.
  • Criteria; a set of all available variables that can be used to validate, get notified or forward incoming position reports. E.g. Assets, Asset groups, Mobile terminals, Position reports, etc.
  • Sub criteria; this list changes after chosen criteria to further specify attributes that can be used in building the rule. E.g. Asset CFR, Mobile terminal DNID, Position report time, etc.
  • Condition; decides the check you would like to do. E.g. an Asset CFR is equal to, an position report is in an area, etc.
  • Value; specifies exact value for the rule's condition. E.g. an Asset CFR is "SWE000011111".
  • Composite; this can be used to compose a complex rule between two conditions. E.g. if the user would like to get notified if asset CFR is equal to "SWE00000111" OR if area code is equal to "SWE".

• Fill in what action the system should take if the rule is broken. It is possible to add several different actions, click on the "Add a row" link.
• When finished with the rule, click in the "Create" button to save.

Edit rule

When edit an already existing rule, click on the "View Details" button to open up a new window with the rule information.

• Change settings in the different rule options available, and then click on the "Update" to save the new settings.
• Click on the "Close" button to cancel and go back.

Subscribe on rule

It is possible to subscribe on rules in order to get notification regarding them.

• Select what rule to subscribe to, click on "Notification" in the dropdown list in the column named "Subscription". See picture below.
• There is also an option to be notified by email. Fill in preferred email address in the text field in the column "Notify by email. See picture below.

Export rule

• To export a list of rules, select one or several rules to export by click on the box in the "Rule name" column.
• Select "Export selection" in the "Actions" dropdown list.
• The file will be downloaded to the computers "Downloaded files".

Notifications

In notifications shows the alarm reports from discrepancies in the active rules. There are search fields in order to enable the user to find older notifications as well as new ones.

Search and sort among notifications

• Fill in search field to find the specific notification(s).
• The notifications can also be sorted by "All", "Open" and "Closed" notification.

Close notification

• The user can choose to resolve an open notification by clicking on the "Close" button, see picture below.

Section 9 Exchange

Click on "Exchange" in the main menu bar to get an overview of all incoming and outgoing in the system. Exchange is working as the systems communication channel.

Transmission status

The transmission status list shows all communication plugins.
The user can start and stop transmissions here.
The sender name is shown to the left and the transmission status is shown to the right. See picture below.