BAM

The BAM sample demonstrates how to use the Deployment Framework for BizTalk with a BAM model, tracking profile, custom pipeline and custom pipeline component.

What this Sample Does

The BAM sample is a simplified version of the BamEndToEnd sample included in the BizTalk Server SDK.  The documentation for the BizTalk Server 2010 version of the sample application (it hasn't changed through many BizTalk releases) may be found here.  This application picks up a file from a file system folder, runs it through a custom pipeline and an orchestration and writes it out to another file system folder.  Along the way, data is fed into a BAM model via the BAM API and a tracking profile.

How this Sample is Designed and Why

This sample demonstrates deployment of a custom pipeline, a custom pipeline component, an assembly containing both schemas and orchestrations, a BAM model and a BAM tracking profile.  It uses the Deployment Framework for BizTalk's environment-specific configuration features to dynamically transform a template bindings XML file into an environment-specific bindings file (see BasicMasterBindings sample).

The Excel settings spreadsheet, SettingsFileGenerator.xml, contains an extra setting used for BAM deployments: BAMViewsAndAccounts.  This setting allows you to specify the users and/or groups that will be granted access to the BAM view(s).  The setting value is translated into an MSBuild property for use during the build by including it in a PropsFromEnvSettings ItemGroup in Deployment.btdfproj.

One extensibility feature demonstrated in the sample's Deployment.btdfproj project file is how to package additional files into the MSI so that they are deployed to the server along with the application binaries and other project files.  The CustomRedist target is called during MSI packaging, and in the sample it copies the files in the TestFiles folder into the MSI staging folder (defined by the $(RedistDir) MSBuild property).

Where to Find this Sample

<BTDFInstallFolder>\Samples\BizTalk2006\BAM or <BTDFInstallFolder>\Samples\BizTalk2009\BAM

NOTE: The BizTalk 2006/2006 R2 version of the sample must be prepared by running PrepareSample.bat in the Samples\BizTalk2006\BAM folder.

NOTE: After upgrading the solution to BizTalk 2010 or newer, you must upgrade the .NET class library projects to target .NET Framework 4.0.

Building and Deploying this Sample

1. Open the solution file BAM.sln in Visual Studio.  If necessary, upgrade the solution and projects to Visual Studio 2010 format.
2. Build the solution and ensure that the build succeeded
3. Deploy the application using the Deployment Framework's Visual Studio Deploy command
4. The Deployment Framework will create an input folder at C:\DeploymentFrameworkForBizTalk\Samples\BAM\In
5. Confirm that the deployment process succeeded and the application is now running in BizTalk (see the Visual Studio Output window and BizTalk Admin Console)
6. If desired, package the application into an MSI using the Build Server MSI command

Running this Sample

1. Copy one or more of the InputMessageXX.xml files from TestFiles into C:\DeploymentFrameworkForBizTalk\Samples\BAM\In
2. Watch for an output XML file to appear in C:\DeploymentFrameworkForBizTalk\Samples\BAM\Out
3. The captured BAM data should be visible in the BAM Portal.  If you don't see the activity, you may need to grant yourself rights to the view.

Removing this Sample

1. With the BAM.sln open in Visual Studio, use the Deployment Framework's Visual Studio Undeploy command
2. Delete the folder C:\DeploymentFrameworkForBizTalk\Samples\BAM

Created with the Personal Edition of HelpNDoc: Free PDF documentation generator