SALES: 1-800-867-1380

BatchDescription

Updated: February 20, 2014

A BatchDescription entity set captures batch configuration for each send-side one-way agreement.

BatchDescription Entity Properties

 

Property Type Description

ID

Int

Specifies a unique ID for the batch. This value is auto-generated.

Name

String

Required. Specifies a unique name for the batch. This must not be more than 256 characters.

Description

String

Specifies a description for the batch. This must not be more than 256 characters.

CriteriaType

String

Required. <Pending meeting>

FilterExpression

String

Required. Specifies a valid SQL92 filter expression. This must not be more than 1024 characters.

FirstRelease

DateTime

Required if the ReleaseCriteriaType is set to Schedule. This specifies the time when the first batch is released.

InterchangeSize

Long

Required if the ReleaseCriteriaType is set to Size. This specifies the total size of the batch to wait for before releasing the batch.

MessageCount

Int

Required if the ReleaseCriteriaType is set to Count. This specifies the count of the message to wait for before releasing the batch.

MessageScope

Short

Required if the ReleaseCriteriaType is set to Count. The possible value is 1, which indicates that each interchange is treated as a separate message.

OnewayAgreement

OnewayAgreement

Required. A navigation property that references the one-way send-side agreement with which the batch setting is associated.

ProtocolName

String

Required. Specifies the protocol for the agreement with which batch setting is associated.

RecurrencePeriodInSeconds

Long

Required if ReleaseCriteriaType is set to Schedule.

RecurrenceType

Short

Required if the ReleaseCriteriaType is set to Schedule. This property specifies whether the frequency of recurrence is based on minutes, hours, etc. The possible values are:

  • None = 0

  • MinutesBased

TimeoutInSeconds

Long

Required if the ReleaseCriteriaType is set to Timeout. This property specifies the timeout (in seconds) at which a batch is triggered, irrespective of whether any other criterion is met or not.

DaysOfWeek

Int

Required if the ReleaseCriteriaType is set to Schedule. This specifies the day of the week when the batch is released. The possible values are Monday=1 to Sunday=7.

StartDateInternal

DateTime

Specifies the start date for the batch.

EndDateInternal

DateTime

Specifies the end date for the batch

TerminationCount

Int

Version

Byte[]

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

Create a Batch Description

You can create a batch description using a POST HTTP request.

 

Method Request URI HTTP Version

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions

HTTP/1.1

noteNote
You cannot create a business profile without linking it to a partner. In the following sample request, a business profile is linked to a partner using the <link> element of the request body.

noteNote
After you create a new batch using the TPM OM API, you must redeploy the agreement using the BizTalk Services Portal.

Sample Request

The following sample request message shows how to create a batch description and simultaneously create a link with a OnewayAgreement entity using the <link> element in the request body.

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions 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: 1753
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?><entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.BatchDescription" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <link rel="http://schemas.microsoft.com/ado/2007/08/dataservices/related/OnewayAgreement" type="application/atom+xml;type=entry" title="OnewayAgreement" href="https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/OnewayAgreements(90)" />
  <id />
  <title />
  <updated>2013-02-08T06:51:24Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:CriteriaType m:type="Edm.Int16">0</d:CriteriaType>
      <d:DaysOfWeek m:type="Edm.Int32" m:null="true" />
      <d:Description m:null="true" />
      <d:EndDateInternal m:type="Edm.DateTime">0001-01-01T00:00:00</d:EndDateInternal>
      <d:FilterExpression>1=1</d:FilterExpression>
      <d:FirstRelease m:type="Edm.DateTime">2013-02-07T22:51:24.6239514-08:00</d:FirstRelease>
      <d:Id m:type="Edm.Int32">0</d:Id>
      <d:InterchangeSize m:type="Edm.Int64" m:null="true" />
      <d:MessageCount m:type="Edm.Int32" m:null="true" />
      <d:MessageScope m:type="Edm.Int16" m:null="true" />
      <d:Name>NewBatch</d:Name>
      <d:ProtocolName>X12</d:ProtocolName>
      <d:RecurrencePeriodInSeconds m:type="Edm.Int64" m:null="true" />
      <d:RecurrenceType m:type="Edm.Int16" m:null="true" />
      <d:StartDateInternal m:type="Edm.DateTime">0001-01-01T00:00:00</d:StartDateInternal>
      <d:TerminationCount m:type="Edm.Int32" m:null="true" />
      <d:TimeoutInSeconds m:type="Edm.Int64" m:null="true" />
      <d:Version m:type="Edm.Binary">AA==</d:Version>
    </m:properties>
  </content>
