Edit

Tutorial: Using the BizTalk Adapter for TIBCO Enterprise Message Service to Send Data

  • Article

You can use the BizTalk Adapter for TIBCO Enterprise Message Service (EMS) to send data to a TIBCO system. This walkthrough describes an SDK sample that illustrates this.

Prerequisites

  • BizTalk Adapter for TIBCO EMS requires that you add the TIBCO EMS C# API, TIBCO.EMS.dll, to the global assembly cache (GAC). For more information about installing the assembly, see TIBCO Enterprise Message Service Requirements and Limitations.

  • Install Visual Studio on the BizTalk Server that the adapter is running on in order to build and deploy the sample.

What This Sample Does

This sample picks up an XML file from a file folder, sends the file to an orchestration, and then uses the BizTalk Adapter for TIBCO Enterprise Message Service to create a record in the TIBCO system.

How This Sample is Designed and Why

This sample, designed in Visual Studio, illustrates basic functionality using the BizTalk Adapter for TIBCO Enterprise Message Service with a BizTalk orchestration.

Where to Find This Sample

The default location for the sample is

C:\Program Files\Microsoft BizTalk Adapters for Enterprise Applications\TIBCO(r) Enterprise Message Service(TM)\Sdk\OneWaySend

The following table lists and describes the files in the sample.

Runtime Project Filename Runtime Project File Description
OneWaySend.btproj

OneWaySend.sln		 Project and solution files for the application.
Schema.xsd Schema file for the application.
Orchestration.odx The orchestration used by the application.
TIBCOEMSOneWaySend.snk The strong naming key file.

How to Use This Sample

Create a new instance of the BizTalk Adapter for TIBCO EMS

  1. Launch the BizTalk Server Administration console. Click Start, All Programs, Microsoft BizTalk Server, BizTalk Server Administration.

  2. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Platform Settings, and then click Adapters.

  3. Right-click Adapters and point to New, Adapter to display the Adapter Properties dialog.

  4. Enter a value for the Name field, for example TIBCO EMS.

  5. Select TIBCO Enterprise Message System from the list of adapters available in the Adapter dropdown and click OK.

Create a BizTalk Send Port

  1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, expand BizTalk Application 1, and click Send Ports.

  2. Right-click Send Ports and point to New, Static One-way Send Port to display the Send Port Properties dialog.

  3. Enter a value for the Name field, for example TIBCOEMSOneWaySP.

  4. Select the TIBCO EMS adapter from the list of available adapters in the Type dropdown box and click the Configure button to display the adapter Transport Properties dialog box.

    Note

    This value is the name that was specified when the TIBCO Enterprise Message System adapter was created in the BizTalk Server Administration console.

  5. Enter values for the Server Connection definition:

    Property Value
    Destination The server destination queue or topic name.
    Port number The port on which the TIBCO server is listening. Default value is 7222.
    Server Name The name of the TIBCO EMS server.

  6. Enter values for the User Credentials:

    Property Value
    Password The password for the TIBCO EMS server.
    User name The user name for the TIBCO EMS server.

    For more information about the properties, see Creating TIBCO Enterprise Message Service Send Handlers.

  7. Click OK.

  8. Select the XML Transmit pipeline from the list of pipelines available in the Send pipeline dropdown and click OK.

  9. Right-click the send port and click Start to enlist and start the send port.

Create a file receive port

  1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, expand BizTalk Application 1, and click Receive Ports.

  2. Right-click the Receive Ports folder and then click New, One-way Receive Port to display the Receive Port Properties dialog.

  3. Enter a value for the Name field, for example TIBCOEMSOneWayFileRP, and click OK.

Create a file receive location

  1. Create a folder for the file receive location to monitor, for example C:\Filesource.

  2. Right-click the new receive port and then click New, Receive Location to display the Receive Location Properties dialog.

  3. Enter a value for the Name field, for example TIBCOEMSOneWayFileRL.

  4. Select FILE from the list of available adapters in the Type dropdown box and click the Configure button to display the adapter Transport Properties dialog box.

  5. Enter the location of the folder that you created earlier for the Receive Folder property and click OK.

  6. Select XMLReceive from the list of available pipelines in the Receive pipeline dropdown box and click OK.

  7. Right-click the receive location and click Enable.

Generate a document instance from the Adapter schema

  1. Right-click Schema.xsd in Solution Explorer and click Properties.

  2. In the Properties window, click to select the Output Instance Filename option under the General category.

  3. Click the ellipses button (…) to display the Select Output File dialog.

  4. Specify a folder and name for the output file instance, for example C:\instance.xml and click Save.

    Note

    Do not specify the location of the folder that was specified for the file receive location here.

  5. Right-click Schema.xsd in Solution Explorer and click Generate Instance to generate a document instance in the specified location.

Modify the generated document instance

  1. Open the generated document instance in a text editor such as Notepad and edit the contents of the document instance to ensure that the data will generate a unique record in the TIBCO system. For example the code below shows the first part of the data file:

    <ns0:Root xmlns:ns0="http://TibcoEMSOne_WaySend.TibcoEMSOneWaySendSchema">  
  <Name>Punya Palit</Name>  
  <MailAddress>Prose Ware, Inc.</MailAddress>  
</ns0:Root>

  2. Save the modified document instance.

Build and deploy the project

  1. Right-click the OneWaySend project in Solution Explorer and click Properties to launch the Project Designer for the project.

  2. Click the Deployment tab.

  3. Enter the appropriate values for the Server property and the Configuration Database property under BizTalk Group category.

  4. Right-click the OneWaySend project in Solution Explorer and click Deploy to build the project and deploy the assembly to the BizTalk Server configuration database.

Bind and Enlist the orchestration

  1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, expand BizTalk Application 1, and click Orchestrations.

  2. Click the Refresh button in the MMC toolbar or press the F5 key on your keyboard to refresh the BizTalk Server Administration console view.

  3. Double-click the orchestration to display the Orchestration Properties dialog.

  4. Click Bindings in the left pane of the dialog to display the Bindings options for the orchestration.

  5. Specify the appropriate values for the binding options, for example:

    Parameter Value
    Host BizTalkServerApplication
    FileReceivePort TIBCOEMSOneWayFileRP
    TibcoEMSOneWaySendPort TIBCOEMSOneWaySP

  6. Click OK.

Start the orchestration

  • In the BizTalk Server Administration console, right-click the orchestration and click Start to enlist and start the orchestration.

Drop a document instance into the folder monitored by the file receive location

  • Copy the document instance that was created earlier to the file receive folder the application monitors.

Verify that the TIBCO system is updated

  • Use the TIBCO web interface to verify that the record was created from the data in the XML file.

    The following sequence of events occurs if the document instance is processed successfully:

  1. The File adapter retrieves the file from the folder and publishes it to the MessageBox as a BizTalk message.

  2. The orchestration subscribes to this published message so the BizTalk Messaging Engine will activate an instance of the orchestration and send the message to the orchestration instance.

  3. The orchestration instance processes the message using the logic specified in the orchestration and publishes the message back to the MessageBox.

  4. The TIBCO send port subscribes to this published message and so the BizTalk Messaging Engine sends the message to the TIBCO send port.

  5. The send port hands the message to the BizTalk Adapter for TIBCO Enterprise Message Service.

  6. The BizTalk Adapter for TIBCO Enterprise Message Service sends the message to the TIBCO system.

See Also

Tutorial: Using the BizTalk Adapter for TIBCO Enterprise Message Service to Receive Data
Tutorials: Using the Microsoft BizTalk Adapter for TIBCO Enterprise Message Service
Getting Started