Understanding Messaging Services Objects

The BizTalk Messaging Configuration Object Model is the component of BizTalk Server that is used in the document processing processes. You need to use the BizTalk Messaging Manager to configure objects in the BizTalk Messaging Configuration Object Model.

The different objects that you can configure in the BizTalk Messaging Configuration Model are listed here:

  • BizTalkConfig object; used to create/configure the following BizTalk Server objects:
    • Document specifications
    • Messaging ports
    • Channels
  • BizTalkOrganization object; holds the attributes on the organization.
  • BizTalk Document object; holds the attributes on the document specification.
  • BizTalkEnvelope object; holds the attributes which identify the format of the envelope for the document.
  • BizTalkPort object; contains information on the destination of a document.
  • BizTalkPortGroup object; contains information about specific messaging ports.
  • BizTalkChannel object; contains information on the source entity’s configurations. It also binds the source entity to a specific messaging port.

Creating Messaging Services Objects

When creating Messaging Services objects, it is recommended that you use the order listed here:

  • Create the home organization
  • Create all other organizations.
  • Create the documents.
  • Create envelopes.
  • Create the messaging ports.
  • Create the channels for the messaging ports.
  • Create the distribution lists.
  • Create the channels for the distribution lists.

An organization must minimally have one organization identifier that uniquely identifies the specific organization. An organization can however have multiple identifiers. When multiple identifiers are used, each one must be unique to the specific organization.

One identifier becomes the default identifier for an organization. The default identifier is always used to identify the specific organization, and it is usually the name of the organization. You can though explicitly override this in a messaging port or channel. To change the default identifier to a different identifier, you have to change the organization’s associated properties.

The organization identifier record contains the following three fields:

  • Name of the identifier; describes the entity utilized for identifying the organization.
  • Qualifier; a number which specifies what the name signifies. The Qualifier is specific to BizTalk Server.
  • Value; represents the actual entity.

When you install BizTalk Server, the home organization is automatically created. The home organization is the object which describes your specific business. The home organization cannot be deleted. The home organization is created with the following defaults:

  • The Identifier is Organization.
  • The qualifier is OrganizationName.
  • The value is Home Organization

If you are using the BizTalk Server Standard edition, then you can create up to 5 organizations. You can create numerous organizations if you are using the BizTalk Server Enterprise edition – there is no limit placed on the number of organizations that you can create.

Document definitions in BizTalk Server, describe documents, and are used in channels to define how document should be processed. The BizTalkDocument object holds the pointer to the document specification which BizTalk Server utilizes to validate the document structure.

Each channel must have an:

  • Inbound document definition.
  • Outbound document definition.

An envelope contains data on the document or interchange; and is sent together with the specific document or interchange. The envelope holds the attributes which identify the format of the envelope for the document. It defines how the document should be processed.

You do not need to create and send an envelope with a document or interchange. The document is transported in the XML format when an envelope is not defined for it. Here, the document has no header. When configuring envelopes, the envelope you specify for a document must be compatible with the format of the document it will contain – an X12 envelope should be used for an X12 document. When you specify an envelope in the messaging port, the envelope must be compatible with the format of the outbound document definition.

The following properties can be configured for a messaging port:

  • Document Destinations: A message port can transport documents to the following:
    • Destination organizations (trading partners).
    • Destination applications in the home organization.
    • XLANG schedules.
    • Open destinations, which will be defined at a later stage.
  • Transport properties: Configuring Transport properties consists of specifying the following transport specific settings:
    • The transport service which will be utilized by the message port to transport the documents.
    • The destination address that the document should be transported to.
    • The time interval (service window) wherein the document will be transported.

