Integration Configurations

An overview of the integration configurations available for buyers and suppliers.

What are configurations?

Configurations are a set of policies that can be applied to a customers profile to enable a desired system behavior or data input/output.

How are they managed?

To enable a configurations, please contact support@shipserv.com.

🔎 Note: A self service option will be available for customers soon.


What configurations are available?

 

Legacy Name
(With Intr URL)

Zero Name

Description

Application

AllowAddNewLineItem

Allows/Restrict suppliers from adding new lines in the Quotation. Works only for Trade users.

Trade

AllowPOCReadonlyFields

Allow integrated suppliers to send changes in read only fields specified by the buyer for POC.

Integration

AllowPocWithoutPoa

This will make sending POA optional for integrated supplier. When flag is enabled, sending a POC without POA will be allowed.

Integration

AllowQOTReadonlyFields

Allow integrated suppliers to send changes in read only fields specfied by the buyer for QOT.
Used in conjuction with CCF_QOT_READONLY_FIELDS.

Integration

BlockExpiredQuote

This is a buyer feature wherein the buyer does not want to receive Quotes for RFQs whose Advise By date has already expired. When an RFQ is determined as blocked, the supplier Quote sending will fail.

Trade

BlockOrderedQuote

This is a buyer feature wherein the buyer does not want to receive Quotes for awarded RFQs. When an RFQ is determined as blocked, the supplier Quote upload will fail.

Trade

BuyerTnidMapping

This feature was created if an Integrated Supplier only wants to distinguish one Buyer TNID. A Buyer can have different offices which can have different Buyer TNID. This will cater the need if the supplier would want to consider all of them in one TNID.

Integration

ComparePoDlp

Resending the same PO with changes to the fields below, a replacement PO will be posted with the updated information:
- Latest Delivery Date (_2)
- Delivery Location (Vessel Name, Delivery Port)
- Delivery Address (CN)

Integration

ConvExtAsciiToEntity

This feature will convert ASCII characters that have a value of 128 or more to their respective Character Entity Number in all exported MTML document from TradeNet.

Integration

ConvertDprToPercent

Upon enabling this flag, the downloaded quote will show the DPR price details in terms of percentage instead of cost.

Integration

ConvertHDiscToPercent

Upon enabling this flag, the downloaded QOT/POC will show the Header Discount (Qualifier="_204") price details in terms of percentage instead of cost.

Integration

ConvertMfToBP

If this option is enabled , all LineItems arriving in RFQ/POs from an integrated buyer which have TypeCode=MF (i.e. Manufacturer's PartNo.) are changed to "BP" (Buyer's PartNo).

Integration

ConvertPORToPOC

Allows conversion of POR Decline into a PO Confirmation doc type with Zero Quantity.

Integration

ConvertRfpToQot

Enable Buyer to receive RFQ decline xml (make sure integrated buyers can handle the import of this document).

Integration

CountryPortHyphen

If this options is enabled , incoming MTML transactions get a hyphen inserted into the port code , e.g. NOOSL gets converted to NO-OSL. This is in order to better comply with the MTML standard.

Integration

CustomUomMapping

UOM Mapping setting per TNID. The mapping table is hosted in the CODE_MAPPING table with the MAP_TYPE = 'UOM'. When a non-standard UOM is mapped, the old UOM is prefixed in square brackets [] to the line item description.

Integration

DefaultAddressMapping

Enable default mapping for Party Address details, setup default buyer contact or billing address according to mapping table below and ignore the following details passed from Buyers original RFQ / PO

Integration

DlvryAddressInPartyBy

The Buyer Address will be extracted from Consignee Address

Integration

DoctypePoaToPoc

This customization allows Bpship Acknowledgment feature to handle POA to be converted to POC on DocType.

Integration

EnableCbrMapping

For buyers who belong to separate companies but are managed from the same purchasing system (i.e. all RFQs/POs come from the same TradeNet ID), we can make transactions appear to come from different sub-buyer companies, based on which company (i.e. Party BY party name contact) is mentioned in the incoming RFQ/PO.

Integration

EnableChrMapping

This feature will allow Character based mapping per TNID based on the Code Mapping table that has a map type of Character.

