Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Publish-Subscribe Toolkit Documentation for Microsoft BizTalk Server 2002

Click here to download sample - BizTalkPubSubToolkit.exe.
 

                    
Martin Chung

Microsoft Corporation

May 2002

Applies to:
    Microsoft® BizTalk® Server 2002

Summary: How to understand and use the BizTalk 2002 Publish-Subscribe Toolkit. (21 printed pages)

Download BizTalkPubSubToolkit.exe.

Contents

Introduction
Enterprise Application Integration Concepts
Integration Architectures
Implementing EAI in BizTalk
The Publish-Subscribe Toolkit
Publish-Subscribe Framework Administration
Subscription Processor AIC
Sample Applications
Installation
Quick Component Reference

Introduction

What is the Microsoft BizTalk Server 2002 Publish-Subscribe Toolkit?

The Microsoft® BizTalk® 2002 Publish-Subscribe Toolkit is an abstraction layer built upon the standard BizTalk objects (also called "artifacts") such as receive functions, channels, ports, documents, and organizations.

Instead of requiring applications to deal with the underlying artifacts, the Toolkit provides a simplified way to create them by using a publish-subscribe metaphor; namely through the following objects:

  • Publisher
  • Subscriber
  • Broker
  • Publication
  • Subscription

The Toolkit consists of the following components.

  • A Publish-Subscribe multithreaded COM+ component, the Publish-Subscribe Framework (PSF)
  • A BizTalk Application Integration Component (AIC) that shows how incoming XML documents can call the PSF to create new subscriptions
  • A stock quote sample to show multiple publishers, subscribers, and dynamic updating of subscriptions
  • Documentation and source code

The Toolkit is meant as a starting point for publish-subscribe systems based on BizTalk Server.

Enterprise Application Integration Concepts

What is EAI?

Enterprise Application Integration (EAI) software provides the infrastructure to connect an organization's internal applications. The ultimate goal is to have an organization's disparate internal applications appear and act as one single unified application.

From a historical point of view, applications typically began as unconnected, unrelated applications. When data integration was needed, it was often performed in a point-to-point manner. Point-to-point integration quickly becomes unmanageable as the number of integration points increases.

A solution to connecting multiple applications together was to write a single monolithic application to encompass the organization's business needs. Such ERP (Enterprise Resource Planning) applications provided the advantages of integration, but typically had the drawback that their functionality was usually not the best available in the marketplace.

ERP systems are often essential partners in any EAI-based systems. A common technique used by organizations is to employ ERP systems such as PeopleSoft or SAP for internal, non-value-add functionality such as accounting, payroll, human resources, and so forth, while employing custom or best-of-breed solutions for value-add (often customer-facing) systems such as logistics, product merchandising, e-commerce, customer relationship management, and so on.

EAI and middleware technologies were introduced to provide a means for best-of-breed applications to be integrated with each other into a unified "virtual" application, thus enjoying the benefits of integration without the drawbacks of ERP.

EAI should be seen as an ongoing philosophy as EAI software exists to provide integration, but an organization's applications must be written to function in an EAI environment as well.

From its beginnings as message-oriented-middleware technology, EAI has expanded beyond simply integrating data between applications (for example, BizTalk Messaging) into providing business process integration (for example, BizTalk Orchestration).

Integration Architectures

Point-to-Point

Point-to-point integration is where data is interchanged directly between the two systems. The sending system needs to convert its internal data format to a format acceptable for the receiving system. Examples would be direct TCP/IP sockets interfaces between systems, flat file export/import, direct read/write to target database schema.

Advantages:

  • Typically better performance and tighter integration because of the tighter coupling between the two systems.
  • Two-way communications between applications are easier without a middleman.
  • In smaller cases, or where applications are static, can be simpler than an EAI solution.

Disadvantages:

  • Complexity. The number of integration points increases as number of systems increases and can quickly become unmanageable.
  • Tighter coupling (transport, document formats) makes it harder to change either of the two systems involved in an interchange without impacting other systems.
  • Static integration design does not allow for rapid changes (swapping in of new applications) often required to be competitive in this day and age.

Hub-and-Spoke EAI

Hub-and-spoke integration is where integration between systems (spokes) occurs with an intermediary, the hub, involved in routing messages to other spoke systems. A spoke system will send a message with a defined destination to the hub. The hub will perform any required transformations of the message contents and send it to the destination spoke system.

