8/5/2015 Standard Adapter Framework modules [AF_Modules]... | SCN

http://scn.sap.com/people/gabrielsagayaselvam.panneerselvam/blog/2009/12/07/standardadapterframeworkmodulesafmodulesinpi71part1 1/5

Getting Started Newsletters Store   

Products Services & Support About SCN Downloads

Industries Training & Education Partnership Developer Center

Lines of Business University Alliances Events & Webinars Innovation

Log On Join UsHi, Guest Search the Community

Activity Communications Actions

Browse

gabrielsagayaselvam.panneerselvam 

0 Tweet 0

  In this Weblog I am going to explain the various SAP provided standard Adapter Framework modules  (AF_Modules)shipped with the module processor in Process Integration PI 7.1 once the Communication channel has been createdalong with the business cases. This blog is aimed at all important Adapter Framework modules with the examples in asingle place.    We have the option of specifying generic modules for every adapter that is configured in the communication channel.These modules equip the adapters with additional functions. The modules that are the basis of the adapterconfiguration on the Parameters tab page are located in the module processor and are displayed in the moduleprocessor once a communication channel has been created. We define the module processor on the Module tabpage. Also we have the set of predefined adapter modules for the particular adapters. This Documentation link (http://help.sap.com/saphelp_nwpi711/helpdata/en/a4/f13341771b4c0de10000000a1550b0/content.htm) will give theclear picture how to extend the module chain for the Adapters in the module processor. Below is the list of standardmodules for Adapter Framework provided by SAP.   

StrictXML2PlainBean

XMLAnonymizerBean

PayloadZipBean

TextCodepageConversionBean

DynamicConfigurationBean

MessageTransformBean

XiHeaderValidationBean (A New Standard Adapter Module in PI 7.1)0.1. RequestResponseBean0.2. ResponseOnewayBean0.3. RequestOnewayBean0.4. WaitResponseBean0.5. NotifyResponseBean  We will go through each module with their business cases   <u>1) PayloadSwapBean</u>   A standard module used to replace the application payload of XI message that holds the data with another payloadwhich is appended to the message as an attachment.   <u>Business case</u>  We can use this module in the mail adapters for mails with attachments. 

Standard Adapter Framework modules [AF_Modules]in PI 7.1 –Part 1Posted by Gabriel Sagaya Selvam Panneer Selvam in gabrielsagayaselvam.panneerselvam on Dec 7,

2009 8:13:21 AM

Share 0Like

8/5/2015 Standard Adapter Framework modules [AF_Modules]... | SCN

http://scn.sap.com/people/gabrielsagayaselvam.panneerselvam/blog/2009/12/07/standardadapterframeworkmodulesafmodulesinpi71part1 2/5

   In the above Sender Mail Communication channel, the swap module for the PayloadSwapBean has 2 parametersfrom the MIME headers in order to replace the application payload by the attachment. They are *swap.keyName*where the attribute of payloadname is entered and *swap.keyValue which holds the value of attribute. A wiki on fileto mail scenario will clearly explain the usage of PayloadSwapBean.   </p><p>   </p><p>_2)StrictXML2PlainBean_*   A standard module used for converting an XML document in the main payload of XI message to text format. Within anXML document, different recordset types can be displayed either separately or with a fixed field length (mixed display).The structure of the XML document is checked based on the entries you make in the module.   <u>Business Case</u>              We can use the module in the receiver File/FTP adapter for converting XML format to pure text format.  

   In the above Receiver File Adapter, the convert module for StrictXml2PlainBean has 2 parameters in whichsingleRecordType where all recordset types are converted in the same way and <RecordType>.fieldSeparatorconverts the XML to asterisk separated file. We can find more information about the usage of StrictXml2PlainBean inthis blog  ( Xml to Text conversion made easy by  StrictXml2PlainBean)      <u>3) XMLanonymizerBean</u>   A standard module for anonymize XML elements and attributes by removing their namespaces or namespace prefixesfrom the XML document of main payload.

8/5/2015 Standard Adapter Framework modules [AF_Modules]... | SCN

http://scn.sap.com/people/gabrielsagayaselvam.panneerselvam/blog/2009/12/07/standardadapterframeworkmodulesafmodulesinpi71part1 3/5

   <u>Business Case</u>  We can use this module in the adapters that can be extended in the module processor. Also this module is used tohave the namespace without prefix or to define a particular namespace prefix for each namespace. Also we canchange the encoding attribute of XML declaration. 

   In above receiver JMS Adapter, The remove module for XMLAnonymizerBean has 2 parameters thatanonymizer.acceptNamespaces has to set the namespace without a prefix and anonymizer.quote has the characterto be used to enclose the attribute values. For better understanding of XMLAnonymizerBean, Please visit this blog ( Remove namespace prefix or change XML encoding with the XMLAnonymizerBean).      <u>4) PayloadZipBean</u>   A standard module used for compressing one or more payloads or extracting the payloads from a compressed file.   <u>Business Case</u>            We can use this module in any adapters that can be extended in the module processor. If we have a multiple files withlarge size to be processed, this module can reduce the size of the file and successively reduce the load on the PIServer. 

   In the above receiver File Adapter, The zip module for the PayloadZipBean has the parameter zip.mode to specify theprocessing mode (zip, zipAll and unzip) for the purpose of compressing and decompressing the files. A blog onPayloadZipBean  ( Working with the PayloadZipBean module of the XI Adapter Framework) will clearly explain theusage.  

8/5/2015 Standard Adapter Framework modules [AF_Modules]... | SCN

http://scn.sap.com/people/gabrielsagayaselvam.panneerselvam/blog/2009/12/07/standardadapterframeworkmodulesafmodulesinpi71part1 4/5

Average User Rating

(5 ratings)

My Rating:

0 Tweet 0

    <u>5) TextCodepageConversionBean</u>   A standard module used for swapping the code page of the main payload of the XI message and convert the contentusing the new code page  <u>Business Case</u>            If a receiver uses a different code page to the one specified in the XI payload, we can use this module to swap thecode page of the main payload of the XI message and convert the content. An example is converting a non utf8payload into utf8 payload. We can use this module in any adapters that can be extended in the module processor. 

  In the above Receiver File Adapter, The convert module for the TextCodepageConversionBean has the parametername as Conversion.charset to convert a non UTF8 text payload into utf8 payload. We can find more informationabout TextCodepageConversionBean from this sap notes  (https://service.sap.com/sap/support/notes/960663).      <u>6) DynamicConfigurationBean</u>    A standard module used for processing the dynamic configuration header that is used to represent the AdapterSpecific Message Attributes  (ASMA's).<u> </u>   <u>Business Case</u>  DynamicConfigurationBean allows us toa) Insert/Delete some specific ASMA'sb) Read some XI message header propertiesc) Write some ASMA's into XI message header properties           We can use this module in any adapters that can be extended in the module processor. !https://weblogs.sdn.sap.com/weblogs/images/251828887/DynamicConfigurationBean.JPG|height=366|alt=DynamicConfigurationBean|width=700|src=https://weblogs.sdn.sap.com/weblogs/images/251828887/DynamicConfigurationBean.JPG|border=0</body>

8138 Views  

Share 0Like

8/5/2015 Standard Adapter Framework modules [AF_Modules]... | SCN

http://scn.sap.com/people/gabrielsagayaselvam.panneerselvam/blog/2009/12/07/standardadapterframeworkmodulesafmodulesinpi71part1 5/5

Follow SCNSite Index Contact Us SAP Help PortalPrivacy Terms of Use Legal Disclosure Copyright

There are no comments on this post

0 Comments