Type = Technical Guides, Technical Tools, What's New,; Topic = Multienterprise Information Network Tower (MINT), Technical Documentation,;Persona = Solution Designer, TraceLink Administrator, User, Orchestration Architect, Solution Partner, Technology Partner,; Orchestration = Manufacturing, Logistics, Commerce, Transportation, Clinical Supply,; Function = IT, Quality, Procurement,

Text message canonical guidelines

The Text message transaction enables trading partners to exchange free-form, human-readable messages directly through standard EDI channels. Unlike transactional EDI messages that require structured data for system processing, the text message is designed for non-transactional communication such as instructions, clarifications, alerts, or one-time announcements that benefit from being shared within the EDI framework but do not need to trigger system actions.

Canonical Element Type Definition Description IDoc mapping X12 mapping EDIFACTmapping
Canonical Element - JSon object type/root element. - - -
  controlFileHeader - Canonical control file header to store data for control segments and envelopes of IDocs, and X12 and EDIFACT EDI messages. - - -
  canonicalTextMessageHeader - Header details for the canonical text message. - BMG BGM
    processingFunctionTypeCode string

Processing function, transaction set purpose code.

Valid values include:

  • CREATE

  • CHANGE

  • CANCEL

  • DELETE

  • ORIGINAL

  • REPLACE

  • STATUS

  • CONFIRM

-

BMG01 =

  • 08 (STATUS) or

  • 00 (ORIGINAL)

  • 01 (CANCEL)

  • 06 (CONFIRM)

BGM030 =

  • 8 (STATUS) or

  • 9 (ORIGINAL)

  • 1 (CANCEL)

  • 6 (CONFIRM)
    description string Description of text message to set the context of document. - BMG02 BGM010-040
    documentTypeCode string

Code specifying the type of transaction document supporting the message.

Valid values:

  • REPORT

  • EMAIL

-

BMG03 =

  • 03 (REPORT) or

  • 04 (EMAIL)

 BGM010-010
    mpcDates array Dates relevant for text message at header. - DTM DTM
      dateType string

Date type at header level for text message transaction set at header in date format YYYYMMDD and time format (IDoc, X12) HHMMSS.

Valid values:

  • PROCESSING - Transaction processing date

  • INVOICE - Invoice Date

  • CREATEDON - Transaction created date

 -

DTM01 =

  • 009 (PROCESSING) or

  • 003 (INVOICE) or

  • 097 (CREATEDON)

DTM010-010 =

  • 453 (CREATEDON) Or

  • 003 (INVOICE) Or

  • 009 (PROCESSING)

      dateValue string Date defined by referenced date type in date format YYYY-MM-DD. Transform will pass thru whatever it finds in IDoc date and time fields. - DTM02 DTM010-020
      epochDateValue integer Date defined by referenced date type generated in epoch integer date format. - - -
      dateTimePeriodFormat string

Code specifying representation of date or time or format presented in date value,

Valid values include:

  • CCYYMMDD - Date format century year month day, 2 characters each

  • CCYYMMDDHHMM - Date format century year month day hour minutes, 2 characters each

 -

DTM05 =

  • TT (MMDDYY) or

  • DT (CCYYMMDDHHMM)

 DTM010-030
      timeZone string Time zone for referenced dates. - DTM04 -
      eventTimeType string Event Time Type. - - -
    transactionReferenceIdentifierList array Text Message transaction identifier. - - -
      b2bTransactionIdentifierType string

Transaction reference type for X12 segments REF and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

TEXTMESSAGE - Text Message (required)

 - b2bTransactionIdentifierType = TEXTMESSAGE, if BGM01 is present. -
      b2bTransactionIdentifierValue string Transaction reference identifier value. - - -
      transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
      epochTransactionDate string Transaction reference date and time, if time available, in epoch date format. - - -
      lineItemNumber integer Transaction reference date and time in EPOCH date time format. - - -
      b2bTransactionIdentifierTypeName string B2B Transaction Identifier Type Name. - - -
      timeZone string Time Zone. - - -
    extendedPartnerBusinessInformation array Extended Partner Entity group identifiers and address information. - N1 Loop NAD Group
      businessPartyInformation - Partner Entity group identifiers and address information. - N1 NAD
        partnerEntityType string

Explains the type of the partner entity involved in this business transaction.

