Business Protocol Properties

Business protocol property lists for the pair of host and partner participants.

The following are business protocols:

Each business protocol consists the properties of:

  • Host participant properties, the properties to be applied on the host participant.
  • Partner participant properties, the properties to be applied on the partner participant.

ebMS3

ebMS3 business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
N/A N/A N/A
Partner Participant Properties
Property Name Property Type Property Display Name
specificationID string AgreementRef
agreementRefType string Type

ebXML

ebXML business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
expireQueue integer Queued Conversation Expiration Period (days)
Partner Participant Properties
Property Name Property Type Property Display Name
dsigKeyInfoType enumeration Digital Signature KeyInfo Type
specificationID string Specification ID

EZComm

EZComm business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
N/A N/A N/A
Partner Participant Properties
Property Name Property Type Property Display Name
AllowOverrideFilename boolean Allow override of filename via HTTP parameter
dupDetectOutbound boolean Duplicate Detection for Outbound
dupDetectInbound boolean Duplicate Detection for Inbound

RosettaNet

RosettaNet business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
AllowAllRoles boolean Assume all Roles
OutboundDocValidationStyle enumeration Outbound Document Validation
EnableStrictDocumentValidation boolean Inbound Document Validation (XSD)
EnableAuditToFile boolean Enable Audit Logging to File
AuditLogDir string Directory for Audit Log Files
DisableResponseAlways boolean Forward Response Document Only When Response Acknowledgement Succeeds
EnableFetchResponse boolean Enable Automatic Response for Duplicate Request
Partner Participant Properties
Property Name Property Type Property Display Name
AllowAllRoles boolean Assume all Roles
ClientAuthentication boolean Support Client Authentication Where Required
DigitalSignature boolean Use Digital Signature Where Required
XXXReplacement boolean Outbound Document Inline Replacement
SupportNOF boolean Enable Exchange of PIP0A1 (NOF)
DebugHeader boolean Enable Debug Header with RNIF2.0
MIMECTE enumeration MIME Content Transfer Encoding
OverrideHostDocumentValidation boolean Override Host Inbound Document Validation
DocValidationStyle enumeration Host Inbound Document Validation
OverrideHostOutBoundDocumentValidation boolean Override Host Outbound Document Validation
OutboundDocValidationStyle enumeration Outbound Document Validation
DisableResponseAlways boolean Forward Response Document Only When Response Acknowledgement Succeeds

SOAP

SOAP business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
AllowAnonymousSOAPMessages boolean Allow Anonymous SOAP Messages
Partner Participant Properties
Property Name Property Type Property Display Name
dupDetectOutbound boolean Duplicate Detection for Outbound
AddBCSpecificSOAPHeader boolean Add BusinessConnect Specific Header
AllowAnonymousSOAPMessagesFromThisTradingPartner boolean Allow Anonymous SOAP Messages From This Trading Partner
SOAPEnvPrefix string SOAP namespace prefix
SOAPVersion enumeration SOAP Version
SOAPMTOMEnabled boolean SOAP MTOM Enabled

EDIFACT