Advantages:

  • Decoupling of sender and receiver. Documents can be transformed by the hub.
  • Less complexity of integration. Applications on either side of the hub can be modified independently of each other and the hub performs any mapping of documents between different application formats.

Disadvantages:

  • Two-way communications is harder. The hub has to correlate messages flowing between both parties.
  • Applications on both sides of the hub have to work well in a decoupled fashion.
  • Some knowledge of the target is required by the source of a message making it somewhat harder to add or remove senders and receivers.

Publish-Subscribe EAI

Publish-subscribe is a system whereby messages generated by publishers are sent to a central messaging hub or broker that in turn sends these messages to subscribers that have previously subscribed to receive some or all of these messages.

This method is similar to hub-and-spoke, and the main conceptual difference is that spokes in a hub-and-spoke system typically know the destination of the message, whereas in publish-subscribe, the publishers do not have any knowledge of the subscribers.

Advantages:

  • Complete decoupling of source and target. Senders (Publishers) have no idea who subscribes to their messages; Receivers (Subscribers) have no idea who generates their messages.
  • Less complexity of integration. Applications on either side of the hub can be modified independently of each other and the hub performs any mapping of documents between different application formats.
  • More dynamic. Subscribers can choose to subscribe and unsubscribe to messages and change their subscription properties at any time.

Disadvantages:

  • Two-way communications is harder. The hub has to correlate messages flowing between both parties.
  • Applications on both sides of the hub have to work well in a decoupled, event-driven fashion.

Implementing EAI in BizTalk

All of the above integration architectures can be implemented in BizTalk through specific configuration patterns for BizTalk channels, ports, and organizations. For example:

  • Point-to-point integration involves direct data transfer between applications, so BizTalk pass-through functionality with preset channels could be used. BizTalk is not strictly necessary for point-to-point integration, but provides some useful functionality such as document tracking.
  • Hub-and-spoke integration and Publish-subscribe integration using BizTalk channel selection (routing) and filtering.

It is important to note that a single implementation of BizTalk can provide all of these integration architectures, depending on how the BizTalk objects are configured.

The Publish-Subscribe Toolkit

The Publish-Subscribe Terminology

The Publish-Subscribe Metaphor revolves around Publishers, Publications, Publication Location, Subscribers, Subscriptions, Subscriber Location, and Brokers.

  • A Subscriber sends a Subscription request (create, update, delete) for a Publication to the Broker. The Subscription request contains the Publication Name and Subscriber Location.
  • Publishers send Publications to the common Publication Location defined for each Publication.
  • The Broker monitors this Publication Location for new Publications.
  • Using the Subscriber Location defined in each Subscription, the Broker transmits copies of the new Publication to Subscribers who have previously created a Subscription to that Publication.
  • Subscribers can also set a filter expression in their Subscription so that only messages matching that filter expression are passed to them by the Broker (this is referred to as a Content-based or topic-based Subscription).
  • The Broker's behavior is configured programmatically through a broker configuration object. Administration applications use the methods provided by the configuration object.
  • The Broker can also be configured by a subscription processor that receives XML subscription messages and calls the broker configuration object.

    Click here for larger image

    Figure 1. Click thumbnail for larger image.

The Publish-Subscribe Framework Component

The Publish-Subscribe Framework Component (PSF) provides an object model to create the underlying BizTalk artifacts. Callers to the PSF operate at Publish-Subscribe level of abstraction and do not have to know anything about BizTalk artifacts.

How It Works

The PSF leverages BizTalk Server's ability to execute multiple channels on submission of a document. BizTalk Server decides which channels to execute by selecting the channels that match the properties configured in the receive function for a particular document (Publication), namely the source organization, destination organization, and document type. In addition, an XPath filter expression can be set for each subscription to allow for content-based filtering at the broker.

The channel routing is achieved by setting a standard source organization (for example, "Broker" or "Home Organization"—the default), a specific destination (for example, "Document X Subscribers") and an existing document type as configured in BizTalk Messaging Manager (for example, "Document X").

When a new publication is created, the PSF creates an MSMQ receive function for the Publication Location specified. Additionally, a destination organization is created containing a specific prefix and the Publication name.

When a new subscription is created, the PSF creates a port with an MSMQ transport to the Subscription Location and creates a channel with the appropriate document (Publication name) specification.

