Professional Documents
Culture Documents
Trading Networks
Version 7.1
Cerebra,Glue,InfravioXBroker,InfravioXRegistry,Infravio,MywebMethodsServer,MywebMethods,webMethodsAccess,webMethodsAdministrator, webMethodsBroker,webMethodsCentralConfiguration,webMethodsDashboard,webMethodsDesigner,webMethodsDeveloper,webMethodsFabric, webMethodsGlue,webMethodsInfrastructureDataCollector,webMethodsInfravioXBroker,webMethodsInfravioXRegistry,webMethodsInstaller, webMethodsIntegrationServer,webMethodslogo,webMethodsMainframe,webMethodsManager,webMethodsModeler,webMethodsMonitor, webMethodsOptimizeforInfrastructure,webMethodsOptimizeforProcess,webMethodsOptimize,webMethodsPortal,webMethodsProcessEngine, webMethodsServicenet,webMethodsTaskEngine,webMethodsTradingNetworks,webMethodsWorkflow,andwebMethodsareeitherregistered trademarksortrademarksofwebMethods,Inc. Acrobat,Acrobat,andReaderareregisteredtrademarksofAdobeSystemsIncorporated.AmdocsandClarifyCRMareregisteredtrademarksofAmdocs. AribaisaregisteredtrademarkofAriba,Inc.BEA,BEAWebLogicServer,Jolt,andTuxedoareregisteredtrademarks,andBEAWebLogicPlatformisa trademarkofBEASystems,Inc.ActionRequestSystem,BMCSoftware,PATROL,andRemedyareregisteredtrademarksofBMCSoftware,Inc.BroadVision isaregisteredtrademarkofBroadVision,Inc.ChemeStandardsandCIDXaretrademarksofCIDX,TheChemicalIndustryDataExchange.SiteMinderand UnicenterareregisteredtrademarksofCA,Inc.PopChartisaregisteredtrademarkofCORDATechnologies,Inc.KenanandArborareregisteredtrademarks ofAlcatelLucent.DataConnectionandSNAPIXareregisteredtrademarksofDataConnectionCorporation.D&BandDUNSareregisteredtrademarksof Dun&BradstreetCorporation.EclipseisatrademarkofEclipseFoundation,Inc.EntrustisaregisteredtrademarkofEntrust,Inc.papiNetisaregistered trademarkoftheEuropeanUnionandtheUnitedStates.FinancialInformationeXchange,F.I.X,andF.I.XProtocolaretrademarksofFIXProtocolLtd. UCCnetandeBusinessReadyareregisteredtrademarks,and1SYNCandTransoraaretrademarksofGS1US.HewlettPackard,HP,HPUX,OpenView,PA RISC,andSNAplus2aretrademarksofHewlettPackardCompany.i2isaregisteredtrademarkofi2Technologies,Inc.AIX,AS/400,CICS,ClearCase,DB2, Domino,IBM,Informix,Infoprint,Lotus,LotusNotes,MQSeries,OS/390,OS/400,RACF,RS/6000,SQL/400,S/390,System/390,VTAM,andWebSphere,and z/OSareregisteredtrademarks;andCommunicationsSystemforWindowsNT,DB2UniversalDatabase,IMS,MVS,andSQL/DSaretrademarksofIBM Corporation.InnoDBisatrademarkofInnobaseOy.ItaniumisaregisteredtrademarkofIntelCorporation.LinuxisaregisteredtrademarkofLinus Torvalds.W3Cisaregisteredtrademark,andXWindowSystemisatrademarkoftheMassachusettsInstituteofTechnology.MetaSolvisaregistered trademarkofMetasolvSoftware,Inc.ActiveX,Microsoft,Outlook,VisualBasic,VisualSourceSafe,Windows,WindowsNT,andWindowsServerare registeredtrademarksofMicrosoftCorporation.SixSigmaisaregisteredtrademarkofMotorola,Inc.FirefoxandMozillaareregisteredtrademarksofthe MozillaFoundation.MySQLisaregisteredtrademarkofMySQLAB.nCipherisatrademarkofnCipherCorporationLtd.EclipseisatrademarkofEclipse Foundation,Inc.EntrustisaregisteredtrademarkofEntrust,Inc.papiNetisaregisteredtrademarkoftheEuropeanUnionandtheUnitedStates.Financial InformationeXchange,F.I.X,andF.I.XProtocolaretrademarksofFIXProtocolLtd.UCCnetandeBusinessReadyareregisteredtrademarks,and1SYNCand TransoraaretrademarksofGS1US.HewlettPackard,HP,HPUX,OpenView,PARISC,andSNAplus2aretrademarksofHewlettPackardCompany.i2isa registeredtrademarkofi2Technologies,Inc.AIX,AS/400,CICS,ClearCase,DB2,Domino,IBM,Informix,Infoprint,Lotus,LotusNotes,MQSeries,OS/390, OS/400,RACF,RS/6000,SQL/400,S/390,System/390,VTAM,andWebSphere,andz/OSareregisteredtrademarks;andCommunicationsSystemforWindows NT,DB2UniversalDatabase,IMS,MVS,andSQL/DSaretrademarksofIBMCorporation.InnoDBisatrademarkofInnobaseOy.Itaniumisaregistered trademarkofIntelCorporation.TeradataisaregisteredtrademarkofNCRCorporation.NetscapeisaregisteredtrademarkofNetscapeCommunications Corporation.ServletExecisaregisteredtrademark,andNewAtlantaisatrademarkofNewAtlantaCommunications,LLC.SUSEisaregisteredtrademark ofNovell,Inc.AppiaisaregisteredtrademarkandJavelinTechnologiesisatrademarkofNYFIX,Inc.CORBAisaregisteredtrademarkofObject ManagementGroup,Inc.JDEdwards,OneWorld,Oracle,PeopleSoft,Siebel,andVantiveareregisteredtrademarks;andInfranet,PeopleSoftPureInternet Architecture,Portal,andWorldSoftwarearetrademarksofOracleCorporation.PerforceisatrademarkofPerforceSoftware.JBossandRedHatare registeredtrademarksofRedHat,Inc.PIPandRosettaNetaretrademarksofRosettaNet,anonprofitorganization.SAPandR/3areregisteredtrademarks ofSAPAG.PVCSisaregisteredtrademarkofSerenaSoftware,Inc.SWIFTandSWIFTNetareregisteredtrademarksofSocietyforWorldwideInterbank FinancialTelecommunicationSCRL.SPARCandSPARCStationareregisteredtrademarksofSPARCInternational,Inc.BAANandSSAareregistered trademarks;andSSAGlobalisatrademarkofSSAGlobalTechnologies,Inc.EJB,EnterpriseJavaBeans,Java,JavaServer,JDBC,JSP,J2EE,Solaris,Sun,and SunMicrosystemsareregisteredtrademarks;andJavaNamingandDirectoryInterface,JavaServerPages,SOAPwithAttachmentsAPIforJava,andSunSoft aretrademarksofSunMicrosystems,Inc.SybaseisaregisteredtrademarkofSybase,Inc.VERITASisaregisteredtrademark,andVERITASClusterServeris atrademarkofSymantecCorporation.UNIXisaregisteredtrademarkofTheOpenGroup.UnicodeisatrademarkofUnicode,Inc.VeriSignisaregistered trademarkofVerisign,Inc. SoftwareAGandallSoftwareAGproductnamesareeithertrademarksorregisteredtrademarksofSoftwareAG. Otherproductandcompanynamesmentionedhereinmaybethetrademarksoftheirrespectiveowners. Copyright20052007webMethods,Inc.Allrightsreserved. Copyright20052007SoftwareAGand/oritssuppliers,Uhlandstrasse12,64297Darmstadt,Germany.Allrightsreserved.
Contents
Contents
About This Guide. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7
7 8
9
10 10 11 12 12 14 15 16 16
17
18 18 19 19 20 20 21 22 22 23
25
26 27 28 28 29 30 31 33 33
Contents
Information You Supply to Define TN Flat File Document Types . . . . . . . . . . . . . . . . . . . . Unknown TN Document Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Criteria . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Pre-processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Scheduled Delivery Queues and Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
34 35 36 37 38 38 39
41
42 42 42 43 43 44 44 46 48
51
52 53 55 56 56 56 59 60 61 63 64 65 66 66 67 67 67 68 68
Contents
71
72 73 74 75 75 76 76 77 77 79 80 80 80 81 82 83
85
86 86 87 88
91
92 93 94 94 95 96 96 97
99
100 100 102 102 103
Contents
Appendix A. Glossary for Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105 Appendix B. Security within Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Overview of Security Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Communicating Securely Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Protecting Access to User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access to My webMethods for Trading Networks Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access to Trading Networks User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Protecting Partner Profile Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Protecting Access to Trading Networks Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Access Control Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Certificates for Verifying, Signing, Encrypting, and Decrypting Documents . . . . . . . . . . . . . . . . . . . . Verifying Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Actions You Must Take to Verify Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Verifies Digital Signatures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Digitally Signing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Signs Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Encrypting and Decrypting Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Encrypt Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Encrypts Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Decrypt Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How Trading Networks Decrypts Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 116 116 116 118 118 119 119 120 121 121 122 122 123 123 123 123 124 124
ThismanualisforusersofwebMethodsTradingNetworksandwebMethodsforPartners andprovidesanoverviewofwebMethodsTradingNetworks(TradingNetworks).It containsinformationtofamiliarizeyouwithusingTradingNetworksanddescribeshow tomonitorTradingNetworksdata. Note: ThewebMethodsTradingNetworksandwebMethodsforPartnerscomponents performthesamefunctionality.Thedifferencebetweenthecomponentsisthat webMethodsTradingNetworksallowsyoutohaveasmanypartnersinyournetworkas youwant,andwebMethodsforPartnersallowsyoutohaveonlyasinglepartner.This guideprovidesdocumentationforbothcomponentsalthoughitrefersonlyto webMethodsTradingNetworks(referredtoasTradingNetworks).
Document Conventions
Convention Bold Italic Description Identifieselementsonascreen. Identifiesvariableinformationthatyoumustsupplyorchange basedonyourspecificsituationorenvironment.Identifiestermsthe firsttimetheyaredefinedintext.Alsoidentifiesserviceinputand outputvariables. IdentifiesstoragelocationsforservicesonthewebMethods IntegrationServerusingtheconventionfolder.subfolder:service. Identifiescharactersandvaluesthatyoumusttypeexactlyor messagesthatthesystemdisplaysontheconsole. Identifieskeyboardkeys.Keysthatyoumustpresssimultaneously arejoinedwiththe+symbol. Directorypathsusethe\directorydelimiterunlessthesubjectis UNIXspecific. Optionalkeywordsorvaluesareenclosedin[].Donottypethe[] symbolsinyourowncode.
Narrow font
Typewriter font
UPPERCASE \ []
Additional Information
ThewebMethodsAdvantageWebsiteathttp://advantage.webmethods.comprovidesyou withimportantsourcesofinformationaboutwebMethodsproducts: Troubleshooting Information.ThewebMethodsKnowledgeBaseprovides troubleshootinginformationformanywebMethodsproducts. Documentation Feedback.ToprovidefeedbackonwebMethodsdocumentation,goto theDocumentationFeedbackFormonthewebMethodsBookshelf. Additional Documentation.Startingwith7.0,youhavetheoptionofdownloadingthe documentationduringproductinstallationtoasingledirectorycalled _documentation,locatedbydefaultunderwebMethodsinstallationdirectory.In addition,youcanfinddocumentationforallwebMethodsproductsonthe webMethodsBookshelf.
What Is a Trading Network? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 What Is webMethods Trading Networks? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10 Architecture and Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11 Partners in a Trading Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 Document Processing with Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Overview of Trading Networks Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15
10
Trading Networks
WmTN package WmTNWeb package
Relational Database
Integration Server
My webMethods ServeristheruntimecontainerforfunctionsthatwebMethods componentsmakeavailable.Forexample,TradingNetworksmakesthefunctionsto monitorandmanagetransactionsavailable.UsersaccessthesefunctionsfromtheMy webMethodsuserinterface.Forexample,whenausermonitorsatransaction,My webMethodsServerhandlestherequestbyinteractingwithTradingNetworksto performthefunctionandreturninformationtotheuser. Trading NetworksWmTNandWmTNWebpackagesrunwithintheIntegrationServer. Thepackagesprovidethelogictohandlethemanagementofpartnersonyour networkandtheexchangeofdocuments.YoucaninteractwiththeTradingNetworks viatheuserinterfaces.Yourpartnersinteractwiththeservertoexchangebusiness documents. Note: TheWmTNWebpackage,whichisforWebManager,isdeprecated. Integration Serverhostspackagesthatcontainservicesandrelatedfiles.TheIntegration Serverprovidesanenvironmentfortheorderly,efficient,andsecureexecutionof services. Relational database (RDBMS)thatTradingNetworksusestostoreallinformationabout thetradingnetwork:partnerinformation,thetypesofdocumentstoprocess,howto processbusinessdocuments,informationaboutbusinessdocumentsthatpass throughthenetwork,loginformation,etc.Youneedtoinstallarelationaldatabasefor TradingNetworksuse,forexample,OracleorSQLServer.
11
My webMethodsisawebbased,administrationandmonitoringuserinterfacefor managingyourwebMethodscomponents.YoucanuseittomonitorTrading Networkstransactions,serviceexecutiontasks,deliverytasks,andtheactivitylog. Additionally,youcanusewebMethodstomanageprofiles,profilegroups,and TradingNetworksqueues. Trading Networks Console,whichisaJavabasedGUI,isaTradingNetworksuser interfaceprimarilyfordesigninghowyouwantTradingNetworkstorecognize documentsusingTNdocumenttypesandhowTradingNetworksprocesses documents.YoucanalsouseittoperformfunctionsthathavebeenmigratedtoMy webMethods.Theseportions(e.g.,transactionanalysis,tasks,andactivitylog viewing,profilemanagement)oftheConsolethathavebeenmigratedtoMy webMethodsaredeprecated. Trading Networks Web Manager isanotheruserinterfaceforTradingNetworksthatyou accessviaaWebbrowser.TradingNetworksWebManagerisdeprecated.Itoffers someofthefunctionalityoftheTradingNetworksConsoleplusadditional administrativeactions.
12
A Trading Network
Trading Networks Integration Server Trading Networks Integration Server Trading Networks Integration Server DB Trading Networks Integration Server Integration Server Application Server
Marketplace
DB
DB
DB
13
DB
DB Trading Networks Integration Server Trading Networks Integration Server DB hub and spoke DB Trading Networks Integration Server
DB
DB
14
Tospecifyhowtoexchangedocuments,youdefine: Profilesforpartners;thatis,theinformationyouwanttocollectandmaintainabout yourpartners.AprofilecontainstheinformationthatTradingNetworksneedsto exchangedocumentswithyourpartners. TN document typesthatspecifythetypesofbusinessdocumentsthatyouwantto exchangewithyourpartners.Thebusinessdocumentsmightconformtoanindustry standard,suchas,cXML,CBL,OAG,andEDI,orhaveyourowncustomized specifications. Processing rulesthatindicatehowyouwantTradingNetworkstoprocessdocuments astheytraverseyourtradingnetwork. Afteryouhaveyourtradingnetworkestablished,youuseTradingNetworkstomanage andmaintainyourtradingnetwork.
Trading Partner
Client
Receiver
Step
1 2
15
Design Time
Atdesigntime,youdefinethefollowingobjectsforTradingNetworks: Define for Trading Networks Profiles TN document types Document attributes
Description Identifiesthepartnersyouwant TradingNetworkstointeractwith. Definesthetypesofdocumentsthat youwantTradingNetworksto recognizeandprocess. Identifiesthepiecesofinformation withinthedocumentsthatare importanttoyouforprocessing documentsandforlateranalyzing thedocumentsthathavepassed throughyournetwork. Definestheactionsyouwant TradingNetworkstotakeagainst thedocumentsitreceives,for example,deliveringthedocument toitsreceiver.
Processing rules
Run Time
Atruntime,thefollowingactionsoccur: Action for Trading Networks Aclientorbackendsystemsendsadocumentto TradingNetworks TradingNetworksprocessesthedocument For more information, see... Chapter 4,Sending DocumentstoTrading NetworksforProcessing Chapter 5,Trading NetworksDocument Processing Chapter 6,Delivering DocumentstoPartners
TradingNetworkscandeliverthedocumenttoa tradingpartner
16
Overview of Trading Partner Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18 Profile Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Profile Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Trading Partner Agreements (TPAs) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
17
2. Trading Partners
Profiles
Aprofileisacollectionofinformationaboutacorporationthatisapartofatrading network.TradingNetworksmaintainsyourprofile(calledtheEnterpriseprofile),aswellas theprofileofeachofyourtradingpartnersonyournetwork. Theinformationinaprofileencompassesbothtechnical(e.g.,HTTPportnumber)and businesslevel(e.g.,paymentterms)information.Youfillinprofilefieldstodefinethe informationforaprofile.Aprofilecontainsstandardprofilefieldsthatareprovided outoftheboxandextendedprofilefieldsthatyoudefine.Formoreinformation,see ProfileFieldsonpage 19. Theinformationintheprofileincludesthefollowingtypesofinformation: Generalinformationaboutthecorporation,forexample,thecorporationnameandits address. Contactinformationforthecorporation,forexample,atechnicalcontact. Informationabouthowdocumentsshouldbedeliveredtothecorporation,for example,theHTTPhostnameandportnumbertousetodeliveradocumenttothe corporationviaHTTP. Certificateinformationfordigitalsigningofdocuments,verifyingdigitalsignatures, encryptinganddecryptingdocuments. AnyinformationthatyouwanttoincludeintheprofilethatTradingNetworksdoes notprovide.Youdefineextendedfieldsforthisinformation.
18
2. Trading Partners
For more information about: Definingprofiles,seeChapter9,DefiningandManagingYourProfile(Your Enterprise),AppendixH,ManagingYourProfileUsingtheConsole, Chapter10,DefiningandManagingPartnerProfiles,andAppendixI, ManagingPartnerProfilesUsingtheConsoleinthewebMethodsTrading NetworksAdministratorsGuide. Certificateinformation,see,Appendix B,SecuritywithinTradingNetworks.
Profile Status
TradingNetworksmaintainsastatusfortheprofileofeachpartner.Afteryouadda profileforapartnerandTradingNetworksvalidatesthefields,TradingNetworkssaves theprofileandsetsprofilestatustoInactive.Beforeyoucanexchangedocumentswith thepartner,youmustenabletheprofilebyupdatingthestatustoActive.Whenyou enableyourownprofile,youareabletoexchangedocumentswithpartners.Whenyou enableapartnersprofile,youareabletoexchangedocumentswiththatpartner. Thefollowingtableshowsthepossibleprofilestatusesandtheirmeanings: Value Active Meaning YouhavefilledinthepartnersprofileandTradingNetworkshas programmaticallydeterminedthatallprofilefields(standardandextended) arevalid.YouhaveenabledtheprofilebysettingthestatustoActive. Whenthepartnersprofileisactive,youcanexchangedocumentswiththe partner. Inactive Whenapartnersprofileisinactive,youcannotexchangedocumentswith thispartner. Eitheryouhavejustaddedtheprofileandhavenotyetenabledit,oryou havedisabledtheprofile.
Profile Fields
Profilefieldsarethefieldsinaprofile.Eachprofilefieldrepresentsinformationthatyou cancollectandmaintainaboutyourownenterpriseandtheenterprisesofeachpartnerin yournetwork.Therearetwotypesofprofilefieldsstandardandextended. Standard fieldsareTradingNetworksdefinedfieldsthatincorporatethemajorityofthe informationthatyouwillwanttocollectandmaintainaboutapartner.Theseprofile fieldsareavailableoutofthebox. Mostofthestandardfieldsareforyourownuse,forexample,thenameofthe corporationanditsmailingaddress.However,TradingNetworksrequiressomeof
19
2. Trading Partners
thestandardfieldstooperatenormally,forexample,thehostandportnumberthata partnerusesforHTTPtodeliveradocumenttothepartnerviaHTTP. Extended fieldsarecustomfieldsthatyoudefinetoextendthestandardprofilethatare providedoutofthebox.Ifyouwanttocollectadditionalinformationaboutyour partnersthatisnotcoveredbythestandardfields,youcandefineextendedfields.If youdefineextendedfields,allprofilesonyourTradingNetworkssystemwillcontain thestandardfieldsandtheextendedfieldsthatyoudefine. Bothstandardandextendedprofilefieldsare1)haveadatatypeand2)canberequired. For more information aboutdefiningprofilefields,seeChapter8,Definingand ManagingProfileFieldsandAppendixG,ManagingProfileFieldsUsingthe ConsoleinthewebMethodsTradingNetworksAdministratorsGuide.
Required Fields
Arequiredfieldisonethatyouwantsuppliedforallprofiles,bothyourprofileandyour partners. Severalofthestandardfieldsarerequired.Ifyouwant,youcanchangestandardfields thatcomeoutoftheboxasnonrequiredtorequired.Whenyouaddyourownextended fields,youcanmakethemrequired. Eachprofileonyoursystemmusthaveavalueforeachrequiredprofilefieldbeforeyou canmaketheprofileactive.Inotherwords,apartnersprofilemustcontainavalidvalue forallrequiredfieldsbeforeyoucanenablethepartnersprofileandthereforemakethe partneranactivememberinthetradingnetworkfromwhichTradingNetworkswill acceptdocumentsandtowhichTradingNetworkscansenddocuments. InMywebMethodsandtheTradingNetworksConsole,TradingNetworksplacesan asterisk(*)nexttotherequiredfields,soyoucaneasilyseethefieldsthatarerequired.
20
2. Trading Partners
TradingNetworksdoesnotuseTPAsforitsownprocessing.Forexample,Trading NetworksdoesnotuseTPAswhendeterminingtheprocessingrulestousefora document.RathertheparametersthatyouspecifyintheTPAareavailableforyourown use.Forexample,youcanaccesstheTPAinformationfromservicesexecutedbya processingrule.Accesstothisinformationallowsyoutobuildadocumentexchange applicationthatusestheTPAtotailortheexchangeofdocumentsbetweenpartners. OtherwebMethodscomponentstakeadvantageoftheTPAfeatureinTradingNetworks. Forexample,thewebMethodsebXMLModuleusestheTPAfeaturetosupportebXML CollaborationProtocolAgreements(CPAs).Formoreinformation,seethewebMethods ebXMLUsersGuide. Basedonthedocumentexchangeprocessingthatyouwanttoputintoeffect,youdefine theparametersthatyouwantsavedintheTPA.Thesetofparameterscanbedifferentfor differenttypesofTPAs.Forexample,youmightuseTPAsforpartnersthatexchange documentsusingebXMLthatcontaintheparametersdefinedbythewebMethodsebXML Module.OtherpartnersmightexchangedocumentsusingEDI,andforthosepartnersyou createTPAsthatcontainparametersdefinedbythewebMethodsEDIModule.Formore information,seethewebMethodsEDIModuleUsersGuide. For more information abouthowtodefineTPAs,seeChapter12,DefiningandManaging TradingPartnerAgreements(TPAs)inthewebMethodsTradingNetworksUsersGuide.
21
2. Trading Partners
Information in a TPA
WhenyoudefineaTPA,youassignthefollowinginformation: ThepartnerthatrepresentsthesenderfortheTPA. ThepartnerthatrepresentsthereceiverfortheTPA. AnagreementIDtoidentifythetypeofTPA(e.g.,TPAsforthewebMethodsEDI ModuleusetheagreementIDEDITPA). TheTPAdatathatcontainstheapplicationspecificvariablestousetotailorthe processingofdocumentsexchangedbetweenthesenderandreceiver.Youspecifythis databydefininganISdocumenttypethatdefinesthestructureofthedatatoprovide. YousupplyvaluesforthevariablesdefinedbytheISdocumenttype.Forexample,the webMethodsEDIModuleshipswithanISdocumenttype(thewm.b2b.editn.TPA:EDITPA ISdocumenttype)touseforTPAsforpartnersexchangingEDIdocuments.ThisIS documenttypecontainsasetofvariablesthatareusedforprocessingEDIdocuments. Optionally,anexportservicethatyousupplytoexporttheTPAdata. Optionally,aninitializationservicethatyousupplytoinitializetheTPAdata(e.g.,the webMethodsEDIModulesuppliesaninitializationservicetosettheTPAvaluestoits defaultvalues).
22
2. Trading Partners
TPA Statuses
TPAshavetwotypesofstatusesagreementstatusanddatastatus. 1 Agreement status.IndicatesthestatusoftheTPAagreementbetweenthereceiverand sender.TherearethreeTPAagreementstatuses. Proposed WhentheagreementstatusisProposed,aTPAisinadraftstatus.Youdomostof themodificationtotheTPAfieldsanddatainputinthisProposedstate. Agreed AnAgreedstatusmeansthattheTPAisfinal.Whentheagreementstatusis Agreed,thedatastatusestakeaffect.Additionally,aftertheagreementstatusis Agreed,youcannotdeletetheTPAagreement. Disabled TheDisabledstatusmeanstheTPAshouldnotbeused.IfyouareusingaTPA andnolongerwanttouseit,youcandisableit.WhenyoudisableaTPA,theTPA remainsintheTradingNetworkssystem,butisconsideredinactive.Later,ifyou decidethatyouneedtheTPA,youcanchangetheagreementstatustoProposed orAgreed. webMethodscomponentsthatusetheTPAfeaturerecognizeaDisabled agreementstatusforaTPA.Forexample,ifthewebMethodsebXMLModule attemptstouseaTPAwithaDisabledstatus,itactsasifthereisnoTPA.Ifyou createanapplicationthatusesTPAs,itshouldcheckandhonortheDisabled status. 2 Data status.ThedatastatusdetermineswhetheryoucanmodifytheTPAdata,whichis datathatyousupplyfortheISdocumenttypeyoudefinefortheTPA.Thatis,the TPAdataisthedatafortheapplicationspecificvariablestousetotailorthe processingofdocumentsexchangedbetweenasenderandreceiver.TheTPAdata statuscanbe: Modifiable.YoucanchangeTPAdata;thatisyoucanchangethevaluesofthe variablesintheISdocumenttypeassociatedwiththeTPA. Non-modifiable.YoucannotchangetheTPAdata;thatisyoucannotchangethe valuesofthevariablesintheISdocumenttypeassociatedwiththeTPA. Note: ThedatastatusisonlyeffectivewhentheAgreementstatusisAgreed.Whenthe AgreementstatusisProposed,TradingNetworksallowsyoutomakeanychangesto theTPA,includingchangingtheTPAdata.
23
2. Trading Partners
24
Overview of Items to Set Up for Processing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Document Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 TN Document Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 Processing Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
25
26
Document Attributes
Documentattributesidentifyselectedcontentfromthedocumentsthatpassthroughyour tradingnetwork.Thisselectedcontentisinformationinthedocumentsthatyouare interestedin,forexample,apurchaseordernumberortheaccountnumberofa purchaser.YoualsousethedocumentattributesformonitoringbywebMethodsOptimize forB2B,forexample,acomparativeanalysisofallthepurchaseorderquantitiesbya particularcustomer.Formoreinformation,seeChapter 9,BusinessAnalysisand MonitoringofTradingNetworksTransactionData. TradingNetworksmaintainstwotypesofattributessystemattributesandcustom attributes. System attributesareTradingNetworksdefinedattributes.Thesystemattributesare: SenderID ReceiverID DocumentID UserStatus GroupID ConversationID Identificationofthesenderofadocument Identificationofthereceiverofadocument Identificationofthedocument Thestatusthatyouorapartnerassociatewiththedocument Identificationwithinadocumentthatassociatesadocument withotherdocumentsinagroup Identificationwithinadocumentthatassociatesthisdocument withotherdocumentsinthesamebusinessprocess(or conversationofdocuments) Portionofadocumentthatcontainsdatathatwasdigitally signed Portionofadocumentthatcontainsthedigitalsignatureofthe document
SignedBody Signature
Althoughyoudonotdefinethesystemattributes,ifyouwantTradingNetworksto extractasystemattributefromadocument,youmustspecifythatsystemattributein theTNdocumenttype.Formoreinformation,seeHowDocumentAttributesRelate toTNDocumentTypesonpage 28. Custom attributesareattributesthatyoudefinetoidentifyanyothercontentthatyou areinterestedinextractingfromdocuments.Forexample,toextractthepurchase ordernumberfromdocuments,youmightdefineadocumentattributenamed PO_Number.Toextractthetotalamountofapurchaseorder,youmightdefinea documentattributenamedTotal_Order_Amount.
27
WhenyouenableTradingNetworkswithBAM,youcanmonitorboth,system attributesandcustomattributes.TradingNetworksalwaysextractsthesystem, attributes,SenderID,ReceiverID,andInternalIDformonitoring. For more information about: Systemandcustomdocumentattributes,includinghowtodefinecustom attributes,seeChapter13,DefiningandManagingDocumentAttributesinthe webMethodsTradingNetworksAdministratorsGuide. EnablingBAMwithTradingNetworks,seeChapter 9,BusinessAnalysisand MonitoringofTradingNetworksTransactionData.
28
The definition of a TN document type specifies how to locate the attributes in the specific type of document.
<POID>A230</POID>
Document Attribute Name = PO_Number Type = Number Description = Purchase Order Number TN Document Type Name = cXML PO . . . Attributes PO_Number . . .
Document #3 <!-- CBL --> <BuyerRefNum> <Reference> <RefNum> 100 </RefNum> </Reference> </BuyerRefNum>
29
systemattributesoTradingNetworkscandeterminethepartnerthatistoreceivethe document. If you save attribute values to the database, you can query the database based on attribute values to locate specific documents.Forexample,youmightwanttolocatealldocumentsthat weresentbyPartnerAandhaveandforwhichthecustomattributefortotalamount ofapurchaseorder(Total_Order_Amountcustomattributethatyoudefine)isgreater than$10,000. If Trading Networks is BAM enabled, Trading Networks passes the attribute values to Optimize for monitoring:Forexample,extractingthecustomattributePO_Quantityandthesystem attributes,SenderIDandReceiverID,togenerateareportonthepurchaseorder quantitybyaparticularsenderfromaparticularreceiver. For more information about: Standardandcustomdocumentattributes,includinghowtodefinecustom attributes,seeChapter13,DefiningandManagingDocumentAttributesinthe webMethodsTradingNetworksAdministratorsGuide. HowtoextractattributesfromTNdocumenttypes,includinghowtotransform attributevaluesusingeitherthebuiltintransformationsoryourowncustom transformationservices,seeChapter14,DefiningandManagingTNXML DocumentTypesandChapter15,DefiningandManagingTNFlatFileDocument TypesinthewebMethodsTradingNetworksAdministratorsGuide. Howtodefineprocessingrulecriteriathatusesthevaluesofextractedattributes, seeChapter16,DefiningandManagingProcessingRulesinthewebMethods TradingNetworksAdministratorsGuide. Howtoquerythedatabasefordocumentsbasedonthevaluesofextracted attributes,seeChapter3,ManagingandTrackingDocumentsfromMy webMethodsandChapter8,ManagingandTrackingDocumentsfromthe ConsoleinthewebMethodsTradingNetworksUsersGuide. MonitoringtheTradingNetworksdata,seeChapter 9,BusinessAnalysisand MonitoringofTradingNetworksTransactionData. HowtodefinetheTNdocumenttypeandselectthedocumentattributesfor monitoring,seewebMethodsTradingNetworksAdministratorsGuide.
TN Document Types
TNdocumenttypesrepresentthetypesofdocumentsthatyouexpecttocomeintoyour tradingnetwork.TNdocumenttypesinclude:
30
Identification information,whichindicateshowTradingNetworksistorecognizeatype ofdocument,forexampleisthedocumentacXMLPurchaseOrder(anAribacXML purchaseorder)oracustomformatthatyouandatradingpartneruse. Extraction information, whichindicatesthedocumentattributestoextractfroman inbounddocumentthatarerequiredforfurtherprocessingormonitoring.After TradingNetworksmatchesaninbounddocumenttotheTNdocumenttype,theTN documenttypeindicatestheattributestoextractfromtheinbounddocument.For moreinformation,seeDocumentAttributesonpage 27. Pre-processing options.InaTNdocumenttype,youcanspecifypreprocessingoptions thatTradingNetworksperformsbeforeitperformstheactionsspecifiedbya processingrule.Formoreinformation,seePreprocessingActionsonpage 38. TradingNetworkssupportsTNdocumenttypesfortwocategoriesofdocuments: XMLdocuments Flatfiledocuments FormoreinformationabouthowTradingNetworksusesTNdocumenttypesatruntime, seeRecognitionProcessingonpage 55.
31
queriesthatTradingNetworksusestolocatetheattributeswithintheXML documents.ForTradingNetworkstoextractavalue,thenodethattheXQLquery identifiesmustexistintheXMLdocument.Optionally,intheextractioninformation, youcanspecifythatyouwantTradingNetworkstouseabuiltintransformationor invokeacustomtransformationserviceagainsttheattributevaluetoalterthevalueof theextractedattribute.Forexample,youmightwantTradingNetworkstotransform aSTRINGvalueintoalluppercasecharacters. Namespace mappings.IftheXMLdocumentsusenamespaces,youshouldspecify namespacemappingstodescribethenamespacesthatXMLdocumentsmightuse. NamespacesareusedinanXMLdocumenttodistinguishbetweenelementsthatcome fromdifferentsources.Asetofelements(ortags)fromaspecificsourceisassignedto aspecificnamespace.EachnamespaceisassociatedwithaURI,whichisusedto uniquelyidentifythenamespace.Namespacemappingsmaptheprefixesusedby namespacestotheURIsusedbythosenamespaces.FormoreinformationaboutXML namespaces,seetheXMLNamespacespecificationathttp://www.w3.org/. WhenyoudefinenamespacemappingsinaTNXMLdocumenttype,Trading NetworksusesthenamespacemappingsyouspecifywhenapplyingXQLqueries againsttheXMLdocument.Thatis,TradingNetworksusesthenamespacemappings forboththeidentifyingXQLqueriesandtheXQLqueriestoextractattributes. Options.Youcanusetheoptionstodefineitemsforlaterprocessing.Whenspecifying theoptionsforanXMLdocument,youcanspecify: AnISdocumenttypethatdefinesthestructureoftheXMLdocumentandthat canbeusedtoparsetheXMLdocumentintoanIDataobject.TradingNetworks usestheISdocumenttypeifyouinvokethewm.tn.doc.xml:bizdocToRecordserviceto convertthedocumentcontentintheBizDocEnvelopetoanIDataobject. AnISschemathatdefinesthestructureoftheXMLdocument.TradingNetworks usesthisISschemaifyouindicateyouwanttoTradingNetworkstoperformthe preprocessingactiontovalidatethestructureoftheXMLdocument. WhetheryouwantTradingNetworkstoperformanyorallofthepreprocessing actions.PreprocessingactionsareactionsthatTradingNetworksperformsbefore usingtheprocessingruleactionstoprocesstheXMLdocument.Formore information,seePreprocessingActionsonpage 38. Note: YouspecifypreprocessingactionsinbothTNXMLdocumenttypesand processingrules.Thepreprocessingactionsinaprocessingruleindicatewhether TradingNetworksistousethesettingsfromtheTNdocumenttypeortooverride theTNdocumenttypesettings. WhetheryouwantTradingNetworkstoprocessadocumentusingaprocessing ruleorwanttopreventTradingNetworksfromperformingprocessingrule actions.Whenyoudisableprocessingrulerouting,TradingNetworksonly performsthepreprocessingactionsspecifiedintheTNdocumenttype;itdoes notsearchforaprocessingrule,nordoesitperformanyprocessingruleactions.
32
33
34
WhetheryouwantTradingNetworkstoprocessadocumentusingaprocessing ruleorwanttopreventTradingNetworksfromperformingprocessingrule actions.Whenyoudisableprocessingrulerouting,TradingNetworksonly performsthepreprocessingactionsspecifiedintheTNdocumenttype;itdoes notsearchforaprocessingrule,nordoesitperformanyprocessingruleactions. For more information about: HowtodefineTNflatfiledocumenttypes,seeChapter15,Definingand ManagingTNFlatFileDocumentTypesinthewebMethodsTradingNetworks AdministratorsGuide. Flatfileschemasandparsingflatfiles,seetheFlatFileSchemaDevelopersGuide.
35
Processing Rules
ProcessingrulesspecifyhowyouwantTradingNetworkstoprocessdocuments. ProcessingrulesdefinetheactionsthatyouwantTradingNetworkstotakefora particulardocument.Forexample,youmightwantTradingNetworkstosendanalert emailmessagetoacontactandthendeliverthedocumenttothereceiverthatisidentified inthedocument. ForeachdocumentthatTradingNetworksistoprocess,itperformsaprocessingrule lookuptodeterminewhichprocessingruletouse.Toperformthelookup,Trading Networksusescriteriathatyoudefineinprocessingrules.TradingNetworksmatches informationfromthedocumentagainstthecriteriayouspecify.AfterTradingNetworks locatesamatchingprocessingrulebasedonthecriteria,ittakestheactionsthatyou specifyinthematchingprocessingrule.
Processing Rules
If the document information matches the processing rule criteria... Information from Document sender receiver document type user status errors? custom attributes Processing Criteria sender receiver document type user status errors? custom attributes
...perform the pre-processing and processing actions specified in the processing rule. Pre-processing Actions verify validate check duplication save Processing Actions Execute a service Send an alert e-mail Change the user status Deliver the document to the receiver Respond with a message
Trading Networks
Note: IfyoudonotwantTradingNetworkstoperformanyprocessingactions,youdisable processingruleroutingfordocumentsintheTNdocumenttype.Whenprocessingrule routingisdisabled,TradingNetworksdoesnotlookupaprocessingrule.Itperformsthe preprocessingactionsasdefinedintheTNdocumenttype,butdoesnotperformany processingactions. For more information abouthowtodefineprocessingrules,seeChapter16,Definingand ManagingProcessingRulesinthewebMethodsTradingNetworksAdministratorsGuides
36
37
Pre-processing Actions
ThepreprocessingactionsspecifyactionsyouwantTradingNetworkstotakebeforeit processesthedocumentusingtheprocessingactionsyouspecify.Foralistofthe processingruleactions,seeProcessingRuleActionsonpage 38.Usepreprocessing actionstoinstructTradingNetworksto: Verifythedigitalsignatureofadocument Validatethestructureofadocument DeterminewhetherthedocumenthasalreadybeenreceivedbyTradingNetworks Savethedocumentcontent,attributevalues,and/oractivityloginformationtothe database Note: YoucanspecifypreprocessingactionsinbothTNdocumenttypesandthe processingrule.Youcanusethepreprocessingactionsintheprocessingruletooverride theactionsthatarespecifiedintheTNdocumenttype. FormoreinformationabouthowTradingNetworksusespreprocessingactionsatrun time,seePreprocessingActionsonpage 61.
38
documentsthatareinthequeue.Formoreinformationaboutqueues,see ScheduledDeliveryQueuesandProcessingRulesonpage 39. Queuethedocumentforpolling.InthissituationTradingNetworksdoesnot deliverthedocument;rather,thereceiverpollsforthedocumentatalatertime andTradingNetworksreturnsthedocumentinresponsetothepolling. Formoreinformationaboutdeliveryoptions,seeChapter 6,DeliveringDocuments toPartners. Respondtothecallerbysendingamessagebacktothesenderofthedocument. FormoreinformationabouthowTradingNetworksusesprocessingactionsatruntime, seeProcessingRuleActionsonpage 63.
39
40
Overview of Sending Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Sending Documents to Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Forwarding Documents to Another Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46 Sending a Document Back to the Same Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
41
42
43
Client Alltypesofclientsexcept browserbasedclients Alltypesofclientsexcept browserbasedclients Alltypesofclientsexcept browserbasedclients Alltypesofclientsexcept browserbasedclients Alltypesofclientsexcept browserbasedclients Alltypesofclients
Note: FormoredetailsaboutusingeachoftheabovemethodsforXMLdocuments,seethe chapteraboutpassingXMLdatatoservicesinthewebMethodsDeveloperUsersGuide. For more information about creatingclients,seethechapteraboutcreatingclientcodein thewebMethodsDeveloperUsersGuide.InthewebMethodsDeveloperUsersGuide, clientsarereferredtoasISclients.
44
XML
Trading Networks
Flat File
1. Recognize the document. 2. Extract the attributes. 3. Perform pre-processing. 4. Perform processing actions.
Step
1 2
Description TheclientorbackendsystemsendsthedocumenttoTradingNetworks. Ifthedocumentisaflatfile,theclientorbackendsystemshouldinvokethe documentgatewayservice.Formoreinformation,seeDocumentGateway Servicesonpage 33. WhenTradingNetworksreceivesthedocument,itprocessesthedocumentas definedbyTNdocumenttypesandprocessingrules. TradingNetworksperformsthefollowingtaskstoprocessthedocument: 1 RecognizesthedocumentusingtheTNdocumenttypes.Ifthedocumentis aflatfile,thedocumentfirstgoestothedocumentgatewayservice,thento TradingNetworksforrecognition.Formoreinformation,seeRecognition Processingonpage 55. Extractstheattributevaluesfromthedocumentasinstructedbythe matchingTNdocumenttype.Formoreinformation,seeRecognition Processingonpage 55. Performsthepreprocessingactionsagainstthedocumentasdefinedinthe TNdocumenttypeand/orprocessingrule.Formoreinformation,seePre processingActionsonpage 61. Performstheprocessingactionsagainstthedocumentasdefinedinthe processingrule.Formoreinformation,seeProcessingRuleActionson page 63.
45
XML
Trading Networks
1. Recognize the document. 2. Extract the attributes. 3. Perform pre-processing. 4. Perform processing actions.
Flat File
XML
Flat File
46
Trading Networks
2 3
1. Recognize the document. 2. Extract the attributes. 3. Perform pre-processing. 4. Perform processing actions; deliver the document to another Integration Server using: - Execute a service processing action - Deliver Document By processing action
Trading Networks
1. Recognize the document. 2. Extract the attributes. 3. Perform pre-processing. 4. Perform processing actions.
Step
1
2 3
TradingNetworksprocessesthedocumentasdefinedbyTNdocumenttypes andprocessingrules. Theactionsintheprocessingruleindicatetodeliverthedocumenttoanother instanceofTradingNetworks,thatis,thetargetTradingNetworks.Youcanuse eithertheExecute a serviceortheDeliver Document Byprocessingactions: WhenyouusetheExecute a serviceprocessingaction,TradingNetworks executesaservicethatyouspecify.Toforwardthedocumentthetarget TradingNetworks,thisservicecaninvokethewm.tn:receiveserviceora documentgatewayserviceonthetargetIntegrationServer. Whenyouusethe Deliver Document Byprocessingaction,TradingNetworks sendsthedocumentbeingprocessedtothepartneridentifiedasthereceiver inthedocument.TradingNetworksusesthedeliveryinformationinthe profiletodeterminehowtosendthedocumenttothetargetTrading Networks.
TheTradingNetworksreceivesthedocumentandprocessesitasdefinedbyits TNdocumenttypesandprocessingrules.
47
Trading Networks
2
1. Recognize the document. 2. Extract the attributes. 3. Perform pre-processing. 4. Perform processing actions.
Second time, use a processing rule that delivers the document back to the receiving partner. First time, use a processing rule that sends the document back to the same server.
Step
1 2
48
Step
3
Description Additionally,theprocessingactionsincludelogictosendthedocumentbackto thesameTradingNetworksforfurtherprocessing(e.g.,todeliverittothe receivingpartner).TosendthedocumentbacktothesameTradingNetworks: ForanXMLdocument,usethewm.tn.doc.xml:routeXmlserviceratherthanthe wm.tn:receiveservice. Foraflatfile,usethewm.tn.doc.ff:routeFlatFileserviceratherthanthe wm.tn:receiveservice. TradingNetworksdoesnotchecktheidentityofthesenderagainsttheISuser accountinvokingthewm.tn.doc.xml:routeXml or wm.tn.doc.ff:routeFlatFile service.(That is,TradingNetworksdoesnotchecktoensurethattheuserinvokingtheoneof theseserviceshasTradingNetworkspartnerauthorityandthatthesender identifiedwithinthedocumentisassociatedwiththepartnerthatsentthe document.)
49
50
Overview of How Trading Networks Processes a Document . . . . . . . . . . . . . . . . . . . . . . . . . . . 52 Processing of Documents in Trading Networks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53 Recognition Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55 Processing Rule Selection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60 Pre-processing Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Processing Rule Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63 Large Document Handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67
51
52
XML
4
TN document type bizdoc
Flat File
5
Select the Processing Rule to Use
6
Perform Pre-processing Actions - Verify - Validate - Check for duplicate - Save
7
Perform Processing Actions - Execute a service - Send an alert e-mail - Change the user status - Deliver the document - Respond with a message
processing rules
bizdoc
Step
1
Description TradingNetworksissentadocument(forexampleanXMLdocumentoraflat file)toprocess.ForinformationabouthowtosendadocumenttoTrading Networks,seeChapter 4,SendingDocumentstoTradingNetworksfor Processing. Ifthedocumentisaflatfile,thedocumentisfirstsenttoadocumentgateway service.ThedocumentgatewayserviceprovidesrecognitionhintsthatTrading NetworksusestohelpselectthecorrectTNdocumenttypeinthenextstep.For moreinformation,seeDocumentGatewayServicesonpage 33.
53
Step
3
Description TradingNetworksperformsrecognitionprocessing.Inrecognitionprocessing, TradingNetworksrecognizesthetypeofdocumentusingTNdocumenttypes thatyousetup. FormoreinformationaboutTNXMLdocumenttypes,seeTNXML DocumentTypesonpage 31. FormoreinformationaboutTNflatfiledocumenttypes,seeTNFlatFile DocumentTypesonpage 33. IfTradingNetworkscannotdeterminethetypeofdocument,itconsidersthe TNdocumenttypeunknown.Formoreinformation,seeUnknownTN DocumentTypeonpage 35. IfTradingNetworksdeterminesthetypeofdocument,itextractsspecificpieces ofinformationfromthedocumentbasedonthedocumentattributesyou specifyintheTNdocumenttype.Formoreinformationaboutdocument attributes,seeDocumentAttributesonpage 27andHowDocument AttributesRelatetoTNDocumentTypesonpage 28. Formoreinformationaboutthisstep,seeRecognitionProcessingonpage 55.
TheoutputoftheTradingNetworksrecognitionprocessingisaBizDocEnvelope. ABizDocEnvelopecontainstheoriginaldocument,theextractedattribute values,andadditionalinformationthatTradingNetworksrequiresforrouting andprocessingthedocument.Inotherwords,theBizDocEnveloperepresentsa routableTradingNetworkstransaction.TradingNetworksplacesthe BizDocEnvelopeinthepipelineinthebizdocvariable. Note: WhenyouenableaTNdocumenttypeformonitoring,TradingNetworks createsahashmapwithintheBizDocEnvelope,andstoresthemonitoring attributesinit.Theseattributevaluesarethenusedtocreateevents.Formore information,seeMonitoringTradingNetworksTransactionDataonpage 102. Note: YoucandefineaTNdocumenttypetoindicatethatyouwanttodisable processingrulerouting.IftheTNdocumenttypethatmatchedtheincoming documentindicatesthatprocessingruleroutingisdisabled,TradingNetworks performsthepreprocessingactionsdefinedbytheTNdocumenttype.After that,TradingNetworksdoesnotperformaprocessingrulelookup,nordoesit performanyprocessingruleactions.However,ifthedocumentispartofa businessprocess,TradingNetworkswillpassthedocumenttotheProcess Engine.Formoreinformation,seeChapter 7,SendingDocumentstoBusiness ProcessesforProcessing.
54
Step
5
Description TradingNetworksperformsprocessingruleselection.Inthisstep,Trading Networksusestheprocessingrulecriteriatolocatetheprocessingruletouse fortheinbounddocument.Formoreinformation,seeProcessingRule Selectiononpage 60. TradingNetworksperformspreprocessingactionsthatyoudefineineitherthe TNdocumenttypeortheprocessingrule.Formoreinformation,seePre processingActionsonpage 61. TradingNetworksperformstheactionsyouspecifyintheprocessingrule.For moreinformation,seeProcessingRuleActionsonpage 63. Note: IfTradingNetworkssuccessfullyextractedtheConversationIDsystem attributefromadocument,TradingNetworkspassesthedocumenttothe ProcessEngineforthedocumenttobeprocessedinabusinessprocess.You definetheactionstakeninthebusinessprocessbycreatingaprocessmodel.For moreinformation,seeChapter 7,SendingDocumentstoBusinessProcesses forProcessing.
Recognition Processing
WhenTradingNetworksreceivesaninbounddocument,thefirststepisrecognition processing;thatis,determiningtheTNdocumenttypetouse. AfterdeterminingtheTNdocumenttype,TradingNetworksusesthematchingTN documenttypetodeterminethedocumentattributevaluestoassociatewiththe documentandtheinitiallistofpreprocessingactionstoperformagainstthedocument. Note: YoucanspecifypreprocessingactionsinbothTNdocumenttypesandthe processingrule.Youcanusethepreprocessingactionsintheprocessingruletooverride theactionsthatarespecifiedintheTNdocumenttype. ThefinalstepofrecognitionprocessingistoformaBizDocEnvelopethatcontainsthe originaldocument,theextractedattributevalues,andadditionalinformationthatTrading Networksrequiresforroutingandprocessingthedocument.TheBizDocEnvelopeis passedtootherprocessinginthebizdocvariableinthepipeline. RecognitionprocessingvariesbasedonwhethertheinbounddocumentisanXML documentoraflatfiledocument.
55
56
PipelinevariablesthatyouuseintheidentificationinformationofTNflatfile documenttypes Optionally,thenameoftheTNflatfiledocumenttypeyouwantTradingNetworksto usefortheflatfile Additionally,thedocumentgatewayservicecanplaceattributesalongwiththeirvaluesin thepipeline.Becausetheattributesareinthepipeline,TradingNetworkscanincludethe attributesintheBizDocEnvelopeifinstructedtodosobythematchingTNflatfile documenttype. Thevaluesthatyourdocumentgatewayserviceplacesinthepipelinecanbehardcoded, extractedfromthecontentoftheflatfile,orderivedbysomeothermeans. ThefollowingdiagramshowshowaflatfiledocumentflowsthroughTradingNetworks andhowTradingNetworksperformsdocumentrecognitiononthatflatfile.
TN Flat File Document Type Runtime Overview
Trading Networks
3
bizdoc tn:receive
4
Recognize TN Document Type and Extract Attributes
5
Continue with Trading Networks processing
TN document type
Integration Server
Step
1
Description AusersendsaflatfiledocumenttoaTradingNetworksdocumentgateway service. Note: TradingNetworksconsidersincomingdocumentswiththetext/plain contenttypeasflatfiledocumentsbydefault.Youcanregisterothercontent typesasflatfiledocumentsaswell.Usethetn.ff.contenttypespropertyinthe properties.cnffiletoregisteradditionalflatfilecontenttypes.Formore information,seetheFlatFilePropertiesintheTradingNetworksproperties onlinehelp.
57
Step
2
Description Theflatfiledocumentpassesthroughthedocumentgatewayservice,which providesinformationhintsneededbyTradingNetworksforflatfiledocument recognition. Note: BecauseTradingNetworkslooksforthesehintsinTN_parms, applicationsthatwanttopassdataintoTradingNetworksshouldplacethe dataintheTN_parmsvariable,whichislocatedattherootofthepipeline. Thedocumentgatewayserviceperformsthefollowing: Specifiesvaluesforatleastoneofthefollowingsystemattributes: SenderID,ReceiverID,GroupID,ConversationID,DocumentID,and DoctypeIDorDoctypeNameIDintheTN_parmsvariableinthepipeline. Thesecouldbehardcodedinthegatewayservice,derivedfromthe documentcontent,orderivedbysomeothermeans. Optionally,addscustom(userdefined)attributestothepipelineinthe TN_parmsvariable. Invokesthewm.tn:receiveorwm.tn.doc.ff:routeFlatFileservice.
3 4
Thewm.tn.receive servicerecognizestheflatfiledataandcreatesabizdocfromit. Thewm.tn.receive serviceinvokestheTradingNetworksrecognitionprocess, whichdeterminestheTNflatfiledocumenttypetouseforthefile. Note: IfyouspecifythedocumenttypeIDorthedocumenttypename,(i.e.,the gatewayservicesetsthevariableDoctypeIDorthevariableDoctypeName withinTN_parms),TradingNetworkswillnotattempttodeterminewhichTN flatfiledocumenttypetouse.Instead,TradingNetworksskipsthisstepand willusetheTNflatfiledocumenttypespecifiedbyDoctypeIDorDoctypeName. TradingNetworkscompletesthebizdocbyfillinginattributevalues.TheTN documenttypehascertaincustomattributesassociatedwithit.Ifthereisa variableinthepipelineforacustomattribute(setbythegatewayservice), TradingNetworkssetsthevalueofthatattributeinthebizdoc. TheTradingNetworksrecognitionprocessreturnsabizdocandinformation aboutthesenderandreceiver.TradingNetworksaddsthebizdoctothe pipeline.
58
Step
5
Description Atthispoint,TradingNetworkshandlestheflatfilebizdocjustlikeabizdoc formedfromanXMLdocument. Ifprocessingruleroutingisenabled,TradingNetworkscontinueswiththe preprocessingactionsandtheactionsspecifiedintheprocessingrules. IftheTNdocumenttypedisabledprocessingrulerouting,Trading NetworksperformsthepreprocessingactionsdefinedbytheTN documenttype.Afterthat,TradingNetworksdoesnotperforma processingrulelookup,nordoesitperformanyprocessingruleactions. However,ifthedocumentispartofabusinessprocess,TradingNetworks willpassthedocumenttotheProcessEngine.Formoreinformation,see Chapter 7,SendingDocumentstoBusinessProcessesforProcessing.
59
60
Pre-processing Actions
Afterselectingtheprocessingrule,TradingNetworkshasthelistofpreprocessingactions specifiedintheTNdocumenttypeandthelistofpreprocessingactionsspecifiedinthe selectedprocessingrule. Note: Thepreprocessingactionsintheprocessingrulescanoverridethepreprocessing actionsspecifiedintheaTNdocumenttype. Eachpreprocessingactionintheprocessingrule,canindicateoneofthefollowing: UsethesettingintheTNdocumenttype PerformthepreprocessingactionregardlessofthesettingintheTNdocumenttype NotperformtheactionregardlessofthesettingintheTNdocumenttype Thefollowinglistthepreprocessingactions.TradingNetworksperformsthepre processingactionsintheorderspecified. Verify Digital Signature.ForthispreprocessingactionTradingNetworksverifiesthe digitalsignatureoftheinbounddocument.Thispreprocessingactionverifies: Thedigitalsignaturetoassurethatthesignedbodyoftheinbounddocumenthas arrivedunchanged. Thesenderiswhoitclaimstobebymatchingthecertificatefromthedigital signaturetothecertificatethatTradingNetworkshasonfileforthepartner. Validate Structure.ForthispreprocessingactionTradingNetworksvalidatesthe structureofthedocumentagainstanISschema.TradingNetworksassuresthatthe documentmatchesthestructureidentifiedbytheISschema(usingthe pub.schema:validatebuiltinservice). Check for Duplicate Document.Forthispreprocessingaction,TradingNetworks determineswhetherthereisaduplicateofthedocument;thatis,ifithasalready receivedthedocument.YoucanhaveTradingNetworksdeterminewhetherthe
61
documenthasaduplicateusingabuiltinduplicationcheckthatTradingNetworks providesorusingacustomduplicatecheckservicethatyoucreate. Built-in services.TradingNetworkschecksthedocumentbeingprocessedagainst documentsithasinitsdatabase.ThebuiltinduplicationchecksthatTrading Networksprovidesare: Document ID only.TradingNetworksassuresthatitdoesnotalreadyhavea documentwithsamedocumentIDinitsdatabase. Document ID and sender.TradingNetworksassuresthatitdoesnotalready haveadocumentwithsamedocumentIDandsenderinitsdatabase. Document ID, sender and receiver.TradingNetworksassuresthatitdoesnot alreadyhaveadocumentwiththesamedocumentID,sender,andreceiverin itsdatabase. Document ID, sender and document type.TradingNetworksassuresthatitdoes notalreadyhaveadocumentwiththesamedocumentID,sender,andTN documenttypeinitsdatabase. Custom services.Ifyouwanttouseanothermethodtodeterminewhethera documentisaduplicate,youcancreateanduseaduplicationcheckservice. TradingNetworkssavestheresultsoftheduplicationchecktothepipeline.Asa result,thisinformationisavailableforuseintheprocessingactionsthatyoudefinein theprocessingrule.Additionally,TradingNetworksusestheresultsofthe duplicationcheckintheSave Document to Databasepreprocessingaction. Save Document to Database.ForthispreprocessingactionTradingNetworkssavesa copyofthedocumentcontent,attributes,and/oractivityloginformationtothe database.YoucaninstructTradingNetworkstousetheresultsoftheduplication checkforthispreprocessingaction;thatis,youcaninstructTradingNetworkstoonly saveinformationtoitsdatabaseiftheinbounddocumentisnotaduplicate. Certaindeliveryoptionsrequiresavingthedocumentcontenttothedatabase,for example,ifyouwanttodeliveradocumentviaaqueue.Ifyoudonotselecttosave thedocumentcontentandTradingNetworksistouseadeliveryoptionthatrequires documentcontenttobesaved,TradingNetworkswillautomaticallysavethe document. RegardlessofwhetherTradingNetworkscanperformaspecifiedpreprocessingactionor iferrorsresultfromapreprocessingaction,TradingNetworkscontinuesperformingthe restofthepreprocessingactions.Italsoperformstheprocessingactionsthataredefined intheprocessingrule.IfTradingNetworksisunabletoperformapreprocessingactionor errorsresult,TradingNetworksrecordstheinformationtoitsactivitylog.
62
For more information about: HowtodefinehowtodefinepreprocessingactionsinTNdocumenttypes,see Chapter14,DefiningandManagingTNXMLDocumentTypesandChapter15, DefiningandManagingTNFlatFileDocumentTypesinthewebMethodsTrading NetworksAdministratorsGuide. Howtodefinepreprocessingactionsinprocessingrules,seeChapter16,Defining andManagingProcessingRulesinthewebMethodsTradingNetworks AdministratorsGuide.
63
Deliver Document by
ThefollowingillustratestheinformationthatTradingNetworksplacesinthepipeline whenadocumentisrecognized.
Information in the Pipeline During Processing
Variable bizdoc
sender
64
Variable receiver
ToseetheactualstructureofeachoftheseISdocumenttypes,usethewebMethods DevelopertoviewtheISdocumenttypes.AlltheISdocumenttypesarelocatedinthe wm.tn.rec folderthatisintheWmTNpackageandeachisdescribedinthewebMethods TradingNetworksBuiltinServicesReference. Note: Thebizdocvariableisaninstanceofcom.wm.app.tn.doc.BizDocEnvelope.Thesenderand receivervariablesareinstancesofcom.wm.app.tn.profile.ProfileSummary. InadditiontotheinformationthatTradingNetworksnormallyplacesinthepipeline whenexecutingaprocessingrule,iftheprocessingrulespecifiestheExecute a service actionandalsoindicatesthatTradingNetworksistoinvoketheservicesynchronously, thepipelinewillcontainanyinformationplacedinitbytheserviceaswell.Thepipeline willalsocontaininformationfromagatewayservice,ifagatewayservicewasusedfora flatfile.
65
66
67
documentcontenttoharddiskdrivespace(referredtoastspace)andkeepareferenceto thelargedocumentcontentinmemoryratherthaninthedocumentcontentitself.
68
queriesinTNdocumenttypes.YouconfigurethenumberofbytesthatTrading Networksreads. Ensure IS clients do not use the $xmldata variable to send large XML documents to Trading Networks.Formoreinformationaboutclients,seeClientsthatTradingPartnersUse toSendDocumentsonpage 42. Code services to recognize when a document is large and take the appropriate actions based on whether the document content is in memory or written to hard disk drive space.Thisaffects: ServicesyoucreatetobeinvokedbytheExecute a Serviceprocessingaction. Immediatedeliveryservicesyouregistertoaddadditionimmediatedelivery methods.Formoreinformation,seeAddingYourOwnImmediateDelivery Methodsonpage 76. Scheduleddeliveryservicesthatyouregistertousewithscheduleddelivery queues.Formoreinformation,seeScheduledDeliveryServicesonpage 80. For more information about: HowtodefineTNXMLdocumenttypes,seeChapter14,DefiningandManaging TNXMLDocumentTypesinthewebMethodsTradingNetworksAdministrators Guide. HowtocreateservicestobeinvokedbytheExecute a Serviceprocessingaction,see Chapter16,DefiningandManagingProcessingRulesinthewebMethodsTrading NetworksAdministratorsGuide. Howtocreatedeliveryservices,seeChapter18,CreatingDeliveryServicesinthe webMethodsTradingNetworksAdministratorsGuide. AreasofTradingNetworksthatbehavedifferentlywhenyouareworkingwith largedocuments,seeAppendixF,LargeDocumentHandlinginthewebMethods TradingNetworksAdministratorsGuide.
69
70
Overview of Delivering Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 How Trading Networks Determines Delivery Method Information . . . . . . . . . . . . . . . . . . . . . . . . 73 Immediate Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Scheduled Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Queuing Documents for Polling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
71
72
4
http://TN01:5555/invoke/wm.tn/receive
3
Processing Rule Deliver Document By:
Primary HTTP
Trading Networks
73
Step
1
Description TradingNetworksreceivesadocumentandextractstheReceiverIDattribute fromthedocument.Intheaboveillustration,thevalueoftheReceiverID attributeis123456789andisfoundwithinthe<DUNS>tag. TradingNetworksmatchesthevalueoftheReceiverIDattributetotheexternal IDinformationstoredforpartnersinthepartnerprofiles.Theprofilethat containsthematchingexternalIDinformationistheprofileforthereceiving partner.Inthisillustration,thematchingprofileisforapartnerthathasthe DUNSnumber123456789. TradingNetworkslooksupthedeliverymethodspecifiedontheDeliver Document Byactionoftheprocessingruleinthereceivingpartnersprofileto obtaindeliveryinformationthatisspecifictothatpartner. Inthisillustration,thePrimary HTTPinformationdefinedinthematching partnerprofileindicatesthatTradingNetworksistodeliverthedocumentto thehostname TN01atport5555specifyingthelocation/invoke/wm.tn/receive.
74
Immediate Delivery
Foranimmediatedelivery,TradingNetworksattemptstoimmediatelydelivera documentdirectlytothereceivingpartner.
Delivering Documents with an Immediate Delivery Method
Primary HTTP
75
76
DeliverytasksremainintheTradingNetworkssystemuntilyoudeletethemoruntilthe documentwithwhichthedeliverytaskisassociatedisarchivedordeleted.Youcanview informationaboutdeliverytasksin: MywebMethodsontheMonitoring>Integration>B2B>Taskspage TradingNetworksConsoleontheTasksscreen For more information abouthowtoviewandrestarttasks,seeChapter4,ManagingTasks fromMywebMethodsandChapter9,ManagingDeliveryTasksfromtheConsolein thewebMethodsTradingNetworksUsersGuide.
Scheduled Delivery
Scheduleddeliveryisawaytobatchmultipledocumentsthatareactedon(delivered)at scheduledtimes.WhentheDeliver Document Byprocessingactionindicatesascheduled deliverymethod,TradingNetworkscreatesadeliverytaskforthedocumentandplacesthe deliverytaskinthequeueidentifiedwiththeDeliver Document Byprocessingaction.The queueisassociatedwithascheduleandascheduleddeliveryservice.Atthetimesthe scheduleindicates,TradingNetworksinvokesthescheduleddeliveryservicetoactonthe documentsinthequeuetodeliverthem. Usescheduleddeliverywhenitismoreefficienttodeliverabatchofdocumentsatatime ratherthandeliverthemimmediatelyastheyarrive.Forexample,ifyouwanttodeliver documentsviaFTP,youmightwanttousescheduleddelivery,soyouonlyopena connectiononetime,deliverallthedocumentsinthequeue,thenclosetheconnection, ratherthandeliveringthedocumentswithanimmediatedeliverymethodthatrequires theconnectiontobeopenedandclosedforeachdocumentbeingdelivered. Thefollowingdiagramillustratesscheduleddelivery.Seethetablebelowthediagramfor additionalinformation.
77
1
processing rules
bizdoc
2
delivery task
Create a delivery task for the document. (The document is contained in the bizdoc.).
scheduled delivery queue delivery task delivery task delivery task Scheduled delivery service retrieves the document content from the delivery task and delivers it to the receiving partner
Trading Networks
Step
1
Description TradingNetworksreceivesadocument,andtheprocessingruleforthe documentincludestheDeliver Document Byprocessingactionandindicates scheduleddelivery. TradingNetworksestablishesadeliverytaskforthedocument.Thedelivery taskincludestheBizDocEnvelope,whichincludesthecontentofthedocument. TradingNetworksplacesthedeliverytaskinthescheduleddeliveryqueuethat isidentifiedwiththeDeliver Document Byprocessingaction. Whenthescheduleassociatedwiththescheduleddeliveryqueueindicates, TradingNetworksinvokesthescheduleddeliveryservicethatisassociated withthescheduleddeliveryqueue.Thescheduleddeliveryserviceactsoneach deliverytaskinthequeue. Thescheduleddeliveryserviceattemptstodeliverthedocumenttothe receivingpartnerandindicateswhetherthedeliverywassuccessfulornot.The statusofthedeliverytaskisupdatedaccordingly.Formoreinformation,see ReliableDeliveryandScheduledDeliveryonpage 81.
78
79
80
81
Trading Networks
Receiving partner
The receiving partner repeats Steps 2-3 for each document in the list.
82
83
84
Overview of Sending Documents to Business Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 How You Define the Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86 Conversation IDs for Trading Networks Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 How Documents Are Passed to a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
85
86
document,itdetermineswhetherithasarunningbusinessprocessthatusesthe conversationID.Ifitdoes,theProcessEnginepassesthedocumenttotherunning businessprocesstorejointherunningbusinessprocess.Ifthereisnorunningbusiness processesthatusesthatconversationID,theProcessEnginesearchesforaprocessmodel thathasthefirststepthatwaitsforthedocument,andiffound,startsanewinstanceof theprocessmodel. AstheProcessEnginemanagestheexecutionofabusinessprocess,itlogsitsprogress andstatustotheProcessAuditLogdatabase.Youcanviewtheprogressandstatusfrom MywebMethodsusingwebMethodsMonitor. For more information about: Howtocreateprocessmodels,seethewebMethodsDesigneronlinehelp. Howtomonitorrunningbusinessprocesses,seethewebMethodsMonitorUsers Guide.
87
2
TN document type bizdoc
3
Select the Processing Rule to Use
4
Perform Pre-processing Actions - Verify - Validate - Check for duplicate - Save
5
Perform Processing Actions - Execute a service - Send an alert e-mail - Change the user status - Deliver the document - Respond with a message
processing rules
Process Engine
bizdoc
88
Step
1
Description WhenTradingNetworksreceivesadocumentanddeterminestheTN documenttypetouseforthedocument.TheTNdocumenttypeshouldinstruct TradingNetworkstoextracttheConversationIDsystemattribute. TradingNetworkscreatestheBizDocEnvelopeforthedocument.The BizDocEnvelopecontainstheoriginaldocument,theextractedattributevalues, andadditionalinformationthatTradingNetworksrequiresforroutingand processingthedocument. Note: YoucandefineaTNdocumenttypetoindicatethatyouwanttodisable processingrulerouting.IftheTNdocumenttypethatmatchedtheincoming documentindicatesthatprocessingruleroutingisdisabled,TradingNetworks performsthepreprocessingactionsdefinedbytheTNdocumenttype.After that,TradingNetworksdoesnotperformaprocessingrulelookup,nordoesit performanyprocessingruleactions.BecausetheConversationIDwas extracted,TradingNetworksimmediatelypassesthedocumenttotheProcess Engine,whichisdescribedinstep 6 .
TradingNetworksperformsprocessingruleselection.Inthisstep,Trading Networksusestheprocessingrulecriteriatolocatetheprocessingruletouse fortheinbounddocument.Formoreinformation,seeProcessingRule Selectiononpage 60. TradingNetworksperformspreprocessingactionsthatyoudefineineitherthe TNdocumenttypeortheprocessingrule.Formoreinformation,seePre processingActionsonpage 61. IfTradingNetworksistosendadocumenttotheProcessEngine,italways savestheattributesandactivityloginformationtoitsdatabase.
5 6
TradingNetworksperformstheactionsyouspecifyintheprocessingrule,if any.Formoreinformation,seeProcessingRuleActionsonpage 63. BecausetheConversationIDsystemattributecontainsavalue,Trading NetworkspassesthedocumenttotheProcessEngine.TheProcessEngine either: Starts a new business process basedonaprocessmodelthatyouhave designediftheConversationIDdoesnotmatchthatofanyrunning businessprocess. or Rejoins a running business processifitdeterminesthattheConversationID matchesthatofacurrentlyrunningbusinessprocess.
89
90
Run-time Information that You Can Track . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92 Viewing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93 Viewing Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94 Viewing the Activity Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Viewing the Server Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Using Trading Networks Web Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
91
To view: Informationaboutthedocumentsthat TradingNetworkshassavedtoitsdatabase: Attributesthathavebeenextractedfrom documents Contentofdocumentsthathavepassed throughyoursystem StatusofdocumentsthatTrading Networksisintheprocessofdelivering Inadditiontoviewingthisinformation, TradingNetworksalsoprovidesfeaturesyou canusetoresubmitandreprocess documents. Formoreinformation,seeViewing Documentsonpage 93.
Task
Theprogressandstatusofeachdeliverytask andserviceexecutiontask.Inadditionto viewingthisinformation,TradingNetworks alsoprovidesfeaturesyoucanusestop, restart,anddeletetasks.Formore information,seeViewingTasksonpage 94. Auditinformationoftheactivitythathas occurredinyourTradingNetworkssystem. Formoreinformation,seeViewingthe ActivityLogonpage 96.
Activity Log
Ifyouplantousethesamequerymultipletimes,youcansavethequerysettings.When youwanttousethesamequeryagain,yousimplyselectthatsavedquery.
92
Note: MywebMethodsandTradingNetworksdonotsharequeries.Queriesyousavein oneoftheuserinterfacescannotbeusedintheotheruserinterface. For more information about: HowtosavesearchesinMywebMethods,seetheGettingStartedwithMy webMethods. HowtoperformqueriesinTradingNetworksConsole,seeChapter12,Queriesin TradingNetworksConsoleinthewebMethodsTradingNetworksUsersGuide.
Viewing Documents
YoucanviewinformationaboutthedocumentsthatTradingNetworkshassavedtoits database.Youcan: Manageandtrackdocumentsthathaveflowedthroughyourtradingnetwork: Viewdocumentattributesanddocumentcontent. Viewrelateddocuments,whichareotherdocumentsthataresomehowrelatedtoa document.TradingNetworksautomaticallyrelatesdocumentsthatarepartofa businessprocess(orconversation).Formoreinformationaboutprocesses,see Chapter 7,SendingDocumentstoBusinessProcessesforProcessing. Additionallyyoucanexplicitlyrelatedocumentstooneanotherusingthe wm.tn.doc:relateDocumentsbuiltinservice. Manageandtrackthedeliveryofdocuments: Viewtheprocessingstatusofdocumentstodeterminewhethertheyhavebeen delivered,arestillintheprocessofbeingdelivered,orifthedeliveryfailed. Viewpollabledocumentsthatarequeuedforatradingpartner. Viewdocumentsthatarescheduledfordelivery. Addorupdatecommentsthatareassociatedwithadocument.Thisfeatureisonly availableviaMywebMethods. Viewtasks(deliverytasksandserviceexecutiontasks)thatareassociatedwiththe document. ViewactivitylogentriesthatareassociatedwiththeprocessingthatTrading Networkshasperformedagainstadocument.
93
Viewing Tasks
Youcanviewinformationspecificallyabouttasks.Additionally,whileviewing documents,youcanviewtasksthatareassociatedwithaspecificdocument. Note: IfyouareusinganOEMversionoftheproduct,theTasksscreenisnotavailable throughtheTradingNetworksConsole.Toviewtasks,useMywebMethods.
94
TradingNetworksusestwotypesoftasks:deliverytasksandserviceexecutiontasks. Delivery tasks.TradingNetworkscreatesdeliverytaskstokeeptrackofitsattemptsto deliverdocumentswhenitisusingreliabledelivery.Formoreinformationabout deliverytasksandreliabledelivery,seeReliableDeliverywithImmediateDelivery onpage 76andReliableDeliveryandScheduledDeliveryonpage 81. Service execution tasks.TradingNetworkscreatesaserviceexecutiontaskwhenyou usethe Execute a Serviceprocessingactionandselectservice execution tasktoindicate howTradingNetworksistoexecutetheservice.Formoreinformation,seeExecutea ServiceProcessingActiononpage 65. Youcanviewdetailsforatask,whichincludesthenumberoftimesthatTradingNetworks hasattemptedtoretrythetask;thatis,foradeliverytaskthenumberoftimesTrading Networkshasattemptedtoretrydeliveringadocumentandforaserviceexecutiontask thenumberoftimesTradingNetworkshasattemptedtoretrytheservice. For more information abouthowtosearchforandviewtaskinformation,seeChapter4, ManagingTasksfromMywebMethodsandChapter9,ManagingDeliveryTasks fromtheConsoleandChapter10,ManagingServiceExecutionTasksfromthe ConsoleinthewebMethodsTradingNetworksUsersGuide.
95
Deleting a task.Youcanmanuallydeletetaskswhenyounolongerneedtheminthe system. Note: TradingNetworksautomaticallydeletestaskswhenthedocumentwithwhich thetaskisassociatedisarchivedordeleted. For more information abouthowtostop,restart,anddeletetasks,seeChapter4, ManagingTasksfromMywebMethods;Chapter9,ManagingDeliveryTasksfrom theConsole;andChapter10,ManagingServiceExecutionTasksfromtheConsolein thewebMethodsTradingNetworksUsersGuide.
96
97
98
Overview of the Analysis of Trading Networks Transaction Data . . . . . . . . . . . . . . . . . . . . . . . 100 Architecture and components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100 Design Time Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102 Monitoring Trading Networks Transaction Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
99
100
Broker
Document
Optimizes database
My webMethods Server
Trading Networks:Extractsthedocumentattributesfromeverydocumentitreceives. Theseextracteddocumentattributesincludetheonesrequiredformonitoringandfor furtherprocessing.Afterthedocumentprocessing,TradingNetworkssendsthe monitorableattributevaluesaseventstoOptimizeforB2Bforanalysis.Aneventisthe datathatTradingNetworkssendstoOptimizeformonitoring. Broker:ActsasanintermediarywhilepassingthedatafromTradingNetworksto Optimize.BrokerusesaJMS(JavaMessagingService)Queuetopassthedatato Optimize. Optimize:TradingNetworksusesOptimizeforitsmonitoringcapabilitiesandtodefine andmanagetheKPIsrequiredforanalysisandmonitoring.OptimizeforB2B subscribestotheeventsfromBrokerandanalyzesthemusingoneofitsAnalytic Engines.ThisanalyzeddataissavedtoOptimizeforB2Bsdatabase. My webMethods Server:IstheruntimecontainerforfunctionsthatwebMethods componentsmakeavailable.TradingNetworksadministratorsuseMywebMethods toconfigureTradingNetworkstoenableBAM.MywebMethodsalsopresentsthe analyzeddataasgraphs,reports,andsoonbyretrievingitfromOptimizeforB2Bs database. For more information about: webMethodsBroker,seethewebMethodsBrokerAdministratorsGuide. webMethodsOptimizeforB2B,seethewebMethodsOptimizeforProcess AdministratorsGuideandthewebMethodsOptimizeforProcessUsersGuide. MywebMethodsServer,seetheGettingStartedwithMywebMethods.
101
4 5
102
thenchecksifthatTNdocumenttypeandTradingNetworksitselfareenabledfor BAM.Ifyes,TradingNetworkscollectsalltheattributevaluesformonitoringand storesinahashmapwithintheBizDocEnvelopeuntilthedocumentprocessingis complete. Afterthedocumentprocessingiscomplete,TradingNetworksonceagain synchronizestheactualattributevaluestotheonesexistinginthehashmap.Thisis necessarybecausetheattributevaluesstoredintheBizDocEnvelopemightget updatedeitherduringanyoftheserviceexecutiontasks(bothSynchronous/ Asynchronous)orduetoanyotherservicesinTradingNetworks. TradingNetworksthenmapstheattributestotheeventmapsasconfiguredduring thedesigntime,andcreatesevents. FormoreinformationabouttheBizDocEnvelopeandthedocumentprocessingin TradingNetworks,seeProcessingofDocumentsinTradingNetworkson page 53. 2 TheeventsarethenpassedtowebMethodsBroker.AJavaMessagingSystem(JMS) providedbyBrokercollectsalltheseeventsusingaDCA. Ifanerroroccurswhilepassingtheevents,anexceptionisthrown.Thisexceptionwill beloggedasawarningintheActivityLogassociatedwiththatdocument. Note: WhenTradingNetworkspassestheeventtoBrokerduringthedocument processingdependsontheprocessingruleactionsdefinedfortheTNdocumenttype. FormoreinformationaboutwhenTradingNetworkspassestheeventstoBroker,see StagesatWhichtheEventsarePassedtotheBrokeronpage 103. 3 webMethodsOptimizeforB2BsubscribestotheeventsfromtheBrokersJMSqueue andfeedsthemtoitsAnalyticEngine.TheAnalyticEngineanalyzestheseeventsand savesthedatatoOptimizeforB2Bsdatabase. Duringmonitoring,MywebMethodsServerretrievestherequireddatafrom OptimizeforB2Bsdatabaseatruntimeandallowstheusertoviewthedataina presentableformatsuchasgraphs,reports,andsoon. Note: YoucanalsouseInformaticasDashboardtoanalyze,monitorandviewthedata. ThisispossiblebecausetheschemadefinedforanalysisiscommonforbothMy webMethodsServerandDashboard.
103
passedtoBroker.Toavoidthis,basedonthedeliverymethodyouchooseforaTN documenttype,theeventsarepassedtotheBrokerasfollows: Ifyouchoosetoturnofftheroutingforthedocument,theeventispassed immediatelyafterthedocumentprocesscompletion. IfyouusetheExecute a Serviceprocessingaction,whentheeventispassedisbasedon howtheserviceisinvoked: Synchronous:Theeventispassedonlyaftertheexecutionoftheserviceis completeandtheprocessingofthedocumentissuccessful. Asynchronous or Reliable Execution:Theeventispassedaftertheexecutionofthe serviceiscompleteirrespectiveofthedocumentprocessingstatus. IfyouusetheDeliver Document Byprocessingaction,theeventispassedonlywhenthe documentprocessingstatusiscomplete. Note: WhenaTNdocumenttypehasbothExecute a ServiceandDeliver Document Bytasks associatedwithit,thenwhileconfiguringtheTNdocumenttypeformonitoringyoumust selecteitherofthetasksintheSend BAM Event Afteroption.Dependingonthis,Trading NetworkspassestheeventstotheBrokerafterthechosentaskiscompleteandthus avoidsduplicateeventsbeingpassed.FormoreinformationaboutconfiguringtheTN documenttypeformonitoring,seetheChapter5,SettingUpAnalysisofTrading NetworksTransactionDatainthewebMethodsTradingNetworksAdministratorsGuide.
104
activity log AlogthatTradingNetworksmaintainstorecordtheactivitythatoccurswithinthe TradingNetworkssystem.TradingNetworksrecordsentries,forexample,whenyou managetradingpartnerinformation,whenitprocessesdocuments,andwhenyouperform administrativetasks. activity class AclassificationthatidentifiestheTradingNetworksfunctionassociatedwithanentryin theactivitylog.Forexample,TradingNetworkssetstheactivityclasstoRecognitionwhen addingentriesrelatedtousingtheTNdocumenttypestorecognizeadocument. ambiguous document AdocumentthatmatchesmultipleTNdocumenttypes.(Comparewithunknowndocument.) attribute Seedocumentattribute. BAM (Business Activity Monitoring) Allowsyoutoanalyzerealtimeinformationabouttheperformanceofyourbusiness, includingthevolumeofbusinessactivityanditsresponsiveness,seriouserrorsthatmight haveoccurred,andotherKPIs.Usingthisactionabledata,youcaneliminateproblems andtakeadvantageofbusinessopportunities. bizdoc ThenameofthevariableinthepipelinethatcontainstheBizDocEnvelope. BizDocEnvelope ABizDocEnveloperepresentsaroutableTradingNetworkstransaction.Itcontainsthe contentofadocumentthatTradingNetworksisprocessingandincludesadditional informationthatTradingNetworksrequiresforroutingandprocessingthedocument.Itis inthepipelineinthebizdocvariableandconformstotheISdocumenttype wm.tn.rec:BizDocEnvelope. Broker SeewebMethodsBroker. business process Amultistepinteractionamongparticipatingsystems,people,andtradingpartners.A businessprocesscanbefullyautomated(involveonlyinteractionamongcomputer systems)orincludevaryingdegreesofhumaninteraction(forexample,reviewand approvalsteps).Itcanbebrieforlongrunning.Somebusinessprocessestranspireover daysorweeks.(Comparewithconversation.) conversation Aspecificcaseofabusinessprocessthatinvolvesaseriesofrelateddocumentsbeing exchangedbytwoormoretradingpartners.Alldocumentsfromaspecifictradingpartner
105
containthesameConversationID.Youmodelaconversationbycreatingaprocessmodel usingwebMethodsDesigner. Conversation ID Asystemattributethatidentifiesavaluewithinadocumentthatiscommontoalldocuments thatarepartofthesamebusinessprocess.(Aorsameconversationofdocuments.) custom attribute Adocumentattributethatyoudefinetoidentifyinformationwithinadocumentthatisof interesttoyou.(Contrastwithsystemattribute.) deliver SendinganoutbounddocumentfromTradingNetworkstothetradingpartnerthatisthe receiverofthedocument. delivery method Amethodfordeliveringadocumenttoatradingpartner,e.g.,HTTP,HTTPS,FTP,FTPS, email(SMTP).TradingNetworkssupports,immediatedeliverymethods,scheduleddelivery methods,andqueueforpolling. delivery task AtaskthatTradingNetworksestablishestokeeptrackoftheattemptstoredelivera documentwhenitisusingreliabledelivery. dimension Whiledefininganeventmap,youdefineadocumentattributeasadimensionthathasa valuethatisnotmeasurable,forexample,region,department,andsoon.Youuse dimensionstoanalyzeafact. document Abusinessdocument(e.g.,purchaseorder,acknowledgement,confirmation)sentto TradingNetworks.Thedocumentcanbeinanyformat(XML,EDI,etc.)TradingNetworks providesoutoftheboxsupportforXMLandflatfiledocuments.ThewebMethodsEDI ModuleisnecessaryforEDIdocuments. document attribute ATradingNetworksobjectthatdefinesapieceofinformationwithinadocumentthatisof interest.Forexample,documentattributesinapurchaseordermightbethepurchaseorder number,theaccountnumberofthepurchaseorderandthetotalpurchaseamount. Documentattributescanbeeitherasystemattributes(thosethatareprovidedwithTrading Networks)orcustomattributes(thosethatyoudefineforyourenterprise). document gateway service Aservicethatyoucreateandthatistheentrypointforprocessingaflatfile.Theserviceyou createplacesinformationinthepipelineforTradingNetworkstousetodeterminetheTN flatfiledocumenttypetouseforaflatfile.Theservicecanalsoplacedocumentattributes alongwiththeirvaluesinthepipeline.Afterthedocumentgatewayserviceexecutes,itpasses controltoTradingNetworks.
106
Document ID Asystemattributeforanidentifierinadocumentthatistypicallyauniquevaluethat distinguishesadocumentfromotherversionsofthesamedocument. document type SeeTNdocumenttypeorISdocumenttype. document validation Theprocessofverifyingthestructureandcontentofanindividualdocumentbyvalidating itagainstaschema. Enterprise partner Thepartnerthathoststhetradingnetwork.OnyourTradingNetworkssystem,thiswould typicallybeyourcorporation.(Alsoknownasthehub,localpartner,orsponsor.)(Contrast withspoke.) event ThedatathattradingnetworkpassestotheBrokeratruntime,afterthedocument processingiscomplete.Itcontainsthedocumentattributesvaluesformonitoring,theevent mapandthetimestampdataofthedocument. event map Theknowledgeofwhateachdocumentattributeinaneventmeans.Aneventmap associatesbusinessdata,suchasdimensions,withaparticulartransaction. extended fields Fieldswithinaprofilethatyoudefineforyourenterprise.Createextendedfieldstomaintain informationabouttradingpartnersthatisnotcoveredbythestandardfields. external ID type Atypeofidentifierinadocumentusedtoidentifythesenderorreceiverofthedocument. Forexample,thesendermightberepresentedbytheDUNSnumberforthesenders corporation. external ID ThevalueoftheexternalIDtypewithinadocument.Forexample,iftheexternalIDtypeisa DUNSnumber,theexternalIDistheactualvalueoftheDUNSnumber. fact Ameasurableattributevaluethatyoucanusetoanalyzethetradingnetworktransactions1 data,forexample,quantity,cost,andsoon. flat file Anyfileordocumentthathasaformatthatisnondescribing,thatis,adocumentthatdoes notcontainmetadata.Aflatfiledocumentpresentshierarchicaldatainarecordbased storageformat,whichunlikeXML,doesnotembedstructuralinformationwithinthe data. flat file dictionary Acollectionofrecorddefinitions,fielddefinitions,andcompositedefinitionsthatcanbe usedinmultipleflatfileschemas.
107
flat file schema Ablueprintthatcontainstheconstraintstowhichaflatfiledocumentshouldconformto beconsideredvalid. gateway service Seedocumentgatewayservice. Group ID Asystemattributeforanidentifierinadocumentthatiscommontoalldocumentsinagroup ofdocuments. hub Thepartnerthathoststhetradingnetwork.(AlsoknownastheEnterprisepartner,local partnerorsponsor.)(Contrastwithspoke.) IData object Thecollectionofname/valuepairsonwhichaserviceoperates.AnIDataobjectcancontain anynumberofelementsofanyvalidJavaobjects,includingadditionalIDataobjects.(Also calledanISdocument.) identifying query AnXQLquerythatisspecifiedinaTNXMLdocumenttypeandthatTradingNetworks usestomatchaninboundXMLdocumenttoaTNXMLdocumenttype.TradingNetworks performstheidentifyingquerytoensurethenodethattheXQLqueryrepresentsisinan XMLdocument.Ifthenodeispresentandallotheridentifyinginformationmatchesthe inboundXMLdocument,TradingNetworksdeterminesthattheinboundXMLdocument matchestheTNXMLdocumenttypethatcontainstheidentifyingquery.Alternatively,ifthe nodeisnotpresent,TradingNetworksdeterminesthattheinboundXMLdocumentdoes notmatchtheTNXMLdocumenttype. immediate delivery method AdeliverymethodwhereTradingNetworksattemptstoimmediatelydeliveradocument directlytothereceivingpartner.TradingNetworksprovidesmanybuiltindelivery methods,suchas,PrimaryHTTP,SecondaryHTTP,PrimaryEmail,etc. IS document type AnelementintheIntegrationServersnamespacethatcontainsasetoffieldsusedto definethestructureandtypeofdatainanISdocument(IDataobject). IS schema TheblueprintormodeldocumentthatyouvalidateanXMLdocumentagainst.The schemadefineswhatcanandcannotbecontainedintheXMLdocumentsitisvalidated against. Java Messaging System (JMS) AmessagingsystemthatactsasmediumtopassalltheeventsstoredinBrokerbythe tradingnetworktoOptimize. local partner Thepartnerthathoststhetradingnetwork.(Alsoknownasthe Enterprisepartner,hubor sponsor.)(Contrastwithspoke.)
108
KPI Keyperformanceindicator.Ameasurementofabusinessactivitythatisimportanttothe successofanorganization.KPIsmonitormetricsquantitativebusinessandsystemdata suchasrevenue,volumeoforders,queuelength,andcycletime.KPIshelpanswer questionssuchasHowmanyordersover$10,000arestuckinthisprocess?AKPI definesawaytoaggregateeventdata. KPI Hierarchy Anorderedrankingofdimensions.Ahierarchyprovidesadditionalwaystoslicedatainto smallercomponents.Forexample,asaleshierarchymightconsistoftwodimensions: regionandsalesperson. My Enterprise partner Oldtermforthepartnerthathoststhetradingnetwork;nowknownasthe Enterprise partner.(SeeEnterprisepartner.) My webMethods Awebbased,administrationandmonitoringuserinterfaceformanagingyour webMethodscomponents.YoucanuseittomonitorTradingNetworkstransactions, serviceexecutiontasks,deliverytasks,andtheactivitylog.Additionally,youcanuse webMethodstomanageprofiles,profilegroups,andTradingNetworksqueues. My webMethods Server TheruntimecontainerforfunctionsthatwebMethodscomponentsmakeavailablevia MywebMethods.Forexample,TradingNetworksmakesthefunctionstomonitorand managetransactionsavailable. Optimize SeewebMethodsOptimizeforB2B. partner Seetradingpartner. pipeline Thegeneraltermusedtorefertothedatastructureinwhichinputandoutputvaluesare maintained.Thepipelinestartswiththeinputtoaserviceandcollectsinputsandoutputs fromsubsequentservices.Whenaserviceexecutes,ithasaccesstoalldatainthepipeline. private queue Ascheduleddeliveryqueuethatyoudefinetoschedulethedeliveryofdocumentsthatare aimedatonespecifictradingpartner.Youdefineaprivatequeueintheprofileofthepartner toreceivethedocuments.(Contrastwithpublicqueue.) process Seebusinessprocess. Process Engine AfacilityoftheIntegrationServerthatmanagestheexecutionofbusinessprocesses(or conversations).Youmodelabusinessprocess(orconversation)byusingwebMethods Designertocreateaprocessmodel.
109
process model Diagramsthatillustrateanddefinetheactionstoperformforabusinessprocessor conversation.YoucreateprocessmodelsusingwebMethodsDesigner. process run time OldtermfortheProcessEngine. processing rule ATradingNetworksobjectthatcontainsasetofactionsthatdeterminehowTrading Networksistoprocessaninbounddocumentandcriteriathatindicateswhentoselecta processingruleforanincomingdocument. profile ATradingNetworksobjectthatcontainsasummaryofinformationaboutacorporation thatispartofatradingnetwork.AprofilecontainsstandardfieldsthatTradingNetworks providesandextendedfieldsthataresitedefined. profile fields Fieldsinaprofile.Eachprofilefieldrepresentsinformationthatyoucollectandmaintainfor tradingpartnersinthetradingnetwork.Therearetwotypesofprofilefields:standardfields andextendedfields. public queue Ascheduleddeliveryqueuethatyoudefinetoschedulethedeliveryofdocumentsthatare aimedatmultipletradingpartners.(Contrastwithprivatequeue.) queue for polling AdeliverymethodwhereatradingpartnerscanobtaindocumentswithouthavingTrading Networksdeliverdocumentsdirectlytothetradingpartner,forexample,becauseoffirewall constraints.TradingNetworkssavesthedocumentstoitsdatabaseinaninternallydefined queue.Atalatertime,thereceivingpartnerpollsfordocuments,andTradingNetworks returnsallthedocumentsinthequeueforwhichthattradingpartneristhereceiver. ReceiverID Asystemattributethatidentifiesthetradingpartnerthatistoreceiveadocument.The ReceiverIDisanexternalID(i.e.,thevalueofanexternalIDtype). reliable delivery AfeatureofTradingNetworkswhereTradingNetworksattemptstoredeliveradocument toatradingpartneroneormoretimesifpreviousattemptstodeliverthedocumentfails.For animmediatedeliverymethod,TradingNetworksautomaticallyusesreliabledeliverywhen thepreprocessingactionSave Document to DatabaseindicatesthatTradingNetworksisto savethedocumentcontenttoitsdatabase.Forascheduleddeliverymethod,Trading Networksalwaysusesreliabledelivery. reliable execution AfeatureofTradingNetworkswhereTradingNetworksattemptstoreexecuteaservice ifpreviousattemptstoexecutetheservicefails.TradingNetworksusesreliableexecution whenyouselectservice execution taskasthemethodforhowTradingNetworksisto asynchronouslyexecuteaservicefortheExecute a Serviceprocessingaction.Seealso serviceexecutiontask.
110
scheduled delivery method AdeliverymethodwhereTradingNetworksbatchesmultipledocumentsinascheduled deliveryqueue.Thedocumentsinthequeueareactedonatscheduledtimestodeliverthem. scheduled delivery queue Agroupingofdocumentsthatareintendedforoneormoretradingpartners.Trading Networkssupportstwotypesofscheduleddeliveryqueues:publicqueueandprivatequeue. schema SeeflatfileschemaorISschema. SenderID Asystemattributethatidentifiesthetradingpartnerthatsentadocument.TheSenderIDisan externalID(i.e.,thevalueofanexternalIDtype). service execution task AtaskthatTradingNetworksestablishestokeeptrackoftheattemptstoreexecutea servicewhenusingreliableexecution.TradingNetworkscreatesaserviceexecutiontask whenyouselectservice execution taskasthemethodforhowTradingNetworksisto asynchronouslyexecuteaservicefortheExecute a Serviceprocessingaction. signature Asystemattributethatidentifiestheportionofadocumentthatcontainsthedigital signatureforthedocument. SignedBody Asystemattributethatidentifiestheportionofadocumentthatcontainsthedatathatwas digitallysignedtocreatethedigitalsignature. spoke Atradingpartnerthatisamemberofatradingnetwork,butisnotthehostofthenetwork. (Contrastwithhub.) standard fields Fieldswithinaprofilethatareprovidedoutofthebox.Thestandardfieldstypically incorporatemostoftheinformationthatsiteswanttocollectaboutatradingpartner.See alsoprofilefields. system attribute AdocumentattributethatisprovidedwithTradingNetworksoutofthebox. tasks Seedeliverytaskandserviceexecutiontask. TN document type ATradingNetworksobjectthatdefineshowTradingNetworksistorecognizeadocument andinitialactionstotakeonarecognizeddocument.TradingNetworksrecognizesthe documentbyusingidentificationinformationintheTNdocumenttype.Theactions specifiedinaTNdocumenttypeindicatethedocumentattributesthatTradingNetworksisto extractfromthedocument(includinginformationaboutXMLnamespacesthedocuments mightuse)andspecifyoptionsforpreprocessingthedocument(whichinclude
111
verification,validation,andwhethertosavethedocumentattributes,documentcontent, andlogentriesforthedocumenttothedatabase). TN flat file document type ATNdocumenttypethatTradingNetworksuseswhenrecognizingflatfiledocuments.To matchaflatfiletoaTNflatfiledocumenttype,TradingNetworksreliesoninformation providedbyadocumentgatewayservice. TN XML document type ATNdocumenttypethatTradingNetworksuseswhenrecognizingXMLdocuments. TPAs SeeTradingPartnerAgreement(TPA). trading network Asystemoforganizationsthatareconnectedtosharebusinessinformation.The organizationsinatradingnetworkarestrategicpartners,buyers,suppliers,and marketplaces.Theysharebusinessinformationbyexchangingdocuments,forexample, purchaseorders,orderstatuses,purchaseorderacknowledgements,invoices,aswellas domainspecificbusinessdocuments. Trading Partner Agreement (TPA) ATradingNetworksobjectthatyoucanusetotailorhowdocumentsareexchanged betweentwotradingpartners. trading partner Anorganizationinyourtradingnetwork,forexample,astrategicpartner,marketplaces, buyer,orsupplier.Eachtradingpartnerrequiresaprofile.Youcanexchangebusiness documentswiththetradingpartnersinyournetworktorelaymissioncriticalproduction information.(Alsoknownaspartners.) transactions1 ThedocumentsthathavepassedthroughTradingNetworks. transaction2 Whiledefininganeventmap,youdefineadocumentattributeasatransaction,ifitsvalue isneitherafactnoradimension.Youdonotusethisdataforanalysisbutjustasareference point.Forexample,orderID. unknown document AdocumentthatdoesnotmatchanyTNdocumenttype.(Comparewithambiguous document.) unknown partner Atradingpartner(senderorreceiver)ofadocumentisconsideredunknownifTrading Networksisunabletodeterminethesenderorreceiver;thatismatchthesenderor receivertoaprofileintheTradingNetworkssystem. User Status Asystemattributethatcontainsastatusthatausercanassociatewithadocument,e.g., NeedsApproval.
112
webMethods Broker TheprimarymessagebackboneproductinawebMethodsintegrationenvironment. webMethodsBrokerfacilitatesasynchronous,messagebasedcommunicationusingthe publishandsubscribemodel. Whenyouenablemonitoringontradingnetworkstransactiondata,Brokeractsasan intermediarywhilepassingeventsfromatradingnetworktoOptimize.ItusesaJava MessagingSystem(JMS)queuethatpublishestheeventstotheOptimize. webMethods Optimize for B2B WhenyouenableBAMonTradingNetworkstransactiondata,Optimizesubscribesthe eventsfromtheJavaMessagingSystem(JMS)queueoftheBroker,analyzesthembasedon thedefinedKPIs,andsavesthemtoitsdatabase.Atruntime,MywebMethodsServer retrievesthisdatatoviewormonitorthedatainagraphicaloratabularformat. Web Manager ATradingNetworksspecificuserinterfacethatyouuseviaaWebbrowser.Thisuse interfaceisdeprecated. XML EXtensibleMarkupLanguage,auniformmethodfordescribingandexchangingdatathat isflexible,extensible,andeasytoimplement.ItisasimplifieddialectoftheStandard GeneralizedMarkupLanguage(SGML). XQL XMLQueryLanguage.AlanguageusedtoretrieveinformationfromanXMLdocument.
113
114
Overview of Security Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Communicating Securely Using SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Protecting Access to User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116 Protecting Partner Profile Passwords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118 Protecting Access to Trading Networks Processing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119 Certificates for Verifying, Signing, Encrypting, and Decrypting Documents . . . . . . . . . . . . . . . 120
115
116
ofaroletowhichthatpermissionhasbeengranted.Therearetwoaspectstorolebased access: Datapermissions,whichidentifiesadatasetofprofiles,transactions,tasks,andactivity logentriesalongwiththeactionsarolecanperformagainstthatTradingNetworks dataset.Usingdatalevelsecurity,youcangrantrolesthefollowingpermissions: View/editprofilesettingsofexistingprofiles. Reprocesstransactions Resubmittransactions Edituserstatusattributefortransactions Editcommentfortransactions Viewcontentoftransactions Editcontentandresubmittransactions View,restart,stop,delete,orreassigntasks View/deleteactivitylogentries Generalfunctionalpermissions,whichgrantsarolethepermissiontoperformTrading NetworksactionsagainstotherTradingNetworksdata.Usinggeneralfunctional permissions,youcangrantrolesthefollowingpermissions: Managepublicqueues Manageprofilegroups Createnewprofiles Deleteexistingprofiles Manageextendedprofilefields AddexternalIDtypes ViewSQLassociatedwithaqueryperformedinMywebMethods ManageTradingNetworksBusinessActivityMonitoring(BAM)configuration Viewuserpreferences Edituserpreferences ViewTradingNetworksconfigurationproperties EditTradingNetworksconfigurationproperties Queryexpiringpartnercertificates
117
118
119
Description Whenapartnersendsadocumenttoyou,Trading Networkslooksatthesendersprofiletoseeifit containsthespecificpubliccertificatetouseto verifythedocument. Whenyousignadocumenttosendtoapartner, TradingNetworkslooksatyourprofiletoseeifit containsthespecificprivatekeytousetosignthe document. Whenyouencryptadocumenttosendtoapartner, TradingNetworkslooksatthereceiversprofileto seeifitcontainsthespecificpubliccertificatetouse toencryptthedocument. Whenapartnersendsanencrypteddocumentto you,TradingNetworkslooksatyourprofiletoseeif itcontainsthespecificprivatekeytousetodecrypt thedocument.
Sign
sendersprofile
Encrypt
receiversprofile
Decrypt
receiversprofile
Thefollowingtablesummarizesallscenariosofcertificateusage: Sender A A B B A A B Receiver B B A A B B A Operation Sign Verify Sign Verify Encrypt Decrypt Encrypt Profile used A A B B B B A
120
Sender B A B
Receiver A B A
Profile used A A B
121
122
Encrypt Certificates
IfyouareusinganotherwebMethodscomponentthatrequiresEncryptcertificates,savea partnersEncryptcertificateinthepartnersprofile.Youcanalsoaddyourown functionalitythattakesadvantageofthiscertificateinformation.Youcanobtainthe certificationinformationbyusingbuiltinservices. TradingNetworksdoesnotchecktoseeiftheCAthatsignedtheEncryptcertificateisin thelistoftrustedCAsthatthewebMethodsIntegrationServermaintains. Note: Ifyouincludetheprivatekeyinthiscertificateinformation,thiscertificate informationcanalsobeusedtodecryptdocumentsthatwereencryptedwiththepartners publickey.Youmighthavetheprivatekeyiftheprofiledescribesaninternalgroup,for exampleadepartmentwithinyourcorporation. How Trading Networks Encrypts Documents Whenyouencryptadocumenttosendtoapartner,TradingNetworkslooksatthe partnersprofiletoseeifitcontainsthespecificpubliccertificatetousetoencryptthe document.IfTradingNetworks: Findsasetofcertificatestouseforthatspecificreceiver,itusestheappropriate certificateinthatset
123
Doesnotfindasetofcertificatestouseforthatspecificreceiver,itusesthedefaultset ofcertificatesspecifiedinthepartnersprofile.
Decrypt Certificates
IfyouareusinganotherwebMethodscomponentthatrequiresDecryptcertificates,save yourDecryptcertificateintheownersprofile.BecauseyoucanstoreDecryptcertificates intheownersprofile,youcansetupalternateDecryptcertificatesfordifferentpartners. YoucanalsospecifyadefaultDecryptcertificatebyprovidingthecertificateinformation intheownersprofile.IfadefaultDecryptcertificateisdefined,thenTradingNetworks willusethisdefaultDecryptcertificatewhenapartnerspecificDecryptcertificateisnot available. TradingNetworksdoesnotchecktoseeiftheCAthatsignedtheDecryptcertificateisin thelistoftrustedCAsthatthewebMethodsIntegrationServermaintains. How Trading Networks Decrypts Documents Whenapartnersendsanencrypteddocumenttoyou,TradingNetworkslooksatyour profiletoseeifitcontainsthespecificprivatekeytousetodecryptthedocument.If TradingNetworks: Findsasetofcertificatestouseforthatspecificreceiver,itusestheappropriate privatekeyinthatset Doesnotfindasetofcertificatestouseforthatspecificreceiver,itusesthedefaultset ofprivatekeysdefinedintheDefaultprofileforpartners.
124