WmEDIsamples Service Documentation

Transcription

1 WmEDIsamples Service Documentation VERSION webmethods, Inc. South Tower 3877 Fairfax Ridge Road Fairfax, VA USA

2 webmethods Access, webmethods Administrator, webmethods Broker, webmethods Dashboard, webmethods Developer, webmethods Fabric, webmethods Glue, webmethods Installer, webmethods Integration Server, webmethods Mainframe, webmethods Manager, webmethods Modeler, webmethods Monitor, webmethods Optimize, webmethods Portal, webmethods Servicenet, webmethods Trading Networks, and webmethods Workflow are trademarks of webmethods, Inc. webmethods and the webmethods logo are registered trademarks of webmethods, Inc. Acrobat and Adobe are registered trademarks, and Reader is a trademark of Adobe Systems Incorporated. Amdocs is a registered trademark, and ClarifyCRM is a trademark of Amdocs. Ariba is a registered trademark of Ariba, Inc. BEA, BEA WebLogic Server, Jolt, and Tuxedo are registered trademarks, and BEA WebLogic Platform is a trademark of BEA Systems, Inc. Action Request System, BMC Software, PATROL, and Remedy are registered trademarks of BMC Software, Inc. BroadVision is a registered trademark of BroadVision, Inc. ChemeStandards and CIDX are trademarks of Chemical Industry Data Exchange. Unicenter is a registered trademark of Computer Associates International, Inc. PopChart is a registered trademark of CORDA Technologies, Inc. Kenan and Arbor are registered trademarks of CSG Systems, Inc. Data Connection and SNAP IX are registered trademarks of Data Connection Corporation. DataDirect, DataDirect Connect, and SequeLink are registered trademarks of DataDirect Technologies. D&B and D U N S are registered trademarks of Dun & Bradstreet Corporation. Entrust is a registered trademark of Entrust, Inc. papinet is a registered trademark of the European Union and the United States. Financial Information exchange, F.I.X, and F.I.X Protocol are trademarks of FIX Protocol Ltd. UCCnet and ebusinessready are registered trademarks, and 1SYNC and Transora are trademarks of GS1 US. Hewlett Packard, HP, HP UX, OpenView, PA RISC, and SNAplus2 are trademarks of Hewlett Packard Company. i2 is a registered trademark of i2 Technologies, Inc. AIX, AS/400, CICS, DB2, Domino, IBM, Informix, Infoprint, Lotus, Lotus Notes, MQSeries, OS/390, OS/400, RACF, RS/6000, SQL/400, S/390, System/390, VTAM, z/os, and WebSphere are registered trademarks; and Communications System for Windows NT, DB2 Universal Database, IMS, MVS, and SQL/DS are trademarks of IBM Corporation. InnoDB is a trademark of Innobase Oy. Itanium is a registered trademark of Intel Corporation. JBoss is a registered trademark, and JBoss Group is a trademark of Jboss, Inc. Linux is a registered trademark of Linus Torvalds. W3C is a registered trademark, and X Window System is a trademark of the Massachusetts Institute of Technology. MetaSolv is a registered trademark of Metasolv Software, Inc. ActiveX, Microsoft, Outlook, Visual Basic, Windows, and Windows NT are registered trademarks; and Windows Server is a trademark of Microsoft Corporation. Six Sigma is a registered trademark of Motorola, Inc. Firefox is a registered trademark, and Mozilla is a trademark of the Mozilla Foundation. MySQL is a registered trademark of MySQL AB. ncipher is a trademark of ncipher Corporation Ltd. Teradata is a registered trademark of NCR International, Inc. Netscape is a registered trademark of Netscape Communications Corporation. SUSE is a registered trademark of Novell, Inc. ServletExec is a registered trademark, and New Atlanta is a trademark of New Atlanta Communications, LLC. CORBA is a registered trademark of Object Management Group, Inc. JD Edwards, OneWorld, Oracle, PeopleSoft, Siebel, and Vantive are registered trademarks, and PeopleSoft Pure Internet Architecture and WorldSoftware are trademarks of Oracle Corporation. Infranet and Portal are trademarks of Portal Software, Inc. Red Hat is a registered trademark of Red Hat, Inc. PIP and RosettaNet are trademarks of RosettaNet, a non profit organization. SAP and R/3 are registered trademarks of SAP AG. SWIFT and SWIFTNet are registered trademarks of Society for Worldwide Interbank Financial Telecommunication SCRL. SPARC and SPARCStation are registered trademarks of SPARC International, Inc. SSA is a registered trademark, and Baan and SSA Global are trademarks of SSA Global Technologies, Inc. EJB, Enterprise JavaBeans, Java, JavaServer, JDBC, JSP, J2EE, Solaris, Sun, and Sun Microsystems are registered trademarks; and Java Naming and Directory Interface, SOAP with Attachments API for Java, JavaServer Pages, and SunSoft are trademarks of Sun Microsystems, Inc. Sybase is a registered trademark of Sybase, Inc. VERITAS is a registered trademark, and VERITAS Cluster Server is a trademark of Symantec Corporation. UNIX is a registered trademark of The Open Group. Unicode is a trademark of Unicode, Inc. VeriSign is a registered trademark of Verisign, Inc. All other marks are the property of their respective owners. Copyright by webmethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form. Document ID:

3 CHAPTER1 WmEDIsamples Service Documentation EDIFFSchema Tutorial.EDItoXML Tutorial.EDItoXML:segmentMapping Tutorial.FlatFile Tutorial.Records Tutorial.XMLtoEDI Tutorial.XMLtoEDI.segmentMapping Tutorial.properties Sample Flow Services Sample Business Process wm.ediint.sample Note: The WmEDIsamples package is located in the Knowledge Base Samples area on the Advantage Web site at The samples in this package have been certified, meaning that they have been tested by webmethods. WmEDIsamples Service Documentation 1

4 CHAPTER 1 WmEDIsamples Service Documentation EDIFFSchema The EDIFFSchema folder contains flat file schemas and dictionaries that other services in the WmEDIsamples package can use to validate EDI documents, as well as, some sample flat file schemas. EDIFFSchema.FlatFile:CSVSchema Sample flat file schema for a comma separated values (CSV) flat file. For more information about flat file schemas and dictionaries, see the Flat File Schema Developer s Guide. EDIFFSchema.FlatFile:Dictionary Sample flat file schema dictionary. For more information about flat file schemas and dictionaries, see the Flat File Schema Developer s Guide. EDIFFSchema.FlatFile:Example1 Sample flat file schema. For more information about flat file schemas and dictionaries, see the Flat File Schema Developer s Guide. EDIFFSchema.FlatFile:Example2 Sample flat file schema. For more information about flat file schemas and dictionaries, see the Flat File Schema Developer s Guide. EDIFFSchema.UNEDIFACT.V98A:Dictionary Sample flat file schema dictionary. For more information about flat file schemas and dictionaries, see the Flat File Schema Developer s Guide. EDIFFSchema.UNEDIFACT.V98A:TORDERS Flat file schema used to parse and validate a UN/EDIFACT 98A ORDERS document. 2 WmEDIsamples Service Documentation

5 EDIFFSchema.X12.V4010:Dictionary EDIFFSchema.X12.V4010:Dictionary Sample flat file schema dictionary. For more information about flat file schemas and dictionaries, see the Flat File Schema Developer s Guide. EDIFFSchema.X12.V4010:T810 Flat file schema is used to parse and validate an ANSI X12, version 4010, 810 document. EDIFFSchema.X12.V4010:T850 Flat file schema used to parse and validate an ANSI X12, version 4010, 850 document. EDIFFSchema.X12.V4010:T997 Flat file schema used to parse and validate an ANSI X12, version 4010, 997 document. WmEDIsamples Service Documentation 3

6 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.EDItoXML The services in this folder illustrate how to map an EDI document to an XML document. Tutorial.EDItoXML:EDItoXMLPOMap Illustrates how an to convert an EDI document into a different format (in this case, an XML PO). EDIValues Document The source EDI transaction set. POTarget mappingstatus Document The target XML document. String Status of the mapping result. This is the main ANSI X12 to XML target mapping service. This service uses the mapping services in the Tutorial.EDItoXML:segmentMapping folder described below. See Also Tutorial.Records:POTarget Tutorial.EDItoXML:dateParse Parses out the date from YYMMDD or YYYYMMDD to pipeline variables. date String Date input in format ʺYYMMDDʺ or ʺYYYYMMDDʺ. newyear newmonth newday newhour newminute newsecond String Four digit year. String Two digit month. String Two digit day. String Current time in hour. String Current time in minute. String Current time in second. 4 WmEDIsamples Service Documentation

