MTMLLink-FX

An application that is installed on the client's computer (usually on their server) that facilitates the File eXchange of order management and invoice (legacy) documents between the client's system and the ShipServ platform through MTMLLink web service. This is available for clients who do not wish or with systems that is not capable of connecting or consuming web services directly.

References

• Components

• How it works?

• Versions

• Installation & setup

• Using MTMLLink-FX

  • Force Exchange

  • Transaction Log

  • Sending & Receiving Attachments

    • Older versions

    • Version 6.0.0 (latest)

• Uninstallation

• Upgrading to the latest version

Components

Service

A windows service that does the file exchanges between the client's system and the ShipServ platform through MTMLLink web service.

Client

A client application that allows the client to monitor the status of the service, either from the same computer where the MTMLlink service is running, or from another computer on the same LAN.

How it works?

MTMLlink-FX uses a secure HTTPS connection to talk to the ShipServ platform.

Files sent to the ShipServ platform are “pushed” by MTMLlink-FX (HTTPS POST)

• Files received from the ShipServ platform are “pulled” by MTMLlink-FX (HTTPS GET) based on the configured polling frequency.

The ShipServ platform, specifically MTMLLink web service, do not initiate a connection to the client’s computer. As a result, there is no special firewall configuration required at the client side; just allow normal “browser” connections to allow MTMLlink-FX to operate.

Versions

Installation

Pre-requisites

• On the client computer

  • Microsoft Windows 2000, NT or XP/Server 2003

  • Microsoft .NET Framework (v3.5 or later)

• On MTMLLink-FX configuration

  • TradeNet ID

  • TradeNet username and password (not the same as Trade username and password)

1. Download the MTMLlink-FX installer.

2. Log on the client computer as a user with Administrative privileges.

3. Double-click on the downloaded .msi file, which should be named like ShipServ-MTMLlinkFX-xx.yy.msi

4. Follow the setup wizard to install the application.

Setting up

1. Start up the MTMLlink-FX Client program using the Shortcut called “MTMLlink-FX Client”, or from Start->Programs->ShipServ->MTMLlink-FX Client.

    

   The Client program allows you to configure the service parameters, and monitor the state of your connection to TradeNet

    

2. You should see a screen like the one below, then click on the ‘New’ button

    

   

    

3. Enter your TradeNet Account Details described below (which is issued to you by ShipServ), then click the ‘Add’ button.

    

   

    

   TradeNet Account Number: This is your TradeNet Account Number

   TradeNet User ID: This is your username for ShipServ TradeNet

   TradeNet Password: This is your ShipServ TradeNet password

   MTMLLink-FX Access Code: The default access code is “SHIPSERV” (in upper-case letters), if not changed.

    

   Note: The access code is your password-protection against unauthorised modifications to your MTMLlink-FX service settings. You can change the access code to your own preferred password by using the ‘Change Access Code’ button.

    

   After a few seconds the status field at the lower left should turn to a green tick (this shows you are now connected to TradeNet) as shown below:

    

   

    

4. Click on the ‘Edit’ button:

    

   

    

5. Enter your Access Code which is “SHIPSERV” (in upper-case letters), if not changed, and click on the ‘Ok’ button. The grayed-out fields should now become editable.

    

   

    

   Fill in the following fields:

    

   

    

   Inbox Folder: The downloaded document is saved in this folder. This is where the client's Purchasing/ERP system reads incoming transaction files

    

   Inbox Copy: A copy of each downloaded document is saved in this folder

    

   Outbox Folder: Documents placed in this folder will be sent out in the next exchange process. This is where the client's Purchasing/ERP system writes its outgoing transaction files.

    

   Outbox Copy: If the document placed in the OutBox folder is sent successfully, the document is moved from the OutBox folder to this folder.

    

   Error Folder: If an error is encountered when sending a document placed in the OutBox folder, the document is moved from the OutBox folder to this folder.

    

   Work Folder: This folder is being used for miscellaneous temporary processing.

    

   ICR Folder: After the document in the OutBox folder has been processed, whether successful or failed, an ICR (Interchange Response) file with the same file name is stored here.

    

   Exceptions
   
   Sending error due to timeout issue
   The Save ICR flag is set to FALSE in for the selected Integration Type

    

   Invoice Outbox: Invoice specific files in this folder will be sent to ShipServ Tradenet

    

   Note: On the TradeNet tab shown below – the fields ‘Server URL’, ‘Purchasing’ Integrations, ‘Invoice’ Integrations, and ‘Mode’ are grayed-out and disabled. This indicates that ShipServ has these pre-configured for your User ID otherwise the fields will become editable. If they are editable, leave the ‘Purchasing Integration’ type set to ‘STD’ , ‘Invoice Integration’ type to ‘STD’, Mode as ‘Send/Receive’, and the Poll Time at 300 (seconds) unless instructed to do otherwise by ShipServ Customer Service. (If you are using an HTTP Proxy Server please refer to 'Proxy Server' section below)

    

   

    