Each channel associated with the messaging port, will receive the transport properties for that specific messaging port.
The different transport types supported by BizTalk Server are listed here:

    • HTTP; Hypertext Transfer Protocol (HTTP) will be used to transport the document. You have to specify the transport address.
    • HTTPS; Secure Hypertext Transfer Protocol (SHTTP) will be used to transport the document. You have to specify the transport address.
    • SMTP; Simple Mail Transfer Protocol (SMTP) will be used to transport the document. You have to specify the transport address.
    • File; the SendToLocalFile component will be used to transport the document. You have to specify the transport address.
    • Message Queuing; Message Queuing Services will be used to transport the document. You have to specify the transport address.
    • Application Integration Component; an application integration component (AIC) will be used to transport the document.
    • Loopback; the document is transported back to the application, a component, or the XLANG schedule. Used for messaging ports where the destination is an application. You have to specify the transport address.
  • Envelopes: Envelopes can be used in messaging ports. The format of an envelope must go with the format of the documents that it is associated with. When you define an envelope for a messaging port, each of the documents dealt with by the specific messaging port must have the same format. The format of the envelope must also go with the outbound document definition in the channel that the specific messaging port is associated with.
  • Security properties: When you configure security properties for a messaging port, all channels which are associated with the specific messaging port have the security properties applied. This basically means that each and every channel for the specific messaging port share the same security properties.

BizTalk Server can both process and generate receipts. To process receipts, you can use either of these methods:

  • Use reliable messaging: With reliable messaging, receipts are generated and sent automatically. Reliable messaging basically guarantees that the document or exchange will reach its specified destination. To use reliable messaging, you have to configure the source system and the destination system accordingly.
  • Configure a channel to process the receipts: When processing an interchange that needs parsing through a non-XML parser, then you have to use a channel to process the receipts. You have to configure the destination system to generate a receipt once it receives an interchange.

How to change the default identifier to a different identifier

  1. Open BizTalk Messaging Manager.
  2. Click Organizations.
  3. Click Search Now to display the list of current organizations.
  4. Double-click the organization thats default identifier you want to modify.
  5. The Organization Properties dialog box opens.
  6. Switch to the Identifiers tab.
  7. Select the identifier that you want as the default identifier.
  8. Click Edit.
  9. When the Identifier Properties dialog box opens, click the Set As Default checkbox.
  10. Click OK in the Identifier Properties dialog box.
  11. Click OK in the Organization Properties dialog box.

How to configure the home organization

  1. Open BizTalk Messaging Manager.
  2. The BizTalk Messaging Manager window opens.
  3. Click the Cancel button to use the Messaging Manager.
  4. Click Organizations and then click Search Now, in the Search For Other Items section.
  5. The Home Organization (Default) is displayed in the right pane.
  6. Double-click the default organization to access its properties.
  7. The Organization Properties dialog box opens.
  8. Enter the name of the organization in the Organization Name textbox.
  9. Provide a meaningful description in the Comment box.
  10. Click the Identifiers tab.
  11. The identifiers displayed on the Identifiers tab are:
  • The default identifier which identifies the organization based on name.
  • The Reliable Messaging Acknowledgement SMTP From Address identifier.
  1. Click the Add button.
  2. The New Identifier dialog box opens.
  3. Select the Standard option.
  4. Select the identifier that you want to add and click OK.
  5. Click OK in the Organization Properties dialog box.

How to add applications to the home organization

  1. Open BizTalk Messaging Manager.
  2. Click Organizations and then select the Home Organization checkbox. Click Search Now.
  3. Double-click the organization.
  4. The Organization Properties dialog box opens.
  5. Click the Applications tab.
  6. Click the Add button.
  7. Provide a name in the Application Name text box.
  8. Click OK.

How to create a new organization

  1. Open BizTalk Messaging Manager.
  2. Click the File menu and select New, and then select Organization.
  3. The New Organization dialog box opens.
  4. In the Organization Name textbox, enter the name for the organization.
  5. Provide a meaningful description in the Comment box.
  6. Click OK.

How to create a document definition

  1. Open BizTalk Messaging Manager.
  2. From the File menu, click New and then click Document Definition.
  3. The New Document Definition dialog box opens.
  4. In the Document Definition Name textbox, enter the name for the new document definition.
  5. Select the Document Specification checkbox.
  6. Click the Browse button.
  7. The Select A Document Specification From The WebDAV Repository dialog box opens.
  8. Locate the specification, select it and then click Open.
  9. The URL of the specification should be displayed in the WebDAV Repository Reference textbox.
  10. Click the Global Tracking tab.
  11. Under Specification Fields, expand the specification tree and select the appropriate entry.
  12. Click OK.

How to create an envelope for a document or interchange

  1. Open BizTalk Messaging Manager.
  2. Click the File menu and select New, and then select Envelope.
  3. The New Envelope dialog box opens.
  4. Provide a name for the envelope.
  5. Select the format for the envelope in the Envelope Format list.
  6. Select the Envelope Specification checkbox if you have selected either of the following formats:
    • Custom XML.
    • Custom.
    • Flatfile.
  1. Click the Browse button to select the envelope specification.
  2. Click OK.