7 Tutorial.EDItoXML:processEDI850_4010 Output variable status is not used. Tutorial.EDItoXML:processEDI850_4010 Illustrates how to convert an X document to an XML String. edidata String Sample X document. xmldata String Output XML String. The sampleservices:x12tovalues service is used to generate an IData object from the EDI document. The pub.xml:documenttoxmlstring service is used to generate an XML String. WmEDIsamples Service Documentation 5

8 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.EDItoXML:segmentMapping All of the services contained in this folder (not listed individually) are used to map ANSI X12 segments to XML targets.the Tutorial.EDItoXML:EDItoXMLPOMap service uses these services. 6 WmEDIsamples Service Documentation

9 Tutorial.FlatFile:parseCsvInput Tutorial.FlatFile The services in this folder illustrate how to convert the two main types of flat files (character delimited and positional) to an IData object using a template and flat file as input. Tutorial.FlatFile:parseCsvInput Illustrates how to convert a character delimited flat file to an IData object using the flat file and template as input. See Also Tutorial.Records:rec_XCEL Tutorial.FlatFile:parseFlatFile Illustrates how to convert a positional flat file to an IData object using the flat file and template as input. The flat file was created with Microsoft Excel. See Also Tutorial.Records:rec_FF WmEDIsamples Service Documentation 7

10 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.FlatFile:parseFlatFile2 Illustrates how to convert a positional flat file to an IData object using the flat file and template as input. The flat file was created with Microsoft Excel. See Also Tutorial.Records:rec_FF2 8 WmEDIsamples Service Documentation

11 Tutorial.Records:POSource Tutorial.Records All of the IS document types in this folder are used for mapping purposes in the following three folders Tutorial.EDItoXML, Tutorial.XMLtoEDI, and Tutorial.FlatFile. Tutorial.Records:POSource Reflects the source XML document that the services in the Tutorial.XMLtoEDI folder use. Tutorial.Records:POTarget Reflects the target XML document that the services in the Tutorial.EDItoXML folder use. Tutorial.Records:rec_FF The IS document type that the flat file sample in Tutorial.FlatFile:parseFlatFile uses. It represents the output of that service. Tutorial.Records:rec_FF2 The IS document type that the flat file sample in Tutorial.FlatFile:parseFlatFile2 uses. It represents the output of that service. Tutorial.Records:rec_XCEL The IS document type that the flat file sample in Tutorial.FlatFile:parseCsvInput uses. It represents the output of that service. WmEDIsamples Service Documentation 9

12 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.XMLtoEDI All the services in this folder illustrate mapping and converting an XML document into an EDI document. Tutorial.XMLtoEDI:XMLPOtoEDIMap Maps an XML PO to an ANSI X EDI document. This service invokes many mapping services that reside in the Tutorial.XMLtoEDI.segmentMapping folder. POSource Document A PO that uses the format defined by the Tutorial.Records:POSource IS document type, which represents the XML PO document structure. EDIT850_4010 Document An X EDI document that uses the format defined by the EDIrecords:X12_4010_850 IS document type. Variable in EDIT850_4010 Description ST Document EDI segment from which the IData object starts. Tutorial.XMLtoEDI:XMLdateConversionToDateTime Converts the date and time format based on input specifications. XMLDate yeardigit String Input date in format of ʺYYYYMMDD hh:mm:ss.ʺ String (optional) Number of digits for year in the output. Default is set to four. date time String Date. String Time. 10 WmEDIsamples Service Documentation