Publish-Subscribe objects are mapped to BizTalk artifacts in the following ways:

  • Brokers are implemented as organizations.
  • Publications are implemented as organizations and receive functions.
  • Subscribers are implemented as organizations.
  • Subscriptions are implemented as channel/port pairs with channel filtering.
  • Subscriber Locations are implemented as MSMQ queues (one queue per publication per subscriber). This queue is set in the subscription port transport.
  • Publication Locations are implemented as MSMQ queues (one queue per Publication). The MSMQ receive function for the Publication reads from this queue.
  • Receive functions are created with the Broker organization as the Source Organization, the Publication as the Destination Organization, and the Document type as the Publication.

BizTalk objects created by the PSF have a "PSF_" prefix in their names and embed other special information in the name (GUIDs and handles). Modification of these objects should be through the PSF component only (that is, through the AIC, Administration application, or other custom application) and not through the BizTalk Messaging Manager as inconsistencies could result.

Implementation Steps

  1. Create a document specification in BizTalk Messaging Manager.
  2. Create an MSMQ Queue for the publication location. All publishers will send documents matching this specification to this common location.
  3. Use PSF Administration tool to create a publication based on the above document, setting properties such as the publication location (MSMQ Queue).
  4. Use the PSF Administration tool to create valid subscribers for this PSF installation.
  5. Either using the AIC or the PSF Administration tool, create a subscription for each subscriber/publication pair. In the subscription properties, enter the subscriber location (MSMQ Queue) for the publication to be sent to.

Implementation Notes

Co-existing with other BizTalk objects

Since the PSF is based purely upon BizTalk Server routing and the use of special naming conventions for objects, it does not interfere with the components of BizTalk Server in any way.

Default AIC

When creating each publication, the PSF automatically creates a default BizTalk channel and port pair to a Default AIC—essentially a default, hidden subscriber. This AIC is essentially a "null" AIC that does nothing except return control back to BizTalk. This AIC is currently required with BizTalk so that there will always be a channel that is instantiated by BizTalk, regardless of any filtering expressions that may exist for subscriptions to that publication. If the default AIC did not exist, and the filtering expressions resulted in no matching channels, BizTalk would treat this as an error condition and log to the system event log.

In addition, the default AIC can also be the starting point for any customized logging for a publication—all publication documents will be received by the default AIC.

At this time, the behavior of the PSF is to always create the default channel/port. If filtering was guaranteed to not be used, the default channel/port could be removed either manually, or the PSF component source code could be modified.

MSMQ transport

The current release of the PSF only supports MSMQ as the underlying transport mechanism. However, other transports can be supported in a multi-hop process (inbound transport -> Publication Location (MSMQ) -> Broker -> Subscription Transport Location (MSMQ) -> outbound transport).

PSF component

The PSF component can be used as a regular COM component or registered as a COM+ component. It was written in Microsoft Visual C++® and designed to better handle large numbers of calls compared to a Microsoft Visual Basic® single-threaded apartment component.

Queue per publication

Each publication can be associated with only one publishing location (incoming MSMQ Queue). Therefore, all publishers of this particular publication should send all messages to this queue. Multiple publications can be based upon the same underlying document specification, but they all have to be named uniquely.

Multiple brokers

A single BizTalk Server installation can support multiple brokers, as the underlying definition for a broker is a source organization. The default broker name is "Home Organization", the default organization for BizTalk Server. Publications are associated with a particular broker. The PSF Administration supports setting the broker for publications.

Queue permissions

When creating MSMQ queues, ensure that the user account that BizTalk Server runs, as has the appropriate read and write permissions to the queue.

Publish-Subscribe Framework Administration

User Interface

The Publish-Subscribe Toolkit provides a sample PSF Administration tool (PSFAdmin) that uses the Publish-Subscribe Framework component to create, update, and delete PSF objects.

PSFAdmin initially shows a window with three tabs, Subscriptions, Publications, and Subscribers. Clicking on these tabs will bring up a list of the corresponding objects. Each list is searchable using the search fields.

The lists have context popup menus (accessed clicking the right mouse button on the object) appropriate for the objects being listed. Objects can be created or deleted, and in the case of publications and subscribers, subscriptions associated with the highlighted object can be searched through the Find Subscription popup menu item.

Ee265643.bts_pubsubeai_02(en-US,BTS.10).gif

Figure 2.

