BEA WebLogic XML/Non-XML Translator. Samples Guide

Transcription

1 BEA WebLogic XML/No-XML Traslator Samples Guide BEA WebLobic XML/No-XML Traslator Samples Guide Documet Editio 1.1 March 2001

2 Copyright Copyright 2000, 2001 BEA Systems, Ic. All Rights Reserved. Restricted Rights Leged This software ad documetatio is subject to ad made available oly pursuat to the terms of the BEA Systems Licese Agreemet ad may be used or copied oly i accordace with the terms of that agreemet. It is agaist the law to copy the software except as specifically allowed i the agreemet. This documet may ot, i whole or i part, be copied photocopied, reproduced, traslated, or reduced to ay electroic medium or machie readable form without prior coset, i writig, from BEA Systems, Ic. Use, duplicatio or disclosure by the U.S. Govermet is subject to restrictios set forth i the BEA Systems Licese Agreemet ad i subparagraph (c)(1) of the Commercial Computer Software-Restricted Rights Clause at FAR ; subparagraph (c)(1)(ii) of the Rights i Techical Data ad Computer Software clause at DFARS , subparagraph (d) of the Commercial Computer Software--Licesig clause at NASA FAR supplemet ; or their equivalet. Iformatio i this documet is subject to chage without otice ad does ot represet a commitmet o the part of BEA Systems. THE SOFTWARE AND DOCUMENTATION ARE PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND INCLUDING WITHOUT LIMITATION, ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. FURTHER, BEA Systems DOES NOT WARRANT, GUARANTEE, OR MAKE ANY REPRESENTATIONS REGARDING THE USE, OR THE RESULTS OF THE USE, OF THE SOFTWARE OR WRITTEN MATERIAL IN TERMS OF CORRECTNESS, ACCURACY, RELIABILITY, OR OTHERWISE. Trademarks or Service Marks BEA, ObjectBroker, TOP END, ad Tuxedo are registered trademarks of BEA Systems, Ic. BEA Builder, BEA Coect, BEA Maager, BEA MessageQ, BEA Jolt, M3, esolutios, elik, WebLogic, WebLogic Eterprise, WebLogic Commerce Server, ad WebLogic Persoalizatio Server are trademarks of BEA Systems, Ic. All other compay ames may be trademarks of the respective compaies with which they are associated. BEA WebLogic XML/No-XML Traslator Samples Guide Documet Editio Part Number Date Software Versio 1.1 March 2001 BEA WebLogic XML/No-XML Traslator 1.0.1

3 Cotets 1. Ruig the Purchase Order Sample What is Icluded i the Purchase Order Sample Prerequisite Cosideratios Uderstadig the Data Formats Used with XML Traslator About Biary Data (No-XML Data) About XML Documets About MFL Documets Performig Biary to XML Traslatio Aalyzig the Data to be Traslated Usig the Format Builder To Test the Traslatio Performig XML to Biary Traslatio Ruig the WebLogic Process Itegrator Sample Applicatios Prerequisite Cosideratios Ruig the WebLogic Process Itegrator Servlet Sample What is Icluded i the Servlet Sample How to Ru the Servlet Sample Ruig the WebLogic Process Itegrator EJB Sample What is Icluded i the EJB Sample How to Ru the EJB Sample BEA WebLogic XML/No-XML Traslator Samples Guide iii

4 iv BEA WebLogic XML/No-XML Traslator Samples Guide

5 CHAPTER 1 Ruig the Purchase Order Sample The BEA WebLogic XML/No-XML Traslator (hereafter referred to as XML Traslator) software icludes a Purchase Order sample desiged to illustrate the basic techiques of creatig message format defiitios for biary data usig Format Builder. The Purchase Order sample cosists of DTD, MFL, ad DATA files. These samples ca be used to test your istallatio of the XML Traslator. The followig topics are discussed i this sectio: What is Icluded i the Purchase Order Sample Prerequisite Cosideratios Uderstadig the Data Formats Used with XML Traslator Performig Biary to XML Traslatio Performig XML to Biary Traslatio BEA WebLogic XML/No-XML Traslator Samples Guide 1-1

6 1 Ruig the Purchase Order Sample What is Icluded i the Purchase Order Sample The followig table provides a listig ad descriptio of the files icluded i the Purchase Order sample applicatio. Table 1-1 List of Purchase Order Sample Applicatio Files Directory File Descriptio samples\po po_01.data Purchase order data i biary format. po_02.data po.dtd po.mfl Additioal purchase order data i biary format. Purchase order documet type defiitio. Pre-built message format descriptio of purchase order data. Prerequisite Cosideratios There are certai software applicatios that must be istalled ad tasks that must be performed prior to ruig the Purchase Order sample. Please refer to the BEA WebLogic XML/No-XML Traslator Release Notes for more iformatio. Uderstadig the Data Formats Used with XML Traslator To uderstad how the Format Builder is used, it helps to uderstad the data formats used by XML Traslator: biary data, XML, ad MFL. 1-2 BEA WebLogic XML/No-XML Traslator Samples Guide

7 Uderstadig the Data Formats Used with XML Traslator About Biary Data (No-XML Data) Because computers are based o the biary umberig system, applicatios ofte use a biary format to represet data. A file stored i biary format is computer-readable but ot ecessarily huma-readable. Biary formats are used for executable programs ad umeric data, ad text formats are used for textual data. may files cotai a combiatio of biary ad text formats. Such files are usually cosidered to be biary files eve though they cotai some data i text format. Ulike XML data, biary data is ot self-describig. I other words, biary data does ot provide a descriptio of how the data is grouped, divided ito fields, or arraged i a layout. Biary data is a sequece of bytes that ca be iterpreted as a iteger, a strig, or a picture, depedig o the itet of the applicatio that geerates the sequece of bytes. For example, the followig biary data strig ca be iterpreted may differet ways: This could be a date (2/23/1987) or a phoe umber ( ) or ay umber of other iterpretatios. Without a clear uderstadig of the purpose of this data strig, the applicatio has o idea how to iterpret the strig. I order for biary data to be uderstood by a applicatio, the format must be embedded withi each applicatio that accesses the biary data. The Format Builder is used to create a Message Format Laguage (MFL) file that describes the layout of the biary data. MFL is a XML laguage that icludes elemets to describe each field of data, as well as groupigs of fields (groups), repetitio, ad aggregatio. The hierarchy of a biary record, the layout of the fields, ad the groupigs of fields ad groups are expressed i a MFL documet. The MFL documet is used by XML Traslator at ru-time to traslate biary data to ad from a XML documet. About XML Documets Exteded Markup Laguage, or XML, is a text format for exchagig data betwee differet systems. It allows data to be described i a simple, stadard, text-oly format. I cotrast to biary data, XML data embeds a descriptio of the data withi the data stream. Applicatios ca share data more easily, sice they are ot depedet o the BEA WebLogic XML/No-XML Traslator Samples Guide 1-3