13 Tutorial.XMLtoEDI:appendSegment Tutorial.XMLtoEDI:appendSegment Appends an IData object that represents a segment to an array of IData objects. record recordlist Document The segment to add. Document List The array of IData objects to which to append the segment. recordlist Document List The array of IData objects after the segment is appended. Tutorial.XMLtoEDI:conditionalTruncate Truncates an input String to specified length. instring truncatelength String Input String. String Length to truncate. outstring String Resulting truncated String. Tutorial.XMLtoEDI:processXMLSource Converts an input XML document into an IData object and maps the IData object into a String that represents an EDI document. xmldata String (optional) Input XML document. EDIDocument String (optional) ANSI X document as output of this service. WmEDIsamples Service Documentation 11

14 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.XMLtoEDI:replaceControlChar Replaces the control characters (such as carriage return, line feed, tab, etc.) with the specified String. instring replacestring String Input String. String Character String used to replace the control characters. outstring String Resulting String. 12 WmEDIsamples Service Documentation

15 Tutorial.XMLtoEDI.segmentMapping:XMLToBEG Tutorial.XMLtoEDI.segmentMapping This folder contains segment mappings that map from XML source into EDI segments. Use these as examples for your own mapping needs. Tutorial.XMLtoEDI.segmentMapping:XMLToBEG Maps an XML document equivalent to a BEG segment to an IData object that represents a BEG segment. This service uses the Tutorial.XMLtoEDI:XMLdateConversionToDateTime service. Tutorial.XMLtoEDI.segmentMapping:XMLToDTM Maps an XML document equivalent to a DTM segment to an IData object that represents a DTM segment. This service uses the Tutorial.XMLtoEDI:XMLdateConversionToDateTime and Tutorial.XMLtoEDI:appendSegment services. Tutorial.XMLtoEDI.segmentMapping:XMLToFOB Maps an XML document equivalent to a FOB segment to an IData object that represents a FOB segment. This service uses the Tutorial.XMLtoEDI:appendSegment service to append a FOB IData object to an array of FOB IData objects. Tutorial.XMLtoEDI.segmentMapping:XMLToGS Maps an XML document equivalent to a GS segment to an IData object that represents a GS segment. Tutorial.XMLtoEDI.segmentMapping:XMLToISA Maps an XML document equivalent to a ISA segment to an IData object that represents a ISA segment. Tutorial.XMLtoEDI.segmentMapping:XMLToN1 Maps an XML document equivalent to a N1 segment to an IData object that represents a N1 segment. WmEDIsamples Service Documentation 13

16 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.XMLtoEDI.segmentMapping:XMLToPO1_CTT Maps an input XML source line item to ANSI X PO1 and CTT segment. LineItem POTotal Document List XML source line items. String (optional) Maps to AMT02 in the AMT segment under CTT segment. PO1 CTT Document List PO1 loop for ANSI X transaction set. Document List CTT segment for ANSI X transaction set. Tutorial.XMLtoEDI.segmentMapping:XMLToREF Creates REF segment loop for ANSI X transaction sets. CustomerPONumber AccountingCode String Purchase order number. Document List Accounting code. REF Document List REF segment loop for ANSI X transaction set. Tutorial.XMLtoEDI.segmentMapping:XMLToTD5 Creates TD5 segment loop for ANSI X transaction sets. ShipMethodCode ShipmentPriorityCode String Ship method code. String Shipment priority code. TD5 Document List TD5 segment loop for ANSI X transaction set. 14 WmEDIsamples Service Documentation

17 Tutorial.XMLtoEDI.segmentMapping:XMLToTXI Tutorial.XMLtoEDI.segmentMapping:XMLToTXI Creates TXI segment loop for ANSI X transaction sets. TaxExemptCode TaxExemptNumber String Tax exempt code. String Tax exempt number. TXI Document List TXI segment loop for ANSI X transaction set. WmEDIsamples Service Documentation 15

18 CHAPTER 1 WmEDIsamples Service Documentation Tutorial.properties This folder contains a Java service that obtains trading partner specific information that the mapping services in the Tutorial.XMLtoEDI.segmentMapping folder use to create the Interchange Header/Trailer. Tutorial.properties:getProperties Gets properties defined in the partnerʹs configuration file. B2B_config_file properties String Configuration file name. String List Property names to retrieve. values String List Retrieved property values 16 WmEDIsamples Service Documentation

