AmosConnect 7.4.
26 API
Vessel API usage Configuration instructions for use with
AMOSConnect
Instruction summary:
Instruction document on the configuration of export API’s in AMOSMail related to Inmarsat
AMOSConnect service. The configuration uses a mailbox onboard as intermediate between
the Hub on shore and the API onboard.
Process:
Steps:
1) Mail is send from the world to AMOSConnect to mail address
[email protected]
2) The Mail with attachments is transported via mail networks to AMOSConnect.
3) At AMOSConnect the mail is received and the addressee translated to MB-A@PO-
Addree
API represented in
Forward/Copy
s book address book
setting
entry
MS G
MSG
MS G
E-mail server SM
TP AMSOConne Co inte Save to Disk
sending Msg MailBox 7
mai ct Hub mm rnal API
l
1 2 3 4 6
5 Attachme
nt
Hard Disk
Vessel, and put in the queue for the vessel.
4) During regular communication the messages including this one is transferred to the
vessels AMOSMail system.
5) At the vessels AMOSMail system the message for
[email protected] is
now received in mailbox-A.The Mailbox is configured to Copy all incoming mail to the
API ‘Save to disk’. Making an address book entry where the internal address of the
API is linked to an address ALIAS does the internal lookup.
6) At arrival of the new message in the mailbox the system directly copies the mail to
the API as well, which is then triggered.
7) The API is configured to unzip and export all the attachments in the message to
the directory specified, and thus to hard disk of the computer.
Construction instructions Vessel side:
Pre-requisites:
1) The AMOSMail system is fully operational for standard use with AMOSConnect.
2) The AMOSConnect hub has a special mail address configured for this goal
AmosConnect 7.4.26 API
3) The mail address on AMOSConnect forwards the mail to a mailbox on board of the
vessel.
4) The vessel AMOSMail is logged on with Admin rights to configure these settings.
1) Create Vessel mailbox with the same Mailbox ID as requested to
the AMOSConnect registration.
MAILBOX-A would be the mailbox ID in this case.
The Mailbox management can be found in the top menu bar under
{SETUP}>{Mailbox Management}
2) Create the API.
In the top menu go to {Setup}>{Application Definition} and press the [ADD] button.
Set the:
· API–ID (6 characters like SAVAPI)
· Specify the pc to run the API on
· Describe the API
· Set the directory to export the files to
· Check the settings ‘Export Attachments’, ‘Unzip Zipped files’
AmosConnect 7.4.26 API
3) Create an address book entry
Use the menu option {Tools}>{Address Book} to access the address book.
Press [NEW] to create a new entry.
Select Everyone to create the entry in.
Fill in:
Template: API
Name: Export API
Address in full : SAVAPI@API
Alias : EXPAPI
AmosConnect 7.4.26 API
The Alias is needed to be able to link the copy/forward feature of the mailbox
to the API.
4) Set the Mail forwarding of the MailBox to the API
The Mailbox management can be found in the top menu bar under
{SETUP}>{Mailbox Management}. Navigate to the /Forward/ tab.
Select the setting ‘COPY TO’ and press the [Address] button. Select from the list the entry
with the name ‘Export API’ and Alias ‘EXPAPI’
5) Be sure that API processing is activated on the machine in AMOSMail
Go to the menu on the top and navigate to {Remote}>{Other Services} access the
/System/ tab.
Check the ‘Process API’s on this computer’ checkmark.
AmosConnect 7.4.26 API
6) Done
Now every message to the mailbox will be forwarded to the API, which will export
any attachments to the directory specified.
The advantage of the mailbox in the middle is that exports to the api can easily
be repeated if required, and traced onboard.
This automatically creates an archive of these incoming export files, and eliminated the
need to resend the files via shore-ship communications if an export file gets lost because
the application using the exported files gets damaged.
