Carlos Medina's Blog

I have listened many times, how can I get a message context property from a map?  Well, while I was playing with the framework of BizTalk Server 2006 RC I found the way to do a functoid that implements this functionality.  I’ll try to explain how I do it below.

First, I have to know three values:

Message Name: the name of the message that have the context property
Property Name: the name of the context property
Property Namespace: the namespace of the context property

Second, I need to get the segments of the service (orchestration) and check in each segment if the message that I’m looking for is there.  The messages aren’t stored directly in the service; the messages are stored in the segments that exist inside the orchestration.  Normally one orchestration has two segments and one more segment when the orchestration implements compensation; the message normally is stored in the second segment (I really don’t know why the segments exist, this is an internal architecture from Microsoft and there isn’t information about that).

Third, when I find the particular message I check the context property (formed by Property Name and Property Namespace) inside the message and return its value.

This is the code that I have used:

// set the property
string property = "";
// get the service
Microsoft.XLANGs.Core.Service s = Microsoft.XLANGs.Core.Service.RootService;
foreach (Microsoft.XLANGs.Core.Segment seg in s._segments)
{
// find the real name of the message
foreach (DictionaryEntry de in Microsoft.XLANGs.Core.Context.FindFields(typeof(Microsoft.XLANGs.BaseTypes.XLANGMessage), seg.ExceptionContext))
{
// check that the key ends with the name of the message
if (de.Key.ToString().EndsWith(val1))
{
// get the message as a XLANGMessage
Microsoft.XLANGs.Core.XMessage msg = de.Value as Microsoft.XLANGs.Core.XMessage;
// if the message was found, then I get the value of the property
if (msg != null)
{
// create a XmlQName instance
Microsoft.XLANGs.BaseTypes.XmlQName qName = new Microsoft.XLANGs.BaseTypes.XmlQName(val2, val3);
// find the message property in the message
if (msg.GetContextProperties().ContainsKey(qName))
{
// get the property from GetContextProperties
property = msg.GetContextProperties()[qName].ToString();
}
else if (msg.GetContentProperties().ContainsKey(qName))
{
// get the property from GetContentProperties
property = msg.GetContentProperties()[qName].ToString();
}
}
break;
}
}
if (property.Length > 0)
break;
}
// return the property value
return property;