19 sampleservices:iterator810 Sample Flow Services These sample flow services illustrate how you can use different built in services and features of the EDI Module to process your documents. sampleservices:iterator810 Demonstrates the use of the iterator variable of the wm.b2b.edi:converttovalues service to parse large input data by processing it piece by piece. Each time the wm.b2b.edi:converttovalues service is invoked, the iterator variable is set to true. The format of the EDIFFSchema.X12.V4010:Sample810_Large flat file schema dictates how the service processes the sample 810 document. This flat file schema defines three top level segment structures: 1) ST, 2) IT1, and 3) TDS. The first time the Iterator810 service invokes the wm.b2b.edi:converttovalues service, the ST segment structure is processed. It reads the input data from the sample 810 document until it encounters the next top level segment structure, which is the first IT1 segment structure. The Iterator810 service invokes the wm.b2b.edi:converttovalues service for each IT1 segment structure until it encounters the TDS segment structure. After processing the TDS segment structure, the Iterator810 service exists the REPEAT loop because there is no more input data. The Iterator810 service determines there is no more input when ediobject, which is an output parameter from the wm.b2b.edi:converttovalues service, is null. Because the wm.b2b.edi:converttovalues service always returns its output in EDIValues, each pass of the service invocation should save the output or map it somewhere else. In this example, the main iteration maps each segment under ISA. In the iteration steps under the ST segment, an empty sequence operation is used. This can be replaced by services that process one item in the invoice. The services have access to the current items as well as all of the information in ISA, GS, ST and other segments under ST.This service does not validate or check the structure of any segments. edidata String EDI 810 document of ANSI X12 version If it is not specified, the default sample document is used. Values EDIValues Document An 810 document structure (defined in the EDIFFSchema.X12.V4010:Sample810_Large flat file schema). Document Single invoice item. It will only show up after the sub level iterator call. WmEDIsamples Service Documentation 17

20 CHAPTER 1 WmEDIsamples Service Documentation sampleservices:unedifacttovalues Illustrates an example flow service for an inbound UN/EDIFACT document. edidata compliancecheck String UN/EDIFACT standard document. String (optional) Whether the compliance check is required. Specify true or false. validate Value of compliancecheck true false String (optional) Value of validate Meaning Compliance check is required. Compliance check is not required. Meaning returnerrors true false Validation check is required. Validation check is not required. String (optional) How you want this service to return error messages when validate is set to true. Specify one of the following. Value of validate Meaning asarray inresults both Return validation errors with the edidata in an array called errors. This is the default. Return validation errors in the EDIValues object. Return validation errors in both errors and EDIValues. Values Document The output UN/EDIFACT document in IData object format. sampleservices:x12tovalues Illustrates an example flow service for an inbound ANSI X12 document. edidata docprocessingsvc String EDI document. String A service to process an ANSI X12 transaction. 18 WmEDIsamples Service Documentation

21 sampleservices:x12tovalues compliancecheck String (optional) Whether the compliance check is required. Specify true or false. validate Value of compliancecheck true false String (optional) Value of validate Meaning Compliance check is required. Compliance check is not required. Meaning returnerrors true false Validation check is required. Validation check is not required. String (optional) How you want this service to return error messages when validate is set to true. Specify one of the following. Value of validate Meaning asarray inresults both Return validation errors with the edidata in an array called errors. This is the default. Return validation errors in the EDIValues object. Return validation errors in both errors and EDIValues. Values Document The output ANSI X12 IS document in IData object format. WmEDIsamples Service Documentation 19