How to configure a messaging port for transport (file)

  1. Open BizTalk Messaging Manager.
  2. Click the File menu, select New, select Messaging Port, and then select To An Application.
  3. The New Messaging Port Wizard initiates.
  4. On the General Information screen, enter a name in the Name textbox.
  5. In the Comments box, enter a meaningful description. Click Next.
  6. On the Destination Application screen, select Application.
  7. Click Browse under Primary Transport.
  8. The Primary Transport dialog box opens.
  9. Select File from the Transport Type drop-down list box.
  10. Enter the appropriate information in the Address field.
  11. Click OK in the Primary Transport dialog box.
  12. Click Next on the Destination Application screen.
  13. On the Envelope Information screen, you can use the default settings. Click Next.
  14. On the Security Information screen, you can also use the default encoding setting, default encryption setting, and default signature setting.
  15. Select the Create A Channel For This Messaging Port checkbox.
  16. In the Channel Type drop-down list, select the From An Application option.
  17. Click Finish.
  18. The New Channel Wizard initiates automatically.

How to configure a channel for a messaging port

  1. The New Channel Wizard initiates automatically after you have configured a messaging port for transport.
  2. On the General Information screen, enter a name in the Name textbox.
  3. In the Comments box, enter a meaningful description. Click Next.
  4. Select Application and then click Next.
  5. Click the Browse button when the Inbound Document screen is displayed.
  6. The Select A Document Definition dialog box opens.
  7. Select the document definition and then click OK.
  8. Click Next on the Inbound Document screen.
  9. Click the Browse button when the Outbound Document screen is displayed.
  10. The Select A Document Definition dialog box opens.
  11. Select the document definition and then click OK.
  12. On the Outbound Document screen, select the Map Inbound Document To Outbound Document checkbox.
  13. Select the Browse button associated with the Map Reference textbox.
  14. When the Select a Map From The WebDAV Repository dialog box opens, select the map and click Open.
  15. Click Next on the Outbound Document screen.
  16. On the Document Logging screen, click Next to use the default settings.
  17. On the Advanced Configuration screen, click Next to use the default settings.
  18. Click Finish.

How to configure a messaging port for transport (HTTP)

  1. Open BizTalk Messaging Manager.
  2. Click the File menu, select New, select Messaging Port, and then select To An Application.
  3. The New Messaging Port Wizard initiates.
  4. On the General Information screen, enter a name in the Name textbox.
  5. In the Comments box, enter a meaningful description. Click Next.
  6. On the Destination Application screen, select Application.
  7. Click Browse under Primary Transport.
  8. The Primary transport dialog box opens.
  9. Select HTTP from the Transport Type drop-down list box.
  10. Enter the appropriate information in the Address field.
  11. Click OK in the Primary Transport dialog box.
  12. Click Next on the Destination Application screen.
  13. On the Envelope Information screen, you can use the default settings. Click Next.
  14. On the Security Information screen, you can also use the default encoding setting, default encryption setting, and default signature setting.
  15. Select the Create A Channel For This Messaging Port checkbox.
  16. In the Channel Type drop-down list, select the From An Organization option.
  17. Click Finish.
  18. The New Channel Wizard initiates automatically.

How to configure the SMTP host for reliable messaging

  1. In the BizTalk Server Administration console, proceed to expand Microsoft BizTalk Server 2000, and then select the BizTalk Server Group.
  2. Click the Action menu and then select Properties.
  3. Enter the name of the SMTP server in the SMTP Host textbox.
  4. Click OK.

How to configure the From address field for reliable messaging

  1. Open BizTalk Messaging Manager.
  2. Click Organizations, and then click Home Organization.
  3. Click Search Now.
  4. Double-click the organization.
  5. The Organization Properties dialog box opens.
  6. Click the Identifiers tab.
  7. Select Reliable Messaging Acknowledgement SMTP From Address and then click Edit.
  8. Enter the appropriate information in the Value field in the Identifier Properties.
  9. Click OK.