Adding/Editing Subscribers

  1. Double-click the subscriber to edit an existing subscriber. To create a new subscriber, click the right mouse button in the subscriber list and select New Subscriber, or select File | New > Subscriber.
  2. Enter the new subscriber name, ensuring it is unique.

    Ee265643.bts_pubsubeai_03(en-US,BTS.10).gif

    Figure 3.

Adding/Editing Publications

  1. Double-click the publication list to edit an existing publication. To add a new publication, click the right mouse button in the subscriber list and select New Publication, or select File | New > Publication.
  2. Enter the new publication name, ensuring it is unique. A publication's name cannot be changed after the publication has been created.
  3. Select a document definition by clicking on the Browse. . . button to the right of the document definition field. A list of BizTalk Messaging document definitions will appear. Select one and click OK.
  4. Enter the MSMQ queue name for the publication location for this publication. This will be used by the underlying BizTalk Server receive function. For example: direct=os:<servername>\<queuename>
  5. Select a server group where the receive function will run by clicking on the Browse. . . button to the right of the server group field. A list of BizTalk server groups will appear. Select one and click OK.
  6. Select a processing server where the receive function will run by clicking on the Browse. . . button to the right of the server group field. A list of BizTalk servers belonging to the server group will appear. Select one and click OK.
  7. Click Save.

    Ee265643.bts_pubsubeai_04(en-US,BTS.10).gif

    Figure 4.

Adding/Editing Subscriptions

  1. Double-click the subscription list to edit an existing subscription. To add a new publication, click the right mouse button in the subscriber list and select New Subscription, or select File | New > Subscription.
  2. Select a broker for this new subscription to be associated with by clicking on the Browse. . . button to the right of the subscription entry field. A list of valid broker names (BizTalk organizations) will appear. Select one and click OK.
  3. Select a subscriber by clicking on the Browse. . . button to the right of the subscriber field. A list of subscribers will appear. Select one and click OK.
  4. Select a publication by clicking on the Browse. . . button to the right of the publication field. A list of publications will appear. Select one and click OK.
  5. Enter a valid XPath filter expression for the document, if one is required for content-based filtering. If the filter expression result is non-empty, then the channel will be executed.
  6. Enter the MSMQ queue name for the subscriber location for this subscription. Incoming publications that match the filter expression will be sent to this queue.
  7. Click Save.

    Ee265643.bts_pubsubeai_05(en-US,BTS.10).gif

    Figure 5.

Subscription Processor AIC

Included in the Publish-Subscribe Toolkit is a subscription processor AIC that parses an incoming XML message and calls the Publish-Subscribe Framework component to create, update, and delete subscriptions. The AIC will also reply to the caller with an acknowledgement XML message. This AIC is used by the sample applications.

Two schemas are provided: one for subscription create/add/and update requests, and the other for acknowledgements. These are meant as starting points for further development.

Subscribers create MSMQ queues to receive acknowledgement messages from the BizTalk AIC. The queue name to reply on is passed to the AIC in the subscription message.

The flow of MSMQ messages between a subscriber, publisher, and the broker can be illustrated as follows:

Click here for larger image

Figure 6. Click thumbnail for larger image.

The supplied version of the AIC supports only subscribing, updating, and unsubscribing. It does not provide the ability for a subscriber to query the AIC for information that the PSF component can provide such as a list of publications.

Sample Applications

The sample applications consist of a publishing application and a subscribing application. The publishing application publishes simple stock quote messages (consisting of a stock symbol and price) every 0.5 seconds to a publishing location, in this case an MSMQ queue.

The subscribing application monitors a subscriber location, another MSMQ queue, for stock quote messages. The subscribing application automatically creates this queue upon startup. The queue name is suffixed by the process id of the application, so multiple instances of the subscriber can be run, with each instance monitoring a different queue.

The subscribing application also has the ability to dynamically subscribe and subscribe to publications. It can generate subscription request XML messages and send them to an Administration queue. BizTalk Server monitors this queue through a receive function and messages are sent to a BizTalk AIC that processes the message and calls the PSF component to create or delete subscriptions. The AIC will also send an acknowledgement message back to the subscriber containing the success code of the request and a handle to the subscription.

The sample setup script will automatically create the necessary queues, document definitions, channels, ports, and receive functions required, so very little is required to run the sample applications other than to start the publisher, start the receiver, and send a subscription request message to the broker.

Publisher Sample Application