22 CHAPTER 1 WmEDIsamples Service Documentation Sample Business Process The WmEDIsamples package, which you can download from the Knowledge Base on the Advantage Web site at provides a sample that illustrates one way of using EDI documents in a business process. To read an overview of the sample, learn how to set it up and to run it, perform the following procedure. Note: If you intend to also run the sample provided for the webmethods EDIINT Module (which is also included in the WmEDIsamples package), set up the EDIINT Module sample before setting up this sample business process. 1 Download the WmEDIsamples package from the Knowledge Base on the Advantage Web site at Important! You should delete the WmEDIsamples package before going into production. 2 Open the Server Administrator if it is not already open. 3 In the Solutions menu of the navigation panel, click EDI. The Server Administrator opens a new browser window to display the EDI Module home page. 4 From the EDI Module home page, in the EDI Processes menu of the navigation panel, click Run a Demo. To continue, follow the instructions on the home page. The following sections describe the services that are used in the execution and setup of the sample. The sample services have been certified, meaning that they have been tested by webmethods. wm.b2b.editn.sample.setup:setupsample Creates the partner profiles and TN document types for the sample, if they do not exist. SenderCorporateName SenderDuns SenderHost SenderPort SenderUserName SenderPassword ReceiverCorporateName ReceiverDuns String Corporate Name of the sender s profile. String Sender s D U N S number. String The machine name for the sender. String The machine name for the sender. String The user name used to connect to the sender s machine. String The password used to connect to the sender s machine. String Corporate Name of the receiver s profile. String Receiver s D U N S number. 20 WmEDIsamples Service Documentation