Integration

EnableCurrencyMapping

This feature will map the currency as known by the clients to the currency as known by TradeNet.

Integration

EnableDateMapping

This feature will map values of Due Date to Requested Delivery Date and Given Delivery Date to delete content.

Integration

EnableGenPartNo

Enable if Buyers always need a value in the part number field in quotations. ShipServ will add a dummy part number to facilitate the import.

Integration

EnableGenPartNoFormat

Specify the series for the dummy part e.g. SS000001

Integration

EnableMandatoryFields

For buyers who have Trade Supplier, they have the ability to set certain fields to be readonly or mandatory. This can be set on buyer settings under CUSTOMER_CONFIG table.

Integration

EnableOrdAddressMapping

This customization allows RFQ and/Or PO Billing address to be map by using IMO, Company and User details

Integration

EnablePnoMapping

This feature will update Part Number from RFQ and Order according to mapping table.

Integration

EnableProforma

 

Integration

EnableProRating

 

Integration

EnableRecipientMapping

For cases wherein a group of suppliers use a consolidated TN account but those individual suppliers belonging to that group are all represented individually in the buyer purchasing system, this feature enables such buyers to put an ID to each suppliers to differentiate them from each other.

Integration

EnableRfqAddressMapping

This customization allows RFQ and/Or PO Billing address to be map by using IMO, Company and User details

Integration

EnableTxtMapping

 

Integration

EnableVptMapping

This feature is for integrated suppliers that would like to have their own Part Type defined for a particular buyer.

Integration

FastenalPartMapping

This feature will update Part Number from RFQ and Order according to mapping table.

Integration

FxRcvAttach

To enable FX users to download transaction attachments from the sender

Integration

FxRcvAttachSizeLimit

To enable FX users to download transaction attachments from the sender

Integration

FxRcvPrintAtt

To enable FX users to download transaction attachments from the sender

Integration

HeaderCmntsSeparator

On the RFQ and PO sent to the supplier, we concatenate 4 fields in the Buyer Comments:
Attachment link details
Buyer Comments
Packaging Instructions
Currency Instructions

Integration

IgnoreRemRepControlRef

A new CUSTOMER_CONFIG switch to include/exclude the ControlReference sent by the buyer in the criteria.

Integration

InboundPercentToAmount

 

Integration

InsertNewLineOnPattern

 

Integration

IsHeaderDiscToLineItem

This will remove the Header Discount and apply it the Line Item Discounts.

Integration

IsMapVesselNameToImo

This feature will try to map a given Vessel Name for an RFQ/PO to it.s corresponding Vessel IMO on a given Buyer in it.s Vessel Profile records.

Integration

IsMtmlExportAddrMapped

 

Integration

IsOutRestorePartNo

This feature will try to map a given Vessel Name for an RFQ/PO to it.s corresponding Vessel IMO on a given Buyer in it.s Vessel Profile records.

Integration

IsOverflowToAttachment

When a client sends a document through MTMLLink FX with values that exceed the database length.

Integration

IsRemindOnMtmlDup

This is to allow replacement documents FX integrations. RFQs and POs only.

Integration

IsReplaceOnMtmlChange

This is to allow replacement documents FX integrations. RFQs and POs only.

Integration

 

 

 

MapAbsTaxStatus

This feature will map local tax status to the tax status segment of RFQ/PO sent by ABS/NS5 buyers.

Integration

MapCmtTimeToLeadtime

This feature is for Supplier ISS Machinery wherein they want ShipServ to parse out the numerical value and unit of time (days/weeks/months) after "DELIVERY TIME:" (located in their comment section), convert it to the equivalent number of working days, and map it to the MTML field Supplier Delivery Time.

Integration

MoveDprToGrp

Upon enabling this flag, the downloaded quote will only show the discounted GRP and remove the DPR price details.

Integration

MoveNegCostsToDisc

This feature is for those integrated suppliers that can't handle values for negative freight and packing cost. The values will be added in the header discount. The removed values for Freight and Packing cost will be added in the Buyer Comments.

Integration

MtmlEquipmentSupport