EDIFACT business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
_hostInterchangeHostInternalID string UNB-S002/0008 Internal ID/Routing Address
_hostInterchangeHostInternalSubID string UNB-S002/0042 Internal Sub ID (Syntax 4)
Preprocessing._hostCharsToStrip string Characters To Strip (e.g. /r/n;/t;/0D)
Preprocessing._hostStripBetweenInterchanges boolean Strip Chars Between Segments Boundaries
Logging._hostLogInboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogInboundRequestLocation string Store Location
Logging._hostLogInboundRequestIncludeDateFolder boolean Include Date Folder
Logging._hostLogOutboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogOutboundRequestLocation string Store Location
Logging._hostLogOutboundRequestIncludeDateFolder boolean Include Date Folder
Advanced._hostPPSkipContentEnabled boolean Publish XML (or TEXT) Request as File Reference
Advanced._hostPPSkipContentThreshold integer Threshold (bytes)
Advanced._hostPPSkipContentIncludeDateFolder boolean Include Date Folder
Advanced._hostPPSkipContentSaveLocation string Store Location
Advanced._hostXSLTPostProcessXML boolean Output XML Request in UTF-8 and Remove Empty Elements
Advanced._hostXMLStreamCompressed boolean Use In-memory Compression During EDI to XML (or EDI to TEXT) Conversion
Advanced._hostXMLStreamThreshold integer Threshold to Use File-based Storage During EDI to XML (or EDI to TEXT) Conversion (bytes)
Advanced._hostInstreamFileBasedThreshold integer Threshold to Use File-based Storage Prior to EDI Processing (bytes)
Advanced._hostAuditReportSaveLocation string Audit Report Location
Advanced._hostAuditReportIncludeDateFolder boolean Include Date folder
Partner Participant Properties
Property Name Property Type Property Display Name
_tpEnableInboundValidation boolean Enable EDI Validation
_tpDisableXMLCreation boolean Disable EDI to XML (or EDI to TEXT) Conversion
_tpEnableDuplicateDetection boolean Enable Transaction Duplicate Detection
_tpRouteInfo string Extra Info in Private Process Request
_tpInboundAllowableIdentifierList string Allowable Receiver Identifier List (e.g. ZZ:50291;ZZ:50292)
_tpAllowSecuredMessage enumeration Partner Level Security Option (MIME Encode Messages Only)
_tpEnableInboundInterchangeComplete boolean Enable Interchange Complete Message
_tpEnableInboundAuditReportLogging boolean Enable Audit Report Logging
_tpEnableInboundInsightReporting boolean Publish Information to Insight Reporting
_tpValidateOutbound boolean Enable EDI Validation
_tpEnableOBDuplicateDetection enumeration Transaction Level Duplicate Detection
_tpEnableOutboundInsightReporting boolean Publish Information to Insight Reporting
_tpEnableOBEDIEncoding enumeration Outbound XML to EDI data encoding
_tpElementTagReplacer list Replace Element Value (e.g. E-7088=.:,|E-6032=.:,)
Logging._tpLogInterchangeToFile boolean Log Raw EDI Segments to File
Logging._tpLogInterchangeLocation string Store Location
Logging._tpLogTransactionToFile boolean Log Raw EDI Segments to File
Logging._tpLogEnvelopeToFile boolean Include Envelope Segments
Logging._tpLogTransactionLocation string Store Location
Batching._tpAllowMultiIntc boolean Allow Single Transmission for Multiple Exclusively-batched Interchanges
Batching._tpIntcCtrlNumByOpid boolean Increment Interchange Control Reference by Operation ID for Exclusive Batch
Batching._regenerateCtrlNum boolean Regenerate Control Number For Batch Resend
Batching._enableInsightReporting boolean Publish Information to Insight Reporting for Batch
Batching._tpTransportTpName string Gateway (override scheduler and transport settings)
Interchange Header._tpAlwaysIncludeUNA boolean Always Generate UNA Segment
Interchange Header._tpSyntaxIdentifier string UNB-S001/0001 Identifier
Interchange Header._tpServiceCodeList string UNB-S001/0080 Service Code List (Syntax 4)
Interchange Header._tpCharacterEncoding string UNB-S001/0133 Character Encoding (Syntax 4)
Interchange Header._tpTpInternalID string UNB-S003/0014 Internal ID/Routing Address
Interchange Header._tpTpInternalSubID string UNB-S003/0046 Internal Sub ID (Syntax 4)
Interchange Header._tpDate string UNB-S004/0017 Date Format
Interchange Header._tpTime string UNB-S004/0019 Time Format
Interchange Header._tpRecipientRefPassword string UNB-S005/0022 Reference/Password
Interchange Header._tpRecipientRefPasswordQual string UNB-S005/0025 Qualifier
Interchange Header._tpAppRef string UNB-0026 Application Reference
Interchange Header._tpProcessingPriority string UNB-0029 Processing Priority Code
Interchange Header._tpAckRequested string UNB-0031 Ack Requested
Interchange Header._tpAgreementIdentifier string UNB-0032 Agreement Identifier
Interchange Header._tpTestIndicator string UNB-0035 Test Indicator
Group Header._tpGroupCreationTxn enumeration Transaction
Group Header._tpGroupCreationAck enumeration Acknowledgement
Group Header._tpHostAppQual string UNG-S006/0007 Sender Qualifier
Group Header._tpHostAppCode string UNG-S006/0040 Sender ID
Group Header._tpTpAppQual string UNG-S007/0007 Recipient Qualifier
Group Header._tpTpAppCode string UNG-S007/0044 Receiver ID
Group Header._tpDate string UNG-S004/0017 Date Format
Group Header._tpTime string UNG-S004/0019 Time Format
Group Header._tpAssociationCode string UNG-S008/0057 Association Assigned Code
Group Header._tpAppPassword string UNG-0058 Application Password
Acknowledgement._tpCreateOption enumeration Ack Creation Option
Acknowledgement._tpOnErrorOnly boolean Ack on Errors Only
Acknowledgement._tpVersionNum string UNH-S009/0052 Version Number
Acknowledgement._tpReleaseNum string UNH-S009/0054 Release Number
Acknowledgement._tpAgencyCode string UNH-S009/0051 Controlling Agency Code
Acknowledgement._tpAssocCode string UNH-S009/0057 Association Assigned Code
Acknowledgement._tpRecordOption enumeration Ack Expected Option
Control Numbers._tpGrpIncrementReceive enumeration Group Control Number Increment Across Interchanges
Control Numbers._tpIntcSeqCheckFlag enumeration Interchange Control Number Sequence Check
Control Numbers._tpGrpSeqCheckFlag enumeration Group Control Number Sequence Check
Control Numbers._tpTxnSeqCheckFlag enumeration Transaction Control Number Sequence Check
Control Numbers._tpResetInbound boolean Reset on Save
Control Numbers._tpGrpIncrementSend enumeration Increment Group Control Number Across Interchanges
Control Numbers._tpTxnIncrementSend enumeration Increment Transaction Control Number Sequentially Across Interchanges
Control Numbers._tpIntcSeed integer Interchange Control Number Seed
Control Numbers._tpIntcEnd integer Interchange Control Number End
Control Numbers._tpGrpSeed integer Group Control Number Seed
Control Numbers._tpTxnSeed integer Transaction Control Number Seed
Control Numbers._tpResetOutbound boolean Reset on Save
Delimiters._tpSubelementDelimiter string UNA-010 Component Data Element Separator
Delimiters._tpElementDelimiter string UNA-020 Data Element Separator
Delimiters._tpDecimalSeparator string UNA-030 Decimal Separator
Delimiters._tpReleaseCharacter string UNA-040 Release Character
Delimiters._tpRepeatingSeparator string UNA-050 Repetition Separator (Syntax 4)
Delimiters._tpSegmentDelimiter string UNA-060 Segment Terminator
Delimiters._tpExtraSegDelimiter string Extra Segment Terminators (e.g. 0x0d,0x0a)

