Custom Pipeline to Add DocType in Message

Sometimes we require to add some element, tag, DocType in incoming or outgoing message from BizTalk. We can achieve this by using custom pipeline. But we should use this pipeline component in Decode or encode stage of Pipeline.

In this sample custom pipeline, we convert the message in string. So you can take this code and change according your business requirement.

Below link is defined for Custom Pipeline setup details

https://vkbiztalk.com/2017/08/04/custom-pipeline/

Here in this sample code I have added DocType on header of message when sending the message to send port. DocType will defined at design time when consume this pipeline component on encode stage on send pipeline.

using System;

using System.IO;

using System.Text;

using System.Drawing;

using System.Resources;

using System.Reflection;

using System.Diagnostics;

using System.Collections;

using System.ComponentModel;

using Microsoft.BizTalk.Message.Interop;

using Microsoft.BizTalk.Component.Interop;

using Microsoft.BizTalk.Component;

using Microsoft.BizTalk.Messaging;

using System.IO;

using System.Xml;

 

namespace BizTalk.Custom.PipelineComponents

{

[ComponentCategory(CategoryTypes.CATID_PipelineComponent)]

[ComponentCategory(CategoryTypes.CATID_Any)]

[System.Runtime.InteropServices.Guid(“CB814714-BC81-4BDA-B361-69CA270997E8”)]

public class AddDocFileName : IBaseComponent, IComponentUI, Microsoft.BizTalk.Component.Interop.IComponent, IPersistPropertyBag

{

#region Configuration Properties

private string _DocTypeName;

public string DocTypeName

{

get

{

return _DocTypeName;

}

set

{

_DocTypeName = value;

}

}

#endregion

public string Description

{

get

{

return “Pipeline component To Add DocType in Outgoing XML”;

}

}

public string Name

{

get

{

return “AddDocNameinXML”;

}

}

public string Version

{

get

{

return “1.0.0.0”;

}

}

public IntPtr Icon

{

get

{

return new System.IntPtr();

}

}

public System.Collections.IEnumerator Validate(object projectSystem)

{

return null;

}

public void GetClassID(out Guid classID)

{

classID = new Guid(“CB814714-BC81-4BDA-B361-69CA270997E8”);

}

public void InitNew()

{

}

public virtual void Load(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, int errlog)

{

object val = null;

val = this.ReadPropertyBag(pb, “DocTypeName”);

if ((val != null))

{

this._DocTypeName = ((string)(val));

}

}

public virtual void Save(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, bool fClearDirty, bool fSaveAllProperties)

{

this.WritePropertyBag(pb, “DocTypeName”, this.DocTypeName);

}

#region utility functionality

/// <summary>

/// Reads property value from property bag

/// </summary>

/// <param name=”pb”>Property bag</param>

/// <param name=”propName”>Name of property</param>

/// <returns>Value of the property</returns>

private object ReadPropertyBag(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, string propName)

{

object val = null;

try

{

pb.Read(propName, out val, 0);

}

catch (System.ArgumentException)

{

return val;

}

catch (System.Exception e)

{

throw new System.ApplicationException(e.Message);

}

return val;

}

/// <summary>

/// Writes property values into a property bag.

/// </summary>

/// <param name=”pb”>Property bag.</param>

/// <param name=”propName”>Name of property.</param>

/// <param name=”val”>Value of property.</param>

private void WritePropertyBag(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, string propName, object val)

{

try

{

pb.Write(propName, ref val);

}

catch (System.Exception e)

{

throw new System.ApplicationException(e.Message);

}

}

#endregion

public IBaseMessage Execute(IPipelineContext pContext, IBaseMessage pInMsg)

{

IBaseMessagePart bodyPart = pInMsg.BodyPart;

XmlDocument xDoc = new XmlDocument();

if (bodyPart != null)

{

Stream originalStream = bodyPart.GetOriginalDataStream();

string originalDataString;

try

{

//fetch original message

Stream originalMessageStream = bodyPart.GetOriginalDataStream();

byte[] bufferOriginalMessage = new byte[originalMessageStream.Length];

originalMessageStream.Read(bufferOriginalMessage, 0, Convert.ToInt32(originalMessageStream.Length));

originalDataString = System.Text.ASCIIEncoding.ASCII.GetString(bufferOriginalMessage);

}

catch (Exception ex)

{

ex.Source = “AddDocTypePipelineComponent”;

throw ex;

}

XmlDocument originalMessageXml = new XmlDocument();

if (originalStream != null)

{

originalDataString = originalDataString.Remove(0, 41);

originalDataString = @”<?xml version=’1.0′ encoding=’UTF-8′?>” + DocTypeName + originalDataString;

byte[] outBytes = System.Text.Encoding.ASCII.GetBytes(originalDataString);

MemoryStream memStream = new MemoryStream();

memStream.Write(outBytes, 0, outBytes.Length);

memStream.Position = 0;

bodyPart.Data = memStream;

pContext.ResourceTracker.AddResource(memStream);

 

}

}

return pInMsg;

}

}

}

 

Sample Input File:

<?xml version=”1.0″ encoding=”UTF-8″?>

<Test xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema“><Name> </Name></Test>

Sample Output File:

<?xml version=”1.0″ encoding=”UTF-8″?>

<!DOCTYPE Test SYSTEM “http://localhost/Test/DTD/TestDocType.dtd”&gt;

<Test xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema“><Name> </Name></Test>

 

 

 

Advertisements

BAM Activity in Custom Pipeline

Sometimes requirement cannot be fulfil by using tracking profile editor for BAM logging. Here in this code I am explaining about how to use BAM in custom pipeline. And also I am using EnableContinuation method so that we can get all the details in single row in BAM table while using different stage of BAM tracking in BizTalk application. When a solution needs BAM, and you what to link the receivedTime and sendTime together you have to use continuation.

Code for BAM Activity in Custom Pipeline:

Begin BAM Activity

This custom pipeline component can be put after xml or flat dissembler pipeline component in Receive Pipeline, because we are consuming MessageType context property to log into BAM.

For creating BAM Definition Activity please click here

https://vkbiztalk.com/2017/06/14/implementation-of-bam-activity-definition-file/

 

using System;

using System.IO;

using System.Text;

using System.Drawing;

using System.Resources;

using System.Reflection;

using System.Diagnostics;

using System.Collections;

using System.ComponentModel;

using Microsoft.BizTalk.Message.Interop;

using Microsoft.BizTalk.Component.Interop;

using Microsoft.BizTalk.Component;

using Microsoft.BizTalk.Messaging;

using System.IO;

using System.Xml;

using Microsoft.BizTalk.Bam.EventObservation;

namespace BeginBAMPipeline

{

[ComponentCategory(CategoryTypes.CATID_PipelineComponent)]

[ComponentCategory(CategoryTypes.CATID_Any)]

[System.Runtime.InteropServices.Guid(“3BB6433B-CF8D-456B-AA78-70D6788C8574”)]

public class BeginBAMPipelineComponent : IBaseComponent, IComponentUI, Microsoft.BizTalk.Component.Interop.IComponent, IPersistPropertyBag

{

#region Configuration Properties

private string _BAMActivityName;

private bool _IsTrackingRequire;

public string BAMActivityName

{

get

{

return _BAMActivityName;

}

set

{

_BAMActivityName = value;

}

}

 

public bool IsTrackingRequire

{

get

{

return _IsTrackingRequire;

}

set

{

_IsTrackingRequire = value;

}

}

 

#endregion

public string Description

{

get

{

return “Pipeline component For Begin BAM Activity”;

}

}

 

public string Name

{

get

{

return “BeginBAMPipelineComponent”;

}

}

public string Version

{

get

{

return “1.0.0.0”;

}

}

public IntPtr Icon

{

get

{

return new System.IntPtr();

}

}

public System.Collections.IEnumerator Validate(object projectSystem)

{

return null;

}

public void GetClassID(out Guid classID)

{

classID = new Guid(“3BB6433B-CF8D-456B-AA78-70D6788C8574”);

}

public void InitNew()

{

}

public virtual void Load(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, int errlog)

{

object val = null;

val = this.ReadPropertyBag(pb, “BAMActivityName”);

if ((val != null))

{

this._BAMActivityName = ((string)(val));

}

val = this.ReadPropertyBag(pb, “IsTrackingRequire”);

if ((val != null))

{

this._IsTrackingRequire = ((bool)(val));

}

}

public virtual void Save(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, bool fClearDirty, bool fSaveAllProperties)

{

this.WritePropertyBag(pb, “BAMActivityName”, this.BAMActivityName);

this.WritePropertyBag(pb, “IsTrackingRequire”, this.IsTrackingRequire);

}

#region utility functionality

/// <summary>

/// Reads property value from property bag

/// </summary>

/// <param name=”pb”>Property bag</param>

/// <param name=”propName”>Name of property</param>

/// <returns>Value of the property</returns>

private object ReadPropertyBag(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, string propName)

{

object val = null;

try

{

pb.Read(propName, out val, 0);

}

catch (System.ArgumentException)

{

return val;

}

catch (System.Exception e)

{

throw new System.ApplicationException(e.Message);

}

return val;

}

 

/// <summary>

/// Writes property values into a property bag.

/// </summary>

/// <param name=”pb”>Property bag.</param>

/// <param name=”propName”>Name of property.</param>

/// <param name=”val”>Value of property.</param>

private void WritePropertyBag(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, string propName, object val)

{

try

{

pb.Write(propName, ref val);

}

catch (System.Exception e)

{

throw new System.ApplicationException(e.Message);

}

}

#endregion

public IBaseMessage Execute(IPipelineContext pContext, IBaseMessage pInMsg)

{

IBaseMessagePart bodyPart = pInMsg.BodyPart;

StringBuilder outputMessageText = null;

XmlDocument xDoc = new XmlDocument();

 

string systemPropertiesNamespace = @”http://schemas.microsoft.com/BizTalk/2003/system-properties&#8221;;

//string messageType = “”;

if (bodyPart != null)

{

if (IsTrackingRequire)

{

Stream originalStream = bodyPart.GetOriginalDataStream();

 

if (originalStream != null)

{

string ActivityName = BAMActivityName;

string messageType = Convert.ToString(pInMsg.Context.Read(“MessageType”, systemPropertiesNamespace));

 

EventStream BAMes;

 

BAMes = pContext.GetEventStream();

 

string ActivityID = Guid.NewGuid().ToString();

string corelationToken = (string)pInMsg.Context.Read(“InterchangeID”, “http://schemas.microsoft.com/BizTalk/2003/system-properties&#8221;);

 

System.Diagnostics.EventLog.WriteEntry(“InterchangeIDStart”, corelationToken);

BAMes.BeginActivity(ActivityName, ActivityID);

BAMes.UpdateActivity(ActivityName, ActivityID, “MessageType”, messageType);

BAMes.UpdateActivity(ActivityName, ActivityID, “StartTime”, DateTime.Now);

 

BAMes.UpdateActivity(ActivityName, ActivityID, “Status”, “START”);

 

BAMes.EnableContinuation(ActivityName, ActivityID, corelationToken);

 

BAMes.EndActivity(ActivityName, ActivityID);

 

BAMes.Flush();

}

}

}

return pInMsg;

}

}

}

END Bam Activity:

This custom pipeline component can be used in any stage at in send pipeline.

using System;

using System.IO;

using System.Text;

using System.Drawing;

using System.Resources;

using System.Reflection;

using System.Diagnostics;

using System.Collections;

using System.ComponentModel;

using Microsoft.BizTalk.Message.Interop;

using Microsoft.BizTalk.Component.Interop;

using Microsoft.BizTalk.Component;

using Microsoft.BizTalk.Messaging;

using System.IO;

using System.Xml;

using Microsoft.BizTalk.Bam.EventObservation;

 

 

namespace EndBAMPipeline

{

[ComponentCategory(CategoryTypes.CATID_PipelineComponent)]

 

[ComponentCategory(CategoryTypes.CATID_Any)]

 

[System.Runtime.InteropServices.Guid(“3AC1B310-C4DF-4732-8AA9-2808349CEFFA”)]

public class EndBAMComponent : IBaseComponent, IComponentUI, Microsoft.BizTalk.Component.Interop.IComponent, IPersistPropertyBag

{

#region Configuration Properties

private string _BAMActivityName;

private bool _IsTrackingRequire;

 

public string BAMActivityName

{

get

{

return _BAMActivityName;

}

set

{

_BAMActivityName = value;

}

}

 

public bool IsTrackingRequire

{

get

{

return _IsTrackingRequire;

}

set

{

_IsTrackingRequire = value;

}

}

#endregion

 

#region IBaseComponent members

public string Description

{

get

{

return “Pipeline component For End BAM Activity”;

}

}

 

public string Name

{

get

{

return “EndBAMPipelineComponent”;

}

}

public string Version

{

get

{

return “1.0.0.0”;

 

}

 

}

#endregion

 

public IntPtr Icon

{

get

{

return new System.IntPtr();

 

}

}

public System.Collections.IEnumerator Validate(object projectSystem)

{

return null;

}

 

#region IPersistPropertyBag members

public void GetClassID(out Guid classID)

{

classID = new Guid(“3AC1B310-C4DF-4732-8AA9-2808349CEFFA”);

}

public void InitNew()

{

}

public virtual void Load(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, int errlog)

{

object val = null;

val = this.ReadPropertyBag(pb, “BAMActivityName”);

if ((val != null))

{

this._BAMActivityName = ((string)(val));

}

val = this.ReadPropertyBag(pb, “IsTrackingRequire”);

if ((val != null))

{

this._IsTrackingRequire = ((bool)(val));

}

}

public virtual void Save(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, bool fClearDirty, bool fSaveAllProperties)

{

this.WritePropertyBag(pb, “BAMActivityName”, this.BAMActivityName);

this.WritePropertyBag(pb, “IsTrackingRequire”, this.IsTrackingRequire);

 

}

#endregion

 

#region utility functionality

/// <summary>

/// Reads property value from property bag

/// </summary>

/// <param name=”pb”>Property bag</param>

/// <param name=”propName”>Name of property</param>

/// <returns>Value of the property</returns>

private object ReadPropertyBag(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, string propName)

{

object val = null;

try

{

pb.Read(propName, out val, 0);

}

catch (System.ArgumentException)

{

return val;

}

catch (System.Exception e)

{

throw new System.ApplicationException(e.Message);

}

return val;

}

 

/// <summary>

/// Writes property values into a property bag.

/// </summary>

/// <param name=”pb”>Property bag.</param>

/// <param name=”propName”>Name of property.</param>

/// <param name=”val”>Value of property.</param>

private void WritePropertyBag(Microsoft.BizTalk.Component.Interop.IPropertyBag pb, string propName, object val)

{

try

{

pb.Write(propName, ref val);

}

catch (System.Exception e)

{

throw new System.ApplicationException(e.Message);

}

}

#endregion

public IBaseMessage Execute(IPipelineContext pContext, IBaseMessage pInMsg)

{

IBaseMessagePart bodyPart = pInMsg.BodyPart;

StringBuilder outputMessageText = null;

string systemPropertiesNamespace = @”http://schemas.microsoft.com/BizTalk/2003/system-properties&#8221;;

if (bodyPart != null)

{

if (IsTrackingRequire)

{

Stream originalStream = bodyPart.GetOriginalDataStream();

if (originalStream != null)

{

string ActivityName = BAMActivityName;

string messageType = Convert.ToString(pInMsg.Context.Read(“MessageType”, systemPropertiesNamespace));

EventStream BAMes;

BAMes = pContext.GetEventStream();

string ActivityID = “seq_” + Guid.NewGuid().ToString();

string corelationToken = (string)pInMsg.Context.Read(“InterchangeID”, “http://schemas.microsoft.com/BizTalk/2003/system-properties&#8221;);

System.Diagnostics.EventLog.WriteEntry(“InterchangeIDEND”, corelationToken);

BAMes.UpdateActivity(ActivityName, corelationToken, “EndTime”, DateTime.Now);

BAMes.UpdateActivity(ActivityName, corelationToken, “Status”, “SUCCESS”);

BAMes.EndActivity(ActivityName, corelationToken);

BAMes.Flush();

}

}

}

return pInMsg;

}

}

}

 

You can see the BAM table or BAM Portal in one row start time and end time of message in BizTalk along with status and messagetype.