8 1 Ruig the Purchase Order Sample layout of the data beig embedded withi each applicatio. Sice the data is preseted i a stadard form, applicatios o disparate systems ca iterpret data i proprietary biary formats. Istaces of XML documets cotai character data ad markup. The character data is referred to as cotet, while the markup provides hierarchy for that cotet. Markup is distiguished from cotet by agle brackets. Iformatio i the space betwee the < ad the > is referred to as the tags that markup the cotet. Tags provide a idicatio of what the cotet is for, ad a mechaism to describe Paret-child relatioships. A XML documet ca coform to a cotet model. A cotet model allows Metadata (data that is used to describe other data) about XML documets to be commuicated to a XML parser. XML documets are said to be valid if they coform to a cotet model. A cotet model describes the data that ca exist i a istace of a XML documet. A cotet model also describes a top-level etity, which is a sequece of subordiate etities. These subordiate etities are further described by their tag ames ad data cotet. The two stadard formats for XML cotet models are XML Documet Type Defiitio (DTD) ad XML Schema. A Schema is a XML documet that defies what ca be i a XML documet. A DTD also defies what cotet ca exist i a XML documet, but the Schema defiitio is more specific tha the DTD, ad provides much fier-graied cotrol over the cotet that ca exist i a XML documet. About MFL Documets Message Format Laguage (MFL) is a XML laguage that describes the layout of biary data. This laguage icludes elemets to describe each field of data, as well as groupigs of fields (groups), repetitio, ad aggregatio. The hierarchy of a biary record, the layout of fields, ad the groupig of fields ad groups is expressed i a MFL documet. MFL documets are created usig Format Builder. The Format Builder applicatio allows you to defie the structure of biary data ad save that iformatio i a MFL documet. These MFL documets are the used to perform ru-time traslatio. The MFL documets you create usig Format Builder ca cotai the followig elemets: Message Format The top level elemet. Defies the message ame ad MFL versio. 1-4 BEA WebLogic XML/No-XML Traslator Samples Guide

9 Uderstadig the Data Formats Used with XML Traslator Field Sequece of bytes that have some meaig to a applicatio. (For example, the field EMPNAME cotais a employee ame.) Defies the formattig for the field. The formattig parameters you ca defie iclude: l l l l Tagged Idicates that a literal precedes the data field, deotig the begiig of the field. Legth Field Idicates that a legth value precedes the data field, deotig the legth of this field. Repeatig Repeatig fields appear more tha oce i the message format. You ca set a specific umber of times the field is to repeat, or defie a delimiter to idicate the ed of the repeatig field. Optioal The field may or may ot be preset i the amed message format. Groups Collectios of fields, commets, ad other groups or refereces that are related i some way (for example, the fields PAYDATE, HOURS, ad RATE could be part of the PAYINFO group). Defies the formattig for all items cotaied i the group. The formattig parameters you ca defie iclude: l l l Repeatig Repeatig groups appear more tha oce i the message format: You ca set a specific umber of times the group is to repeat, or defie a delimiter to idicate the ed of the repeatig group. Choice of Childre Defiig a group as Choice of Childre meas that oly oe item i the group will appear i the message format. Optioal The group of data withi this structure may or may ot be preset i the amed message format. Refereces Idicates that aother istace of the field or group format exists i the data. Referece fields or groups have the same format as the origial field or group, but you ca chage the optioal settig ad the occurrece settig for the referece field or group. For example, if you have a bill to address ad a ship to address i your data, you oly eed to defie the address format oce. You ca create the bill to address defiitio ad create a referece for the ship to address. Commets Notes or additioal iformatio about the message format. BEA WebLogic XML/No-XML Traslator Samples Guide 1-5

10 1 Ruig the Purchase Order Sample Performig Biary to XML Traslatio The followig sectios provide iformatio o buildig sample purchase order format defiitios usig the Format Builder utility to test the traslatio of biary data ito XML format. Aalyzig the Data to be Traslated Usig the Format Builder To Test the Traslatio The Format Builder icluded with XML Traslator allows you to build format defiitios for biary data that will be traslated to or from XML. Format defiitios are the metadata used to parse biary data. Aalyzig the Data to be Traslated The key to traslatig biary data to ad from XML is to create a accurate descriptio of the biary data. For biary data (data that is ot self-describig), you must idetify the followig elemets: Hierarchical groups Group attributes, such as ame, optioal, repeatig, delimited Data fields Data field attributes, such as ame, data type, legth/termiatio, optioal, repeatig Listig 1-1 shows sample biary data that is icluded o the XML Traslator CD-ROM ad is called \sample\po\po_01.data. I this sample, the example data is take from a ficticious purchase order o a proprietary system that the XYZ Corporatio uses. They would like to iterchage this iformatio with aother system that accepts XML data. 1-6 BEA WebLogic XML/No-XML Traslator Samples Guide

11 Performig Biary to XML Traslatio Listig 1-1 Sample Biary Purchase Order Data 1234; ;SUP:21Sprockley s Sprockets01/15/ Mai St.; Austi;TX;75222;555 State St.; Austi;TX;75222; PO ;666123;150;Red Sprocket; Perform the followig steps to aalyze the purchase order data: 1. Get the defiitio of the data. This may ivolve usig prited specificatios or iteral documetatio. For this sample, we have described the purchase order format i Table 1-2. Table 1-2 Purchase Order Master Record Field Name Data Type Legth Descriptio Purchase Request Number Numeric Delimited by semicolo The Purchase Request umber assiged by the Purchasig departmet. This umber is used to track the status of a order from requisitio through delivery ad paymet. Supplier ID Numeric Delimited by semicolo The idetificatio of the assiged supplier as defied i the corporate Supplier Data Base. Assigmet of a approved supplier is made by the buyer whe creatig a Purchase Request from a requisitio. Supplier Name Character Prefixed by a literal "SUP:". Followig this literal is a two digit umeric legth field. The ame of the assiged supplier as defied i the corporate Supplier Data Base. This field is prefixed with a literal to idicate that it is preset. Requested Delivery Date Date MM/DD/YYYY 10 characters The delivery date specified by the requisitioer. Shippig Street Character Delimited by semicolo The street address to be used i shippig the requested items. Shippig City Character Delimited by semicolo The city to be used i shippig the requested items. BEA WebLogic XML/No-XML Traslator Samples Guide 1-7

12 1 Ruig the Purchase Order Sample Field Name Data Type Legth Descriptio Shippig State Character Delimited by semicolo The state to be used i shippig the requested items. Shippig Zip Numeric Delimited by semicolo The zip code to be used i shippig the requested items. Billig Street Character Delimited by semicolo The street address to be used for billig. Billig City Character Delimited by semicolo The city to be used for billig. Billig State Character Delimited by semicolo The state to be used for billig. Billig Zip Numeric Delimited by semicolo The zip code to be used for billig. Paymet Terms Supported paymet terms may be either Purchase Order or Compay Credit Card. A literal precedig the paymet iformatio idetifies the type. PO Type Character Literal PO Idicates PO paymet terms. PO Number Numeric Delimited by semicolo Purchase Order umber. Credit Card Type Character Literal CC Idicates Credit Card paymet terms. Credit Card Number Numeric Delimited by semicolo Credit card umber. Credit Card Expiratio Moth Credit Card Expiratio Year Purchase Items Numeric Delimited by semicolo Expiratio moth for credit card. Numeric Delimited by semicolo Expiratio year for credit card. The followig fields idetify the items to be purchased. This iformatio may be repeated for each item that is part of this Purchase Request. At least oe item must be preset. Part Number Numeric Delimited by semicolo The supplier's part umber of the requested item. Quatity Numeric Delimited by semicolo The quatity requested. Must be greater the zero. 1-8 BEA WebLogic XML/No-XML Traslator Samples Guide

13 Performig Biary to XML Traslatio Field Name Data Type Legth Descriptio Descriptio Character Delimited by semicolo Descriptio of the requested item. 2. Idetify hierarchical groups. Groups are collectios of fields, commets, ad other groups or refereces that are related i some way. I Table 1-2, otice that the sample data defies two distict groups: Paymet Terms ad Purchase Items. I additio to these groups, otice that there are several fields related to shippig ad billig addresses. You ca defie a group for Shippig Address ad a group for Billig Address. 3. Idetify group attributes. You must defie the attributes of the hierarchical groups. Group attributes iclude the ame of the group, whether the group is optioal, repeatig, or delimited, or whether it is defied as a referece to aother group. For example, look at the Address group withi the Shippig Address ad Billig Address groups. These two groups cotai the same fields with the same attributes. Therefore, you ca defie the Address group withi the Shippig Address group ad set up the Address group withi the Billig Address group as a referece. For more iformatio o refereces, refer to the BEA WebLogic XML/No-XML Traslator User Guide. 4. Idetify data fields. Fields are a sequece of bytes that have some meaig to a applicatio. I Table 1-2, some of the sample data fields are Purchase Request Number, Supplier ID, Supplier Name, etc. 5. Idetify data field attributes. You eed to defie the attributes of the data fields. Field attributes iclude the ame of the field, the type of data cotaied i the field, the legth of the field, or the delimiter that deotes the ed of the field. For example, the Supplier ID field is delimited by a semicolo (;) idicatig the ed of the field data, but the Requested Delivery Date has a implied legth of 10 characters. Oce you have completed the steps above, it might be helpful to put the data ito a spreadsheet form as show i Table 1-3. This will assist you i eterig the data i Format Builder to create your message defiitios. BEA WebLogic XML/No-XML Traslator Samples Guide 1-9

14 1 Ruig the Purchase Order Sample Table 1-3 Aalysis of Purchase Order Data Descriptio Group Field Referece Optioal Name / Refers To Data Type Occurrece Delimited by Purchase Request Number X PR_Number Numeric 1 Semicolo Supplier ID X Supplier_ID Numeric 1 Semicolo Supplier Name X X Supplier_Name Strig 1 Numeric field legth 2 Requested Delivery Date X Requested_Delivery_Date Date MM/DD/YYYY 1 Semicolo Shippig Address X Shippig_Address 1 Street X Street Strig 1 Semicolo City X City Strig 1 Semicolo State X State Strig 1 Semicolo Zip X Zip Numeric 1 Semicolo Billig Address X Address 1 Semicolo Street X Street Strig 1 Semicolo City X City Strig 1 Semicolo State X State Strig 1 Semicolo Zip X Zip Numeric 1 Semicolo Paymet Terms X Paymet Terms 1 Purchase Order X 0 or 1 Purchase Order Tag X Paymet_Type_PO Literal "PO" 1 Semicolo Purchase Order Number X PO_Number Numeric 1 Semicolo Credit Card X 0 or 1 Paymet Type X Paymet_Type_CC Literal "CC" 1 Semicolo Credit Card Number X CC_Number Numeric 1 Semicolo Credit Card Expire Moth X CC_Expire_Moth Numeric 1 Semicolo Credit Card Expire Year X CC_Expire_Year Numeric 1 Semicolo Purchase Items X Purchase_Items 1- Semicolo Part Number X Part_Number Numeric 1 Semicolo Quatity X Quatity Numeric 1 Semicolo Descriptio X Descriptio Strig 1 Semicolo Usig the Format Builder To Test the Traslatio This sectio walks you through the Format Builder steps required to create the message defiitio file for traslatig the biary Purchase Order data to XML. Notes: For details o eterig data i the detail widows of Format Builder, refer to the BEA WebLogic XML/No-XML User Guide. The file \sample\po\po.mfl icluded o the CD-ROM cotais the message defiitio created by the steps below. You ca use this file for referece to make sure you create the defiitio correctly BEA WebLogic XML/No-XML Traslator Samples Guide

15 Performig Biary to XML Traslatio Step 1. Startig Format Builder ad Creatig the Message Format Step 2. Creatig Fields To start Format Builder ad create the message format: 1. Choose Start Programs BEA WebLogic XML/No-XML Traslator Format Builder. The Format Builder mai widow displays. 2. Choose File New. A ew message defiitio opes. 3. Eter PurchaseRequest as the message format ame ad click Apply. The tree pae chages to reflect the ew message format ame. To create fields: 1. Select PurchaseRequest i the tree pae ad choose Isert Field As Child. The Field Descriptio detail widow opes. 2. Eter the field details as follows: Field Name Type Field Occurrece Delimiter Value PR_Number Numeric Oce ; (semi-colo) These values were determied by our aalysis of the raw purchase order data, as you ca see i Table Click Apply. The PR_Number field is saved to the message format file. Note: Sice the oly differece betwee the PR_Number field ad the Supplier_ID field is the ame, we will use the Format Builder Duplicate feature to create the Supplier_ID field. 4. Select the PR_Number field you just created i the tree pae ad click Duplicate. A ew field descriptio is displayed i the detail pae. BEA WebLogic XML/No-XML Traslator Samples Guide 1-11

16 1 Ruig the Purchase Order Sample 5. Eter Supplier_ID as the ame ad click Apply. The Supplier_ID field is created ad stored i the message format file. 6. Select the Supplier_ID field you just created i the tree pae ad choose Isert Field As Siblig. 7. Eter the Supplier_Name field details as follows: Field Name Optioal Tagged Tag Type Field Occurrece Value Supplier_Name Select this optio Select this optio ad choose Strig from the drop dow list SUP: Strig Oce Termiatio (Legth Field Tab) Type Legth Numeric Select this optio ad eter 2 i the text box 8. Click Apply. The Supplier_Name field is created ad added to the tree pae. Note: The dashed box aroud the field ico i the tree pae idicates this is a optioal field. 9. Select the Supplier_Name field you just created i the tree pae ad choose Isert Field As Siblig. 10. Eter the Requested_Delivery_Date field details as follows: Note: The Field detail pae chages based o the Type selected. Because this field is a Date type, it has a implied legth ad does ot require you to specify the termiatio BEA WebLogic XML/No-XML Traslator Samples Guide

17 Performig Biary to XML Traslatio Field Name Type Field Occurrece Data Base Type Value Requested_Delivery_Date Date: MM/DD/YYYY Oce Strig Step 3. Creatig Groups 11. Click Apply. The Requested_Delivery_Date field is created ad added to the tree pae. To create groups: 1. Select the Requested_Delivery_Date field i the tree pae ad choose Isert Group As Siblig. The Group Detail widow opes. 2. Eter the group details as follows: Field Name Field Occurrece Value Shippig_Address Oce These values were determied by our aalysis of the raw purchase order data preseted i Table Click Apply. The Shippig_Address group is created ad added to the tree pae. We kow from our iitial data aalysis that the Shippig Address ad Billig Address groups cotai the same fields with the same attributes. Therefore, we ca defie the Address group withi the Shippig Address group ad set up the Address group withi the Billig Address group as a referece. For more iformatio o refereces, refer to the BEA WebLogic XML/No-XML Traslator User Guide. BEA WebLogic XML/No-XML Traslator Samples Guide 1-13

18 1 Ruig the Purchase Order Sample 4. Select the Shippig_Address group i the tree pae ad choose Isert Group As Child. 5. Use the data i Table 1-3 to create the Address group ad click Apply to save the data. 6. Follow the steps outlied i Step 2. Creatig Fields, to create the Street, City, State, ad Zip fields as childre of the Address group. Note: Step 4. Creatig a Group Referece Oce the Street field is created, you ca use the Duplicate butto to create the City ad State fields. Now we are goig to create the Billig Address group ad fields. Sice this is a duplicate of the Shippig Address group, we ca create a group referece. A referece group has the same format as the origial group, but you ca chage the optioal settig ad the occurrece settig for the referece group. 1. Select the Shippig_Address group i the tree pae ad choose Isert Group As Siblig. The Group Detail widow opes. 2. Eter the group details as follows: Field Name Field Occurrece Value Billig_Address Oce These values were determied by our aalysis of the raw purchase order data preseted i Table Select the Address group uder Shippig_Address i the tree pae ad choose Edit Copy. This copies the Address group details (icludig child objects) ad places them o the clipboard. 4. Select the Billig_Address group you created i step 2 i the tree pae ad choose Edit Paste As Referece. This pastes the copy of the Address group ito the message defiitio as a siblig of the Billig Address group. Note: You ca idetify this Address group as a referece by the ico located to the left of it i the tree pae BEA WebLogic XML/No-XML Traslator Samples Guide

19 Performig Biary to XML Traslatio 5. Chage the Address referece group to be a child of the Billig_Address group by selectig the Address referece group i the tree pae ad choose Edit Demote. The Address referece group moves uder the Billig_Address group. Step 5. Creatig the Remaiig Items Follow Steps 1 through 4 above to create the remaiig items ecessary to complete the message defiitio for the Purchase Order sample. Use the aalysis of the raw purchase order data preseted i Table 1-3 to determie the values you eed to eter for each item. You ca use the file \sample\po\po.mfl for referece if you eed assistace. Whe you fiish eterig the items, your tree pae should looks similar to Figure 1-1. BEA WebLogic XML/No-XML Traslator Samples Guide 1-15

20 1 Ruig the Purchase Order Sample Figure 1-1 Completed Tree Pae for Purchase Order Sample Step 6. Savig the Message Format To save a message format file: 1. Choose File Save As. The Save As dialog displays. 2. Navigate to the directory where you wat to save the file. 3. I the File Name text box, type the ame you wat to assig to the file BEA WebLogic XML/No-XML Traslator Samples Guide