Gateway

Gateway business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
Logging._hostLogInboundRequestToFile boolean Log Raw Request to File
Logging._hostPPSkipContentThreshold integer Threshold (bytes)
Logging._hostLogInboundRequestLocation string Store Location
Logging._hostLogInboundRequestIncludeDateFolder boolean Include Date Folder
Logging._hostLogOutboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogOutboundRequestLocation string Store Location
Logging._hostLogOutboundRequestIncludeDateFolder boolean Include Date Folder
Partner Participant Properties
Property Name Property Type Property Display Name
_tpAllowSecuredMessage enumeration Partner Level Security Option (MIME Encode Messages Only)
Batching._tpAllowMultiIntc boolean Allow Single Transmission for Multiple Exclusively-batched Interchanges
Batching._tpIntcCtrlNumByOpid boolean Increment Interchange Control Number by Operation ID for Exclusive Batch
Batching._regenerateCtrlNum boolean Regenerate Control Number For Batch Resend
Batching._enableInsightReporting boolean Publish Information to Insight Reporting for Batch
Batching._tpSchedulerBatchByTp boolean Always Create Batch per Trading Partner
Batching._tpEnableOBEDIEncoding enumeration Outbound XML to EDI data encoding for Batch

TEXT

Text business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
Logging._hostLogInboundRequestToFile boolean Log Raw TEXT Request to File
Logging._hostLogInboundRequestLocation string Store Location
Logging._hostLogInboundRequestIncludeDateFolder boolean Include Date Folder
Logging._hostLogOutboundRequestToFile boolean Log Raw TEXT Request to File
Logging._hostLogOutboundRequestLocation string Store Location
Logging._hostLogOutboundRequestIncludeDateFolder boolean Include Date Folder
Advanced._hostPPSkipContentEnabled boolean Publish XML Request as File Reference
Advanced._hostPPSkipContentThreshold integer Threshold (bytes)
Advanced._hostPPSkipContentIncludeDateFolder boolean Include Date folder
Advanced._hostPPSkipContentSaveLocation string Store Location
Advanced._hostXSLTPostProcessXML boolean Output XML Request in UTF-8 and Remove Empty Elements
Partner Participant Properties
Property Name Property Type Property Display Name
_tpEnableDuplicateDetection boolean Enable Transaction Duplicate Detection
_tpRouteInfo string Extra Info in Private Process Request
_tpEnableOBDuplicateDetection enumeration Transaction Level Duplicate Detection
_tpValidateOutbound boolean Enable EDI Validation
_tpEnableOBEDIEncoding enumeration Outbound XML to EDI data encoding
Logging._tpLogInterchangeToFile boolean Log Raw TEXT Segments to File
Logging._tpLogInterchangeLocation string Store Location
Delimiters._tpTEXTWrapData boolean Wrap Data
Delimiters._tpSegmentDelimiter string Segment Delimiter
Delimiters._tpElementDelimiter string Element Delimiter
Delimiters._tpRecordDelimiter string Record Delimiter
Delimiters._tpInboundSegmentDelimiter string Segment Delimiter
Delimiters._tpInboundElementDelimiter string Element Delimiter
Delimiters._tpInboundRecordDelimiter string Record Delimiter