23 wm.b2b.editn.sample.setup:setupedibizdoctypes ReceiverHost ReceiverPort ReceiverUsername ReceiverPassword String The machine name for the receiver. String The port on which the Receiver will be listening. String The user name used to connect to the receiver s machine. String The password used to connect to the receiver s machine. Only the sample web pages should invoke this service. If you intend to also run the sample provided for the webmethods EDIINT Module (in the WmEDIsamples package, which is located in the Knowledge Base Samples area on the Advantage Web site at set up the EDIINT Module sample before setting up the WmEDIforTN sample. wm.b2b.editn.sample.setup:setupedibizdoctypes Installs the TN document types that are needed for EDI documents used in the sample. Only the sample web pages should invoke this service. wm.b2b.editn.sample.setup:setupxmlbizdoctypes Installs the TN document types that are needed for XML documents used in the sample. Only the sample web pages should invoke this service. WmEDIsamples Service Documentation 21

24 CHAPTER 1 WmEDIsamples Service Documentation wm.b2b.editn.sample.setup:setupprofile Sets up the profiles for partners in the sample. CorporationName DUNS host port url user password String The corporate name for the profile. String The external ID for the profile. String The machine name. String The port for this profile. String The URL to which to connect. String The user name for this profile. String The password for the profile. Only the sample web pages should invoke this service. wm.b2b.editn.sample.receiver:process850 Takes an EDI X and generates an 855 in response. edidata String EDI 855 document. The EDI Seller business process invokes this service. 22 WmEDIsamples Service Documentation

25 wm.b2b.editn.sample.receiver:send997 wm.b2b.editn.sample.receiver:send997 Transmits a 997 document to the receiver trading partner. 997 String Text of an EDI 997 document. The Receive EDI Envelope business process invokes this service. wm.b2b.editn.sample.receiver:generate997 Creates a 997 document in response to an X12 Envelope. X12Env edidata Document The X12 envelope. String X12 Envelope used to generate 997 functional acknowledgement. 997 String The 997 document. The Receive EDI Envelope business process invokes this service. wm.b2b.editn.sample.receiver:send855 Sends an EDI 855 document to the sender trading partner. edidata String Text of the EDI 855 document. WmEDIsamples Service Documentation 23

26 CHAPTER 1 WmEDIsamples Service Documentation The EDI Seller business process invokes this service. wm.b2b.editn.sample.receiver:processenvelope Used to represent where envelope processing would occur in a business process. The Receive EDI Envelope business process invokes this service. wm.b2b.editn.sample.util:getlastdocuments Retrieves the BizDocEnvelopes for events that occurred in a business process. parameters documents getcontent lastevents Document Provided by the process run time facility of the Integration Server. (The process run time facility manages the execution of business processes.) Document Provided by the process run time facility of the Integration Server. String Whether the document content, which is saved in the BizDocEnvelope, should be retrieved. String List Names of the most recent event(s) that occurred in the business process. recordcount events String Number of events returned. Document List (optional) The BizDocEnvelopes for all document events. 24 WmEDIsamples Service Documentation

27 wm.b2b.editn.sample.util:enable wm.b2b.editn.sample.util:enable This service places a variable in the pipeline that alters the way in which conversation IDs are constructed for EDI documents. To run both sides of a conversation on a single instance of the Integration Server, the construction of the conversation ID is forced to be ReceiverID-SenderID-InstanceID. This service should be used only in demonstration circumstances. The conversation ID is only constructed this way if the variable is present in the pipeline when the service wm.tn:receive is invoked. wm.b2b.editn.sample.util:return997 Determines whether a 997 should be sent in response to a document. parameters documents Document Provided by the process run time facility of the Integration Server. (The process run time facility manages the execution of business processes.) Document Provided by the process run time facility of the Integration Server. X12Env send997 Document BizDocEnvelope of the last event in the business process that occurred. String Whether a 997 should be sent. This will be true if a 997 should be sent or false if not. WmEDIsamples Service Documentation 25

28 CHAPTER 1 WmEDIsamples Service Documentation wm.b2b.editn.sample.util:getbizdocfromevent Retrieves the BizDocEnvelopes for events that occurred in a business process. parameters documents getcontent lastevents Document Provided by the process run time facility of the Integration Server. (The process run time facility manages the execution of business processes.) Document Provided by the process run time facility of the Integration Server. String Whether the document content, which is saved in the BizDocEnvelope, should be retrieved. String List Names of the most recent event(s) that occurred in the business process. bizenv Document The BizDocEnvelope. wm.b2b.editn.sample.util:checksetup Checks the system to determine whether the sample is configured properly. setupproperly profilesokay docsokay scriptsokay String Whether all the components of the sample appear to be configured properly. This will be true if configured properly; otherwise false. String Whether the trading partner profiles for the sample are present. This will be true if profiles are present; otherwise false. String Whether the TN document types for the sample are present. This will be true if TN document types are present; otherwise false. String Whether the process models for the sample are present. This will be true if the process models are present; otherwise false. 26 WmEDIsamples Service Documentation

29 wm.b2b.editn.sample.util:receive wm.b2b.editn.sample.util:receive Alternate receive method that first calls wm.b2b.editn.sample.util:enable, and then wm.tn:receive. This is to force the conversation IDs in such a way that both sides of the conversation can take place on a single instance of the Integration Server. Only the sample web pages should invoke this service. wm.b2b.editn.sample.util:deliver Deliver BizDocEnvelopes from one trading partner to another. Defaults to using the Secondary HTTP delivery method that is specified in the receiver s trading partner profile. bizdoc Document The BizDocEnvelope to deliver. Only the sample web pages should invoke this service. wm.b2b.editn.sample.sender:process997 This is a placeholder service to represent the processing of a 997 done by the sender. WmEDIsamples Service Documentation 27

30 CHAPTER 1 WmEDIsamples Service Documentation The Send EDI Envelope business process invokes this service. wm.b2b.editn.sample.sender:log850 This is a placeholder service to represent the logging of an outbound 850 message done by the sender. The EDI Buyer business process invokes this service. wm.b2b.editn.sample.sender:sendenvelope Sends an X12 envelope containing an EDI 850 document to a trading partner. The Send EDI Envelope business process invokes this service. wm.b2b.editn.sample.sender:generateenvelope Generates an X12 envelope containing an EDI 850 document. 28 WmEDIsamples Service Documentation

31 wm.b2b.editn.sample.sender:process855 The EDI Buyer business process invokes this service. wm.b2b.editn.sample.sender:process855 Placeholder to represent business logic that is executed when an 855 document is received. The EDI Buyer business process wm.b2b.editn.sample.sender:start Starts the sample. Creates an XML Purchase Order document that is submitted to Trading Networks. SenderID ReceiverID DocumentID ControlNumber String D U N S number of the trading partner that is sending the document. String D U N S number of the trading partner to whom the document will be sent. String Unique identifier for the purchase order. String Unique identifier for the group segment that will contain the purchase order. SenderTNID ReceiverTNID String The Trading Networks internal ID for the sender. String The Trading Networks internal ID for the receiver. Only the sample web pages should invoke this service. WmEDIsamples Service Documentation 29

32 CHAPTER 1 WmEDIsamples Service Documentation wm.ediint.sample You can run the following sample send service within the webmethods Developer to exchange sample EDIINT messages. wm.ediint.sample:send Reads the input file as an InputStream and invokes the wm.ediint.send service. datafilename datacontenttype type String Name and location of the file to send. String The content type of the file to send, for example application/edi-x12. String The S/MIME type that you want to use for the outbound EDIINT message. Specify one of the following: Value of type Description plain signed encrypted signedandencrypted getfromprofile You want the wm.ediint.sample:send service to neither sign nor encrypt the outbound EDIINT message. You want the wm.ediint.sample:send service to sign the outbound EDIINT message. You want the wm.ediint.sample:send service to encrypt the outbound EDIINT message. You want the wm.ediint.sample:send service to sign and encrypt the outbound EDIINT message. You want the wm.ediint.sample:send service to determine whether to sign and/or encrypt the outbound EDIINT message using the value of the S/MIME Type extended field from the receiver s profile. 30 WmEDIsamples Service Documentation

33 wm.ediint.sample:send deliverymethod String The delivery method you want to use to send the EDIINT document. The wm.ediint:send service obtains the Trading Networks profile for the receiver (specified by the receiverid input variable) and delivers the EDIINT document to the receiver s system using the information specified for the delivery method you specify. Specify a delivery method that is defined in the receiver s Trading Networks profile. For EDIINT AS1, specify one of the following: PrimarySMTP (corresponds to the Trading Networks Primary delivery method) SecondarySMTP (corresponds to the Trading Networks Secondary delivery method) For EDIINT AS2, specify one of the following: PrimaryHTTP SecondaryHTTP PrimaryHTTPS SecondaryHTTPS For EDIINT AS3, specify the following: requestmdn requestsignedreceipt AS3 String Whether you want the receiver to return an MDN. Specify one of the following: Value of requestmdn none synchronousmdn Meaning Do not request a return MDN. Request a return synchronous MDN. asynchronousmdn Request a return asynchronous MDN. Note: If you specify PrimarySMTP, SecondarySMTP, PrimaryFTPS, or SecondaryFTPS for deliverymethod, you can only receive an asynchronous MDN. String Whether you want the MDN to be signed. Note: requestsignedreceipt is ignored when requestmdn is false. Value of requestsignedreceipt Meaning true false Request a signed MDN. Request a plain (not signed) MDN. WmEDIsamples Service Documentation 31

34 CHAPTER 1 WmEDIsamples Service Documentation senderid Document Identification of the sender of the EDIINT message. Variable in senderid Description id idtypedesc The sender s external ID. That is, the identification that you want for the sender in the message. Optional. The external ID type for the sender ID you specified in id. This is an external ID type as defined in Trading Networks. Note: By default, the service uses the appropriate external ID type based on the value you specify for the deliverymethod parameter. For example, if you specify AS3 for the deliverymethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idtypedesc only if you want to override this default. receiverid Document Identification of the receiver of the EDIINT message. Variable in senderid Description id idtypedesc The receiver s external ID. That is, the identification that you want for the receiver in the message. Optional. The external ID type for the receiver ID you specified in id. This is an external ID type as defined in Trading Networks. Note: By default, the service uses the appropriate external ID type based on the value you specify for the deliverymethod parameter. For example, if you specify AS3 for the deliverymethod parameter, the service uses the EDIINT AS3 external ID type. Specify a value for idtypedesc only if you want to override this default. conversationid String (optional) The conversation ID for the outbound EDIINT message. The conversationid parameter is an identifier that links all documents that are part of the same business process (also called a conversation). That is, all documents in the same business process need to have the same conversationid. As described in the webmethods Trading Networks User s Guide, Trading Networks can extract conversationids from EDI documents and use them to pass documents to the webmethods Process Run Time (PRT) after Trading Networks performs the actions identified by a processing rule. 32 WmEDIsamples Service Documentation

35 wm.ediint.sample:send In this field, you might want to specify the same conversation ID as that of the payload that you are sending. The EDIINT Module automatically assigns to a return MDN the same conversation ID that is assigned here. Note: Leave this field blank unless you own a license for the webmethods Process Run Time (PRT). WmEDIsamples Service Documentation 33

36 CHAPTER 1 WmEDIsamples Service Documentation 34 WmEDIsamples Service Documentation