21 Performig Biary to XML Traslatio Note: Format Builder automatically assigs the.mfl extesio to message format files by default if o extesio is give. 4. Click Save As to save the file i the specified locatio with the specified ame ad extesio. Oce you have geerated the Message Format defiitio, you ca create a DTD or XML Schema documet that describes the XML to be coverted. You ca set up Format Builder to automatically geerate a DTD ad/or Schema for your message defiitios as follows: 1. From the Format Builder mai widow, choose Tools Optios. The Format Builder Optios dialog opes. 2. Select Auto-geerate DTD ad/or Auto-geerate Schema to have Format Builder automatically create these documets durig the traslatio process. 3. Click OK to activate your selectios. Now, wheever you save message format documets, Format Builder will geerate a DTD ad/or a Schema for your message format. Refer to the BEA WebLogic XML/No-XML User Guide for more iformatio o DTDs ad Schemas. Step 7. Testig the Message Format Now, you must test the message format to idetify ay errors that exist before usig it to traslate actual data. 1. Choose Test Message Format. The Tester opes. This allows you to test the traslatio of the biary purchase order data ito XML. 2. Click Load ad avigate to the SAMPLES\PO directory. 3. Choose the file PO_01.DATA ad click Ope. The left side of the Format Tester dialog displays the biary data. 4. Click To XML >. The biary data is traslated ad the right side of the dialog displays the purchase order data i XML format. Note: You ca see the messages output durig the traslatio by selectig Debug. BEA WebLogic XML/No-XML Traslator Samples Guide 1-17

22 1 Ruig the Purchase Order Sample 5. If the traslated data appears correct, click Save o the right side of the dialog (uder XML). 6. Navigate to the SAMPLES\PO directory ad eter PO.XML as a ame for the XML data. Performig XML to Biary Traslatio You ca also use Format Builder to create message defiitios ad test the traslatio of XML data to biary. The steps required to do this are essetially the same as traslatig biary data to XML. To traslate XML data to biary, first create a MFL descriptio of the biary format. The Purchase Order Record sample provides a MFL documet that ca be loaded by performig the followig steps: 1. Choose File Ope i Format Builder. 2. Navigate to the directory cotaiig the desired file ad select the file ame. 3. Click ope. The file is loaded ito Format Builder. 4. Choose Tester Message Format. 5. Uder the XML pael, click Load, ad avigate to the SAMPLES\PO directory. 6. Choose the file po.xml ad click Ope. The right side of the Format Tester dialog displays the XML data. 7. Click <To Biary. The XML data is traslated, ad the right side of the dialog displays the purchase order data i Biary format. Note: You ca see the messages output durig the traslatio by selectig Debug BEA WebLogic XML/No-XML Traslator Samples Guide

23 CHAPTER 2 Ruig the WebLogic Process Itegrator Sample Applicatios The BEA WebLogic XML/No-XML Traslator software icludes two sample applicatios desiged to illustrate the itegratio of XML Traslator with BEA WebLogic Process Itegrator. This sectio describes these samples ad gives you step-by-step istructios for ruig the samples. The followig topics are discussed: Prerequisite Cosideratios Ruig the WebLogic Process Itegrator Servlet Sample Ruig the WebLogic Process Itegrator EJB Sample Prerequisite Cosideratios There are certai software applicatios that must be istalled ad tasks that must be performed prior to ruig the Purchase Order sample. Please refer to the BEA WebLogic XML/No-XML Traslator Release Notes for more iformatio. Note: The istructios preseted i this sectio assume that you have a good workig kowledge of BEA WebLogic Process Itegrator ad BEA WebLogic Server. You should have successfully istalled WebLogic Process Itegrator ad ru a sample workflow prior to ruig the Purchase Order sample. BEA WebLogic XML/No-XML Traslator Samples Guide 2-1

24 2 Ruig the WebLogic Process Itegrator Sample Applicatios Ruig the WebLogic Process Itegrator Servlet Sample This sample applicatio implemets a Web Archive (WLPI_Sample.war) that istalls a servlet to accept requests for coversio of biary data to XML. The servlet is accessed via a browser ad respods by displayig the geerated XML data. I additio, a geerated XML file may be posted to a JMS topic to act as a startig evet for a WebLogic Process Itegrator workflow. Note: This sample does ot require the iterface to WebLogic Process Itegrator; however, i order to start the workflow, WebLogic Process Itegrator is required. What is Icluded i the Servlet Sample The followig table provides a listig ad descriptio of the files icluded i the WebLogic Process Itegrator Servlet sample applicatio. This sample applicatio ca be foud i the samples\wpli\servlet directory. Table 2-1 List of Servlet Sample Applicatio Files Directory File Descriptio \servlet\source WLPI_sample.java The source code for the servlet used to preset the HTML scree ad process biary data to XML. This XML may be placed, optioally, oto the WebLogic Process Itegrator JMS topic. \servlet SampleData.mfl The Message Format Laguage descriptio of the sample biary data file used to start the sample WebLogic Process Itegrator workflow. \servlet SampleData.data The sample data file used as iput to start the sample WebLogic Process Itegrator workflow. 2-2 BEA WebLogic XML/No-XML Traslator Samples Guide

25 Ruig the WebLogic Process Itegrator Servlet Sample Table 2-1 List of Servlet Sample Applicatio Files Directory File Descriptio \servlet SampleWorkflow.xml The exported WebLogic Process Itegrator workflow used i the sample. This workflow should be imported via the WebLogic Process Itegrator Studio GUI to setup the workflow tasks ivolved i the sample. \servlet WLPI_sample.war A Web Archive file cotaiig all executable sample code ad cofiguratio files. \servlet\images bealogo.jpg The BEA logo image displayed o the HTML page redered by the sample servlet. \servlet\web-inf hello.html The HTML page used by the sample servlet to obtai iput data from the user. \servlet\web-inf web.xml The J2EE cofiguratio file defiig deploymet iformatio for the sample servlet. \servlet\web-inf weblogic.xml The BEA cofiguratio file defiig WebLogic-specific iformatio for the sample servlet. \servlet\web-inf \lib *.jar Utility libraries, icludig XML Traslator, that are used i the executio of the sample code. How to Ru the Servlet Sample Usig WebLogic 5.1 This sectio describes the steps required to ru the Servlet Sample. Follow the istructios appropriate for your WebLogic Server versio (5.1 or 6.0). For istructios o the tasks specific to WebLogic Server ad WebLogic Process Itegrator, refer to the documetatio that accompaies those applicatios. To ru the servlet sample stad-aloe (without WebLogic Process Itegrator): 1. Copy the licese-group sectio from the XML Traslator licese file (licese.bea) to the WebLogic Process Itegrator licese file. For details o this procedure, refer to the BEA WebLogic XML/No-XML Traslator Release Notes ad the WebLogic Process Itegrator documetatio. BEA WebLogic XML/No-XML Traslator Samples Guide 2-3

26 2 Ruig the WebLogic Process Itegrator Sample Applicatios 2. Usig a text editor, add the followig lie to the ed of your weblogic.properties file: weblogic.httpd.webapp.wlxt=<path to war file>/wlpi_sample.war Note: 3. Start WebLogic. If you have both WebLogic Server ad WebLogic Process Itegrator istalled, you may have two istaces of the weblogic.properties file. Make sure you edit the file i the WebLogic Process Itegrator directory for this sample exercise. 4. Start a web browser ad eter the followig URL: server>:<weblogic port>/wlxt/wlxttest 5. Select a MFL file ad a data file from your local machie. 6. Click Submit. The server respose displays the geerated XML data. The followig additioal steps ca be ru to start the workflow if you are itegratig with WebLogic Process Itegrator: 1. Usig a text editor, ope the weblogic.properties file i the wlpi\server directory. 2. Modify the mail.host parameter to cotai the address of your SMTP server. 3. Start WebLogic Process Itegrator. 4. Start the WebLogic Process Itegrator Studio ad log o. 5. Select Templates i the left pae, click the right mouse butto, ad choose Create to create a ew template. 6. Select the ewly created template, click the right mouse butto, ad choose Import Template Defiitio. 7. Select the file \samples\wlpi\sampleworkflow.xml. 8. Select the ewly imported workflow, click the right mouse butto, ad choose Properties. The Properties dialog displays. 9. Select Active ad click OK. 10. Select the workflow, click the right mouse butto, ad choose Save. 2-4 BEA WebLogic XML/No-XML Traslator Samples Guide

27 Ruig the WebLogic Process Itegrator Servlet Sample 11. Usig a text editor, ope the file \samples\wlpi\sampledata.data. Replace the text user@bea.com with a valid address. This is the address the workflow uses to deliver the message. 12. Ope a browser ad go to the followig URL: server/port>/wlxt/wlxttest 13. Eter the followig path to the MFL file: samples\wlpi\sampledata.xml 14. Eter the followig path to the data file: samples\wlpi\sampledata.data 15. Select the optio to ivoke WebLogic Process Itegrator ad click Submit. A short message is set to the address you supplied i the data file. Usig WebLogic 6.0 To ru the servlet sample stad-aloe (without WebLogic Process Itegrator): 1. Copy the licese-group sectio from the XML Traslator licese file (licese.bea) to the WebLogic Process Itegrator licese file. For details o this procedure, refer to the BEA WebLogic XML/No-XML Traslator Release Notes ad the WebLogic Process Itegrator documetatio. 2. Start WebLogic. 3. Copy the WLPI_sample.war file to the default web applicatio directory. By default, these directories are: C:\bea\wlserver6.0\cofig\mydomai\applicatios (for Widows NT or Widows 2000) $BEA_HOME/wlserver6.0/cofig/mydomai/applicatios (for Uix) 4. If your WebLogic Server has auto-deploymet eabled, the sample web applicatio is deployed withi several secods. Verify the deploymet settig usig the WebLogic Server Cosole, as show i Figure 2-1. BEA WebLogic XML/No-XML Traslator Samples Guide 2-5

28 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-1 WebLogic Server Cosole 5. If you have disabled auto-deploymet o your WebLogic Server, you must statically deploy the web applicatio usig the WebLogic Server Cosole. To do this, follow the steps below: a. From the tree i the left pae, choose Web Applicatios. b. I the right pae, click Istall a New Web Appolicatio. c. Eter the path ad file ame of the WLPI_sample.war file ad press Upload. Note:Do ot select the file you copied to the applicatios directory i step BEA WebLogic XML/No-XML Traslator Samples Guide

29 Ruig the WebLogic Process Itegrator Servlet Sample After the WLPI_sample.war file is successfully uploaded, WLPI_sample appears i the tree uder Web Applicatios. d. Select the ew WLPI_sample ode from the tree. e. Click the Deployed checkbox i the right pae ad click Apply. f. Select the Targets tab. g. Move your server ame from the Available colum to the Chose colum, as show i Figure 2-2. BEA WebLogic XML/No-XML Traslator Samples Guide 2-7

30 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-2 WebLogic Server Cosole Targets Tab 6. Start a web browser ad eter the followig URL: 7. Select a MFL file ad a data file from your local machie. 8. Click Submit. The server respose displays the geerated XML data. 2-8 BEA WebLogic XML/No-XML Traslator Samples Guide

31 Ruig the WebLogic Process Itegrator Servlet Sample The followig additioal steps ca be ru to start the workflow if you are itegratig with WebLogic Process Itegrator: 1. Start WebLogic Process Itegrator. 2. Start the WebLogic Process Itegrator Studio ad log o. 3. From the tree i the left pae, choose Mail. 4. Eter the appropriate iformatio to cofigure your mail host. Figure 2-3 shows a example of the Mail Sessio Cofiguratio scree. Figure 2-3 WebLogic Server Cosole Mail Sessio Cofiguratio Tab BEA WebLogic XML/No-XML Traslator Samples Guide 2-9

32 2 Ruig the WebLogic Process Itegrator Sample Applicatios 5. Select the Targets tab. 6. Move your mail server ame from the Available colum to the Chose colum, as show i Figure 2-4. Figure 2-4 WebLogic Server Cosole Mail Sessio Targets Tab 7. Select Templates i the left pae, click the right mouse butto, ad choose Create to create a ew template BEA WebLogic XML/No-XML Traslator Samples Guide

33 Ruig the WebLogic Process Itegrator EJB Sample 8. Select the ewly created template, click the right mouse butto, ad choose Import Template Defiitio. 9. Select the file \samples\wlpi\sampleworkflow.xml. 10. Select the ewly imported workflow, click the right mouse butto, ad choose Properties. The Properties dialog displays. 11. Select Active ad click OK. 12. Select the workflow, click the right mouse butto, ad choose Save. 13. Usig a text editor, ope the file \samples\wlpi\sampledata.data. Replace the text user@bea.com with a valid address. This is the address the workflow uses to deliver the message. 14. Ope a browser ad go to the followig URL: server/port>/wlxt/wlxttest 15. Eter the followig path to the MFL file: samples\wlpi\sampledata.xml 16. Eter the followig path to the data file: samples\wlpi\sampledata.data 17. Select the optio to ivoke WebLogic Process Itegrator ad click Submit. A short message is set to the address you supplied i the data file. Ruig the WebLogic Process Itegrator EJB Sample This sample simulates a dataflow from a HR system to a payroll system, iitiated by the etry of payroll data. The employee data is obtaied from a legacy payroll system that uses biary data. The data is traslated to XML i order to perform a calculatio to determie the employee s pay iformatio. The result of the calculatio is traslated back to biary ad set o to the payroll system. BEA WebLogic XML/No-XML Traslator Samples Guide 2-11

34 2 Ruig the WebLogic Process Itegrator Sample Applicatios What is Icluded i the EJB Sample The followig table provides a listig ad descriptio of the files icluded i the WebLogic Process Itegrator EJB sample applicatio. This sample applicatio ca be foud i the samples\wpli\ejb directory. Table 2-2 List of EJB Sample Applicatio Files Directory File Descriptio \ejb Makefile Make file for buildig the sample source to a.jar file. \ejb WLXTExample.xml Exported sample workflow from WebLogic Process Itegrator. \ejb HR.mfl MFL file for biary data retured from the Sample HR Bea. \ejb Payroll.mfl MFL file for biary data passed to the Sample Payroll Bea. \ejb Autopay.cmd Widows NT commad script to iitiate the workflow from the commad lie. \ejb Autopay.sh Uix shell script to iitiate the workflow from a commad prompt. \ejb\lib \ejb\source \ejb\source \ejb\source WLXTEJB51.jar or WLXTEJB60.jar XMLoXML Traslator.java XMLoXML TraslatorHome.java XMLoXML TraslatorBea.java Executables for the sample applicatio. The file WLXTEJB51.jar is used if you have WebLogic Server versio 5.1 istalled. The file WLXTEJB60.jar is used if you have WebLogic Server 6.0 istalled. EJB wrapper class for WLXT. EJB wrapper class for WLXT. EJB wrapper class for WLXT. \ejb\source Payroll.java Sample EJB to represet legacy payroll system. \ejb\source PayrollHome.java Sample EJB to represet legacy payroll system BEA WebLogic XML/No-XML Traslator Samples Guide

35 Ruig the WebLogic Process Itegrator EJB Sample Table 2-2 List of EJB Sample Applicatio Files Directory File Descriptio \ejb\source PayrollBea.java Sample EJB to represet legacy payroll system. \ejb\source HR.java Sample EJB to represet legacy HR system. \ejb\source HRHome.java Sample EJB to represet legacy HR system. \ejb\source HRBea.java Sample EJB to represet legacy HR system. \ejb\source AutoPay.java Program to place a pre-formatted message o the WLPI Evet Topic to start the sample workflow. \ejb\source HexDump.java Utility class used by the sample EJBs. \ejb\source EmployeeRecord.java Employee data class used by the sample HR EJB. How to Ru the EJB Sample Follow the steps below to ru the EJB sample. For specific istructios o performig the tasks i WebLogic Process Itegrator ad WebLogic Server, please refer to the documetatio that accompaies those applicatios. Step 1. Cofigure ad Ru WebLogic Process Itegrator usig WebLogic Server 5.1 Note: If you are ruig WebLogic Process Itegrator uder WebLogic Server 5.1, follow the steps below. If you are ruig WebLogic Process Itegrator uder WebLogic Server 6.0, proceed to Step 2. Cofigure ad Ru WebLogic Process Itegrator usig WebLogic Server Copy the licese-group sectio from the XML Traslator licese file (licese.bea) to the WebLogic Process Itegrator licese file. For details o this procedure, refer to the BEA WebLogic XML/No-XML Traslator Release Notes ad the WebLogic Process Itegrator documetatio. BEA WebLogic XML/No-XML Traslator Samples Guide 2-13

36 2 Ruig the WebLogic Process Itegrator Sample Applicatios 2. Deploy the sample beas by addig a etry to the WebLogic Properties file. For example: weblogic.ejb.deploy=d:/beahome/wlxt1.0/samples/ejb/lib/wlxtejb51.jar 3. Add the full path ad file ame of the followig.jar files to the server.cmd file used to start the WebLogic Process Itegrator Server. xmlx.jar dom2.jar sax2.jar ebase.jar wlxt.jar 4. I the WebLogic Process Itegrator home directory, create a subdirectory called mflrepos. 5. Copy the two sample.mfl files icluded with this sample (Payroll.mfl ad HR.mfl) to the ew subdirectory. 6. Start the WebLogic Process Itegrator Server. 7. Ru WebLogic Process Itegrator Studio. Step 2. Cofigure ad Ru WebLogic Process Itegrator usig WebLogic Server Copy the licese-group sectio from the XML Traslator licese file (licese.bea) to the WebLogic Process Itegrator licese file. For details o this procedure, refer to the BEA WebLogic XML/No-XML Traslator Release Notes ad the WebLogic Process Itegrator documetatio. 2. Copy the file WLXTEJB60.jar from the \samples\wlpi\ejb\lib directory where you have XML Traslator istalled to the \lib directory where you have WebLogic Process Itegrator istalled. 3. Ope the file cofig.xml i a text editor. This file ca be foud i the directory <BEA_Home>\wlserver6.0\cofig\<domai_ame>. 4. Add the followig lies to the ed of the WebLogic Process Itegrator Applicatio sectio of the file: <EJBCompoet Name= wlxt-sample Targets= <your_machie_ame> 2-14 BEA WebLogic XML/No-XML Traslator Samples Guide