How to configure the messaging port for reliable messaging

  1. Open BizTalk Messaging Manager.
  2. Click the File menu, select New, select Messaging Port, and then select To An Organization.
  3. The New Messaging Port Wizard initiates.
  4. On the General Information screen, enter a name in the Name textbox. Click Next.
  5. On the Destination Organization screen, select Organization.
  6. Click Browse.
  7. When the Select An Organization dialog box opens, select the organization. Click OK.
  8. Click Browse under Primary Transport.
  9. The Primary Transport dialog box opens.
  10. Select SMTP from the Transport Type drop-down list box.
  11. Enter the appropriate information in the Address field.
  12. Enter the information in the Return E-mail Address field. Click OK and then click Next.
  13. On the Envelope Information screen, you can use the default settings. Click Next.
  14. On the Security Information screen, select the Create A Channel For This Messaging Port checkbox. Click Next.
  15. Click Finish.
  16. The New Channel Wizard initiates automatically.

How to configure the channel for reliable messaging

  1. After the New Channel Wizard starts, on the General Information screen, enter a name in the Name textbox. Click Next.
  2. On the Source Application screen, select the application from the Application Name drop-down list box.
  3. Select the Expect Receipt checkbox.
  4. Accept or change the value in the Receipt Interval In Minutes box. Click Next.
  5. On the Inbound Document screen, click the Browse button.
  6. Select the document definition and click OK and then click Next.
  7. On the Outbound Document screen, click the Browse button.
  8. Select the document definition and click OK and then click Next.
  9. Click Next on the Document Logging screen.
  10. Click Finish.

How to configure a channel to accept canonical receipts

  1. Open BizTalk Messaging Manager.
  2. Click Messaging Ports and then select Search Now.
  3. The current messaging ports are displayed.
  4. Right-click the messaging port and select New Channel from the shortcut menu.
    li>Select either of these options:
    • From An Organization
    • From An Application
  1. On the General Information screen, provide a name for the new channel.
  2. Select the This Is A Receipt Channel checkbox and then click Next.
  3. On the following screen, click the browse button and select the organization or application and then click Next.
  4. On the Inbound Document screen, select BizTalk Canonical Receipt.
  5. On the Outbound Document screen, select BizTalk Canonical Receipt.
  6. Click Next and then Finish.

How to create a distribution list

  1. Open BizTalk Messaging Manager.
  2. From the File menu, click New and then click Distribution List.
  3. The New Distribution List dialog box opens.
  4. Enter a name for the new distribution list in the Distribution List Name textbox.
  5. From the Available Messaging Ports list, select the messaging port to add to the distribution list and click Add.
  6. The messaging port is now displayed under Selected Messaging Ports.
  7. Add any other messaging ports to the distribution list.
  8. Click OK.

Configuring Receive Functions

Receive functions can be considered the main entry or access point into BizTalk Messaging Services, because they perform the following activities:

  • Retrieves a document from the message store.
  • Chooses the channel(s) that will process the document.
  • Passes the document to the particular channel(s).

Receive functions are categorized into the following types:

  • File receive function.
  • Message Queuing receive function.

The BizTalk Server Administration console is used to configure the different receive functions for BizTalk Server.

BizTalk Server also includes content-based document self-routing routing functionality that can be configured in the BizTalk Editor tool, on the Dictionary tab. The properties that you can configure on the Dictionary tab are:

  • Document Name
  • Source Type
  • Source Value
  • Destination Type
  • Destination Value

The different types of content-based routing that you can configure are:

  • Open Source Routing: Here, you have to specify the channel as an open source channel. The messaging port is configured as usual.
  • Open Destination Routing: Here, you have to specify the messaging port as an open destination messaging port. The channel is configured as usual.

When encountering issues with receive functions, you can use the troubleshooting recommendations listed here:

  • A File receive function only recognizes files which are not read-only. When the input file remains in the pickup directory, first check whether the file is specified as read-only.
  • When the File receive function moves to the disabled state while the input file is in the pickup directory;
    • Verify that the proper polling location was specified.
    • Verify that the file specification was specified correctly.
  • You could possible have two or multiple receive functions that point to the same resources when the following events occur:
    • The input file disappears and no output file was created.
    • A different output file was created.

The document should now be in the Suspended queue. You can check error messages in the event viewer.