6. Click the ‘Save’ button – the bottom left tick should remain green (this confirms that you are still connected to TradeNet).

Proxy Server

As this is a generic document, not all clients will be using a Proxy Server. Please ignore this section you are not using one. If you are unsure with the settings, please confirm with your ShipServ representative.

Proxy Server: Name of proxy server (http://proxyname.domain:8080) or IP Address

Authorization: Authorization type

User: Username required to connect to your proxy server

Password: Password required to connect to your proxy server

Routing Downloaded Documents

MTMLlink-FX can be configured to save a specified document type to a particular folder.

Please check out the steps below to configure MTMLLink-FX to place all downloaded Invoice documents to C:\MTML\ROUTED folder

1. Click the “Edit” button in the “TradeNet” tab:

    

   

    

2. Enter your Access Code which is “SHIPSERV” (in upper-case letters), if not changed, and click on the ‘Ok’ button. The grayed-out fields should now become editable

    

   

    

3. Click on the “Advanced…” button.

4. Click on the “New” button and select the document type to route, then the folder where the downloaded document will be placed in and click on the “OK” button.

    

   

    

   

    

5. Click on the “Save” button.

    

   

    

Using MTMLLink-FX

Force Exchange

A Send/Receive action will be executed every so many seconds specified in the Poll Time field. A force Send/Receive can be executed by clicking the Exchange Now! button.

Transaction Log

A log is created for every transaction. You can view this log file by clicking on the Log tab. To clear the log file, click the Clear button.

Send Transaction Log to Technical Support

To send the Log file to Technical Support, click on the Send Log To Support button under the Log tab.

Sending and Receiving Attachments (older versions)

The Sender has to be configured to enable the Sending and Receiving of attachments.

Sending

In order to send attachments via MTMLLink FX:

1. The file attachments should be placed in a folder with name prefix same as the main document followed by “_ATTACHMENT”, e.g.:

   1. Main document → po200905051508189.xml

   2. Folder name → \po200905051508189.xml_ATTACHMENT

   3. First attachment → 14257_5456.jpg placed in folder \po200905051508189.xml_ATTACHMENT

   4. Second attachment → Schematics.pdf placed in folder \po200905051508189.xml_ATTACHMENT

   5. Third attachment → Brochure.doc placed in folder \po200905051508189.xml_ATTACHMENT

2. The documents and attachments should all be placed together in the configured outbox, e.g. “C:\MTML\OUT” in the following order:

   1. Create the folder for attachments.

   2. Save all attachments in the folder

   3. Save the main document.

    

   Sending successful
   
   If the document and attachments are sent successfully, all will be moved to the configured-out copy folder, e.g. “C:\MTML\OUT\COPY”.

    

   Sending failure
   
   If the document and attachment sending fails for any reason, all files will be moved to the configured error folder, e.g. “C:\MTML\ERR”.

Receiving

1. When MTMLLink FX detects that a particular document has attachments, it will download the main document and attachments. The attachments will be placed in a folder prefixed with the main document filename followed by “_ATTACHMENT, e.g.:

   1. Main document → 77988_20090505_151101_63.xml

   2. Folder name → \77988_20090505_151101_63.xml_ATTACHMENT

   3. First attachment → 14257_5456.jpg placed in folder \77988_20090505_151101_63.xml_ATTACHMENT

   4. Second attachment → Schematics.pdf placed in folder \77988_20090505_151101_63.xml_ATTACHMENT

   5. Third attachment → Brochure.doc placed in folder \77988_20090505_151101_63.xml_ATTACHMENT

Limitations

Maximum of 3 Megabytes total file size for all attachments.

Sending and Receiving Attachments (version 6.x and above)

The Sender has to be configured to enable the Sending and Receiving of attachments.

Sending

In order to send attachments via MTMLLink FX:

1. The file attachments should be placed in a folder with name prefix same as the main document followed by “_ATTACHMENT”, e.g.:

   1. Main document → po200905051508189.xml

   2. Folder name → \po200905051508189.xml_ATTACHMENT

   3. Header attachment → 14257_5456.jpg placed in folder \po200905051508189.xml_ATTACHMENT

   4. Line attachment → Schematics.pdf placed in folder \po200905051508189.xml_ATTACHMENT\1

2. The documents and attachments should all be placed together in the configured outbox, e.g. “C:\MTML\OUT” in the following order:

   1. Create the folder for attachments.

   2. Save all attachments in the folder. Header attachments are placed directly under the attachments folder and line attachments are placed in a sub-directory where the name is the line number.

   3. Save the main document.

    

   Sending successful
   
   If the document and attachments are sent successfully, all will be moved to the configured-out copy folder, e.g. “C:\MTML\OUT\COPY”.

    

   Sending failure
   
   If the document and attachment sending fails for any reason, all files will be moved to the configured error folder, e.g. “C:\MTML\ERR”.

Receiving

1. When MTMLLink FX detects that a particular document has attachments, it will download the main document and attachments. The attachments will be placed in a folder prefixed with the main document filename followed by “_ATTACHMENT, e.g.:

   1. Main document → 77988_20090505_151101_63.xml

   2. Folder name → \77988_20090505_151101_63.xml_ATTACHMENT

   3. Header attachment → 14257_5456.jpg placed in folder \77988_20090505_151101_63.xml_ATTACHMENT

   4. Line attachment → Schematics.pdf placed in folder \77988_20090505_151101_63.xml_ATTACHMENT\1

Attachments Classification

ShipServ now supports classification of attachments. This allows users to indicate what type of attachment are sent along with the transaction documents. Click here for more about classified attachments and supported documents, formats and usage.

When you receive attachments, the classification abbreviation will be prefixed in the filename.

• Header attachment → IN\77988_20090505_151101_63.xml_ATTACHMENT\SDoC_14257_5456.pdf

• Line attachment → IN\77988_20090505_151101_63.xml_ATTACHMENT\1\CERT_ropes_quality.pdf placed in folder

When sending attachments, prefix the classification abbreviation in the attachment filename before placing the files in the configured MTMLLink-FX OUT folder.

• Header attachment → OUT\77988_20090505_151101_63.xml_ATTACHMENT\SDoC_14257_5456.pdf

• Line attachment → OUT\77988_20090505_151101_63.xml_ATTACHMENT\1\CERT_ropes_quality.pdf placed in folder

Hazardous Material Indicator

With the classified attachments, users can now indicate if the attachment is for hazardous material. This is only applicable to Materials Declaration (MD) and Material Safety Data Sheet (MSDS) documents.

When you receive attachments, the hazardous material indicator will be prefixed in the filename.

• Line attachment → OUT\77988_20090505_151101_63.xml_ATTACHMENT\1\ForHazMat_MD_P30012.pdf placed in folder

When sending attachments, prefix the hazardous material indicator in the attachment filename before placing the files in the configured MTMLLink-FX OUT folder.

• Line attachment → OUT\77988_20090505_151101_63.xml_ATTACHMENT\1\ForHazMat_MSDS_Q607712.pdf placed in folder

The hazardous material indicator is always placed before the classification abbreviation.

Limitations

Maximum of 10 Megabytes per attachment file.

Maximum of 5 attachments per line item.

Uninstallation

You can uninstall “ShipServ MTMLlink-FX” program from the Control Panel -> Add/Remove Programs menu or from the Apps and features (if you are using a newer version of Windows) like any other application on your machine.

Upgrading to the latest version

1. Download the latest version of ShipServ MTMLlink-FX

2. Log on the client computer as a user with Administrative privileges.

3. Double-click on the downloaded .msi file, which should be named like ShipServ-MTMLlinkFX-xx.yy.msi

4. Follow the setup wizard to install the application