Adding the Component to Custom Send and Receive Pipelines
Before the component can be used in a BizTalk application, it must be added to a custom pipeline that will be used on a Receive Location or Send Port. To add the component to a custom receive pipeline:
1. In a BizTalk project, right-click the project and select Add -> New Item, to load the Add New Item dialog as shown below:
2. When the Add New Item dialog window opens, select Pipeline Files from the Categories pane and select Receive Pipeline in the Templates pane. Specify a meaningful name and click Add to add the new receive pipeline to the project:
3. The new receive pipeline will load in the Pipeline Designer. Once loaded, click View -> Toolbox to load the pipeline toolbox menu. In the menu you will see the Message Archiving Component. Left click the Toolbox entry for the component and drag onto the Decode stage of the pipeline surface:
Note: In a Receive Pipeline, the component can be used either in the Decode or ResolveParty stages. The component cannot be used in the Disassemble or Validate stages.
4. To configure the component at design-time in the Pipeline Designer click View -> Properties Window to load the Properties Window:
The Properties Window exposes all of the user-configurable properties of the component, including:
- Archive Directory - The directory in which the archive file should be saved;
- Archive Filename - The filename of the archive file;
- Archiving Enabled - Enables and disables the archiving component at run-time;
- Ensure Archive Integrity - Controls how the archive file is written to the file-system, ensuring that a full and complete archive of the message is created, even if an error is raised by a downstream pipeline component;
- Overwrite Existing File - Controls the behaviour of the component if it encounters another archived message with the same directory/filename;
For more information on the configuration options that are available in the component, see Common Tasks - Configuration Options
With the component added to a new custom pipline, deploy the BizTalk project as you normally would, either manually from Visual Studio or through an MSI or MSBuild package.
Configuring the Component in the BizTalk Administration Console
The component can also be configured after deployment in the BizTalk Administration Console as described below.
Configuring the Component in the BizTalk Administration Console
1. Navigate to a Receive Location or Send Port that has a custom receive pipeline that includes the Message Archiving component in one of its stages and click the Elipsis button to launch the Configure Pipeline dialog:
2. In the Configure Pipeline dialog, configure the component with a valid Archive Directory and Archive Filename; configure the ArchivingEnabled, EnsureArchiveIntegrity and OverwriteExistingFile properties if necessary:
For more information on configuring a pipeline component in the BizTalk Administration Console, see the Microsoft Developer Network documentation at Configure Pipeline Dialog Box.