EDIFACTProtocolSettings

  • Article

 

Important

Microsoft Azure BizTalk Services (MABS) is being retired, and replaced with Azure Logic Apps. If you currently use MABS, then Move from BizTalk Services to Logic Appsprovides some guidance on moving your integration solutions to Logic Apps.

If you're brand new to Logic Apps, then we suggest getting started here:

An EDIFACTProtocolSettings entity inherits the ProtocolSettings entity and provides the EDIFACT protocol information.

EDIFACTProtocolSettings Entity Properties

Property

Type

Description

AcknowledgementControlNumberLowerBound

Long

Required. Specifies a numeric value for the lower bounds for the acknowledgement control number. The possible values are between 1 and 999999999.

AcknowledgementControlNumberPrefix

String

Specifies a prefix for the acknowledgement control number. This value can be alpha-numeric and must not be more than 9 characters.

AcknowledgementControlNumberSuffix

String

Specifies a suffix for the acknowledgement control number. This value can be alpha-numeric and must not be more than 9 characters.

AcknowledgementControlNumberUpperBound

Long

Required. Specifies a numeric value for the upper bounds for the acknowledgement control number. The possible values are between 1 and 999999999.

AcknowledgementControlNumberRollover

Bool

Required. Specifies whether the control number is reset to the lower limit once the maximum value is exceeded.

AllowLeadingAndTrailingSpacesAndZeroes

Bool

Required. Specifies whether the EDI interchange fails validation if a data element in the interchange does not conform to its length requirement because of leading (or trailing) zeroes or trailing spaces, but does conform to its length requirement when they are removed.

ApplicationReferenceId

String

Specifies the application reference ID. This should not be more than 14 characters.

ApplyDelimiterStringAdvice

Bool

Required. Specifies whether a UNA segment is generated for the interchange. If this is set to true, UNA6 cannot be empty.

BatchFunctionalAck

Bool

Required. Set this to true to send functional acknowledgements in batches. If set to false, each functional acknowledgement is sent separately.

BatchTechnicalAck

Bool

Required. Set this to true to send technical acknowledgements in batches. If set to false, each technical acknowledgement is sent separately.

CharacterSet

Short

Required. Specifies the character set. The valid values are 0 for UNOB, 1 for UNOA, 2 for UNOC, 3 for UNOD, 4 for UNOE, 5 for UNOF, 6 for UNOG, 7 for UNOH,  8 for UNOI, 9 for UNOJ, 10 for UNOK,  11 for UNOX, 12 for UNOY, 13 for KECA.

CheckDuplicateGroupControlNumber

Bool

Required. Specifies whether interchanges with duplicate group control numbers (UNG5) are processed.

CheckDuplicateInterchangeControlNumber

Bool

Required. Specifies whether interchanges with duplicate interchange control numbers are processed. This checks the interchange control number for the received interchange with the interchange control number of an earlier message. If a match occurs, the bridge processes the interchange based on the value of this property.

CheckDuplicateTransactionSetControlNumber

Bool

Required. Specifies whether interchanges with duplicate transaction sets (UNH1) are processed.

CommunicationAgreementId

String

Specifies the communication agreement between two partners.

ComponentSeparator

Int

Required. Specifies the component separator used by the bridge to identify the different components in the message. This value must not be an empty space, an alphabet, or a numeric character.

CreateEmptyXmlTagsForTrailingSeparators

Bool

Required. Specifies whether empty XML tags are included for trailing separators.

CreateGroupingSegments

Bool

Required. Specifies whether UNG elements are populated in the message.

DataElementSeparator

Int

Required. Specifies a single character that the bridge uses to separate composite data elements consisting of two or more simple data elements.

DecimalPointIndicator

Int

Required. Specifies a single character that is used to denote a decimal point.

DelimiterOverrides

DataServiceCollection<EDIFACTDelimiterOverride>

A navigation property that references the delimiter overrides associated with an EDIFACT message.

EnableDefaultGroupHeaders

Bool

Specifies whether default group headers are included or not.

EnvelopeOverrides

DataServiceCollection<EDIFACTEnvelopeOverride>

A navigation property that references the envelop overrides associated with an EDIFACT message.

FunctionalGroupId

String

Specifies the functional group ID.

GenerateLoopForValidMessagesInAck

Bool

Required. Specifies whether the SG1/SG4 loops are generated in the functional CONTRL acknowledgements for accepted transaction sets.

GroupApplicationPassword

String

Required. Specifies the GroupApplicationPassword property for the EDIFACT message.

GroupApplicationSenderId

String

Specifies the GroupApplicationSenderId property for the EDIFACT message.

GroupApplicationSenderQualifier

String

Specifies the GroupApplicationSenderQualifier property for the EDIFACT message.

GroupApplicationReceiverQualifier

String

Specifies the GroupApplicationReceiverQualifier property for the EDIFACT message.

GroupAssociationAssignedCode

String

Specifies the GroupAssociationAssignedCode property for the EDIFACT message.

GroupControllingAgencyCode

Short

Specifies the GroupControllingAgencyCode property for the EDIFACT message.

GroupControlNumberLowerBound

Long

Specifies a numeric value for the lower bounds for the group control number. The possible values are between 1 and 999999999.

GroupControlNumberPrefix

String

Specifies the prefix for the group control number.

GroupControlNumberRollover

Bool

Specifies whether the group control number is reset to the lower limit once the maximum value is exceeded.

GroupControlNumberSuffix