Aggregate equipment info into header if identical in ALL lineitems (Y for Fuji)".This is a very old setting which only takes effect in mtmlserver , and only for integrated suppliers ( Fuji ).

Integration

MtmlExportedAck

If an integrated customer is set up for this feature, their MTMLlink-FX will send back a "Acknowledged Receipt" for each transaction they receive ( e.g. Buyers will acknowledge receipt of Quotes, POCs and OrderResponses ; integrated suppliers will acknowledge receipt of RFQs and Orders).

Integration

MtmlLineitemRobSupport

ROB (Remaining On Board) quantity information is exported to the buyer's purchasing system on each Req line item using the MTML "RemainingQuantity" field. N.B. the customer's purchasing system must support ROB on reqs, AND they should use the latest MTML.DTD (v1.3.3).

Integration

MtmlStdPrepDateTime

 

Integration

NewQotPoLinking

By default, Quote is linked to PO using the auto-generated internal reference number (e.g. <Reference Qualifier="AGI" ReferenceNumber="Quote:2296377"/>). By enabling this feature, QOT-PO linking can be done by using the human readable QOT reference number or QOT UC reference on Order AAG or AGI (e.g. <Reference Qualifier="AAG" ReferenceNumber="QOT-TEST-002"/>).

Integration

NS5PoRenumbering

 

Integration

NumberInEurFormat

This feature allows the client to send and receive amounts in European format.

Integration

OmMtmlVersion

Indicates the Order Management (OM) MTML version. The version is being checked so that TNC will
include version-specific logic or validations.

Integration

OutIcrMsgNo

An MTML-compliant integrated buyer or supplier has the option to display or remove MessageNumber attribute in the ICR Response

Integration

OutMtmlDtdRef

When an MTML-compliant integrated buyer or supplier downloads a document, include the reference to the MTML.DTD document: <!DOCTYPE MTML SYSTEM "Mtml.dtd"[]>

Integration

OutMtmlEncodingRef

An MTML-compliant integrated buyer or supplier has the option to display or remove the reference to the encoding type on the downloaded
document. This is found at the beginning of the document in the format: encoding="UTF-8"?

Integration

OutMtmlVersionRef

This table defines the rules on document interchanges between a buyer and a supplier. This is implemented because some clients
prefer not to receive certain documents because, for example, their purchasing systems do not support certain documents.

Integration

OutputAddCostDesc1

In SmartSupplier, Line Item Subtotal has a field labeled Other. Currently, value on this field even when provided will not be available upon download by Buyer on TNC.
This feature allows TNC to display the additional cost provided by Supplier during download.

Integration

OutputOrpOrdRefNo

How we handle display of POA Reference Number and Supplier Comments once XML file is exported in POA (buyer download).

Integration

OutputPortName

Enable default mapping for Party Address details, setup default buyer contact or billing address according to mapping table below and ignore the following details passed from Buyer.s original RFQ / PO

Integration

OutputProperPartyFields

Sender output the party information from proper MTML fields PARTY_CONTACT table

Integration

OutputQotGenuineSpare

How we handle display of selected value for Quality data that ShipServ is requiring suppliers to input.

Integration

OverflowRefNoToComments

This feature is for those integrated customers that have number of characters limitation for Reference Numbers in their system.

Integration

PartyBaAbsentAcceptIv

The Billing Address will be extracted from Invoicee Address.

Integration

PartyCnAbsentUseByOB

On incoming MTML RFQs and PO's the delivery address should normally be in the "CN" (Consignee) Party. However some purchasing systems (e.g. AMOS) put the Delivery address in the "BY" or "OB" party , so we have a flag to set to take the delivery address from BY or OB Party if CN Party is absent.

Integration

PocReadOnlyFields

For buyers who have SmartSupplier and StartSupplier, they have the ability to set certain fields to be readonly or mandatory. This can be set on buyer settings under CUSTOMER_CONFIG table.

Trade

PocVarianceLineRestore

This will restore line item variance values on Buyer Import.

Integration

PreventAdditionalCosts

When a QOT / POC is downloaded by the buyer, the Additional Cost (MonetaryAmount.Qualifier="_106") is set to 0 and the freight charge amount deducted from the total QOT / POC amount . The removed amount will be placed in the Supplier Comments in the format: .[Removed Additional Costs from xxxx ].