The publisher sample publishes stock quote messages to the designated MSMQ queue. The stock prices move randomly from a starting point, but trend either upwards or downwards based on the alphabetical position of the first character of the stock symbol (A-M upwards, N-Z downwards).

To run the publisher

  1. Set the stock symbol.
  2. Enter the MSMQ queue pathname.
  3. If the queue is transactional, make sure the transactional checkbox is set.
  4. Click Start to start sending messages to the queue.
  5. Click Stop to stop sending messages to the queue.

Ee265643.bts_pubsubeai_07(en-US,BTS.10).gif

Figure 7.

Subscriber Sample Application

The subscriber sample application provides a way to receive stock quote messages from a queue and display them. It also provides a way to send subscription create, update, and delete messages to the broker and receive a reply from the broker.

The subscriber sample application creates a unique queue per instance. This queue name is displayed in the Subscriber Queue field. Incoming stock quote messages are received on this queue.

Monitoring messages

To start monitoring queue messages, click the Start Receiving button. Incoming messages will be displayed in the Queue Monitor list. To stop monitoring messages, click the Stop Receiving button.

Sending a subscription message

  1. Verify that the Pub/Sub Admin queue field is set to the MSMQ queue configured to run the Publish-Subscribe BizTalk Server AIC. Also verify that the transactional checkbox is set to reflect the transactional setting of the queue.
  2. Enter a filter expression if needed. This should be a valid XPath expression for the underlying document.
  3. Click Create. This will send a subscription request XML message to the Admin queue and will wait for an acknowledgement message on a reply queue created by the subscriber. A message box will appear showing the actual contents of the message. When the acknowledgement message is received, the contents of the message will be displayed in a message box and the last error code and subscription handle fields on the window will be updated. The subscriber will wait up to 60 seconds for a response from the subscription AIC before timing out and reporting an error.
  4. Once created, the subscription properties can be updated by clicking on the Update button. For example, a new filter expression can be set by entering the expression in the filter field and clicking on Update. The last error code field will be updated.
  5. To delete the subscription, click the Delete button.

Ee265643.bts_pubsubeai_08(en-US,BTS.10).gif

Figure 8.

Running the Publisher and Subscriber Samples

There are two ways to run the samples, broker-initiated (created by the PSF Administration tool), and subscriber-initiated subscriptions (subscriber calls the subscription AIC). The easiest way is subscriber-initiated as the subscriber application makes the subscription request; with the broker-initiated subscription, the user will need to create the subscription manually.

Please note that, currently, subscribers do not have a way to get a list of their subscriptions through the AIC, so they cannot modify an existing broker-initiated subscription. Subscribers do have a way to modify their own subscriber-initiated subscriptions because a subscription handle is passed to them when they dynamically subscribe to a message.

Subscriber-initiated subscription

  1. If the sample objects have not been previously setup, run the sample setup script (Sample Setup.vbs) in the Toolkit Sample folder.
  2. Run the Quote Publisher.
  3. Run the Quote Subscriber. Ensure the Administration queue is set to the MSMQ queue monitored by BizTalk Server. Also verify that the transactional checkbox is set to reflect the transactional setting of the queue.
  4. Click Start Receiving. This will start the subscriber listening for messages from the queue.
  5. Enter a filter expression if needed. This should be a valid XPath expression for the underlying document.
  6. Click Create. This will send a subscription request XML message to the Admin queue and will wait for an acknowledgement message on a reply queue created by the subscriber. A message box will appear showing the actual contents of the message. When the acknowledgement message is received, the contents of the message will be displayed in a message box and the last error code and subscription handle fields on the window will be updated. The queue monitor should now display messages being sent by the publisher.
  7. Once created, the subscription properties can be updated by clicking on the Update button. For example, a new filter expression can be set by entering the expression in the filter field and clicking on Update. The last error code field will be updated.
  8. To delete the subscription, click the Delete button.