valid values include:

  • SENDER - Message from

  • RECEIVER - Message to

 - N101 NAD010
        businessName string Business name for partner or location. - N102 NAD030-010
        additionalBusinessName string Additional Business name for partner or location. - - -
        companyLocationPartnerName string Additional Location of same Business partner. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Company identifier type for business partner. -

  • N103 - 1 (DUNS) or

  • N103 - 9 (DUNS4) or

  • N103 - 11 (DEA) or

  • N103 - 21 (HIN) or

  • N103 - 91 (COMPANYID) or

  • N103 - 92 (COMPANYSITEID) or

  • N103 - UL (GLN)

  • N103 - 93 (TRANSACTION_PARTY_ID) or

  • N103 - 94 (TRANSACTION_PARTY_ID) or

  • N103 - FA (FACILITY_IDENTIFIER) or

  • N103 - 20 (STANDARD_POINT_LOCATION_CODE) or

  • N103 - ZZ (CUSTOM)

  • NAD020-030 = 16 (DUNS))

  • NAD020-030 = 164(DEA)

  • NAD020-030 = 237(HIN)

  • NAD020-030 = 91(COMPANYID)

  • NAD020-030 = 92(COMPANYSITEID)

  • NAD020-030 = 9(GLN)
          companyIdentifierValue string Company identifier value for business partner. - N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value. - - -
        address - Party address information. - N3, N4,  
          address1 string Main street address. - N301 NAD050-010
          address2 string Supplemental street address. - N302 NAD050-020
          city string City - N401 NAD060
          district string District - - -
          state string State or region code - N402 NAD070-010
          postalCode string Postal code - N403 NAD080
          country string Country code - N404 NAD090
          telephone string Telephone number - - -
          fax string Fax number - - -
          url string Website URL - - -
          buildingNumber string Building number - - -
          plantNumber string Plant number - - -
          floorNumber string Floor number in building. - - -
          lscAddressIdentifier string LSC address identifier. - - -
          village string Village name - - -
          houseNumber string House number - - -
          township string Township - - -
          premisesCode string Premises code - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          orderType string Order Type. - - -
          address3 string Additional address information that is not included in addressTypeDefinition. - - -
          postalArea string Postal Area - - -
          timeZone string Time zone for referenced dates - - -
          telephone string Telephone Number - - -
          emailAddress string Email Address - - -
          vatRegistrationNumber string Vat Registration Number - - -
          taxExemptCode string Tax exempt Code - - -
          locationType string Business Partner Location Type - - -
          locationIdentifier string Business Partner location Identifier - - -
          countrySubDivisionCode string Describes the country subdivision - - -
        companyLocationContactInformation - - - PER Segment Segment loop NAD-CTA
          contactType string

Contact type.

Valid values include:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

  • SENDER - Message sender contact

 -

PER01 =

  • IC (INFORMATION) or

  • FC (FORWARDER)

CTA010 =

  • IC (INFORMATION) or

  • OC (ORDERCONTACT)

  • CW (CONFIRMEDWITH)

  • HE (EMERGENCYDANGEROUS)

  • MS (SENDER)
          contactName string Contact name - PER02 CTA020-020
          contactTitle string Title of contact - - -
          contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
          contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"
      transactionReferenceIdentifierList array List of documents and transactions at the header level of the message. - REF RFF
        b2bTransactionIdentifierType string

Transaction reference type for X12 segments REF and EDIFACT RFF for general reference data that is not a transaction document identifier.

The valid values include INVOICE - Invoice Number

 - REF01 = IV (INVOICE)

RFF010-010 =

  • BM (BOL) Or

  • ON (PURCHASEORDER) Or

  • SN (SEALNUMBER) Or

  • CG (CONSIGNEEORDER) Or
        b2bTransactionIdentifierValue string Transaction reference identifier value. - REF02 for qualifiers in b2bTransactionIdentifierType RFF010-020 for b2bTransactionIdentifierType
        transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
        epochTransactionDate string Transaction reference date and time, if time available, in epoch date format. - - -
        lineItemNumber integer Transaction reference date and time in EPOCH date time format. - - -
        b2bTransactionIdentifierTypeName string B2B Transaction Identifier Type Name. - - -
        timeZone string Time Zone. - - -
      transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF. - REF RFF
        transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