How to configure receive functions for BizTalk Server

  1. Open BizTalk Server Administration.
  2. In the Tree tab, expand the Microsoft BizTalk Server 2000 node and expand the BizTalk Server Group node.
  3. Expnd the Receive Functions node.
  4. Click the Receive Functions node.
  5. All currently defined receive functions are displayed under the Receive Functions node.
  6. The Protocol type column specifies whether the receive function is a File receive function or a Message Queuing receive function.

How to add a File receive function

  1. Open the BizTalk Server Administration console.
  2. In the Tree tab, expand the Microsoft BizTalk Server 2000 node, expand the BizTalk Server Group node, and then expand the Receive Functions node.
  3. Click the Receive Functions node.
  4. Right-click the Receive Functions node and select New and then File Receive Function from the shortcut menu.
  5. The Add A File Receive Function dialog box opens.
  6. Provide a name for the File receive function in the Name textbox.
  7. Provide a meaningful comment for the File receive function.
  8. Specify the server whereon the receive function will be run.
  9. Provide the file type in the File Types To Poll For textbox.
  10. Choose the location for polling.
  11. Click the Advanced button to define routing information.
  12. The Advanced Receive Function Options dialog box opens.
  13. Select the Not Open option from the Openness drop-down list box.
  14. The Submit With A Pass-Through Flag option should not be selected.
  15. The envelope setting should be specified as None.
  16. Select the appropriate channel.
  17. Click OK in the Advanced Receive Function Options dialog box.
  18. Click OK in the Add A File Receive Function dialog box.
  19. The new File receive function should be displayed beneath the Receive Functions node in BizTalk Server Administration.

How to add a Message Queuing receive function

Before you create the Message Queuing receive function, you first have to create the queue which the receive function will send messages from to the BizTalk Server.

To add a Message Queuing receive function:

  1. Open the BizTalk Server Administration console.
  2. In the Tree tab, expand the Microsoft BizTalk Server 2000 node, expand the BizTalk Server Group node, and expand the Receive Functions node.
  3. Click the Receive Functions node.
  4. Right-click the Receive Functions node and select New and then Message Queuing Receive Function from the shortcut menu.
  5. The Add A Message Queuing Receive Function dialog box opens.
  6. Provide a name for the Message Queuing receive function in the Name textbox.
  7. Provide a meaningful comment for the Message Queuing receive function.
  8. Specify the server whereon the receive function will be run.
  9. Choose the location for polling.
  10. Click the Advanced button to define routing information.
  11. The Advanced Receive Function Options dialog box opens.
  12. Select the Not Open option from the Openness drop-down list box.
  13. The Submit With A Pass-Through Flag option should not be selected.
  14. The envelope setting should be specified as None.
  15. Select the appropriate channel.
  16. Click OK in the Advanced Receive Function Options dialog box.
  17. Click OK in the Add A Message Queuing Receive Function dialog box.
  18. The new Message Queuing receive function should be displayed beneath the Receive Functions node in BizTalk Server Administration.

How to create an open source routing File receive function

  1. Open BizTalk Messaging Manager.
  2. Beneath Search For Other Items, select Channels, and then select Search Now.
  3. Select the channel and start the Channel Properties Wizard. Click Next.
  4. On the Source Organization screen, the channel should be specified as an open channel. Click Next.
  5. Close the BizTalk Messaging Manager tool.
  6. Start the BizTalk Administration console.
  7. Expand the Microsoft BizTalk Server 2000 node, expand the BizTalk Server Group node, and expand the Receive Functions node.
  8. Right-click the Receive Functions node and select New and then File Receive Function from the shortcut menu.
  9. On the Add A File Receive Function dialog box opens, provide a name for the File receive function in the Name textbox.
  10. Provide a meaningful comment for the File receive function.
  11. Specify the server whereon the receive function will be hosted and run.
  12. Provide the file type in the File Types To Poll For textbox.
  13. Choose the location for polling.
  14. Click the Advanced button to define routing information.
  15. Select the Open Source option from the Openness drop-down list box.
  16. Specify the document definition.
  17. Select the Browse button under Source Selected
  18. Select the Organization qualifier.
  19. Select the Organization identifier value.
  20. Select the Browse button under Destination Selected.
  21. Select the Organization qualifier.
  22. Select the Organization identifier value.
  23. Click OK in the Advanced Receive Function Options dialog box.
  24. Click OK in the Add A File Receive Function dialog box.