37 Ruig the WebLogic Process Itegrator EJB Sample URI= WLXTEJB60.jar /> Figure 2-5 shows a example of the Applicatio sectio of the cofig.xml file with the above lies added. Figure 2-5 Sample cofig.xml file 5. Add the full path ad file ame of the followig.jar files to the server.cmd file used to start the WebLogic Process Itegrator Server. xmlx.jar dom2.jar sax2.jar ebase.jar wlxt.jar 6. I the WebLogic Domai home directory, create a subdirectory called mflrepos. By default, this directory is: $BEA_Home/wlserver60 BEA WebLogic XML/No-XML Traslator Samples Guide 2-15

38 2 Ruig the WebLogic Process Itegrator Sample Applicatios 7. Copy the two sample.mfl files icluded with this sample (Payroll.mfl ad HR.mfl) to the ew subdirectory. 8. Start the WebLogic Process Itegrator Server. 9. Ru WebLogic Process Itegrator Studio. Step 2. Create the Busiess Operatios for the Workflow You eed to create seve busiess operatios for the sample. These busiess operatios are refereced by the sample workflow; therefore, their ames must exactly match the list below. Create XML/oXML Traslatio Bea Create Example HR Bea Get Employee Ifo Traslate Biary to XML Create Example Payroll Bea Post Payroll Data Traslate XML to Biary Notes: The ames of these operatios must exactly match the above list. Busiess operatio ames are case-sesitive. To create the busiess operatios: 1. Choose Cofigure Busiess Operatios ad click Add. 2. Eter the iformatio for each busiess operatio as show i each of the seve dialog illustratios that follow. 3. After you eter the iformatio i the dialog, click OK. 4. Repeat steps 1 through 3 for each busiess operatio BEA WebLogic XML/No-XML Traslator Samples Guide

39 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-6 Create XML/oXML Traslatio Bea Busiess Operatio BEA WebLogic XML/No-XML Traslator Samples Guide 2-17

40 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-7 Create Example HR Bea Busiess Operatio 2-18 BEA WebLogic XML/No-XML Traslator Samples Guide

41 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-8 Get Employee Ifo Busiess Operatio BEA WebLogic XML/No-XML Traslator Samples Guide 2-19

42 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-9 Traslate Biary to XML Busiess Operatio 2-20 BEA WebLogic XML/No-XML Traslator Samples Guide

43 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-10 Create Example Payroll Bea Busiess Operatio BEA WebLogic XML/No-XML Traslator Samples Guide 2-21

44 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-11 Post Payroll Data Busiess Operatio 2-22 BEA WebLogic XML/No-XML Traslator Samples Guide

45 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-12 Traslate XML to Biary Busiess Operatio The followig dialog shows a list of the completed busiess operatios. BEA WebLogic XML/No-XML Traslator Samples Guide 2-23

46 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-13 List of Completed Busiess Operatios 5. Click Doe whe you have fiished creatig the Busiess Operatios. Step 3. Create the Template ad Import the Template Defiitio To create the template ad import the template defiitio: 1. Create a ew template called WLXT Example. 2. Select the template from the tree view i the left pae ad click the right mouse butto. 3. Choose Import Template Defiitio. 4. Select the defiitio file WLXTExample.xml. A message box opes iformig you that the busiess operatios you just created will be executed durig this workflow BEA WebLogic XML/No-XML Traslator Samples Guide

47 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-14 Import Message 5. Click OK to close the message box. A cofirmatio message displays. Figure 2-15 Import Cofirmatio Message 6. Click OK to close the message box. Step 4. Ope ad Activate the Template To ope ad activate the template: 1. Select the WLXT Example template defiitio imported i the previous step from the tree view ad click the right mouse butto. BEA WebLogic XML/No-XML Traslator Samples Guide 2-25

48 2 Ruig the WebLogic Process Itegrator Sample Applicatios 2. Choose Ope. The workflow created for this sample applicatio displays. Figure 2-16 Workflow for WLXT Example 3. Select the WLXTExample template defiitio agai from the tree view ad click the right mouse butto. 4. Choose Properties. The Template Defiitio properties dialog displays BEA WebLogic XML/No-XML Traslator Samples Guide

49 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-17 Template Defiitio 5. Click Active to activate the template ad click OK. 6. Select the WLXTExample template defiitio a third time from the tree view ad click the right mouse butto agai. 7. Choose Save to save the template defiitio with the chages you made. BEA WebLogic XML/No-XML Traslator Samples Guide 2-27

50 2 Ruig the WebLogic Process Itegrator Sample Applicatios Step 5. Start the Workflow There are two ways to start the workflow created i the sample: From the WebLogic Process Itegrator Worklist From the Commad Lie From the WebLogic Process Itegrator Worklist To start the sample workflow from the Weblogic Process Itegrator Worklist: 1. Start WebLogic Process Itegrator Worklist ad choose Workflow Start a Workflow. 2. Select WLXT Example. The template opes ad the tasks are displayed. Figure 2-18 WLXT Example Worklist 3. Select the Eter Payroll Data task ad click the right mouse butto. 4. Choose Execute. The Eter Payroll Data dialog displays BEA WebLogic XML/No-XML Traslator Samples Guide

51 Ruig the WebLogic Process Itegrator EJB Sample Figure 2-19 Eter Payroll Data From the Commad Lie 5. Eter the payroll data ad click OK. The task is started ad the workflow rus. Note: For this example, the employee umbers 1 through 4 are valid. You ca eter ay period edig date ad ay umber of hours worked. To start the sample workflow from a commad lie prompt: 1. Ope the script file (Autopay.cmd o Widows NT systems; Autopay.sh o Uix systems) i a text editor ad check the locatio of the WebLogic Process Itegrator Server. By default, the locatio is localhost ad port: Chage the locatio iformatio to match the host ad port for your system. 3. Ru the commad scripts for your system (Widows NT or Uix), passig the same parameters show i Figure For example: Autopay Figure 2-20 shows the WebLogic Process Itegrator output from executig the workflow. BEA WebLogic XML/No-XML Traslator Samples Guide 2-29

52 2 Ruig the WebLogic Process Itegrator Sample Applicatios Figure 2-20 WebLogic Process Itegrator Server Cosole 2-30 BEA WebLogic XML/No-XML Traslator Samples Guide