TRADACOMS

TRADACOMS business protocol properties are listed as the following:

Host Participant Properties
Property Name Property Type Property Display Name
Preprocessing._hostCharsToStrip string Characters To Strip (e.g. /r/n;/t;/0D)
Preprocessing._hostStripBetweenInterchanges boolean Strip Chars Between Segments Boundaries
Logging._hostLogInboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogInboundRequestLocation string Store Location
Logging._hostLogInboundRequestIncludeDateFolder boolean Include Date Folder
Logging._hostLogOutboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogOutboundRequestLocation string Store Location
Logging._hostLogOutboundRequestIncludeDateFolder boolean Include Date Folder
Advanced._hostPPSkipContentEnabled boolean Publish XML Request as File Reference
Advanced._hostPPSkipContentThreshold integer Threshold (bytes)
Advanced._hostPPSkipContentIncludeDateFolder boolean Include Date folder
Advanced._hostPPSkipContentSaveLocation string Store Location
Advanced._hostXSLTPostProcessXML boolean Output XML Request in UTF-8 and Remove Empty Elements
Advanced._hostAuditReportSaveLocation string Audit Report Location
Advanced._hostAuditReportIncludeDateFolder boolean Include Date folder
Partner Participant Properties
Property Name Property Type Property Display Name
_tpEnableInboundValidation boolean Enable EDI Validation
_tpDisableXMLCreation boolean Disable EDI to XML Conversion
_tpEnableDuplicateDetection boolean Enable Transaction Duplicate Detection
_tpRouteInfo string Extra Info in Private Process Request
_tpEnableInboundInterchangeComplete boolean Enable Interchange Complete Message
_tpEnableInboundAuditReportLogging boolean Enable Audit Report Logging
_tpValidateOutbound boolean Enable EDI validation
_tpEnableOBDuplicateDetection enumeration Transaction Level Duplicate Detection
_tpEnableOBEDIEncoding enumeration Outbound XML to EDI data encoding
Logging._tpLogInterchangeToFile boolean Log Raw EDI Segments to File
Logging._tpLogInterchangeLocation string Store Location
Control Numbers._tpTxnSeed integer Transmission Control Number Seed
Control Numbers._tpResetOutbound boolean Reset on Save

X12

TRADACOMS business protocol properties are listed as the following:

