Adapter Configuration

This section provides step-by-step instructions for creating, configuring and testing a BizTalk Messaging port using an /n software BizTalk Adapter. It is assumed that you are familiar with Microsoft BizTalk Server and the concepts of the transfer protocol used by the /n software BizTalk Adapters.

Adapter Installation

After you run the setup application, all of the necessary files and registry keys will be installed on your system. The setup application will also attempt to register the new adapters within BizTalk, and will also attempt to refresh the registries of any previous installation. However, if an error occurs during this process, it will be necessary to manually complete this step for each adapter that you wish to use.

1. Click the Start menu, select Programs, Microsoft BizTalk Server, and then BizTalk Server Administration.
2. In the BizTalk Administration Console, expand the appropriate BizTalk Group node and expand Platform Settings node.
3. Select the Adapters node to bring up the list of installed adapters.
4. If the adapter you installed was not successfully added to the list by the setup application, right click the Adapters node, click New, and then click Adapter.
5. In the Add Adapter dialog box, select the adapter you wish to add from the drop-down menu.
6. Enter a name for the adapter's transport type in the top text field. This name is arbitrary and does not affect the behavior of the adapter itself. It will be the name that shows up in the "Transport Type" drop down box when configuring a new port.
7. Enter any comment you wish to describe the adapter's transport type.
8. Click OK.

The adapter will now appear in the list of adapters in the BizTalk Administration console.

Configuring a Send Port

1. Click the Start menu, select Programs, Microsoft BizTalk Server, and then BizTalk Server Administration.
2. In the BizTalk Administration Console, expand the appropriate BizTalk Group node and expand the Applications node.
3. Expand the node for the appropriate application.
4. Right-click Send Ports and select New.
5. Select Static One-way Send Port.
6. Enter a name for the port at the top of the configuration window, and expand the drop-down Transport Type menu. Select the name you gave to the adapter when you installed it.
7. Press the Configure button. This will bring up the property page for the adapter.
8. Fill out the relevant fields on the property page. Please refer to the section on the adapter in this help file for a description of the various properties and their function.
9. Click "OK". The URI should now contain a value.
10. Select a pipeline to use in processing the data, and click "OK". Your port is now configured.

Configuring a Receive Location

Configuring a receive port is very similar to configuring a send port, however a receive can receive data from multiple receive locations. You will first need to add a receive port, and then add and configure a receive location for it.

1. Click the Start menu, select Programs, Microsoft BizTalk Server, and then BizTalk Server Administration.
2. In the BizTalk Administration Console, expand the appropriate BizTalk Group node and expand the Applications node.
3. Expand the node for the appropriate application.
4. Right-click Receive Ports and select New.
5. Select Static One-way Receive Port.
6. Enter a name for the port at the top of the port configuration window. Click "OK" to close the window.
7. Right-click Receive Locations and click "New".
8. Select Static One-way Receive Location.
9. Select the appropriate Receive Port of which the new Receive Location will be a member.
10. Enter a name for the location at the top of the receive location properties window, and expand the drop-down Transport Type menu. Select the name you gave to the adapter when you installed it.
11. Press the Configure button. This will bring up the property page for the adapter.
12. Fill out the relevant fields on the property page. Please refer to the section on the adapter in this help file for a description of the various properties and their function.
13. Click "OK". A value will be generated and used to fill out the URI field.
14. Select a handler to host the adapter. Note: the AS2 receive adapter is hosted out of process, so the handler you choose must be an isolated host, and must be a member of the BizTalk Isolated Host Users group.
15. Select a pipeline to use in processing the data, and click "OK". Your port is now configured.
16. SPECIAL CONFIGURATION FOR THE AS2 ADAPTER: since this adapter must receive requests over HTTP, an HTTP receive application (normally just an ASPX page or module) must be setup under IIS, or any other viable ASP.NET web server, to forward AS2 requests to BizTalk. A sample is included in the aspx subfolder of the installation directory. This sample can be used as is, or be modified to suit your site requirements.