Integration

PreventFreightCharges

When a QOT / POC is downloaded by the buyer, the Freight Charge (MonetaryAmount.Qualifier=._64) is set to 0 and the freight charge amount deducted from the total QOT / POC amount (MonetaryAmount.Qualifier=._259). The removed amount will be placed in the Supplier Comments in the format: .[Removed Freight Charges from Quote / POC: x].

Integration

PriceDetailsValidation

This feature will prevent integrated buyer or supplier from sending an invalid value for Type Qualifier under Price Details.

Integration

PriorityMapping

Some company may have different sets of Priority Level, however, MTML only accepts a specific set of values: High, Medium, Low.
Enabling this feature, will allow custom Priority to be mapped to a valid Priority value.

Integration

QotReadOnlyFields

For buyers who have SmartSupplier and StartSupplier, they have the ability to set certain fields to be readonly or mandatory. This can be set on buyer settings under CUSTOMER_CONFIG table.

Trade

QotVarianceLineRestore

This will restore line item variance values on Buyer Import.

Integration

GetQotWithSupCurrFlag

 

Integration

RcvAttachmentLink

This feature will allow clients to view attachments associated in the trading documents by accessing the available link in the header comments upon download from Shipserv.

Integration

RcvStdMtmlFldLen

Limit the length of fields to standard MTML lengths when sending documents to clients.

Integration

RemindMaxCount

This is to allow replacement documents FX integrations. RFQs and POs only.

Integration

RemoveInvalidDate

Null dates sent in documents older than 2 years.

Integration

RemoveMonetaryAmount

This allows an MTML-compliant integrated buyer to remove header Monetary Amount in the downloaded XML when tag is not present or when value is equal to zero.

Integration

RemovePriceDetails

An MTML-compliant integrated buyer or supplier has the option to display or remove line item monetary amount from the downloaded document. (e.g. LineItem MonetaryAmount="0.00")

Integration

RemoveRevisionNumber

Ability to remove R:1 for AGI on QOT and POC download during Replace document using customer config,

Integration

RenumberLineItems

 

 

RestoreImo

This will restore IMO value sent in PO if not sent back in POC by supplier.

Integration

RestorePceToNonStdUom

When buyer sends RFQ or PO with a NON_STD_UOM that is mapped to PCE, then receiver sends QOT or POC with UOM: PCE; it will restore back the non-MTML standard UOM

Integration

RetainOrigEqDetails

When the buyer downloads a QOT, the line item equipment details sent by the supplier are overwritten with the equipment details sent on the previously sent RFQ.

Integration

RetainOrigLiDesc

Restore Line Item Description of in QOT/POC from RFQ/PO document

Integration

RfqDeadlineControl

The Deadline Control Feature allows buyers to indicate a Quote Deadline for an RFQ. If an RFQ hasn't passed the deadline date, purchasers won't be able to see the quote prices and they won't be able to send a PO from that quote. Quote Deadline is required when submitting an RFQ. When an integrated supplier downloads an RFQ, comments will be inserted informing them that this RFQ has a deadline.

Trade

RFQDeadlineNotifyMins

The Deadline Control Feature allows buyers to indicate a Quote Deadline for an RFQ. If an RFQ hasn't passed the deadline date, purchasers won't be able to see the quote prices and they won't be able to send a PO from that quote. Quote Deadline is required when submitting an RFQ. When an integrated supplier downloads an RFQ, comments will be inserted informing them that this RFQ has a deadline.

Trade

RoundOffPrecision

Set the number of decimal places for mbling QOT, PO, POC Variances to use the variance engineonetary amounts to be outputted by the MTML Server

Integration

 

 

 

 

 

 

 

 

 

StartSupplier21Redirect

For buyers who use 7-digit startsupplier-121 IDs inside their purchasing system, and ShipServ would like to get them to start using the newer 5-digit startsupplierSTANDARD TradeNet IDs.

Integration

StrictNumericValidation

This feature allows the client to send and receive amounts in European format.

Integration

StripUomMapping

