Understanding and Using EDI Module
About this help
Online Information and Support
Data Protection
Document Conventions
Understanding EDI Concepts
Overview of webMethods Module for EDI
Overview
Architecture
Supported EDI Standards
Processing Inbound EDI Documents
Overview
Before You Process EDI Documents
Flat File Schemas
Processing Inbound EDI Documents with Trading Networks
Creating an EDI Client
Defining Trading Partner Information
Using Standard or Non-Standard Processing
Comparing Standard vs Non-Standard Processing
EDI Document Inbound Processing
Initial Processing of the EDI Recognizer
Processing Documents in Trading Networks
Processing Rules for Inbound EDI Documents
Preprocessing Actions
Processing Actions
Creating EDI Trading Partner Agreements
Generating Functional Acknowledgments
Generating Interchange Acknowledgments
Forming EDI Documents and Sending Them Outbound
Overview
Creating a Service for Forming an Outbound EDI Document
Delivering the EDI Document Directly from the Service that Forms It
Submitting the Outbound EDI Document to Trading Networks to Deliver It
Routing the Outbound EDI Document to Trading Networks to Deliver It
Generating the AUTACK Message for EANCOM
Working with VANs
Overview
Inbound Processing: Retrieving Documents from VANs
Outbound Processing: Delivering Documents to VANs
Batching Outbound EDI Documents
Overview
Creating the Batched EDI Documents
Delivering the Batched Document
EDI Documents in Business Processes
Overview
How You Define the Business Process
Conversation IDs for EDI Documents
How EDI Documents are Passed to a Business Process
Using Module for EDI Decoupled from Trading Networks
Overview
Configuring Module for EDI Decoupled from Trading Networks
Processing of Inbound EDI Documents
Services to Process the Inbound EDI Document
Forming EDI Documents to Send Outbound
Installing and Using EDI Module
Installing, Upgrading, and Uninstalling webMethods Module for EDI
Overview
Requirements
Installing Module for EDI
Upgrading the Module for EDI from 9.0 to 9.12
Uninstalling Module for EDI
Before You Begin
Uninstalling Module 9.12 for EDI
Configuring webMethods Module for EDI
Overview
Assigning User-Specific Permissions in My webMethods
Defining Module for EDI Properties
Setting Up Items Required for Structural Validation and Conversion
Configuring Format Services to Convert Field Values
Associating the EDI Format Services with EDI Data Types
Creating Flat File Schemas for Internal-Format Documents
Defining TN EDI Document Types
Step 1: Define Document Type Information
Defining Document Type Information Using My webMethods
Step 2: Define Attributes to be Extracted from Documents
Attributes Stored for TRADACOMS Document Types
Extracting a Document Attribute Using an XQL Query
Examples of Extracting a Document Attribute Using an XQL Query
Step 3: Define Processing Options
Creating a TN EDI Document Type Based on a Transaction
Flat File Schema Namespace Conventions
Flat File Schema Namespace Conventions for Non-TRADACOMS Standards
Flat File Schema Namespace Conventions When Using TRADACOMS
Managing TN EDI Document Types
Viewing the Code List Details
Viewing Alternate Name and Description of Segments
Updating TN EDI Document Types
Updating the Description or Status of a TN EDI Document Type
Updating the Processing Options Specified in the Document Type
Updating a TN EDI Document Type Based on a Transaction
Managing Document Attributes
Adding a Document Attribute
Editing a Document Attribute
Deleting a Document Attribute
Overwriting Document Attributes Extracted from Inbound Documents
EDI Transaction
TA1 Transaction
FA Transaction
Adding New Versions of EDI Standards
Defining Trading Partner Information
Overview
Partner Information You Need to Define
Defining Trading Partner Profiles
Adding External ID Types for EDI ID Qualifiers
Adding and Overriding EDI ID Qualifiers
Partner Profile ID Types Mapping for EDI Documents
Defining EDI Trading Partner Agreements
Modifying the Default EDITPA
Defining a Partner-Specific EDITPA
wm.b2b.editn.TPA:EDITPA IS Document Type
GSRouting Variables
PersistMultipleDocEnvelope Variable
processingMode Variable
splitOption Variable
FAReconciliation Variable
UNAmode Variable
publishBatchFailEvent Variable
delimiters Variables
envelopeIdentifier Variables
ICheaderInfo Variables
FAGeneration Variables
ControlNumberManagement Variables
useReverseRoute Variable
BatchCriteria Variables
EDITransportMedia Variable
persistOriginalEnvelope Variable
documentPersistOrder Variable
LateFA Variables
X12TA1Generation Variables
EANCOMAUTACK Variables
Defining Trading Partner Information When Using TRADACOMS
Overview
Partner Information You Need to Define When Using TRADACOMS
Defining Trading Partner Profiles When Using TRADACOMS
External ID Types When Using TRADACOMS
Optionally Configuring the External ID Types When Using TRADACOMS
Defining EDI Trading Partner Agreements When Using TRADACOMS
Modifying the Default EDITPA When Using TRADACOMS
Defining a Partner-Specific EDITPA When Using TRADACOMS
wm.b2b.editn.TPA:EDITPA IS Document Type When Using TRADACOMS
TRADACOM Variables
Storage Options for File Document Types
Errors that Prevent the Splitting of Transmissions
Validation Errors
Invalid File Structure
Defining Control Number Information for Trading Partners
Overview
Managing Control Number Information
Defining How Module for EDI Creates the Control Number Sequence
Adding Entries to the EDIControlNumber Table
Configuring Control Number Settings
Configuring Control Number Settings Using the My webMethods Control Numbers Page
Configuring Control Number Settings Using the My webMethods Partner Profiles Page
Updating Control Number Settings
Turning Inbound Control Number Validation On and Off
Activating Validation for ANSI X12 or UN/EDIFACT Documents
Activating Validation for VDA Documents
Activating Validation for TRADACOMS Documents
Defining Control Number Information for Processing Documents
Defining Control Number Information for Processing Inbound Documents
Defining Control Number Information for Processing Outbound Documents
Defining Actions Module for EDI Can Take for Invalid Control Numbers
Defining How to Handle Invalid Control Numbers for ANSI X12 or UN/EDIFACT Documents
Defining How to Handle Invalid Control Numbers for VDA Documents
Defining How to Handle Invalid Control Numbers for TRADACOMS Documents
Searching for Existing Control Number Settings
Searching for Existing Control Number Settings Using My webMethods
Creating Clients that Send EDI Documents to Integration Server
Overview
Defining the Content Type to Use
Before Creating the Service to Form an EDI Document
Creating the Service the Client Invokes to Handle EDI Documents
Logic to Include in the Service to Form an EDI Document
Validating the Input Internal-Format Document When It Is an IData Object
Adding UN/EDIFACT Envelopes
Validating the EDI Document Envelope
Sending EDI Documents to Integration Server via HTTP
Identifying the Service to Invoke
Logic to Include in the HTTP Client
Example of Input Parameters for the pub.client:http Service
Sending EDI Documents to Integration Server via FTP
Identifying the Service to Invoke
Logic to Include in the FTP Client
Example of Input Parameters for the pub.client:ftp Service
Sending EDI Documents to Integration Server via File Polling
Setting Up File Polling
Identifying the Service to Invoke
Creating Clients that Send EDI Documents to Trading Networks
Overview
Content Type to Use
Content Type for EDI Documents that Do Not Contain Mainframe Data
Content Types for EDI Documents that Contain Mainframe Data
Service the Client Invokes
Sending EDI Documents to Trading Networks via HTTP/S
Example of Input Parameters for the pub.client:http Service
Sending EDI Documents to Trading Networks via FTP
Example of Input Parameters for the pub.client:ftp Service
Sending EDI Documents to Trading Networks via File Polling
Sending EDI Documents to Trading Networks via My webMethods
Using a Service to Send Multiple EDI Documents to Trading Networks
Handling Large Documents When Using Trading Networks
Overview
Configuring Module for EDI for Large Document Handling
Determining When an EDI Document Is Large
Converting Large Documents to IData Objects Iteratively
Troubleshooting Memory Constraint Problems
Generating Acknowledgments
Overview
Generating Functional Acknowledgments
Before You Can Generate a Functional Acknowledgment
Configuring the Maximum Number of Transaction Errors
Determining How Module for EDI Reports FA Status
Determining If the Child Transaction is Allowed in Its Envelope
Determining If a Transaction Is an FA or If a Group Contains an FA
syntaxErrorStatus Parameter
logicalErrorStatus Parameter
childTransactionRejectedStatus Parameter
How Module for EDI Determines Which FA Status to Use
Transaction FA Status
Group FA Status
UN/EDIFACT Interchange FA Status
When to Invoke the generateFA Service
Using a Service that Processes Documents at One Time
Invoking generateFA Before Invoking envelopeProcess
Invoking generateFA Immediately after Invoking envelopeProcess
Using a Service that Processes Documents Iteratively
Output from the generateFA Service
Tracking Late Functional Acknowledgments
Before Tracking Late FAs
Tracking Late FAs
Example
Generating Interchange Acknowledgments
Before Creating the Service to Process EDI Documents
Overview
Inputs to Your Service
Logic to Include in the Service to Process EDI Documents
Determining Which Process Method to Use
Processing the Entire Document at One Time
Performing Envelope Validation and Compliance Checks
Processing the Document Iteratively, Segment by Segment
Customizing the EDI Flat File Schema
Logic for the Service to Process the Document Iteratively
Samples
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks
Overview
Preparing to Receive EDI Documents
Specifying EDITPA Variables that Affect Inbound Processing
Validating the EDIFACT Document Schema
Validating VDA Message Structure
Trading Networks Attributes and EDI Documents
System Attributes that Module for EDI Sets
DocumentID
GroupID
ConversationID
Enabling Extraction of ConversationIDs from an EDI Document
Disabling Extraction of ConversationIDs from EDI Documents
Custom Attributes that Module for EDI Sets
EDI Group Type
EDI Outbound FA
EDI Processing Mode
EDI Status
EDI Version
Envelope CntrlNum Status and Group CntrlNum Status
EDI FA Status
TA1 Status and TA1 Code
Managing Custom Attributes for EDI Documents
Setting the Attribute Values at Run Time
Defining a Processing Rule that Uses Your Custom Attribute as Criteria
Defining Processing Rules to Process Inbound EDI Documents
Specifying Processing Rule Criteria
Specifying Preprocessing Actions
Specifying Processing Actions
Coding Services to Process Transaction and Group Documents
Information in the Pipeline that Your Service Can Access
Logic to Process a Transaction Document
Logic to Process a Group Document when splitOption is Group
Processing Inbound TRADACOMS Documents Using Trading Networks
Overview
Before Setting Up Processing of Inbound EDI Documents When Using TRADACOMS
Specifying EDITPA Variables that Affect Inbound Processing When Using TRADACOMS
Trading Networks Attributes and EDI Documents When Using TRADACOMS
System Attributes that Module for EDI Sets When Using TRADACOMS
DocumentID
GroupID
Custom Attributes that Module for EDI Sets When Using TRADACOMS
Managing Your Own Custom Attributes for EDI Documents When Using TRADACOMS
Setting Attribute Values at Run Time When Using TRADACOMS
Defining a Processing Rule that Uses Your Custom Attribute as Criteria When Using TRADACOMS
Defining Processing Rules to Process Inbound EDI Documents When Using TRADACOMS
Specifying Processing Rule Criteria When Using TRADACOMS
Specifying Preprocessing Actions When Using TRADACOMS
Specifying Processing Actions When Using TRADACOMS
Coding Services to Process File and Batch Documents When Using TRADACOMS
Information in the Pipeline that Your Service Can Access When Using TRADACOMS
Logic to Process a File Document
Logic to Map a File Document to an Internal-Format Document
Optional Inbound Processing When Using Trading Networks
Overview
Validating Inbound Control Numbers
Valid Control Numbers
Invalid Control Numbers
Duplicate Control Numbers
Out-of-Sequence Control Numbers
Performing Control Number Validation
Actions Module for EDI Can Take for Invalid Control Numbers
Error & Continue
Process Normally
Reject
Defining Processing Rules to Handle Documents with Invalid Control Numbers
Setting the EDI Status Custom Attribute for Control Number Validation
Defining the Processing Rule to Handle Documents with Invalid Control Numbers
Reprocessing EDI Documents with Invalid Control Numbers
Reprocessing Documents with Duplicate Control Numbers
Reprocessing Documents with Out-of-Sequence Control Numbers
Creating a Service to Reprocess Documents with Out-of-Sequence Control Numbers
Automatically Generating Functional Acknowledgments
Turning Automatic FA Generation On and Off
Determining How Module for EDI Reports FA Status
Defining FA Statuses as Acceptable and Unacceptable
Defining Actions Module for EDI Takes Based on FA Status
Processing Documents with Acceptable FA Statuses
Processing Documents with Unacceptable FA Statuses
Defining a Processing Rule to Deliver FAs
Defining Processing Rules for Documents with Unacceptable FA Statuses
Automatically Generating Interchange Acknowledgments
Performing Optional Processing of Inbound EDI Documents
Forming EDI Documents to Send Outbound When Using Trading Networks
Overview
Preparing Trading Networks to Process Internal-Format Documents
Creating the Service to Form the EDI Document
Before Creating the Service to Form an EDI Document
Creating the Service
Obtaining Control Numbers for Outbound Processing (ANSI X12 and UN/EDIFACT)
Adding TRADACOMS Envelopes and Obtaining Control Numbers
Delivering the Outbound EDI Document
Delivering the EDI Document Directly from the Service that Forms It
Submitting the EDI Document to Trading Networks
Specifying Variables that Affect Outbound Processing
Specifying Variables that Affect Outbound Processing When Using TRADACOMS
Preparing Trading Networks to Deliver the EDI Document
Adding Logic to the Service that Forms the EDI Document to Submit to Trading Networks
Preparing the Pipeline to Invoke the wm.tn.doc.xml:routeXML Service
Routing the Outbound EDI Document to Trading Networks
Adding Logic to the Service that Forms the EDI Document that Routes through Trading Networks
Creating a BizDocEnvelope for the Outbound EDI Document
Batching EDI Documents
Overview
Indicating How Many Batch EDI Documents to Create
How Documents Are Combined to Create the Batch EDI Document
Extracting Transactions and Sorting the Batched Documents
Sorting Transactions in the Queued Documents
Collection Areas Representing an Interchange in the Final Batch EDI Document
Subcollections Representing a Group in the Final Batch EDI Document
Delimiters Associated with Collection Areas
Example of Sorting Documents
When EDI Documents Have No Interchange or Transmission Header
Sorting Transactions when Queued Documents Have No Interchange Headers
Default Collection Area (Interchange in the Final Batch EDI Document)
Subcollections when there Are No Headers (Groups in the Final Batch EDI Document)
Delimiters Associated with the Default Collection Area
Delimiters Used for the Batch EDI Document
Updating the Task Status and Publishing Documents for Failed Tasks
Recombining the Transactions into the Batch EDI Document
Creating the Batch EDI Document when Using SINGLEOUTPUT
Creating the Batch EDI Document when Using MULTIPLEOUTPUTS
Before You Can Batch EDI Documents
Controlling How the batchProcess Service Forms the Batch Document
EDITPA Variables that the batchProcess Service Uses
EDITPA Variables Used when Sorting Transactions
EDITPA Variables Used when Recombining Transactions
Preparing to Batch EDI Documents
Determining the Number of Queues You Need to Define
Defining the Scheduled Delivery Queues
Defining Processing Rules to Batch EDI Documents
Delivering the Batch EDI Document
Viewing Batched EDI Documents
Retrieving and Delivering EDI Documents from and to VANs
Overview
Preparing to Retrieve Documents from a VAN
Preparing to Deliver Documents to VANs
Defining the Scheduled Delivery Queue
Defining a Processing Rule to Place Documents in the Queue
Handling Conventions Required by Specific VANs
Customizing Built-In Services to Connect to Another VAN
Reconciling Functional Acknowledgments
Overview
FA Reconciliation
Turning FA Reconciliation On or Off
Information Module for EDI Records to Reconcile FAs
FA Statuses
Controlling FA Status for Documents Submitted Multiple Times
Setting FA Status Manually
Viewing Log Information for EDI Documents
Overview
Viewing the Server Log
Viewing the Trading Networks Activity Log
Viewing Information about EDI Documents
Overview
EDI Documents You Can View
Viewing EDI Documents
Trading Networks Processing Status and EDI Documents
Viewing Information about EDI Documents in Queues
Viewing Related Documents with Relationship Labels
Including Documents in a Business Process
Overview
Designing the Process Model
Sample Process Models for ANSI X12
Sample Process Models for UN/EDIFACT
Assigning Conversation IDs to EDI Documents
Instance IDs for Interchange, Group, and Transaction Documents
Instance IDs for Functional Acknowledgments
Sample Business Process
Monitoring Your Business Processes
Non-Standard Processing
Overview
Defining Partner Information When Using Non-Standard Processing
Defining Trading Networks Profiles When Using Non-Standard Processing
Defining a Partner-Specific EDITPA When Using Non-Standard Processing
wm.b2b.editn.TPA:EDITPA IS Document Type When Using Non-Standard Processing
Defining Interchange-Level Sender/Receiver Pair Information
Editing and Deleting Interchange-Level Sender/Receiver Pair Information
Defining Group-Level Sender/Receiver Pair Associations
Querying for Group-Level Sender/Receiver Pair Associations
Defining Control Number Information for Partners When Using Non-Standard Processing
Turning Inbound Control Number Validation On or Off When Using Non-Standard Processing
Defining Actions for Invalid Control Numbers
Defining the Control Number Settings
Processing Inbound EDI Documents using Trading Networks and Non-Standard Processing
Before You Can Process Inbound EDI Documents
Variables that Affect Inbound Processing
Forming EDI Documents to Send Outbound When Using Trading Networks and Non-Standard Processing
Before Creating the Service to Form an EDI Document
Creating the Service When Using Non-Standard Processing
Using Module for EDI Decoupled from Trading Networks
Overview
Using Only the WmEDI Package with Integration Server
Configuring Module for EDI Decoupled from Trading Networks
Preparing Module for EDI Decoupled from Trading Networks
Creating Flat File Schemas for EDI Documents
Creating a Flat File Schema from a SEF File
Creating a Flat File Schema from an IDOC
Forming EDI Documents and Sending Them Outbound
Validating the Input Internal-Format Document When It Is an IData Object
Adding UN/EDIFACT Envelopes
Checking Your Work
Example
Building Services with EDI Module
Part I WmEDI Package
WmEDI Core Services
Summary of Elements in this Folder
wm.b2b.edi:convertToString
wm.b2b.edi:convertToValues
wm.b2b.edi:createIDOCtemplate
wm.b2b.edi:createTemplateFromSEF
wm.b2b.edi:createW3CXMLSchema
wm.b2b.edi:envelopeProcess
wm.b2b.edi:SEFParse
WmEDI Migration Folder
Summary of Elements in this Folder
wm.b2b.edi.migration:migrateTemplate
WmEDI TemplateMgr Folder
Summary of Elements in this Folder
wm.b2b.edi.templateMgr:getProperties
wm.b2b.edi.templateMgr:getTemplate
WmEDI TRADACOMS Folder
Summary of Elements in this Folder
wm.b2b.edi.tradacoms:convertToString
wm.b2b.edi.tradacoms:convertToValues
wm.b2b.edi.tradacoms.compose:addToTradacomsTransmission
wm.b2b.edi.tradacoms.compose:endTradacomsTransmission
wm.b2b.edi.tradacoms.compose:startTradacomsBatch
wm.b2b.edi.tradacoms.compose:startTradacomsTransmission
WmEDI Util Folder
Summary of Elements in this Folder
wm.b2b.edi.util:addGroupEnvelope
wm.b2b.edi.util:addGroupEnvelopeEDIFACT
wm.b2b.edi.util:addICEnvelope
wm.b2b.edi.util:addICEnvelopeEDIFACT
wm.b2b.edi.util:concatStringArray
wm.b2b.edi.util:controlNumber
wm.b2b.edi.util:convertToValues
wm.b2b.edi.util:EDIconcat
wm.b2b.edi.util.FA:lite997
wm.b2b.edi.util:generateFA
wm.b2b.edi.util:getEDIDictionaryName
wm.b2b.edi.util:getEDIFFSchemaName
wm.b2b.edi.util:getEDIstring
wm.b2b.edi.util:invoke
wm.b2b.edi.util:makeArray
wm.b2b.edi.util:nullBlankCheck
wm.b2b.edi.util:nullifyIfBlank
wm.b2b.edi.util:pad
wm.b2b.edi.util:standardCheck
Format Services: Inputs and Outputs
wm.b2b.edi.util.formatServices:formatAN
wm.b2b.edi.util.formatServices:formatDate6
wm.b2b.edi.util.formatServices:formatDate8
wm.b2b.edi.util.formatServices:formatDecimal
wm.b2b.edi.util.formatServices:formatN
wm.b2b.edi.util.formatServices:formatN0
wm.b2b.edi.util.formatServices:formatN1
wm.b2b.edi.util.formatServices:formatN2
wm.b2b.edi.util.formatServices:formatN3
wm.b2b.edi.util.formatServices:formatN4
wm.b2b.edi.util.formatServices:formatN5
wm.b2b.edi.util.formatServices:formatN6
wm.b2b.edi.util.formatServices:formatN7
wm.b2b.edi.util.formatServices:formatN8
wm.b2b.edi.util.formatServices:formatN9
wm.b2b.edi.util.formatServices:formatTime4_4
wm.b2b.edi.util.formatServices:formatTime4_6
wm.b2b.edi.util.formatServices:formatTime4_8
wm.b2b.edi.util.formatServices:formatTime6_6
Part II WmEDIforTN Package
WmEDIforTN VANConnectivity Folder
Summary of Elements in this Folder
VAN.VANConnectivity:FTPConnection
VAN.VANConnectivity:getFromVAN
VAN.VANConnectivity:getReportFromVAN
VAN.VANConnectivity:putToVAN
WmEDIforTN TRADACOMS Folder
Summary of Elements in this Folder
wm.b2b.edi.tradacoms.doc:getContentPart
wm.b2b.edi.tradacoms.doc:getDocumentPartInfo
wm.b2b.edi.tradacoms.doc:getDocumentStream
wm.b2b.edi.tradacoms.doc:getFFSchemaNames
wm.b2b.edi.tradacoms.doc:isFileEnvelope
wm.b2b.edi.tradacoms.ui:modifyTradacomsSchema
WmEDIforTN Core Services
Summary of Elements in this Folder
wm.b2b.editn:addAttributeTypeToBizDoc
wm.b2b.editn:bizdocToRecord
wm.b2b.editn:ediPartnerIDToTNPartnerID
wm.b2b.edi:generateX12TA1
wm.b2b.editn:getICDetail
wm.b2b.editn:getTransactionSetDetail
wm.b2b.editn:getTspace
wm.b2b.editn:trackEDIdocs
wm.b2b.editn:validateEnvelope
wm.b2b.editn:validateTransaction
wm.b2b.editn:wrapData
WmEDIforTN Batch Folder
Summary of Elements in this Folder
wm.b2b.editn.batch:batchProcess
wm.b2b.editn.batch:getControlNumber
WmEDIforTN CrossRef Folder
Summary of Elements in this Folder
wm.b2b.editn.crossRef:deleteEnvInfo
wm.b2b.editn.crossRef:getEnvInfo
WmEDIforTN Db Folder
Summary of Elements in this Folder
wm.b2b.editn.db:deleteControlNumber
wm.b2b.editn.db:deleteFAInfo
WmEDIforTN Doc Folder
Summary of Elements in this Folder
wm.b2b.editn.doc:listTransactionTypes
wm.b2b.editn.doc:saveQuery
WmEDIforTN FAReport Folder
Summary of Elements in this Folder
wm.b2b.editn.FAReport:generateFAReport
WmEDIforTN Migration Services
Summary of Elements in this Folder
wm.b2b.editn.migration:updateBizDocs
WmEDIforTN Rec Folder
Summary of Elements in this Folder
wm.b2b.editn.rec:batchFailRecord
WmEDIforTN TPA Folder
Summary of Elements in this Folder
wm.b2b.editn.TPA:getEDITPAData
WmEDIforTN Util Folder
Summary of Elements in this Folder
wm.b2b.editn.util:getContentPartDataAsInputStream
wm.b2b.editn.util.reprocess:listInSequenceDoc
wm.b2b.editn.util.reprocess:listUnprocessDoc
wm.b2b.editn.util.reprocess:nextInSequenceDoc
wm.b2b.editn.util.reprocess:reprocessDocument
wm.b2b.editn.util.reprocess:validateControlNumber
wm.b2b.edi.util:updateVDAEnvelope
wm.b2b.editn.util.VersionSupport:addNewEDIVersion
Copyright
Understanding and Using EDI Module
Copyright