Partner Participant Properties
Property Name Property Type Property Display Name
_hostCAQHUserName string CAQH UserName to authenticate at Partner
_hostCAQHPassword password CAQH Password to authenticate at Partner
Preprocessing._hostCharsToStrip string Characters To Strip (e.g. /r/n;/t;/0D)
Preprocessing._hostStripBetweenInterchanges boolean Strip Chars Between Segment Boundaries
Logging._hostLogInboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogInboundRequestLocation string Store Location
Logging._hostLogInboundRequestIncludeDateFolder boolean Include Date Folder
Logging._hostLogOutboundRequestToFile boolean Log Raw EDI Request to File
Logging._hostLogOutboundRequestLocation string Store Location
Logging._hostLogOutboundRequestIncludeDateFolder boolean Include Date Folder
Advanced._hostPPSkipContentEnabled boolean Publish XML (or TEXT) Request as File Reference
Advanced._hostPPSkipContentThreshold integer Threshold (bytes)
Advanced._hostPPSkipContentIncludeDateFolder boolean Include Date Folder
Partner Participant Properties
Property Name Property Type Property Display Name
_tpEnableInboundValidation boolean Enable EDI Validation
_tpDisableXMLCreation boolean Disable EDI to XML (or EDI to TEXT) Conversion
_tpEnableDuplicateDetection boolean Enable Transaction Duplicate Detection
_tpRouteInfo string Extra Info in Private Process Request
_tpInboundAllowableIdentifierList string Allowable Receiver Identifier List (e.g. ZZ:50291;ZZ:50292)
_tpAllowSecuredMessage enumeration Partner Level Security Option (MIME Encode Messages Only)
_tpEnableInboundInterchangeComplete boolean Enable Interchange Complete Message
_tpEnableInboundAuditReportLogging boolean Enable Audit Report Logging
_tpEnableInboundInsightReporting boolean Publish Information to Insight Reporting
_tpValidateOutbound boolean Enable EDI Validation
_tpEnableOBDuplicateDetection enumeration Transaction Level Duplicate Detection
_tpEnableOutboundInsightReporting boolean Publish Information to Insight Reporting
_tpEnableOBEDIEncoding enumeration Outbound XML to EDI data encoding
_tpElementTagReplacer list Replace Element Value (e.g. E-7088=.:,|E-6032=.:,)
Logging._tpLogInterchangeToFile boolean Log Raw EDI Segments to File
Logging._tpLogInterchangeLocation string Store Location
Logging._tpLogTransactionToFile boolean Log Raw EDI Segments to File
Logging._tpLogEnvelopeToFile boolean Include Envelope Segments
Logging._tpLogTransactionLocation string Store Location
Batching._tpAllowMultiIntc boolean Allow Single Transmission for Multiple Exclusively-batched Interchanges
Batching._tpIntcCtrlNumByOpid boolean Increment Interchange Control Number by Operation ID for Exclusive Batch
Batching._regenerateCtrlNum boolean Regenerate Control Number For Batch Resend
Batching._enableInsightReporting boolean Publish Information to Insight Reporting for Batch
Batching._tpTransportTpName string Gateway (override scheduler and transport settings)
Interchange Header._tpAuthQual string ISA01 Qualifier
Interchange Header._tpAuthInfo string ISA02 Information
Interchange Header._tpSecurityQual string ISA03 Qualifier
Interchange Header._tpSecurityInfo string ISA04 Information
Interchange Header._tpDate string ISA09 Date Format
Interchange Header._tpTime string ISA10 Time Format
Interchange Header._tpControlStandard string ISA11 Control Standard (4012 and Lower)
Interchange Header._tpRepeatingSeparator string ISA11 Repeating Separator (4020 and Higher)
Interchange Header._tpAckRequested string ISA14 Ack Requested
Interchange Header._tpUsageIndicator string ISA15 Usage Indicator
Interchange Header._tpSubelementDelimiter string ISA16 Component Element Separator
Group Header._tpHostAppCode string GS02 Sender
Group Header._tpTpAppCode string GS03 Receiver
Group Header._tpDate string GS04 Date Format
Group Header._tpTime string GS05 Time Format
Acknowledgement._tpCreateOption enumeration Ack Creation Option
Acknowledgement._tpCreate999AckOption boolean 999 Ack Creation Option *
Acknowledgement._tpAckCreationForRequested boolean Ack Creation based on ISA14 Ack Requested
Acknowledgement._tpAckVersionType enumeration Ack Version Option
Acknowledgement._tpAckVersion string Ack Version
Acknowledgement._tpRecordOption enumeration Ack Expected Option
Acknowledgement._tpRecord999AckOption boolean 999 Ack Expected Option *
Control Numbers._tpGrpIncrementReceive enumeration Group Control Number Increment across Interchanges
Control Numbers._tpIntcSeqCheckFlag enumeration Interchange Control Number Sequence Check
Control Numbers._tpGrpSeqCheckFlag enumeration Group Control Number Sequence Check
Control Numbers._tpTxnSeqCheckFlag enumeration Transaction Control Number Sequence Check
Control Numbers._tpResetInbound boolean Reset on Save
Control Numbers._tpGrpIncrementSend enumeration Increment Group Control Number across Interchanges
Control Numbers._tpTxnIncrementSend enumeration Increment Transaction Control Number Sequentially Across Interchanges
Control Numbers._tpIntcSeed integer Interchange Control Number Seed
Control Numbers._tpIntcEnd integer Interchange Control Number End
Control Numbers._tpGrpSeed integer Group Control Number Seed
Control Numbers._tpTxnSeed integer Transaction Control Number Seed
Control Numbers._tpResetOutbound boolean Reset on Save
Delimiters._tpSegmentDelimiter string Segment Terminator
Delimiters._tpElementDelimiter string Data Element Separator
Delimiters._tpExtraSegDelimiter string Extra Segment Terminators (e.g. 0x0d,0x0a)