Aggregator (BizTalk Server Sample)

The purpose of this sample is to build a message aggregation functionality using orchestration and pipelines. Specifically we will build an orchestration that:

  1. Receives a set of correlated messages. Messages are correlated based on the destination partner URI information that is extracted from message content.

  2. Aggregates received messages into a single interchange batch by executing an XML send pipeline.

  3. Produces an XML interchange message every minute or as soon as it has enough messages to aggregate.

Where to Find This Sample

<Samples Path>\Pipelines\Aggregator

The following table lists the files for this sample.

File(s) Description
Aggregator.sln Visual Studio solution file for the sample.
AggretatorBinding.xml Binding file for the sample.
Cleanup.bat Used to undeploy assemblies and remove them from the global assembly cache (GAC). Removes send and receive ports. Removes Microsoft Internet Information Services (IIS) virtual directories as needed.
Setup.bat Used to build and initialize this sample.
In Aggregate folder:

BizTalk project for aggregating orchestration.
In Aggregator folder:

Orchestration that collects correlated messages together and then executes send pipeline to assemble them into a single interchange.
In Aggregate folder:

Orchestration used for suspending messages that cannot be processed within aggregating orchestration.
In PipelinesAndSchemas folder:

Receive pipeline with flat file disassembler.
In PipelinesAndSchemas folder:

Instance1.txt, Instance2.txt, Instance3.txt, Instance4.txt
Document instances for the sample. Instance1.txt and Instance2.txt should be added to an interchange for destination partner while Instance3.txt and Instance4.txt should be added to an interchange for destination partner
In PipelinesAndSchemas folder:

Invoice.xsd, InvoiceEnvelope.xsd
Document schema and envelope schema for output interchange.
In PipelinesAndSchemas folder:

BizTalk project for the schemas and pipelines.
In PipelinesAndSchemas folder:

Property schema for the sample.
In PipelinesAndSchemas folder:

Send pipeline that is executed from orchestration to assemble collected messages into an XML interchange.

Building and Initializing the Sample

Use the following procedure to build and initialize the Aggregator sample.

To build and initialize the Aggregator sample

  1. In a command window, navigate to the following folder:

    <Samples Path>\Pipelines\Aggregator

  2. Run the file Setup.bat, which performs the following actions:

    • Creates the input (In) and output (Out) folders for this sample in the folder:

      <Samples Path>\Pipelines\Aggregator

    • Compiles the Visual Studio projects for this sample.

    • Creates a new application called "Aggregator Sample" and deploys the sample assemblies into it.

    • Creates and binds the BizTalk Server receive location, and the send and receive ports.

    • Enlists and starts orchestration, enables the receive location, and starts the send port.

      If you choose to open and build the projects in this sample without running the file Setup.bat, you must first create a strong name key pair using the .NET Framework Strong Name utility (sn.exe). Use this key pair is used to sign the resulting assemblies.

  3. Before attempting to run this sample, confirm that BizTalk Server did not report any errors during the build and initialization process.

    To undo changes made by Setup.bat, run Cleanup.bat. You must run Cleanup.bat before running Setup.bat a second time.

Running the Sample

Use the following procedure to run the Aggregator sample.

To run the Aggregator sample

  1. Open Instance1.txt and Instance2.txt files located in PipelinesAndSchemas folder to inspect their content.

    Notice that in both files the DestinationPartnerURI element contains the value This value will be used to correlate these two messages together so that they can be added to one interchange.

    Similarly Instance3.txt and Instance4.txt files have DestinationPatnerURI element set to

    These two messages together will be added to a different interchange.

  2. Paste copies of the text files Instance1.txt, Instance2.txt, Instance3.txt, and Instance4.txt into the folder In.

  3. Aggregating orchestrations produce output interchanges as soon as they collect 10 messages or after timeout of 1 minute. Because of that, the files in the Out folder may appear with delay.

    To avoid the timeout, you can paste the four input files four more times, which would trigger the aggregating orchestrations to produce the interchanges.

  4. Observe the XML files created in the folder Out. There should be two files – one per each destination partner URI.

    Open one of the file to inspect its content. The file should contain an XML interchange that consists of an envelope and two XML documents within it.


    The sample implementation may cause "Delivered, not consumed messages" or "Completed with discarded messages" under high load in a convoy scenario. This occurs any time a message routes to a business process that is in the process of ending, or any time unexpected messages arrive into a business process.

See Also

Pipelines (BizTalk Server Samples Folder)