Valid values include:

  • INTERNALVENDORNUMBER - Internal Vendor Number

  • DEPARTMENT - Department Number

 - REF01 = IA (INTERNALVENDORNUMBER)

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

  • SRN (CARRIERASSIGNEDSHIPPERIDENTIFIER) Or

  • SD (SALESDEPARTMENT)
        transactionReferenceIdentifier string Transaction reference identifier value. - REF02 RFF010-020
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - REF03  
        transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
        epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    freeTextNote array Free form text required for text message at header. - - -
      textReferenceCode string Text reference or subject code. - - -
      textFunctionCode string Text function code. - - -
      language string Language of free text. - - -
      textFormatCode string Format code for free text. - - -
      freeText string Free test string. - - -
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalTextMessageItemDetails array Line item details for the canonical text message. Line item details describes messages, allowed number of characters per line, allowed number of lines per page, etc.. - MIT Loop (Mandatory) FTX Loop
    transactionReferenceIdentifier string Transaction reference identifier value or message number. - MIT01 (Mandatory) -
    description string Description of text message or subject of the message in brief. - MIT02 -
    maximumNumberOfCharacters Number Maximum number of characters per line, expected in the message text. - MIT03 Default 80 characters. -
    maximumNumberOfLines Number Maximum number of lines per page, expected in the message text. - MIT04 Default 66 lines allowed. -
    extendedPartnerBusinessInformation array Extended Partner Entity group identifiers and address information at line item. - N1 Loop NAD Group
      businessPartyInformation - Partner Entity group identifiers and address information. - N1 NAD
        partnerEntityType string

Explains the type of the partner entity involved in this business transaction,

Valid values include:

  • SENDER - Message from

  • RECEIVER - Message to

 - N101 NAD010
        businessName string Business name for partner or location. - N102 NAD030-010
        additionalBusinessName string Additional Business name for partner or location. - - -
        companyLocationPartnerName string Additional Location of same Business partner. - - -
        mpcCompanyLocationIdentifierList array Identifier list for business party. - - -
          isIdentifierPresentInEvent boolean Is identifier present in event boolean. - - -
          companyIdentifierType string Company identifier type for business partner -

  • N103 = 1 (DUNS) or

  • N103 = 9 (DUNS4) or

  • N103 = 11 (DEA) or

  • N103 = 21 (HIN) or

  • N103 = 91 (COMPANYID) or

  • N103 = 92 (COMPANYSITEID) or N103 = UL (GLN)

  • N103 = 93 (TRANSACTION_PARTY_ID) or

  • N103 = 94 (TRANSACTION_PARTY_ID) or

  • N103 = FA (FACILITY_IDENTIFIER) or

  • N103 = 20 (STANDARD_POINT_LOCATION_CODE) or

  • N103 = ZZ (CUSTOM)

  • NAD020-030 =16 (DUNS))

  • NAD020-030 = 164(DEA)

  • NAD020-030 = 237(HIN)

  • NAD020-030 = 91(COMPANYID)

  • NAD020-030 = 92(COMPANYSITEID)

  • NAD020-030 = 9(GLN)
          companyIdentifierValue string Company identifier value for business partner - N104 NAD020-010
          alternateCompanyLocationIdentifierValue string Alternate company location identifier value - - -
        address - Party address information - N3, N4, -
          address1 string Main street address - N301 NAD050-010
          address2 string Supplemental street address - N302 NAD050-020
          city string City - N401 NAD060
          district string District - N/A N/A
          state string State or region code - N402 NAD070-010
          postalCode string Postal code - N403 NAD080
          country string Country code - N404 NAD090
          telephone string Telephone number - - -
          fax string Fax number - - -
          url string Website URL - - -
          buildingNumber string Building number - - -
          plantNumber string Plant number - - -
          floorNumber string Floor number in building - - -
          lscAddressIdentifier string LSC address identifier - - -
          village string Village name - - -
          houseNumber string House number - - -
          township string Township - - -
          premisesCode string Premises code - - -
        mpcAdditionalAddressInformation - Additional address information that is not included in addressTypeDefinition. - - -
          externalERPUserName string External ERP system user name for user who generated message. - - -
          organizationCode string Code for organization responsible for generating the message. - - -
          organizationDescription string Description of the organization responsible for generating the message. - - -
          groupCode string Code identifying group responsible for generating the message. - - -
          language string Language key for message. - - -
          languageCode string ISO language code for message. - - -
          referenceIdentifier string Partner reference identifier. - - -
          orderType string Order Type. - - -
          address3 string Additional address information that is not included in addressTypeDefinition. - - -
          postalArea string Postal Area. - - -
          timeZone string Time zone for referenced dates. - - -
          telephone string Telephone Number. - - -
          emailAddress string Email Address. - - -
          vatRegistrationNumber string Vat Registration Number. - - -
          taxExemptCode string Tax exempt Code. - - -
          locationType string Business Partner Location Type. - - -
          locationIdentifier string Business Partner location Identifier. - N406 -
          countrySubDivisionCode string Describes the country subdivision. - N407 -
        companyLocationContactInformation - - - PER Segment Segment loop NAD-CTA
          contactType string