The adapters are now ready for binding to a BizTalk orchestration. You may refer to the sample orchestrations for demonstrations of how to use the ports you have just created.

Pipeline Installation

After you run the setup application, all of the necessary files will be installed on your system. The setup application will also attempt to register the new pipeline components within BizTalk. However, if an error occurs during this process, it will be necessary to manually complete this step for each pipeline component that you wish to use.

1. Click the Start menu, select Programs, Microsoft Visual Studio (which ever version you have installed, 2003 or later), then select the Microsoft Visual Studio icon.
2. In Visual Studio, click File, select New, and finally Project.
3. Click BizTalk Projects in the Project types pane. Select Empty BizTalk Server Project in the Templates pane. Click OK once you have named the project.
4. In the Solution Explorer pane, right click on the project, and select Add and then click New Item.
5. Select Pipeline Files in the Categories pane, and select either the Send or Receive Pipeline. Once you have named this pipeline, click Add. Repeat the last two steps for any other desired pipelines.
6. Scroll over the Toolbox, and when it appears, right click inside of it and click on Choose Items.
7. Select the BizTalk Pipeline Components tab. Check the desired Assembler/Disassembler to add to the toolbox. Click OK.
8. Drag the desired Assembler/Disassembler into the Pipeline and drop in the appropriate Assemble/Disassemble box.
9. Set any properties in the Properties pane.
10. When all pipeline components in the project are configured correctly, right click on the project from the Solution Explorer and click Build.
11. Right click on the project from the Solution Explorer and click Deploy.
12. The host instance of BizTalk Server must be restarted for the Pipelines to properly be installed.

The pipeline will now appear in the list of pipelines in the BizTalk Administration console.

Configuring a Send Port

1. Click the Start menu, select Programs, Microsoft BizTalk Server, and then BizTalk Server Administration.
2. In the BizTalk Administration Console, expand the appropriate BizTalk Group node and expand the Applications node.
3. Expand the node for the appropriate application.
4. Right-click Send Ports and select New.
5. Select Static One-way Send Port.
6. Enter a name for the port at the top of the configuration window, and expand the drop-down Transport Type menu. Select the name you gave to the adapter when you installed it.
7. Press the Configure button. This will bring up the property page for the adapter.
8. Properly configure the adapter as needed.
9. Click on the drop-down list of pipelines. Select the name you gave to the pipeline when you created it.
10. Click the ellipsis ("...") on the side of the pipeline selection box.
11. Fill out the relevant fields on the property page. Please refer to the section on the pipeline in this help file for a description of the various properties and their function.
12. Click "OK". Your port is now configured.

Configuring a Receive Location

Configuring a receive port is very similar to configuring a send port, however a receive can receive data from multiple receive locations. You will first need to add a receive port, and then add and configure a receive location for it.

1. Click the Start menu, select Programs, Microsoft BizTalk Server, and then BizTalk Server Administration.
2. In the BizTalk Administration Console, expand the appropriate BizTalk Group node and expand the Applications node.
3. Expand the node for the appropriate application.
4. Right-click Receive Ports and select New.
5. Select Static One-way Receive Port.
6. Enter a name for the port at the top of the port configuration window. Click "OK" to close the window.
7. Right-click Receive Locations and click "New".
8. Select Static One-way Receive Location.
9. Select the appropriate Receive Port of which the new Receive Location will be a member.
10. Enter a name for the location at the top of the receive location properties window, and expand the drop-down Transport Type menu. Select the name you gave to the adapter when you installed it.
11. Press the Configure button. This will bring up the property page for the adapter.
12. Properly configure the adapter as needed.
13. Select a handler to host the adapter. Click on the drop-down list of pipelines. Select the name you gave to the pipeline when you created it.
14. Click the ellipsis ("...") on the side of the pipeline selection box.
15. Fill out the relevant fields on the property page. Please refer to the section on the pipeline in this help file for a description of the various properties and their function.
16. Click "OK". Your port is now configured.