X12ProtocolSettings
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:
-
Create your first logic app, or quickly get started using a pre-built template
-
View all the available connectors you can use in your logic apps
An X12ProtocolSettings entity inherits the ProtocolSettings entity and provides the X12 protocol information.
X12ProtocolSettings Entity Properties
Create an X12ProtocolSettings
List X12 Protocol Settings
Update a Protocol Setting
Delete an X12 Protocol Setting
Link X12ProtocolSettings with Other Entities
Delete Link between X12ProtocolSettings and Other Entities
X12ProtocolSettings Entity Properties
Property |
Type |
Description |
---|---|---|
Id |
Int |
Specifies a unique ID for the X12 protocol settings. This value is auto-generated. |
AcknowledgementControlNumberLowerBound |
Int |
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 |
Int |
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. |
AuthorizationQualifier |
String |
Required. Specifies the authorization qualifier and must not be more than 2 characters long. The possible values are:
|
AuthorizationValue |
String |
You must specify this value if you set AuthorizationQualifier to any value other than 00. This field must not be more than 10 characters. |
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, 1, or 2. |
CheckDuplicateGroupControlNumber |
Bool |
Required. Specifies whether interchanges with duplicate group control numbers (GS06) are processed. |
CheckDuplicateInterchangeControlNumber |
Bool |
Required. Specifies whether interchanges with duplicate interchange control numbers (ISA13) 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 (ST02) are processed. |
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. |
ControlStandardsId |
Int |
Required. Specifies the control standards ID. The possible value is U. However, if UseControlStandardsIdAsRepSep is set to true, the value of ControlStandardsId can be set to the repetition character. Also, the repetition character must not be a space, an alphabet, or a numberic character. |
ControlVersionNumber |
String |
Required. Specifies the version of the X12 standard to be used for generating an outgoing interchange. This must not exceed 5 characters, for example, 00401. |
ConvertImpliedDecimal |
Bool |
Required. Specifies whether an EDI number, specified with the format Nn, is converted base-10 numeric value in the intermediate XML file. |
CreateEmptyXmlTagsForTrailingSeparators |
Bool |
Required. Specifies whether empty XML tags are included for trailing separators. |
DataElementSeparator |
Int |
Required. Specifies a single character that the bridge uses to separate composite data elements consisting of two or more simple data elements. |
DelimiterOverrides |
DataServiceCollection<X12DelimiterOverride> |
A navigation property that references the delimiter overrides associated with an X12 message. |
EnableDefaultGroupHeaders |
Bool |
Specifies whether default group headers are included or not. |
EnvelopeOverrides |
DataServiceCollection<X12EnvelopeOverride> |
A navigation property that references the envelop overrides associated with an X12 message. |
FunctionalGroupId |
String |
|
GenerateLoopForValidMessagesInAck |
Bool |
Required. Specifies whether the AK2 loops are generated in the 997 acknowledgements for accepted transaction sets. |
GroupControlNumberLowerBound |
Int |
Specifies a numeric value for the lower bounds for the group control number. The possible values are between 1 and 999999999. |
GroupControlNumberRollover |
Bool |
Specifies whether the group control number is reset to the lower limit once the maximum value is exceeded. |
GroupControlNumberUpperBound |
Int |
Specifies a numeric value for the upper 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 for GroupControlNumberLowerBound. |
GroupDateFormat |
String |
Required. Specifies the group date format. The valid values are CCYYMMDD or YYMMDD. |
GroupHeaderVersion |
String |
Specifies the group header version. The valid value is 00401. Also, the value must not exceed 12 characters. |
GroupResponsibleAgencyCode |
Short |
Required. Specifies the responsible agency code (GS07) for the group. The valid values are:
|
GroupTimeFormat |
Short |
Required. Specifies the group time format. The valid values are HHMM, HHMMSS, HHMMSSdd, HHMMSSd. |
InterchangeControlNumberLowerBound |
Int |
Required. Specifies a numeric value for the lower bounds for the interchange control number. The possible values are between 1 and 999999999. |
InterchangeControlNumberRollover |
Bool |
Required. Specifies whether the interchange control number is reset to the lower limit once the maximum value is exceeded. |
InterchangeControlNumberUpperBound |
Int |
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. |
MaskSecurityInfo |
Bool |
- |
MessageFilterType |
Short |
Specifies the type of message filter. The valid values are Include and Exclude. |
NeedFunctionalAck |
Bool |
Required. Specifies whether a functional acknowledgement (997) must be returned to the interchange sender. |
NeedTechnicalAck |
Bool |
Required. Specifies whether a technical acknowledgement (TA1) must be returned to the interchange sender. |
PreserveInterchange |
Bool |
Required. Specifies whether the bridge preserves an EDI interchange. |
ProtocolName |
String |
Required. Specifies the protocol name. The only valid value for this property is X12. |
ReceiverApplicationId |
String |
Specifies the receiver application ID. This value must not exceed 15 characters. |
ReplaceChar |
Int |
You must set this property if ReplaceSeparatorsInPayload property is set to True. |
ReplaceSeparatorsInPayload |
Bool |
If set to True, all instances of the separator characters in the payload data are replaced with the character specified for the property ReplaceChar. |
RouteAckToSendPipeline |
Bool |
Required. Specifies whether the acknowledgement must be returned by a separate channel. |
SchemaReferences |
DataServiceCollection<X12SchemaReference> |
A navigation property that references the schema used for the X12 protocol settings. |
SecurityQualifier |
String |
Required. Specifies the security qualifier (ISA13). This must not exceed 2 characters and the valid values are:
|
SecurityValue |
String |
Specifies the security value (ISA4). This property must be set if the SecurityQualifier property is not set to 00. This property must not exceed 10 characters. |
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:
|
SenderApplicationId |
String |
Specifies the sender application ID. This value must not be more than 15 characters. |
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.
|
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 and must not be more than 9 characters. |
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 and must not be more than 9 characters. |
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. |
UsageIndicator |
Short |
Required. Specifies whether an interchange generated by the bridge is information, production data, or test data. The possible values are:
|
UseControlStandardsIDAsRepSep |
Bool |
Required. If set to false, the value of ISA11 is used to specify a standard identifier instead of a repetition separator. |
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. |
ValidateExtended |
Bool |
Required. Specifies whether extended validation (XSD) is enabled on the interchange receiver. |
ValidationOverrides |
DataServiceCollection<X12ValidationOverride> |
A navigation property that references X12 validation overrides associated with the instance of X12 protocol settings. |
Version |
Byte[] |
This value is auto-generated and is for internal use only. |
Create an X12ProtocolSettings
You can create an X12 protocol settings entity using a POST HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?><entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<id />
<title />
<updated>2013-02-05T19:38:38Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
...
[Property names with their values]
...
</m:properties>
</content>
</entry>
List X12 Protocol Settings
You can list the X12 protocol settings using a GET HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings This returns all the protocol settings entities |
HTTP/1.1 |
GET |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings This returns information about the protocol setting with the specified ID. |
HTTP/1.1 |
Sample Request
Retrieve all the protocol settings
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Retrieve information about a specific protocol setting
GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Update a Protocol Setting
You can update an X12 protocol setting using a MERGE HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
MERGE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/ Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings |
HTTP/1.1 |
Sample Request
MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagementProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/atom+xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 5446
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?><entry xmlns="https://www.w3.org/2005/Atom" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
<id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)</id>
<category term="Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<title />
<updated>2013-02-05T23:59:14Z</updated>
<author>
<name />
</author>
<content type="application/xml">
<m:properties>
...
[Upddated properties with their values]
...
</m:properties>
</content>
</entry>
Delete an X12 Protocol Setting
You can delete an X12 protocol setting using a DELETE HTTP request.
Method |
Request URI |
HTTP Version |
---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0
Link X12ProtocolSettings with Other Entities
You can link an X12 protocol setting entity with other entities using the POST HTTP method. To create the link, the URI of the entity you are linking to must be included in the request body. In this section, we show how to create a link between X12ProtocolSetting and X12SchemaReference.
Method |
Request URI |
HTTP Version |
---|---|---|
POST |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences ProtocolSettings(id) denotes the ID of the protocol setting that links to the X12 schema reference. |
HTTP/1.1 |
Sample Request
POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences HTTP/1.1
User-Agent: Microsoft ADO.NET Data Services
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
x-ms-version: 1.0
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 218
Expect: 100-continue
<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://integration.zurich.test.dnsdemo1.com:5446/test01/$PartnerManagement/X12SchemaReferences(1)</uri>
Delete Link between X12ProtocolSettings and Other Entities
You can delete a link between an X12ProtocolSettings and other entities using a DELETE HTTP method.
Method |
Request URI |
HTTP Version |
---|---|---|
DELETE |
https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(id)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences(id) |
HTTP/1.1 |
Sample Request
DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/ProtocolSettings(1)/Microsoft.ApplicationServer.Integration.PartnerManagement.X12ProtocolSettings/$links/SchemaReferences(1) HTTP/1.1
Accept-Charset: UTF-8
DataServiceVersion: 1.0;NetFx
MaxDataServiceVersion: 3.0;NetFx
x-ms-version: 1.0
Accept: application/atom+xml,application/xml
Authorization: WRAP access_token="<token>"
Content-Type: application/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Expect: 100-continue