Things to remember with MSMQ Busadapter

Lohndorf — Tue, 15 Jul 2008 10:16:00 GMT

Thank you to the person who made me aware that the article here:

Misses out a couple of important things. So I will try to correct that here.

When you set up NAS to read from Microsoft Message Queues (MSMQ), using the MSMQ Bus Adapter as described in the article above, then you must remember these two things:

1) The label on any message you send to the queue, must be "Navision MSMQ-BA". Otherwise NAS will ignore them, and they will stay in the queue. This is a way to control which messages are intented for NAS. It is a hardcoded feature, and cannot be adjusted or changed or disabled.

2) Text in the messages must be in the format UTF-8. NAS (or any other NAV component) does not recognise UNICODE and any other format than UTF-8 can make the message unreadable.

So if everything else seems to be OK, but NAS still does not read messages from MSMQ, then check these two things.

Lars Lohndorf-Larsen

Microsoft Dynamics UK

Microsoft Customer Service and Support (CSS) EMEA

These postings are provided "AS IS" with no warranties and confer no rights. You assume all risk for your use.

Comcom and the Bus adapter

Lohndorf — Tue, 13 May 2008 11:21:00 GMT

This post is the second part of the post NAS Tutorial which is based on KB article 861762, previously published on PartnerSource. This post is an updated version, and available to a wider audience (no PartnerSource login required).

This post describes how to use NAV Communication Component (Comcom) and NAV Bus adapter. Comcom is designed to enhance communication between Navision and other applications, like a Web server, a BizTalk server or some other external system. What kind of communication takes place, is all down to the specific application (like Commerce Portal or Commerce Gateway). In this document, we will only look at the mechanisms of sending and receiving a document.

This post also shows how to create a very small application that can send a message to MS Message queue, and receive this message again.

=== Updated on July 15th ===

I was made aware of a couple of important additional things to remember when working with MSMQ Busadapter:

1) Messages sent to NAS must have the label "Navision MSMQ-BA"

2) Text in the messages must be in the format UTF-8. You cannot use UNICODE.

There are more details about this here.

=== End of Update ========

What is Comcom and Bus adapter?
Both Comcom and the bus adapter are automation servers developed by Microsoft for NAV. Comcom is a general communication component. All it does, is sending and receiving messages. You need to use a bus adapter with Comcom. The bus adapter is specific to the media used to transport the messages that Comcom sends and receive. At the moment there are two bus adapters: One for MS Message queue, and one for Named Pipes. In this document we will use the bus adapter for MS Message queue (MSMQ).

The reason for having Comcom as well as a bus adapter is, that you can create your application using Comcom without being concerned about what the transport media is going to be. When you decide on that / or if you want to change the media used, it will only require small changes – the application itself would need only very minor changes.

Prerequisites
NAV communication components come as part of SDK (Devkit) on the product CD. This needs to be installed before you start. And, you need to have MSMQ installed (installs as part of Windows).

First, create a new queue in MSMQ: Open Computer Management, expand "Services and Applications", and you should see "Message Queuing" here, if MSMQ is installed. Expand "Message Queuing", and then expand "Private Queues". Note that the MSMQ Busadapter is only tested with private queues, and is unlikely to work with public queues.

Rightclick on "Private Queues", select New -> Private Queue, and enter a name. Let's call it MuQueue. Also note that MSMQ Busadapter has not been tested for Transactional queues, so leave the field "Transactional" blank.

Now you have the queue, and the rest is up to NAV to send a message into this queue.

So, in NAV, create a new codeunit. First we need do declare the following variables to get access to Comcom:
Name          Type          Subtype
Comcom    Automation 'Navision Communication Component version 2'.CommunicationComponent
ComOut      Automation 'Navision Communication Component version 2'.OutMessage
OutStr        Outstream
All automation variables need to be initialised before they can be used. Type these two lines to initialise Comcom and ComOut:

CREATE(Comcom);
ComOut := Comcom.CreateoutMessage('Message queue://');

'Message queue://' is the actual word Message queue. We need to tell Comcom to send the message in a format for Microsoft Message queue. But this is the only reference to the media (until we get to the bus adapter).

Remember, Comcom has only one purpose: Sending / receiving messages. It is for writing the actual message that we want to send that we need OutStr. OutStr will contain the message, and Comcom will send it.

To associate Comcom with OutStr, add this line:

OutStr := ComOut.GetStream;

Then, compose the message using OutStr:
OutStr.WRITE('This is my message.');

Once the message is done, we just need to send it. Send it in this way:
ComOut.Send(0);

That’s the application done. Finally, we just need to add our bus adapter, which needs to be specific to what transport media we are using - in this case MSMQ.
Add one more global variable:
Name Type Subtype
MQBus Automation 'Navision MS-Message Queue Bus Adapter'.MSMQBusAdapter

To “plug in” the bus adapter, type in these lines at the beginning of the codeunit:

create(MQBus);
MQBus.OpenWriteQueue('My-pc2\Myqueue',0,0);
// On Win2000, use MQBus.OpenWriteQueue('.\private$\Myqueue',0,0);
Comcom.AddBusAdapter(MQBus,0);

Your final codeunit should now look like this:

OnRun()
CREATE(Comcom);

CREATE(MQBus);
MQBus.OpenWriteQueue('My-pc2\Myqueue',0,0);
Comcom.AddBusAdapter(MQBus,0);

ComOut := Comcom.CreateoutMessage('Message queue://');
OutStr := ComOut.GetStream;
OutStr.WRITE('This is my message.');

ComOut.Send(0);

To test is, try to run it, then look the queue and see if the message was sent.

Next, we want to receive this message.
Receiving a message

Create a new codeunit with these variables:

Name      Datatype    SubType
Comcom Automation Navision Communication Component version 2'.CommunicationComponent
InMsg     Automation 'Navision Communication Component version 2'.InMessage
InStr       InStream
MSMQBus Automation 'Navision MS-Message Queue Bus Adapter'.MSMQBusAdapter
Line       Text           250

Highlight the Comcom variable, go to properties, and set the property WithEvents to Yes. This will create a new trigger called:
Comcom::MessageReceived(VAR InMessage : Automation "''.IDISPATCH")

This trigger will automatically run whenever there is a new message in the queue.

The finished codeunit should look like this:

OnRun()
CREATE(Comcom);
CREATE(MSMQBus);
MSMQBus.OpenReceiveQueue('nuk-cp\private$\lll',1,1);
Comcom.AddBusAdapter(MSMQBus,1);

Comcom::MessageReceived(VAR InMessage : Automation "''.IDISPATCH")
InMsg := InMessage;
InStr := InMsg.GetStream;
InStr.READTEXT(Line);
MESSAGE(Line);

Go to Codeunit Properties, and set the property SingleInstance to Yes. Now, you can either run it from the object designer, or you set up NAS to run this codeunit.