Broker-initiated subscription

  1. Run the Quote Publisher. Set the MSMQ queue to an existing queue such as ".\private$\psf_stock_quote_message" (create MSMQ queues using the Computer Management tool in the Control Panel). Messages will be published to this queue and be picked up by BizTalk.
  2. In the PSF Administration tool, create a publication with the following properties (this publication should already exist if the sample setup script has been run):
    • Publication name set to "PSF Stock Quote Publication"
    • The Publishing Location set to the MSMQ queue configured in the Quote Publisher (".\private$\psf_stock_quote_message" in this case)
    • The document specification set to "PSF Stock Quote Message"
    • The server group and processing server set appropriately
  3. In the PSF Administration tool, create a subscriber, for example, "PSF Sample Subscriber". Again, this subscriber should already exist if the sample setup script has been run.
  4. Run the Quote Subscriber.
  5. In the PSF Administration tool, create a new subscription with the Subscription location set to the MSMQ queue specified in the Subscriber queue field in the Quote Subscriber application (for example, ".\private$\psf_sample_subscription_xxxx" where xxxx is the process ID). This is the queue that the Quote Subscriber will expect messages from the broker to arrive on. Set the Publication to "PSF Stock Quote Publication". Set the Broker Name to "Home Organization" and the server group and name to their appropriate values. Finally, click Save to save the changes. The subscription will now be active.
  6. In the Quote Subscriber, click the Start Receiving button.
  7. In the Quote Publisher, click the Start button to start sending messages. The messages should now appear in the Quote Subscriber.
  8. Using the PSF Administration tool, modify the subscription as necessary; for example, by setting the filter expression, deleting, and creating subscriptions.

Running additional Publishers and Subscribers

Additional Publishers and Subscribers can be run together at the same time. Each instance of the Publisher will write to the same common publishing location queue. Each instance of the Subscriber will automatically create its own unique subscription queue to receive messages on.

Installation

The installation package contains several subfolders:

  • Admin: contains the PSF Administration tool.
  • Sample: contains the stock quote subscriber and publisher samples.
  • DocSpecs: contains the document specifications for the sample and AIC.
  • Components: contains the PSF component and AIC.
  • Documentation: contains the documentation for the toolkit.
  • Source: contains two ZIP compressed files with the Visual Basic 6.0 and Visual C++ 6.0 code for the toolkit. There is also a file, VCReadme.txt, in the folder that provides further instructions for building the Visual C++ components.

Framework Installation

  1. Unpack the installation package into a temporary folder.
  2. Run setup.exe and select a target folder.
  3. The setup program will then create the subfolders and files mentioned above.

Sample Installation

  1. If it does not exist already, create a new Organization with the name "Home Organization". Otherwise, ensure that the default organization is called "Home Organization" This is required because it is the default name of the broker used by the sample setup. The sample setup script also requires the objects it creates to not already exist; if they do, they will need to be removed before running the script.
  2. Run the sample install script (Sample Setup.vbs) in the Publish-Subscribe Sample folder, typically "C:\Program Files\BizTalk Server PST\Sample". This will create the prerequisite objects for running the sample. These objects include the following:
    • Private MSMQ queues: one for the subscription AIC's administration queue ("psf_admin_queue") and one for the publication location ("psf_stock_quote_message")
    • Document specifications ("PSF Stock Quote Message", "PSF Subscription Request")
    • Publication ("PSF Stock Quote Publication")
    • Subscriber ("PSF Sample Subscriber")
  3. Once created, the setup script will not need to be run again, unless the above objects are removed.
  4. To remove the objects, use the Publish-Subscribe Administration Tool to remove them manually. The MSMQ queues may be removed through the Computer Management control panel application.

Quick Component Reference

Requirements

Library: Microsoft BizTalk Server Configuration Objects 1.0 Type Library (BizTalkPubSubObjectModel.dll)

Remarks

Objects used in the Publish-Subscribe Framework utilize the interfaces established by the standard BizTalk Server configuration objects. For example, each object inherits the following common methods from IBizTalkBase:

  • DateModified
  • Handle
  • Name
  • Clear
  • Create
  • Load
  • LoadByName
  • Remove
  • Save

When IBizTalkPublication, IBizTalkSubscription objects are created, the PSF automatically creates some associated IBizTalkPort and IBizTalkChannel objects, which in turn create some associated subobjects.

These subobject properties can be accessed through the IBizTalkPublication and IBizTalkSubscription objects. For example, the underlying PrimaryTransport property for a port is exposed through the PrimaryTransport property in the IBizTalkSubscription object.

Further documentation on these properties and methods can be found in the Microsoft BizTalk Server 2002 documentation.

IBizTalkPubSubConfig

Creates subscribers, publications, and subscriptions.

Hierarchy

IDispatch

|—IBizTalkPubSubConfig

Declaration

[Visual Basic]

Class BizTalkConfig

[C++]

