Things to Know Before Installing
A few things to know before installing the Message Archiving Pipeline Component:
- The component is supported on Microsoft BizTalk Server 2006, BizTalk Server 2006 R2 and BizTalk Server 2009. The component is not supported on BizTalk Server 2000, BizTalk Server 2002 or BizTalk Server 2004.
- The component is supported on all editions of BizTalk Server 2006, 2006 R2 and 2009 - Developer, Branch, Standard and Enterprise.
- The component is released in 32-bit (x86) and 64-bit (x64) versions; it is recommended that you install the correct version for your architecture, otherwise unexpected problems may occur.
- The user performing the installation must have Administrator previledges on the machine where the component is being installed.
- By default, the installer will not place the component assemblies into the BizTalk Pipeline Components directory - this is a manual task that needs to be performed by your dev team or deployment scripts. This step is covered in the installation instuctions below.
- By default, the component will be installed with a developer licence. If you are installing the component on a production system you will subsequently need to install a commercial licence. This step is covered in the installation instuctions below.
Installing the Component
The BizTalk Message Archiving Pipeline Component is distributed with a standard MSI based installer. To start the installation, simply click on the downloaded .msi file.
You can determine which architecture the installer is targetted for by looking at the MSI filename; the architecture is detailed at the end of the name: BizTalkMessageArchivingComponent-1.0.154.264-x64.msi.
x86 refers to a 32-bit architecture, x64 refers to a 64-bit architecture.
1. When the installer first starts, you will be presented with the installer welcome screen, as shown below. Click Next to start the installation.
2. Review and accept the licencing agreement. Click Next.
3. Review the installation folder. Click 'Next' to accept the default folder location or click 'Change' to specify a different installation folder, followed by 'Next' to accept the new location.
4. The installer now has sufficient information to proceed with the installation. Click 'Install' to install the component; click 'Back' to make any amendments to the installation location.
5. The installer will proceed to install the component to the specified directory and add any additional configuration settings required. When finished, you will be presented with the following screen. Click 'Finish' to exit the Setup Wizard.
You have successfully installed the component.
Deploying the Component
Before the component can be used at runtime or in Visual Studio, it must first be deployed to either the BizTalk Pipeline Components folder or the Windows Global Assembly Cache. This section details these two steps.
Deploying the Component to the BizTalk Pipeline Components Folder
Before the component can be used in Visual Studio, its assembly must be deployed into the BizTalk Pipeline Components directory (normally C:\Program Files\Microsoft BizTalk Server 2006\Pipeline Components\). The Pipeline Component directory is parsed by Visual Studio to determine what custom pipeline components can be use within BizTalk projects.
To deploy the component to the pipeline components directory:
- Navigate to the installation directory in Windows Explorer (C:\Program Files\Atomic-Scope\BizTalk Message Archiving Component\). If the component was installed in a different location, navigate to that location.
- Copy the AtomicScope.BizTalk.Pipelines.MessageArchivingComponent.dll assembly to your BizTalk Pipeline Components directory, usually C:\Program Files\Microsoft BizTalk Server 2006\Pipeline Components\. The component is now ready to be used in Visual Studio.
If you don't want to deploy the component to the Global Assembly Cache, jump straight to the next section - Adding the Component to the Visual Studio Toolbox.
Deploying the Component to the Global Assembly Cache
Although BizTalk can reference the component's assembly from the BizTalk Pipeline Components directory at runtime, it is best practice to deploy the assembly into the Global Assembly Cache (GAC).
The GAC is a machine-wide store of .NET Common Language Runtime assemblies, specifically designated to be shared by several applications on the computer, such as multiple BizTalk Host Instances. All assemblies shipped as part of the BizTalk Message Archiving Pipeline Component are signed by Atomic-Scope and ready for deployment to the GAC.
To deploy the component to the GAC:
1. Open a command line prompt and navigate to the component installation directory:
2. Install the pipeline component to the GAC using the GACUtil.exe tool supplied with the .Net Framework (the /i switch prompts the tool to install the assembly):
To deploy the component to the GAC:
1. Open a command line prompt and use the GACUtil.exe tool to uninstall the assembly (the /u switch prompts the tool to uninstall the assembly):
For more information on the GACUtil tool, see the MSDN pages The Global Assembly Cache Tool.
Adding the Component to the Visual Studio Toolbox
This section details the steps required to use the component in Visual Studio.
1. Open Visual Studio 2005 or 2008 and click on Tools -> Choose Toolbox Items to load the Choose Toolbox Items dialog. Click on the BizTalk Pipeline Components tab as shown in the screenshot below:
2. When the BizTalk Pipeline Components tab loads (it may take several seconds), the Atomic-Scope BizTalk Message Archiving Pipeline Component will be shown (unticked) in the list of available pipeline components, as shown in the screenshot below. Tick the checkbox for the component to make it available for use in BizTalk Projects in Visual Studio.
Click Ok to save the changed to the Toolbox. The component is now ready to be used in custom send and receive pipelines.