String

Specifies the suffix for the group control number.

GroupControlNumberUpperBound

Long

Specifies a numeric value for the lower bounds for the group control number. The possible values are between 1 and 999999999. This value must be greater than or equal to the value specified for the GroupControlNumberLowerBound.

GroupMessageVersion

String

Specifies the message version.

GroupMessageRelease

String

Specifies the message release.

InterchangeControlNumberLowerBound

Long

Required. Specifies a numeric value for the lower bounds for the interchange control number. The possible values are between 1 and 999999999.

InterchangeControlNumberPrefix

String

Specifies the prefix for the interchange control number.

InterchangeControlNumberRollover

Bool

Required. Specifies whether the interchange control number is reset to the lower limit once the maximum value is exceeded.

InterchangeControlNumberSuffix

String

Specifies the suffix for the interchange control number.

InterchangeControlNumberUpperBound

Long

Required. Specifies a numeric value for the upper bounds for the interchange control number. The possible values are between 1 and 999999999. This value must be greater than or equal to the value for InterchangeControlNumberLowerBound.

InterchangeDuplicatesValidity

Short

Required. You must set this property if CheckDuplicateInterchangeControlNumber property is set to True. If set, this property can only take values greater than 0.

IsTestInterchange

Bool

Required. Set this to true if you want BizTalk Services to indicate that the interchange generated is test data.

MaskSecurityInfo

Bool

Required. Specifies whether the security info is masked.

MessageFilterType

Short

Specifies the type of message filter. The valid values are Include and Exclude.

NeedFunctionalAck

Bool

Required. Specifies whether a functional acknowledgement must be returned to the interchange sender.

NeedTechnicalAck

Bool

Required. Specifies whether a technical acknowledgement must be returned to the interchange sender.

PreserveInterchange

Bool

Required. Specifies whether the bridge preserves an EDI interchange.

ProcessingPriorityCode

String

Specifies the code determined by the sender for acknowledgement of the interchange.

ProtocolName

String

Required. Specifies the protocol name.

ProtocolVersion

Short

Required. Specifies the EDIFACT protocol version.

ReceiverReverseRoutingAddress

String

Specifies the reverse routing address for the receiver.

RecipientReferencePasswordQualifier

String

Specifies the password qualifier for the recipient.

RecipientReferencePasswordValue

String

Specifies the password value for the recipient password qualifier.

ReleaseIndicator

Int

Required. This character is used to indicate that the text following contains one of the characters used as a composite, data, or segment separator. Therefore, this character is released from its conventional usage in this instance.

RepetitionSeparator

Int

Required. This character is used to separate adjacent occurrences of the same repeating data element in a segment.

RouteAckToSendPipeline

Bool

Required. Specifies whether the acknowledgement must be returned by a separate channel.

SchemasReferences

DataServiceCollection<EDIFACTSchemaReference>

A navigation property that references the schema used for the EDIFACT protocol settings.

SegmentTerminator

Int

Required. Specifies a single character that the bridge uses to indicate the end of a segment. This value must not be a space, an alphabet, or a numeric character.

SegmentTerminatorSuffix

Short

Required. Specifies the character that the bridge uses with the segment terminator. The valid values are:

  • 00 – for None

  • 01 – for CR

  • 02 – for LF

  • 03 – for CRLF

SenderReverseRoutingAddress

String

Specifies the reverse routing address of the sender.

SuspendInterchangeOnError

Bool

Required. Specifies whether the entire message is suspended if one or more transaction sets in the interchange fail validation.

TrailingSeparatorPolicy

Short

Required. Specifies how to process trailing separators.

  • Set this to 0 (for Not Allowed). If set to 0, trailing delimiters and separators are not allowed in an interchange received from the interchange sender. If the interchange contains trailing delimiters and separators, it will be declared invalid.

  • Set this to 1 (for Optional). If set to 1, the bridge accepts interchanges with or without trailing delimiters and separators.

  • Set this to 2 (for Mandatory). If set to 2, the received interchange must contain trailing delimiters and separators.

TSApplyNewId

Bool

Required.

TSControlNumberLowerBound

Int

Required. Specifies a numeric value for the lower bounds for the transaction set control number. The possible values are between 1 and 999999999.

TSControlNumberPrefix

String

Specifies a prefix for the transaction set control number. This value can be alpha-numeric.

TSControlNumberRollover

Bool

Required. Specifies whether the control number is reset to the lower limit once the maximum value is exceeded.

TSControlNumberSuffix

String

Specifies a suffix for the transaction set control number. This value can be alpha-numeric.

TSControlNumberUpperBound

Int

Required. Specifies a numeric value for the upper bounds for the transaction set control number. The possible values are between 1 and 999999999.

UseDotAsDecimalIndicator

Bool

Required. Specifies whether a dot (.) is used as a decimal separator.

ValidateCharacterSet

Bool

Required. Specifies whether the character set must be validated.

ValidateEdiTypes

Bool

Required. Specifies whether EDI (data element) validation is enabled on the interchange receiver.

ValidateXSDTypes

Bool

Required. Specifies whether extended validation (XSD) is enabled on the interchange receiver.

ValidationOverrides

DataServiceCollection<EDIFACTValidationOverride>

A navigation property that references EDIFACT validation overrides associated with the instance of EDIFACT protocol settings.

Version

Byte[]

This value is auto-generated and is for internal use only.

See Also

TPM OM API: Exposed Entities and Properties