Skip to Content
Ask any PI developer about favorite mapping, the answer for sure would be Message Mapping. Still sometimes our favorite message mapping seem to be helpless due to its fixed target structure definition and we are forced to use java/xsl mappings or do something at adapter level for the desired output. For example you can visit some of these threads – Pass value to the node, Removing ns0 from namespace, XSLT for dynamic target field names, Add namespace in message mapping, JAVA/XSLT mapping to create SOAP envelope

Perhaps there may be many ways to manage all the above requirements but sometimes it becomes like using a cannon to kill a fly! So here we go with our favorite message mapping and see how to play around with tag name, occurrence, namespace and prefix at target side. Also we will try to pass value to structure node, seems weird? Let’s see how it is possible with simple user defined function.

In first step to access target field in udf, we take help of getParameter method of Container with parameter STRUCTURE_NODE that returns access to target field/node to which the UDF is being directly mapped to. The node needs to be type casted to structure/leaf as per the type of target field.

  • StructureNode node = ((StructureNode) container.getParameter(“STRUCTURE_NODE”));

          Applicable to fields having child or sub-fields.

  • LeafStructureNode node = ((LeafStructureNode)container.getParameter(“STRUCTURE_NODE”));

          Applicable to fields having no child or sub-fields.

Next step involves using node methods as per the requirements.

  • String getQName()

          Return the name of target field.

  • void setQName(String newName)

          Set the target field name with input parameter newName.

  • void setNSDeclarations(String decl)

          Set the namespace declaration and attribute with input parameter decl.

          e.g decl = ” attribute1=\”a1\” attribute2=\”a2\” xmlns:prefix=\”namespace1\””

  • void setOccurances(int min, int max)

          Set the occurrence of target field with input parameter min and max.

  • void setPreValue(String prevalue)

          Add the string prevalue unescaped just after start tag of target field. Applicable only for structure field.

  • void setPostValue(String postvalue)

          Add the string postvalue unescaped just before end tag of target field. Applicable only for structure field.


For example, lets say we have the source and target structure as shown below:

Field Name Occurence Field name Occurence
Source 1..1 Target 1..1
    Rows 0..Unbounded     Items 0..Unbounded
        Key 1..1         Element 1..1
        Value 1..1

And the requirements are..

  • The Element field name should get changed with value in Key field and should be filled with Value.
  • Output xml should have only 2 items assuming that it is coming in a particular order from source.
  • The namespace and its prefix should be Modified to “http://company.com” and pfx respectively.
  • Assign value “list of top 2 company” to Target node.

Source instance and expected result xml are as shown below.

Source Instance Result

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

<ns0:Source xmlns:ns0=http://test.com>

<Rows>

     <Key>CompanyA</Key>

     <Value>abc corp</Value>

</Rows>

<Rows>

     <Key>CompanyB</Key>

     <Value>xyz info</Value>

</Rows>

       …

<Rows>

     <Key>CompanyZ</Key>

     <Value>123 ent</Value>

</Rows>

</ns0:Source>

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

<pfx:Target xmlns:pfx=http://company.com>

list of top 2 companies

<Items>

     <CompanyA>abc corp</CompanyA>

</Items>

<Items>

     <CompanyB>xyz info</CompanyB>

</Items>

</pfx:Target>

And here comes the mapping part..

          UDF setNSDeclarations would fix namespace to http://company.com , fix prefix to pfx and assign value “list of top 2 companies” to Target node.

/wp-content/uploads/2012/11/image001_152907.png

public String setNSDeclarations(String prefix, String nmspace ,Container container) {


     StructureNode node = ((StructureNode) container.getParameter(“STRUCTURE_NODE”));

     node.setNSDeclarations(” xmlns:” + prefix + “=” + nmspace); // notice the space before xmlns:

     node.setQName(prefix + “:Target”);

     node.setPreValue(“list of top 2 companies”);


     return“”;                                   

}

  • /ns0:Target/Items=setOccurences(/ns0:Source/Rows, const(value=2))

          UDF setOccurences simply set the max occurence of Items to 2 to ensure top 2 Rows are mapped to Items.

/wp-content/uploads/2012/11/image003_152496.png

public String setOccurences(String sourcenode, int maxOccur, Container container) {


     StructureNode node = ((StructureNode) container.getParameter(“STRUCTURE_NODE”));

     node.setOccurences(0, maxOccur);


     return “”;

}

  • /ns0:Target/Items/Element=setTargetFieldName(/ns0:Source/Rows/Key, /ns0:Source/Rows/Value)

          UDF setTargetFieldName dynamically changes the tag name Element.

/wp-content/uploads/2012/11/image004_152498.png

public String setTargetFieldName(String targetFieldName, String targetFieldvalue, Container container) {


     LeafStructureNode node =((LeafStructureNode) container.getParameter(“STRUCTURE_NODE”));

     node.setQName(targetFieldName);


     return targetFieldvalue;

}

At end, please note that the code discussed above uses undocumented classes/methods that are subject to change in future without notice. In short, use at your own risk as any related issues will not be supported by SAP

Reference :

Accessing Element’s name in message mapping

Mapping question

To report this post you need to login first.

16 Comments

You must be Logged on to comment or reply to a post.

  1. Rajesh pasupula

    Nice..info..How did you found the API for these ? Are there published some where ? if so can you add that link in above, so that it will be helpful ..

    Regards

    Rajesh

    (0) 
    1. Sunil Chandra Post author

      Thanks Rajesh. I came across those undocumented methods while writing UDF in developer studio with reference to mapping api ( com.sap.xi.mapping.tool.lib_api.jar,  com.sap.xpi.ib.mapping.lib.jar) that we use for java mapping. Auto completion with ctrl space is the way forward for any further experiment 🙂  

      Regards,

      Sunil Chandra

      (0) 
  2. Rudra Singh

    Hi Sunil,

    Thanks for a wonderful blog. please let me know can we create Target Structure at run

    time ?

    for exp :-  I want to add extra record or element in target structure at run time ..

    Thanks & Regards

    Rudra

    (0) 
    1. vijay kumar

      Hi Sunil ,

      So nice, Useful document. This doc helped me in my recent projects………………

      Thanks for sharing.

      Regards,

      Vijay Kumar K.V.N

      (0) 
  3. Shankar Narayanan

    Hi Sunil… Thanks for the blog. Really informative. Can you help me with my requirement ?

    I need to create additional fields in the target(apart from those present in MT) dynamically in mapping.

    How would I do that?

    Find the below screenshots for reference.

    error.JPG

    code.JPG

    (0) 
  4. ceren çetin

    Hello everyody,
    I want to add <?xml version=”1.0″ encoding=”utf-8″?>  between two context element. That’s why is between </AccessRequest> and  <AddressValidationRequest> . 

    The required Output is the below:

    <?xml version=”1.0″ encoding=”UTF-8″?>
    <ns2:JSON xmlns:ns2=”http://zorlu.com/UPSIntegrations”>
    <AccessRequest>
    <AccessLicenseNumber>ED15FE4865E42E88</AccessLicenseNumber><UserId>aezeroglu</UserId>
    <Password>btc@Zorlu</Password>

    </AccessRequest>

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

    <AddressValidationRequest>

    <Request><TransactionReference><CustomerContext></CustomerContext></TransactionReference><RequestAction></RequestAction></Request><Address><City></City><StateProvinceCode></StateProvinceCode><PostalCode></PostalCode></Address></AddressValidationRequest></ns2:JSON>

    I used  setPreValue method but  the xml declaration is in the AddressValidationRequest node.

    How can I solve this problem?

    (0) 

Leave a Reply