Notice: This website is an unofficial Microsoft Knowledge Base (hereinafter KB) archive and is intended to provide a reliable access to deleted content from Microsoft KB. All KB articles are owned by Microsoft Corporation. Read full disclaimer for more details.

How to apply maps and custom ACK codes to ACK messages in BizTalk Server 2013


View products that this article applies to.

Symptoms

Issue 1

Consider the following scenario:

  • You are using Microsoft BizTalk 2013 Accelerator for HL7 (BTAHL7).
  • You are using the MLLP receive adapter and the HL7 receive pipeline in a two-way receive port.
  • In MLLP Transport Properties, you set the Use Direct Synchronous HL7 ACK option to "True."
  • You create an outbound map on this two-way receive port to transform the ACK message before it is sent.

In this scenario, the outbound map is not applied to the HL7 ACK. Therefore, the ACK is not transformed.

Issue 2

The MLLP send port examines the ACK code in the ACK message (MSA.1_AcknowledgmentCode field of MSA segment) that is returned by the downstream system, and then compares the ACK with the Acceptable ACK codes that are set in the MLLP send port configuration properties. The currently acceptable ACK codes that are supported by the MLLP send port are AA, CA, AE, CE, AR, and CR. You can select all ACK codes or a combination of codes. For example, the following codes are all valid:

AA and CA

AA, CA, AE, and CE

AA, CA, AR, and CR
However, you cannot enter the desired acceptable ACK code combination.

After you apply this hotfix, a new acceptable ACK code that is named Custom is added to the Acceptable ACK Codes list. Additionally, a new text box is added to let you enter the acceptable custom ACK codes.

Notes
  • You must separate the codes by using a comma (,). For example: "AE,CE,AR,CR,XX,ZZ."
  • If one of the standard (noncustom) combinations is selected, you do not have to enter the Acceptable Custom ACK Codes property.
  • To make sure that the pipeline validation succeeds in regards to the custom ACK codes, you have to add the required custom ACK codes to corresponding ACK schema.
  • You can use the BizTalk Tracking feature (by enabling tracking) to track the message by using the MessageID that is logged to the event log when the message is retried or suspended.

↑ Back to the top


Resolution

A supported hotfix is available from Microsoft. However, this hotfix is intended to correct only the problem that is described in this article. Apply this hotfix only to systems that are experiencing this specific problem.

If the hotfix is available for download, there is a "Hotfix Download Available" section at the top of this Knowledge Base article. If this section does not appear, submit a request to Microsoft Customer Service and Support to obtain the hotfix.

Note If additional issues occur or if any troubleshooting is required, you might have to create a separate service request. The usual support costs will apply to additional support questions and issues that do not qualify for this specific hotfix. For a complete list of Microsoft Customer Service and Support telephone numbers or to create a separate service request, visit the following Microsoft website: Note The "Hotfix Download Available" form displays the languages for which the hotfix is available. If you do not see your language, it is because a hotfix is not available for that language.


Make sure that you deploy the required Outbound Map .dll file, and then install the file to the global assembly cache (GAC) by using the following properties:
  • OutboundMap Assembly Name

    This property must include the full name of the assembly in which the outbound map is hosted. You can locate this information in the properties of the map in the BizTalk Server Admin console. This information describes the assembly and also the complete name that is required for OutboundMap Name.

    For example: Outbound, Version=1.0.0.0, Culture=neutral, PublicKeyToken=83f92b3673c9005d
  • OutboundMap Name

    This property must include the full the map name. This includes the namespace. You can locate this information in the properties of the *.btm file (Namespace.TypeName).

    For example: Outbound.Map1
Note These properties are applied only if Direct Synchronous HL7 ACK is set to "True."

You might not require the HL7 Disassembler (DASM) in the HL7 Receive pipeline to automatically generates HL7 acknowledgements. For example, the ACK that is generated by some downstream system is to be handed to an upstream system. In this case, turn off "Route ACK to send pipeline on Request Receive port" for the source party, and set Use Direct Synchronous HL7 ACK to "False." Then, use the outbound map option that is provided in the receive port.

For Issue 1

You cannot track the ACK that is sent to the upstream system by having Use Direct Synchronous HL7 ACK set to "True." However, if you want to track the content of the ACK that is transmitted to the upstream system, you can use the same tracking mechanism that was used to track the ACK that was sent by a two-way receive port to the upstream system in the absence of the Use Direct Synchronous HL7 ACK setting. This assumes that the same map is used in the MLLP Receive location configuration properties and also in the standard Outbound Map feature in the receive port setting that is provided by BizTalk Server. 

For Issue 2

After you install the hotfix, the behavior will be based on the Acceptable ACK code that you select in the drop-down list instead of the code that is provided by the downstream system. 

If the ACK code is listed under the selected acceptable code, the message processing succeeds and the processing runs again for standard ACK codes that are not listed in the selected Acceptable ACK Codes and in case of nonstandard ACK codes that are not listed in the selected Acceptable ACK Codes, message is suspended.

Note If the downstream system returns AA or CA codes, message processing always succeeds regardless of any acceptable ACK code option that is set in the port configuration.

The ACK schema must be modified by adding the acceptable custom ACKs. If the additional custom ACKs are not added to the schema, the pipeline validation fails and returns a “table value not found” error message. Any additional acceptable custom ACKs must be added to the MSA.1_AcknowledgementCode existing list of ACKs.

↑ Back to the top


More Information

Prerequisites to install the software update

To apply this hotfix, you must have the following software installed:

Restart requirements

You do not have to restart the computer after you apply this hotfix. However, we recommend that you close and reopen the BizTalk Admin console after the hotfix is installed. 
File information
The English version of this hotfix has the file attributes (or later file attributes) that are listed in the following table. The dates and times for these files are listed in Coordinated Universal Time (UTC). When you view the file information, it is converted to local time. To find the difference between UTC and local time, use the Time Zone tab in the Date and Time item in Control Panel.

File nameFile versionFile sizeDateTimePlatform
Microsoft.Solutions.BTAHL7.HL72fDasm.dll3.10.325.2107,520 09-Feb-201522:52x86
Microsoft.Solutions.BTAHL7.PipelineCommon.dll3.10.325.295,232 09-Feb-201522:52x86
Microsoft.Solutions.BTAHL7.Shared.dll3.10.325.299,328 09-Feb-201522:52x86
Microsoft.Solutions.BTAHL7.MLLP.dll3.10.325.2128,000 09-Feb-201522:52x86
Microsoft.Solutions.BTAHL7.HL7AckHelper.dll3.10.325.229,696 09-Feb-201522:52x86


↑ Back to the top


Status

Microsoft has confirmed that this is a problem in the Microsoft products that are listed in the "Applies to" section.

↑ Back to the top


References

For more information about BizTalk Server hotfixes, see Information about BizTalk Server hotfixes .

For more information about software update terminology, see Description of the standard terminology that is used to describe Microsoft software updates .

Third-party information disclaimer
The third-party products that this article discusses are manufactured by companies that are independent of Microsoft. Microsoft makes no warranty, implied or otherwise, about the performance or reliability of these products.

↑ Back to the top


Keywords: kbautohotfix, kbqfe, kbhotfixserver, kbfix, kbsurveynew, kbexpertiseadvanced, kb

↑ Back to the top

Article Info
Article ID : 3025503
Revision : 1
Created on : 1/7/2017
Published on : 5/26/2015
Exists online : False
Views : 334