Exception :(

Unfortunately this functoid ONLY works if it is invoked from an orchestration… I mean a map inside an orchestration.  The reason is simple, to access to Message I have to get the current context of the service and this service is represented by the orchestration, if the orchestration doesn’t exist I cann’t get the context.

You can download the functoid assembly from GetContextProperty Functoid Workspace

This functoid was developed with the framework of Microsoft BizTalk 2006 RC using the Microsoft.XLANGs.Engine.dll and Microsoft.XLANGs.BasTypes.dll assemblies.  I hope that this functionality exists in the RTM version.

Sometimes, in own orchestrations we need to know if a message context property exists inside one message in particular.  Well, the exists operator is useful in this situation.

The exists operator can be use in Filter expressions or Decide shapes.  The filter expression can determine if a message is welcome in the orchestration or not, and you can use the exists operator to allow messages that contain one or various message context property incoming to process.

But, if you need to take a decision about what way to follow when a message context property exists or not in the message you can use a Decide shape and the exists operator.  The syntax to exists operator is: PropertyName exists MessageName.

For example, if you need to know if the BTS.AckFailurecategory property is inside the message, you must use this expression: BTS.AckFailureCategory exists MessageIn

I have developed a new version of BTSEasyReflector.  This new version include the refactoring of the code (I tried to simplify the code), new icons to represent visually each biztalk artifact, and - at last - I added two new classes to write dynamically the properties of each artifact using reflection.

You can visit and download it from BTS Easy Reflector

Note this version was developed with VS .Net 2005 and BizTalk Server 2006 RC.  If you have any question or suggestion, pls send me it to carlos1254@hotmail.com

Microsoft has added new features and changed others in WMI provider to BizTalk Server 2006.  These features include:

• add two new class MSBTS_SendHandler2 and MSBTS_TrackedMessageInstance2
• remove the MSBTS_ServiceInstance.ServiceInstanceID property
• change the definition (properties and methods) of 7 classes

I show below the complete list of changes:

MSBTS_GroupSetting Class

Properties

(+) BizTalkOperatorGroup: Gets the name of the BizTalk Administrator Microsoft® Windows® NT® Group

MSBTS_Host Class

Methods

(+) Cluster: Clusters all BizTalk Host Instances of the given BizTalk Host

(+) GetClusterResourceGroupNames: Returns List of cluster resource groups available

(+) UnCluster: Un-Clusters all BizTalk Host Instances of the given BizTalk Host

MSBTS_HostInstance Class

Properties

(+) ClusterInstanceType: This property tells whether the BizTalk Host Instance NT service is clustered

MSBTS_HostSetting Class

Properties

(+) ClusterResourceGroupName: When the host instances of this host are clustered, this property contains the cluster resource group name set by the Administrator

(+) DBQueueSizeThreshold: Maximum number of items in the Database

(+) DBSessionThreshold: Maximum number of DB Sessions (per CPU) allowed before throttling begins

(+) DeliveryQueueSize: Size of the in-memory Queue that the host maintains as a temporary placeholder for delivering messages

(+) GlobalMemoryThreshold: Maximum System-wide Virtual Memory (in percent) usage allowed before throttling begins

(+) InflightMessageThreshold: Maximum number of in-memory in-flight messages allowed before throttling Message Delivery begins

(+) IsHost32BitOnly: This property indicates whether the host instance process should be created as 32-bit on both 32-bit and 64-bit servers

(+) MessageDeliverySampleSpaceSize: This property indicates the number of samples that are used for determining the rate of the Message Delivery to all Service Classes of the Host

(+) MessageDeliverySampleSpaceWindow: Time-window (in milliseconds) beyond which samples will be deemed invalid for consideration

(+) MessageDeliveryOverdriveFactor: Percent factor by which the system will overdrive the Input rate for Message Delivery Throttling

(+) MessageDeliveryMaximumDelay: Maximum Delay (in milliseconds) imposed for Message Delivery Throttling. Zero indicates disable Message Delivery Throttling

(+) MessagePublishSampleSpaceSize: Number of samples that are used for determining the rate of the Message Publishing by the Service Classes

(+) MessagePublishSampleSpaceWindow: Time-window (in milliseconds) beyond which samples will be deemed invalid for consideration

(+) MessagePublishOverdriveFactor: Percent Factor by which the system will overdrive the Input rate

(+) MessagePublishMaximumDelay: Maximum Delay (in milliseconds) imposed for Message Publishing Throttling. Zero indicates disable Message Publishing Throttling

(+) ThreadPoolSize: Maximum number of messaging engine threads per CPU

(+) ThreadThreshold: Maximum number of threads in the process (per CPU) allowed before throttling begins

(+) ProcessMemoryThreshold: Maximum Process Memory (in percent) allowed before throttling begins

MSBTS_ReceiveLocation Class

Properties

(+) EncryptionCert: Contains the Name of the certificate used for outbound encryption

(+) SendPipeline: Represents the name of the pipeline that will process outbound documents

(+) SendPipelineData: Contains the custom configuration data for the SendPipeline

MSBTS_ReceivePort Class

Properties

(+) RouteFailedMessage: Controls whether failed messages have to be routed to failed message subscribers

(+) MSBTS_SendHandler2 Class

Properties

(+) AdapterName: Contains the name of the adapter used by the given instance

(+) CustomCfg: Contains adapter-specific configuration in XML format

(+) HostName: Contains the name of the BizTalk Host for this transport handler

(+) HostNameToSwitchTo: Contains the name of the BizTalk Host that this transport handler should switch to

(+) IsDefault: Indicates whether the send handler is the default one for this adapter type

MSBTS_SendPort Class

Properties

(+) OrderedDelivery: Determines whether the port should send messages in an ordered manner

(+) StopSendingOnFailure: Controls how EPM handles failures for order delivery enabled send port's primary transport

(+) RouteFailedMessage: Controls whether failed messages have to be routed to failed message subscribers

MSBTS_ServiceInstance Class

Properties

(-) ServiceInstanceID: Contains the ID of the service instance to which this message belongs

(+) MSBTS_TrackedMessageInstance2 Class

Properties

(+) MessageInstanceID: Contains the ID of the message

(+) PartCount: Number of message parts

(+) SourceDBName: Name of the SQL database where the tracked message is stored

(+) SourceDBServerName: Name of the SQL Server where the tracked message is stored

Methods

(+) SaveToFile: This method saves message context and parts into multiple output files

(+) this feature has been added
(-) this feature has been removed

Note: this information was based on BTS 2006 RC documentation, thus, is possible that these features change in BTS 2006 RTM version.

Microsoft.BizTalk.Deployment.dll is an unsupported assembly provided by Microsoft, it is used to perform all actions related with the deployment of EAI solutions in BizTalk Server 2006 Beta 2.  This assembly provides classes to import, export, add and remove resources, register and unregister assemblies in the gac, and so on....

Additionally, with Microsoft.BizTalk.Deployment.dll you can extract the artifacts contained inside a biztalk assembly (.dll) using its classes and interfaces.  For example, if you want to know if a file is a biztalk assembly you can use this code:

if (BizTalkLatamAssembly.BtsAssemblyManager.IsBizTalkAssemblyByPath(pathBtsAssembly))
{
// crate an instance of BizTalkAssembly
Microsoft.BizTalk.Deployment.BizTalkAssembly biztalkAssembly = 
new Microsoft.BizTalk.Deployment.BizTalkAssembly();
biztalkAssembly.Load(pathBtsAssembly);
// create an instance of BtsAssemblyManager
Microsoft.BizTalk.Deployment.Assembly.BtsAssemblyManager btsAssemblyManager = 
new Microsoft.BizTalk.Deployment.Assembly.BtsAssemblyManager(pathBtsAssembly, biztalkAssembly);
// load the BtsAssembly from BtsAssemblyManager
Microsoft.BizTalk.Deployment.Assembly.btsAssembly = btsAssemblyManager.BtsAssembly;
}

Also, you can get the pipelines from a biztalk assembly using BtsAssembly class and IBizTalkOrchestration interface, see below:

IEnumerator listOfPipelines = btsAssembly.AssemblyMetaData.Pipelines;
listOfPipelines.Reset();
while (listOfPipelines.MoveNext())
{
Microsoft.BizTalk.Deployment.MetaDataOM.IBizTalkPipeline pipeline = listOfPipelines.Current 
as Microsoft.BizTalk.Deployment.MetaDataOM.IBizTalkPipeline;
System.Console.WriteLine("Pipeline name: " + pipeline.Name);
}

I wrote an easy sample called "BTS Easy Reflector" that uses the classes of Microsoft.BizTalk.Deployment.dll to show information about a biztalk assembly.  You can download it from "BTS Easy Reflector: Workspace home" and send me your feedback.

This information and project was developed with BizTalk Server 2006 Beta 2, thus, is possible that it doesn't work to final relase .

If you get the System.OutOfMemoryException exception when you map large messages, may be you need to read this kb "The BizTalk service restart unexpectly when you map large message in BizTalk Server 2004".  It explains the cause and possible solutions to solve this problem.

For more information go to http://support.microsoft.com/kb/913959

Microsoft.BizTalk.Databases.dll is an unsupported assembly in BizTalk Server framework.  It provides functionality to query the servers (SQL Server, Windows, Clusters, etc) and its database – if is a SQL Server - over the network.  To do it, this assembly exposes 5 classes: BizTalkDatabaseInfo, Database, DatabaseCollection, Server, y ServerCollection; and each class have its own properties and methods.

The use of these classes is very easy, in the following example I query the SQL Server that exists in my network using ServerCollection y Server.

foreach (string name in Microsoft.BizTalk.Databases.ServerCollection.GetSqlServerNames())
{
    Microsoft.BizTalk.Databases.Server server = new Microsoft.BizTalk.Databases.Server(name);
    System.Console.WriteLine("Server name: " + server.Name);
    System.Console.WriteLine("Platform Identifier: " + server.PlatformIdentifier.ToString());
    System.Console.WriteLine("Type: " + server.Type.ToString());
    System.Console.WriteLine("Version: " + server.Version.ToString());
}

Or, to query the databases in each SQL Server you can use the code that I show below.  In the example, I query each database in SQL Server and I ask if the database is a BizTalk Database:

Microsoft.BizTalk.Databases.Server server = new Microsoft.BizTalk.Databases.Server("server_name");
bool isBtsDb = true;
foreach (Microsoft.BizTalk.Databases.Database database in server.GetDatabaseCollection())
{
    System.Console.WriteLine("Database: " + database.Name);
    try
    {
        isBtsDb = database.IsBizTalkDatabase;
        if ( isBtsDb ) 
            System.Console.WriteLine("///// Begin - BizTalk Database ");
    }
    catch
    {
        isBtsDb = false;
    }
    System.Console.WriteLine("Is BizTalk database: " + isBtsDb.ToString());
    if (isBtsDb)
    {
        System.Console.WriteLine("BizTalk Db name: " + database.BizTalkDatabaseInfo.Name);
        System.Console.WriteLine("BizTalk Db version: " + database.BizTalkDatabaseInfo.Version.ToString());
        System.Console.WriteLine("BizTalk Db description: " + database.BizTalkDatabaseInfo.Description);
        System.Console.WriteLine("///// End - BizTalk Database ");
    }
}

The last functionality doesn’t work in Database class because when I ask if a database is a BizTalk Database using IsBizTalkDatabase property, Database class only checks for BizTalk Management DB and ignore another database.

Unfortunately, by this reason, you cannot use this property… I hope that Microsoft people can resolve this “issue” in the next version; it’ll be a great help.

If you have(had) any problem when you are(were) publishing orchestrations as Web Services... then you must read this article "You cannot call an orchestration that is exposed as a Web service on a server that is running BizTalk Server 2004"....

The article explains three symptoms, its causes and how we can resolve it.  As part of article, these are the symptoms explained:

Symptom 1

The following error messages are logged in the Application event log on the server that is running BizTalk Server 2004:

The Messaging Engine failed to register the adapter for "SOAP" for the receive location "/VirtualDirectory/Name.asmx". Please verify that the receive location is valid, and that the isolated adapter runs under an account that has access to the BizTalk databases.

An attempt to connect to "BizTalkMgmtDb" SQL Server database on server "Server" failed with error: "Cannot open database requested in login 'BizTalkMgmtDb'. Login fails.".

Symptom 2

On a remote server that is running BizTalk Server 2004, the following error message is logged in the Application event log when you call the orchestration that is exposed as a Web service:

The "SOAP" adapter is suspending an outbound message going to destination URL:"<http://VirtualDirectory/Name.asmx>". Details: "Server was unable to process request. --> File or assembly name FileName.dll, or one of its dependencies, was not found.".

When you call the orchestration that is exposed as a Web service from a client computer that is not running BizTalk Server 2004, you may receive an error message that is similar to the following:

SoapException: Internal SOAP Processing Failure

Symptom 3

The following error message is logged in the Application event log on the server on which the Web service is exposed:

There was a failure executing the receive pipeline:
"Microsoft.BizTalk.DefaultPipelines.XMLReceive" Source: "Microsoft.BizTalk.Messaging" Receive Location: "/VirtualDirectory/Name.asmx" Reason: Specified cast is not valid.