Contact type.

Valid values include:

  • INFORMATION - Information contact

  • FORWARDER - Forwarder contact

  • SENDER - Message sender contact

 -

PER01 =

  • IC (INFORMATION) or

  • FC (FORWARDER)

CTA010 =

  • IC (INFORMATION) or

  • OC (ORDERCONTACT)

  • CW (CONFIRMEDWITH)

  • HE (EMERGENCYDANGEROUS)

  • MS (SENDER)
          contactName string Contact name. - PER02 CTA020-020
          contactTitle string Title of contact. - - -
          contactPhone string Contact phone number. - PER04 where PER03 = "TE" COM010-010 where COM010-020 = "TE"
          contactEmail string Contact email address. - PER06 where PER05 = "EM" COM010-010 where COM010-020 = "EM"
      transactionReferenceIdentifierList array List of documents and transactions at the line item level of the message. - REF RFF
        b2bTransactionIdentifierType string

Transaction reference type for X12 segments REF and EDIFACT RFF for general reference data that is not a transaction document identifier.

The valid values include INVOICE - Invoice Number.

 - REF01 = IV (INVOICE)

RFF010-010 =

  • BM (BOL) Or

  • ON (PURCHASEORDER) Or

  • SN (SEALNUMBER) Or

  • CG (CONSIGNEEORDER) Or
        b2bTransactionIdentifierValue string

Transaction reference identifier value.

 - REF02 for qualifiers in b2bTransactionIdentifierType RFF010-020 for b2bTransactionIdentifierType
        transactionDate string Transaction reference date and time, if time available, in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
        epochTransactionDate string Transaction reference date and time, if time available, in epoch date format - - -
        lineItemNumber integer Transaction reference date and time in EPOCH date time format. - - -
        b2bTransactionIdentifierTypeName string B2B Transaction Identifier Type Name - - -
        timeZone string Time Zone - - -
      transactionReferenceInformation array Reference information for identifiers that are not related to transaction documents. This group would map to X12 segments REF and N9 and EDIFACT RFF at line item. - REF RFF
        transactionReferenceType string

Transaction reference type for X12 segments REF and N9 and EDIFACT RFF for general reference data that is not a transaction document identifier.

The valid values include INTERNALVENDORNUMBER - Internal Vendor Number.

 - REF01 = IA (INTERNALVENDORNUMBER)

RFF010-010 =

  • FF (FORWARDERREFERENCE) Or

  • ZZZ (CUSTOM) Or

  • AAO (PICKUPIDENTIFIER) Or

  • SRN (CARRIERASSIGNEDSHIPPERIDENTIFIER) Or

  • SD (SALESDEPARTMENT)
        transactionReferenceIdentifier string Transaction reference identifier value. - REF02 RFF010-020
        description string Identifier or description defined by qualifier code in transactionReferenceIdentifier (REF02). - REF03 -
        transactionReferenceDate string Transaction reference date and time/ if time available/ in date format YYYY-MM-DD or YYYY-MM-DDTHH:MM:SS.nnnZ if time available. - - -
        epochTransactionReferenceDate integer Transaction reference date and time in EPOCH date time format. - - -
    freeTextNote array Free form text required for text message at line item. - MSG (Optional Segment) FTX (Mandatory Segment)
      textReferenceCode string Text reference or subject code. - MSG02 FTX010-010
      textFunctionCode string Text function code. - - FTX020
      language string Language of free text. - - FTX050
      textFormatCode string Format code for free text. - - FTX060
      freeText string Free test string. - MSG01 (Mandatory) FTX040-010
    customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
      name string Name of mapped field. - - -
      value string Value in named field. - - -
  canonicalTextMessageSummary array Summary totals for text message - - -
    summaryType string

Summary type for text message. Number of line items.

The valid value is NUMBEROFITEMS.

 - - -
    summaryValue string Summary value - - -
    summaryValueUnit string Summary value unit of measure - - -
  customFields array Name value pairs for mapping pass through elements that will not be processed in TL system but may be passed outbound. Line item level. - - -
    name string Name of mapped field. - - -
    value string Value in named field. - - -

Tag end