</entry>

List BatchDescriptions

You can list batch descriptions using a GET HTTP request.

 

Method Request URI HTTP Version

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions

This returns all the batch descriptions

HTTP/1.1

GET

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(id)

This returns information about the batch description with the specified ID.

HTTP/1.1

Sample Request

Retrieve all the batch descriptions

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions 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 batch description

GET https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(1) 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 BatchDescription

You can update a batch description using a MERGE HTTP request.

 

Method Request URI HTTP Version

MERGE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(id)

HTTP/1.1

Sample Request

MERGE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(1) 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
If-Match: W/"X'0000000000000A59'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 1598
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:d="http://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">
  <id>https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(1)</id>
  <category term="Microsoft.ApplicationServer.Integration.PartnerManagement.BatchDescription" scheme="http://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
  <title />
  <updated>2013-02-08T07:29:29Z</updated>
  <author>
    <name />
  </author>
  <content type="application/xml">
    <m:properties>
      <d:CriteriaType m:type="Edm.Int16">0</d:CriteriaType>
      <d:DaysOfWeek m:type="Edm.Int32" m:null="true" />
      <d:Description m:null="true" />
      <d:EndDateInternal m:type="Edm.DateTime">0001-01-01T00:00:00</d:EndDateInternal>
      <d:FilterExpression>1=1</d:FilterExpression>
      <d:FirstRelease m:type="Edm.DateTime">2013-02-07T17:26:48.7885402</d:FirstRelease>
      <d:Id m:type="Edm.Int32">1</d:Id>
      <d:InterchangeSize m:type="Edm.Int64" m:null="true" />
      <d:MessageCount m:type="Edm.Int32" m:null="true" />
      <d:MessageScope m:type="Edm.Int16" m:null="true" />
      <d:Name>UpdatedBatch</d:Name>
      <d:ProtocolName>X12</d:ProtocolName>
      <d:RecurrencePeriodInSeconds m:type="Edm.Int64" m:null="true" />
      <d:RecurrenceType m:type="Edm.Int16" m:null="true" />
      <d:StartDateInternal m:type="Edm.DateTime">0001-01-01T00:00:00</d:StartDateInternal>
      <d:TerminationCount m:type="Edm.Int32" m:null="true" />
      <d:TimeoutInSeconds m:type="Edm.Int64" m:null="true" />
      <d:Version m:type="Edm.Binary">AAAAAAAAClk=</d:Version>
    </m:properties>
  </content>
</entry>

Delete a Batch Description

You can delete a batch description using a DELETE HTTP request.

 

Method Request URI HTTP Version

DELETE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(id)

HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(1) 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
If-Match: W/"X'0000000000000A5F'"
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 0

Link OnewayAgreements with BatchDescriptions

In Create a Batch Description section, we saw how to create a link between a BatchDescription and a OnewayAgreement while creating a BatchDescription. In this section, we see how to create a link in the opposite direction, that is, from a OnewayAgreement to a BatchDescription. To create the link, the URI of the BatchDescription must be included in the request body.

 

Method Request URI HTTP Version

POST

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/OnewayAgreements(id)/$links/BatchDescriptions

OnewayAgreements(id) denotes the ID of the one-way agreement that links to the batch description.

HTTP/1.1

Sample Request

POST https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/OnewayAgreements(1)/$links/BatchDescriptions 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/xml
Host: integration.zurich.test.dnsdemo1.com:5446
Content-Length: 216
Expect: 100-continue

<?xml version="1.0" encoding="utf-8"?>
<uri xmlns="http://schemas.microsoft.com/ado/2007/08/dataservices/metadata">https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/BatchDescriptions(1)</uri>

Delete Link between OnewayAgreements and BatchDescriptions

You can delete a link between OnewayAgreements and BatchDescriptions by using the HTTP DELETE method.

 

Method Request URI HTTP Version

DELETE

https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/OnewayAgreements(id)/$links/BatchDescriptions(id)

HTTP/1.1

Sample Request

DELETE https://mybiztalkservice.biztalk.windows.net/default/$PartnerManagement/OnewayAgreements(1)/$links/BatchDescriptions(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

See Also

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft