BizTalk Mapper vs Attributes with Defaults….Schema Elements with an attribute having a default value are ALWAYS generated

 

‘Challenge’:

Schema Elements with an attribute having a default value are ALWAYS generated, this is because of the default mapping behavior.

Structure of this post:

What is the problem

Attributes with a Default Value are generated even though the element is optional. Consider this schema, which has an Data element.

image

The element ‘OptionalAttributeDefault’ is optional (minoccurs:0) and has an attribute with a Default value: ‘LINUX’

image

The element ‘RequiredAttributeDefault’ is mandatory (minoccurs:1) and has an attribute with a Default value: ‘CAT141.12’

image

The element ‘RequiredDefaultValue’ is mandatory (minoccurs:1) and has a default value: ‘Test’

image

When we execute the map which does not map the ‘Data’ element like this:

image

The XML output generated is:

<ns0:Destination xmlns:ns0="http://AttributeTest.Schema2">
    <Name>Name_0</Name>
    <ID>ID_0</ID>
    <Data>
        <OptionalAttributeDefault Type="LINUX"></OptionalAttributeDefault>
        <RequiredAttributeDefault Type="CAT141.12"></RequiredAttributeDefault>
        <RequiredDefaultValue>Test</RequiredDefaultValue>
    </Data>
</ns0:Destination>

Issue: All [DATA] elements are generated, optional elements with an attribute default as well

 

Why is this

This is because the .btm file is configured with a behavior to always generate the default values, even for optional elements.

Although we can state that the default values have to be removed, that is not always possible. I came across this issue when implementing UBL (from OASIS).

 

How to overcome this

We can overcome this be altering the behavior of the map, this can be done by opening the .BTM file and navigate to the attribute: ‘GenerateDefaultFixedNodes’, which is default “YES”.

Before making any changes, we have to understand which options there are:

  • GenerateDefaultFixedNodes=”Yes” : default behavior
  • GenerateDefaultFixedNodes=”” : this will generate no elements if the attribute has a value, even when the element is mandatory!

Note: you can set the value to whatever (no, false, etc) however when you save the map it will become “”

Example result:

<sns0:Destination xmlns:ns0="http://AttributeTest.Schema2">
  <Name>Name_0</Name>
  <ID>ID_0</ID>
</ns0:Destination>

Issue: No [DATA] element is generated

  • GenerateDefaultFixedNodes=”RequiredDefaults” : this will generate elements with minoccurs=1 in case it has attributes with a default value

Example result:

<ns0:Destination xmlns:ns0="http://AttributeTest.Schema2">
    <Name>Name_0</Name>
    <ID>ID_0</ID>
    <Data>
        <RequiredDefaultValue>Test</RequiredDefaultValue>
    </Data>
</ns0:Destination>

Issue: results are still not valid (Required elements with default attribute value are not created, thus validation fails

 

This means that even though you can configure the behavior of the mapping there is no perfect solution. You either have:

  • to modify the default values and use the default behavior
  • have to ensure that elements/attributes are set (you can not rely on any of the default attributes anymore since elements are not created)

 

Since this is quite important, I’ve created a sample project that has a map for each setting, and a readme.txt with information about the results.

In the next post I will explain how to change the ‘template’ used when creating maps.

HTH,

Sander Nefs

 

Comments

Post a Comment

Popular posts from this blog

Azure implementation guidelines

In My post ‘ Service Bus Management ’ I pointed out a way of implementing a DTAP strategy for managing the Service Bus environment. There’s now a great post available from Microsoft which goes into more detail about other aspects of managing the Azure subscriptions and other artefacts which is quite useful when setting up your Azure environments. Follow this link to the ‘Azure Implementation Guidelines’ HTH, Sander
Read more

UK Connected Systems User Group – BizTalk Services questions

This Wednesday I’m attending the CSUG – The Hybrid Organisation (sold out!). During my evaluation of several Integration products (BizTalk / BizTalk Services / Neuron ESB / MuleESB) I had some concerns/questions on BizTalk Services. My goal is to get answers on the following scenario a) I receive a HTTP Post with an Xml Body payload b) This contains a signature which i need to validate c) Transform the Xml body payload to another Xml message d) Perform a HTTP Post with the new Xml message to an external HTTP url and sign the message e) Route the response back, similar to the aforementioned steps, where an error needs to be mapped to a dedicated error response Challenges I'm wondering how to cope with some of the following challenges in this scenario, and would like to know resource information available which addresses some of these challenges; Validating / Signing of messages A requirement is to validate the incoming message by inspecting an signature in the message
Read more

Setting up a build server with the BizTalk Deployment Framework

Image
This chapter describes the steps to a TFS Build Server to set up BizTalk deployment with the following functionality: • Build solution • Perform unit testing Using BizUnit • Create Deployment Packages Using BDTF • Deploy to Server Using R packages created in previous step • Create documentation BizTalkDocumenter For this the following steps are required: • Installation Components (30 min) • Configuring a build account (30 min) • Setting up the build service (30 min) • Scrum template installation (30 min) • Share for the build output directory (10 min) • Adjustments Build Template for use BTDF (30 min) • Design of build definitions (60 min) • Setting BTDF (60 min) • Use BTDF • Build execution / scheduling UPDATE (21-06-2013) - When using sharedassemblies, the following URL is a big help http://mohamedradwan.wordpress.com/2013/01/31/set-custom-assemblies-path-for-host-build-service-on-the-cloud/ - For viewing the basic instructions a video is available on the following blog http:
Read more