interface IBizTalkPubSubConfig : IDispatch

Members

IBizTalkPubSubConfig defines the following properties:

PropertyDescription
PublicationsContains an ADO recordset that contains all IBizTalkPublication objects.
SubscribersContains an ADO recordset that contains all IBizTalkSubscriber objects.
SubscriptionsContains an ADO recordset that contains all IBizTalkSubscription objects.

IBizTalkPubSubConfig defines the following methods:

MethodDescription
CreatePublicationReturns a new IBizTalkPublication object.
CreateSubscriberReturns a new IBizTalkSubscriber object.
CreateSubscriptionReturns a new IBizTalkSubscription object.

IBizTalkPublication

Configures a publication. Publications are created as organizations and receive functions in the BizTalk Management Database.

Hierarchy

IDispatch

|—IBizTalkBase

  |—IBizTalkPublication

Declaration

[Visual Basic]

Class BizTalkPublication

[C++]

interface IBizTalkPublication : IBizTalkBase

Members

IBizTalkPublication defines the following properties:

PropertyDescription
BrokerNameString.  Contains the name of the broker organization.
DateModifiedString.  Gets the date of the last update for this object.
DocumentNameContains an ADO recordset that contains all IBizTalkSubscription objects.
GroupNameString.  Contains the name of the group to which the server belongs.
HandleLong.  Returns a handle to the object in the database.
NameString.  Returns the name of the object.
PollingLocationString.  Contains the name of the directory to poll (directory, message queue, and so on) for receive functions that require polling.
ProcessingServerString.  Contains the name of the server that is currently processing the interchange.
SubscribersReturns an ADO Recordset of the subscribers to this publication.
SubscriptionsReturns an ADO Recordset of the subscriptions to this publication.

IBizTalkPublication defines the following methods:

MethodDescription
ClearClears the object from memory.
CreateCreates a new object in the database.
LoadLoads a specified object in memory.
LoadByNameLoads a specified object by name in memory.
RemoveRemoves the object from the database.
SaveSaves the object in the database.

IBizTalkSubscriber

Configures a subscriber. Subscribers are created as organizations in the BizTalk Messaging Database.

Hierarchy

IDispatch

|—IBizTalkBase

  |—IBizTalkSubscriber

Declaration

[Visual Basic]

Class BizTalkSubscriber

[C++]

interface IBizTalkSubscriber : IBizTalkBase

Members

IBizTalkSubscriber defines the following properties:

PropertyDescription
DateModifiedString. Gets the date of the last update for this object.
HandleLong. Returns a handle to the object in the database.
NameString. Returns the name of the object.
PublicationsReturns an ADO Recordset of the publications the subscriber subscribes to.
SubscriptionsReturns an ADO Recordset of the subscriptions belonging to this subscriber.

IBizTalkSubscriber defines the following methods:

MethodDescription
ClearClears the object from memory.
CreateCreates a new object in the database.
LoadLoads a specified object in memory.
LoadByNameLoads a specified object by name in memory.
RemoveRemoves the object from the database.
SaveSaves the object in the database.

IBizTalkSubscription

Configures a subscription. Subscriptions are created as channels and ports in the BizTalk Management Database.

Hierarchy

IDispatch

|—IBizTalkBase

  |—IBizTalkSubscription

Declaration

[Visual Basic]

Class BizTalkSubscription

[C++]

interface IBizTalkSubscription : IBizTalkBase

Members

IBizTalkSubscription defines the following properties:

PropertyDescription
BrokerLong. Contains the handle of the broker.
DateModifiedString. Gets the date of the last update for this object.
FilterString. Contains the XPath filter expression for this subscription.
HandleLong. Returns a handle to the object in the database.
NameString. Returns the name of the object.
Primary TransportReturns an IBizTalkTransportInfo object containing the primary transport component information.
PublicationLong. Contains the handle to the publication object for this subscription.
Secondary TransportReturns an IBizTalkTransportInfo object containing the secondary transport component information.
SubscriberLong. Contains a handle to the subscriber object for this subscription.
SubscriberTokenString. Contains the token provided by the subscriber to identify the subscription.

IBizTalkSubscription defines the following methods:

MethodDescription
ClearClears the object from memory.
CreateCreates a new object in the database.
LoadLoads a specified object in memory.
LoadByNameLoads a specified object by name in memory.
RemoveRemoves the object from the database.
SaveSaves the object in the database.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.