Guide on how to Classified and Line item attachments + IHM for customers
Introduction
ShipServ integrations now allows customers to send and receive attachments at line level and also supports attachment classification which can be used by customers for IHM (Inventory of Hazardous Materials).
Here we will guide you on how to enable the set up for customers.
Applicable to
-
For Buyers and Suppliers using MTML Link FX 6.x.x above
-
For Buyers and Suppliers using Direct Web Service, new TNC endpoints GetDocumentWithClassifiedAttachment & SendDocumentWithClassifiedAttachment
- For Buyers and Suppliers using the Order Management API Version 2.x.x above
What you will need
-
Formal request from the customer, with approval from the AM's or Tech AM.
-
Admin access to set up configurations.
Configuration set up
By default, all customers are set up to receive line attachments by a Generated Line Attachments Doc To Header Attachments.
|
Configuration Name |
Description |
Important Notes |
|
FxRcvAttach |
Indicates if the customers system can handle attachments via MTMLLink FX |
Should be enabled if customers request to download attachments. |
|
RcvAttachmentLink |
Indicates if the customer wants to receive header attachments as links in the header comments. |
Should be disabled if the customers systems can handle attachments. |
|
ClassifiedAttachments |
Indicates if the customers can handle attachment classifications. If enabled, customers will receive additional fields in the MTML file or API response with the attachment classification and Hazmat indicator along with the header and line item attachments. |
Should be enabled if customers system can handle attachment classifications. Set config attribute to 1.
You can refer to this article for information on classified attachment and technical documentation. |
|
ClassifiedAttachmentsOnFilename |
For customers who want to receive the attachment classification and the Hazmat indicator appended to the file name (e.g. HazMat_MD_filename.pdf) |
Should be disabled if the ClassifiedAttachments config is enabled for customers.
You can refer to this article for information on classified attachment and technical documentation. |
|
Generated Line Attachments Doc To Header Attachments |
Enabled by default for all customers, this config generates a pdf document with links to the line item attachments. |
Should be disabled if the customers systems can handle attachments.
Important note: This config may not be listed under the active configurations for the client. In this case you need to explicitly add the config and disable it |
Important Notes:
-
Do not forget to clear the config cache once are applied to an account!
-
You need to link the legacy username and password to a new platform user. Clear user cache once done
Reference
Here are some articles that will help you understand more about classified attachments.
-
To know what is classified attachments refer to this article
-
To know how API customers can send and receive classified attachments refer to this article
-
To know how MTML customers can send and receive classified attachments refer to this article
-
To know how Web Services customers can send and receive classified attachments refer to this article
-
For more information contact you may contact automation_support@shipserv.com