This feature will strip any UOM prefix enclosed by [] or () included in the beginning of a Line Item Description. UOM Prefixes are caused by UOM Mappings which are: Custom UOM Mapping, Global Mapping and Conversion of Non Standard UOM to PCE.

Integration

SupCmntsInQualifierSur

When exporting a Quote/OrderResponse/POC MTML file to a buyer, Should we use Qualifier "SUR" or "PUR" for the Supplier's comments ?

Integration

HideBuyerContactEmail

 

Trade

TruncHeaderCmts

This feature is for integrated suppliers that would like the "Buyer comments" to be truncated.

Integration

UomMapping

Enable Global Unit Of Measure mapping

Integration

UploadDateFormat

This feature allows setting of custom date and time format for transaction document to be uploaded. Failure in upload due to Invalid Date error will be encountered in case of an incorrect format

Integration

UseOrigMsgNoOnReplace

 

Integration

ValidateMonetaryValue

This customization allows TNC to skip validation Monetary Amount Value node for all Document. By default in TNC Monetary amount is always validated if empty or has invalid values, having this flag disable will skip this validation on all documents both for Buyer and Supplier.

Integration

VarianceLineRestore

This will restore line item variance values on Buyer Import.

Integration

VendorTnidMapping

Enable a buyer to send custom vendor codes and this will be mapped to a valid Vendor TNID.

Integration

LineItemLeadTimeSupport

Incoming Quotes from certain integrated suppliers (e.g. MAN B&W) have leadTimes defined per line item. We add these to the LineItem Description before adding to our database.

Integration

MoveLineItemsToHeaderCmnts

Enables handling of supplier adding extra line items

Integration

VesselBasedRedirectEnabled

For buyers who manage vessels which belong to separate companies but are managed from the same purchasing system (ie all RFQs/POs come from the same TradeNet ID) , we can make transactions appear to come from different companies, based on which vessel(i.e. IMO number) is mentioned in the incoming RFQ/PO.

Integration

N/A

GeneratedLineAttachmentsDocToHeaderAttachments

A line attachments PDF document will be generated automatically and included as header attachment.

 

Enabled by default, applicable to buyers and suppliers.

 

Note: The PDF document is only generated when the transaction document has at least one line item with attachment.

Integration

N/A

ClassifiedAttachments

Allows support for MTML (see MTML 1.9) classified attachments.

 

Disabled by default, applicable to buyers and suppliers using MTML based integrations.

 

If enabled, on download the document header and line attachments information will be part of the document.

 

Important: This can break the client's integration. Before enabling, make sure that the client's system supports MTML 1.9 and higher.

Integration

N/A

ClassifiedAttachmentsOnFilename

Allows classified information to be included as part of the filename.

 

Disabled by default, applicable to buyers and suppliers.

 

If enabled, on document download the classification and hazmat indicator will be prefixed in the attachment filename e.g. MD_S112-MDOC.pdf, HasHazMat_MD_S443-MDOC2.pdf.

 

On document upload the classification and hazmat indicator will be expected and parsed from the attachment filename. If the classification is invalid or is not in the filename, then the attachment will be classified as 'OTHER'. If the hazmat indicator is invalid or is not in the filename, then it will be set to 'NOT SPECIFIED'.

Integration

N/A

EnableSupplierPartNumber

Allows support for Line Supplier Part Number as separate and new field.

 

Disabled by default, applicable to buyers and suppliers.

 

If enabled, the Supplier Part Number is placed in the LineItem SupplierPartNumber attribute e.g. <LineItem ... SupplierPartNumber="SPN12345"/>

 

If disabled, the Supplier Part Number is prefixed to the LineItem Comments e.g. <LineItem>

<Comments Qualifier="LIN">

<Value>Supplier PN: SPN12345</Value></Comments

</LineItem>

Integration

N/A

Move Line Item Remarks To Header Remarks

** For NS51_PACC profile only. **

 

Allows NS51_PACC profile users to move line item comments to the header remarks section in NS

Integration

N/A

Supplier Name On Attachment Filename

** For NS51_PACC profile only. **

 

Allows NS51_PACC profile users to append the ShipServ supplier name to the attachment file name when NS downloads the attachments. File name is limited to 200 chars only.

Integration