webMethods Module for EDI

Installation and User’s Guide

Version 9.12

September 2017
This document applies to webMethods Module for EDI Version 9.12 and to all subsequent releases.
Specifications contained herein are subject to change and these changes will be reported in subsequent release notes or new editions.
Copyright © 2000-2017 Software AG, Darmstadt, Germany and/or Software AG USA Inc., Reston, VA, USA, and/or its subsidiaries and/or
its affiliates and/or their licensors.
The name Software AG and all Software AG product names are either trademarks or registered trademarks of Software AG and/or
Software AG USA Inc. and/or its subsidiaries and/or its affiliates and/or their licensors. Other company and product names mentioned
herein may be trademarks of their respective owners.
Detailed information on trademarks and patents owned by Software AG and/or its subsidiaries is located at
hp://softwareag.com/licenses.
Use of this software is subject to adherence to Software AG's licensing conditions and terms. These terms are part of the product
documentation, located at hp://softwareag.com/licenses and/or in the root installation directory of the licensed product(s).
This software may include portions of third-party products. For third-party copyright notices, license terms, additional rights or
restrictions, please refer to "License Texts, Copyright Notices and Disclaimers of Third Party Products". For certain specific third-party
license restrictions, please refer to section E of the Legal Notices available under "License Terms and Conditions for Use of Software AG
Products / Copyright and Trademark Notices of Software AG Products". These documents are part of the product documentation, located
at hp://softwareag.com/licenses and/or in the root installation directory of the licensed product(s).

Document ID: ESTD-EDI-IUG-912-20170914

 M
Table of Contents

Table of Contents

About this Guide............................................................................................................................13

Document Conventions............................................................................................................ 13
Online Information.................................................................................................................... 14

Installing, Upgrading, and Uninstalling webMethods Module for EDI......................................15

Overview................................................................................................................................... 16
Requirements............................................................................................................................16
Installing Module for EDI.......................................................................................................... 16
Upgrading the Module for EDI from 9.0 to 9.12.......................................................................21
Uninstalling Module for EDI......................................................................................................22
Before You Begin.............................................................................................................. 22
Uninstalling Module 9.12 for EDI...................................................................................... 22

Configuring webMethods Module for EDI...................................................................................23

Overview................................................................................................................................... 24
Assigning User-Specific Permissions in My webMethods........................................................25
Defining Module for EDI Properties..........................................................................................26
Setting Up Items Required for Structural Validation and Conversion.......................................32
Configuring Format Services to Convert Field Values...................................................... 32
Associating the EDI Format Services with EDI Data Types..............................................35
Creating Flat File Schemas for Internal-Format Documents.............................................36
Defining TN EDI Document Types........................................................................................... 37
Step 1: Define Document Type Information......................................................................38
Defining Document Type Information Using My webMethods................................... 38
Step 2: Define Attributes to be Extracted from Documents.............................................. 39
Attributes Stored for TRADACOMS Document Types............................................... 41
Extracting a Document Attribute Using an XQL Query..............................................42
Examples of Extracting a Document Attribute Using an XQL Query.................. 42
Step 3: Define Processing Options................................................................................... 42
Creating a TN EDI Document Type Based on a Transaction.................................................. 44
Flat File Schema Namespace Conventions............................................................................. 44
Flat File Schema Namespace Conventions for Non-TRADACOMS Standards................ 44
Flat File Schema Namespace Conventions When Using TRADACOMS..........................45
Managing TN EDI Document Types.........................................................................................45
Viewing the Code List Details........................................................................................... 46
Viewing Alternate Name and Description of Segments.................................................... 46
Updating TN EDI Document Types...................................................................................46
Updating the Description or Status of a TN EDI Document Type..................................... 47
Updating the Processing Options Specified in the Document Type..................................47
Updating a TN EDI Document Type Based on a Transaction...........................................48
Managing Document Attributes................................................................................................ 48

webMethods Module for EDI Installation and User’s Guide Version 9.12 3
 M
Table of Contents

Adding a Document Attribute............................................................................................ 49

Editing a Document Attribute............................................................................................ 49
Deleting a Document Attribute.......................................................................................... 49
Overwriting Document Attributes Extracted from Inbound Documents.................................... 49
EDI Transaction................................................................................................................. 50
TA1 Transaction.................................................................................................................51
FA Transaction...................................................................................................................52
Adding New Versions of EDI Standards.................................................................................. 53

Defining Trading Partner Information..........................................................................................57

Overview................................................................................................................................... 58
Partner Information You Need to Define........................................................................... 58
Defining Trading Partner Profiles............................................................................................. 59
Adding External ID Types for EDI ID Qualifiers................................................................ 60
Adding and Overriding EDI ID Qualifiers................................................................... 61
Defining EDI Trading Partner Agreements...............................................................................61
Modifying the Default EDITPA...........................................................................................62
Defining a Partner-Specific EDITPA..................................................................................63
wm.b2b.editn.TPA:EDITPA IS Document Type................................................................. 65
GSRouting Variables.................................................................................................. 67
PersistMultipleDocEnvelope Variable.........................................................................69
processingMode Variable........................................................................................... 70
splitOption Variable.....................................................................................................71
FAReconciliation Variable...........................................................................................72
UNAmode Variable..................................................................................................... 74
publishBatchFailEvent Variable.................................................................................. 74
delimiters Variables.................................................................................................... 75
envelopeIdentifier Variables....................................................................................... 76
ICheaderInfo Variables............................................................................................... 77
FAGeneration Variables..............................................................................................80
ControlNumberManagement Variables.......................................................................88
useReverseRoute Variable.........................................................................................92
BatchCriteria Variables............................................................................................... 93
EDITransportMedia Variable.......................................................................................95
persistOriginalEnvelope Variable................................................................................96
documentPersistOrder Variable..................................................................................97
LateFA Variables........................................................................................................ 98
X12TA1Generation Variables................................................................................... 100
EANCOMAUTACK Variables....................................................................................101

Defining Trading Partner Information When Using TRADACOMS..........................................105

Overview................................................................................................................................. 106
Partner Information You Need to Define When Using TRADACOMS............................. 106
Defining Trading Partner Profiles When Using TRADACOMS...............................................107
External ID Types When Using TRADACOMS............................................................... 107
Optionally Configuring the External ID Types When Using TRADACOMS.............. 109

webMethods Module for EDI Installation and User’s Guide Version 9.12 4
 M
Table of Contents

Defining EDI Trading Partner Agreements When Using TRADACOMS.................................109

Modifying the Default EDITPA When Using TRADACOMS............................................ 110
Defining a Partner-Specific EDITPA When Using TRADACOMS................................... 110
wm.b2b.editn.TPA:EDITPA IS Document Type When Using TRADACOMS...................112
TRADACOM Variables............................................................................................. 112
Storage Options for File Document Types......................................................................118
Errors that Prevent the Splitting of Transmissions..........................................................120
Validation Errors....................................................................................................... 120
Invalid File Structure................................................................................................ 121

Defining Control Number Information for Trading Partners....................................................123

Overview................................................................................................................................. 124
Managing Control Number Information.................................................................................. 124
Defining How Module for EDI Creates the Control Number Sequence...........................126
Adding Entries to the EDIControlNumber Table..............................................................126
Configuring Control Number Settings..............................................................................126
Configuring Control Number Settings Using the My webMethods Control Numbers
Page......................................................................................................................... 128
Configuring Control Number Settings Using the My webMethods Partner Profiles
Page......................................................................................................................... 132
Updating Control Number Settings................................................................................. 132
Turning Inbound Control Number Validation On and Off........................................................132
Activating Validation for ANSI X12 or UN/EDIFACT Documents.................................... 133
Activating Validation for VDA Documents....................................................................... 133
Activating Validation for TRADACOMS Documents........................................................134
Defining Control Number Information for Processing Documents..........................................135
Defining Control Number Information for Processing Inbound Documents.....................135
Defining Control Number Information for Processing Outbound Documents.................. 136
Defining Actions Module for EDI Can Take for Invalid Control Numbers............................... 136
Defining How to Handle Invalid Control Numbers for ANSI X12 or UN/EDIFACT
Documents.......................................................................................................................136
Defining How to Handle Invalid Control Numbers for VDA Documents.......................... 137
Defining How to Handle Invalid Control Numbers for TRADACOMS Documents........... 138
Searching for Existing Control Number Settings....................................................................138
Searching for Existing Control Number Settings Using My webMethods........................139

Creating Clients that Send EDI Documents to Integration Server..........................................143

Overview................................................................................................................................. 144
Defining the Content Type to Use..........................................................................................144
Before Creating the Service to Form an EDI Document........................................................144
Creating the Service the Client Invokes to Handle EDI Documents...................................... 145
Logic to Include in the Service to Form an EDI Document.............................................145
Validating the Input Internal-Format Document When It Is an IData Object....................148
Adding UN/EDIFACT Envelopes..................................................................................... 148
Validating the EDI Document Envelope................................................................... 149
Sending EDI Documents to Integration Server via HTTP...................................................... 149

webMethods Module for EDI Installation and User’s Guide Version 9.12 5
 M
Table of Contents

Identifying the Service to Invoke.....................................................................................149

Logic to Include in the HTTP Client................................................................................149
Example of Input Parameters for the pub.client:http Service...................................150
Sending EDI Documents to Integration Server via FTP.........................................................151
Identifying the Service to Invoke.....................................................................................151
Logic to Include in the FTP Client.................................................................................. 151
Example of Input Parameters for the pub.client:ftp Service.....................................152
Sending EDI Documents to Integration Server via File Polling.............................................. 153
Setting Up File Polling.....................................................................................................153
Identifying the Service to Invoke.....................................................................................154

Creating Clients that Send EDI Documents to Trading Networks.......................................... 155

Overview................................................................................................................................. 156
Content Type to Use.............................................................................................................. 156
Content Type for EDI Documents that Do Not Contain Mainframe Data........................ 156
Content Types for EDI Documents that Contain Mainframe Data...................................157
Service the Client Invokes......................................................................................................157
Sending EDI Documents to Trading Networks via HTTP/S................................................... 158
Example of Input Parameters for the pub.client:http Service.......................................... 158
Sending EDI Documents to Trading Networks via FTP......................................................... 159
Example of Input Parameters for the pub.client:ftp Service............................................159
Sending EDI Documents to Trading Networks via File Polling.............................................. 160
Sending EDI Documents to Trading Networks via My webMethods...................................... 161
Using a Service to Send Multiple EDI Documents to Trading Networks................................ 161

Handling Large Documents When Using Trading Networks...................................................163

Overview................................................................................................................................. 164
Configuring Module for EDI for Large Document Handling....................................................164
Determining When an EDI Document Is Large...............................................................165
Converting Large Documents to IData Objects Iteratively..................................................... 166
Troubleshooting Memory Constraint Problems...................................................................... 166

Generating Acknowledgments................................................................................................... 169

Overview................................................................................................................................. 170
Generating Functional Acknowledgments.............................................................................. 170
Before You Can Generate a Functional Acknowledgment..................................................... 172
Configuring the Maximum Number of Transaction Errors............................................... 172
Determining How Module for EDI Reports FA Status............................................................ 173
Determining If the Child Transaction is Allowed in Its Envelope..................................... 174
Determining If a Transaction Is an FA or If a Group Contains an FA..............................175
syntaxErrorStatus Parameter.......................................................................................... 175
logicalErrorStatus Parameter...........................................................................................176
childTransactionRejectedStatus Parameter.....................................................................176
How Module for EDI Determines Which FA Status to Use............................................. 178
Transaction FA Status.............................................................................................. 178
Group FA Status.......................................................................................................179

webMethods Module for EDI Installation and User’s Guide Version 9.12 6
 M
Table of Contents

UN/EDIFACT Interchange FA Status....................................................................... 180

When to Invoke the generateFA Service............................................................................... 180
Using a Service that Processes Documents at One Time.............................................. 181
Invoking generateFA Before Invoking envelopeProcess..........................................181
Invoking generateFA Immediately after Invoking envelopeProcess.........................182
Using a Service that Processes Documents Iteratively...................................................182
Output from the generateFA Service......................................................................................183
Tracking Late Functional Acknowledgments.......................................................................... 185
Before Tracking Late FAs................................................................................................185
Tracking Late FAs........................................................................................................... 186
Example........................................................................................................................... 186
Generating Interchange Acknowledgments............................................................................187

Before Creating the Service to Process EDI Documents........................................................ 191

Overview................................................................................................................................. 192
Inputs to Your Service............................................................................................................ 192
Logic to Include in the Service to Process EDI Documents...................................................193
Determining Which Process Method to Use................................................................... 193
Processing the Entire Document at One Time................................................................194
Performing Envelope Validation and Compliance Checks....................................... 198
Processing the Document Iteratively, Segment by Segment.......................................... 199
Customizing the EDI Flat File Schema....................................................................199
Logic for the Service to Process the Document Iteratively...................................... 202
Samples.................................................................................................................................. 205

Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks.....207

Overview................................................................................................................................. 208
Preparing to Receive EDI Documents................................................................................... 209
Specifying EDITPA Variables that Affect Inbound Processing............................................... 210
Validating the EDIFACT Document Schema...................................................................210
Validating VDA Message Structure................................................................................. 211
Trading Networks Attributes and EDI Documents..................................................................211
System Attributes that Module for EDI Sets................................................................... 212
DocumentID..............................................................................................................212
GroupID.................................................................................................................... 213
ConversationID......................................................................................................... 213
Enabling Extraction of ConversationIDs from an EDI Document...................... 213
Disabling Extraction of ConversationIDs from EDI Documents.........................214
Custom Attributes that Module for EDI Sets................................................................... 214
EDI Group Type....................................................................................................... 215
EDI Outbound FA..................................................................................................... 215
EDI Processing Mode.............................................................................................. 215
EDI Status................................................................................................................ 215
EDI Version.............................................................................................................. 216
Envelope CntrlNum Status and Group CntrlNum Status......................................... 216
EDI FA Status...........................................................................................................217

webMethods Module for EDI Installation and User’s Guide Version 9.12 7
 M
Table of Contents

TA1 Status and TA1 Code....................................................................................... 218

Managing Custom Attributes for EDI Documents........................................................... 221
Setting the Attribute Values at Run Time.................................................................221
Defining a Processing Rule that Uses Your Custom Attribute as Criteria................ 222
Defining Processing Rules to Process Inbound EDI Documents........................................... 222
Specifying Processing Rule Criteria................................................................................223
Specifying Preprocessing Actions................................................................................... 225
Specifying Processing Actions........................................................................................ 225
Coding Services to Process Transaction and Group Documents.......................................... 226
Information in the Pipeline that Your Service Can Access..............................................228
Logic to Process a Transaction Document..................................................................... 230
Logic to Process a Group Document when splitOption is Group....................................232

Processing Inbound TRADACOMS Documents Using Trading Networks............................. 237

Overview................................................................................................................................. 238
Before Setting Up Processing of Inbound EDI Documents When Using TRADACOMS........ 239
Specifying EDITPA Variables that Affect Inbound Processing When Using TRADACOMS....240
Trading Networks Attributes and EDI Documents When Using TRADACOMS......................240
System Attributes that Module for EDI Sets When Using TRADACOMS........................241
DocumentID..............................................................................................................241
GroupID.................................................................................................................... 241
Custom Attributes that Module for EDI Sets When Using TRADACOMS....................... 242
Managing Your Own Custom Attributes for EDI Documents When Using
TRADACOMS.................................................................................................................. 243
Setting Attribute Values at Run Time When Using TRADACOMS...........................244
Defining a Processing Rule that Uses Your Custom Attribute as Criteria When Using
TRADACOMS...........................................................................................................245
Defining Processing Rules to Process Inbound EDI Documents When Using
TRADACOMS......................................................................................................................... 245
Specifying Processing Rule Criteria When Using TRADACOMS....................................246
Specifying Preprocessing Actions When Using TRADACOMS.......................................247
Specifying Processing Actions When Using TRADACOMS............................................248
Coding Services to Process File and Batch Documents When Using TRADACOMS............ 249
Information in the Pipeline that Your Service Can Access When Using TRADACOMS...250
Logic to Process a File Document..................................................................................252
Logic to Map a File Document to an Internal-Format Document.................................... 254

Optional Inbound Processing When Using Trading Networks................................................257

Overview................................................................................................................................. 258
Validating Inbound Control Numbers......................................................................................258
Valid Control Numbers.................................................................................................... 258
Invalid Control Numbers..................................................................................................259
Duplicate Control Numbers...................................................................................... 259
Out-of-Sequence Control Numbers..........................................................................260
Performing Control Number Validation............................................................................261
Actions Module for EDI Can Take for Invalid Control Numbers...................................... 262

webMethods Module for EDI Installation and User’s Guide Version 9.12 8
 M
Table of Contents

Error & Continue...................................................................................................... 263

Process Normally..................................................................................................... 263
Reject........................................................................................................................263
Defining Processing Rules to Handle Documents with Invalid Control Numbers................... 265
Setting the EDI Status Custom Attribute for Control Number Validation......................... 265
Defining the Processing Rule to Handle Documents with Invalid Control Numbers........ 266
Reprocessing EDI Documents with Invalid Control Numbers................................................ 268
Reprocessing Documents with Duplicate Control Numbers............................................268
Reprocessing Documents with Out-of-Sequence Control Numbers............................... 269
Creating a Service to Reprocess Documents with Out-of-Sequence Control
Numbers................................................................................................................... 270
Automatically Generating Functional Acknowledgments........................................................275
Turning Automatic FA Generation On and Off................................................................ 277
Determining How Module for EDI Reports FA Status..................................................... 277
Defining FA Statuses as Acceptable and Unacceptable.................................................277
Defining Actions Module for EDI Takes Based on FA Status..........................................279
Processing Documents with Acceptable FA Statuses..............................................279
Processing Documents with Unacceptable FA Statuses......................................... 280
Defining a Processing Rule to Deliver FAs.....................................................................281
Defining Processing Rules for Documents with Unacceptable FA Statuses................... 282
Automatically Generating Interchange Acknowledgments..................................................... 284
Performing Optional Processing of Inbound EDI Documents................................................ 284

Forming EDI Documents to Send Outbound When Using Trading Networks........................289

Overview................................................................................................................................. 290
Preparing Trading Networks to Process Internal-Format Documents.................................... 290
Creating the Service to Form the EDI Document.................................................................. 291
Before Creating the Service to Form an EDI Document.................................................292
Creating the Service........................................................................................................293
Obtaining Control Numbers for Outbound Processing (ANSI X12 and UN/
EDIFACT)..................................................................................................................296
Adding TRADACOMS Envelopes and Obtaining Control Numbers.........................297
Delivering the Outbound EDI Document................................................................................ 297
Delivering the EDI Document Directly from the Service that Forms It............................ 298
Submitting the EDI Document to Trading Networks........................................................298
Specifying Variables that Affect Outbound Processing............................................ 299
Specifying Variables that Affect Outbound Processing When Using
TRADACOMS...........................................................................................................300
Preparing Trading Networks to Deliver the EDI Document......................................300
Adding Logic to the Service that Forms the EDI Document to Submit to Trading
Networks...................................................................................................................302
Preparing the Pipeline to Invoke the wm.tn.doc.xml:routeXML Service............ 302
Routing the Outbound EDI Document to Trading Networks........................................... 304
Adding Logic to the Service that Forms the EDI Document that Routes through
Trading Networks..................................................................................................... 305
Creating a BizDocEnvelope for the Outbound EDI Document.................................305

webMethods Module for EDI Installation and User’s Guide Version 9.12 9
 M
Table of Contents

Batching EDI Documents............................................................................................................311

Overview................................................................................................................................. 312
Indicating How Many Batch EDI Documents to Create......................................................... 312
How Documents Are Combined to Create the Batch EDI Document.....................................313
Extracting Transactions and Sorting the Batched Documents............................................... 313
Sorting Transactions in the Queued Documents............................................................ 314
Collection Areas Representing an Interchange in the Final Batch EDI Document... 314
Subcollections Representing a Group in the Final Batch EDI Document.................314
Delimiters Associated with Collection Areas............................................................315
Example of Sorting Documents............................................................................... 315
When EDI Documents Have No Interchange or Transmission Header...........................316
Sorting Transactions when Queued Documents Have No Interchange Headers.....317
Default Collection Area (Interchange in the Final Batch EDI Document).......... 317
Subcollections when there Are No Headers (Groups in the Final Batch EDI
Document)......................................................................................................... 318
Delimiters Associated with the Default Collection Area.................................... 318
Delimiters Used for the Batch EDI Document.................................................................319
Updating the Task Status and Publishing Documents for Failed Tasks.......................... 320
Recombining the Transactions into the Batch EDI Document............................................... 321
Creating the Batch EDI Document when Using SINGLEOUTPUT................................. 322
Creating the Batch EDI Document when Using MULTIPLEOUTPUTS........................... 324
Before You Can Batch EDI Documents................................................................................. 326
Controlling How the batchProcess Service Forms the Batch Document................................327
EDITPA Variables that the batchProcess Service Uses..................................................328
EDITPA Variables Used when Sorting Transactions................................................328
EDITPA Variables Used when Recombining Transactions...................................... 328
Preparing to Batch EDI Documents....................................................................................... 329
Determining the Number of Queues You Need to Define............................................... 329
Defining the Scheduled Delivery Queues....................................................................... 330
Defining Processing Rules to Batch EDI Documents..................................................... 331
Delivering the Batch EDI Document.......................................................................................331
Viewing Batched EDI Documents.......................................................................................... 333

Retrieving and Delivering EDI Documents from and to VANs................................................ 335

Overview................................................................................................................................. 336
Preparing to Retrieve Documents from a VAN...................................................................... 336
Preparing to Deliver Documents to VANs.............................................................................. 337
Defining the Scheduled Delivery Queue......................................................................... 337
Defining a Processing Rule to Place Documents in the Queue......................................339
Handling Conventions Required by Specific VANs................................................................ 339
Customizing Built-In Services to Connect to Another VAN.................................................... 340

Reconciling Functional Acknowledgments...............................................................................341

Overview................................................................................................................................. 342
FA Reconciliation.............................................................................................................342

webMethods Module for EDI Installation and User’s Guide Version 9.12 10
 M
Table of Contents

Turning FA Reconciliation On or Off...................................................................................... 343

Information Module for EDI Records to Reconcile FAs..........................................................343
FA Statuses..................................................................................................................... 345
Controlling FA Status for Documents Submitted Multiple Times..............................346
Setting FA Status Manually......................................................................................347

Viewing Log Information for EDI Documents........................................................................... 349

Overview................................................................................................................................. 350
Viewing the Server Log.......................................................................................................... 350
Viewing the Trading Networks Activity Log............................................................................ 350

Viewing Information about EDI Documents..............................................................................353

Overview................................................................................................................................. 354
EDI Documents You Can View.............................................................................................. 354
Viewing EDI Documents.........................................................................................................355
Trading Networks Processing Status and EDI Documents............................................. 356
Viewing Information about EDI Documents in Queues.......................................................... 357
Viewing Related Documents with Relationship Labels.......................................................... 358

Including Documents in a Business Process...........................................................................361

Overview................................................................................................................................. 362
Designing the Process Model.................................................................................................362
Sample Process Models for ANSI X12........................................................................... 363
Sample Process Models for UN/EDIFACT......................................................................365
Assigning Conversation IDs to EDI Documents.....................................................................367
Instance IDs for Interchange, Group, and Transaction Documents................................ 368
Instance IDs for Functional Acknowledgments............................................................... 369
Sample Business Process......................................................................................................369
Monitoring Your Business Processes..................................................................................... 370

Non-Standard Processing........................................................................................................... 371

Overview................................................................................................................................. 372
Defining Partner Information When Using Non-Standard Processing....................................372
Defining Trading Networks Profiles When Using Non-Standard Processing...................373
Defining a Partner-Specific EDITPA When Using Non-Standard Processing..................374
wm.b2b.editn.TPA:EDITPA IS Document Type When Using Non-Standard
Processing................................................................................................................ 374
Defining Interchange-Level Sender/Receiver Pair Information....................................... 376
Editing and Deleting Interchange-Level Sender/Receiver Pair Information..............387
Defining Group-Level Sender/Receiver Pair Associations.............................................. 388
Querying for Group-Level Sender/Receiver Pair Associations................................ 392
Defining Control Number Information for Partners When Using Non-Standard Processing... 392
Turning Inbound Control Number Validation On or Off When Using Non-Standard
Processing....................................................................................................................... 393
Defining Actions for Invalid Control Numbers................................................................. 393
Defining the Control Number Settings............................................................................ 394

webMethods Module for EDI Installation and User’s Guide Version 9.12 11
 M
Table of Contents

Processing Inbound EDI Documents using Trading Networks and Non-Standard

Processing.............................................................................................................................. 395
Before You Can Process Inbound EDI Documents.........................................................395
Variables that Affect Inbound Processing....................................................................... 395
Forming EDI Documents to Send Outbound When Using Trading Networks and Non-Standard
Processing.............................................................................................................................. 397
Before Creating the Service to Form an EDI Document.................................................397
Creating the Service When Using Non-Standard Processing......................................... 397

Using Module for EDI Decoupled from Trading Networks...................................................... 399

Overview................................................................................................................................. 400
Using Only the WmEDI Package with Integration Server............................................... 400
Configuring Module for EDI Decoupled from Trading Networks............................................ 401
Preparing Module for EDI Decoupled from Trading Networks............................................... 402
Creating Flat File Schemas for EDI Documents.................................................................... 403
Creating a Flat File Schema from a SEF File.................................................................404
Creating a Flat File Schema from an IDOC....................................................................405
Forming EDI Documents and Sending Them Outbound........................................................406
Validating the Input Internal-Format Document When It Is an IData Object....................406
Adding UN/EDIFACT Envelopes..................................................................................... 407
Checking Your Work........................................................................................................407
Example.................................................................................................................................. 407

Index.............................................................................................................................................. 409

webMethods Module for EDI Installation and User’s Guide Version 9.12 12
 M
Odd Header

About this Guide

This guide describes how to use webMethods Module for EDI to process EDI
documents, including:
How to install and configure Module for EDI and install webMethods Trading
Networks document types
Define processing rules
Create services to process inbound and outbound EDI documents
For an overview of Module for EDI features, see webMethods Module for EDI Concepts
Guide.

Document Conventions

Convention Description

Bold Identifies elements on a screen.

Narrowfont Identifies storage locations for services on webMethods

Integration Server, using the convention folder.subfolder:service .

UPPERCASE Identifies keyboard keys. Keys you must press simultaneously

are joined with a plus sign (+).

Italic Identifies variables for which you must supply values specific to
your own situation or environment. Identifies new terms the first
time they occur in the text.

Monospace Identifies text you must type or messages displayed by the

font system.

{} Indicates a set of choices from which you must choose one. Type
only the information inside the curly braces. Do not type the { }
symbols.

| Separates two mutually exclusive choices in a syntax line. Type

one of these choices. Do not type the | symbol.

webMethods Module for EDI Installation and User’s Guide Version 9.12 13
 M
Even Header

Convention Description

[] Indicates one or more options. Type only the information inside

the square brackets. Do not type the [ ] symbols.

... Indicates that you can type multiple options of the same type.
Type only the information. Do not type the ellipsis (...).

Online Information
Software AG Documentation Website
You can find documentation on the Software AG Documentation website at hp://
documentation.softwareag.com. The site requires Empower credentials. If you do not
have Empower credentials, you must use the TECHcommunity website.

Software AG Empower Product Support Website

You can find product information on the Software AG Empower Product Support
website at hps://empower.softwareag.com.
To submit feature/enhancement requests, get information about product availability,
and download products, go to Products.
To get information about fixes and to read early warnings, technical papers, and
knowledge base articles, go to the Knowledge Center.

Software AG TECHcommunity
You can find documentation and other technical information on the Software AG
TECHcommunity website at hp://techcommunity.softwareag.com. You can:
Access product documentation, if you have TECHcommunity credentials. If you do
not, you will need to register and specify "Documentation" as an area of interest.
Access articles, code samples, demos, and tutorials.
Use the online discussion forums, moderated by Software AG professionals, to
ask questions, discuss best practices, and learn how other customers are using
Software AG technology.
Link to external websites that discuss open standards and web technology.

webMethods Module for EDI Installation and User’s Guide Version 9.12 14
 M
Odd Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

1   Installing, Upgrading, and Uninstalling webMethods

Module for EDI

■ Overview ....................................................................................................................................... 16
■ Requirements ............................................................................................................................... 16
■ Installing Module for EDI ............................................................................................................. 16
■ Upgrading the Module for EDI from 9.0 to 9.12 .......................................................................... 21
■ Uninstalling Module for EDI ......................................................................................................... 22

webMethods Module for EDI Installation and User’s Guide Version 9.12 15
 M
Even Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

Overview
This chapter explains how to install, upgrade, and uninstall webMethods Module for
EDI. The instructions use the Software AG Installer and the Software AG Uninstaller
wizards. For complete information about the wizards or other installation methods, or
to install other webMethods products, see the Installing webMethods Products for your
release.

Requirements
For a list of the operating systems and webMethods products that Module 9.12 for
EDI supports, see webMethods eStandards Modules System Requirements, available in the
webMethods area of the Software AG Documentation website.

Installing Module for EDI

Note: Module for EDI stores data in Trading Networks tables. If you are installing
the module in a clustered environment, you must install Module for EDI
and Trading Networks on each Integration Server in the cluster, and
each installation must be identical. For information on running Trading
Networks in a clustered environment, see the webMethods Trading Networks
Administrator’s Guide for your release.

To install Module for EDI

1. If you are installing Module for EDI on an already installed Integration Server, shut
down Integration Server.
2. Download Software AG Installer from the Empower Product Support website at
hps://empower.softwareag.com.
3. Start the Software AG Installer wizard.
4. Choose the supported webMethods version that corresponds to Integration Server
that you are installing. Click Next.
5. Specify the installation directory as follows:
If you are installing Module for EDI on an existing Integration Server, specify the
Software AG installation directory that contains the host Integration Server.
If you are installing both the host Integration Server and Module for EDI for the
first time, specify the installation directory to use. (The default is SoftwareAG.)

webMethods Module for EDI Installation and User’s Guide Version 9.12 16
 M
Odd Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

6. In the product selection list, navigate to eStandards > webMethods Module 9.12 for EDI.
Install any other required products as indicated in webMethods eStandards Modules
System Requirements .
Software AG Installer installs the following packages in the
Integration Server_directory\instances\$instance_name \packages directory:

Note: If you select the top level check box for a schema package, then all the
versions for that package are selected automatically. If you don't want to
install all the versions for a schema package, then deselect the top level
check box, and select individual versions for a package or individual
packages instead.

Note: Starting with webMethods Module for EDI 9.12, XML schemas are
introduced for use with XML based document types. XML schemas
provide the following advantages:
View the code list details of a segment for a document type.
View the alternate name and description of a segment for an XML
schema.

Installer Options Packages Versions

Program WmEDI
Files
WmEDIforTN

Schema EANCOM WmEDI_EANCOM 01B, 1, 2, 3,

93A, and 96A

ODETTE WmEDI_ODETTE 3 and 94

TRADACOMS WmEDI_TRADACOMS 2, 3, 4, 5, 6, 8,
and 9

UCS WmEDI_UCS 4010, 4020,

4030, and 5010

UNEDIFACT > WmEDI_UNEDIFACT_1990 901 and 902

Release 1990

UNEDIFACT > WmEDI_UNEDIFACT_1991 911 and 912

Release 1991

webMethods Module for EDI Installation and User’s Guide Version 9.12 17
 M
Even Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

Installer Options Packages Versions

UNEDIFACT > WmEDI_UNEDIFACT_1992 921

Release 1992

UNEDIFACT > WmEDI_UNEDIFACT_1993 93A, 2932, and

Release 1993 S93A

UNEDIFACT > WmEDI_UNEDIFACT_1994 94A and 94B

Release 1994

UNEDIFACT > WmEDI_UNEDIFACT_1995 95A and 95B

Release 1995

UNEDIFACT > WmEDI_UNEDIFACT_1996 96A and 96B

Release 1996

UNEDIFACT > WmEDI_UNEDIFACT_1997 97A and 97B

Release 1997

UNEDIFACT > WmEDI_UNEDIFACT_1998 98A and 98B

Release 1998

UNEDIFACT > WmEDI_UNEDIFACT_1999 99A and 99B

Release 1999

UNEDIFACT > WmEDI_UNEDIFACT_2000 00A and 00B

Release 2000

UNEDIFACT > WmEDI_UNEDIFACT_2001 01A, O1B, and

Release 2001 01C

UNEDIFACT > WmEDI_UNEDIFACT_2002 02A and 02B

Release 2002

UNEDIFACT > WmEDI_UNEDIFACT_2003 03A and 03B

Release 2003

UNEDIFACT > WmEDI_UNEDIFACT_2004 04A and 04B

Release 2004

UNEDIFACT > WmEDI_UNEDIFACT_2005 05A and 05B

Release 2005

webMethods Module for EDI Installation and User’s Guide Version 9.12 18
 M
Odd Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

Installer Options Packages Versions

UNEDIFACT > WmEDI_UNEDIFACT_2006 06A and 06B

Release 2006

UNEDIFACT > WmEDI_UNEDIFACT_2007 07A and 07B

Release 2007

UNEDIFACT > WmEDI_UNEDIFACT_2008 08A and 08B

Release 2008

UNEDIFACT > WmEDI_UNEDIFACT_2009 09A and 09B

Release 2009

UNEDIFACT > WmEDI_UNEDIFACT_2010 10A and 10B

Release 2010

UNEDIFACT > WmEDI_UNEDIFACT_2011 11A and 11B

Release 2011

UNEDIFACT > WmEDI_UNEDIFACT_2013 13A and 13B

Release 2013

UNEDIFACT > WmEDI_UNEDIFACT_2014 14A and 14B

Release 2014

UNEDIFACT > WmEDI_UNEDIFACT_2016 16A and 16B

Release 2016

UNEDIFACT > WmEDI_UNEDIFACT_Misc 2, 3, 40, and 41

Miscellaneous

VDA WmEDI_VDA 4905_4,

4906_2,
4907_2,
4908_3,
4911_1,
4913_4,
4913_5,
4915_2,
4916_1,
4918_1,
4919_1,
4920_1,

webMethods Module for EDI Installation and User’s Guide Version 9.12 19
 M
Even Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

Installer Options Packages Versions

4921_1, and
4927_3

VICS WmEDI_VICS 3010, 4010,

4020, 4030,
4050, and 5010

X12 > Version WmEDI_X12_20xx 2000, 2001,

20xx 2001FORD,
2002,
2002FORD,
2003, 2003GM,
2040, and
2040CHRY

X12 > Version WmEDI_X12_30xx 3010, 3020,

30xx 3030, 3040,
3041, 3050,
3051, 3060,
and 3070

X12 > Version WmEDI_X12_40xx 4010,

40xx 4010RIFMAT,
4020, 4030,
4040, 4050,
and 4060

X12 > Version WmEDI_X12_50xx 5010, 5020,

50xx 5030, 5040,
and 5050

X12 > Version WmEDI_X12_60xx 6010, 6020,

60xx 6040, and 6050

X12 > Version WmEDI_X12_70xx 7010 and 7030

70xx

Note: Module for EDI uses the Trading Networks JDBC pool associated with
Integration Server. The module database scripts are installed as part of
the Trading Networks script installation using the Database Component
Configurator. For more information about Trading Networks script
installation, see the Installing webMethods Products for your release.

7. After Installer completes the installation, close the wizard.

webMethods Module for EDI Installation and User’s Guide Version 9.12 20
 M
Odd Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

8. Start the host Integration Server.

Upgrading the Module for EDI from 9.0 to 9.12

Upgrade the module from 9.0 to 9.12 by installing Module 9.12 for EDI in a separate
installation directory, editing the properties in the config files, and migrating the data
from webMethods Trading Networks.

Important: Module 9.12 for EDI requires the supported Trading Networks version. You
must upgrade all your webMethods products at the same time. For more
information about upgrading your webMethods products, see the Upgrading
Software AG Products for your release.

To upgrade the module from 9.0 to 9.12

1. Shut down all webMethods products and all other applications that are running on
the machine on which you want to install Module 9.12 for EDI. In addition, if any
business processes are running, wait for them to complete normally or use Monitor
to stop them.

Important: If all products, applications, and business processes are not shut down,
Installer cannot replace the key files that are locked by the operating
system.

2. Back up the following 9.0 installation directories:

...\packages\WmEDI
...\packages\WmEDIforTN
3. Install Module 9.12 for EDI as described in "Installing Module for EDI " on page
16. Specify the Module 9.12 for EDI installation directory for the installation
directory.
4. Copy the ...\packages\WmEDI\config\properties.cnf file from your backup
installation to your 9.12 installation.
5. Migrate the data and TPAs from Trading Networks. For instructions about migrating
data from Trading Networks, see Upgrading Software AG Products.
6. If you modified a schema in the WmEDIforTN\ns\EDIFFSchema folder for the
WmEDIforTN package in the ...\packages\WmEDIforTN installation directory, then
copy the updated schema to the same installation directory. If you used a different
package for the flat file schemas, then copy the package to the Module for EDI 9.12
installation using the Integration Server migration utility. For more information, see
Upgrading Software AG Products.

Note: If you have not copied the schemas to the installation directory, then
perform the following actions:

webMethods Module for EDI Installation and User’s Guide Version 9.12 21
 M
Even Header
Installing, Upgrading, and Uninstalling webMethods Module for EDI

Create the flat file schemas that are used in Module for EDI 9.0 in
Module for EDI 9.12. For information about creating flat file schemas,
see "Flat File Schema Namespace Conventions" on page 44.
To use the migrated document types; open the document type in
My webMethods Server and click Save and Close. This registers the
document type with Integration Server and is ready for use.

Uninstalling Module for EDI

Before You Begin

Uninstalling Module 9.12 for EDI removes all components in the Module for EDI
packages. To keep certain records or services from the existing Module for EDI packages
on Integration Server, export them to a new package.

To export a module package or service

1. In Designer, select the package or the service you want to export.
2. Select File > Export.
If you select a package, the entire package is exported. If you select a service, only the
selected service is exported.

Uninstalling Module 9.12 for EDI

To uninstall Module for EDI
1. Shut down the Integration Server that hosts Module for EDI.
2. Start Software AG Uninstaller, selecting the Software AG installation directory that
contains the host Integration Server. In the product selection list, select eStandards
> webMethods Module 9.12 for EDI and any other products and items you want to
uninstall.
3. After Software AG Uninstaller completes, restart the host Integration Server.
4. Software AG Uninstaller removes all Module 9.12 for EDI-related files that were
installed into the Integration Server_directory \instances\$instance_name \packages
directory. However, Uninstaller does not delete files you created after you installed
the module (for example, user-created files or configuration files), nor does it delete
the module directory structure. You can navigate to the Integration Server_directory
\instances\$instance_name \packages directory and delete the WmEDI-related
directories.

webMethods Module for EDI Installation and User’s Guide Version 9.12 22
 M
Odd Header
Configuring webMethods Module for EDI

2   Configuring webMethods Module for EDI

■ Overview ....................................................................................................................................... 24
■ Assigning User-Specific Permissions in My webMethods ........................................................... 25
■ Defining Module for EDI Properties ............................................................................................. 26
■ Setting Up Items Required for Structural Validation and Conversion .......................................... 32
■ Defining TN EDI Document Types ............................................................................................... 37
■ Creating a TN EDI Document Type Based on a Transaction ...................................................... 44
■ Flat File Schema Namespace Conventions ................................................................................. 44
■ Managing TN EDI Document Types ............................................................................................ 45
■ Managing Document Attributes .................................................................................................... 48
■ Overwriting Document Attributes Extracted from Inbound Documents ........................................ 49
■ Adding New Versions of EDI Standards ...................................................................................... 53

webMethods Module for EDI Installation and User’s Guide Version 9.12 23
 M
Even Header
Configuring webMethods Module for EDI

Overview
Before you can process EDI documents using webMethods Module for EDI (Module
for EDI), you must first configure the module. The following table summarizes the
configuration tasks and where you can find more information about those tasks.

Task Where to Find More Information

Assign user-specific permissions "Assigning User-Specific Permissions

in My webMethods" on page 25

Define the Module for EDI properties "Defining Module for EDI Properties"
on page 26

Set up the items required for parsing "Seing Up Items Required for
and validating the structure of EDI Structural Validation and Conversion"
documents and converting documents on page 32
to a different format
For more information about schemas
and formaing related services,
including how to specify format
services for fields in flat file schemas
and dictionaries, see Flat File Schema
Developer’s Guide.

Define the TN EDI document types that "Defining TN EDI Document Types"
you want to process on page 37
For more information about TN
document types, profiles, and TPAs
and how Trading Networks uses them,
see the webMethods Trading Networks
Administrator’s Guide for your release.

Configure Module for EDI to support a "Adding New Versions of EDI

new version of any EDI standard Standards" on page 53

Define trading partner information "Defining Trading Partner

Information" on page 57

Define seings for inbound control "Defining Control Number

number validation Information for Trading Partners" on
page 123

webMethods Module for EDI Installation and User’s Guide Version 9.12 24
 M
Odd Header
Configuring webMethods Module for EDI

Task Where to Find More Information

Optionally, prepare to use Module webMethods Module for EDIINT

for EDIINT to transport documents Installation and User’s Guide
through EDIINT

Assigning User-Specific Permissions in My webMethods

My webMethods is a web-based administration and monitoring user interface for
managing your webMethods components. Use My webMethods to perform functions
such as managing your trading partners, configuring how documents are exchanged
through your network, and performing real-time monitoring and analysis.
The functionality available in the My webMethods user interface is based on the
permissions assigned to your My webMethods roles. For more information about using
My webMethods, see the Administering My webMethods Server for your release.
The My webMethods administrator and the system administrator can manage
permissions for users, groups, and roles in whatever combination is needed.
Functional privileges define the actions a role can perform within My webMethods.
Data-level security defines the data on which a role can act.
The following table describes the Trading Networks general functional permissions
specific to Module for EDI that you can assign to grant access to Trading Networks
functionality in My webMethods. The table lists the data governed by each general
functional permission and the actions a role can perform when assigned the permission.

Functional permission Actions a role can perform when assigned this functional
permission

Submit Documents to Use the Administration > Integration > B2B Seings >
TN Submit Documents page to submit EDI documents to
Trading Networks.

Manage EDI Control Use the Administration > Integration > B2B Seings >
Number Sequences Control Numbers page to manage (add, edit, delete)
control numbers.

To set data permissions, you must first define data sets. After defining a data set, you
then specify the roles that can act on the data in the data set. For each role, define
permissions that indicate the actions the role can perform on the data.
For more information about data permissions, general functional privileges, managing
permissions, and data and actions governed by data permissions, see the webMethods
Trading Networks Administrator’s Guide for your release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 25
 M
Even Header
Configuring webMethods Module for EDI

The following table describes the module-specific Trading Networks data permissions
that you can assign to a role.

Data permission Actions a role can perform when assigned this data permission

Edit EDI Edit the control number sequence associated with partner
Control Number profiles in the data set
Sequences
Note: You need Manage EDI Control Number Sequences
functional permission to use the Control Number tab in
the Administration > Integration > B2B > Partner Profiles
> Partner Profile page.

Edit EDI FA Edit EDI FA Status aributes of the transactions in the data
Status Aributes set

Defining Module for EDI Properties

Module for EDI properties are defined in the properties.cnf configuration file. This file
contains properties that specify how to handle large document thresholds, encoding, FA
transaction errors, related documents, control number sequence, duplicate documents,
and the extraction of conversation IDs.

To define Module for EDI properties

1. Navigate to the Integration Server_directory \instances\$instance_name \packages
\WmEDI\config folder.
2. Take a backup of the sample-properties.cnf file and rename the file to
properties.cnf.
3. Open the properties.cnf file in a text editor and set the properties as indicated in the
following table. If a property is not listed in the properties.cnf file, you can add it
manually.

Property Description

EDIBigDocThreshold Determines the size at which Module for EDI

considers a document to be large.
Possible values are:
0 or -n . Zero or any negative whole
number specifies that Module for EDI
should consider no documents as large.
The module processes all documents in the
traditional manner, reading the document

webMethods Module for EDI Installation and User’s Guide Version 9.12 26
 M
Odd Header
Configuring webMethods Module for EDI

Property Description
content into memory during processing.
The default is -1.
n . A positive whole number specifies
the number of bytes over which Module
for EDI treats a document as large. For
example, if the value is 1000000, the module
considers all documents greater than
1,000,000 bytes as large.

Note:You must specify a threshold number

that is at least three times the size of a
document. For example, if the document
size is 1 MB, set EDIBigDocThreshold to
at least 3 MB. Otherwise, Module for
EDI still treats the document as large
even though its size is smaller than the
threshold number.

EDICheckEncodingLength Specifies the length of each portion of data

to be validated for encoding.The Module for
EDI validates an EDI document by dividing
it into smaller portions of data where each
portion of data is validated for encoding.You
can add a suffix of K or M to the value. The
default value is 20K.

EDIencoding Specifies the character encoding for

encoding EDI documents. The default is
UTF-8. Module for EDI uses this property if
it does not encounter an encoding variable in
the pipeline.

EDIEncodingsToTry Specifies a comma-separated list of character

encoding to use if the default encoding
standard property (EDIencoding) fails.
If both the EDIencoding property and the
EDIEncodingsToTry property fail, then
the value for the file.encoding java system
property is used. If this value is UTF-8, then
ISO8859-1 is used.

EDIMaxFATransactionErrors Specifies the maximum number of errors to

report per FA transaction. Valid values are:

webMethods Module for EDI Installation and User’s Guide Version 9.12 27
 M
Even Header
Configuring webMethods Module for EDI

Property Description

n . Specifies the maximum number of

errors that can be reported for any one FA
transaction. The default is 100.
-1. Specifies that any number of errors can
be reported for any one FA transaction.

EDIUseNewRelationshipLabel Indicates whether to display related

documents identified by their control
numbers or by their relationship labels
on the Transaction Analysis page in My
webMethods. Valid values are:
true—Displays documents by relationship
labels.
false—Displays documents by control
numbers. This is the default.

EDIAllowCustomControlNumberSequences
Specifies the control number sequence. Valid
values are:
false—Module for EDI looks up the next
control number using the corporation
names of the sender and receiver. This is
the default.
true—Module for EDI looks up the next
control number using the sender and
receiver IDs and qualifiers. If no record
is found using this criteria, the module
aempts to identify the sequence based on
corporation names. If no sequence is found,
the module creates a new sequence based
on partner corporation names.
strictCompatibility—Specifies whether
to use either the external IDs of partners
or their corporation names to define the
control number sequence. Use this value
for backward compatibility with Module
for EDI 6.5.2 or if you want to adopt the
sequence that a particular operation uses.
(For example, with the batching feature,
Module for EDI uses corporation names
when generating outbound batches but

webMethods Module for EDI Installation and User’s Guide Version 9.12 28
 M
Odd Header
Configuring webMethods Module for EDI

Property Description
uses sender/receiver IDs and qualifiers in
services that add envelopes and groups.)

EDIResolveDuplicates Specifies how Module for EDI assigns

FA status when sending (or receiving) a
document multiple times before the receiver
returns an FA.
false—When sending a document
multiple times before the receiver returns
an FA, the status of each document is set to
None (“100”) in the EDITRACKING table.
This indicates that Module for EDI has
not yet received an FA. When the receiver
returns an FA for one of these documents,
the status of each document is updated to
Duplicate (“120”), indicating that multiple
documents exist in the EDITRACKING
table that match this FA. This is the default.
true—When sending a document the first
time, its status is set to None (“100”) in the
EDITRACKING table. This indicates that
Module for EDI has not yet received an FA.
If the same document is sent again before
the receiver returns an FA:
The status of the first document
changes to Duplicate (“120”), indicating
that multiple documents exist in the
EDITRACKING table that match this
FA.
The status of the second document is set
to None. This behavior occurs for each
subsequent document sent before an FA
is returned.
When the receiver returns an FA, the FA
acknowledges only the document that was
sent last. The status of this last document
is set according to the FA status reported
in the FA document. The status of all prior
documents remains Duplicate.

Note:This behavior also applies to received

documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 29
 M
Even Header
Configuring webMethods Module for EDI

Property Description

disableCIDSupport Specifies whether to disable the extraction

of conversation IDs from EDI documents for
Envelope and Group document types.
true—Disables the extraction of
conversation IDs from EDI documents for
Envelope and Group document types.
false—Enables the extraction of
conversation IDs from EDI documents for
Envelope and Group document types. This
is the default.

Note:For VDA documents, if you set this

property to false, you must also add
a package dependency from WmTN
to WmPRT and then reload WmTN
in order to extract the conversation
ID correctly. For details, see the
webMethods Service Development Help
for your release.

ignoreFAStatusUpdateForOutboundBatch
Controls whether Module for EDI checks
and updates the EDI FA Status of incoming
EDI documents during batching.
true—The module does not check and
update the EDI FA Status.
false—The module checks and updates
the EDI Status. This is the default.

PersistUnchangedInboundEDIDocumentSpecifies whether to persist EDI documents

in Trading Networks exactly as they are
received, without removing empty records
and spaces between records.
true—EDI documents are persisted exactly
as they are received.
false—EDI documents are persisted
after removing empty records and spaces
between records. This is the default.

EDIUseConvertToString61Behavior Specifies whether Module for EDI

performs less stringent validation
during implementation of the

webMethods Module for EDI Installation and User’s Guide Version 9.12 30
 M
Odd Header
Configuring webMethods Module for EDI

Property Description
wm.b2b.edi:convertToString service. Software AG
recommends seing this property to false.
true—Module for EDI performs less
stringent validation against the flat file
schema during implementation of the
wm.b2b.edi:convertToString service. Specifically,
Module for EDI prevents sorting the
edidata from the wm.b2b.edi:convertToString
service when the service’s input data does
not follow the same order as the flat file
schema and the sortInput parameter is set
to false.
false—Module for EDI performs
stringent validation against the flat file
schema during implementation of the
wm.b2b.edi:convertToString service when the
sortInput parameter is set to false. This is
the default.

EDIDisableCONTRLVersion Specifies whether both the release number

and the version number of the UNIEDIFACT
message are used to determine the version.
Valid values are:
true—Module for EDI considers only
the release number of the UNEDIFACT
message to determine the version of the
UNEDIFACT message.
false—Module for EDI considers both the
release number and the version number
when determining the version of the
UNEDIFACT message. This is the default.

EDISchemaSource Specifies whether the flat file schemas are

created using either the SEF or XML files.
The default is XML.

Note:Ensure that the required schema

packages are installed.

Note: Any properties you set in the properties.cnf file, will appear in My
webMethods. You can edit these properties in the Module for EDI
Configuration Properties section of the Administration > Integration > B2B
Settings > Configure Properties page.

webMethods Module for EDI Installation and User’s Guide Version 9.12 31
 M
Even Header
Configuring webMethods Module for EDI

4. Click Save.
5. Restart Integration Server.

Setting Up Items Required for Structural Validation and

Conversion
Module for EDI uses flat file schemas to parse and validate the structure of inbound EDI
documents and to convert documents from EDI format into the format used by your
internal applications and vice versa. Module for EDI automatically creates the flat file
schemas when you define TN EDI document types as described in "Defining TN EDI
Document Types" on page 37.
However, you might still need to perform the following flat file-related tasks:

Task Where to Find More Information

Configure how you want format "Configuring Format Services to

services to convert field values in Convert Field Values" on page 32
documents

Specify how to associate the format "Associating the EDI Format Services
service to fields defined in a flat file with EDI Data Types" on page 35
schema for an EDI document

Create flat file schemas for EDI "Creating Flat File Schemas for
documents and your internal-format Internal-Format Documents" on page
documents 36

Configuring Format Services to Convert Field Values

A format service formats the value of a field and optionally validates the field against
restrictions defined in the format service. Module for EDI provides format services to
convert field values into a different format as required by your system. For example, a
format service can change the format of a date field from YYYYMMDD to MMDDYYYY
or data from the EDI standard into a different format used by your internal application.
You associate format services with specific fields in a flat file schema.
The following EDI format services run automatically when defined as the conversion
service for a flat file input schema:
wm.b2b.edi:convertToValues (or wm.b2b.edi.tradacoms:convertToValues) service. Converts an
EDI transaction set document to an IS document (IData object), which contains the
internal document format.

webMethods Module for EDI Installation and User’s Guide Version 9.12 32
 M
Odd Header
Configuring webMethods Module for EDI

wm.b2b.edi:convertToString (or wm.b2b.edi.tradacoms:convertToString) service. Converts an IS

document (IData object), which contains the internal document format, to an EDI
document.

Important: If a field does not have a value (that is, a value is not returned in the IS
document (IData object) for the convertToValues service or is not present in the
input data for the convertToString service), the assigned format service does not
execute.

For more information about the convertToValues and convertToString services, see webMethods
Module for EDI Built-In Services Reference. For more information about how to use these
services when processing EDI documents, see "Logic to Include in the Service to Process
EDI Documents" on page 193.
The format services use the seings in the following configuration file to determine how
to perform field conversions:
Integration Server_directory\instances\$instance_name \packages\WmEDI\config
\format.xml
The format.xml configuration file specifies the format required by the EDI standard
(external format) and your internal application (internal format). By default, the external
formats in this configuration file match the EDI ANSI standard format. You must update
the configuration so that it reflects the EDI standard that you are using and the formats
of your internal application in order for the system to accurately convert field values
from one format to another.
To apply conversion configurations, perform the following procedure to update
the configuration in memory so changes are applied immediately, as well as in the
format.xml file.

To configure field conversion values in documents

1. In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2. In the Module for EDI Format Seings panel, update each entry in the format.xml
configuration file to meet your site's needs. Do not add any additional
FormatService entries.

Each entry has the following format:

<FormatService
name="name_of_format_service"
isEnabled="true_or_false"
internalFormatString="format"
externalFormatString="format"
applyFormat="true_or_false"/>

For example:
<FormatService
name="formatDate6"
isEnabled="true"
internalFormatString="MM/dd/yy"
externalFormatString="yyMMdd"
applyFormat="true"/>

webMethods Module for EDI Installation and User’s Guide Version 9.12 33
 M
Even Header
Configuring webMethods Module for EDI

The following tables describes the meaning of each seing in an entry:

Setting Description

name The name of the format service that the entry governs.
Do not change name.
The entry formatImpliedDecimal affects all implied
decimal services (formatN0-formatN9), which format fields
with EDI data types N0 - N9. For a complete description
of these and other EDI format services, see webMethods
Module for EDI Built-In Services Reference.

isEnabled Indicates whether the format service is enabled.

Specify either true or false.
true—The format service performs its processing to
convert and/or validate field values.
false—The format service immediately returns
without performing any conversion or validation.

Note: You can also configure whether to enable format

services in the configuration of the WmFlatFile.

Note: If the configuration for the WmFlatFile

package specifies not to use format services,
the convertToValues and convertToString services
will not invoke the format service, even if the
isEnabled configuration seing is set to true.
For more information about how to configure
the WmFlatFile package, see Flat File Schema
Developer’s Guide.

internalFormatString The format required by your internal application (for

example, your back-end system).
Specify a string that follows the conventions described
in the java classes java.text.DecimalFormat and
java.text.SimpleDateFormat. For more information
about these classes, see Oracle’s documentation.

externalFormatString The format required by the EDI standard you are

using. If you are using the EDI ANSI standard format,
you should not change this seing.
Specify a string that follows the conventions described
in the java classes java.text.DecimalFormat and

webMethods Module for EDI Installation and User’s Guide Version 9.12 34
 M
Odd Header
Configuring webMethods Module for EDI

Setting Description
java.text.SimpleDateFormat. For more information
about these classes, see Oracle’s documentation.

applyFormat Whether the convertToValues or convertToString services

should apply the converted value.
true—The service validates and updates the
document to reflect the converted value.
false—The service validates, but does not update
the document with the converted value.

3. Click Save Changes.

For information about format services and the WmFlatFile package, including error
information and how to specify format services for fields in flat file schemas and
dictionaries, see the section on format services in the chapter on creating and editing flat
file schemas and dictionaries in Flat File Schema Developer’s Guide.

Associating the EDI Format Services with EDI Data Types

When you create a flat file schema from a SEF file, you can have the wm.b2b.edi:SEFParse
service automatically assign format services to the fields in the flat file schema. For
this service to be able to assign the format services, you must associate EDI format
services with EDI data types. The wm.b2b.edi:SEFParse service assigns the format services
to fields based on the fields' data types. For example, if a field has a data type of “DT”,
the wm.b2b.edi:SEFParse service assigns the format service that you associate with the DT
data type to that field. For more information about how to create flat files from SEF files,
see "Creating a Flat File Schema from a SEF File" on page 404.
To determine the data type of a field, the wm.b2b.edi:SEFParse service uses the element
definition contained within the SEF file. The element definition has the following
structure:
<element name>=<data type>,<min length>,<max length>

To determine the format service to associate with a specific data type, the
wm.b2b.edi:SEFParse service uses information that you configure in the following
configuration file:
Integration Server_directory\instances\$instance_name \packages\WmEDI\config
\format.xml
In the format.xml configuration file, you configure the format service you want the
wm.b2b.edi:SEFParse service to use for each EDI data type.
To associate EDI format services with EDI data types, perform the following procedure
to update the configuration in memory (so the changes take effect immediately) and in
the format.xml file.

webMethods Module for EDI Installation and User’s Guide Version 9.12 35
 M
Even Header
Configuring webMethods Module for EDI

To associate EDI format services with EDI data types

1. In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2. In the Module for EDI Format Seings panel, update each entry in the format.xml
configuration file as needed. Each entry has the following format structure:
<DatatypeFormat
datatype="data_type"
service="format_service_to_associate_with_datatype"/>

For more information about the format services provided with Module for EDI, see
the description of the wm.b2b.edi.util.formatServices folder in webMethods Module for EDI
Built-In Services Reference.
Examples:
The following entry associates the data type N1 with the formatN1 format service.
This entry matches all elements with data type N1, regardless of their length.
<DatatypeFormat
datatype="N1"
service="wm.b2b.edi.util.formatServices:formatN1"/>

The following entry associates the data type TM with a minimum length of 4 and
a maximum length of 8 with the formatTime4_8 format service:
<DatatypeFormat
datatype="TM,4,8"
service="wm.b2b.edi.util.formatServices:formatTime4_8"/>

3. Resequence the DatatypeFormat entries, if necessary.

The wm.b2b.edi:SEFParse service searches the DatatypeFormat entries sequentially in
the format.xml configuration file and uses the first match. As a result, ensure your
entries are listed from more specific to less specific.
Example:
To use format service “example:service1" for data type N1 where the minimum length
is 1 and maximum length is 5 and to use format service "example:service2" for all other
N1 data types, the format.xml file would contain DatatypeFormat entries in the
following order:
<DatatypeFormat
datatype="N1,1,5"
service="example:service1"/>
<DatatypeFormat
datatype="N1"
service="example:service2"/>

4. Click Save.

Creating Flat File Schemas for Internal-Format Documents

If you want to use EDI built-in services to convert internal-format documents (for
example, documents from a back-end system) from IData objects to strings and
vice versa, create a flat file schema that defines the structure of the internal-format

webMethods Module for EDI Installation and User’s Guide Version 9.12 36
 M
Odd Header
Configuring webMethods Module for EDI

documents. Use the functionality in the WmFlatFile package in Software AG Designer to

create the flat file schemas. For more information, see Flat File Schema Developer’s Guide.

Note: For backward compatibility, you can also use an IS document type to
define the structure of internal-format documents. However, Software AG
recommends using flat file schemas.

Defining TN EDI Document Types

For Trading Networks to recognize EDI documents, you must define a TN EDI
document type for each corresponding EDI transaction set or TRADACOMS file (of
a specific standard and version) that you will exchange. For example, if you plan to
exchange 850s (purchase orders), 855s (purchase order acknowledgments), and 997s
(functional acknowledgments), you would define the three TN EDI document types
corresponding to a specific version and standard of each transaction set. Or, if you plan
to exchange three TRADACOMS File document types, you would define those three TN
EDI document types corresponding to a specific version and standard of each file.
When you define a TN EDI document type, Module for EDI automatically creates a flat
file schema for the same EDI transaction set or TRADACOMS file. Trading Networks
stores flat file schemas in the EDIFFSchema folder in the WmEDIforTN package,
using the naming conventions described in "Flat File Schema Namespace Conventions
for Non-TRADACOMS Standards" on page 44 or "Flat File Schema Namespace
Conventions When Using TRADACOMS" on page 45.

Note: In a clustered environment, you can optionally deploy the EDIFFSchema

folder in all the nodes so that the installed document types are available
across the cluster.

If you have set the tn.docType.EnableLogDocumentType property to true, Trading

Networks logs the details of the new document type in the activity log. For more
information about seing Trading Networks configuration properties, see the
webMethods Trading Networks Administrator’s Guide for your release.

Note: You might need to customize flat file schemas for your specific validation
needs. For example, you might want to validate fewer constraints, or modify
the valid values.
For information about how to work with flat files schemas, see Flat File Schema
Developer’s Guide.

These are the following three high-level steps for defining TN EDI document types:

Note: You must have administrator privileges and data permission to define
and manage document types in Trading Networks. For information about
defining data permissions and role-based access, see the webMethods Trading
Networks Administrator’s Guide for your release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 37
 M
Even Header
Configuring webMethods Module for EDI

Step 1: Define Document Type Information

You can use My webMethods to define document type information.

Defining Document Type Information Using My webMethods

This procedure uses My webMethods to define information for the supporting TN
EDI document types for each transaction set or file you want to exchange with trading
partners. Trading Networks checks documents against this information to determine
whether the document matches a defined TN EDI document type.

To define document type information using My webMethods

1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Types.
2. Click Add Document Types.
3. Select EDI.
4. In the EDI Document Type dialog box, select the appropriate values for the following
fields, and then click Create.

Field Description

Standard The EDI standard

Version The version of the selected standard

In TRADACOMS, the transmission, batch, and file
document types each have a version. The version you are
specifying here is the version of the TRADACOMS file
document type (for example, v4).

Transaction The transaction set (or TRADACOMS file) of the selected

standard and version
In TRADACOMS, the transmission, batch, and file
document types each have a version. The version you are
specifying here is the version of the TRADACOMS file
document type (for example, v4).

Module for EDI generates the name of the TN EDI document type based on the
standard, the version, and the transaction type you selected. This name is displayed
in the Name field on the EDI Document Type Details page. You cannot edit the name
of the TN EDI document type.

webMethods Module for EDI Installation and User’s Guide Version 9.12 38
 M
Odd Header
Configuring webMethods Module for EDI

In addition to generating the name of the TN EDI document type, the module
installs a flat file schema. For information about flat file schema namespace
conventions, see "Flat File Schema Namespace Conventions" on page 44.
5. In the EDI Document Type Details page, specify the following:

Field Description

Description Optional. The description for the TN EDI document type.

Status Whether you want the TN EDI document type to be

enabled or disabled for identifying a document that passes
through your system.
Enabled—The TN EDI document type is enabled. This is
the default.
Disabled—The TN EDI document type is disabled. For
information about the effects of disabling a TN document
type, see the webMethods Trading Networks Administrator’s
Guide for your release.

Note: You can keep the TN EDI document type disabled

until all the information for the TN EDI document
type is specified.

Step 2: Define Attributes to be Extracted from Documents

You must specify the aribute values to extract from the document's TN_parms
parameter. You can extract both system aributes and custom aributes (the document
data). In addition, you can use built-in or custom transformations to transform extracted
aribute values before Trading Networks stores them in the BizDocEnvelope.
For VDA documents, the extraction query specified in the document type should be able
to extract any field value in the header of the message. You must specify the sender and
receiver aributes that you want Trading Networks to extract from the documents.
For TRADACOMS documents, you cannot extract aributes for TRADACOMS headers,
messages, and trailers separately. Trading Networks does not separate these sections
in the aribute extraction dialog box. You can extract aributes only from the message
section of a TRADACOMS document. For more information about the aributes that
Module for EDI stores for TRADACOMS document types, see "Aributes Stored for
TRADACOMS Document Types" on page 41.
For more information about document aributes, see " Trading Networks Aributes and
EDI Documents" on page 211 and the webMethods Trading Networks Administrator’s
Guide for your release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 39
 M
Even Header
Configuring webMethods Module for EDI

For information about overwriting aributes, see "Overwriting Document Aributes

Extracted from Inbound Documents" on page 49.

To define the attributes that you want Trading Networks to extract from the document
1. Complete the steps in "Step 1: Define Document Type Information" on page 38.
2. On the EDI Document Type Details page, click the Extract tab. The document tree
view displays the contents of the installed TN EDI document type.
3. For each aribute that you want Trading Networks to extract from documents
identified by this TN EDI document type:
a. Expand the document tree view, and select a node that represents the aribute
that you want Trading Networks to extract.
b. Do one of the following to display the Add Extracted Aribute dialog box:
Click next to the Query field, and then select Add Attribute.
In the EDI document tree view panel, click in the Action column, and then
select Add Attribute.
c. In the Add Extracted Aribute dialog box, specify the following:

Field Description

Query The XQL query that instructs Trading Networks how to

extract the aribute for the particular TN EDI document type.
Trading Networks fills the Query field with the XQL query for
the node that you selected.
For information about extracting aributes specifying an
XQL query of a node in the document tree, see "Extracting a
Document Aribute Using an XQL Query" on page 42.

Name The name of the aribute (for example, SenderID,

ReceiverID, or ConversationID). Select a name from the list.
Trading Networks fills in the Type and Description fields based
on the document aribute definition.

Required Whether you want Trading Networks to log an error message

in the activity log when it cannot extract the aribute.

Transformation How Trading Networks handles aribute data before storing

it in the Trading Networks database. The data type of the
aribute (shown in the Type field) determines the built-in or
custom transformation options available.

webMethods Module for EDI Installation and User’s Guide Version 9.12 40
 M
Odd Header
Configuring webMethods Module for EDI

Field Description

For VDA documents, you must also select the type of the
external IDs (for example, DUNS) from the Built-in list for
both SenderID and ReceiverID aributes so that Trading
Networks can match the external IDs in SenderID and
ReceiverID with the external IDs in the profiles. This is how
Trading Networks verifies the identities of the sender and
receiver.

d. Click OK.
For information about using an XQL query of a node in a document tree to extract a
document aribute, see "Extracting a Document Aribute Using an XQL Query" on page
42.

Attributes Stored for TRADACOMS Document Types

Trading Networks supports the TRADACOMS document types Transmission, Batch,
and File. This table shows which aributes are stored for each of these document types.

Attribute Transmission Batch Type File Type

Type

Application yes derived from derived from

Reference transmission transmission

Priority Code yes derived from derived from

transmission transmission

Detail Message no no yes

Count

Has VAT Message no no yes

Has Reconciliation yes no no

Message

Is Multiple yes no no
Envelope

Version yes (only derived from no (determined

valid value is transmission by document
1) type)

webMethods Module for EDI Installation and User’s Guide Version 9.12 41
 M
Even Header
Configuring webMethods Module for EDI

Extracting a Document Attribute Using an XQL Query

You can use an XQL query of a node in the document tree to extract a document
aribute by following this procedure. For examples, see "Examples of Extracting a
Document Aribute Using an XQL Query" on page 42.

To extract a document attribute by specifying an XQL query of a node in the document tree
1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Types.
2. Select the document type for which you want to specify aributes to extract and then
click the Action tab.
3. On the Extract tab, in the document tree view, select a node that represents the
aribute that you want Trading Networks to extract.
4. Click either next to the Query field or in the Action column in the EDI document
tree view panel.
5. Select Add Attribute.
6. In the Add Extracted Aribute dialog box, specify the values, as described in "Step 2:
Define Aributes to be Extracted from Documents" on page 39.
7. Click OK.

Examples of Extracting a Document Attribute Using an XQL Query

The examples provided are based on the following EDI document:
ST*850*0001!
BEG*01*BK*99AKDF9DAL393*39483920193843*20021106*AN3920943*AC*IBM*02*AE*02*BA!
CUR*AC*USA*.2939*SE*USA*IMF*002*20021106*1615*021*20021106*0718*038*20021106*195
2*002*20021106*1615*021*20021106*0718!
REF*AB*3920394930203*GENERAL
PURPOSE*BT:12345678900987654321768958473:CM:500:AB:3920394930203!
REF*BC*3920394930203*GENERAL
PURPOSE*BT:12345678900987654321768958473:CM:500:AB:3920394930203!
...
SE*196*0001!

Example 1. To extract the first field, 01, in the BEG record of the sample EDI document,
specify the following XQL query: /ST/BEG/BEG01/code
Example 2. To extract the first field, AB, in the first REF record of the sample EDI
document, specify the following XQL query: /ST/REF[0]/REF01/code
Example 3. To extract the first field, BC, in the second REF record of the sample EDI
document, specify the following XQL query: /ST/REF[1]/REF01/code

Step 3: Define Processing Options

Once you have identified the aributes that you want Trading Networks to extract from
the document, you need to define the processing options you want Trading Networks

webMethods Module for EDI Installation and User’s Guide Version 9.12 42
 M
Odd Header
Configuring webMethods Module for EDI

to consider when matching a document to a TN EDI document type. Use the following
procedure to define options.

To define processing options for a TN EDI document type

1. Complete the steps in "Step 2: Define Aributes to be Extracted from Documents" on
page 39.
2. Select the document type for which you want to define options and click the Options
tab.
3. On the EDI Document Type Details page, specify the following:

Field Description

Enable Processing Whether you want Trading Networks to search for

Rule Routing a processing rule and use the rule to process the
document.

Validate Structure Whether you want Trading Networks to validate the

(pre-processing structure of the document.
action)

Save (pre- Whether you want Trading Networks to save the

processing action) document to the database.
If you select to save the document to the database,
select one of the following from the list:
All documents
Only unique documents
If you choose to save the document to the database,
select the options to specify whether you want Trading
Networks to save the following document information
to the database:
Content
Attributes
Activity Log
Trading Networks performs this pre-processing action
before it performs the processing action defined by the
processing rule.

4. Do one of the following:

To save the changes you have made and continue defining the TN EDI document
type, click Save.

webMethods Module for EDI Installation and User’s Guide Version 9.12 43
 M
Even Header
Configuring webMethods Module for EDI

To save the changes and close the TN EDI document type, click Save and Close.

Creating a TN EDI Document Type Based on a Transaction

You can create an EDI document type based on a transaction that you have saved in
Trading Networks.

To create a TN EDI document type based on a transaction saved in the Trading Networks
1. In My webMethods: Monitoring > Integration > B2B > Transactions.
2. Click on the row containing the 'Unknown' document that you want to use for
creating the document type.
3. Select Create Document Type.
4. In the Create Document Type dialog box, click EDI to select the document type
category.
5. In the EDI Document Type dialog box, select the appropriate values for Standard,
Version, and Transaction.
6. Click Create.
7. In the EDI Document Type Details page, specify the details.
8. Do one of the following:
Click Save to save the changes you have made and continue defining the TN EDI
document type.
Click Save and Close to save the changes and close the TN EDI document type.
Click Cancel if you do not want to save the TN EDI document type.

Flat File Schema Namespace Conventions

When you define a TN EDI document type, Module for EDI creates a flat file schema
for the same EDI transaction set or TRADACOMS file. Trading Networks stores flat file
schemas in the EDIFFSchema folder of the WmEDIforTN package, using the namespace
conventions described below.

Flat File Schema Namespace Conventions for Non-TRADACOMS

Standards
For non-TRADACOMS standards, Trading Networks uses the following namespace
convention for flat file schemas:
EDIFFSchema.Standard.VVersion:TTransactionSet

webMethods Module for EDI Installation and User’s Guide Version 9.12 44
 M
Odd Header
Configuring webMethods Module for EDI

where Standard is the name of the EDI standard, version is the version number of the
EDI standard, and TransactionSet is the EDI transaction set. For example:
For a TN EDI document type for version 4010 of an ANSI X12 850, Trading
Networks creates the following flat file schema in the WmEDIforTN package:
EDIFFSchema.X12.V4010:T850

For a TN EDI document type for version 99A of the UN/EDIFACT standard with a
transaction set of ORDERS, Trading Networks creates the following flat file schema
in the WmEDIforTN package: EDIFFSchema.UNEDIFACT.V99A:TORDERS

Note: If a transaction in a SEF file contains multiple consecutive HL segments with

the same name, the package combines the HL segments into one HL segment
in the flat file schema, thus enabling it to be parsed correctly.

Flat File Schema Namespace Conventions When Using TRADACOMS

For each TRADACOMS File document type, Trading Networks installs up to four flat
file schemas, using the following namespace convention:
EDIFFSchema.Tradacoms.Vversion.Tname:MheaderMessage

EDIFFSchema.Tradacoms.Vversion.Tname:MdetailMessage

EDIFFSchema.Tradacoms.Vversion.Tname:MVATMessage

EDIFFSchema.Tradacoms.Vversion.Tname:MtrailerMessage

where:
version represents the version of the TRADACOMS File document type (for example,
v2).
name represents the name of the TRADACOMS File document type (for example,
TLPRHDR).
headerMessage , detailMessage , VATMessage , and trailerMessage are derived from the
MHD0201.
For example: EDIFFSchema.Tradacoms.v2.TLPRHDR:MLPRHDR
For information about the aributes stored for TRADACOMS document types, see
"Aributes Stored for TRADACOMS Document Types" on page 41.

Managing TN EDI Document Types

You can perform the following tasks on TN EDI documents types:
Enable and disable
Search
View
Update

webMethods Module for EDI Installation and User’s Guide Version 9.12 45
 M
Even Header
Configuring webMethods Module for EDI

Viewing the Code List Details

To view the code list descriptions of a segment for a document type using My webMethods

Note: The code list descriptions are available only for the document types
based on the XML schemas for the EDI schema packages available in the
installer. By default, Module for EDI installs the document types from the
XML schemas which are available in the EDI schema packages.
The code list descriptions in My webMethods are displayed only for the
default values of the installed EDI standards. If these values are modified
and any additional values are added to these standards in Designer, then
the changes do not reflect in My webMethods.

1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Types.
2. Click on an EDI Document Type.
3. Navigate to the EDI Document Type Details > Extract tab and expand the document type
tree at the UUID level.
4. Click on the corresponding Lookup link for a document type.
The CodeList Lookup dialog box lists all the code IDs, names, and descriptions for
the document type. You can also search for a specific code ID using the Search Code
ID > ID field.

Viewing Alternate Name and Description of Segments

To view the alternate name and description of a segment for an XML schema
1. In Software AG Designer: Package Navigator > WmEDIforTN > EDIFFSchema > Standard,
expand any version folder and double click on a transaction.
2. In the Properties tab, click on a segment to view the properties.
The Alternate name and Description properties of the segment are displayed.

Updating TN EDI Document Types

This section describes how to update TN EDI document types. For more information
about performing any of the other tasks listed, see the webMethods Trading Networks
Administrator’s Guide for your release.
You can perform the following update tasks on TN EDI document types:

webMethods Module for EDI Installation and User’s Guide Version 9.12 46
 M
Odd Header
Configuring webMethods Module for EDI

Task Where to Find More Information

Update the description and "Updating the Description or Status of a TN

status of the TN EDI document EDI Document Type" on page 47
type

Update the processing options "Updating the Processing Options Specified

of the TN EDI document type in the Document Type" on page 47

Update the TN EDI document "Updating a TN EDI Document Type Based

type based on a transaction on a Transaction" on page 48

You cannot update the name, standard, and version of a TN EDI document type.
When you update a TN EDI document type, the changes are logged in the activity
log if you have set the tn.docType.EnableLogDocumentType property to true. For
more information about seing Trading Networks configuration properties, see the
webMethods Trading Networks Administrator’s Guide for your release.

Updating the Description or Status of a TN EDI Document Type

Use this procedure to update the description or status of a TN EDI document type. For
more information about the description and the status of a TN EDI document type, see
"Defining TN EDI Document Types" on page 37.

To update the description or status of a TN EDI document type

1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Types
Trading Networks displays all the document types.
2. In the row containing information about the TN EDI document type that you want to
update, click Edit.
3. In the EDI Document Type Details page, edit the Description and Status fields as
required, and then click OK.

Updating the Processing Options Specified in the Document Type

To update the options specified in the document type
1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Types.
2. Click the Options tab, and then select the required options.

webMethods Module for EDI Installation and User’s Guide Version 9.12 47
 M
Even Header
Configuring webMethods Module for EDI

For more information about these options, see "Defining TN EDI Document Types"
on page 37.
3. Do one of the following:
To save the changes you have made and continue defining the TN EDI document
type, click Save.
To save the changes and close the TN EDI document type, click Save and Close.

Updating a TN EDI Document Type Based on a Transaction

To update a TN EDI document type based on a transaction saved in Trading Networks
1. In My webMethods: Monitoring > Integration > B2B > Transactions.
2. Click on the row containing the document that you want to use for editing the
document type. Select Edit Document Type.
3. In the Document Type Details page, edit the fields in the Extract and Options tabs as
required.
For more information about updating TN EDI document types using a saved
transaction, see the webMethods Trading Networks Administrator’s Guide for your
release.
4. Do one of the following:
To save the changes you have made and continue editing the document type,
click Save.
To save the changes and close the TN EDI document type, click Save and Close.

Managing Document Attributes

You can perform the following tasks on document aributes:

Task Where to Find More Information

Add a document aribute "Adding a Document Aribute" on page

49

Edit a document aribute "Editing a Document Aribute" on page

49

Delete a document aribute "Deleting a Document Aribute" on page

49

webMethods Module for EDI Installation and User’s Guide Version 9.12 48
 M
Odd Header
Configuring webMethods Module for EDI

Adding a Document Attribute

To add a document attribute
1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Attributes.
2. Click Add Document Attributes.
3. In the Name field, enter the name of the aribute.
4. In the Type field, select the appropriate value from the drop-down list.
5. In the Description field, enter a description for the document aribute.
6. Click OK.

Editing a Document Attribute

To edit a document attribute
1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Attributes.
2. In the row containing information about the document aribute that you want to
update, click Edit.
3. Edit the Name and Description fields as required.
4. Click OK.

Deleting a Document Attribute

To delete a document attribute
1. In My webMethods: Administration > Integration > B2B > Document Types Administration >
Document Attributes.
2. Click the row containing the document aribute you want to delete, and then click
Delete.

Overwriting Document Attributes Extracted from Inbound

Documents
To simplify document recognition by Trading Networks, you can overwrite aribute
values that are extracted from inbound documents with values of your own. To
overwrite any custom or system aribute, add the aribute with the new value in the
TN_parms parameter of the wm.tn:receive service.Trading Networks extracts the value

webMethods Module for EDI Installation and User’s Guide Version 9.12 49
 M
Even Header
Configuring webMethods Module for EDI

from TN_parms and saves it to the database to use later. For more information about the
wm.tn:receive service, see the webMethods Trading Networks Built-In Services Reference for
your release.
You can overwrite the values of system and custom aributes for Transaction, Group,
and Envelope document types depending on the type of transaction. Trading Networks
displays the new value of the aribute on the Attributes tab in My webMethods.
For more information about document aributes, see " Trading Networks Aributes and
EDI Documents" on page 211 and the webMethods Trading Networks Administrator’s
Guide for your release.

EDI Transaction
The following tables show the system and custom aributes that you can overwrite for
an EDI transaction, where:
Yes means that the value of the aribute you specify overwrites the default value.
No means that you cannot overwrite the aribute.
NA means that the aribute is not present in the document.
Table 1. System Aributes

Attribute Transaction Group Document Envelope

Document Document

ConversationID Yes Yes Yes

DocumentID Yes Yes Yes

GroupID Yes Yes Yes

Table 2. Custom Aributes

Attribute Transaction Group Document Envelope

Document Document

EDI Batch No Yes Yes

EDI Group Type NA Yes Yes

EDI Outbound FA NA NA Yes

EDI Processing No Yes Yes

Mode

webMethods Module for EDI Installation and User’s Guide Version 9.12 50
 M
Odd Header
Configuring webMethods Module for EDI

Attribute Transaction Group Document Envelope

Document Document

EDI Status No Yes Yes

EDI Version NA Yes Yes

Envelope CntrlNum No No No
Status

Group CntrlNum No No NA
Status

EDI FA Status No Yes NA

TA1 Transaction
The following tables show the system and custom aributes that you can overwrite for a
TA1 transaction, where:
Yes means that the value of the aribute you specify overwrites the default value.
No means that you cannot overwrite the aribute.
NA means that the aribute is not present in the document.
Table 3. System Aributes

Attribute Transaction (TA1) Envelope Document

Document

ConversationID No Yes

DocumentID No Yes

GroupID No Yes

Table 4. Custom Aributes

Attribute Transaction (TA1) Envelope Document

Document

EDI Batch NA Yes

webMethods Module for EDI Installation and User’s Guide Version 9.12 51
 M
Even Header
Configuring webMethods Module for EDI

Attribute Transaction (TA1) Envelope Document

Document

EDI Group Type NA Yes

EDI Outbound FA NA Yes

EDI Processing Mode NA Yes

EDI Status NA Yes

EDI Version NA Yes

Envelope CntrlNum Status NA No

Group CntrlNum Status NA NA

TA1 Status NA No

TA1 Code NA No

EDI FA Status NA NA

FA Transaction
The following tables show the system and custom aributes that you can overwrite for
an FA transaction, where:
Yes means that the value of the aribute you specify overwrites the default value.
No means that you cannot overwrite the aribute.
NA means that the aribute is not present in the document.
Table 5. System Aributes

Attribute Transaction (TA1) Envelope Group

Document Document Document

ConversationID Yes Yes Yes

DocumentID Yes Yes Yes

GroupID Yes Yes Yes

webMethods Module for EDI Installation and User’s Guide Version 9.12 52
 M
Odd Header
Configuring webMethods Module for EDI

Table 6. Custom Aributes

Attribute Transaction (TA1) Envelope Group

Document Document Document

EDI Batch No Yes Yes

EDI Group Type NA Yes Yes

EDI Outbound FA NA Yes NA

EDI Processing Mode No Yes Yes

EDI Status No Yes Yes

EDI Version NA Yes Yes

Envelope CntrlNum Status No No No

Group CntrlNum Status No NA No

LateFA NA NA No

EDI FA Status No NA Yes

Adding New Versions of EDI Standards

You can configure Module for EDI to support a new version of any EDI standard that
Module for EDI supports, except VDA and TRADACOMS.

To add a new version of an EDI standard from SEF

1. Obtain the appropriate SEF file for the new version of the EDI standard. The SEF
file's .INI section must specify the EDI standard and version. The file must contain all
the transaction sets that the version supports.
2. In Designer's navigation panel, run the following built-in service located in the
WmEDIforTN package: wm.b2b.editn.util.VersionSupport:addNewEDIVersion. This service
creates a new TN document type file in the config directory of the WmEDIforTN
package. The new version will be available when defining TN document types.
Specify the following input parameters for the service:

webMethods Module for EDI Installation and User’s Guide Version 9.12 53
 M
Even Header
Configuring webMethods Module for EDI

Input Parameter Description

SEF fileName The fully qualified path of the SEF file.

Replace? Whether to overwrite an existing SEF file of the same name

and its associated TN document type file.
yes—Overwrite an existing SEF file of the same name and its
associated TN document type file.
no—Do not overwrite an existing SEF file of the same name
and its associated TN document type file. This is the default.

Note: The service does not update the envelope segments structure or the
validation for individual fields. However, the service does update the
following fields in the IS document type wm.b2b.editn.rec:EDIHEADERS so that
Trading Networks recognizes the new version during validation:

Standard Code list for Description

field

ANSI X12, VICS, ISA/ISA12 Version in the Interchange header.

UCS

ISA/GS/ Version in the Group header.

GS08

Note: If the new version of the EDI standard introduces changes to the structure
of the 997 transaction set, these changes will not be reflected in the
functional acknowledgments created by the wm.b2b.edi:generateFA service.

For complete information about the wm.b2b.editn.util.VersionSupport:addNewEDIVersion

service, see webMethods Module for EDI Built-In Services Reference.
3. Reload the WmEDIforTN package.
4. Install the new TN EDI document type for the transaction set, as described in
"Defining TN EDI Document Types" on page 37. Module for EDI creates the TN
EDI document type and the SEF files.

Module for EDI In the following directory...

creates...

TN EDI WmEDIforTN\config\EDI_Standard \docType.xml

document type

webMethods Module for EDI Installation and User’s Guide Version 9.12 54
 M
Odd Header
Configuring webMethods Module for EDI

Module for EDI In the following directory...

creates...

where EDI_Standard is X12, UNEDIFACT, ODETTE, EANCOM,

VICS, or UCS.

SEF file Integration Server_directory\instances

\$instance_name \packagesWmEDI\pub\SEFS
\EDI_Standard\version.sef

Note: For UN/EDIFACT, ODETTE, and EANCOM, the

system adds a CONTRL message in the .SETS section
of the SEF file.

Important: After you install a new version of an EDI standard and the corresponding
TN EDI document type, do not re-install that version of the EDI standard.
If you re-install it, the internal ID of the document type will change,
and any references to that ID will be incorrect. In addition, any Trading
Networks processing rules that refer to the document type will also be
incorrect.

webMethods Module for EDI Installation and User’s Guide Version 9.12 55
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 56
 M
Odd Header
Defining Trading Partner Information

3   Defining Trading Partner Information

■ Overview ....................................................................................................................................... 58
■ Defining Trading Partner Profiles ................................................................................................. 59
■ Defining EDI Trading Partner Agreements .................................................................................. 61

webMethods Module for EDI Installation and User’s Guide Version 9.12 57
 M
Even Header
Defining Trading Partner Information

Overview
To process documents when you are using webMethods Trading Networks with
webMethods Module for EDI, you must define both trading partner profiles and
trading partner agreements (EDITPAs) for the partners with whom you will trade EDI
documents. How you define information for your partners depends on whether you
want Module for EDI to use standard or non-standard processing. For more information,
see webMethods Module for EDI Concepts Guide.

Important: The chapters in this guide describe how to use standard processing. When
you want to use non-standard processing, certain tasks must be performed
differently. Such tasks are indicated by the graphic, as well as
a reference to the corresponding section in "Non-Standard Processing" on
page 371. When you are using standard processing, you can ignore these
references.

Partner Information You Need to Define

The following table lists the information you must define for interchange and group
sender/receiver pairs with whom you will trade EDI documents.

Note: For more information about defining partners when using

non-standard processing, see "Defining Partner Information When Using
Non-Standard Processing" on page 372. For more information about the
difference between standard and non-standard processing, see webMethods
Module for EDI Concepts Guide.

For... Define...

Interchange sender/ Trading partner profiles for each interchange

receiver pairs sender and receiver. For more information, see
"Defining Trading Partner Profiles" on page 59.

Group sender/receiver Trading partner profiles for each group sender

pairs and receiver. For more information, see "Defining
Trading Partner Profiles" on page 59.

Tailoring how Module for A default EDITPA, which defines the seings that
EDI processes documents you want to use for most partner pairs.
A partner-specific EDITPA for each interchange
sender/receiver pair for which you want to
override the default EDITPA seings.

webMethods Module for EDI Installation and User’s Guide Version 9.12 58
 M
Odd Header
Defining Trading Partner Information

For... Define...

For more information, see "Defining EDI Trading

Partner Agreements" on page 61.

How Module for EDI Whether to validate control numbers.

validates inbound control
Actions Module for EDI should take when it
numbers
encounters an invalid control number.
Control number validation seings (that is,
maximum, minimum, increment, and window).
For more information, see "Validating Inbound
Control Numbers" on page 258.

For more information about how Module for EDI works with Trading Networks, see
webMethods Module for EDI Concepts Guide.

Defining Trading Partner Profiles

You must set up profiles for all the trading partners with whom you want to exchange
documents. Define profiles for:
Your own corporation if you have not already done so. This is referred to as the
Enterprise profile in Trading Networks.
Your trading partners at the interchange and group level.

Note: When you use non-standard processing, you must create profiles
only for partners at the group level. For more information, see "Defining
Trading Networks Profiles When Using Non-Standard Processing" on page
373. For more information about the difference between standard and non-
standard processing, see webMethods Module for EDI Concepts Guide.

When you define trading partner profiles, you need to specify the external IDs your
partners use in their documents. The external IDs correspond to the standard EDI ID
qualifiers. Trading Networks does not provide external IDs for all EDI ID qualifiers;
however, Module for EDI provides a way for you to add them to Trading Networks.
Before creating the profiles, you might want to add additional external ID types to
Trading Networks that correspond to the EDI ID qualifiers. For more information, see
"Adding External ID Types for EDI ID Qualifiers" on page 60.
For instructions about creating trading partner profiles, see the webMethods Trading
Networks Administrator’s Guide for your release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 59
 M
Even Header
Defining Trading Partner Information

Adding External ID Types for EDI ID Qualifiers

An external ID type indicates the method a corporation uses to identify itself within
documents and enables you to identify the partner with whom you are exchanging
a document. For example, a corporation might use a D-U-N-S number as an external
ID type, which is identified by the EDI ID qualifier “1” or “01.” When you define
the profile, you select an external ID type and supply the value the partner uses. For
example, if the corporation uses a D-U-N-S number, the value is the corporation's D-U-
N-S number, such as “123456789.”
Trading Networks uses the external ID information in a profile to determine the
sender and receiver of a document. EDI ID qualifiers and their corresponding values
identify the sender and receiver of the EDI document. The EDI ID qualifiers and their
corresponding values are contained in the interchange and group envelope headers. The
following example shows an ANSI X12 interchange envelope header.

The EDI ID qualifier “01” corresponds to a D-U-N-S number (which is the Trading
Networks external ID type, DUNS). The EDI ID qualifier “ZZ” corresponds to the
Trading Networks external ID type Mutually-Defined. Trading Networks automatically
provides the DUNS and Mutually-Defined external ID types. However, Trading Networks
does not provide external ID types for all EDI ID qualifiers. To Trading Networks, you
can add external ID types that correspond to standard EDI ID qualifiers. For all EDI ID
qualifiers and their external ID type equivalents, see the EDI Standards documentation
for your EDI standard and version.

To add external ID types for EDI ID qualifiers to Trading Networks

1. In My webMethods: Administration > Integration > B2B > Partner Administration > Partner
Profiles.
2. Either click the desired profile or click Edit next to the desired profile.
3. On the External IDs tab, click Add ID Type.
4. Type the name of the external ID type and click OK.
5. Do one of the following:
To assign a value to the new external ID type, select the ID type from the ID Type
list and then type a value in the Value box.

webMethods Module for EDI Installation and User’s Guide Version 9.12 60
 M
Odd Header
Defining Trading Partner Information

To add a new external ID, click Add ID, select the ID type from the ID Type list,
type a value in the Value box, and click OK.

Adding and Overriding EDI ID Qualifiers

Some EDI ID qualifiers have different meanings in different EDI standards and versions.
For example:
For UN/EDIFACT, the value of the ID qualifier code 30 is “ISO 6523".
For ANSI X12, the value of the ID qualifier code 30 is “Federal Tax ID.”
Module for EDI considers the value of the ID qualifier code 30 to be “ISO 6523".
However, you can create a service to override (or add) any ID qualifier code value
(for example, you can override “ISO 6523" with “Federal Tax ID”), as described in the
following table.

Step Description

1 In any user-defined package, create a service that overrides the value of the
ID qualifier code and name it custom.EDIIDMapping:addEDIIDMapping.

2 In your flow, create the custom.EDIIDMapping:addEDIIDMapping service.

3 To the custom.EDIIDMapping:addEDIIDMapping service, add the qualifier input

parameter and the idType output parameter. They are both of data type
String.

4 In the custom.EDIIDMapping:addEDIIDMapping service, branch on qualifier and

add a map step. Label the map step with the ID qualifier that you expect to
receive (for example, 30).

5 In the map step, hard code the value of the output idType with any value,
such as “User Defined 1.”

For more information about creating custom flow services, see the webMethods Service
Development Help for your release. For a sample service, see the Technical community
area of the Empower Product Support website at hp://communities.softwareag.com/.

Defining EDI Trading Partner Agreements

An EDI trading partner agreement (EDITPA) is a set of variables that you provide to
tailor how Module for EDI exchanges documents between two trading partners. The
module supports partner-specific EDITPAs and a single default EDITPA. Each EDITPA
contains variables that Module for EDI uses only when processing documents that
match the values specified in the EDITPA.

webMethods Module for EDI Installation and User’s Guide Version 9.12 61
 M
Even Header
Defining Trading Partner Information

A partner-specific EDIDTPA is unique for a specific sender and receiver pair and
contains variables that the module uses only when processing documents that match
the specified sender/receiver pair.
A sender-specific EDITPA specifies a sender but leaves the receiver defined as
“unknown.” The value “unknown” equates to “any,” thus matching all document
types to the EDITPA.
A receiver-specific EDITPA identifies the receiver but leaves the sender defined as
“unknown.”
A default EDITPA defines both the sender and receiver as “unknown.” A default
EDITPA contains variables used by all trading partners when partner-specific
information is not available. The seings in the default EDITPA should meet the
requirements of the majority of your trading partner relationships. You can modify
the default EDITPA. For more information, see "Modifying the Default EDITPA" on
page 62.
During document processing, Module for EDI identifies the EDITPA to use for the
sender/receiver pair of a document as follows:
1. When a partner-specific EDITPA exists, the module uses the values specified in the
partner-specific EDITPA.
2. When a partner-specific EDITPA does not exist and a sender specific EDITPA does
exist, Module for EDI uses the values specified in the sender-specific EDITPA.
3. When neither a partner-specific EDITPA nor a sender-specific EDITPA exists, and
a receiver-specific EDITPA does exist, the module uses the values specified in the
receiver-specific EDITPA.
4. When a partner-specific EDITPA, a sender-specific EDITPA, and a receiver-specific
EDITPA do not exist, the module uses the value from the default EDITPA.

Modifying the Default EDITPA

The seings in the default EDITPA should meet the requirements of the majority of your
trading partner relationships.
The first time the WmEDIforTN package is loaded into Integration Server, Module
for EDI automatically creates the default EDITPA in Trading Networks. Using My
webMethods, you can modify the default EDITPA when the Agreement Status is
Agreed and the Data Status is Modifiable, or when the Agreement Status is Proposed.
For more information about modifying EDITPAs, see the webMethods Trading Networks
Administrator’s Guide for your release.

Note: Do not disable the default EDITPA. Module for EDI uses the seings in the
default EDITPA when values are missing in the partner-, sender-, or receiver-
specific EDITPAs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 62
 M
Odd Header
Defining Trading Partner Information

When you modify the default EDITPA, in My webMethods, specify the following
seings on the Administration > Integration > B2B > Trading Partner Agreements page:

For this field... Keep this setting...

Sender Unknown

Receiver Unknown

Agreement ID EDITPA

IS Document Type wm.b2b.editn.TPA:EDITPA

You can modify the values for the variables in the

wm.b2b.editn.TPA:EDITPA IS document type. For more
information, see "wm.b2b.editn.TPA:EDITPA IS Document
Type" on page 65.

Defining a Partner-Specific EDITPA

You only need to create partner-specific EDITPAs when you have one or more sender/
receiver pairs that require different seings from those you defined in the default
EDITPA. When creating a partner-specific EDITPA, specify only the information that
is different from the default EDITPA. Define partner-specific EDITPAs for interchange-
level sender/receiver pairs.
Using My webMethods, you can create a partner-specific EDITPA in one of the
following ways:
Duplicate the default EDITPA and change variable values
Duplicate a similar partner-specific EDITPA and change variable values
Create an EDITPA from scratch
For instructions about how to create TPAs (either by duplication or from scratch), see the
webMethods Trading Networks Administrator’s Guide for your release.
When creating a partner-specific EDITPA, specify the following fields on the
Administration > Integration > B2B > Trading Partner Agreements > Trading Partner
Agreement Details page:

Field Description

Agreement ID EDITPA

webMethods Module for EDI Installation and User’s Guide Version 9.12 63
 M
Even Header
Defining Trading Partner Information

Field Description

Sender The name of the sender from the partner-specific sender/

receiver pair.

Receiver The name of the receiver from the partner-specific sender/

receiver pair.

Control Number The value that the application using the TPA expects (only
relevant if the application uses the Control Number field).
The value for this field must be an integer. The default is
zero (0).

Description (Optional) A description for the TPA. You can use up to

1024 characters of any type.

Data Status Whether to modify the values of the TPA data of the
IS document type. This field only applies when the
agreement status is Agreed.

Initialization A service that you created to define the default values for
Service the wm.b2b.editn.TPA:EDITPA IS document type. (Or, leave
this field blank.)
Software AG recommends that you do not use the
initialization service ( wm.b2b.editn.TPA:initService)
that is provided with Module for EDI. The
wm.b2b.editn.TPA:initService service is used to populate the
values of the default EDITPA.

Validation Service (Optional) A service to validate the TPA. For more

information about the validation service, see the
webMethods Trading Networks Administrator’s Guide for
your release.

Export Service The service to convert the data in the Trading Networks
TPA to an industry-format trading partner agreement.
For more information about the export service, see the
webMethods Trading Networks Administrator’s Guide for
your release.

IS Document Type wm.b2b.editn.TPA:EDITPA

For information about seing values for

the wm.b2b.editn.TPA:EDITPA variables, see

webMethods Module for EDI Installation and User’s Guide Version 9.12 64
 M
Odd Header
Defining Trading Partner Information

Field Description
"wm.b2b.editn.TPA:EDITPA IS Document Type" on page
65.

Note: You can disable partner-specific EDITPAs. When you disable a partner-
specific EDITPA, Module for EDI uses the values in the default EDITPA.

Note: When you are using non-standard processing, define partner-

specific EDITPAs for group-level sender/receiver pairs. For more information,
see "Defining a Partner-Specific EDITPA When Using Non-Standard
Processing" on page 374. For more information about the difference
between standard and non-standard processing, see "Defining a Partner-
Specific EDITPA When Using Non-Standard Processing" on page 374.

wm.b2b.editn.TPA:EDITPA IS Document Type

At run time, Module for EDI uses a default value for a variable when the value for that
variable is neither specified in a partner-specific EDITPA nor the default EDITPA. When
the wm.b2b.editn.TPA:initService service initially creates the default EDITPA, the module sets
the default values.
Review the variable descriptions to determine the value you want to specify in the
default EDITPA or a partner-specific EDITPA. When creating partner-specific EDITPAs,
keep in mind that you should only specify values for the variables for which you want
to override the default EDITPA value and leave values blank for the variables for which
you want to use the defaults. The descriptions and default values for the variables of the
wm.b2b.editn.TPA:EDITPA IS document type are listed below.

Tip: It is helpful to understand how Module for EDI processes EDI documents
and uses the variables in the EDITPA. For more information, see webMethods
Module for EDI Concepts Guide.

For details about specific EDITPA variables, see the following locations:

EDITPA Variable Where to Find More Information

GSRouting "GSRouting Variables" on page 67

persistMultipleDocEnvelope "PersistMultipleDocEnvelope Variable" on page

69

processingMode "processingMode Variable" on page 70

splitOption "splitOption Variable" on page 71

webMethods Module for EDI Installation and User’s Guide Version 9.12 65
 M
Even Header
Defining Trading Partner Information

EDITPA Variable Where to Find More Information

FAReconciliation "FAReconciliation Variable" on page 72

UNAmode "UNAmode Variable" on page 74

publishBatchFailEvent "publishBatchFailEvent Variable" on page 74

delimiters "delimiters Variables" on page 75

envelopeIdentifier "envelopeIdentifier Variables" on page 76

ICheaderInfo "ICheaderInfo Variables" on page 77

FAGeneration "FAGeneration Variables" on page 80

ControlNumberManagement "ControlNumberManagement Variables" on page

88

useReverseRoute "useReverseRoute Variable" on page 92

BatchCriteria "BatchCriteria Variables" on page 93

EDITransportMedia "EDITransportMedia Variable" on page 95

persistOriginalEnvelope "persistOriginalEnvelope Variable" on page

96

documentPersistOrder "documentPersistOrder Variable" on page 97

LateFA "LateFA Variables" on page 98

X12TA1Generation "X12TA1Generation Variables" on page 100

TRADACOMS "Defining Trading Partner Information When

Using TRADACOMS" on page 105

EANCOMAUTACK "EANCOMAUTACK Variables" on page 101

webMethods Module for EDI Installation and User’s Guide Version 9.12 66
 M
Odd Header
Defining Trading Partner Information

GSRouting Variables
Module for EDI creates Interchange, Group, and Transaction documents based on the
splitOption variable in the EDITPA. The GSRouting variables indicate the value the
module uses for the sender and receiver in these documents.
The values that you select for the GSRouting variables determine:
How you define criteria for Trading Networks processing rules when you create
them for the Interchange, Group, and Transaction documents. You can use the
sender and receiver as criteria in the processing rules.
The external ID types and values that you define in the partner profiles. For Trading
Networks to match the sender and/or receiver criteria in a processing rule, you must
define a partner profile with an external ID type and value that match the value that
the module will put in the Interchange, Group, and Transaction documents.
For more information about creating processing rules and defining external IDs in
trading partner profiles, see the webMethods Trading Networks Administrator’s Guide for
your release.
GSRouting/routingMode EDITPA Variable
Default: OFF
The routingMode variable indicates how Module for EDI obtains the sender and receiver
for each type of document. The following table provides the possible values for this
variable. The examples use the following headers:
ISA*00**00**01*123456789*ZZ*987654321*020201*1535*U*00300*000004323*0*P
GS*PO*901234572000*908887732000*020201*1535*4369*X*003020

Value Description

GSOnly Module for EDI determines the sender and receiver as follows:
For Interchange documents, the module uses the interchange
header.
For example, the sender uses EDI ID qualifier “01” with value
“123456789” and the receiver uses the EDI ID qualifier “ZZ” with
the value “987654321.”
For Group and Transaction documents, the module uses the
group header.
For example, the sender uses the value “901234572000” and the
receiver uses the value “90888773200.” For the EDI ID qualifiers,
see the GSRouting/senderQualifier and GSRouting/receiverQualifier
variables.

GS&ISA Module for EDI determines the sender and receiver as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 67
 M
Even Header
Defining Trading Partner Information

Value Description

For Interchange documents, the module uses the interchange

header.
For example, the sender uses EDI ID qualifier “01” with value
“123456789” and the receiver uses the EDI ID qualifier “ZZ” with
the value “987654321”.
For Group and Transaction documents, the module derives the
sender by concatenating ISA05, ISA06, and GS02 fields, using a
colon (:) separator, and derives the receiver ID by concatenating
ISA07, ISA08, and GS03.
For example, the sender would be 01:123456789:901234572000
and the receiver would be ZZ:987654321:908887732000. The
EDI ID qualifiers are always ZZ (Mutually Defined) when you
use GS&ISA.

OFF Module for EDI determines the sender and receiver as follows:
For Interchange, Group, and Transaction documents, the module
uses the interchange header.
For example, the sender uses the EDI ID qualifier “01” with the
value “123456789” and the receiver uses the EDI ID qualifier “ZZ”
with the value “987654321.”

Note: This seing does not apply when using non-standard

processing. When routingMode is OFF and you are using
non-standard processing, Module for EDI uses the GSOnly
seing. For more information about group level processing,
see webMethods Module for EDI Concepts Guide.

GSRouting/senderQualifier EDITPA Variable

Default: *
The senderQualifier variable indicates the EDI ID qualifier that Module for EDI uses for
the sender when the GSRouting/routingMode variable is GSOnly.

Value Description

* Module for EDI uses the EDI ID qualifier for the sender from the
interchange header (for example, ISA05 field).

Other EDI ID You can specify any EDI ID qualifier that the EDI standard
qualifiers supports. For all EDI ID qualifiers, see the documentation for your
EDI standard and version.

webMethods Module for EDI Installation and User’s Guide Version 9.12 68
 M
Odd Header
Defining Trading Partner Information

Value Description

Note: Be sure to add the external ID types to Trading Networks

for the EDI ID qualifier you specify, if necessary. For more
information, see "Adding External ID Types for EDI ID
Qualifiers" on page 60.

GSRouting/receiverQualifier EDITPA Variable

Default: *
The receiverQualifier variable indicates the EDI ID qualifier that Module for EDI uses for
the receiver when the GSRouting/routingMode variable is GSOnly.

Value Description

* Module for EDI uses the EDI ID qualifier for the receiver from the
interchange header (for example, ISA07 field).

Other EDI ID You can specify any EDI ID qualifier that the EDI standard
qualifiers supports. For all EDI ID qualifiers, see the EDI Standards
documentation for your EDI standard and version.

Note: Be sure to add the external ID types to Trading Networks

for the EDI ID qualifier you specify, if necessary. For more
information, see "Adding External ID Types for EDI ID
Qualifiers" on page 60.

PersistMultipleDocEnvelope Variable
persistMultipleDocEnvelope EDITPA Variable
Default: true
The persistMultipleDocEnvelope variable indicates whether Module for EDI saves the
original document in the Trading Networks database. The original EDI document
usually contains multiple interchange segments. Module for EDI only uses the
persistMultipleDocEnvelope variable from the default EDITPA.

Note: Module for EDI splits each interchange segment within the original EDI
document into Interchange, Group, and Transaction documents based
on the seing of the splitOption EDITPA variable. Control whether the
Interchange, Group, and Transaction documents are saved in the Trading
Networks database in the processing rule.

webMethods Module for EDI Installation and User’s Guide Version 9.12 69
 M
Even Header
Defining Trading Partner Information

Value Description

true Module for EDI saves the original EDI document in the Trading
Networks database. The document is saved with both the sender
and receiver set to “unknown.”

false Module for EDI does not save the original EDI document in the
Trading Networks database.When you specify false, there is no
way to retrieve the original EDI document later.

processingMode Variable
processingMode EDITPA Variable
Default: Testing
The processingMode variable indicates whether the partners using the EDITPA are
in testing, production, or custom mode. When processing Interchange, Group, and
Transaction documents, Module for EDI includes the custom aribute EDI Processing Mode
in the BizDocEnvelope and sets the value of this aribute based on the processingMode
EDITPA variable.
In your processing rules for Interchange, Group, and Transaction documents, you can
use the EDI Processing Mode custom aribute to customize processing according to the
partner's processing mode. For example, you might set up two processing rules: one
for when partners are in testing mode and another for when partners are in production
mode.
For more information about custom aributes and using them when creating processing
rules, see the webMethods Trading Networks Administrator’s Guide for your release.

Value Description

Testing Use when testing the exchange of documents between

two partners. For example, when the production mode
is Testing, you might create processing rules that accept
the documents and do all processing except passing the
document to production applications.

Production Use when you are confident that your logic for
exchanging documents is successful.

Custom Use when you want to define your own seing.

Interchange Define Module for EDI sets the value of EDI Processing
Mode based on the processing mode defined in the
interchange header.

webMethods Module for EDI Installation and User’s Guide Version 9.12 70
 M
Odd Header
Defining Trading Partner Information

Value Description

For an ANSI X12 document, the module defines the

processing mode based on the value of ISA015, as
follows:
T or others—Sets the EDI processing mode
aribute to Testing
P—Sets the processing mode aribute to
Production
I—Sets the processing mode aribute to Custom
For a UN/EDIFACT document, the module defines
the processing mode aribute based on the value of
UNB11, as follows:
1,2,3,4 or others—Sets the processing mode
aribute to Testing
Empty—Sets the processing mode aribute to
Production

splitOption Variable
splitOption EDITPA Variable
Default: Transaction
The splitOption variable defines how Module for EDI splits an interchange segment
within an EDI document. The module uses splitOption to determine which of the
following document types to create from the interchange segment:
Interchange documents—Contain a single interchange envelope, group
segments, and transaction sets
Group documents—Contain a single group segment and transaction sets
Transaction documents—Contain a single transaction set
To perform processing on the transactions in an inbound document, set splitOption to
Transaction or Group. To use Trading Networks to route the inbound EDI document
without processing individual transactions, set the splitOption to Interchange.
The following table lists the possible values for the splitOption variable and the types of
documents that Module for EDI creates for each value.

Value Description

Interchange Module for EDI creates only the Interchange document.

Note: When splitOption is Interchange and the FAReconciliation

EDITPA variable is set to true, the module splits the

webMethods Module for EDI Installation and User’s Guide Version 9.12 71
 M
Even Header
Defining Trading Partner Information

Value Description
document at the Group level. For more information, see
"FAReconciliation Variable" on page 72.

When you are using non-standard processing and you

specify Interchange, the module splits the document at the Group
level. For more information, see "wm.b2b.editn.TPA:EDITPA IS
Document Type When Using Non-Standard Processing" on page
374.

Group Module for EDI creates the Interchange document and a Group
document for each group segment in the interchange segment.

Transaction Module for EDI creates the Interchange document, a Group

document for each group segment in the interchange segment,
and a Transaction document for each transaction set in the
interchange segment.

FAReconciliation Variable
FAReconciliation EDITPA Variable
Default: false
The FAReconciliation variable indicates whether to enable FA reconciliation so Module
for EDI performs both of the following:
Reconciles inbound FA acknowledgments that it receives with the outbound EDI
documents that it has sent
Reconciles outbound FA acknowledgments that it sends with the inbound EDI
documents that it has received
To reconcile FAs, Module for EDI makes a record of each Group/Interchange EDI
document that it sends and receives through Trading Networks. For ANSI EDI
documents, the module records each Group document it sends or receives. For
UN/EDIFACT EDI documents, the module records each Group document if the
EDI document contains Group-level documents; if it does not, the module records
Interchange-level document. Module for EDI records the information about these
documents to the EDITRACKING table, which is a Module for EDI-specific table in the
Trading Networks database. For more information about the EDITRACKING table, see
"Routing the Outbound EDI Document to Trading Networks " on page 304.

Note: When you form an outbound EDI document and send it directly to the
Trading Networks processing rules rather than allow Trading Networks
to recognize the document with its TN document types, you will need
to invoke the wm.b2b.editn:trackEDIdocs service to record the outbound
document in the EDITRACKING table.

webMethods Module for EDI Installation and User’s Guide Version 9.12 72
 M
Odd Header
Defining Trading Partner Information

When FA reconciliation is enabled, Module for EDI updates the status for each Group/
Interchange document in the EDITRACKING table when it sends or receives the
Group/Interchange document's corresponding FA. For more information about FA
reconciliation, see "Reconciling Functional Acknowledgments" on page 341.

Value Description

true Module for EDI enables FA reconciliation.

When the module sends or receives a Group/Interchange
document through Trading Networks, it adds an entry to the
EDITRACKING table the document and sets the FA status to
None.
When the module receives or sends the corresponding FA,
it aempts to locate the corresponding Group/Interchange
document in the EDITRACKING table.
When the module locates a matching entry, it updates the
FA status. For example, if the module locates one matching
document and the FA has the "A" (Accept) status, the module
updates the FA status to Accept.
For a list of all possible statuses, see "FA Statuses" on page
345.
When the module cannot find a matching entry, it adds an
entry for the FA to the EDITRACKING table.

false Module for EDI disables FA reconciliation.

When the module sends or receives a Group/Interchange
document through Trading Networks, it adds an entry to the
EDITRACKING table the document and sets the FA status to
Disable.
When the module receives or sends the corresponding FA,
it aempts to locate the corresponding Group/Interchange
document in the EDITRACKING table.
When the module locates a matching entry and the status is
Disable, it does nothing.
When the module locates a matching entry and the status is
None, it updates the status to Disable.
When the module cannot find a matching entry, it adds an
entry for the FA to the EDITRACKING table.

webMethods Module for EDI Installation and User’s Guide Version 9.12 73
 M
Even Header
Defining Trading Partner Information

UNAmode Variable
UNAmode EDITPA Variable
Default: auto
The UNAmode variable indicates whether you want to create a UNA segment to precede
the interchange in an outbound UN/EDIFACT EDI document.
When you use the Module for EDI batching feature to create an outbound EDI
document, the batchProcess service honors this seing. For more information, see
"Batching EDI Documents" on page 311.
Additionally, services you create to form outbound UN/EDIFACT EDI documents
can retrieve this seing from the EDITPA using the wm.tn.tpa:getTPA service. For more
information about this service, see the webMethods Trading Networks Built-In Services
Reference for your release.

Value Description

yes The module creates the UNA segment prior to the interchange in
the outbound EDI UN/EDIFACT document.

no The module does not create UNA segment prior to the

interchange in the outbound EDI UN/EDIFACT document.

auto The module creates the UNA segment prior to the interchange in
the outbound EDI UN/EDIFACT document.

publishBatchFailEvent Variable
publishBatchFailEvent EDITPA Variable
Default: false
The publishBatchFailEvent variable indicates whether you want Module for EDI to
publish an IS document when it is unable to include an EDI document that is queued for
batching into the final batch EDI document. The format of the IS document is defined by
wm.b2b.editn.rec:batchFailRecord IS document type. For more information, see webMethods
Module for EDI Built-In Services Reference. For more information about how this EDITPA
variable is used during batching and how to handle the failure, see "Updating the Task
Status and Publishing Documents for Failed Tasks" on page 320.

Value Description

true The module publishes an IS document when it is unable to

include into the final batch EDI document, an EDI document that
is queued for batching.

webMethods Module for EDI Installation and User’s Guide Version 9.12 74
 M
Odd Header
Defining Trading Partner Information

Value Description

false The module does not publish an IS document when it is unable to

include into the final batch EDI document, an EDI document that
is queued for batching.

delimiters Variables
delimiters/record EDITPA Variable
Default: (no default)
The delimiters/record variable indicates the segment terminator to use in an outbound
EDI document, for example, +. Services you create to form outbound EDI documents
can retrieve this seing from the EDITPA using the wm.tn.tpa:getTPA service. For more
information about this service, see the webMethods Trading Networks Built-In Services
Reference for your release.
When you use the Module for EDI batching feature to create an outbound EDI
document, if you do not specify the delimiters input parameter to the batchProcess service,
the batchProcess service retrieves this seing from the EDITPA. For more information, see
"Delimiters Used for the Batch EDI Document" on page 319.
delimiters/field EDITPA Variable
Default: (no default)
The delimiters/field variable indicates the field separator to use for each EDI segment in
an outbound EDI document, for example, !. Services you create to form outbound EDI
documents can retrieve this seing from the EDITPA using the wm.tn.tpa:getTPA service.
For more information about this service, see the webMethods Trading Networks Built-In
Services Reference for your release.
When you use the Module for EDI batching feature to create an outbound EDI
document, if you do not specify the delimiters input parameter to the batchProcess service,
the batchProcess service retrieves this seing from the EDITPA. For more information, see
"Delimiters Used for the Batch EDI Document" on page 319.
delimiters/subfield EDITPA Variable
Default: (no default)
The delimiters/subfield variable indicates the separator to use for composite elements in
an outbound EDI document, for example, *. Services you create to form outbound EDI
documents can retrieve this seing from the EDITPA using the wm.tn.tpa:getTPA service.
For more information about this service, see the webMethods Trading Networks Built-In
Services Reference for your release.
When you use the Module for EDI batching feature to create an outbound EDI
document, if you do not specify the delimiters input parameter to the batchProcess service,
the batchProcess service retrieves this seing from the EDITPA. For more information, see
"Delimiters Used for the Batch EDI Document" on page 319.
delimiters/release EDITPA Variable
Default: (no default)

webMethods Module for EDI Installation and User’s Guide Version 9.12 75
 M
Even Header
Defining Trading Partner Information

The delimiters/release variable indicates the release character to use for an outbound EDI
document (for example, “\\xd3). Services you create to form outbound EDI documents
can retrieve this seing from the EDITPA using the wm.tn.tpa:getTPA service. For more
information about this service, see the webMethods Trading Networks Built-In Services
Reference for your release.
When you use the Module for EDI batching feature to create an outbound EDI
document, if you do not specify the delimiters input parameter to the batchProcess service,
the batchProcess service retrieves this seing from the EDITPA. For more information, see
"Delimiters Used for the Batch EDI Document" on page 319.

envelopeIdentifier Variables
The envelopeIdentifier variables consist of ID and qualifier variables for senders and
receivers.
envelopeIdentifier/sender/ID EDITPA Variable
Default: (no default)
The envelopeIdentifier/sender/ID variable indicates the sender ID to use for an outbound
EDI document. Services you create to form outbound EDI documents can retrieve this
seing from the EDITPA using the wm.tn.tpa:getTPA service. For more information about
this service, see the webMethods Trading Networks Built-In Services Reference for your
release.
When using the Module for EDI batching feature:
When the batchProcess service oneBatchQueue input parameter is NONE, the
batchProcess service uses its input parameters to locate the EDITPA, and then uses
the envelopeIdentifier variables to set the sender/receiver in the interchange and
group headers of the outbound batch EDI document. For more information, see
the webMethods Trading Networks Built-In Services Reference for your release
When you are using batching with oneBatchQueue set to SINGLEOUTPUT or
MULTIPLEOUTPUTS, do not specify the envelopeIdentifier/sender/ID variable.
envelopeIdentifier/sender/qualifier EDITPA Variable
Default: (no default)
The envelopeIdentifier/sender/qualifier variable indicates the EDI ID qualifier associated
with the value you specify for envelopeIdentifier/sender/ID . For example, if you specified a
D-U-N-S number for the envelopeIdentifier/sender/ID , for envelopeIdentifier/sender/qualifier
specify 01, which is the EDI ID qualifier for a D-U-N-S number. Services you create to
form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature:
When the batchProcess service oneBatchQueue input parameter is NONE, the
batchProcess service uses its input parameters to locate the EDITPA, and then uses
the envelopeIdentifier variables to set the sender/receiver in the interchange and

webMethods Module for EDI Installation and User’s Guide Version 9.12 76
 M
Odd Header
Defining Trading Partner Information

group headers of the outbound batch EDI document. For more information, see
the webMethods Trading Networks Built-In Services Reference for your release.
When you are using batching with oneBatchQueue set to SINGLEOUTPUT or
MULTIPLEOUTPUTS, do not specify the envelopeIdentifier/sender/ID variable.
envelopeIdentifier/receiver/ID EDITPA Variable
Default: (no default)
The envelopeIdentifier/receiver/ID variable indicates the receiver ID to use for an outbound
EDI document. Services you create to form outbound EDI documents can retrieve this
seing from the EDITPA using the wm.tn.tpa:getTPA service. For more information about
this service, see the webMethods Trading Networks Built-In Services Reference for your
release.
When using the Module for EDI batching feature:
When the batchProcess service oneBatchQueue input parameter is NONE, the
batchProcess service uses its input parameters to locate the EDITPA, and then uses
the envelopeIdentifier variables to set the sender/receiver in the interchange and
group headers of the outbound batch EDI document. For more information, see
the webMethods Trading Networks Built-In Services Reference for your release.
When you are using batching with oneBatchQueue set to SINGLEOUTPUT or
MULTIPLEOUTPUTS, do not specify the envelopeIdentifier/sender/ID variable.
envelopeIdentifier/receiver/qualifier EDITPA Variable
Default: (no default)
The envelopeIdentifier/receiver/qualifier variable indicates the EDI ID qualifier associated
with the value you specify for envelopeIdentifier/receiver/ID . For example, if you specified
a D-U-N-S number for the envelopeIdentifier/receiver/ID , specify 01 for envelopeIdentifier/
receiver/qualifier , which is the EDI ID qualifier for a D-U-N-S number. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature:
When the batchProcess service oneBatchQueue input parameter is NONE, the
batchProcess service uses its input parameters to locate the EDITPA, and then uses
the envelopeIdentifier variables to set the sender/receiver in the interchange and
group headers of the outbound batch EDI document. For more information, see
the webMethods Trading Networks Built-In Services Reference for your release.
When you are using batching with oneBatchQueue set to SINGLEOUTPUT or
MULTIPLEOUTPUTS, do not specify the envelopeIdentifier/sender/ID variable.

ICheaderInfo Variables
The ICheaderInfo variables indicate the values to use for ANSI X12 interchange and
group headers and UN/EDIFACT UNB headers in outbound EDI documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 77
 M
Even Header
Defining Trading Partner Information

ICheaderInfo/ISA/ISA01 EDITPA Variable

Default: 00
The ICheaderInfo/ISA/ISA01 variable indicates the value to use for the ISA01 element of
an ANSI X12 interchange header in an outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/ISA/ISA02 EDITPA Variable
Default: (no default)
The ICheaderInfo/ISA/ISA02 variable indicates the value to use for the ISA02 element of
an ANSI X12 interchange header in an outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/ISA/ISA03 EDITPA Variable
Default: 00
The ICheaderInfo/ISA/ISA03 variable indicates the value to use for the ISA03 element of
an ANSI X12 interchange header in an outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/ISA/ISA04 EDITPA Variable
Default: (no default)
The ICheaderInfo/ISA/ISA04 variable indicates the value to use for the ISA04 element of
an ANSI X12 interchange header in an outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/ISA/ISA11 EDITPA Variable
Default: U
The ICheaderInfo/ISA/ISA11 variable indicates the value to use for the ISA11 element of
an ANSI X12 interchange header in an outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the

webMethods Module for EDI Installation and User’s Guide Version 9.12 78
 M
Odd Header
Defining Trading Partner Information

wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/GS/GS07 EDITPA Variable
Default: (no default)
The ICheaderInfo/GS/GS07 variable indicates the value to use for the GS07 element
of an ANSI X12 group header in an outbound EDI document. Services you create to
form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/UNB/UNB01 EDITPA Variable
Default: (no default)
The ICheaderInfo/UNB/UNB01 variable indicates the value to use for the UNB01 element
of a UN/EDIFACT UNB header in the outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/UNB/UNB06 EDITPA Variable
Default: (no default)
The ICheaderInfo/UNB/UNB06 variable indicates the value to use for the UNB06 element
of a UN/EDIFACT UNB header in the outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using the Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.
ICheaderInfo/UNB/UNB08 EDITPA Variable
Default: (no default)
The ICheaderInfo/UNB/UNB08 variable indicates the value to use for the UNB08 element
of a UN/EDIFACT UNB header in the outbound EDI document. Services you create
to form outbound EDI documents can retrieve this seing from the EDITPA using the
wm.tn.tpa:getTPA service. For more information about this service, see the webMethods
Trading Networks Built-In Services Reference for your release.
When using Module for EDI batching feature, the module uses this seing when
creating the interchange headers of the outbound batch EDI document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 79
 M
Even Header
Defining Trading Partner Information

FAGeneration Variables
FAGeneration/autoGenerateFA EDITPA Variable
Default: Off

Note: When you are using non-standard processing, Module for

EDI does not use this EDITPA variable. Instead, it uses the Auto Generate
FA seing available on the Interchange Information Detail panel of the
module’s home page. For more information about accessing and using this
panel, see "Defining Interchange-Level Sender/Receiver Pair Information"
on page 376.
The FAGeneration/autoGenerateFA variable indicates whether you want Module for EDI
to automatically generate FAs for an inbound EDI document.

Value Description

On Always automatically generates FAs for inbound EDI documents

Off Never automatically generates FAs for inbound EDI documents

Per Document Automatically generates FAs based on the indicator flag in the
interchange header (for example, ISA14 or UNB09).

FAGeneration/FALevel EDITPA Variable

Default: Default

Note: When you are using non-standard processing, Module for EDI
does not use this EDITPA variable. Instead, it uses the FA Level seing
available on the Interchange Information Detail panel of the module’s
home page. For more information about accessing and using this panel,
see "Defining Interchange-Level Sender/Receiver Pair Information" on
page 376.
The FAGeneration/FALevel variable defines the level of detail that the module
acknowledges in the FAs that it generates.

Value Description

Default Acknowledges at the envelope level (group for ANSI X12

documents and interchange for UN/EDIFACT documents).

TransactionSet Acknowledges at the transaction set level.

Segment Acknowledges at the segment level.

webMethods Module for EDI Installation and User’s Guide Version 9.12 80
 M
Odd Header
Defining Trading Partner Information

Value Description

Element Acknowledges at the element level.

Note: When you are generating FAs at the element level, be sure
to configure the maximum number of errors to report per
FA transaction. For more information, see "Configuring the
Maximum Number of Transaction Errors" on page 172.

FAGeneration/processDocument EDITPA Variable

Default: All

Note: When you are using non-standard processing, Module for EDI
does not use this EDITPA variable. Instead, it uses the Child Transaction
Rejected Status seing that you set from the Interchange Information Detail
panel of the module’s home page. For more information about accessing
and using this panel, see "Defining Interchange-Level Sender/Receiver Pair
Information" on page 376.
The FAGeneration/processDocument variable indicates how you want Module for EDI
to process a transaction, group, or UN/EDIFACT interchange based on its FA status.
Use this EDITPA variable to define which FA statuses are acceptable and which are
unacceptable.
For acceptable FA statuses, the module processes a transaction, group, or UN/
EDIFACT interchange using its normal processing.
For unacceptable FA statuses, the module processes documents differently.
For more information about how Module for EDI processes documents based on FA
status, see "Defining Actions Module for EDI Takes Based on FA Status" on page 279.
The following table describes the seings for the FAGeneration/processDocument EDITPA
variable, when to use each one, and the acceptable and unacceptable FA statuses based
on the processDocument seing.

Set process When you want to: Acceptable FA Unacceptable FA

statuses statuses
Document to:

All Process all All None

Interchange,
Group, and
Transaction
documents
regardless of
their FA status.

Not Allowed
Only Accepted Process only Accepted
Interchange, Rejected

webMethods Module for EDI Installation and User’s Guide Version 9.12 81
 M
Even Header
Defining Trading Partner Information

Set process When you want to: Acceptable FA Unacceptable FA

statuses statuses
Document to:
Group, and Partially
Transaction Accepted
documents Accepted, But
that have the Errors Were
FA status Noted
"Accepted".

Not Allowed
Not Rejected Process all Rejected
Interchange, Partially
Group, and Accepted
Transaction Accepted, But
documents Errors Were
unless they have Noted
the FA status Accepted
"Rejected".

FAGeneration/generateControlNumber EDITPA Variable

Default: FromInboundDocument

Note: When you are using non-standard processing, Module for EDI
does not use this EDITPA variable. Instead, it uses the Generate Control
Number seing that you set from the Interchange Information Detail panel
of the module’s home page. For more information about accessing and
using this panel, see "Defining Interchange-Level Sender/Receiver Pair
Information" on page 376.
The FAGeneration/generateControlNumber variable defines how Module for EDI is to
generate the control numbers that it uses in the interchange and group headers of the
FAs that it automatically generates.

Value Description

FromInboundDocument Module for EDI uses the control numbers from the
corresponding headers of the inbound EDI document
that the FA acknowledges.
The module uses the control number from the
corresponding header of the inbound EDI document that
the FA acknowledges. For example, if acknowledging
a group, the module uses the control number from the
corresponding group header in the inbound document.

Random Module for EDI randomly generates control numbers for

the interchange and group headers of the FA.

webMethods Module for EDI Installation and User’s Guide Version 9.12 82
 M
Odd Header
Defining Trading Partner Information

Value Description

FromControlNumberTable Module for EDI obtains the control numbers from the
EDIControlNumber table.
The module searches the EDIControlNumber table
for the entry that matches the sender/receiver, EDI
standard/version, production mode, and type (for
example, “Envelope” or group type) identified in the
corresponding interchange or group header of the
inbound EDI document that the FA acknowledges.
The module uses the next control number from this
EDIControlNumber table entry for the FA. It also
increments the value of the next control number in the
table entry, so it reflects the new next control number.

Note: Module for EDI always sets the control number for the transaction (997 or
CONTRL) to 001.

FAGeneration/addGroup EDITPA Variable

Default: false
The FAGeneration/addGroup variable indicates whether you want Module for EDI to add
a functional group to the UN/EDIFACT FA (for example, CONTRL).

Value Description

true Adds a functional group to the FA.

false Does not add a functional group to the FA. This is the default.

FAGeneration/ctlNumberWleadingZero EDITPA Variable

Default: false
The FAGeneration/ctlNumberWleadingZero variable indicates whether you want Module
for EDI to fill the control number field value with leading zeros. For example, if
the control number is 34, and the length of the field is eight, if the FAGeneration/
ctlNumberWleadingZero variable is set to true, the module will set the control number
field value to 00000034.

Value Description

true Adds leading zeros to the control number field value.

false Does not add zeros to the control number field value.

webMethods Module for EDI Installation and User’s Guide Version 9.12 83
 M
Even Header
Defining Trading Partner Information

FAGeneration/RejectionRules/syntaxErrorStatus EDITPA Variable

Default: Rejected

Note: When you are using non-standard processing, Module for EDI
does not use this EDITPA variable. Instead, it uses the Syntax Error Status
seing that you set from the Interchange Information Detail panel of the
module’s home page. For more information about accessing and using this
panel, see "Defining Interchange-Level Sender/Receiver Pair Information"
on page 376.
The FAGeneration/RejectionRules/syntaxErrorStatus variable indicates how you want
Module for EDI to report the syntax error status for a transaction, group, or UN/
EDIFACT interchange.

Value Description

Rejected Use this seing when you want to reject the element (for
example, transaction) because of syntax errors.
Reports the syntax error status as:
“Accepted” when there are no syntax errors
“Rejected” when there are syntax errors

Accepted, Use this seing when you want to know whether there were
But Errors syntax errors, but you do not want to reject the element (for
Were Noted example, transaction) because of syntax errors.
Reports the syntax error status as:
“Accepted” when there are no syntax errors
“Accepted, But Errors Were Noted” when there are syntax
errors

Accepted Use this seing when you do not want to check for syntax errors.
Always reports the syntax error status as “Accepted” regardless
of whether there are any syntax errors.

FAGeneration/RejectionRules/logicalErrorStatus EDITPA Variable

Default: Rejected

Note: When you are using non-standard processing, Module for EDI
does not use this EDITPA variable. Instead, it uses the Logical Error Status
seing that you set from the Interchange Information Detail panel of the
module’s home page. For more information about accessing and using this
panel, see "Defining Interchange-Level Sender/Receiver Pair Information"
on page 376.

webMethods Module for EDI Installation and User’s Guide Version 9.12 84
 M
Odd Header
Defining Trading Partner Information

The FAGeneration/RejectionRules/logicalErrorStatus variable indicates how you want

Module for EDI to report the logical error status.

Value Description

Rejected Reports the logical error status as:

“Accepted” when there are no logical errors
“Rejected” when there are logical errors
Use this seing when you want to reject the element (for
example, transaction) because of logical errors.

Accepted, Reports the logical error status as:

But Errors
“Accepted” when there are no logical errors
Were Noted
“Accepted, But Errors Were Noted” when there are logical
errors
Use this seing when you want to know whether there were
logical errors but do not want to reject the element (for example,
transaction) because of logical errors.

Accepted Always reports the logical error status as “Accepted” regardless

of whether there are any logical errors.
Use this seing when you do not want to check for logical errors.

FAGeneration/RejectionRules/childTransactionRejectedStatus EDITPA Variable

Default: Rejected

Note: When you are using non-standard processing, Module for EDI
does not use this EDITPA variable. Instead, it uses the Child Transaction
Rejected Status seing that you set from the Interchange Information Detail
panel of the module’s home page. For more information about accessing
and using this panel, see "Defining Interchange-Level Sender/Receiver Pair
Information" on page 376.
The FAGeneration/rejectionRules/childTransactionRejectedStatus variable indicates
how you want Module for EDI to report the child transaction rejected status. The
child transaction rejected status indicates whether child elements of a group or UN/
EDIFACT interchange have an FA status of "Rejected". For more information, see "
childTransactionRejectedStatus Parameter" on page 176.

Value Description

Rejected Reports the child transaction rejected status as:

webMethods Module for EDI Installation and User’s Guide Version 9.12 85
 M
Even Header
Defining Trading Partner Information

Value Description

“Rejected” when the FA status of any of the child transactions is

either “Rejected” or “Accepted, But Errors Were Noted”.
“Accepted” when the FA statuses of all the child transactions are
“Accepted”.
Use this seing when the FA status of all of the child transactions
are "Rejected."

Partially Reports the child transaction rejected status as:

Accepted
“Rejected” when the FA statuses of all of the child transactions
are “Rejected”.
“Partially Accepted” when the FA status of at least one child
transaction is “Accepted”, but the FA status of other child
transactions are “Rejected” and/or “Accepted, But Errors Were
Noted”.
“Accepted, But Errors Were Noted” when the FA statuses of the
child transactions are either “Rejected” and/or “Accepted, But
Errors Were Noted” AND no child transactions are “Accepted”.
“Accepted” when the FA statuses of all the child transactions are
“Accepted”.
Use this seing when the FA status of at least one child transaction
is “Accepted” and one is “Rejected”.

Accepted, Reports the child transaction rejected status as:

But Errors
“Rejected” when all the child transactions are “Rejected”.
Were Noted
“Accepted, But Errors Were Noted” when the FA statuses of the
child transactions are “Rejected”, “Accepted, But Errors Were
Noted”, and “Accepted”.
“Accepted” when the FA statuses of all the child transactions are
“Accepted”.
Use this seing when the FA status of at least one child transaction
is “Accepted, But Errors Were Noted”.

FAGeneration/MessageIdentifier/VersionNumber EDITPA Variable

Default: (no default)
The FAGeneration/MessageIdentifier/VersionNumber variable specifies the version number
that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when
automatically generating FAs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 86
 M
Odd Header
Defining Trading Partner Information

FAGeneration/MessageIdentifier/ReleaseNumber EDITPA Variable

Default: (no default)
The FAGeneration/MessageIdentifier/ReleaseNumber variable specifies the release number
that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when
automatically generating FAs.
FAGeneration/MessageIdentifier/ControllingAgency EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/ControllingAgency variable specifies the name of the
controlling agency that the wm.b2b.edi.util:generateFA service should place in the CONTRL
message when automatically generating FAs.
FAGeneration/MessageIdentifier/AssociationCode EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/AssociationCode variable specifies the association
code that the wm.b2b.edi.util:generateFA service should place in the CONTRL message when
automatically generating FAs.
FAGeneration/MessageIdentifier/CodeListDirectoryVersionNumber EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/CodeListDirectoryVersionNumber variable specifies the
version number of the code list directory that the wm.b2b.edi.util:generateFA service should
place in the CONTRL message when automatically generating FAs.
FAGeneration/MessageIdentifier/MessageTypeSubFunctionIdentification EDITPA Variable
Default: (no default)
The FAGeneration/MessageIdentifier/MessageTypeSubFunctionIdentification variable
specifies the code that identifies the sub function of a message type, which the
wm.b2b.edi.util:generateFA service should place in the CONTRL message when
automatically generating FAs.
FAGeneration/DocumentSettings EDITPA Variable
Default: (no default)
The FAGeneration/DocumentSeings variables specify the auto FA generation seings for
different group types (rather than for a sender/receiver pair). Click the Add Row icon to
add the FA generation seings for a group type.
The FAGeneration/DocumentSeings/groupType variable is used to specify the group type.
The remaining variables in FAGeneration/DocumentSeings function exactly the same
as their corresponding FAGeneration variables, except that they pertain to a particular
group type. For more information about seing the FA generation variables for each
group type, see "FAGeneration Variables" on page 80.
Module for EDI processes inbound messages as follows:
When a document is received, the module identifies the TPA associated with
the document and examines the FAGeneration/DocumentSeings/groupType
variable to determine the FA generation seing for the group type of the inbound
message.

webMethods Module for EDI Installation and User’s Guide Version 9.12 87
 M
Even Header
Defining Trading Partner Information

When the group type of the inbound message is listed and autoGenerateFA for
that group type is set to On, the module generates the FA for that particular
group type as per the seings.
When the group type of the inbound message is not listed, the module examines
the FAGeneration/autoGenerateFA variable to determine whether an FA should be
generated as follows:
When the FAGeneration/DocumentSeings/autoGenerateFA variable is set to On,
the module automatically generates an FA for the inbound message.
When the FAGeneration/DocumentSeings/autoGenerateFA variable is set to Per
Document, the module automatically generates an FA based on the indicator
flag in the interchange header (for example, ISA14 or UNB09).
When the FAGeneration/DocumentSeings/autoGenerateFA variable is set to
Off, the module does not generate an FA for the inbound message.

Note: When more than one record exists for a group type, Module for EDI
considers the first record it encounters for the group when generating the
FA.

Important: Do not update and delete elements in the DocumentSeings array at the
same time. Because no single identifier exists for these entries, there is
no way for Module for EDI to identify which element was deleted and
which one was modified. As a result, the message that the module logs
to the Activity Log will not correctly reflect all of the changes that were
performed. You should first delete the element to be deleted, save the
TPA, and then modify the other elements as necessary.

FAGeneration/userFFSchemaForEnvelope EDITPA Variable

Default: (no default)
The FAGeneration/userFFSchemaForEnvelope variable indicates the schema to
be used while generating FA for an inbound message. You can customize
the schema to be used for validating the envelope. When you copy the
wm.b2b.edi.EDIFFSchema:ICS4UNEDIFACTDEF_large schema and modify the copied schema
to customize the schema, there are some limitations. For more information about the
limitations, see the wm.b2b.edi.util:generateFA service description in webMethods Module for
EDI Built-In Services Reference.

ControlNumberManagement Variables
ControlNumberManagement/validateInboundEnvelopeControlNumbers EDITPA Variable
Default: false

Note: When you are using non-standard processing, Module

for EDI does not use this EDITPA variable. Instead, it uses the
Validate inbound envelope control numbers seing that you set from the
Interchange Information Detail panel of the module’s home page. For

webMethods Module for EDI Installation and User’s Guide Version 9.12 88
 M
Odd Header
Defining Trading Partner Information

more information about accessing and using this panel, see "Defining
Interchange-Level Sender/Receiver Pair Information" on page 376.
The ControlNumberManagement/validateInboundEnvelopeControlNumbers variable indicates
whether you want the module to validate and track control numbers in the interchange
headers of inbound EDI documents. For more information, see " Trading Networks
Aributes and EDI Documents" on page 211.

Value Description

true Module for EDI validates and tracks control numbers in the
interchange headers of inbound EDI documents.

false Module for EDI does not validate or track control numbers in the
interchange headers of inbound EDI documents.

ControlNumberManagement/validateInboundGroupControlNumbers EDITPA Variable

Default: false
The ControlNumberManagement/validateInboundGroupControlNumbers variable indicates
whether you want Module for EDI to validate and track control numbers in the group
headers of inbound EDI documents. For more information, see " Trading Networks
Aributes and EDI Documents" on page 211.

Value Description

true Module for EDI validates and tracks control numbers in the group
headers of inbound EDI documents.

false Module for EDI does not validate or track control numbers in the
group headers of inbound EDI documents.

ControlNumberManagement/duplicateControlNumberAction EDITPA Variable

Default: Error & Continue

Note: When you are using non-standard processing, this EDITPA

is only used for duplicate group control numbers. To set the action for
duplicate interchange control numbers, use the Duplicate control number
action seing that you set from the Interchange Information Detail panel
of the Module for EDI home page. For more information about accessing
and using this panel, see "Defining Interchange-Level Sender/Receiver Pair
Information" on page 376.
The ControlNumberManagement/duplicateControlNumberAction variable indicates the
action you want Module for EDI to take when it encounters a duplicate control number
in an inbound document when it is validating interchange and/or group control
numbers.

webMethods Module for EDI Installation and User’s Guide Version 9.12 89
 M
Even Header
Defining Trading Partner Information

For more information, see " Trading Networks Aributes and EDI Documents" on page
211. For more information about each of the following actions, see "Actions Module
for EDI Can Take for Invalid Control Numbers" on page 262.

Value Description

Error & Module for EDI logs the error and then continues to process
Continue the EDI document that contains the invalid control number
normally.

ProcessNormally Module for EDI logs a warning and processes the EDI document
that contains the invalid control number normally.

Reject Module for EDI logs the error and does not process the
document normally. The module does not split the EDI
document. Typically, the module splits an inbound EDI based
on the EDITPA splitOption variable and sends the documents it
splits out to Trading Networks for processing. However, if you
set the action to Reject, the module sends the document without
spliing it to Trading Networks processing rules.
Additionally, Module for EDI sets the Trading Networks custom
aribute EDI Status to Duplicate Control Number. You can use
the custom aribute EDI Status in processing rule criteria. You
should create a processing rule to handle this rejected document.
For information, see "Defining Processing Rules to Handle
Documents with Invalid Control Numbers" on page 265.
You can force processing of the duplicate document later, if you
want. For more information, see "Reprocessing EDI Documents
with Invalid Control Numbers" on page 268.

ControlNumberManagement/outOfSequenceControlNumberAction EDITPA Variable

Default: Error & Continue

Note: When you are using non-standard processing, this EDITPA is

only used for duplicate group control numbers. To set the action for out
of sequence interchange control numbers, use the "out of sequence control
number action" seing that you set from the Interchange Information
Detail panel of the Module for EDI home page. For more information
about accessing and using this panel, see "Defining Interchange-Level
Sender/Receiver Pair Information" on page 376.
The ControlNumberManagement/outOfSequenceControlNumberAction variable indicates the
action you want Module for EDI to take when it encounters an out-of-sequence control
number in an inbound document when it is validating interchange and/or group control
numbers.

webMethods Module for EDI Installation and User’s Guide Version 9.12 90
 M
Odd Header
Defining Trading Partner Information

For more information, see " Trading Networks Aributes and EDI Documents" on page
211. For more information about each of the following actions, see "Actions Module
for EDI Can Take for Invalid Control Numbers" on page 262.

Value Description

Error & Module for EDI logs the error, and then continues to process
Continue the EDI document that contains the invalid control number
normally.

ProcessNormally Module for EDI logs a warning and processes the EDI document
that contains the invalid control number normally.

Reject Module for EDI logs the error and does not process the
document normally. The module does not split the EDI
document. Typically, the module splits an inbound EDI based
on the EDITPA splitOption variable and sends the documents
it splits out to Trading Networks for processing. However, if
you set the action to Reject, Module for EDI sends the document
without spliing it to Trading Networks processing rules.
Additionally, the module sets the Trading Networks custom
aribute EDI Status to Duplicate Control Number. You can use
the custom aribute EDI Status in the processing rule criteria.
You should create a processing rule to handle this rejected
document. For information, see "Defining Processing Rules to
Handle Documents with Invalid Control Numbers" on page
265.
You can force processing of the duplicate document later, if you
want. For more information, see "Reprocessing EDI Documents
with Invalid Control Numbers" on page 268.

ControlNumberManagement/VDA/validateStructure EDITPA Variable

Default: false
The ControlNumberManagement/VDA/validateStructure variable indicates whether
you want Module for EDI to validate the structure of inbound VDA documents. For
more information, see "Defining How to Handle Invalid Control Numbers for VDA
Documents" on page 137.

Value Description

true Module for EDI validates the structure of inbound VDA

documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 91
 M
Even Header
Defining Trading Partner Information

Value Description

false Module for EDI does not validate the structure of inbound VDA
documents.

useReverseRoute Variable
useReverseRoute EDITPA Variable
Default: false
The useReverseRoute variable indicates that when a UNG segment is not present in a UN/
EDIFACT document, the partner IDs for UN/EDIFACT transaction documents will be
determined as follows:

Value Description

false Module for EDI uses the ID and Qualifier portions of the UN/
EDIFACT Sender/Receiver ID to determine the partner ID of the
document. This is the default.

true Module for EDI uses the ReverseRoute Id and Qualifier portions of
the UN/EDIFACT Sender/Receiver ID to determine the partner ID
of the document.

useInternalIds Module for EDI uses the internal identification and internal sub-
identification portions of the UN/EDIFACT Sender/Receiver ID to
determine the partner ID of the document.
The qualifier is the normal Identification code qualifier, but the ID
is constructed as follows:
<Internal identification >[:<internal sub-identification >]
Note that when no sub-identification value is present, this seing
behaves the same way as the true seing.

Note: Once your production system is running, do not change the value of
the useReverseRoute variable. For example, if you send a document with
useReverseRoute set to false, Module for EDI considers your partner
ID to be the values of ID and Qualifier , and it stores these values in
the EDITRACKING table. When you change useReverseRoute to true
and then receive an FA from the receiver, the module tries to use the
ID and ReverseRoute Id values to try to determine the sender of the FA
you received. In this case, the module cannot reconcile the FA with the
document you sent.

webMethods Module for EDI Installation and User’s Guide Version 9.12 92
 M
Odd Header
Defining Trading Partner Information

BatchCriteria Variables
Batching involves grouping together transactions from all queued EDI documents.
You can use the BatchCriteria variables to specify which fields Module for EDI uses to
identify the collections and sub-collections by which to batch transactions.
BatchCriteria/useDefault EDITPA Variable
Default: true
The BatchCriteria/useDefault variable indicates whether to consider only the standard
fields for sorting the documents in the batching process.
When this variable is not present in the TPA, Module for EDI considers only the
standard fields for sorting the documents in the batching process.

Value Description

true Module for EDI considers only the standard fields for sorting the
documents in the batching process.

false Module for EDI considers the standard fields and all the other
fields set to true in UNB, UNG, ISA, and GS records for sorting
the documents in the batching process.

BatchCriteria EDITPA Variable

Default: (no default)
The BatchCriteria variable indicates which fields should be considered during the sorting
of documents in the batch process.
When the BatchCriteria/useDefault variable is set to true, Module for EDI considers only
the standard fields for sorting the documents in the batching process.
The module considers the following standard fields for sorting the EDIFACT documents
to a collection area.

Value Description

UNB/UNB02/ The sender qualifier of the EDIFACT document.

S00202

UNB/UNB02/ The sender ID of the EDIFACT document.

S00201

UNB/UNB03/ The receiver qualifier of the EDIFACT document.

S00302

webMethods Module for EDI Installation and User’s Guide Version 9.12 93
 M
Even Header
Defining Trading Partner Information

Value Description

UNB/UNB03/ The receiver ID of the EDIFACT document.

S00301

UNB/UNB11 The mode of the EDIFACT document.

UNG/UNG07/ The version of the EDIFACT document.

S00802

The module considers the following standard fields for sorting the X12 documents to a
collection area.

Value Description

ISA/ISA05 The sender qualifier of the X12 document.

ISA/ISA06 The sender ID of the X12 document.

ISA/ISA07 The receiver qualifier of the X12 document.

ISA/ISA08 The receiver ID of the X12 document.

ISA/ISA15 The mode of the X12 document.

ISA/ISA12 The version of the X12 document.

The module considers the following standard fields for sorting the EDIFACT documents
to a sub-collection.

Value Description

UNG/UNG02/ The group sender of the EDIFACT document.

S00601

UNG/UNG03/ The group receiver of the EDIFACT document.

S00701

UNG/UNG06 The control agency code of the EDIFACT document.

UNG/UNG07/ The message version number of the EDIFACT document.

S00801

webMethods Module for EDI Installation and User’s Guide Version 9.12 94
 M
Odd Header
Defining Trading Partner Information

Value Description

UNG/UNG07/ The message release number of the EDIFACT document.

S00802

UNG/UNG07/ The message association assigned number code of the

S00803 EDIFACT document.

UNG/UNG01 The group type of the EDIFACT document.

The module considers the following standard fields for sorting the X12 documents to a
sub-collection.

Value Description

GS/GS02 The group sender of the X12 document.

GS/GS03 The group receiver of the X12 document.

GS/GS08 The version of the X12 document.

GS/GS01 The group type of the X12 document.

When the BatchCriteria/useDefault variable is set to false, in addition to using the

standard fields, Module for EDI considers all the other fields set to true in UNB,
UNG, ISA and GS records for sorting the documents. For example, if you want to
use the routing address UNB/UNB03/S00303 in addition to the standard fields in
the sorting criteria, set BatchCriteria/UNB/UNB03/S00303 to true.
BatchCriteria/UNB record fields identify collection areas for EDIFACT
documents
BatchCriteria/ISA record fields identify collection areas for X12 documents
BatchCriteria/UNG record fields identify sub-collection areas for EDIFACT
documents
BatchCriteria/GS record fields identify sub-collection areas for X12 documents

Note: Do not include S0010, the syntax identifier field, in the sorting process.

EDITransportMedia Variable
EDITransportMedia EDITPA Variable
Default: FTP
The EDITransportMedia variable indicates the protocol (for example, HTTP, HTTPS,
FTP, AS1, and AS2) to be used to transport the EDI documents. Module for EDI uses this
variable to display information on the Summary of EDI Activity by Transport Media and

webMethods Module for EDI Installation and User’s Guide Version 9.12 95
 M
Even Header
Defining Trading Partner Information

EDI Volume by Transport Media reports, if you have purchased the appropriate EDI
reporting license.

Note: Beginning with Integration Server 9.12, the EDITransportMedia variable is

obsolete.

persistOriginalEnvelope Variable

persistOriginalEnvelope EDITPA Variable

Default: false
The persistOriginalEnvelope variable indicates whether to persist the original incoming
EDI envelope in Trading Networks before Module for EDI starts processing the EDI
envelope.
When the module receives an EDI document from a partner, it processes the transactions
first, the groups next, and the envelope last. While processing a large document, if the
module fails to process the entire inbound document, it cannot retrieve the original EDI
document received from the partner because the envelope is processed last. Module
for EDI cannot track these unprocessed inbound documents because the original EDI
document received from the partner is not persisted in Trading Networks by default.
When you choose to persist the original incoming EDI document in Trading Networks
before Module for EDI starts processing the document, even if the module fails to
process the entire document, you can track the original document in Trading Networks
and reprocess it in Module for EDI.
If persisting each and every EDI document in Trading Networks before Module for
EDI starts processing it slows down your system performance, you can configure the
module to process the envelope first by seing the documentPersistOrder variable to
EnvelopeFirst. In this case, the module does not persist the original incoming EDI
document in Trading Networks. If Module for EDI fails to process the entire inbound
document, you can still retrieve the details of the original EDI document received from
the partner because the module processes the envelope first and submits it to Trading
Networks. For more information, see "documentPersistOrder Variable" on page 97.

Value Description

true Before processing the document, Module for EDI persists the
original incoming EDI document in Trading Networks with the
following aribute values:
Processing Status = NEW
User Status = Original EDI Envelope
EDI Status = Persisted

When the module does not completely process the inbound

document, the module will not delete the original document
persisted in Trading Networks. Documents containing the
aribute values mentioned above identify that the corresponding

webMethods Module for EDI Installation and User’s Guide Version 9.12 96
 M
Odd Header
Defining Trading Partner Information

Value Description
document was not processed completely. Resubmit these original
documents to Trading Networks for reprocessing.
When the module successfully processes the inbound document,
that is, after all the transactions, groups, and envelope of the
document are processed, the additional document persisted in
Trading Networks is deleted.

Note: When the value of the documentPersistOrder EDITPA

variable is EnvelopeFirst, Module for EDI does not persist
the original EDI envelope in Trading Networks before
processing the document even if you set the value of the
persistOriginalEnvelope variable to true.

false Module for EDI does not persist the original inbound EDI
envelope in Trading Networks before processing the document.
This is the default.

documentPersistOrder Variable

documentPersistOrder EDITPA Variable

Default: EnvelopeLast
The documentPersistOrder variable indicates the order in which the EDI documents are
submied to Trading Networks.

Value Description

EnvelopeLast Module for EDI submits the envelope of the EDI document to
Trading Networks after submiing the transactions and groups.
This is the default.
Module for EDI submits the EDI documents to Trading Networks
in the following order:
1. Transactions
2. Groups
3. Envelope
When the persistOriginalEnvelope variable is set to false, if
the module fails while submiing large EDI documents, you
cannot retrieve the original EDI document received from the
partner because the module submits the envelope last. For more

webMethods Module for EDI Installation and User’s Guide Version 9.12 97
 M
Even Header
Defining Trading Partner Information

Value Description
information, see "persistOriginalEnvelope Variable" on page
96.

EnvelopeFirst Module for EDI submits the envelope of the EDI document to
Trading Networks before submiing the groups and transactions.
The module submits the EDI documents to Trading Networks in
the following order:
1. Envelope
2. Groups
3. Transactions
Even though the persistOriginalEnvelope variable is set to true,
the module does not persist the original inbound EDI document
in Trading Networks before processing the document. Because
the module submits the envelope first, you can track the original
inbound EDI document at any time until processing is complete.

LateFA Variables
Use the LateFA variables for tracking the late functional acknowledgments for a partner
pair. For more information, see "Tracking Late Functional Acknowledgments" on page
185.
LateFA/LateFATime EDITPA Variable
Default: (no default)
The LateFA/LateFATime variable indicates the time in minutes by which Trading
Networks must receive the FA for a partner pair. When Trading Networks receives
the FA late, Module for EDI sets the Late FA aribute of the original document to Y in
Trading Networks.
For a partner pair, Module for EDI checks the Trading Networks database to find
the time difference between the time the document was sent and the time the sender
receives the FA. When the time difference is more than the value of the LateFA/
LateFATime variable, the module sets the Late FA aribute of the original document to
Y in Trading Networks. When the FA is not late, the Late FA aribute of the original
document is set to N.
When the value of the LateFA/LateFATime variable is 0 or a negative integer, the
module does not consider any FA as late for the partner pair.
When the value of the LateFA/LateFATime variable is a positive integer, if Trading
Networks receives the FA later than the value of the LateFA/LateFATime variable,
the module sets the Late FA aribute of the original document in Trading
Networks to Y. If Trading Networks receives the FA within the time specified by
the LateFA/LateFATime variable, the module sets the Late FA aribute to N.

webMethods Module for EDI Installation and User’s Guide Version 9.12 98
 M
Odd Header
Defining Trading Partner Information

When the value of the LateFA/LateFATime variable is not set, the Late FA
aributes of the original documents are not set.
LateFA/LateFAForX12Group EDITPA Variable
Default: (no default)
The LateFA/LateFAForX12Group variable defines the late FA seing for the X12 groups
specified in the LateFA/LateFAForX12Group/groupType variables.

Note: Module for EDI does not support tracking of late FAs for UN/EDIFACT
groups.

LateFA/LateFAForX12Group/groupType EDITPA Variable

Default: (no default)
The LateFA/LateFAForX12Group/groupType variables indicate the X12 groups used for
tracking the late FAs.
When the original document does not contain any of the groups specified in LateFA/
LateFAForX12Group/groupType variables, Module for EDI tracks the late FAs at the
partner pair level by considering the time indicated in the LateFA/LateFATime variable.
LateFA/LateFAForX12Group/LateFATime EDITPA Variable
Default: (no default)
The LateFA/LateFAForX12Group/LateFATime variable indicates the time in minutes by
which Trading Networks must receive the FA for the specified group. When Trading
Networks receives the FA late for the group, Module for EDI sets the Late FA aribute to
Y for all the transactions in that group in Trading Networks.
For a group indicated in the LateFA/LateFAForX12Group/groupType variable of a partner
pair, the module checks the Trading Networks database to find the time difference
between the time the Group document was sent and the time the sender receives the
FA. When the time difference is more than the value of the LateFA/LateFAForX12Group/
LateFATime variable for the specified group, the module sets the Late FA aribute to Y
for all the transactions of the specified group in Trading Networks. When the FA for the
group is not late, the Late FA aribute is set to N for all the transactions in that group.
After Module for EDI sets the Late FA aribute for a document for that group, the
module does not consider the duplicate FAs that Trading Networks may receive later.
When the value of the LateFA/LateFAForX12Group/LateFATime variable is 0 or
less, the module does not consider any FA as late for the group specified by the
LateFA/LateFAForX12Group/groupType variable.
When the value of the LateFA/LateFAForX12Group/LateFATime variable is a
positive integer, the module sets the Late FA aribute of the original document to
Y if Trading Networks receives the FA late for the group specified by the LateFA/
LateFAForX12Group/groupType variable.
When the value of the LateFA/LateFAForX12Group/LateFATime variable is not set,
the Late FA aributes of the specified Group documents are not set.

webMethods Module for EDI Installation and User’s Guide Version 9.12 99
 M
Even Header
Defining Trading Partner Information

X12TA1Generation Variables
The X12TA1Generation variables indicate the seings for interchange acknowledgment
(TA1).
X12TA1Generation/autoGenerateTA1 EDITPA Variable
Default: Off
The X12TA1Generation/autoGenerateTA1 variable indicates whether you want the Module
for EDI to automatically generate TA1s for an inbound EDI document.

Value Description

On Always automatically generates TA1s for inbound EDI documents

Off Never automatically generates TA1s for inbound EDI documents

X12TA1Generation/Rules EDITPA Variable

The X12TA1Generation/Rules variable defines the rule seings for the TA1s the module
generates.
X12TA1Generation/Rules[]/Name EDITPA Variable
Default: (no default)
The X12TA1Generation/Rules[]/Name variable specifies the name of the TA rule.
X12TA1Generation/Rules[]/ErrorCode EDITPA Variable
Default: (no default)
The X12TA1Generation/Rules[]/ErrorCode variable indicates the error code displayed
when rule validation fails.
X12TA1Generation/Rules[]/Description EDITPA Variable
Default: (no default)
The X12TA1Generation/Rules[]/Description variable describes the validation rule.
X12TA1Generation/Rules[]/Enabled EDITPA Variable
Default: yes
The X12TA1Generation/Rules[]/Enabled variable indicates whether the validation rule is
applied while generating the TA1.

Value Description

yes The rule is applied while generating the TA1.

no The rule is not applied while generating the TA1.

webMethods Module for EDI Installation and User’s Guide Version 9.12 100
 M
Odd Header
Defining Trading Partner Information

X12TA1Generation/Rules[]/Order EDITPA Variable

Default: (no default)
The X12TA1Generation/Rules[]/Order indicates the chronological order in which rules
are validated during TA1 generation. The lower the value, the higher the priority. Once
validation of one rule fails, the TA1 is generated with the error that corresponds to the
failed rule.
X12TA1Generation/Rules[]/Type EDITPA Variable
Default: E
The X12TA1Generation/Rules[]/Type variable indicates the valid values that can be used
to define the TA1 status.

Value Description

A The transmied interchange envelope was received without errors.

R The transmied interchange envelope was rejected.

E The transmied interchange envelope was received and accepted, but

errors were noted.

X12TA1Generation/Rules[]/validatorClass EDITPA Variable

Default: (no default)
The X12TA1Generation/Rules[]/validatorClass variable indicates the fully qualified java
class name that Module for EDI uses internally while validating rules.

EANCOMAUTACK Variables
The EANCOMAUTACK variables indicate the configurations necessary for generating a
secure Authentication and Acknowledgement (AUTACK) message.
Use the following EANCOMAUTACK variables to configure the seings for generating
or processing the AUTACK messages:
EANCOMAUTACK/autoGenerateAUTACK EDITPA Variable
Default: off
The EANCOMAUTACK/autoGenerateAUTACK variable indicates whether the AUTACK
message containing the digital signatures are generated automatically.

Value Description

on Always generates the AUTACK message automatically.

Off Never generates the AUTACK message automatically.

webMethods Module for EDI Installation and User’s Guide Version 9.12 101
 M
Even Header
Defining Trading Partner Information

EANCOMAUTACK/processInboundAUTACK EDITPA Variable

Default: off
The EANCOMAUTACK/processInboundAUTACK variable indicates whether the
AUTACK message containing the digital signatures are processed automatically.

Value Description

on Always processes the inbound AUTACK message automatically.

Off Never processes the inbound AUTACK message automatically.

EANCOMAUTACK/configuration EDITPA Variable

Default: (no default)
The EANCOMAUTACK/configuration variables define the configuration seings required
to generate the AUTACK message.
EANCOMAUTACK/configuration/signingScope EDITPA Variable
Default: Interchange
The EANCOMAUTACK/configuration/signingScope variable allows you to sign an entire
Interchange or Envelope, an entire Group, or each Transaction individually.

Value Description

Interchange Signs data from the UNB through UNZ segments,

excluding the UNA segment.

Group Signs data from the UNG through UNE segments.

Transaction Signs data from the UNH through UNT segments.

EANCOMAUTACK/configuration/digestAlgorithm EDITPA Variable

Default: SHA1
The EANCOMAUTACK/configuration/digestAlgorithm variable indicates the type of hash
algorithm used for generating hash before signing the AUTACK message.

Value Description

SHA1 Generates 160-bit hash using the SHA1 algorithm.

MD5 Generates 128-bit hash using the MD5 algorithm.

RIPEMD160 Generates 160-bit hash using the RIPEMD160 algorithm.

webMethods Module for EDI Installation and User’s Guide Version 9.12 102
 M
Odd Header
Defining Trading Partner Information

EANCOMAUTACK/configuration/paddingAlgorithm EDITPA Variable

Default: ISO9796-2
The EANCOMAUTACK/configuration/paddingAlgorithm variable indicates the type of key
algorithm that checks the robustness of the digital signature generated by the AUTACK
message.

Value Description

ISO9796-2 Uses ISO9796-2 padding algorithm before signing the AUTACK

message.

EANCOMAUTACK/configuration/signingAlgorithm EDITPA Variable

Default: RSA
The EANCOMAUTACK/configuration/signingAlgorithm variable indicates the type of
signing algorithm for generating the digital signature.

Value Description

RSA Generates the digital signatures using the RSA algorithm.

EANCOMAUTACK/configuration/filteringAlgorithm EDITPA Variable

Default: Hexadecimal
The EANCOMAUTACK/configuration/filteringAlgorithm variable indicates the type of
filtering algorithm that converts digital signatures from a binary value to a string.

Value Description

Hexadecimal Converts an 8-bit binary value into a hexadecimal string of

two characters.

EANCOMAUTACK/configuration/characterSetEncoding EDITPA Variable

Default: ASCII
The EANCOMAUTACK/configuration/characterSetEncoding variable identifies the type of
character set in which the EANCOM structure is encoded when security algorithms are
applied to the generated the digital signature.

Value Description

ASCII American Standard Code for Information Interchange (7-bit

ASCII standard).

ISO8859-1 ISO/IEC 8859 series of the 8-bit ASCII standard.

webMethods Module for EDI Installation and User’s Guide Version 9.12 103
 M
Even Header
Defining Trading Partner Information

Value Description

ISO8859-15 ISO/IEC 8859 series of the 8-bit ASCII standard.

Cp850 Encoding schema defined by the code page.

Cp500 Encoding schema defined by the EBCDIC code page.

Note: Ensure that you perform the following configurations

To generate or process the AUTACK message, configure the Sign/
Verify certificate in the partner profile. Also, ensure that you install the
EANCOM 1 AUTACK document type to generate the AUTACK message.
For more information, see "Defining TN EDI Document Types" on page
37.
Set EDIDisableCONTRLVersion = true to enable the recognition of the
AUTACK message in Trading Networks.
If you use the EDI Batch aribute for an EANCOM document with
autoGenerateAUTACK = on, then you should also set the extended
criteria, EDI Outbound FA to true in the corresponding processing rule of the
EDI Batch aribute. For more information, see "Defining Processing Rules to
Batch EDI Documents" on page 331.

webMethods Module for EDI Installation and User’s Guide Version 9.12 104
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

4   Defining Trading Partner Information When Using

TRADACOMS

■ Overview ..................................................................................................................................... 106

■ Defining Trading Partner Profiles When Using TRADACOMS .................................................. 107
■ Defining EDI Trading Partner Agreements When Using TRADACOMS .................................... 109

webMethods Module for EDI Installation and User’s Guide Version 9.12 105
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

Overview
To process documents when you are using webMethods Trading Networks (Trading
Networks) with webMethods Module for EDI (Module for EDI), you must define both
Trading partner profiles and trading partner agreements (EDITPAs) for the partners
that will send and receive the EDI documents you expect to process. Module for EDI
processes the transmission, its batch, and its file using seings that you define for the
transmission sender/receiver pair.
For more information about how Module for EDI processes inbound documents, see
webMethods Module for EDI Concepts Guide.

Partner Information You Need to Define When Using TRADACOMS

The following table lists the information you must define for sender/receiver pairs:

For... Define...

Transmission Trading partner profiles for each transmission sender and

sender/receiver receiver. For more information, see "Defining Trading Partner
pairs Profiles When Using TRADACOMS" on page 107.

Tailoring how Default EDITPA that defines the seings that you want to
Module for use for most partner pairs.
EDI processes
Partner-specific EDITPA for each transmission sender/
documents
receiver pair for which you want to override the seings in
the default EDITPA.
For more information, see "Defining EDI Trading Partner
Agreements When Using TRADACOMS" on page 109.

How Module Whether to validate control numbers.

for EDI validates
Actions that Module for EDI takes when encountering an
inbound control
invalid control number.
numbers
Control number validation seings (that is, maximum,
minimum, increment, and window).

Note: The term control number is used in the non-

TRADACOMS EDI standards to refer to a number
in an EDI document header. This number is used
to validate and order the documents exchanged
between trading partners. A control number in a
non-TRADACOMS document is equivalent to the

webMethods Module for EDI Installation and User’s Guide Version 9.12 106
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

For... Define...
transmission reference number in the STX and BAT
segments of TRADACOMS documents.
Regardless of whether your EDI standard includes
control numbers or transmission reference numbers,
you define them the same way in Trading Networks;
the only difference is in the terminology. For
simplicity, Trading Networks and Module for EDI
use the term control number to mean either control
number or transmission reference number.

For more information, see "Defining Control Number

Information for Trading Partners" on page 123.

For more information about how Module for EDI works with Trading Networks, see
webMethods Module for EDI Concepts Guide. For more information about profiles and
TPAs and how Trading Networks uses them, see the Trading Networks Concepts Guide for
your release.

Defining Trading Partner Profiles When Using TRADACOMS

To identify the trading partners with whom you want to exchange documents, set up
profiles. You must define profiles for:
Your own corporation, if you have not already done so. This is referred to as the
Enterprise profile in Trading Networks.
Your Trading partners.
When you define profiles, you need to specify the external IDs that your partners use in
their documents. The external IDs correspond to the standard EDI ID qualifiers.
Module for EDI automatically installs two external IDs that Trading Networks can use
to process TRADACOMS documents: Tradacoms Code and Tradacoms Name. For more
information, see "External ID Types When Using TRADACOMS" on page 107.
You create profiles using My webMethods. For steps to create profiles, see the
webMethods Trading Networks Administrator’s Guide for your release.

External ID Types When Using TRADACOMS

The sender and receiver of a TRADACOMS transmission must be identified in Trading
Networks. To identify senders and receivers, Trading Networks can use information in
the transmission's STX segment to look up a partner profile for the sender and receiver
of a document. That information will be associated with the BizDocEnvelope created for
the transmission.

webMethods Module for EDI Installation and User’s Guide Version 9.12 107
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

The external ID types that Module for EDI automatically installs (Tradacoms Code and
Tradacoms Name) correspond to the STX segment's FROM and UNTO data elements.
Each data element is a composite with two optional fields: Code and Name. Either or
both of these fields can be used to identify the sender or receiver of a TRADACOMS
transmission.
When Trading Networks examines partner profiles to look up a sender or receiver, the
following four possibilities can result, depending on which fields have values:

Code present? Name present? Result

No No Unknown trading partner

Yes No Uses Code to look up trading partner

No Yes Uses Name to look up trading partner

Yes Yes Uses both Name and Code to look up trading

partner

For example:

If the sender's Then the sender will be the trading partner with...
FROM data element
contains...

Code=ABC The external ID type Tradacoms Code defined as ABC.

-and-
Name field is empty

Code field is empty The external ID type Tradacoms Name defined as ABC.
-and-
Name=ABC

Code field=ABC Both of the following:

-and- The external ID type Tradacoms Code defined as ABC and
Name field=XYZ The external ID type Tradacoms Name defined as XYZ

Note: To use only Tradacoms Code to look up partners

when both Code and Name have values, see
"Optionally Configuring the External ID Types
When Using TRADACOMS" on page 109.

webMethods Module for EDI Installation and User’s Guide Version 9.12 108
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

Optionally Configuring the External ID Types When Using TRADACOMS

Perform the following procedure to configure the Tradacoms Code and Tradacoms Name
external ID types. When you configure these external ID types, Module for EDI updates
the configuration in memory (so the changes take effect immediately) and in the
WmEDI/config/properties.cnf file.

To configure the external ID types when using TRADACOMS

1. In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2. Add the following properties as required:

Property Description

Overrides the default Tradacoms Code

wm.edi.tradacoms.CodeExternalIDType=value
external ID.

Overrides the default Tradacoms Name

wm.edi.tradacoms.NameExternalIDType=value
external ID.

wm.edi.tradacoms.CodeOnly=true When both the Code and Name fields have

values, overrides Trading Networks from
using them both to look up a trading
partner. Instead, Trading Networks uses
only Code to look up a trading partner.

Note: If CodeOnly=true is set and the Code field is blank, Trading Networks
looks up a trading partner as described in the table in "External ID Types
When Using TRADACOMS" on page 107.

3. Click Save.

Defining EDI Trading Partner Agreements When Using

TRADACOMS
An EDI trading partner agreement (EDITPA) is a set of variables that you provide to
tailor how Module for EDI exchanges documents between two trading partners. Module
for EDI supports partner-specific EDITPAs and a single default EDITPA.
A partner-specific EDITPA has a specific sender and receiver associated with it and
contains variables that Module for EDI uses only when processing documents that
match the specified sender/receiver pair.
A default EDITPA has a sender and receiver set to "unknown" and contains variables
used by all trading partners when partner-specific information is not available.

webMethods Module for EDI Installation and User’s Guide Version 9.12 109
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

During processing, Module for EDI first aempts to find values in the partner-specific
EDITPA for the sender/receiver pair of a document. If a partner-specific EDITPA does
not exist for the sender/receiver pair, or the value in the partner-specific EDITPA is null
or empty, Module for EDI uses the value from the default EDITPA.

Modifying the Default EDITPA When Using TRADACOMS

The seings in the default EDITPA should meet the requirements of the majority of your
trading partner relationships.
The first time the WmEDIforTN package is loaded into Integration Server, Module for
EDI automatically creates the default EDITPA in Trading Networks. You can modify the
default EDITPA when the Agreement Status is Agreed and the Data Status is Modifiable, or
when the Agreement Status is Proposed.

Note: Do not disable the default EDITPA. If you do not specify a value for a TPA
parameter, Module for EDI uses the value from the default EDITPA.

You modify the default EDITPA using My webMethods. For instructions, see the
webMethods Trading Networks Administrator’s Guide for your release.
When you modify the default EDITPA, the following seings (visible on the
Administration > Integration > B2B > Trading Partner Agreements page) must be
maintained.

For this field... Keep this setting...

Sender Unknown

Receiver Unknown

Agreement ID EDITPA

IS Document Type wm.b2b.editn.TPA:EDITPA

You can modify the values for the variables in the

wm.b2b.editn.TPA:EDITPA IS document type. To set the values
for the variables in the wm.b2b.editn.TPA:EDITPA IS document
type, see the description of the variables in "TRADACOM
Variables" on page 112.

Defining a Partner-Specific EDITPA When Using TRADACOMS

You only need to create partner-specific EDITPAs if you have one or more sender/
receiver pairs that require seings that are different from those you specify in the
default EDITPA. When creating a partner-specific EDITPA, you have to specify only

webMethods Module for EDI Installation and User’s Guide Version 9.12 110
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

the information that is different from the defaults. Define partner-specific EDITPAs for
transmission-level sender/receiver pairs.

Note: You can disable partner-specific EDITPAs. When you disable a partner-
specific EDITPA, Module for EDI functions as if the partner-specific EDITPA
does not exist. That is, Module for EDI uses the values in the default EDITPA.

You create a partner-specific EDITPA using My webMethods. You can create a partner-
specific EDITPA in one of the following three ways:

Duplicate the default EDITPA and change variable values

Duplicate another similar partner-specific EDITPA and change variable values
Create an EDITPA from scratch
For instructions on how to create TPAs, see the webMethods Trading Networks
Administrator’s Guide for your release.
When creating a partner-specific EDITPA, specify the following on the
Administration > Integration > B2B > Trading Partner Agreements page:

For this field... Specify...

Sender The name of the sender from the partner-specific sender/

receiver pair.

Receiver The name of the receiver from the partner-specific sender/

receiver pair.

Agreement ID EDITPA

IS Document Type wm.b2b.editn.TPA:EDITPA

To set the values for the variables in wm.b2b.editn.TPA:EDITPA,

see the description of the variables in "TRADACOM
Variables" on page 112.

Initialization A service that you created to define the default values for the
Service wm.b2b.editn.TPA:EDITPA IS document type. (Or, leave this field
blank.)
It is recommended that you do not use the initialization
service ( wm.b2b.editn.TPA:initService) that is provided with
Module for EDI. The wm.b2b.editn.TPA:initService service is used
to populate the values of the default EDITPA.

webMethods Module for EDI Installation and User’s Guide Version 9.12 111
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

wm.b2b.editn.TPA:EDITPA IS Document Type When Using

TRADACOMS
The descriptions and default values for the variables of the wm.b2b.editn.TPA:EDITPA
IS document type are listed below. If no value is specified in the partner-specific
EDITPA, nor the default EDITPA, Module for EDI uses a default value. The
wm.b2b.editn.TPA:initService initialization service defines these default values in the default
EDITPA when it is executed.
Use the variable descriptions to help you determine the appropriate value to set in the
EDITPA. When creating partner-specific EDITPAs, remember to only specify values for
the variables that you want to override in the default EDITPA. Leave the values blank in
the variables for which the default value applies.

Tip: It is helpful to have an understanding about how Module for EDI processes
EDI documents to understand how Module for EDI uses the variables in the
EDITPA. For more information, see webMethods Module for EDI Concepts Guide.

TRADACOM Variables
TRADACOMS/splitOption EDITPA Variable
Default: File
This variable indicates how you want Module for EDI to split a transmission segment
within an EDI document. The module creates the following types of documents from a
transmission segment, based on the value of this variable:
Transmission documents that contain the single transmission envelope along
with its batch segment and file
Batch documents that contain a single batch segment along with its files
File documents that contain a single file
If you want to perform processing on the file in an inbound document, set splitOption
to File or Batch. If you are sending the inbound EDI document through Trading
Networks to simply deliver it to a destination without processing the file, set splitOption
to Transmission.

Note: Validation errors can prevent Module for EDI from spliing a transmission
document. The kinds of errors that will cause splitOption to fail are listed
in "Errors that Prevent the Spliing of Transmissions" on page 120.
The following table lists the possible values for this variable and the types of documents
that Module for EDI creates for each value.

Value Description

Transmission Creates only the Transmission document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 112
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

Value Description

Batch Creates the Transmission document and a Batch document for

each batch segment in the transmission segment.

File Creates the Transmission document, a Batch document for each

batch segment in the transmission segment, and a File document
for each file in the transmission segment.
This is the initial value for the splitOption variable in the default
EDITPA.

TRADACOMS/storageOption EDITPA Variable

Default: One Message
If a File document contains many detail messages, My webMethods may not be able
to display all of the content parts. In this case, you may want to consider using an
alternative storage option.

Value Description

One Message Default. For a TRADACOMS File, Trading Networks creates one
File document type that contains all the detail messages contained
in the file.

N Messages Instead of storing all detail messages in a single File document

type, Trading Networks creates a separate File document type for
each detail message. For more information, see "Storage Options
for File Document Types" on page 118.

Note: When you use the Monitoring > Integration > B2B > Transaction page to
view transactions, and the value of storageOption is One Message, the
control number displayed is the control number in the FIL segment. If
the value of storageOption is N Messages, the control number displayed is
taken from the sequence number in the MHD segment.

TRADACOMS/ControlNumberManagement/validateInboundTransmissionControlNumbers EDITPA
Variable
Default: false
This variable indicates whether you want Module for EDI to validate and track control
numbers in the transmission headers of inbound EDI documents.

Value Description

true Validates and tracks control numbers in the transmission headers

of inbound EDI documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 113
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

Value Description

false Does not validate or track control numbers in the transmission

headers of inbound EDI documents.

TRADACOMS/ControlNumberManagement/validateInboundBatchControlNumbers EDITPA Variable

Default: false
This variable indicates whether you want Module for EDI to validate and track control
numbers in the batch headers of inbound EDI documents.

Value Description

true Validates and tracks control numbers in the batch headers of

inbound EDI documents.

false Does not validate or track control numbers in the batch headers of
inbound EDI documents.

TRADACOMS/ControlNumberManagement/validateInboundFileControlNumbers EDITPA Variable

Default: false
This variable indicates whether you want Module for EDI to validate and track control
numbers in the file headers of inbound EDI documents.

Value Description

true Validates and tracks control numbers in the file headers of

inbound EDI documents.

false Does not validate or track control numbers in the file headers of
inbound EDI documents.

TRADACOMS/ControlNumberManagement/duplicateControlNumberAction EDITPA Variable

Default: Error & Continue
This variable indicates the action you want Module for EDI to take when it encounters
a duplicate control number in an inbound document when it is validating transmission
and/or batch control numbers.
For more information about each of the following actions, see "Actions Module for EDI
Can Take for Invalid Control Numbers" on page 262.

webMethods Module for EDI Installation and User’s Guide Version 9.12 114
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

Value Description

Error & Module for EDI logs the error and then continues normal
Continue processing of the EDI document that contains the invalid control
number.

ProcessNormally Module for EDI logs a warning and then continues normal
processing of the EDI document that contains the invalid control
number.

Reject Module for EDI logs the error and then sends the document to
Trading Networks without spliing it. (Typically, Module for
EDI splits an inbound EDI based on the EDITPA splitOption
variable and sends the split documents to Trading Networks for
processing.)
Additionally, Module for EDI sets the Trading Networks custom
aribute EDI Status to Duplicate Control Number. You can use
the custom aribute EDI Status in processing rule criteria. You
should create a processing rule to handle this rejected document.
For information, see "Defining Processing Rules to Handle
Documents with Invalid Control Numbers" on page 265.
If desired, you can force a duplicate document to be processed
later. For more information, see "Reprocessing EDI Documents
with Invalid Control Numbers" on page 268.

TRADACOMS/ControlNumberManagement/outOfSequenceControlNumberAction EDITPA Variable

Default: Error & Continue
This variable indicates the action you want Module for EDI to take when it encounters
an out-of-sequence control number in an inbound document while it is validating
transmission and/or batch control numbers.
For more information about each of the following actions, see "Actions Module for EDI
Can Take for Invalid Control Numbers" on page 262.

Value Description

Error & Logs the error; then continues normal processing of the EDI
Continue document that contains the invalid control number.

ProcessNormally Logs a warning and continues normal processing of the EDI

document that contains the invalid control number.

Reject Logs the error and sends the document to Trading Networks
without spliing it. Typically, Module for EDI splits an

webMethods Module for EDI Installation and User’s Guide Version 9.12 115
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

Value Description
inbound EDI based on the EDITPA splitOption variable and
sends the split documents to Trading Networks for processing.
Additionally, the module sets the Trading Networks custom
aribute EDI Status to Out of Sequence Control Number. You
can use the custom aribute EDI Status in processing rule
criteria. You should create a processing rule to handle this
rejected document. For information, see "Defining Processing
Rules to Handle Documents with Invalid Control Numbers" on
page 265.
You can later force processing of the out-of-sequence document
if you want. For more information, see "Reprocessing
Documents with Out-of-Sequence Control Numbers" on page
269.

TRADACOMS/enforceApplicationReference EDITPA Variable

Default: false
This variable is used to validate that the contents of the APRF field in the STX segment
match the file type of the messages in the transmission.

Value Description

true Validates that the APRF field contents match the file type of the
messages.

false Does not perform APRF validation.

TRADACOMS/OutBound/createReconciliationMessage EDITPA Variable

Default: false
This variable indicates whether Module for EDI creates a reconciliation (RSGRSG)
message in outbound batched EDI documents.

Value Description

true Creates an RSGRSG message at the end of the transmission for the
batched TRADACOMS document.

false Does not create an RSGRSG message.

TRADACOMS/OutBound/recipientTransmissionReference EDITPA Variable

Default: false
(optional) This variable indicates whether Module for EDI returns the receiver's
transmission reference in outbound EDI documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 116
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

Value Description

true Returns the receiver's transmission reference in outbound EDI

documents.

false Does not return the receiver's transmission reference.

TRADACOMS/OutBound/applicationReference EDITPA Variable

(optional) This variable returns the value of the receiver's application reference field (the
APRF field in the STX segment) in outbound EDI documents.

Note: This variable is ignored if the TRADACOMS/Outbound/

applicationReferenceFromFile variable is set to true.

TRADACOMS/OutBound/applicationReferenceFromFile EDITPA Variable

Default: false
(optional) This variable indicates whether Module for EDI returns the value of the
receiver's application reference field (the APRF field in the STX segment) in outbound
EDI documents. In this case, the value of the APRF field is the file type specified in the
transmission. For example, if the transmission contains ORDERS files, the value of the
APRF field will be ORDHDR.

Value Description

true Returns the value of the APRF field, which is the file type
specified in the transmission, for example, ORDHDR.

false Uses the value specified for the TRADACOMS/Outbound/

applicationReference variable.

TRADACOMS/persistMultipleDocEnvelope EDITPA Variable

Default: true
This variable indicates whether Module for EDI saves the original EDI document in
the Trading Networks database. The original EDI document that Trading Networks
receives typically contains multiple transmission segments. The module only uses the
persistMultipleDocEnvelope variable from the default EDITPA.

Note: Module for EDI splits each transmission segment within the original EDI
document into Transmission, Batch, and File documents based on the
seing of the TRADACOMS/splitOption EDITPA variable. You can control
whether the Transmission, Batch, and File documents are saved to the
Trading Networks database via a processing rule.

webMethods Module for EDI Installation and User’s Guide Version 9.12 117
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

Value Description

true Saves the original EDI document to the Trading Networks

database. Note that the document is saved with the sender and
receiver both set to Unknown. This is the default.

Note: This behavior occurs only if the original EDI document

contains multiple transmission segments.

false Does not save the original EDI document to the Trading Networks
database. If you specify false, you will not have a way to retrieve
the original EDI document.

TRADACOMS/publishBatchFailEvent EDITPA Variable

Default: false
This variable indicates whether Module for EDI publishes an IS document
when it cannot include an EDI document that is queued for batching into the
final batch EDI document. The format of the IS document is defined by the
wm.b2b.editn.publishedDocs:batchFailDocument service. For more information about this IS
document type, see webMethods Module for EDI Built-In Services Reference. For more
information about how this EDITPA variable is used during batching and how to
handle failure to publish an IS document, see "Updating the Task Status and Publishing
Documents for Failed Tasks" on page 320.

Value Description

true Publishes an IS document when it encounters errors including an

EDI document into the final batch EDI document.

false Does not publish an IS document when it encounters errors

including an EDI document into the final batch EDI document.

Storage Options for File Document Types

You can use the TRADACOMS/storageOption variable in your EDITPA to control how
you want Trading Networks to store the content parts of your File document types.
When Trading Networks receives TRADACOMS data, it creates up to three document
types: Transmission, Batch (if present), and File. The Transmission and Batch document
types have a single content part called EDIdata , which contains all the text in that
transmission or batch. In contrast, by default, Trading Networks stores a File document
type so that it contains multiple content parts—one content part for each of the
following:
Transmission/Batch header information (STX/BAT segments)

webMethods Module for EDI Installation and User’s Guide Version 9.12 118
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

Message header
Message detail (one content part per message detail)
VAT message (if applicable)
Message trailer
Transmission/Batch trailer information (END/EOB segments)
For example:

Message contents The default storage method creates...

STX
Header1Detail1 One File document type with eight content parts as follows:
Detail2
STX
Detail3
Header1
VAT1
Detail1
Trailer1
Detail2
END
Detail3
VAT1
Trailer1
END

Note: These are not the actual names of the content parts. You should not write
code to access the content parts directly. Instead, use the built-in services
provided in the wm.b2b.edi.tradacoms.doc folder to access the content parts. For
more information, see webMethods Module for EDI Built-In Services Reference.

Storing File document types in this way enables you to build logic to process individual
detail messages yet still be able to easily access related summary information from the
header, VAT, and trailer messages.
However, if a single File document contains many detail messages (for example, fifty or
more), My webMethods may not be able to display all of the content parts. In this case,
you might want to consider using an alternative storage option.
The alternative storage option stores the Transmission and Batch information in the
same manner as the default storage option. However, instead of storing all message
details in a single File document type, Trading Networks creates a separate File
document type for each detail message.
For example:

Message contents The default storage The alternative storage method creates...
method creates...
STX
Header1 One File document Three file document types (one per
Detail1 type with eight detail message), each with six content
Detail2
Detail3
content parts as parts as follows:
VAT1 follows:
Trailer1
Document type 1:
STX
END Header1 STX
Detail1 Header1
Detail2 Detail1
Detail3 VAT1

webMethods Module for EDI Installation and User’s Guide Version 9.12 119
 M
Even Header
Defining Trading Partner Information When Using TRADACOMS

Message contents The default storage The alternative storage method creates...
method creates...
VAT1 Trailer1
Trailer1 END
END
Document type 2:
STX
Header1
Detail2
VAT1
Trailer1
END

Document type 3:
STX
Header1
Detail3
VAT1
Trailer1
END

To select which storage option to use, set the TRADACOMS/storageOption variable in

your EDITPA, as described in the "TRADACOM Variables" on page 112.

Errors that Prevent the Splitting of Transmissions

The following categories of errors will prevent the TRADACOMS/splitOption EDITPA
variable from spliing a TRADACOMS transmission. For information about seing the
TRADACOMS/splitOption variable, see "TRADACOM Variables" on page 112.

Validation Errors
If the processing rule triggered by a transmission document is set to validate the
structure of the document, and if any of the following errors occur, splitOption will not
split the transmission:
Data Error
The message structure is invalid, or a field contains an invalid value, or a mandatory
field is missing. These errors are detected by the wm.b2b.edi:convertToValues service when its
validate flag is set to true. This only applies to errors within the STX, BAT, MHD, MTR,
EOB, and END segments. Errors within the MHD and MTR segments will not prevent
splitOption from spliing the entire transmission.
Missing or Invalid RSGRSG Message
When ANAA is specified in the STX segment and:
There is no RSGRSG
The control number in the RSGRSG does not match the control number in
STX
The Sender Reference in RSGRSG does not match the Sender Reference in
STX

webMethods Module for EDI Installation and User’s Guide Version 9.12 120
 M
Odd Header
Defining Trading Partner Information When Using TRADACOMS

When ANAA is not specified in STX segment and:

RSGRSG is present
Document Count Mismatch
Number of messages or batches between STX/END does not match reported
count in END segment
Number of messages between BAT/EOB does not match reported count in EOB
segment
Number of segments between MHD/MTR segments (including the MHD/MTR
segments) does not match the reported count in MTR segment
Invalid MHD Sequence Number
The MHD segment contains a sequence number. The transmission will only be split if
the first MHD segment is 1 and all subsequent MHD segment sequence numbers are
incremented by one.

Invalid File Structure

When any of the following messages in a file are missing, splitOption will not split the
transmission:
Message detail missing
VAT message missing (if required)
Message trailer missing

webMethods Module for EDI Installation and User’s Guide Version 9.12 121
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 122
 M
Odd Header
Defining Control Number Information for Trading Partners

5   Defining Control Number Information for Trading

Partners

■ Overview ..................................................................................................................................... 124

■ Managing Control Number Information ...................................................................................... 124
■ Turning Inbound Control Number Validation On and Off ........................................................... 132
■ Defining Control Number Information for Processing Documents ............................................. 135
■ Defining Actions Module for EDI Can Take for Invalid Control Numbers ................................... 136
■ Searching for Existing Control Number Settings ....................................................................... 138

webMethods Module for EDI Installation and User’s Guide Version 9.12 123
 M
Even Header
Defining Control Number Information for Trading Partners

Overview
A control number is a number in the header of a non-TRADACOMS EDI document that is
used for validation and for ordering documents exchanged between trading partners.
For inbound EDI documents, Module for EDI can perform control number validation,
which determines whether control numbers are valid or invalid and detects duplicate or
out-of-sequence control numbers. Also, inbound control number validation determines
whether the control numbers are in order, and therefore whether the EDI documents
arrived in order. However, inbound control number validation does not guarantee that
EDI documents are processed in the same order in which they are received.
This chapter discusses actions that are taken to define and manage control number
information. For information about control number validation, see "Optional Inbound
Processing When Using Trading Networks " on page 257.

Note: If you use the TRADACOMS EDI standard, the term control number is
equivalent to the transmission reference numbers specified in the STX and
BAT segments of your TRADACOMS documents. Whether your EDI standard
includes control numbers or transmission reference numbers, you define them
the same way in Trading Networks. The only difference is in the terminology.
For simplicity, Trading Networks and Module for EDI use the term control
number to mean either control number or transmission reference number.

Managing Control Number Information

Module for EDI maintains information about control numbers in the
EDIControlNumber table, which is a Module for EDI-specific table in the Trading
Networks database. The module maintains control number information for unique
combinations of:
Sender/receiver
EDI standard and version
Production mode (Production, Test, or Custom). For VDA, the Production mode is
always set to Custom.
Type
For ANSI X12 or UN/EDIFACT (and all supported sub-standards), type is one of
the following:
Envelope, if the control number is to be used for an interchange header
Group, if the control number is to be used for a group header
For TRADACOMS, type is one of the following:

webMethods Module for EDI Installation and User’s Guide Version 9.12 124
 M
Odd Header
Defining Control Number Information for Trading Partners

Envelope, if the control number is to be used for a TRADACOMS

transmission header
Batch, if the control number is to be used for a TRADACOMS batch header,
a TRADACOMS file header (for example, ORDHDR, ACKHDR, and
INVHDR), or a message type for a TRADACOMS file type, (for example,
ORDHDR, ACKHDR, and INVHDR).
For VDA, type is Envelope
When Module for EDI is processing an EDI document and requires control number
information, the module uses the above information from the EDI document being
processed to look up the control number information to use. For example, if the module
is validating a group control number, it uses the following information from the group
header to locate the EDIControlNumber table entry:

Information from the Group Header

Sender A

Receiver B

EDI standard ANSI X12

Version 4010

Production Testing
Mode

Group Type PO

The following table lists the actions you can take to manage control number information,
as well as where you can find more information about each action.

To... See...

Define how Module for EDI creates "Defining How Module for EDI Creates the
the control number sequence Control Number Sequence" on page 126

Add entries to the EDIControl "Adding Entries to the EDIControlNumber

Number table for unique Table" on page 126
combinations of sender/receiver/EDI
standard/version/production mode/
type

webMethods Module for EDI Installation and User’s Guide Version 9.12 125
 M
Even Header
Defining Control Number Information for Trading Partners

To... See...

Configuring control number seings "Configuring Control Number Seings" on

page 126

Updating control number seings "Updating Control Number Seings" on

page 132

Defining How Module for EDI Creates the Control Number Sequence
Use the EDIAllowCustomControlNumberSequence property to define how Module for
EDI creates the control number sequence. For more information, see "Defining Module
for EDI Properties" on page 26.

Adding Entries to the EDIControlNumber Table

Entries can be added to the EDIControlNumber table for unique combinations of sender/
receiver/EDI standard/version/production mode/type.
Module for EDI automatically adds entries to the EDIControlNumber table when it is
validating inbound control numbers. In My webMethods, you can add a control number
for a specific combination of sender/receiver/EDI standard/version/production mode/
type, and then the module adds the control number to the EDIControlNumber table.
Additionally, you can add entries that you want to use for outbound processing. For
more information, see "Configuring Control Number Seings" on page 126.

Configuring Control Number Settings

Module for EDI uses the control number maximum, minimum, increment, and
window seings to determine the next control number to expect, whether a control
number is valid or invalid, and whether an invalid control number is a duplicate or
an out-of-sequence control number. Module for EDI maintains these seings in the
EDIControlNumber table.
The table below describes the control number seings and their defaults.

Setting Description Default

control number The next control number to expect. You 1

can set an initial value. Module for EDI
updates this seing so it is always set
to the next expected control number.

control number The value you want Module for EDI 1

increment to use to increment a control number

webMethods Module for EDI Installation and User’s Guide Version 9.12 126
 M
Odd Header
Defining Control Number Information for Trading Partners

Setting Description Default

when determining the next expected
control number.

control number The highest number the control 99999999999999

maximum number can be.

control number The lowest number the control number 0 (for VDA)
minimum can be.
1 (for all other
standards)

control number A number used to compute a range 100

window of numbers. Module for EDI uses
this range of numbers to determine
whether an invalid control number
is a duplicate or an out-of-sequence
control number. For more information,
see "Invalid Control Numbers" on page
259.

For example, Module for EDI receives an Interchange document that has an interchange
header identifying sender A, receiver B, a production mode of Production, and a
type of Envelope. The module locates the control number seings by locating the
EDIControlNumber table entry for sender A, receiver B, where production mode is
Production, and type is Envelope. If the module is validating a control number in
an inbound document, and an EDIControlNumber table entry does not exist for the
combination of sender/receiver, EDI standard/version, production mode, and type, the
module:
1. Adds an entry to the table
2. Sets the control number maximum, minimum, increment, and window to their
defaults
3. Sets the next expected control number to the sum of the control number from the
inbound EDI document plus the control number increment

Note: It is possible for Module for EDI to encounter more than one sender/receiver
pair that maps to the same Trading Networks internal ID. For example, when
you have the same sender ID/receiver ID pair combination for two separate
sender/receiver pairs, the two pairs map to the same Trading Networks
internal ID. Because Module for EDI uses the same Trading Networks internal
ID to identify senders and receivers in the EDIControlNumber table, both
sender/receiver pairs correlate to the same row in the EDIControlNumber
table. As a result, when Module for EDI receives a document from either
sender/receiver pair, it will update the next expected control number in the
same row of the EDIControlNumber table.

webMethods Module for EDI Installation and User’s Guide Version 9.12 127
 M
Even Header
Defining Control Number Information for Trading Partners

When your environment is set up so that Module for EDI maintains separate
control number sequences for each sender/receiver pair, the module will
indicate that the example’s control numbers are invalid. This is because the
module checks the control number sequences for two sender/receiver pairs
using the same EDIControl number entry.
To identify sender and receiver pairs correctly in this scenario, set the
EDIAllowCustomControlNumberSequence property to true. When
EDIAllowCustomControlNumberSequence is set to true, Module for EDI
looks up the next control number using both the sender/receiver ID and the
sender/receiver qualifiers.
For more information about the EDIAllowCustomControlNumberSequence
property, see "Defining Module for EDI Properties" on page 26.

Configure control number seings using either the Control Numbers page or the Partner
Profiles page in My webMethods. For more information about configuring control
number seings using the Control Numbers page, see "Configuring Control Number
Seings Using the My webMethods Control Numbers Page" on page 128. For more
information about configuring control number seings using the Partner Profiles page,
see "Configuring Control Number Seings Using the My webMethods Partner Profiles
Page" on page 132.

Note: You must have the Manage Control Numbers general functional permission to
configure control number seings using the Control Number page.

Configuring Control Number Settings Using the My webMethods Control

Numbers Page
Use this procedure to define control number seings using the My webMethods Control
Numbers page.

To configure control number settings using the Control Numbers page

1. In My webMethods: Administration > Integration > B2B Settings > Control Numbers.
2. Click Add Control Number.
3. If you have set the value of the EDIAllowCustomControlNumberSequence property
to
True or strictCompatibility, select one of the following options in the Define By
panel to define the control number:
Partner name (Default)
Partner external ID
False, define the control number for your partner using the corporation name of
the partner.

webMethods Module for EDI Installation and User’s Guide Version 9.12 128
 M
Odd Header
Defining Control Number Information for Trading Partners

For more information about the EDIAllowCustomControlNumberSequence

property, see "Defining Module for EDI Properties" on page 26.
4. In the Control Number Definition panel, specify information that describes when to
use the control number as follows:

Field Description

Sender The corporation name of the sender. Click Select to select

the sender from the partner list. This field is available
when:
The value of the
EDIAllowCustomControlNumberSequence property is
false.
The value of the
EDIAllowCustomControlNumberSequence property is
true or strictCompatibility and you define the control
number using Partner name.

Sender ID The Trading Networks ID for the sender.

To determine the ID, you can run the
wm.b2b.editn:ediPartnerIDToTNPartnerID service from Software
AG Designer. Copy the resulting internal ID from the
boom of the Results tab and paste it into this field.
This field is available when the value of the
EDIAllowCustomControlNumberSequence property is
true or strictCompatibility and you define the control
number using Partner external ID.

Sender Qualifier Leave this blank. This field is available when the value of
the EDIAllowCustomControlNumberSequence property
is true or strictCompatibility and you define the control
number using Partner external ID.

Receiver The corporation name of the receiver. Click Select to

select the receiver from the partner list. This field is
available when:
The value of the
EDIAllowCustomControlNumberSequence property is
false.
The value of the
EDIAllowCustomControlNumberSequence property is
true or strictCompatibility and you define the control
number using Partner name.

webMethods Module for EDI Installation and User’s Guide Version 9.12 129
 M
Even Header
Defining Control Number Information for Trading Partners

Field Description

Receiver ID The Trading Networks ID for the receiver.

To determine the ID, you can run the
wm.b2b.editn:ediPartnerIDToTNPartnerID service from Designer.
Copy the resulting internal ID from the boom of the
Results tab and paste it into this field.
This field is available when the value of the
EDIAllowCustomControlNumberSequence property is
true or strictCompatibility and you define the control
number using Partner external ID.

Receiver Qualifier Leave this blank. This field is available when the value of
the EDIAllowCustomControlNumberSequence property
is true or strictCompatibility and you define the control
number using Partner external ID.

Production Mode The production mode associated with the interchange or

group (or transmission or batch) header for which to use
the control number. Specify Production, Test, or Custom.

Note: For TRADACOMS and VDA, the only valid value is

Production.

Standard The EDI standard of the documents in which to use the

control number. Select X12, UNEDIFACT, EANCOM, UCS,
VICS, VDA, or TRADACOMS.

Version The version of the EDI standard. For example, for an

ANSI X12 or UN/EDIFACT interchange the version
might be 00401 and for a group it might be 4010. For
a TRADACOMS batch or transmission, the version can
only be 1. For a TRADACOMS file, specify the version of
the file document type.

Group Type Whether the control number is to be used for an

interchange (or transmission) header or a group (or
batch) header.
Select Envelope if you are adding a control number for
an interchange-level (or transmission-level) document.
Select Select if you are adding a control number for a
group-level (or batch-level) document that has a specific
group type, and then in the Select Group Type box,
type one of the following:

webMethods Module for EDI Installation and User’s Guide Version 9.12 130
 M
Odd Header
Defining Control Number Information for Trading Partners

Field Description

For non-TRADACOMS documents: the name of the

group (for example, PO or IN)
For TRADACOMS documents: the name of the
batch or file type (for example, INVHDR or ORDHDR)
Select All if you are adding a control number that
applies to all group-level documents.

5. In the Seings panel, specify information that describes the value to use for the
control number as follows:

Field Description

Duplicate Detection A number that indicates a range of numbers that Module

Window for EDI uses to determine whether a number is duplicate
or out-of-sequence.

Next Control The next control number that you expect for the
Number interchange or group (or transmission or batch) to use.

Increment The value that Module for EDI uses to increment the
control number to determine the next expected control
number.

Minimum The lowest number that the control number can be.

Maximum The highest number that the control number can be.
If Module for EDI calculates the next expected control
number and that number is greater than the control
number maximum, Module for EDI sets the control
number to the value you specify in the Minimum field.

Note: When seing the values for Maximum, Minimum, and Window, the difference
between Maximum and Minimum must be at least two times as large as the
value you specify for Window.

6. Click Save & Close. Module for EDI adds the control number information you defined
to the EDIControlNumber table.

webMethods Module for EDI Installation and User’s Guide Version 9.12 131
 M
Even Header
Defining Control Number Information for Trading Partners

Configuring Control Number Settings Using the My webMethods Partner

Profiles Page
Use this procedure to configure control number seings using the My webMethods
Partner Profile page.

To configure control number settings using the Partner Profiles page

1. In My webMethods: Administration > Integration > B2B > Partner Administration > Partner
Profiles.
2. On the Partner Profiles page, select a partner and click the Edit icon ( ).
3. On the Partner Details page, click the Control Number tab.

Note: The ControlNumber tab will be available in the Partner Details page only
if you have Edit EDI Control Number Sequences data permission and
Manage Control Numbers general functional permission. For more
information, see "Assigning User-Specific Permissions in My webMethods"
on page 25.

4. Click Add Control Number and continue with step 3 in "Configuring Control Number
Seings Using the My webMethods Control Numbers Page" on page 128.

Updating Control Number Settings

Use the following procedure to update any of the control number seings in the
EDIControlNumber table.

To update control number settings

1. In My webMethods: Administration > B2B Settings > Control Numbers
2. Search for the control number entry that you want to update. For information about
searching the table, see "Searching for Existing Control Number Seings Using My
webMethods " on page 139.
3. Click the Edit icon and update the control number seings, as desired.

Turning Inbound Control Number Validation On and Off

You can have the Module for EDI validate interchange control numbers, group control
numbers, or both (or any combination of TRADACOMS transmission, batch, and file
control numbers). By default, inbound control number validation is turned off.
Because you turn validation on or off using EDITPA variables, you can control whether
Module for EDI validates control numbers for all sender/receiver pairs or for specific
sender/receiver pairs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 132
 M
Odd Header
Defining Control Number Information for Trading Partners

Important: Module for EDI does not validate control numbers that contain non-numeric
characters.

The following sections summarize the EDITPA variables used to turn validation on and
off for each type of control number.

Activating Validation for ANSI X12 or UN/EDIFACT Documents

For ANSI X12 or UN/EDIFACT documents (and all supported sub-standards), use the
EDITPA variables in the following table. For more information about these variables, see
"ControlNumberManagement Variables" on page 88.

Type of control How to turn validation on or off

number

Interchange Set the ControlNumberManagement/

validateInboundEnvelopeControlNumbers EDITPA variable as
follows:
true—Turns on the interchange control number validation.

false—Turns off the interchange control number validation.

When you are using non-standard processing, to turn

validation of inbound interchange control numbers on or off,
use the Validate inbound envelope control numbers seing on the
Module for EDI home page. For more information, see "Turning
Inbound Control Number Validation On or Off When Using
Non-Standard Processing" on page 393.

Group Set the ControlNumberManagement/

validateInboundGroupControlNumbers EDITPA variable as
follows:
true—Turns on the group control number validation.

false—Turns off the group control number validation.

Activating Validation for VDA Documents

For VDA documents, use the following EDITPA variables. For more information about
these variables, see "ControlNumberManagement Variables" on page 88.

webMethods Module for EDI Installation and User’s Guide Version 9.12 133
 M
Even Header
Defining Control Number Information for Trading Partners

Type of control How to turn validation on or off

number

Interchange Set the ControlNumberManagement/

validateInboundEnvelopeControlNumbers EDITPA variable as
follows:
true—Turns interchange control number validation on.

false—Turns interchange control number validation off.

Structure Set the ControlNumberManagement/VDA/validateStructure

EDITPA variable as follows:
true—Turns structure control number validation on.

false—Turns structure control number validation off.

Activating Validation for TRADACOMS Documents

For TRADACOMS documents, use the EDITPA variables in the following table. For
more information about these variables, see "Defining Trading Partner Information
When Using TRADACOMS" on page 105.

Type of control How to turn validation on or off

number

Transmission Set the TRADACOMS/ControlNumberManagement/

validateInboundTransmissionControlNumbers EDITPA variable as
follows:
true—Turns transmission control number validation on.

false. Turns transmission control number validation off.

Batch Set the TRADACOMS/ControlNumberManagement/

validateInboundBatchControlNumbers EDITPA variable as follows:
true—Turns batch control number validation on.

false—Turns batch control number validation off.

File Set the TRADACOMS/ControlNumberManagement/

validateInboundFileControlNumbers EDITPA variable as follows:
true—Turns file control number validation on.

false—Turns file control number validation off.

webMethods Module for EDI Installation and User’s Guide Version 9.12 134
 M
Odd Header
Defining Control Number Information for Trading Partners

Defining Control Number Information for Processing

Documents
This section describes how to define control number information needed to process both
inbound and outbound EDI documents.

Defining Control Number Information for Processing Inbound

Documents
The following table describes the control number seings that you can define for
inbound EDI documents, where to define them, and what information is associated with
each seing.

Settings Define in... Setting is associated with...

Whether you want Module for EDI EDITPA Sender/Receiver

to validate inbound control numbers. pair identified in the
For more information, see "Validating EDITPA
Inbound Control Numbers" on page
258 and "Turning Inbound Control
Number Validation On and Off" on
page 132.

Actions you want Module for EDI to

take when it encounters an invalid
control number. For more information,
see "Actions Module for EDI Can Take
for Invalid Control Numbers" on page
262.

Seings used to track control numbers EDIControlNumber

Unique combination
and determine whether an invalid table of:
control number is a duplicate or out
Sender/Receiver
of sequence. For more information,
see "Managing Control Number Production mode (for
Information" on page 124. example, Testing or
Production)
Initial value of the control number Type (Envelope or
you expect to receive in an inbound Group)
document. For more information,
see "Configuring Control Number
Seings" on page 126.

webMethods Module for EDI Installation and User’s Guide Version 9.12 135
 M
Even Header
Defining Control Number Information for Trading Partners

Defining Control Number Information for Processing Outbound

Documents
For outbound EDI documents, the service you create to form an outbound EDI
document can access the EDIControlNumber table to obtain the control numbers to
use for group and interchange headers (or batch and transmission headers) of the
document. You can set the initial control number value you want to use for an outbound
EDI document. For more information, see "Obtaining Control Numbers for Outbound
Processing (ANSI X12 and UN/EDIFACT)" on page 296.

Defining Actions Module for EDI Can Take for Invalid Control
Numbers
How you define the actions Module for EDI can take for invalid control numbers
depends on the EDI standard you are using.

EDI Standard Where to Find More Information

ANSI X12 or "Defining How to Handle Invalid Control Numbers for ANSI X12
UN/EDIFACT or UN/EDIFACT Documents" on page 136

VDA "Defining How to Handle Invalid Control Numbers for VDA

Documents" on page 137

TRADACOMS "Defining How to Handle Invalid Control Numbers for

TRADACOMS Documents" on page 138

For a description of the specific actions Module for EDI can take when it encounters
an invalid control number, see "Actions Module for EDI Can Take for Invalid Control
Numbers" on page 262.

Defining How to Handle Invalid Control Numbers for ANSI X12 or UN/
EDIFACT Documents
The following table describes how to define the action you want Module for EDI to
take for invalid control numbers in ANSI X12 and UN/EDIFACT documents (and all
supported sub-standards):

webMethods Module for EDI Installation and User’s Guide Version 9.12 136
 M
Odd Header
Defining Control Number Information for Trading Partners

Type of invalid How to define the action

control number

Duplicate Use the ControlNumberManagement/

control number duplicateControlNumberAction EDITPA variable.
For details, see "ControlNumberManagement/
duplicateControlNumberAction EDITPA Variable" in
"ControlNumberManagement Variables" on page 88.

Out-of-sequence Use the ControlNumberManagement/

control number outOfSequenceControlNumberAction EDITPA
variable. For details, see "ControlNumberManagement/
outOfSequenceControlNumberAction EDITPA Variable" in
"ControlNumberManagement Variables" on page 88.

Note: When using non-standard processing, the EDITPA

variables described in the table above apply only to
invalid group control numbers. You specify actions
for invalid interchange control numbers using the
Interchange Information Detail screen of Module for
EDI home page. For more information, see "Defining
Actions for Invalid Control Numbers" on page 393.
For more information about the difference between
standard and non-standard processing, see webMethods
Module for EDI Concepts Guide.

Defining How to Handle Invalid Control Numbers for VDA Documents

The following table describes how to define the action you want Module for EDI to take
for invalid control numbers in VDA documents (and all supported sub-standards):

Type of invalid How to define the action

control number

Duplicate Use the ControlNumberManagement/

control number duplicateControlNumberAction EDITPA variable.
For details, see "ControlNumberManagement/
duplicateControlNumberAction EDITPA Variable" in
"ControlNumberManagement Variables" on page 88.

Out-of-sequence Use the ControlNumberManagement/

control number outOfSequenceControlNumberAction EDITPA
variable. For details, see "ControlNumberManagement/

webMethods Module for EDI Installation and User’s Guide Version 9.12 137
 M
Even Header
Defining Control Number Information for Trading Partners

Type of invalid How to define the action

control number
outOfSequenceControlNumberAction EDITPA Variable" in
"ControlNumberManagement Variables" on page 88.

Invalid structure Use the ControlNumberManagement/VDA/validateStructure

EDITPA variable.
All control number fields are mandatory and are used
to check the completeness of a message. For details, see
"ControlNumberManagement/VDA/validateStructure EDITPA
Variable" in "ControlNumberManagement Variables" on page
88.

Defining How to Handle Invalid Control Numbers for TRADACOMS

Documents
The following table describes how to define the action you want Module for EDI to take
for invalid control numbers in TRADACOMS documents:

Type of invalid How to define the action

control number

Duplicate Use the TRADACOMS/ControlNumberManagement/

control number duplicateControlNumberAction EDITPA variable. For
details, see “TRADACOMS/ControlNumberManagement/
duplicateControlNumberAction EDITPA Variable” in
"TRADACOM Variables" on page 112.

Out-of-sequence Use the TRADACOMS/ControlNumberManagement/

control number outOfSequenceControlNumberAction EDITPA variable. For
details, see “TRADACOMS/ControlNumberManagement/
outOfSequenceControlNumberAction EDITPA Variable” in
"TRADACOM Variables" on page 112.

Searching for Existing Control Number Settings

Note: This section describes how to search for existing control number seings
using My webMethods home page.

webMethods Module for EDI Installation and User’s Guide Version 9.12 138
 M
Odd Header
Defining Control Number Information for Trading Partners

Searching for Existing Control Number Settings Using My

webMethods
When you have Manage Control Numbers general functional permission, you
can search for existing control number seings to view and/or update using My
webMethods.

To search for existing control number settings using My webMethods

1. In My webMethods, navigate to the Control Numbers page by way of either of the
following:
Using B2B seings, go to Administration > Integration > B2B Settings > Control
Numbers.
Using the Partner Profiles page:
i. Go to Administration > Integration > B2B > Partner Administration > Partner Profiles.
ii. Select Edit next to the partner profile for which you want to search.
iii. On the Partner Details page, click the Control Number tab.

Note: The Control Number tab will be available in the Partner Details page
only if you have Edit EDI Control Number Sequences data permission
and Manage Control Numbers general functional permission. For
more information, see "Assigning User-Specific Permissions in My
webMethods" on page 25.

2. Perform either a basic search if you know the control number, or an advanced search
if you do not know the control number or if you want to display a list of control
numbers that meet certain criteria.
To perform a basic search:
i. On the Keyword tab, enter the search keyword in the Keywords field.
ii. Click Search. Module for EDI executes the search in the Trading Networks
database and displays the search results in the Control Numbers panel.
iii. If you want to save the search criteria, click Save, type a name and description
for the search, and then click Save.
To perform an advanced search:
i. On the Advanced tab, select a search field, an appropriate operator, and a
value as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 139
 M
Even Header
Defining Control Number Information for Trading Partners

For this field... Specify this And this value...

operator...

Production Equals The production mode associated

Mode with the interchange (or
Not Equals
transmission) or group (or batch)
header for which to use the
control number. Select CUSTOM,
PRODUCTION, or TEST.

Group Type Equals If you want to search for control

numbers for:
Not Equals
Interchange or TRADACOMS
Contains
transmission headers, type
Begins With ENVELOPE.

Group or batch headers for all

group or TRADACOMS batch
types, type All.
Group or TRADACOMS batch
headers of a specific type, type
the group type (for example, PO)
or the batch TRADACOMS type
BATCH.

TRADACOMS transmissions,
type the TRADACOMS file type.

Receiver Equals The corporation name of the

receiver.
Not Equals
To locate and select a partner from
Contains
a list, click Select Partner.
Begins With

Receiver Equals The receiver ID for the interchange

External ID or group.
Not Equals
If you are searching for
Contains
information about a control
Begins With number that was added by the
Module for EDI batching feature
and for which neither the sender
nor the receiver has a Trading
Networks profile, specify the ID
of the receiver in this field and
then click the icon to add another

webMethods Module for EDI Installation and User’s Guide Version 9.12 140
 M
Odd Header
Defining Control Number Information for Trading Partners

For this field... Specify this And this value...

operator...
search criteria row for Receiver
Qualifier.

Receiver Is Blank If you are searching for

Qualifier information about a control
Is Not Blank
number that was added by the
Equals Module for EDI batching feature
for a receiver that does not have a
Not Equals Trading Networks profile, specify
Contains the EDI ID qualifier associated
with the ID you specified for
Begins With Receiver External ID.

Sender Equals The corporation name of the

sender.
Not Equals
To locate and select a partner from
Contains
a list, click Select Partner.
Begins With

Sender Equals The sender ID for the interchange

External ID or group (or transmission or
Not Equals
batch).
Contains
If you use the Module for EDI
Begins With batching feature, Module for
EDI might encounter a sender/
receiver pair for which no Trading
Networks profile exists for the
sender, receiver, or both; therefore,
no Trading Networks ID exists.
If neither the sender or receiver
has a Trading Networks ID,
Module for EDI saves the ID and
EDI qualifier for the sender and
receiver from the EDI document in
the EDIControlNumber table.
To search for control numbers for a
sender/receiver pair that does not
have a Trading Networks profile,
specify the ID of the sender in this
field, click on to add another
search criteria row for Sender

webMethods Module for EDI Installation and User’s Guide Version 9.12 141
 M
Even Header
Defining Control Number Information for Trading Partners

For this field... Specify this And this value...

operator...
Qualifier, and specify the EDI ID
qualifier in this row.

Sender Is Blank If you are searching for

Qualifier information about a control
Is Not Blank
number that was added by the
Equals Module for EDI batching feature
for a sender that does not have a
Not Equals Trading Networks profile, specify
Contains the EDI ID qualifier associated
with the ID you specified for
Begins With Sender External ID.

Standard Equals The EDI standard of the

documents that use the control
Not Equals
number.

Version Equals The version of the EDI standard.

For example, for an ANSI X12
Not Equals
or UN/EDIFACT interchange,
Contains the version might be 00401, and
for a group it might be 4010.
Begins With For a TRADACOMS batch or
transmission, the version can
only be 1. For a TRADACOMS
file, specify the version of the file
document type.

ii. If you want to add another search criteria row, click Add and specify
additional search criteria.
iii. Click Search to execute the search in the Trading Networks database. The
system displays the search results in the Control Numbers panel.
iv. If you want to save the search criteria, click Save, type a name and description
for the search, and then click Save again.

webMethods Module for EDI Installation and User’s Guide Version 9.12 142
 M
Odd Header
Creating Clients that Send EDI Documents to Integration Server

6   Creating Clients that Send EDI Documents to

Integration Server

■ Overview ..................................................................................................................................... 144

■ Defining the Content Type to Use ............................................................................................. 144
■ Before Creating the Service to Form an EDI Document ........................................................... 144
■ Creating the Service the Client Invokes to Handle EDI Documents .......................................... 145
■ Sending EDI Documents to Integration Server via HTTP .......................................................... 149
■ Sending EDI Documents to Integration Server via FTP ............................................................ 151
■ Sending EDI Documents to Integration Server via File Polling ................................................. 153

webMethods Module for EDI Installation and User’s Guide Version 9.12 143
 M
Even Header
Creating Clients that Send EDI Documents to Integration Server

Overview
To send an EDI document to Integration Server for processing, you create a client to
Integration Server. The client you create must:
Send the document to Integration Server using a content type that Module for EDI
handles.
Invoke a service on Integration Server that you created to process the EDI document.
Use HTTP, HTTPS, FTP, or File Polling to transport the document to Integration
Server. If you want to use EDIINT to transport the document, you must use Module
for EDIINT and webMethods Trading Networks. For more information, see the
webMethods Module for EDIINT Installation and User’s Guide.
For more information about creating clients, see the chapter about creating client code in
the webMethods Service Development Help for your release.
For more information about using clients for inbound EDI document processing, see the
webMethods Module for EDI Concepts Guide.

Defining the Content Type to Use

The client you create should send the EDI document to Integration Server using the
application/EDIstream content type. When you use application/EDIstream, Integration
Server passes the document to the Module for EDI content handler as an InputStream.
The Module for EDI content handler forms the pipeline with the edidata parameter and
assigns this parameter as the pointer to InputStream. Then the content handler invokes
the service that the client specifies.

Note: For backward compatibility, Module for EDI also has content handlers to
accept documents with the content types application/EDI, application/X12,
and application/UNEDIFACT. With these content types, the Module for
EDI content handler must convert the document to a String that it places in
the pipeline. This can potentially consume a lot of pipeline space and use a
significant amount of memory. As a result, it is recommended that you use
the application/EDIstream content type because it conserves system memory.

Before Creating the Service to Form an EDI Document

Before you create the service to form an EDI document from an internal-format
document, you must create the following:
The flat file schema that defines the structure of the EDI document that you are
forming.

webMethods Module for EDI Installation and User’s Guide Version 9.12 144
 M
Odd Header
Creating Clients that Send EDI Documents to Integration Server

Module for EDI uses the schema to create the EDI document from an IData object.
For instructions, see "Creating Flat File Schemas for EDI Documents" on page 403.
Optionally, the flat file schema that defines the structure of the internal-format
document.
This is needed if your client passes the internal-format document to your service in
String format or as an InputStream. Your service uses the flat file schema as input to
the wm.b2b.edi:convertToValues service to convert the internal-format document to an
IData object and optionally validate the document's structure. If your service receives
the document as an IData object, a flat file schema is not needed. Use Software AG
Designer to create the flat file schema. For more information, see the Flat File Schema
Developer’s Guide.
Optionally, an IS document type for the structure of the internal-format document.
This is needed if 1) your client passes the internal-format document to your service
as an IData object, and 2) you want to validate the internal-format document before
forming the EDI document. Your service uses the IS document type as input to the
pub.schema:validate service, which performs the structure validation. For instructions
about how to create an IS document type, see the webMethods Service Development
Help for your release.

Creating the Service the Client Invokes to Handle EDI

Documents
You create a service that the client invokes to process EDI documents. How the client
identifies this service depends on whether you are sending the EDI document to
Integration Server via HTTP, FTP, or File Polling. For more information, see “Identifying
the Service to Invoke” in "Sending EDI Documents to Integration Server via HTTP" on
page 149, "Sending EDI Documents to Integration Server via FTP" on page 151,
and "Sending EDI Documents to Integration Server via File Polling" on page 153.
The Tutorial.XMLtoEDI:processXMLSource service in the WmEDIsamples package converts
an XML document into an outbound EDI (ANSI X12) document. The WmEDIsamples
package is located in the Knowledge Center Samples area on the Empower Product
Support website at hps://empower.softwareag.com.

Important: Delete the WmEDIsamples package before going into production.

Logic to Include in the Service to Form an EDI Document

The inputs to the service you created depend on the information that the client sends. At
a minimum, the service should provide the internal-format document.
The following sample code shows the basic logic you would include to form an
EDI document from an internal-format document and send it outbound. For more

webMethods Module for EDI Installation and User’s Guide Version 9.12 145
 M
Even Header
Creating Clients that Send EDI Documents to Integration Server

information about all of the built-in services that the sample uses, see webMethods Module
for EDI Built-In Services Reference.

Flow Description
operation

1 Invoke the wm.b2b.edi:convertToValues service to convert the

incoming internal-format document, which is either a String or
an InputStream, into an IData object. If you want, you can set the
input parameters of the convertToValues service to have it validate
the structure of the internal-format document. The inputs to the
convertToValues service include the internal-format document and
the flat file schema that defines the structure of the internal-format
document.
For backward compatibility, you can use an IS document type to
define the structure of the internal-format document rather than a
flat file schema. However, it is recommended that you use flat file
schemas.

Note: If the internal-format document is passed to your service

as an IData object, you can still validate its structure before
forming the EDI document. See "Validating the Input
Internal-Format Document When It Is an IData Object" on
page 406.

2 Add your own logic to handle errors that might result from
executing the convertToValues service, for example, validation errors.

3 Map data from the internal-format document IData object into the
EDI document IData object. Depending on the complexity of your
mapping requirements, you might need to add more logic than a
MAP flow operation, or create a separate service to perform the
mapping.

webMethods Module for EDI Installation and User’s Guide Version 9.12 146
 M
Odd Header
Creating Clients that Send EDI Documents to Integration Server

Flow Description
operation

4 Invoke the wm.b2b.edi:convertToString service to convert the EDI

document from an IData object to String format. The inputs to the
convertToString service include:
The IData object that contains the data for your EDI document.
Map this IData object to the values input parameter of the
convertToString service.
The flat file schema for the EDI document. The convertToString
service uses the flat file schema to determine how to form the EDI
document.
For backward compatibility, you can use an IS document type as
input to the convertToString service rather than a flat file schema for
files with delimited fields and records.
The type of encoding the convertToString service uses to write data
to the output file. When no value is provided for the encoding
input parameter, the convertToString service uses the EDIencoding
property located in the Integration Server_directory\instances
\$instance_name \packages\WmEDI\config\properties.cnf file.
When the EDIencoding property is not specified, UTF-8 is used.
For more information about the EDIencoding property, see
"Defining Module for EDI Properties" on page 26.

5 Optionally, invoke the convertToValues service against the EDI

document to validate the structure of your final EDI document.
The inputs to the convertToValues service include:
The EDI document. The string output parameter of the
convertToString service contains the EDI document. Map this to the
edidata input parameter of the convertToValues service.
The flat file schema that defines the structure for the EDI
document.

6 If needed, add the group envelope to the EDI document by

invoking either the wm.b2b.edi.util:addICEnvelopeEDIFACT service
if you are creating a UN/EDIFACT EDI document or the
wm.b2b.edi.util:addGroupEnvelope service if you are creating another
kind of EDI document.
For more information about adding UN/EDIFACT envelopes, see
"Adding UN/EDIFACT Envelopes" on page 407.

7 Add the interchange envelope to the EDI document by

invoking either the wm.b2b.edi.util:addICEnvelopeEDIFACT service

webMethods Module for EDI Installation and User’s Guide Version 9.12 147
 M
Even Header
Creating Clients that Send EDI Documents to Integration Server

Flow Description
operation
if you are creating a UN/EDIFACT EDI document or the
wm.b2b.edi.util:addICEnvelope service if you are creating another
kind of EDI document. For more information about adding UN/
EDIFACT envelopes, see "Adding UN/EDIFACT Envelopes" on
page 407.

8 Add your own logic or invoke a service that you create to send the
EDI document outbound.

Validating the Input Internal-Format Document When It Is an IData

Object
The logic in the sample code for forming an EDI document from an internal-format
document assumes the internal-format document is passed to your service as a String or
InputStream. In this situation, you can have the wm.b2b.edi:convertToValues service validate
the document. If your client passes the internal-format document to your service as an
IData object, and you want to validate the internal-format document before converting
it to an EDI document, you can replace the logic that invokes the convertToValues service
with logic that uses the pub.schema:validate service, as shown in the following diagram:

When you use the pub.schema:validate service, you must have an IS document type that
defines the structure of the internal-format document. For more information about the
pub.schema:validate service, see the webMethods Integration Server Built-In Services Reference
for your release.

Adding UN/EDIFACT Envelopes

To add the appropriate group and interchange envelopes for a UN/EDIFACT EDI
document, you invoke the wm.b2b.edi.util:addICEnvelopeEDIFACT service rather than invoke
the wm.b2b.edi.util:addGroupEnvelope service or the wm.b2b.edi.util:addICEnvelope service, as
shown in the following diagram:

webMethods Module for EDI Installation and User’s Guide Version 9.12 148
 M
Odd Header
Creating Clients that Send EDI Documents to Integration Server

For more information about the wm.b2b.edi.util:addICEnvelopeEDIFACTservice, see webMethods

Module for EDI Built-In Services Reference.

Validating the EDI Document Envelope

If you want to validate the resulting EDI document envelope and check compliance
as a fail-safe measure, you can provide the EDI document envelope as input to the
wm.b2b.edi:envelopeProcess service or the wm.b2b.edi.util:generateFA service. For more
information about these services, see webMethods Module for EDI Built-In Services
Reference.

Sending EDI Documents to Integration Server via HTTP

You can create a client that uses HTTP or HTTPS to post an EDI document to Integration
Server. The HTTP client must meet the following requirements :
The client must be able to send the EDI document as a String of data to Integration
Server using the HTTP POST method.
The client must be able to set the value of the content type (for example, application/
EDIstream) in the request-header field.
Because most browsers do not allow you to modify the content type header field, they
are not suitable clients for this type of submission. Clients that you might use to submit
an EDI document in this manner include PERL scripts, which allow you to build and
issue HTTP requests, and the webMethodspub.client:http service.

Identifying the Service to Invoke

When using HTTP, the client identifies the service to invoke by specifying the URL of
that service as the HTTP request URL. For example, if the fully-qualified name of the
service you want to invoke is myEDIServices.v1:processEDIDoc, use the following URL:
http://rubicon:5555/invoke/myEDIServices.v1/processEDIDoc

Logic to Include in the HTTP Client

When using HTTP, the client must include logic to:
Submit a POST request to Integration Server.

webMethods Module for EDI Installation and User’s Guide Version 9.12 149
 M
Even Header
Creating Clients that Send EDI Documents to Integration Server

Address the request to the URL of the service that is to process the EDI document,
for example, http://rubicon:5555/invoke/myEDIServices.v1/processEDIDoc).
Set the content type to application/EDIstream in the HTTP request header.
Put the EDI document to be processed in the body of the message. The document
must be the only text that appears in the body of the request.

Important: Do not include manual line breaks at the end of the EDI document like
you might do with an XML document.

Example of Input Parameters for the pub.client:http Service

The following example describes the values that you would set when using the
webMethodspub.client:http service to POST an EDI document to a service with the fully-
qualified name myEDIServices.v1:processEDIDoc. For a complete description of this service,
see the webMethods Integration Server Built-In Services Reference for your release.

Set this Of data To...

parameter... type...

url String The URL of the service that you want to invoke to
process the EDI document.
Example: http://rubicon:5555/invoke/
myEDIServices.v1/processEDIDoc

In this example, the processEDIDoc service located

in the myEDIServices.v1 folder on the "rubicon"
server with port number "5555" would be
invoked.

method String post

loadAs String The data type of the input data source. Specify
one of the following:
bytes. The document data source is a byte[].

stream. The document data source is an

InputStream.

data/string String The EDI document that you want to post.

headers Document An IData object that contains the following:

Parameter Value

webMethods Module for EDI Installation and User’s Guide Version 9.12 150
 M
Odd Header
Creating Clients that Send EDI Documents to Integration Server

Set this Of data To...

parameter... type...

Name Content-type

Value The content type for

the document, for
example, application/
EDIstream

Also, the client can set any optional HTTP variables, such as authorization information,
that are required by your application.

Sending EDI Documents to Integration Server via FTP

You can create a client that sends an EDI document to Integration Server's FTP listening
port. By default, the FTP port is assigned to port 8021. However, this assignment is
configurable, so you should check with your server administrator to see which port is
used for FTP communications on your Integration Server.

Identifying the Service to Invoke

When using FTP, the client identifies the service to invoke by changing to the directory
that represents the service you want to invoke. For example, if the fully-qualified name
of the service you want to invoke is myEDIServices.v1:processEDIDoc, the client would issue
the cd command to change to the following directory:
\ns\myEDIServices\v1\processEDIDoc

Logic to Include in the FTP Client

When using FTP, the client must include logic to:
Initiate an FTP connection to Integration Server's FTP listening port, for example,
8021.
Change to the directory that represents the service you want to invoke using the cd
command.
For example,
cd \ns\myEDIServices\v1\processEDIDoc

Note: The root directory for this operation is your Integration Server's namespace
directory (ns), not the root directory of the target machine. Therefore, if
you want to send a file to a service in the myEDIServices.v1 folder, you
use \ns\myEDIServices\v1\ServiceName as the path to that service,

webMethods Module for EDI Installation and User’s Guide Version 9.12 151
 M
Even Header
Creating Clients that Send EDI Documents to Integration Server

not Integration Server_directory\instances\$instance_name \packages

\myEDIServices\v1\ServiceName .

Send the EDI document to this directory using the following put command:
putlocalFileName filename ;content type :content sub-type

For example,
put x12_850 x12_850;application:EDIstream

In this example, the local EDI document's name is X12_850, the document's content
type is application, and the document's content sub-type is EDIstream.

Example of Input Parameters for the pub.client:ftp Service

The following example describes the values that you would set if you used the
webMethodspub.client:ftp service to send an EDI document to a service with the fully-
qualified name myEDIServices.v1:processEDIDoc. For a complete description of this service,
see the webMethods Integration Server Built-In Services Reference for your release.

Set this Of data To...

parameter... type...

serverhost String The name of the machine running Integration

Server.

serverport String The port on which Integration Server listens for

FTP requests.

username String A valid user name of an Integration Server user

account.

password String The password for the user name.

command String put

dirpath String The path representing the service to

invoke, for example, \ns\myEDIServices
\v1\processEDIDoc.

localfile String The name of the source file containing the EDI
document, for example, x12_850.

remotefile String The name to assign the file on Integration Server

and the content type. Use the following format:
filename ;content type :content sub-type

webMethods Module for EDI Installation and User’s Guide Version 9.12 152
 M
Odd Header
Creating Clients that Send EDI Documents to Integration Server

Set this Of data To...

parameter... type...

For example,
x12_850;application:EDIstream

secure Document Indicates whether the FTP session is with a secure

FTP server. The auth parameter specifies the
kind of authentication mechanism to use (SSL,
TLS, or TLS-P), and the securedata parameter
specifies whether the client is sending PROT C
(Data Channel Protection Level Clear) or PROT P
(Data Channel Protection Level Private).

Sending EDI Documents to Integration Server via File Polling

You can send an EDI document to Integration Server using File Polling. When you use
File Polling, you define the:
Directory that Integration Server monitors for files
EDI content type to associate with the files placed in that directory
Service to be executed to handle files placed in the directory
When files such as EDI documents are placed in this directory (for example, sent via
FTP into the directory), Integration Server uses the content type you specify. Because the
content type is an EDI content type, when Integration Server receives the EDI document
in the monitored directory, it passes the document to the appropriate Module for EDI
content handler. The content handler parses the document body and passes it in the
edidata pipeline variable to the specified service.

Setting Up File Polling

When you add the File Polling listener port, set it up to poll specifically for EDI
documents. To do so, specify the following:

In this field... Specify the...

Monitoring Directory on Integration Server that the listener monitors for

Directory incoming EDI documents.

Content type Content type that you want Integration Server to use for
documents that are placed in the Monitoring Directory. Specify
a content type that the Module for EDI recognizes. For more

webMethods Module for EDI Installation and User’s Guide Version 9.12 153
 M
Even Header
Creating Clients that Send EDI Documents to Integration Server

In this field... Specify the...

information about these content types, see "Defining the
Content Type to Use" on page 144.

Processing Service that is to process the EDI document.

Service

For general steps to configure a File Polling listener port, see the webMethods Integration
Server Administrator’s Guide for your release.

Identifying the Service to Invoke

When using File Polling, while adding the File Polling listening port, identify the service
with which you want to process the EDI document in the Processing Service field.

webMethods Module for EDI Installation and User’s Guide Version 9.12 154
 M
Odd Header
Creating Clients that Send EDI Documents to Trading Networks

7   Creating Clients that Send EDI Documents to Trading

Networks

■ Overview ..................................................................................................................................... 156

■ Content Type to Use .................................................................................................................. 156
■ Service the Client Invokes ......................................................................................................... 157
■ Sending EDI Documents to Trading Networks via HTTP/S ....................................................... 158
■ Sending EDI Documents to Trading Networks via FTP ............................................................. 159
■ Sending EDI Documents to Trading Networks via File Polling .................................................. 160
■ Sending EDI Documents to Trading Networks via My webMethods .......................................... 161
■ Using a Service to Send Multiple EDI Documents to Trading Networks .................................... 161

webMethods Module for EDI Installation and User’s Guide Version 9.12 155
 M
Even Header
Creating Clients that Send EDI Documents to Trading Networks

Overview
If you want to process your EDI documents through webMethods Trading Networks
(Trading Networks), create a client to Integration Server that submits the documents to
Trading Networks. For more information about creating clients, see the chapter about
creating client code in the webMethods Service Development Help for your release. For
more information about using clients for inbound EDI document processing when you
are using Trading Networks with Module for EDI, see the webMethods Module for EDI
Concepts Guide.
The client you create must:
Send the document to Integration Server using a content type that Module for EDI
handles. For more information, see "Content Type to Use" on page 156.
Invoke the appropriate service to handle the document.
Use HTTP, HTTPS, FTP, File Polling, or EDIINT to transport the document to
Integration Server. For more information, see one of the following sections in this
chapter:
"Sending EDI Documents to Trading Networks via HTTP/S" on page 158
"Sending EDI Documents to Trading Networks via FTP" on page 159
"Sending EDI Documents to Trading Networks via File Polling" on page 160
For more information about using EDIINT, see the webMethods Module for EDIINT
Installation and User’s Guide.

Content Type to Use

The content type your client should use to send the EDI documents to Trading Networks
depends on the type of data you are sending and/or the type of transport you want to
use. You can have the client send EDI documents either with or without mainframe data
using HTTP, HTTPS, FTP, or File Polling.

Content Type for EDI Documents that Do Not Contain Mainframe

Data
If your client is using HTTP, HTTPS, FTP, or File Polling, you typically will use
the application/EDIstream content type. When you use application/EDIstream and
Integration Server receives the document, it passes the document to the Module for
EDI content handler as an InputStream. The Module for EDI content handler forms
the pipeline with the edidata parameter and assigns this parameter as the pointer to
InputStream.

webMethods Module for EDI Installation and User’s Guide Version 9.12 156
 M
Odd Header
Creating Clients that Send EDI Documents to Trading Networks

Note: For backward compatibility, Module for EDI also has content handlers to
accept documents with the content types application/EDI, application/X12,
and application/UNEDIFACT. With these content types, the Module for
EDI content handler must convert the document to a String that it places in
the pipeline. This can potentially consume a lot of pipeline space and use a
significant amount of memory. As a result, it is recommended that you use
the application/EDIstream content type because it conserves system memory.

Content Types for EDI Documents that Contain Mainframe Data

If your EDI document contains mainframe data that have characters at certain points
in the document that define the boundary of each record, use one of the content types
described in this section. These boundary characters identify returns or new lines. The
content handlers for the application/x-wmedi... content types remove these characters,
allowing Integration Server to properly unwrap and process the mainframe documents.
Use the information in the following table to determine the content type you should use:

Use this content type... If you need to remove the...

application/x-wmediwrap80 81st character from every record in the

document

application/x-wmediwrap132 133nd character from every record in the

document

application/x-wmedisemiwrap80 81st character from a record only when a

segment is longer than 80 characters

application/x- 132nd character from a record only when a

wmedisemiwrap132 segment is longer than 133 characters

When you use one of the application/x-wmedi... content types, Integration Server passes
the document to the Module for EDI content handler as an InputStream. The content
handler removes the return and new line characters as specified by the content type.
Then the content handler forms the pipeline with the edidata parameter and assigns this
parameter as the pointer to InputStream.

Service the Client Invokes

After the content type handler forms the pipeline, it invokes the service that the client
specifies. When your client uses HTTP, HTTPS, FTP, or File Polling, it should invoke the
wm.tn:receive service to send the document directly to Trading Networks.

webMethods Module for EDI Installation and User’s Guide Version 9.12 157
 M
Even Header
Creating Clients that Send EDI Documents to Trading Networks

If your client uses EDIINT, see webMethods Module for EDIINT Installation and User’s
Guide for information about how to create the client and the service the client is to
invoke.

Sending EDI Documents to Trading Networks via HTTP/S

You can create a client that uses HTTP or HTTPS to post an EDI document to Trading
Networks, specifically to the wm.tn:receive service.
The requirements and logic for an HTTP client to send EDI documents to Trading
Networks are almost the same as the requirements and logic described in "Sending
EDI Documents to Integration Server via HTTP" on page 149. The one difference is
the service that the client invokes. To create a client that sends a document to Trading
Networks, the client should identify the wm.tn:receive service rather than identify a service
that you created to process the EDI documents.
For example, part of the logic of the HTTP client is to address the request to the URL of
the service you want to invoke. Your client should use an URL similar to the following:
http://rubicon:5555/invoke/wm.tn/receive

Example of Input Parameters for the pub.client:http Service

The following example describes the values that you would set when using the
pub.client:http service to post an EDI document to the wm.tn:receive service. For a complete
description of the pub.client:http service, see the webMethods Integration Server Built-In
Services Reference for your release.

Set this Of data To...

parameter... type...

url String The URL for the wm.tn:receive service, for

example, http://rubicon:5555/invoke/
wm.tn/receive.

In this example, the wm.tn:receive service on

the "rubicon" server with port number "5555"
would be invoked.

method String post

loadAs String The data type of the input data source. Specify
one of the following:
bytes. The document data source is a byte[]

webMethods Module for EDI Installation and User’s Guide Version 9.12 158
 M
Odd Header
Creating Clients that Send EDI Documents to Trading Networks

Set this Of data To...

parameter... type...

stream. The document data source is an

InputStream

data/string String The EDI document that you want to post.

headers Document An IData object that contains the headers that

you want to set.
Specify a key for each header field that you
want to set. The key’s name represents the
name of the header field, for example, Content-
type.The key’s value represents the value of
that header field, for example, application/
EDIstream.

Also, the client can set any optional HTTP variables, such as authorization information,
that are required by your application.

Sending EDI Documents to Trading Networks via FTP

You can create a client that sends an EDI document to Integration Server's FTP listening
port.
The logic for an FTP client to submit EDI documents to Trading Networks is almost the
same as the logic described in "Sending EDI Documents to Integration Server via FTP"
on page 151. The one difference is the service that the client invokes. To create a client
that submits a document to Trading Networks, the client should identify the wm.tn:receive
service rather than identify a service that you created to process the EDI documents.
For example, part of the logic of the FTP client is to change to the directory that
represents the service you want to invoke. Your client should use the following
command:
cd \ns\wm\tn\receive

Example of Input Parameters for the pub.client:ftp Service

The following example describes the values that you would set when using the
pub.client:ftp service to send an EDI document to the wm.tn:receive service. For a complete
description of the pub.client:ftp service, see the webMethods Integration Server Built-In
Services Reference for your release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 159
 M
Even Header
Creating Clients that Send EDI Documents to Trading Networks

Set this Of data To...

parameter... type...

serverhost String The name of the machine running Integration

Server.

serverport String The port on which Integration Server listens for

FTP requests.

username String A valid user name of an Integration Server user

account.

password String The password for the user name.

command String put

dirpath String The path representing the wm.tn:receive service,

that is the service to invoke: \ns\wm\tn\receive

localfile String The name of the source file containing the EDI
document, for example, x12_850

remotefile String The name to assign the file on Integration Server

and the content type. Use the following format:
filename ;content type :content sub-type
For example: x12_850;application:EDIstream

secure Document Indicate whether the FTP session is with a secure

FTP server. The auth parameter specifies the
kind of authentication mechanism to use (SSL,
TLS, or TLS-P), and the securedata parameter
specifies whether the client is sending PROT C
(Data Channel Protection Level Clear) or PROT P
(Data Channel Protection Level Private).

Sending EDI Documents to Trading Networks via File Polling

You can use File Polling to send documents to Trading Networks. The configuration
and setup of the File Polling listener to submit EDI documents to Trading Networks
is similar to the configuration and setup described in "Sending EDI Documents to
Integration Server via File Polling" on page 153, but with two differences:

webMethods Module for EDI Installation and User’s Guide Version 9.12 160
 M
Odd Header
Creating Clients that Send EDI Documents to Trading Networks

To add a File Polling listener port that submits documents to Trading Networks, set
the Processing Service to wm.tn:receive rather than identify a service that you created to
process the EDI documents.
When seing the value of the Content Type field, you can use any of the content types
listed in "Content Type to Use" on page 156.

Sending EDI Documents to Trading Networks via My

webMethods
You can send an EDI document to Trading Networks using My webMethods if you
have Submit Documents to TN general functional permission. For more information, see
"Assigning User-Specific Permissions in My webMethods" on page 25.

To send an EDI document to Trading Networks via My webMethods

1. In My webMethods: Administration > Integration > B2B Settings > Submit Documents
2. For Document Format, select EDI.

Note: This selection is available only if the WmEDIforTN package is installed.

3. Select the submission method by doing one of the following:

To upload the document, click Upload file and then click Browse to locate and
select the document for uploading.
To copy the contents of a document, click Copy text and then paste the text into
the Document Content box.
4. From the PRT Ignore Document list, select one of the following:
True, to not route the document to the webMethods Process Runtime module.
Use this seing if the WmPRT package is not installed.
False, to route the document to the webMethods Process Runtime module. Use
this seing if the WmPRT package is installed.
Module for EDI saves the seing you select in the pipeline prtIgnoreDocument
parameter in the submied document.
5. Click Submit.

Using a Service to Send Multiple EDI Documents to Trading

Networks
If you create a client that obtains multiple EDI documents (for example, reading them
from file) and you want to loop and send each EDI document to Trading Networks
in one invocation of your client, you must be careful to cleanup the pipeline between

webMethods Module for EDI Installation and User’s Guide Version 9.12 161
 M
Even Header
Creating Clients that Send EDI Documents to Trading Networks

sending each document. Use either the wm.tn:receive service or wm.tn.doc.xml:routeXml service
to send the document. Then, after each invocation of either of these services, drop the
editn_env parameter from the pipeline.

webMethods Module for EDI Installation and User’s Guide Version 9.12 162
 M
Odd Header
Handling Large Documents When Using Trading Networks

8   Handling Large Documents When Using Trading

Networks

■ Overview ..................................................................................................................................... 164

■ Configuring Module for EDI for Large Document Handling ....................................................... 164
■ Converting Large Documents to IData Objects Iteratively ......................................................... 166
■ Troubleshooting Memory Constraint Problems .......................................................................... 166

webMethods Module for EDI Installation and User’s Guide Version 9.12 163
 M
Even Header
Handling Large Documents When Using Trading Networks

Overview
A large EDI document is defined as either an EDI document that contains many
interchanges, many groups, and many transactions, or as a transaction that contains
many line items. Typically, when using webMethods Module for EDI (Module for EDI)
with webMethods Trading Networks (Trading Networks), Module for EDI uses the
Trading Networks large document seings.

Tip: To simplify large document handling for all of your documents, you might
choose to assign identical values to some or all of the Module for EDI and
Trading Networks large document seings.

However, some services provided with the WmEDI package process large documents
differently. When these services are invoked, Module for EDI uses the Module for EDI
large document seings described in "Configuring Module for EDI for Large Document
Handling" on page 164.
The following services use the Module for EDI large document seings. You might
invoke these services from a Trading Networks processing rule.
For ANSI X12 and UN/EDIFACT documents:
wm.b2b.edi:envelopeProcess
wm.b2b.edi:convertToValues
wm.b2b.edi.util:generateFA
For TRADACOMS and VDA documents:
wm.b2b.edi.tradacoms:convertToValues

Configuring Module for EDI for Large Document Handling

Use the following procedure to configure Module for EDI to use large document
handling. The procedure updates the configuration in both the memory, so that the
changes take effect immediately, and in the WmEDI/config/properties.cnf file.

To configure Module for EDI for large document handling

1. Make sure the EDIBigDocThreshold property is set for large documents, as
described in "Defining Module for EDI Properties" on page 26.
2. Update Trading Networks large document seings:
a. From Integration Server Administrator, select Settings > Extended.
b. Click Edit Extended Settings, and then add or update the following Integration
Server properties:

webMethods Module for EDI Installation and User’s Guide Version 9.12 164
 M
Odd Header
Handling Large Documents When Using Trading Networks

Property Description

Specifies the absolute directory path of the hard

watt.server.tspace.location
disk drive space in which Integration Server is to
temporarily store large documents rather than keep
them in memory.

Specifies the maximum number of bytes that

watt.server.tspace.max
can be stored at any one time in the hard
disk drive space that you defined using the
wa.server.tspace.location property.
The default value is 52,428,800 bytes (50 MB).

Specifies the amount of time in milliseconds that

watt.server.tspace.timeToLive
Integration Server temporarily stores documents
in Tspace, rather than keeping them in memory.
Seing this property prevents a document
from being deleted as soon as it is created, thus
prevents any resulting exceptions that occur while
Integration Server tries to read back from the
document.
The default value is 0.

Note: When batching EDI documents, you must set

this property so that Integration Server can
access the file from the temporary directory and
store it in the database.

For more information about Integration Server properties, see the webMethods
Integration Server Administrator’s Guide for your release.
3. Click Save Changes.
For more information about configuring Trading Networks for large document
handling, see the webMethods Trading Networks Administrator’s Guide for your release.

Determining When an EDI Document Is Large

Module for EDI checks the configuration file during the following actions to determine if
the EDI document being processed is large:
When the wm.b2b.edi:envelopeProcess service is invoked to process an inbound EDI
document. The envelopeProcess service leaves the transaction set data within an
EDI document unparsed. These unparsed sections of the document are known
as undefined segments. The envelopeProcess service uses the EDIBigDocThreshold
property to determine whether the undefined segment is large.

webMethods Module for EDI Installation and User’s Guide Version 9.12 165
 M
Even Header
Handling Large Documents When Using Trading Networks

When the wm.b2b.edi:convertToValues service is invoked to convert a String or

InputStream to an IData object. The convertToValues service uses a flat file schema to
determine how to parse the document. When the convertToValues service encounters
sections of the EDI document for which the flat file schema does not define the
structure, that section of the document is considered an undefined segment. The
convertToValues service uses the EDIBigDocThreshold property to determine whether
the undefined segment is large.
If an undefined segment is considered large, the envelopeProcess and convertToValues
services write the undefined segment to Tspace and store the pointer to the undefined
segment (called a reservation ID) in the _RID_ element . The envelopeProcess service
places the _RID_ element in its output IData object (Values ) after the element for the
corresponding transaction header. The convertToValues service places the _RID_ element
in its output IData object (EDIValues ) after the last identified segment.
If the undefined segment is not considered large, the services write the undefined
segment to the unDefData element and place the unDefData element in the output IData
object (instead of an _RID_ element).
For more information about the envelopeProcess and convertToValues services, see
webMethods Module for EDI Built-In Services Reference.

Converting Large Documents to IData Objects Iteratively

When you are converting a large EDI document to an IData object, you should process
the document iteratively, segment by segment. To do so, set the iterator input parameter
of the convertToValues service to true. Seing iterator to true causes the convertToValues
service to process just a segment or a group of segments of the document at a time. The
convertToValues service determines how many segments to process based on the flat file
structure information in the flat file schema for the EDI document.
For more information about processing EDI documents iteratively, see "Processing the
Document Iteratively, Segment by Segment" on page 199.

Troubleshooting Memory Constraint Problems

If some or all of the documents that you need Module for EDI to process encounter
problems because of memory constraints, you can do the following:
Configure Module for EDI to handle large documents differently. The
EDIBigDocThreshold EDI configuration property defines a threshold size at which
Module for EDI considers a document to be large. When Module for EDI processes
large documents, rather than keeping them in memory, Module for EDI temporarily
saves the large documents to local hard disk drive space (known as Tspace). The
built-in services provided with Module for EDI automatically recognize when a
document is in Tspace and perform their processing accordingly.

webMethods Module for EDI Installation and User’s Guide Version 9.12 166
 M
Odd Header
Handling Large Documents When Using Trading Networks

For more information about configuring the EDIBigDocThreshold property for large
document handling, see "Defining Module for EDI Properties" on page 26.
Create clients that send documents to Integration Server as InputStreams.
Convert documents to IData objects iteratively by using the iterator parameter in the
wm.b2b.edi:convertToValues service to process a document a segment or section at a time.

webMethods Module for EDI Installation and User’s Guide Version 9.12 167
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 168
 M
Odd Header
Generating Acknowledgments

9   Generating Acknowledgments
■ Overview ..................................................................................................................................... 170
■ Generating Functional Acknowledgments .................................................................................. 170
■ Before You Can Generate a Functional Acknowledgment ........................................................ 172
■ Determining How Module for EDI Reports FA Status ................................................................ 173
■ When to Invoke the generateFA Service ................................................................................... 180
■ Output from the generateFA Service ......................................................................................... 183
■ Tracking Late Functional Acknowledgments .............................................................................. 185
■ Generating Interchange Acknowledgments ............................................................................... 187

webMethods Module for EDI Installation and User’s Guide Version 9.12 169
 M
Even Header
Generating Acknowledgments

Overview
Module for EDI can generate functional acknowledgments (FAs) and interchange
acknowledgments (TA1s) both manually and automatically. The following table lists
what to use to generate acknowledgments and where to find more information.

To... Use the... As described in...

Manually wm.b2b.edi.util:generateFA "Generating Functional

generate FAs service Acknowledgments" on page
170

Manually wm.b2b.edi:generateX12TA1 "Generating Interchange

generate TA1s service Acknowledgments" on page
187

Automatically FAGeneration/ "FAGeneration Variables" on

generate FAs autoGenerateFA EDITPA page 80
Variable

Automatically X12TA1Generation/ "X12TA1Generation Variables"

generate TA1s autoGenerateTA1 EDITPA on page 100
Variable

Generating Functional Acknowledgments

A functional acknowledgment is a transaction set sent by the receiver of an EDI
transmission to the sender, acknowledging that the message has been received and its
syntax is acceptable. Functional acknowledgments do not indicate that the document has
been processed by the receiver.

Note: Functional acknowledgments (FAs) are not applicable to the TRADACOMS

and VDA standards.

Module for EDI provides the wm.b2b.edi.util:generateFA service to generate functional

acknowledgments (FAs). To generate an FA manually, you invoke the generateFA service
from the service that you create to process an inbound EDI document. The generateFA
service automatically determines the EDI standard of the document, performs validation
using a flat file schema, and creates the FA as output.
The following table shows the type of FA that Module for EDI generates based on the
EDI standard of the inbound document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 170
 M
Odd Header
Generating Acknowledgments

EDI Standard Type of FA the Description

Module Generates

ANSI X12 ANSI X12 997 The module generates an FA for each
group in the inbound document.
UCS
VICS

UN/EDIFACT UN/EDIFACT The module generates an FA for each

CONTRL interchange in the inbound document.
EANCOM
ODETTE

The generated FA reports one of the following FA statuses for a transaction, group, or
UN/EDIFACT interchange:

ANSI X12 997 UN/EDIFACT CONTRL Description

N N Not Allowed

R R Rejected

P R Partially Accepted (for groups only)

E R Accepted, But Errors Were Noted

A A Accepted

FA FA EDI document is an FA 997 or CONTRL

NR NR Not Required

Note: The rest of this chapter uses the FA statuses reported when the ANSI X12 997
standard is used. Refer to this table to see the related FA status that is reported
when the UN/EDIFACT CONTRL standard is used.

The value that the generateFA service reports for the FA status depends on whether
a child transaction is allowed in its envelope and the values you specify for the
syntaxErrorStatus , logicalErrorStatus , and childTransactionRejectedStatus input
parameters. For more information, see "Determining How Module for EDI Reports FA
Status" on page 173.

webMethods Module for EDI Installation and User’s Guide Version 9.12 171
 M
Even Header
Generating Acknowledgments

The generateFA service does not specify what to do with the FA that it creates. Therefore,
in addition to invoking the generateFA service to generate the FA, your service should also
invoke a service to deliver the FA to the sender of the original document.

For more information about... See...

How to have Module for EDI "Automatically Generating

automatically generate FAs when you Functional Acknowledgments" on
are using Trading Networks page 275

How to generate a report for FA "Reconciling Functional

reconciliation Acknowledgments" on page
341

The wm.b2b.edi.util:generateFA service webMethods Module for EDI Built-

In Services Reference

Before You Can Generate a Functional Acknowledgment

Before you use the wm.b2b.edi.util:generateFA service to generate FAs, perform the following
tasks:
Ensure that both the flat file schema for the FA and the flat file schema that defines
the structure of the EDI document for which you are generating an FA are created.
For more information about creating flat file schemas, see "Defining TN EDI
Document Types" on page 37.
The generateFA service uses the flat file schema to validate the EDI document.
When generating FAs at the segment and element levels, configure the maximum
number of errors to report per FA transaction. For more information, see
"Configuring the Maximum Number of Transaction Errors" on page 172.

Configuring the Maximum Number of Transaction Errors

When you want to generate FAs at the element or segment level, configure the
maximum number of errors to report per FA transaction. To configure the maximum
number of errors to report, perform the following procedure to update the configuration
in memory (so the changes take effect immediately) and in the WmEDI/config/
properties.cnf file.

To configure the maximum number of transaction errors

1. In My webMethods: Administration > Integration > B2B Settings > Configure Properties.

webMethods Module for EDI Installation and User’s Guide Version 9.12 172
 M
Odd Header
Generating Acknowledgments

2. In the Module for EDI Configuration Properties section, set the

EDIMaxFATransactionErrors property as follows:

Specify this value... To indicate...

n (a positive The maximum number of errors that can be reported for

whole number) any one FA transaction.

-1 Any number of errors can be reported for any one FA

transaction.

For more information about this property, see "Defining Module for EDI Properties"
on page 26.
3. Click Save.

Determining How Module for EDI Reports FA Status

The following table lists the information that the module uses to determine the FA
status for a transaction, group, or UN/EDIFACT interchange of an EDI document when
executing the wm.b2b.edi.util:generateFA service.

Payload Section Information Used to Determine FA Status

Transaction Whether the transaction is allowed in

the group in which it resides. For more
information, see "Determining If the Child
Transaction is Allowed in Its Envelope" on
page 174.
Whether the transaction is an FA (997
or CONTRL). For more information, see
"Determining If a Transaction Is an FA or If a
Group Contains an FA" on page 175.
The value of syntaxErrorStatus . For more
information, see " syntaxErrorStatus
Parameter" on page 175.
The value of logicalErrorStatus . For more
information, see " logicalErrorStatus
Parameter" on page 176.

Group Whether the group is "FA" or "CONTRL".

For more information, see "Determining If a
Note:
The generateFA service will
report FA status for UN/

webMethods Module for EDI Installation and User’s Guide Version 9.12 173
 M
Even Header
Generating Acknowledgments

Payload Section Information Used to Determine FA Status

EDIFACT groups if the Transaction Is an FA or If a Group Contains an
UN/EDIFACT document FA" on page 175.
contains groups.
The value of syntaxErrorStatus . For more
information, see " syntaxErrorStatus
Parameter" on page 175.
The value of logicalErrorStatus . For more
information, see " logicalErrorStatus
Parameter" on page 176.
The value of childTransactionRejectedStatus .
For more information, see "
childTransactionRejectedStatus Parameter" on
page 176.

Interchange (UN/EDIFACT The value of syntaxErrorStatus . For more

only) information, see " syntaxErrorStatus
Parameter" on page 175.
The value of logicalErrorStatus . For more
information, see " logicalErrorStatus
Parameter" on page 176.
The value of childTransactionRejectedStatus .
For more information, see "
childTransactionRejectedStatus Parameter" on
page 176.

Determining If the Child Transaction is Allowed in Its Envelope

When seing the FA status for a child transaction, the generateFA service first determines
whether the child transaction is allowed in its group (and, therefore, its envelope). For
example, it is not valid for an ANSI X12 997 transaction to be in an ANSI X12 PO group.
Similarly, it is not valid for a UN/EDIFACT CONTRL to be in an ORDERS group.
If the child transaction is:
Allowed, the generateFA service determines the values of the syntaxErrorStatus ,
logicalErrorStatus , and childTransactionRejectedStatus parameters for the child
transaction.
Not allowed, the generateFA service sets the FA status to "Not Allowed" and does not
determine the rest of the statuses.

webMethods Module for EDI Installation and User’s Guide Version 9.12 174
 M
Odd Header
Generating Acknowledgments

Determining If a Transaction Is an FA or If a Group Contains an FA

The generateFA service reports the FA status as "FA" when either a transaction is an FA, or
a group contains an FA, as follows:
A transaction is an FA when it is either an ANSI X12 997 or UN/EDIFACT CONTRL
A group is an FA when it is either an ANSI X12 "FA" or a UN/EDIFACT "CONTRL"
group

syntaxErrorStatus Parameter
The syntaxErrorStatus input parameter to the generateFA service indicates how you want
the service to report the syntax error status. syntaxErrorStatus indicates whether syntax
errors exist in the transaction, group, or UN/EDIFACT interchange, for example, missing
mandatory elements, violation of syntax rules, invalid field lengths, code list violations,
or segment repeat counts exceeded.
The following table describes the values of the syntaxErrorStatus input parameter and
their meanings:

Set syntaxErrorStatus to... When you...

Rejected Want the generateFA service to reject the element (for

example, the transaction) because of syntax errors.
Reports the syntax error status as:
"Accepted" if there are no syntax errors
"Rejected" if there are syntax errors

Accepted, But Want to know whether there were syntax errors,

Errors Were Noted but do not want to reject the element (for example,
transaction) because of syntax errors.
Reports the syntax error status as:
"Accepted" if there are no syntax errors
"Accepted, But Errors Were Noted" if there are syntax
errors

Accepted Do not want to check for syntax errors.

Always reports the syntax error status as "Accepted"
regardless of whether there are any syntax errors.

webMethods Module for EDI Installation and User’s Guide Version 9.12 175
 M
Even Header
Generating Acknowledgments

logicalErrorStatus Parameter
The logicalErrorStatus input parameter to the generateFA service indicates how you want
the service to report the logical error status. The logical error status indicates whether
the transaction, group, or UN/EDIFACT interchange is malformed. For example:
The control number in a header does not match the control number in the
corresponding trailer.
The segment count in a trailer does not have an accurate group, transaction, or
segment count.
The following table describes the values of the logicalErrorStatus input parameter and
their meanings:

Set logicalErrorStatus To have the generateFA service...

to...

Rejected Report the logical error status as:

"Accepted" when there are no logical errors
"Rejected" when there are logical errors
Use this seing when you want to reject the element (for
example, transaction) because of logical errors.

Accepted, But Report the logical error status as:

Errors Were Noted
"Accepted" if there are no logical errors
"Accepted, But Errors Were Noted" when there are
logical errors
Use this seing when you want to know whether there
were logical errors but do not want to reject the element
(for example, transaction) because of logical errors.

Accepted Always reports the logical error status as “Accepted”

regardless of whether there are any logical errors.
Use this seing when you do not want to check for logical
errors.

childTransactionRejectedStatus Parameter
The childTransactionRejectedStatus input parameter to the generateFA service indicates
how you want the service to report the child transaction rejected status. The child

webMethods Module for EDI Installation and User’s Guide Version 9.12 176
 M
Odd Header
Generating Acknowledgments

transaction rejected status indicates whether child elements of a group or UN/EDIFACT

interchange have an FA status of "Rejected". That is:
For a group, whether any transaction within a group has an FA status of "Rejected"
For a UN/EDIFACT interchange, whether any transaction or group within the
interchange has an FA status of "Rejected"
The following table describes how the generateFA service sets the child transaction
rejected status based on the value of the childTransactionRejectedStatus input parameter
and the FA statuses of the child transactions:

When the FA status of... And the The generateFA

childTransactionRejectedStatus service sets the child
is set to... transaction rejected
status to...

Every child transaction is Rejected Accepted

Accepted
Partially Accepted Accepted

Accepted, But Errors Accepted

Were Noted

At least one child Rejected Rejected

transaction is Accepted,
But Errors Were Partially Accepted Accepted, But
Noted -AND- no child Errors Were Noted
transactions are Accepted
Accepted, But Errors Accepted, But
Were Noted Errors Were Noted

At least one child Rejected Rejected

transaction is “Accepted,
But Errors Were Noted - Partially Accepted Partially Accepted
AND- at least one child
transaction is Accepted
Accepted, But Errors Accepted, But
Were Noted Errors Were Noted

Every child transaction is Rejected Rejected

Rejected
Partially Accepted Rejected

Accepted, But Errors Rejected

Were Noted

webMethods Module for EDI Installation and User’s Guide Version 9.12 177
 M
Even Header
Generating Acknowledgments

How Module for EDI Determines Which FA Status to Use

After determining the syntax error status, logical error status, and child transaction
rejected status (if applicable), the generateFA service determines the FA status for a
transaction, group, or UN/EDIFACT interchange.

Transaction FA Status
The generateFA service uses the most restrictive value in the following list when seing
the FA status for a transaction:
Whether the transaction is an FA (997 or CONTRL). For more information about
transactions that are not allowed, see "Determining If a Transaction Is an FA or If a
Group Contains an FA" on page 175.
Syntax error status. For more information about how the module sets the syntax
error status, see " syntaxErrorStatus Parameter" on page 175.
Logical error status. For more information about how the module sets the logical
error status, see " logicalErrorStatus Parameter" on page 176.
The following table shows the possible combinations of values and how the generateFA
service sets the FA status for a transaction based on these values.

Module for EDI When the transaction has the following statuses...
reports this
FA status for a Is transaction Is the Syntax Error Logical Error
transaction... allowed? transaction an Status Status
FA?

Not No Yes Any syntax Any logical

Allowed error status error status

FA Yes Yes Any syntax Any logical

error status error status

Rejected Yes No At least one status is Rejected

Accepted, Yes No Statuses are either Accepted,

But Errors But Errors Were Noted OR
Were Noted Accepted, AND at least one
status is Accepted, But Errors
Were Noted

Accepted Yes No Accepted Accepted

webMethods Module for EDI Installation and User’s Guide Version 9.12 178
 M
Odd Header
Generating Acknowledgments

Group FA Status
The generateFA service uses the most restrictive value in the following list when seing
the FA status for a group:
Whether the group is "FA" or "CONTRL". For more information, see "Determining If
a Transaction Is an FA or If a Group Contains an FA" on page 175.
Syntax error status. For more information about how the module sets the syntax
error status, see " syntaxErrorStatus Parameter" on page 175.
Logical error status. For more information about how the module sets the logical
error status, see " logicalErrorStatus Parameter" on page 176.
Child transaction rejected status. For more information about how the module sets
the child transaction rejected error status, see " childTransactionRejectedStatus
Parameter" on page 176.
The following table shows the possible combinations of values and how the generateFA
service sets the FA status for a group based on these values.

Module for EDI When the group has the following statuses...
reports this
FA status for a Is group Syntax Error Logical Error Child
group... either "FA" or Status Status Transaction
"CONTRL"? Rejected Status

FA Yes Any syntax Any logical Any child

error status error status transaction
rejected
status

Rejected No At least one status is Rejected

Partially No Accepted, Accepted, Partially

Accepted But Errors But Errors Accepted
Were Were
Noted OR Noted OR
Accepted Accepted

Accepted, No Accepted, But Errors Were Noted OR Accepted,

But Errors AND at least one status is Accepted, But Errors
Were Noted Were Noted

Accepted No Accepted Accepted Accepted

webMethods Module for EDI Installation and User’s Guide Version 9.12 179
 M
Even Header
Generating Acknowledgments

UN/EDIFACT Interchange FA Status

The generateFA service uses the most restrictive value in the following list when seing
the FA status for a UN/EDIFACT interchange:
Syntax error status. For more information about how the module sets the syntax
error status, see " logicalErrorStatus Parameter" on page 176.
Logical error status. For more information about how the module sets the logical
error status, see " logicalErrorStatus Parameter" on page 176.
Child transaction rejected status. For more information about how the module sets
the child transaction rejected error status, see " childTransactionRejectedStatus
Parameter" on page 176.
The following table shows the possible combinations of values and how the generateFA
service sets the FA status for a UN/EDIFACT interchange based on these values.

Module for EDI When the interchange has the following statuses...
reports this FA
status for an Syntax Error Status Logical Error Status Child Transaction
interchange... Rejected Status

Rejected At least one status is Rejected

Partially Accepted, But Accepted, But Partially

Accepted Errors Were Errors Were Accepted
Noted OR Noted OR
Accepted Accepted

Accepted, But Statuses are either Accepted, But Errors Were Noted OR
Errors Were Accepted, AND at least one status is Accepted, But Errors
Noted Were Noted

Accepted Accepted Accepted Accepted

Not Required Any syntax error Any logical error Any child
status status transaction
rejected status

When to Invoke the generateFA Service

You invoke the wm.b2b.edi.util:generateFA service from the service you created to process
an inbound EDI document. At what time during processing you wish to invoke the
generateFA service depends on whether the service you created processes the EDI

webMethods Module for EDI Installation and User’s Guide Version 9.12 180
 M
Odd Header
Generating Acknowledgments

document all at once or iteratively, segment by segment. For more information about
these two options, see "Determining Which Process Method to Use" on page 193.
For more information about the wm.b2b.edi.util:generateFA service, see webMethods Module
for EDI Built-In Services Reference.

Using a Service that Processes Documents at One Time

When you use a service that processes the entire EDI document at one time, you can
invoke the generateFA service either before invoking the wm.b2b.edi:envelopeProcess service
or immediately after invoking the envelopeProcess service. For more information about
processing the entire document at one time, see "Processing the Entire Document at One
Time" on page 194.

Invoking generateFA Before Invoking envelopeProcess

When you invoke the generateFA service before the envelopeProcess service, the service uses
the unparsed EDI document as input. The unparsed document is in the pipeline in the
edidata parameter. The edidata parameter is placed in the pipeline by an EDI content
handler. For more information about the edidata parameter, see "Inputs to Your Service"
on page 192.
The following diagram shows an updated version of the service illustrated in
"Processing the Entire Document at One Time" on page 194, which includes
invocation of the generateFA service. Note that in the Pipeline section of the screen, the
edidata parameter in Pipeline In is mapped to the edidata in Service In.

After invoking the generateFA service to generate the FA, add logic or invoke a service
that you create to deliver the FA to the sender of the original EDI document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 181
 M
Even Header
Generating Acknowledgments

Invoking generateFA Immediately after Invoking envelopeProcess

When you invoke the generateFA service after the envelopeProcess service, you can pass
the parsed EDI document that is output from the envelopeProcess service to the generateFA
service as input.

Note: If you are using previously parsed and validated data as input to the
generateFA service, the input data must be the correctly formaed results of
proper services, that is, the error array must be included in the results.

The following diagram shows an updated version of the service that was illustrated
in "Processing the Entire Document at One Time" on page 194 which includes the
invocation of the generateFA service. In the Pipeline section of the screen, the Values
parameter in Pipeline In is the output from the envelopeProcess service. The ICValues
parameter in Service In is the input parameter to the generateFA service that accepts a
parsed EDI document. In the Pipeline section of the screen, map the Values parameter to
the ICValues parameter, as shown.

After invoking the generateFA service to generate the FA, add logic or invoke a service
that you create to deliver the FA to the sender of the original EDI document.

Using a Service that Processes Documents Iteratively

When you use a service that processes the EDI document iteratively, segment by
segment, invoke the generateFA service before performing other processing. For more
information about applying logic to a service that processes documents iteratively, see
"Processing the Document Iteratively, Segment by Segment" on page 199.
When you invoke the generateFA service, the service uses the unparsed EDI document as
input. The unparsed document is in the pipeline in the edidata parameter. The edidata

webMethods Module for EDI Installation and User’s Guide Version 9.12 182
 M
Odd Header
Generating Acknowledgments

parameter is placed in the pipeline by an EDI content handler. For more information
about the edidata parameter, see "Inputs to Your Service" on page 192.
The following diagram shows an updated version of the service illustrated in
"Processing the Document Iteratively, Segment by Segment" on page 199, which
includes invocation of the generateFA service. Note that in the Pipeline section of the
screen, the edidata parameter in Pipeline In is mapped to the edidata parameter in Service
In.

After invoking the generateFA service to generate the FA, add logic or invoke a service
that you create to deliver the FA to the sender of the original EDI document.

Output from the generateFA Service

The output from the wm.b2b.edi.util:generateFA service is the FA itself. The following table
summarizes the information in the generated FA, including items that Module for EDI
sets in the:
BizDocEnvelope that the module creates for the FA. When defining a Trading
Networks processing rule to deliver the FA, you use the BizDocEnvelope
information when defining the processing rule criteria.
Interchange header of the FA.
Group header of the FA.
Transaction header (997 for ANSI X12 or CONTRL for UN/EDIFACT).

Item Setting Value

BizDocEnvelope sender The receiver from the inbound

document's interchange header

webMethods Module for EDI Installation and User’s Guide Version 9.12 183
 M
Even Header
Generating Acknowledgments

Item Setting Value

receiver The sender from the inbound

document's interchange header

TN document For ANSI X12: X12 Envelope

type
For UN/EDIFACT: EDIFACT Envelope

EDI FA Outbound true

custom aribute

Interchange header sender The receiver from the inbound

document's interchange header

receiver The sender from the inbound

document's interchange header

control number The value is based on the

FAGeneration/generateControlNumber
EDITPA variable

Group sender The receiver from the inbound

document's group header

receiver The sender from the inbound

document's group header

control number The value is based on the

FAGeneration/generateControlNumber
EDITPA variable

Transaction header control number 001

Because the generateFA service does not specify what to do with the FA that it has created,
any service that you use or develop that calls the generateFA service must also invoke a
service to deliver the FA to the original sender.
Each FA contains a code that indicates whether the validation was successful. This code
appears in a different position for each level. For example, the code in a Transaction Set
level FA will appear in AK501. For more information about the location of this code in
your documents, see the documentation for your EDI standard and version.
The appropriate position of the transaction, group, or UN/EDIFACT interchange
will contain one of the codes listed in the table of possible FA statuses in "Generating
Functional Acknowledgments" on page 170.

webMethods Module for EDI Installation and User’s Guide Version 9.12 184
 M
Odd Header
Generating Acknowledgments

Tracking Late Functional Acknowledgments

Tracking late functional acknowledgments based on sender, receiver, and document
type of the transactions can help you analyze the documents that are acknowledged late
by your partners.
Module for EDI supports the tracking of late FAs for a partner pair or at a group level of
a partner pair.
For partner pair level tracking, the module supports tracking late functional
acknowledgments of EANCOM, ODETTE, UCS, UNEDIFACT, VICS, and X12
standard documents.
For group level tracking for a partner pair, the module supports tracking of group
level late functional acknowledgments of X12 standard documents and X12 sub-
standard documents.

Before Tracking Late FAs

Before tracking late FAs, you must define the LateFA variables in the partner-specific
EDITPAs in the Trading Partner Agreement Details screen, as follows:
In the EDITPA where your partner is the receiver, specify the following EDITPA
variables:
LateFA/LateFATime variable
Specify the time in minutes by which Trading Networks must receive the FA for
a partner pair.
LateFA/LateFAForX12Group variables:
LateFA/LateFAForX12Group/groupType variable
Specify the groups used for tracking late FAs.
LateFA/LateFAForX12Group/LateFATime variable
Specify the time in minutes by which Trading Networks must receive the FA.
For more information about these variables, see "Defining Trading Partner
Information" on page 57.
In the EDITPA where you are the receiver, set the FAReconciliation EDITPA variable
to true so that Module for EDI can map the late FAs to the original document and
track the late FAs. If the value of the FAReconciliation EDITPA variable is false, the
module cannot track the late FAs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 185
 M
Even Header
Generating Acknowledgments

Tracking Late FAs

Once you have edited the LateFA variables in the partner-specific EDITPAs, you can
track Late FAs using the following procedure.

To track late FAs

1. In My webMethods: Monitoring > Integration > B2B > Transactions.
2. Select the transaction for which you want to track late FAs.
3. In the Transaction Details section of the Transactions page, view the status of the
Late FA aribute for the transaction you selected. If the Late FA aribute is set to Y,
then the corresponding document has received a late functional acknowledgment.
For more information about managing and tracking your documents, see the webMethods
Trading Networks User’s Guide for your release.

Example
In this example, consider that partner A is the sender and partner B is the receiver.
Partner A wants to track the late FAs for PO and IN groups of X12 standard documents.
Partner A must:
1. Set the LateFATime variable for both the LateFA/LateFATime and the LateFA/
LateFAForX12Group partner-specific EDITPA variables
2. Set the FAReconciliation EDITPA variable to true in the EDITPA where partner A is
the receiver, so that the module can map the late FAs to the original document and
track the late FAs
Partner A sets the LateFA/LateFATime and the LateFA/LateFAForX12Group partner-
specific EDITPA variables as follows:

For the LateFA/LateFATime EDITPA variable:

LateFATime Value

For the LateFA/LateFAForX12Group EDITPA variable:

Group Type LateFATime Value

PO 2

IN 3

webMethods Module for EDI Installation and User’s Guide Version 9.12 186
 M
Odd Header
Generating Acknowledgments

When partner A sends X12 documents to partner B, the module sets the Late FA
aribute of the original document in Trading Networks to Y when any of the following
conditions occur:
Partner A receives the functional acknowledgment for the PO group more than two
minutes later.
Partner A receives the functional acknowledgment for the IN group more than three
minutes later.
Partner A receives the functional acknowledgments for any other group more than
one minute later.
Module for EDI sets the Late FA aribute of the original document in Trading Networks
to N when the FA is not late.

Generating Interchange Acknowledgments

When an X12 interchange contains a control header and trailer envelope that surround
one or more functional groups, an Interchange Acknowledgment (TA1) notifies the sender
whether the receiver successfully processed the interchange header and trailer.
The TA1 does not report the status of the functional groups and transaction sets within
the interchange envelope.
The format of a TA1 looks as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 187
 M
Even Header
Generating Acknowledgments

Field Description

Interchange Uniquely identifies the interchange. The sender assigns the

control number interchange control number, which, along with the sender ID,
uniquely identifies the interchange data to the recipient.

Interchange date Indicates the date, in YYMMDD format, when the interchange
was prepared. For example, if the interchange was prepared on
January 2, 2014, the interchange date would be 140102.

Interchange time Indicates the time, in 24-hour format (HHMM), when the
interchange was prepared.

Interchange Indicates the Interchange Acknowledgment Code, as agreed

acknowledgment upon by trading partners. Valid values are:
code
A—Accepted

R—Rejected

E—Accepted, but the file contains errors and must be

resubmied.

webMethods Module for EDI Installation and User’s Guide Version 9.12 188
 M
Odd Header
Generating Acknowledgments

Field Description

TA1 code A three-digit number that corresponds to a TA1 code. For more
information about TA1 codes, see "TA1 Status and TA1 Code" on
page 218.

Module for EDI provides a built-in service, wm.b2b.edi:generateX12TA1, to generate a TA1

acknowledgment. While generating the TA1 acknowledgment, this service provides
the option to include a functional acknowledgment, as well. To generate a TA1 with or
without an FA, you invoke the generateX12TA1 service from the service that you create to
process an EDI document.
For more information about the wm.b2b.edi:generateX12TA1 service, see webMethods Module
for EDI Built-In Services Reference.

webMethods Module for EDI Installation and User’s Guide Version 9.12 189
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 190
 M
Odd Header
Before Creating the Service to Process EDI Documents

10   Before Creating the Service to Process EDI

Documents

■ Overview ..................................................................................................................................... 192

■ Inputs to Your Service ................................................................................................................ 192
■ Logic to Include in the Service to Process EDI Documents ...................................................... 193
■ Samples ...................................................................................................................................... 205

webMethods Module for EDI Installation and User’s Guide Version 9.12 191
 M
Even Header
Before Creating the Service to Process EDI Documents

Overview
The WmEDI package of Module for EDI provides built-in services that support
functions required by the EDI standard. When you create the service that processes
your EDI documents, you add logic to invoke the Module for EDI built-in services.
This chapter contains information about how to create the service to process an EDI
document. For information about how to process an inbound EDI document, see the
webMethods Module for EDI Concepts Guide.
Before you create the service to process EDI documents that are sent to your Integration
Server, you must create:
The flat file schema that defines the structure of the EDI document to process.
Module for EDI uses the flat file schema for parsing, converting, and validating an
inbound EDI document.
Optionally, the flat file schema that defines the structure of the internal-format
document. This is the document that your service will send to your internal
application (for example, a back-end system). Module for EDI provides a service that
you can have your service invoke to create your internal-format document based
on the flat file schema. Use Software AG Designer to create the flat file schema. For
more information, see Flat File Schema Developer’s Guide.

Inputs to Your Service

The service you create should accept the edidata parameter that the Module for EDI
content handler placed in the pipeline as input. The data type of the edidata parameter
depends on the content type you use:

If you use this content type... The data type of edidata is...

application/EDIstream InputStream

application/EDI, application/X12, or String

application/UNEDIFACT

Note: It is recommended that your client use the content type application/
EDIstream. The other content types (application/EDI, application/X12, and
application/UNEDIFACT) are provided for backward compatibility. For more
information, see "Defining the Content Type to Use" on page 144.

webMethods Module for EDI Installation and User’s Guide Version 9.12 192
 M
Odd Header
Before Creating the Service to Process EDI Documents

Logic to Include in the Service to Process EDI Documents

You can perform any processing on the EDI document that you want. For example, you
can:
Map information from the EDI document into one or more internal-format
documents. The internal-format is the format that an internal application (for
example, a back-end system) requires. Then send the internal-format document to
the internal application.
Map information from the EDI document to the inputs of a service and then invoke
the service.
This chapter focuses on the first case, mapping data to format an internal-format
document. However, you can apply the principles that are presented to other processing
you might want to accomplish.
Additionally, you can generate and send functional acknowledgments (FAs) for EDI
documents. For more information, see "Generating Acknowledgments" on page 169.

Determining Which Process Method to Use

There are two basic ways to process documents:
Process the entire document at one time. With this method, you invoke services that
consume the entire EDI document at one time and then you can process it. Use this
method to process EDI documents that have smaller transaction sets.
Process the document iteratively, segment by segment. With this method, you
process the document by working on one segment at a time (or groups of segments
at a time). When you finish one segment or a group of segments, you work on the
next. This method is useful when working with larger transaction sets that can easily
be parsed into smaller units (for example, a large 810 document containing many
line-item segments). For more information about handling large documents, see
"Handling Large Documents When Using Trading Networks " on page 163.
The table below lists the advantages and disadvantages of each method:

Processing Advantages Disadvantages

Method

Processing Easier to implement Requires more memory

the entire because most of the because an IData object
document at processing and set up you is created for the entire
one time need to do is provided with document.
Module for EDI.
You can use built-in
services to perform

webMethods Module for EDI Installation and User’s Guide Version 9.12 193
 M
Even Header
Before Creating the Service to Process EDI Documents

Processing Advantages Disadvantages

Method
envelope validation and
compliance checks. For
more information about
envelope validation and
compliance checks, see
"Performing Envelope
Validation and Compliance
Checks" on page 198.

Processing Requires less memory If you want to perform

the document because as the segments envelope validation and
segment by are being processed, an compliance checks, you
segment IData object is created must add your own logic to
for only the segment or do so.
group of segments that
You likely will need to
represent repeating content
modify the flat file schema
(for example, line items).
for the EDI document you
Then, when working on
are processing.
subsequent segments, the
memory is reused. You might need to create
additional flat file schemas
for segments within the
EDI document you are
processing.

Processing the Entire Document at One Time

The following diagram shows sample code that includes the basic logic you would
apply to process an entire inbound EDI document at one time. This processing shows
how to map information from the EDI document to an internal-format document and
then send the document to an internal application, for example, a back-end system. For
information about all of the built-in services that the sample uses, see webMethods Module
for EDI Built-In Services Reference.

webMethods Module for EDI Installation and User’s Guide Version 9.12 194
 M
Odd Header
Before Creating the Service to Process EDI Documents

Flow Description
Operation

1 Invoke the wm.b2b.edi:envelopeProcess service to process the

envelopes in the inbound EDI document. This service consumes
the entire EDI document and converts all of its envelope header
segments, including transaction set header segments, into an IData
object named Values. That is:
For an ANSI X12 document, it creates an IData object of the ISA/
IEA, GS/GE and ST/SE headers/trailers.
For a UN/EDIFACT document, it creates an IData object of the
UNB/UNZ, UNG/UNE, and UNH/UNT headers/trailers.
After the header segments are converted to the Values IData object,
your service can access and act on data elements within the header
segments of the EDI document.
The contents of the transaction sets remain unparsed. How the
service handles the transaction set contents is based on whether
the document is considered large. For more information, see
"Handling Large Documents When Using Trading Networks " on
page 163.
For documents not considered large, the service leaves the
transaction set contents in String format. The service assigns the
transaction set body to the unDefData parameter that is in the
Values IData object under the transaction set header. For example,
for an ANSI X12 document, the content would be in the elements
Values/ISA/GS/ST/unDefData . The parameter name unDefData
refers to the fact that the content has not yet been processed.
For documents considered large, the service writes the
transaction set contents to hard disk drive storage. When data is
wrien to the hard disk drive storage, it is assigned a reference ID

webMethods Module for EDI Installation and User’s Guide Version 9.12 195
 M
Even Header
Before Creating the Service to Process EDI Documents

Flow Description
Operation
that is used to access the data. The service assigns the reference
ID for the transaction set contents to the element _RID_ , which
is in the Values IData object under the transaction set header.
For example, for a UN/EDIFACT document that contains group
envelopes, the reference ID would be in the elements Values/UNB/
UNG/UNH/_RID_ . For more information about how Module for
EDI handles large documents, see "Handling Large Documents
When Using Trading Networks " on page 163.
Additionally, the envelopeProcess service can perform an optional
check for basic compliance on the interchange envelope. You
specify whether to perform the compliance check by seing
two optional input parameter for the envelopeProcess service. For
more information about the compliance check, see "Performing
Envelope Validation and Compliance Checks" on page 198.

2 Add your own logic to handle errors that might result from
executing the wm.b2b.edi:envelopeProcess service, for example errors
with the compliance check.

3 Loop through the interchange envelope headers. The data for the
interchange headers is within the Values IData object. The sample
code shows the loop over Values/<InterchangeHeader> . If you are
processing:
ANSI X12 document, the interchange headers are in Values/ISA .
UN/EDIFACT document, the interchange headers are in Values/
UNB .

4 Loop through the group envelope headers. The data for the group
headers is within the Values IData object. The sample code shows
the loop over Values/<InterchangeHeader>/GroupHeader . If you are
processing:
ANSI X12 document, the group headers are in Values/ISA/GS .
UN/EDIFACT document and the document has group headers,
the group headers are in Values/UNB/UNG .
If you are processing an UN/EDIFACT document that
might not contain group headers, your processing will
need to be slightly different. For sample code, see the
sampleServices:UNEDIFACTToValues in the WmEDIsamples package,
which is located under Code Samples in the Technical community
area of the Empower Product Support website at hps://

webMethods Module for EDI Installation and User’s Guide Version 9.12 196
 M
Odd Header
Before Creating the Service to Process EDI Documents

Flow Description
Operation
empower.softwareag.com. The samples in this folder have been
certified by Software AG.

5 Loop through the transaction set headers. The data for the
transaction set headers is within the Values IData object. The
sample code above shows the loop over Values/<InterchangeHeader>/
GroupHeader/<Transaction> . If you are processing:
ANSI X12 document, the transaction set headers are in Values/ISA/
GS/ST .
UN/EDIFACT document, the transaction set headers are in Values/
UNB/UNG/UNH.

The remaining steps specify processing to perform for the content of each
transaction.

Flow Description
Operation

6 Invoke the wm.b2b.edi.util:getEDIstring service to convert the

transaction set header and trailer back to a String and concatenate
them with the transaction set contents. The resulting transaction
set with header and trailer can be either a String or InputStream.
You need to have an element that contains the entire transaction
set, including header and trailer, before you can invoke the
wm.b2b.edi:convertToValues service. This is because the convertToValues
service uses a flat file schema for the EDI transaction set that
includes the transaction set header and trailers. If you input data
without the header and trailer, the convertToValues service will return
errors.

7 Invoke the wm.b2b.edi:convertToValues service to:

Convert the EDI transaction set that is in either String or
InputStream format to an IData object
Validate the transaction EDI structure
The inputs to the convertToValues service include the output from
the wm.b2b.edi.util:getEDIstring service (the String or InputStream)
and the flat file schema for the EDI document. The convertToValues
service uses the flat file schema to both determine how to parse the
transaction set into an IData object and to validate its structure.

webMethods Module for EDI Installation and User’s Guide Version 9.12 197
 M
Even Header
Before Creating the Service to Process EDI Documents

Flow Description
Operation

8 Map data from the EDI transaction sets to the internal-format

document.
Now that the content of the transaction set is an IData object, you
can access the data in the transaction set content to map it to an
IData object for the internal-format document. Depending on the
complexity of your mapping requirements, you might need to add
more logic than a MAP flow operation or create a separate service
to perform the mapping.

9 Invoke the wm.b2b.edi:convertToString service to convert the internal-

format document from an IData object to String format.
The inputs to the convertToString service include the IData object that
contains the data for your internal-format document and the flat
file schema for the internal-format document. The convertToString
service uses the flat file schema to determine how to form the
internal-format document. Alternatively, the convertToString service
can accept an IS document type to define the structure of the
internal-format document.

10 Add your own logic or invoke a service that you create to send
the internal-format document to your internal application, for
example, a back-end system.

Performing Envelope Validation and Compliance Checks

While processing an envelope, the wm.b2b.edi:envelopeProcess service optionally can
validate the envelope against the predefined flat file schema for non-TRADACOMS
documents. The service also can perform compliance checks against the interchanges.
When you invoke the wm.b2b.edi:envelopeProcess service, you can set the following input
parameters to true to have the service perform the associated validation or compliance
check:

Set this input To have the wm.b2b.edi:envelopeProcess service...

parameter to true...

validate Validate the interchange envelope. For ANSI X12 and UN/
EDIFACT standards this includes validating field lengths,
code lists, ranges, and partitions. If the service finds any
errors, it records them in the errorArray output parameter.
The interchange envelopes are validated against the EDI
flat file schema for the EDI document. Module for EDI ships

webMethods Module for EDI Installation and User’s Guide Version 9.12 198
 M
Odd Header
Before Creating the Service to Process EDI Documents

Set this input To have the wm.b2b.edi:envelopeProcess service...

parameter to true...
with EDI flat file schemas for ANSI X12 and UN/EDIFACT
envelope validation and compliance checks. They are located
in the wm.b2b.edi.EDIFFSchema folder.

complianceCheck Check for matching interchange control numbers, matching

group control numbers, matching transaction control
numbers, segment counts, transaction counts, and group
counts. After the first error is detected, the error service stops
executing.

If you set both the complianceCheck and validate parameters to true, the envelopeProcess
service performs the interchange envelope validation first, followed by the compliance
check.

Processing the Document Iteratively, Segment by Segment

You can process a document segment by segment instead of all at once. You can process
either a single segment or a group of segments at one time. To process segment by
segment, when you invoke the wm.b2b.edi:convertToValues service to convert data from
String to an IData object, set the iterator input parameter to true. This causes the
convertToValues service to process just a segment or a group of segments of the document.
The convertToValues service determines how many segments to process based on the
flat file structure information in the flat file schema for the EDI document. Because the
convertToValues service uses the flat file schema, you will need to customize the flat file
schema for the EDI document.

Customizing the EDI Flat File Schema

The following procedure describes the high-level steps required to customize the EDI
flat file schema for iterative processing using Designer. For more detailed information
about managing flat file schemas, see the Flat File Schema Developer’s Guide.

Step Description

1 If you created the EDI flat file schema from a SEF file, add the elements
for the interchange envelopes and group envelopes into the flat file
structure.
SEF files do not describe these elements. Your service will execute the
wm.b2b.edi:convertToValues service against the entire EDI document rather
than just a transaction set or file. As a result, the flat file schema needs to
reflect the envelope structure.

webMethods Module for EDI Installation and User’s Guide Version 9.12 199
 M
Even Header
Before Creating the Service to Process EDI Documents

Step Description

2 Update the flat file structure to reflect how you want the convertToValues
service to return segments.
When you execute the convertToValues service with the iterator input
parameter set to true, the convertToValues service uses the flat file structure
to determine the number of segments to process into an IData object. It
starts processing at a top-level element and processes all of its children
into an IData object in one invocation. For example, if you want the
first invocation to return only the ISA header information, update the
structure as follows:
ISA
ISA01
ISA02
ISA03
ISA04
ISA05
ISA06
ISA07
ISA08
ISA09
ISA10
ISA11
ISA12
ISA13
ISA14
ISA15
ISA15
GS
.
.
.

Because GS is not a child under ISA, the convertToValues service would

return only the ISA entry as an IData object. A subsequent call would act
on the GS entry.

3 Identify the repeating sections of the EDI document that you want to
loop over to process and remove these sections from the flat file schema
structure. For example, in an ANSI X12 810 document, you might want
to loop over the IT1 (line item) segments because you want the line items
included in the invoice.

webMethods Module for EDI Installation and User’s Guide Version 9.12 200
 M
Odd Header
Before Creating the Service to Process EDI Documents

Step Description

4 During execution of the convertToValues service with the updated flat file
schema, when the service encounters sections of the document that are
not defined in the flat file schema structure, it places those sections as
unparsed in the returned IData object. The unparsed sections will be
in either an element named unDefData , or in an element named _RID_
if the document is considered large. For more information about large
documents, see "Handling Large Documents When Using Trading
Networks " on page 163.

webMethods Module for EDI Installation and User’s Guide Version 9.12 201
 M
Even Header
Before Creating the Service to Process EDI Documents

Step Description

5 Create new flat file schemas for the sections that you removed from the
EDI flat file schema.
In your service, you will perform a second pass of the convertToValues
service for the unparsed sections of the document. When you invoke the
convertToValues service for the second pass, the input flat file schema is this
new flat file schema that you are creating that defines the structure of the
data left unparsed, that is, a repeating section of the document that you
want to process iteratively.

Logic for the Service to Process the Document Iteratively

This section describes the sample code for processing an inbound EDI document
iteratively. The steps for processing show how to map information from the line item
segments of an ANSI X12 810 document into an internal-format document, and then
send the document to an internal application, for example, a back-end system. For more
information about all of the built-in services that the sample uses, see webMethods Module
for EDI Built-In Services Reference.

webMethods Module for EDI Installation and User’s Guide Version 9.12 202
 M
Odd Header
Before Creating the Service to Process EDI Documents

Flow Description
operation

1 Repeatedly invoke the wm.b2b.edi:convertToValues service until your

service has processed the entire EDI document. When you pass the
iterator input parameter as true to the convertToValues service, the
output contains the object ediObject, , which is used to keep track of
the input data segments. When the entire EDI document has been
processed, EDIObject becomes null.

2 In the outer REPEAT loop, invoke the convertToValues service to:

Convert a segment or group of segments to an IData object
Validate the EDI structure
The inputs to the convertToValues service include the String or
InputStream that represents the EDI document and the customized
flat file schema for the EDI document. The convertToValues service
uses the flat file schema to determine how many segments to read.
It returns the object ediObject , which keeps track of its location in
the EDI document. This object is input to subsequent invocations
of the convertToValues service to ensure the service continues where it
left off at the last invocation.

3 Add BRANCH flow operations for each type of segment you

expect the convertToValues service to return.

webMethods Module for EDI Installation and User’s Guide Version 9.12 203
 M
Even Header
Before Creating the Service to Process EDI Documents

Flow Description
operation

For example, the first BRANCH under the call to the convertToValues
service checks for an ISA element in the returned IData object,
EDIValues . If EDIValues/ISA exists and is not null, the flow service
executes the logic under the BRANCH on ‘EDIVAlues/ISA' flow
operation.

4 Prepare to invoke the convertToValues service against the unparsed

sections of the document. An unparsed section is a section for
which the EDI flat file schema for the EDI document did not have
flat file structure and for which you created a separate flat file
schema.
Save information about where you are in processing the EDI
document. The MAP flow operation saves the values of the
ediObject and EDIFFSchema that the convertToValues service in the
outer REPEAT loop is using.
Map the fully-qualified name of the flat file schema you created
for the repeating section of the document into the EDIFFSchema
parameter. Make sure the value of ediObject is null.

5 Repeatedly invoke the convertToValues service in this inner REPEAT

loop to process an unparsed section of the document.

6 Invoke the wm.b2b.edi.util:EDIconcat service to prepare the unparsed

section for the call to the convertToValues service.
The EDIconcat service automatically gets its input from either
the unDefData or _RID_ elements that the first pass of the
convertToValues service left in the pipeline for the unparsed sections.
You can use the EDIconcat service to add a header, a trailer, or both a
header and trailer to the unparsed data, if needed.

7 In the inner REPEAT loop, invoke the convertToValues service to:

Convert the unparsed section to an IData object
Validate the EDI structure
Pass the output from the EDIconcat service (output parameter)
to the edidata input parameter of the convertToValues service. In a
previous flow operation, you set the value of the EDIFFSchema
input parameter to the fully-qualified name of the flat file schema
to use for this unparsed section of the EDI document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 204
 M
Odd Header
Before Creating the Service to Process EDI Documents

Flow Description
operation

8 Map data from the unparsed section into the internal-format

document. Depending on the complexity of your mapping
requirements, you might need to add more logic than a MAP flow
operation, or create a separate service to perform the mapping.

9 Invoke the convertToString service to convert the internal-format

document from an IData object to String format.
The inputs to the convertToString service include the IData object that
contains the data for your internal-format document and the flat
file schema for the internal-format document. The convertToString
service uses the flat file schema to determine how to form the
internal-format document. Alternatively, the convertToString service
can accept an IS document type to define the structure of the
internal-format document.

10 Add your own logic or invoke a service that you create to send
the internal-format document to your internal application, for
example, a back-end system.

11 Restore the values of the ediObject and EDIFFSchema parameters,

which you saved in a previous flow operation, in preparation for
invoking the convertToValues service in the outer REPEAT loop.

Note: If you want to perform the interchange (or transmission) envelope validation
and the compliance check, you need to add logic to your service to do so.
For more information, see "Performing Envelope Validation and Compliance
Checks" on page 198.

Samples
For samples, see the flow services in the sampleServices folder of the WmEDIsamples
package, which is located under Code Samples in the Technical community section of
the Empower Product Support website at hps://empower.softwareag.com. The samples
in this folder have been certified by Software AG.
The sampleServices:X12toValues service illustrates how to use the
wm.b2b.edi:convertToValues service to convert an ANSI X12 document to an IData object
at one time and process it.
The sampleServices:UNEDIFACTtoValues service illustrates how to use the
wm.b2b.edi:convertToValues service to convert a UN/EDIFACT document to an IData
object at one time and process it.

webMethods Module for EDI Installation and User’s Guide Version 9.12 205
 M
Even Header
Before Creating the Service to Process EDI Documents

The sampleServices:Iterator810 service illustrates how to process an ANSI X12 810

document iteratively, segment by segment.
Additionally, the Tutorial.EDItoXML:processEDI850_4010 service shows a complete sample
that converts an ANSI X12 850 document to an IData object and maps the data from the
EDI document to an XML document.

Important: Delete the WmEDIsamples package before going into production.

webMethods Module for EDI Installation and User’s Guide Version 9.12 206
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

11   Preparing to Process Inbound Non-TRADACOMS

Documents Using Trading Networks

■ Overview ..................................................................................................................................... 208

■ Preparing to Receive EDI Documents ....................................................................................... 209
■ Specifying EDITPA Variables that Affect Inbound Processing ................................................... 210
■ Trading Networks Attributes and EDI Documents ..................................................................... 211
■ Defining Processing Rules to Process Inbound EDI Documents .............................................. 222
■ Coding Services to Process Transaction and Group Documents .............................................. 226

webMethods Module for EDI Installation and User’s Guide Version 9.12 207
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Overview
This chapter describes how to set up basic inbound processing when using Trading
Networks for all EDI standards except TRADACOMS.

For more information about... See...

Inbound processing using TRADACOMS "Processing Inbound TRADACOMS

Documents Using Trading Networks
" on page 237

Optional inbound processing "Optional Inbound Processing When

Using Trading Networks " on page
257

Processing EDI documents using Module "Using Module for EDI Decoupled
for EDI decoupled from Trading Networks from Trading Networks " on page
399

When webMethods Trading Networks (Trading Networks) receives an EDI document, it

passes it to an EDI recognizer, which performs the initial processing. The EDI recognizer
is installed in Trading Networks when you install webMethods Module for EDI (Module
for EDI). You can use EDITPA variables to tailor how the EDI recognizer processes an
inbound EDI document. For more information, see "Specifying EDITPA Variables that
Affect Inbound Processing" on page 210.
To prepare the EDI document for the processing that you want to perform against
it, the EDI recognizer splits the original inbound EDI document based on the seing
of the splitOption EDITPA variable. The EDI recognizer can split the original EDI
document into an Interchange, Group, and/or Transaction document. After creating the
document(s), the EDI recognizer sends the document(s) to Trading Networks for normal
processing.
You define the processing that Trading Networks performs against the Interchange,
Group, and Transaction documents by defining processing rules. Processing rules
consist of:
Criteria that Trading Networks uses to select the appropriate processing rule for a
document. To set the criteria, you can use Trading Networks aributes along with
other information that Trading Networks records about a document, for example,
the TN document type used for the document. This allows you to set up criteria
for processing rules so that Trading Networks selects the correct processing rule
for your document. For example, you can set up criteria so that Trading Networks
selects a processing rule only if it is from a specific sender/receiver pair and it is in a
specific processing mode, such as testing or production. For more information about

webMethods Module for EDI Installation and User’s Guide Version 9.12 208
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

the document aributes that are available, see " Trading Networks Aributes and
EDI Documents" on page 211.
Actions that Trading Networks is to take against the document. You will typically
want to use the Execute a Service action in a processing rule to invoke a service that
you create to process the Interchange, Group, or Transaction document. For more
information about defining processing rules and creating a service to process an
Interchange, Group, or Transaction document, see "Defining Processing Rules to
Process Inbound EDI Documents" on page 222.
For more information about processing EDI documents and business processes,
including an illustration of how EDI documents are passed to a business process, see
webMethods Module for EDI Concepts Guide.
For more information about Trading Networks document aributes and processing
rules, see the Trading Networks Concepts Guide and the webMethods Trading Networks
Administrator’s Guide for your release.

Preparing to Receive EDI Documents

The following steps must be performed before you receive EDI documents.

Step Description

1 Define the TN document types for the EDI documents that you want to
process. For instructions, see "Defining TN EDI Document Types" on
page 37.
When you define the TN document types for EDI documents, Module
for EDI creates the flat file schemas that define the structure of the
EDI documents. Module for EDI uses the flat file schemas for parsing,
converting, and validating the structure of inbound EDI documents.

2 Optional. Create the flat file schema that defines the structure of an
internal-format document. Use Designer to create the flat file schema.
For more information about creating a flat file schema, see the Flat File
Schema Developer’s Guide.

Note: You use the flat file schema created in this step if the service that
you create to process an Interchange, Group, or Transaction
document creates an internal-format document. Module for EDI
provides a service that you can invoke to create the internal-
format document based on the flat file schema.

3 Define profiles for the senders and receivers in the inbound EDI
document. For more information about how to create profiles, see

webMethods Module for EDI Installation and User’s Guide Version 9.12 209
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Step Description
"Defining Trading Partner Profiles" on page 59 and the webMethods
Trading Networks Administrator’s Guide for your release.

4 Define the default EDITPA and optionally, the partner-specific EDITPAs

for the sender/receiver pairs in the EDI document. For more information
about creating EDITPAs, see "Defining EDI Trading Partner Agreements"
on page 61. For information about the EDITPA variables that affect
inbound processing, see "Specifying EDITPA Variables that Affect
Inbound Processing" on page 210.

5 When using non-standard processing, you must also define

the interchange sender/receiver pair information. For instructions, see
"Defining Interchange-Level Sender/Receiver Pair Information" on page
376 in "Using Module for EDI Decoupled from Trading Networks
" on page 399. For more information about the difference between
standard and non-standard processing, see webMethods Module for EDI
Concepts Guide.

Specifying EDITPA Variables that Affect Inbound Processing

To tailor how you want Module for EDI to perform inbound processing, you must
edit the EDITPA variables. When using EDI standards other than TRADACOMS,
the module processes an inbound EDI document one interchange segment at a time.
For each interchange segment in an inbound EDI document, the module obtains the
EDITPA values to use for the interchange sender/receiver pair. The module uses these
values when processing all documents (Interchange, Group, and Transaction) for the
interchange segment.
For a complete list and description of the EDITPA variables, see
"wm.b2b.editn.TPA:EDITPA IS Document Type" on page 65.

Note: When using non-standard processing, Module for EDI uses

EDITPAs for group-level sender/receiver pairs and the additional seings that
you define from the module home page. For more information, see "Variables
that Affect Inbound Processing" on page 395. For more information about
the difference between standard and non-standard processing, see webMethods
Module for EDI Concepts Guide.

Validating the EDIFACT Document Schema

Module for EDI determines the syntax version number, the syntax release number, and
the directory version number of the incoming EDIFACT document and validates the
envelope using the most specific schema available. The name of the most specific schema

webMethods Module for EDI Installation and User’s Guide Version 9.12 210
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

contains the syntax version number, the syntax release number, and the directory
version number. The name of the least specific schema contains only the syntax version
number.
The module searches for the appropriate flat file schema to use for the document
validation of each incoming EDIFACT document in the following search order priority:
1. EDIFFSchema.Standard .envelope:VSyntaxVersionNumber_DirectoryVersionNumber_Syntax
ReleaseNumber schema
2. EDIFFSchema.Standard .envelope:VSyntaxVersionNumber_DirectoryVersionNumber
schema
3. EDIFFSchema.Standard .envelope:VSyntaxVersionNumber schema
4. wm.b2b.editn.rec:EDIHEADERS (default document type)
Module for EDI uses the most specific schema that exists. If the module does not find
any of the listed schemas, the module uses the default wm.b2b.editn.rec:EDIHEADERS
document type. Only the wm.b2b.editn.rec:EDIHEADERS document type is available when
you install the module. You must install the more specific EDIFACT schemas.

Validating VDA Message Structure

Module for EDI can validate the message structure of a VDA document. The VDA
schema includes a trailer record that contains dedicated fields for each type of record
in the schema. These dedicated fields should contain the number of occurrences of
the corresponding record type. The module validates that the value of the dedicated
field matches the number of occurrences of the corresponding record type. All control
number fields are mandatory, and the module uses each field to check the completeness
of a message.
You activate message structure validation for inbound VDA documents by seing the
ControlNumberManagement/VDA/validateStructure EDITPA variable to true. For more
information about this variable, see "wm.b2b.editn.TPA:EDITPA IS Document Type" on
page 65.

Trading Networks Attributes and EDI Documents

Trading Networks aributes specify the content from a document to use for later
processing. For example, you can define the processing rule criteria to select which
processing rule is executed based on the value of an aribute.
Trading Networks supports two types of aributes:
System aributes, which Trading Networks defines.
Custom aributes, which are additional aributes that are added to Trading
Networks. Module for EDI provides some custom aributes. Additionally, you can
write code to define your own custom aributes and assign them values.

webMethods Module for EDI Installation and User’s Guide Version 9.12 211
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

At run time, Module for EDI uses information from the EDI document being processed
to set values for some of the system aributes and custom aributes.
You can use aributes to:
Process EDI documents using content-based processing rules, that is, select a
processing rule for a document based on the value of the aributes extracted from
the document.
Search for saved documents based on aribute values.

System Attributes that Module for EDI Sets

Module for EDI sets the DocumentID, GroupID, and ConversationID system aributes
using information from the EDI document. Module for EDI uses different values
based on whether it is assigning the aribute to an Interchange, Group, or Transaction
document. The sections below describe how the module sets each aribute for each type
of document (interchange, group, and transaction).
The examples provided are based on the following sample:

Control numbers in ANSI X12 ISA, GS, and ST headers

DocumentID
The DocumentID system aribute is an identifier of the document. Module for EDI sets
the DocumentID as follows:

Type of Value Used for DocumentID

Document

Interchange The interchange control number. For example, the sample’s

DocumentID would be set to 000005334, which is the value of
ISA13.

Group The group control number. For example, the sample’s

DocumentID would be set to 1, which is the value of GS06.

Transaction The transaction control number. For example, the sample’s

DocumentID would be set to 0001, which is the value of ST02.
For VDA documents, Module for EDI sets the DocumentID to the
value of the new control number field.

webMethods Module for EDI Installation and User’s Guide Version 9.12 212
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

GroupID
Module for EDI hierarchically assigns the GroupID system aribute so that by viewing
the GroupID, you can determine the envelope to which an element originally belonged.
The module sets the GroupID as follows:

Type of Value Used for GroupID

Document

Interchange The interchange control number. For example, the sample’s

GroupID would be set to 000005334, which is the value of ISA13.

Group The interchange control number, so that you can determine to

which interchange the Group document belongs. For example,
the sample’s GroupID would be set to 000005334, which is the
value of ISA13.

Transaction The group control number, so that you can determine to which
group the Transaction document belongs. For example, the
sample’s GroupID would be set to 1, which is the value of GS06.

ConversationID
The ConversationID system aribute 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 use the same ConversationID.
Trading Networks can extract ConversationIDs from EDI Envelope, Group, and
Transaction documents and use them to pass documents to webMethods Process Engine
after Trading Networks performs the actions identified by a processing rule. Process
Engine is the facility of Integration Server that executes and manages business processes.
For more information, see the webMethods Trading Networks Administrator’s Guide for
your release.
For more information about assigning conversation IDs to EDI documents and including
EDI documents in business processes, see "Including Documents in a Business Process"
on page 361.

Enabling Extraction of ConversationIDs from an EDI Document

By default, Trading Networks does not extract the ConversationID from EDI documents.
Use the following procedure to enable the extraction of ConversationIDs from EDI
documents so that Trading Networks can pass them to Process Engine.

To enable extraction of ConversationIDs from EDI documents

1. Obtain a license and install Process Engine if you haven’t already done so.

webMethods Module for EDI Installation and User’s Guide Version 9.12 213
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

2. For Transaction document types, enable Module for EDI to assign ConversationIDs by
creating an instance ID query that specifies the value to use for the conversation ID.

Note: By default, Module for EDI assigns the conversation IDs in Interchange
and Group documents. Because these documents have a conversation ID,
they are passed to Process Engine.

3. Using Software AG Designer, add a package dependency from WmTN to WmPRT

to ensure that the conversation IDs are extracted correctly. For details, see the
webMethods Service Development Help for your release.
4. Configure a PRT database connection. Follow the installation instructions for Process
Engine to configure a data source.
5. Reload the WmTN package.

Disabling Extraction of ConversationIDs from EDI Documents

By default, Trading Networks does not extract the ConversationID from EDI documents.
However, if this default has been overridden, you can disable the function to extract
ConversationIDs from EDI documents using the following procedure.
1. Do one of the following:
For Envelope and Group document types, set the property
disableCIDSupport=true in the configuration file,
Integration Server_directory\instances\$instance_name \packages\WmEDI\config
\properties.cnf file.
For Transaction document types, use Designer to remove the dependency in the
WmTN package on the WmPRT package.
2. Reload the WmTN package.

Custom Attributes that Module for EDI Sets

When you install Module for EDI, the following custom aributes are added to Trading
Networks. You can use these aributes as criteria when designing processing rules.

Custom Attribute Where to Find More Information

EDI Batch "Delivering the Batch EDI Document" on page 331

EDI Group Type "EDI Group Type" on page 215

EDI Outbound FA "EDI Outbound FA" on page 215

EDI Processing Mode "EDI Processing Mode" on page 215

webMethods Module for EDI Installation and User’s Guide Version 9.12 214
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Custom Attribute Where to Find More Information

EDI Status "EDI Status" on page 215

EDI Version "EDI Version" on page 216

Envelope CntrlNum "Envelope CntrlNum Status and Group CntrlNum Status"

Status and Group on page 216
CntrlNum Status

EDI FA Status "EDI FA Status" on page 217

Late FA "Tracking Late Functional Acknowledgments" on page

185

TA1 Status and TA1 "TA1 Status and TA1 Code" on page 218
Code

For information about custom aributes that Module for EDI sets when using
TRADACOMS, see "Custom Aributes that Module for EDI Sets When Using
TRADACOMS" on page 242.

EDI Group Type

For Group documents, Module for EDI sets this aribute to the value of the functional
identifier (for example, PO, or RC) from the group header.

EDI Outbound FA
Module for EDI sets this aribute to indicate whether the document it generated is an
outbound FA. The value of the EDI Outbound FA custom aribute is set to:
true for an outbound FA that the module generated

false for all other documents

EDI Processing Mode

Module for EDI sets this aribute to Testing, Production, or Custom based
on the value of the EDITPA processingMode variable. For more information, see
"processingMode Variable" on page 70.

EDI Status
Module for EDI sets this aribute based on the outcome of optional inbound processing,
that is, inbound control number validation and automatic FA generation. The module
only performs this optional inbound processing when the EDITPA indicates to do so.

webMethods Module for EDI Installation and User’s Guide Version 9.12 215
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

For more information, see "Optional Inbound Processing When Using Trading Networks
" on page 257.
If the EDITPA indicates to do so, the module first performs inbound control number
validation. If the module determines that a document contains:
A duplicate control number, it sets this aribute to Duplicate Control Number.
An out-of-sequence control number, it sets this aribute to Out of Sequence
Control Number.

Regardless of whether control number validation was performed, Module for EDI will
generate the FA if the EDITPA indicates to do so. If there is an unacceptable FA status,
the module sets the EDI Status aribute based on the FA status as follows:
Generate FA—Not Allowed
Generate FA—Rejected
Generate FA—Partially Accepted
Generate FA—Accepted, But Errors Were Noted

If the control numbers are valid and the FA status is acceptable, Module for EDI sets
the EDI Status aribute to Processed. Additionally, if the module does not validate the
control number nor generate the FAs, it sets the EDI Status aribute to Processed.

EDI Version
Module for EDI sets this aribute to the version of the EDI standard that the document
uses (for example, 4010).

Envelope CntrlNum Status and Group CntrlNum Status

The Envelope CntrlNum Status and Group CntrlNum Status aributes indicate the control
number validation status of documents, thus enabling child documents to know the
validation status of their parent documents.
When validating document control numbers, Module for EDI sets this aribute to Valid,
Duplicate, Out of Sequence, or Not Validated.

For Interchange documents, the module only sets the Envelope CntrlNum Status
aribute.
For Group documents, the module sets the following aributes:
Envelope CntrlNum Status to indicate the status of the associated Interchange
document
Group CntrlNum Status to indicate the status of the associated Group document
For Transaction documents, the module sets the following aributes:
Envelope CntrlNum Status to indicate the status of the associated Interchange
document
Group CntrlNum Status to indicate the status of the associated Group document

webMethods Module for EDI Installation and User’s Guide Version 9.12 216
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Note: For UN/EDIFACT Transaction documents, Module for EDI may also set
this aribute to Not Present.

EDI FA Status
The EDI FA Status aribute indicates the status of a functional acknowledgment (FA) that
Module for EDI has returned to the sender of an inbound document.
For inbound ANSI X12 Group documents and UN/EDIFACT Interchange
documents, this aribute may return the following values:

Value Description

Not Module for EDI has not yet received or sent an FA to

Acknowledged acknowledge this document

Duplicate Module for EDI has one or more other documents

recorded in the EDITRACKING table that match the FA
for this document.

Accepted Module for EDI received a single FA that matches this

document and the FA has either:
“A” (Accept) status on the confirmed level (ANSI X12)
“7” status on the confirmed level (UN/EDIFACT)

Accepted w/ Module for EDI received a single FA that matches this

Errors document and the FA has an “E” status (Errors) on the
confirmed level.

Accepted - Module for EDI received a single FA that matches this

Partial document and the FA has a “P” status (Partially Accept)
on the confirmed level.
This value is used only for Group documents.

Rejected Module for EDI received a single FA that matches this

document and the FA has either:
“R” (Reject) status on the confirmed level (ANSI X12)
“4” status on the confirmed level (UN/EDIFACT)

FA Error Module for EDI encountered other errors, such as

“unknown” or “invalid FA status.”

webMethods Module for EDI Installation and User’s Guide Version 9.12 217
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Value Description

Disabled The FAReconciliation EDITPA variable is set to false,

which disables FA reconciliation and reporting. For more
information, see "FAReconciliation Variable" on page 72.

For functional acknowledgments (for example, ANSI X12 997s and UN/EDIFACT
CONTRL documents), this aribute may return the following values:

Value Description

Matched A matching document exists in the EDITRACKING table.

Unmatched No matching document exists in the EDITRACKING table.

Duplicated Module for EDI has one or more other documents recorded
in the EDITRACKING table that match the FA for this
document.

Disabled The FAReconciliation EDITPA variable is set to false,

which disables FA reconciliation and reporting. For more
information, see "FAReconciliation Variable" on page 72.

DUP_FA Module for EDI received more than one FA that matches this
document.

Note: Be sure to turn on automatic FA generation, as described in "Turning

Automatic FA Generation On and Off" on page 277. Otherwise, the FA
Status aribute will always return Not Acknowledged or Disabled.

TA1 Status and TA1 Code

When Module for EDI receives an inbound EDI document containing a TA1 segment,
the module uses Trading Networks to recognize, route, and persist the document.
During recognition, the TA1 segment is processed and the TA1 data are set as the bizdoc
aributes TA1 Status and TA1 Code.
The TA1 Status aribute indicates the status of an interchange acknowledgment (TA1)
that Module for EDI in an inbound document.

TA1 Status Description

A The TA1 segment was accepted.

webMethods Module for EDI Installation and User’s Guide Version 9.12 218
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

TA1 Status Description

R The TA1 segment was rejected.

E The TA1 segment has an error.

When the TA1 Status is A, the TA1 Code is 000.

When the TA1 Status is either R or E, the TA1 Code aribute indicates the type of error that
the module encountered. The following table lists the error codes and their meanings.

TA1 Code Description

Value

001 The interchange control number in the header and trailer do not
match. The acknowledgment uses the value in the header.

002 The standard noted in the Control Standards Identifier is not

supported.

003 The version of the controls is not supported.

004 The segment terminator is not valid.

005 The interchange ID qualifier for sender is not valid.

006 The interchange ID for sender is not valid.

007 The interchange ID qualifier for recipient is not valid.

008 The interchange ID for recipient is not valid.

009 The interchange receiver ID is unknown.

010 The Authorization Information Qualifier value is not valid.

011 The Authorization Information value is not valid.

012 The Security Information Qualifier is not valid.

013 The Security Information value is not valid.

014 The Interchange Date is not valid.

webMethods Module for EDI Installation and User’s Guide Version 9.12 219
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

TA1 Code Description

Value

015 The Interchange Time is not valid.

016 The Interchange Standards ID is not valid.

017 The Interchange Version ID is not valid.

018 The Interchange Control Number is not valid.

019 The Acknowledgment Request value is not valid.

020 The Test Indicator is not valid.

021 The Number of Included Group value is not valid.

022 The control structure is not valid.

023 Improper end of file.

024 The Interchange content is not valid.

025 Interchange Control Number is a duplicate.

026 The Data Element Separator is not valid.

027 The Component Element Separator is not valid.

028 The delivery date in the Deferred Delivery Request is not valid.

029 The delivery time in the Deferred Delivery Request is not valid.

030 The delivery time code in the Deferred Delivery Request is not
valid.

031 The grade of service code is not valid.

webMethods Module for EDI Installation and User’s Guide Version 9.12 220
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Managing Custom Attributes for EDI Documents

When you want to create and use custom aributes, you must perform the following
tasks:

Task Where to Find More Information

Define the custom aributes using The webMethods Trading Networks

My webMethods. Administrator’s Guide for your release.

Define the TN document types for "Defining TN EDI Document Types" on

the types of EDI documents with page 37.
which you want to associate the
custom aributes.

Create a service that sets the "Seing the Aribute Values at Run
aribute values at run time. Time" on page 221.

Define a processing rule that uses "Defining a Processing Rule that Uses
the custom aributes. Your Custom Aribute as Criteria" on
page 222.

Setting the Attribute Values at Run Time

You must create a service to set the aribute values at run time. To execute this service,
include it as a parameter of the Execute a Service processing action in a Trading Networks
processing rule. Note that your EDI document type or processing rule must use the Save
Document to Database preprocessing action to save the document content and aributes to
the database.
Create a service that performs the following logic:
Obtain the values you want to use for each custom aribute.
For each aribute, invoke the wm.tn.doc:setAttribute service to set the value of the
aribute in the BizDocEnvelope.
Invoke the wm.tn.doc:updateAttributes service to update the values of the aributes in the
copy of the document that is saved in the Trading Networks database.
Example
Let’s say you are working with an EDI ANSI X12 850 document, and you want to
associate the PurchaseOrderNumber aribute with the 850 document. To do so, you would:
1. Install the TN document type for the 850 EDI document.
2. Create the PurchaseOrderNumber aribute.

webMethods Module for EDI Installation and User’s Guide Version 9.12 221
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

3. Invoke the wm.b2b.editn:addAttributeTypeToBizDoc service to associate the

PurchaseOrderNumber aribute with the TN document type for the 850 EDI document.
4. Create a service that extracts the value for the PurchaseOrderNumber aribute from the
850 EDI document, and assign this service as input to the Execute a Service processing
action in the processing rule. Your service should do the following:
Invoke wm.tn.doc:setAttribute to set the value of the aribute in the BizDocEnvelope
Invoke wm.tn.doc:updateAttributes to update the aributes in the saved copy of the
document in the Trading Networks database

Defining a Processing Rule that Uses Your Custom Attribute as Criteria

To use the custom aributes you defined as criteria in a processing rule, you need to:
Associate custom aributes with EDI document types, as described in "Managing
Custom Aributes for EDI Documents" on page 221.
Create a processing rule to process the document, considering the following:
Do not use content-based processing.
Leave the Extended Criteria tab of the Processing Rules screen blank.
In the Execute a Service processing rule, invoke the service that sets the values of
the custom aributes, as described in "Seing the Aribute Values at Run Time"
on page 221.
Ensure that the service invokes the wm.tn.reroute service so that Trading Networks
selects another processing rule for the document. (The next processing rule uses
your custom aributes as criteria.)
Create a processing rule that specifies the custom aributes as criteria in the Extended
Criteria tab.

Note: When ordering your processing rules, be sure to list the processing rule that
uses your custom aributes as criteria before the processing rule that sets the
aribute values. This ensures that Trading Networks will skip the processing
rule that uses the custom aribute criteria the first time the document is
processed but select it the second time.

Defining Processing Rules to Process Inbound EDI

Documents
You can specify how Module for EDI processes Interchange, Group, and Transaction
documents that have been split from the original inbound EDI document by using
processing rules. Your processing rules specify the preprocessing and processing actions
that you want Trading Networks to perform against the document, as well as the

webMethods Module for EDI Installation and User’s Guide Version 9.12 222
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

selection criteria that Trading Networks uses to determine which processing rule to
apply.
The processing rules that you define are based on the splitOption variable that you set in
the EDITPA.

If you set splitOption to... Then define processing rules for...

Interchange Interchange document

Interchange document
Group
Group documents
Interchange document
Transaction
Group documents
Each type of Transaction document (for
example, ANSI X12 850, ANSI X12 810, UN/
EDIFACT INVOIC, or UN/EDIFACT ORDERS)

Define processing rules in My webMethods. For more information, see the webMethods
Trading Networks Administrator’s Guide for your release.

Specifying Processing Rule Criteria

When you create a processing rule, you specify the criteria that Trading Networks uses
to select the appropriate processing rule for an Interchange, Group, or Transaction
document. The following table lists the criteria you can specify.

Use this criterion... To have Trading Networks select a processing rule based on...

Sender The sender of the document

The GSRouting/routingMode and GSRouting/
senderQualifier EDITPA variables can affect the sender
that Module for EDI uses for an interchange, group,
and transaction. For more information, see "GSRouting
Variables" on page 67.

Receiver The receiver of the document

The GSRouting/routingMode and GSRouting/
receiverQualifier EDITPA variables can affect the receiver
that Module for EDI uses for an interchange, group,
and transaction. For more information, see "GSRouting
Variables" on page 67.

Document Type The TN document type for the document

webMethods Module for EDI Installation and User’s Guide Version 9.12 223
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Use this criterion... To have Trading Networks select a processing rule based on...

Use this criterion to process a document based on

whether it is an Interchange, Group, or Transaction
document. The following are example seings:

To select a processing rule for Set Document Type to...

document type...

ANSI X12 interchange X12 Envelope

ANSI X12 group X12 Group

ANSI X12 850 transaction, X12 4010 850

version 4010

UN/EDIFACT interchange UNEDIFACT Envelope

UN/EDIFACT group UNEDIFACT Group

UN/EDIFACT ORDERS UNEDIFACT 99A ORDERS

transaction, version 99A

Recognition Errors Whether Trading Networks or the EDI recognizer

encountered any errors during the recognition process

Extended Criteria The value of custom aributes

For example, on the Extended Criteria tab of the Processing
Rules Detail screen, you might specify that the EDI
Processing Mode aribute must be Production to select
the processing rule. For more information about the
custom aributes that Module for EDI sets, see "Custom
Aributes that Module for EDI Sets" on page 214.
For information about how to set your own custom
aributes, see "Managing Custom Aributes for EDI
Documents" on page 221.

Note: Module for EDI does not set the User Status system aribute, so you should
not use the User Status criterion.

webMethods Module for EDI Installation and User’s Guide Version 9.12 224
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Specifying Preprocessing Actions

Default preprocessing actions are defined in TN document types. However, you can
override the seings in the processing rule. For more information about how the
preprocessing actions apply to EDI documents, see the section about preprocessing
actions in webMethods Module for EDI Concepts Guide.
The following table lists the preprocessing actions that you can set in a processing rule
and the default seings for each action in the TN document types for EDI documents.

Preprocessing Description Default setting in TN document

action type for the EDI document

Validate Structure Validates the structure of the Validate the structure of

EDI document the envelope

Check for Determines if Trading Do not use Trading

Duplicate Networks has already Networks check for
Document saved this document in its duplication
database

Save Document to Saves a copy of the Save document content,

Database document content, aributes, and activity log
aributes, and/or activity
log information to the
Trading Networks database

If a preprocessing action fails, Trading Networks records the error and continues
processing. Trading Networks records the error in the errors variable in the
BizDocEnvelope, which is in the bizdoc pipeline variable. Subsequent processing that
you add, for example a service invoked by the Execute a Service processing action, can
access the error information.

Note: You cannot use the Verify Digital Signature preprocessing action because
values for the SignedBody and Signature system aributes are not set for EDI
documents.

Specifying Processing Actions

You can use all of the Trading Networks processing actions for EDI documents.
If you want to process transactions from an inbound EDI document, for example,
to transform that information into a format that is readable by an internal (back-
end) system, you will primarily use the Execute a Service action. You must create the
service that the Execute a Service processing action invokes.

webMethods Module for EDI Installation and User’s Guide Version 9.12 225
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

In this scenario, the splitOption EDITPA variable must be set to Transaction or

Group.
To process the Transaction and/or Group documents from the split, you would
assign the appropriate processing rules in the Execute a Service processing action.
For more information about how to create the services, see "Coding Services to
Process Transaction and Group Documents" on page 226.
For the Interchange document, you could define a processing rule with no
processing actions selected. This causes Trading Networks to ignore the
document because there is no need to process it. Alternatively, you could define
processing rules that allow the Interchange document to fall through to the
Default rule, which only sets the User Status system aribute of the document to
IGNORED. If you use the Default rule, you do not need to define a processing rule
for the Interchange document.
If you are sending the inbound EDI document in Trading Networks to simply
deliver it to a destination without processing the file, you will primarily use the
Deliver Document By action, with the splitOption EDITPA variable set to Interchange.
In this scenario, the only document sent to Trading Networks is the Interchange
document. For more information about delivering documents, see "Forming EDI
Documents to Send Outbound When Using Trading Networks " on page 289.

Coding Services to Process Transaction and Group

Documents
The logic that you design in your processing service (set in the Execute a Service action)
depends on the type of document that Module for EDI generates when spliing the
document from the original EDI document. This document type is specified in the
EDITPA splitOption variable.
The following table explains the types of documents that the module creates depending
on the value of the splitOption variable.

If the splitOption Module for EDI creates...

is...

Transaction Transaction, and Group and Interchange documents from the

original EDI document. When the split document is of type:
Transaction. Create a service that processes a single
transaction set from the document. For example, create
a document in a format used by an internal application
based on the transaction set information. For information
about how to create this service, see "Logic to Process a File
Document" on page 252.

webMethods Module for EDI Installation and User’s Guide Version 9.12 226
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

If the splitOption Module for EDI creates...

is...

Group and interchange. Do not create a service because all

processing for EDI documents is handled when processing
Transaction documents. You could also set up processing
rules specifically for group and Interchange documents
that have no processing actions selected. Or, set up your
processing rules so that Interchange documents fall through
to the Default rule.

Note: If you want to generate functional acknowledgments

(FAs), see "Automatically Generating Functional
Acknowledgments" on page 275.

Group Group and Interchange documents from the original EDI

document. When the split document is of type:
Group. Create a service that processes each transaction within
the group. For information about how to create this service,
see "Logic to Map a File Document to an Internal-Format
Document" on page 254.
Interchange. Do not create a service. Processing for the EDI
document is handled when processing the Group document.
You could also set up a processing rule specifically for the
Interchange document that has no processing actions defined
or set up your processing rules so that Interchange document
falls through to the Default rule.

Note: If you want to generate functional acknowledgments

(FAs), see "Automatically Generating Functional
Acknowledgments" on page 275.

Interchange Interchange documents from the original EDI document.

You would set the splitOption to Interchange if you want to
simply deliver the EDI document to its receiver.
For more information about how to deliver a document, see
"Delivering the Outbound EDI Document" on page 297.

The services you create can use information that is in the pipeline. For information about
using data in the pipeline when your service is invoked, see "Information in the Pipeline
that Your Service Can Access" on page 228.

webMethods Module for EDI Installation and User’s Guide Version 9.12 227
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Information in the Pipeline that Your Service Can Access

When an Interchange, Group, or Transaction document is passed to the processing rule,
the following information is accessible to your service from the pipeline:
BizDocEnvelope in the bizdoc variable. Use the BizDocEnvelope to retrieve
information that Trading Networks maintains about the document. The
BizDocEnvelope adheres to the wm.tn.rec:BizDocEnvelope IS document type. It is also
an instance of com.wm.app.tn.doc.BizDocEnvelope. For more information about the
BizDocEnvelope, see the webMethods Trading Networks Built-In Services Reference for
your release. The following variables are contained in the BizDocEnvelope:

Variable Description

DocumentID The EDI control number from the interchange, group, or

transaction header, as described in "DocumentID" on page
241.

Aributes The custom aributes that were set for the document. For
information about the custom aributes that Module for EDI
sets, see "Custom Aributes that Module for EDI Sets When
Using TRADACOMS" on page 242.

Errors The errors that Trading Networks and Module for EDI
encountered while processing the document.

EDI document summary information in the envelopeDocuments variable

When Trading Networks originally receives the EDI document, it passes it to the EDI
recognizer, which parses the document and generates this summary. It is the entire
original EDI document as an IData object.
You can use the EDI document summary information to derive a total document
count or to determine when all of the documents in the original EDI document have
completed processing. To do so, your service can perform a simple count of the
original documents and a count of the documents processed. When these counts
match, processing of the entire original EDI document is complete. You can also
perform a query within Trading Networks that checks the status of each document
using the Trading Networks internal ID for each document.
The following table shows the structure of the EDI document summary information
in the envelopeDocuments variable:

webMethods Module for EDI Installation and User’s Guide Version 9.12 228
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Variable Description

Document List Summary of the Interchange document including

envelopeDocuments
the groups and transactions sets that it contains.

Key Description

docID String Internal ID that Trading Networks

generated for the Interchange document.

docTypeID String Internal ID of the TN document type

used for the Interchange document.

docTypeName String Name of the TN document type used for

the Interchange document, for example, X12
Envelope.

group Document List (optional) Summary of all the

Documents Group documents in the interchange.

Key Description

docID String Internal ID that Trading

Networks generated for the
Group document.

docTypeID String Internal ID of the TN

document type.

docType String Name of the TN document

Name type used, for example, X12 Group.

transaction Document List (optional) Summary

Documents of all the Transaction documents
in the group.

Key Description

docID String Internal ID that

Trading Networks
generated for the
Transaction document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 229
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Variable Description

docTypeIDString Internal ID of
the TN document type
used.

docType String Name of the TN

Name document type used, for
example, X12 4010 850.

Logic to Process a Transaction Document

The following sample code shows the logic you might want to apply when creating a
service that will process a Transaction document that contains a single transaction set
from an inbound EDI document. The processing in this example shows how to map
information from the transaction set to an internal-format and send the document to an
internal application.

Flow Description
operation

1 Invoke thewm.b2b.editn:getTspace service to retrieve the content of the

Transaction document from the BizDocEnvelope (in the bizdoc variable)
and use it to populate the edidata variable.
You can use the getTspace service regardless of whether the document is
considered large. For more information about large document handling,
see "Handling Large Documents When Using Trading Networks " on
page 163.
For more information about the getTspace service, see webMethods Module
for EDI Built-In Services Reference.

webMethods Module for EDI Installation and User’s Guide Version 9.12 230
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Flow Description
operation

2 Invoke the wm.b2b.edi:convertToValues service to:

Convert the content of the Transaction document (in the edidata
variable) from either String or InputStream object into an IData object.
Validate the structure of the EDI transaction.
The inputs to the convertToValues service include the flat file schema for
the EDI transaction. The convertToValues service uses the flat file schema
to determine how to parse the transaction set into an IData object and to
validate its structure.
For more information about the convertToValues service, see webMethods
Module for EDI Built-In Services Reference.

3 Map the data from the EDI transaction set into a document in internal
format.
Now that the transaction set is an IData object, you can access the
data in the transaction set to map it to an IData object for the internal-
format document. Depending on the complexity of your mapping
requirements, you might need to add more logic than a MAP flow
operation, or create a separate service to perform the mapping.

4 Invoke the wm.b2b.edi:convertToString service to convert the document in

internal format from an IData object into a String.
The input to the convertToString service includes the IData object, which
contains the data and the flat file schema for the internal-format
document. convertToString uses the flat file schema to determine how to
form the internal-format document. Alternatively, convertToString can
use an IS document type to define the structure of the internal-format
document.
For more information about convertToString, see webMethods Module for
EDI Built-In Services Reference.

5 Branch based on the value of the EDI Processing Mode custom aribute.
This aribute is in the bizdoc/Aributes/EDI Processing Mode variable.
Module for EDI sets the value of the EDI Processing Mode custom aribute
based on the seing of the EDITPA processingMode variable. For more
information, see "processingMode Variable" on page 70.

6 If the value of the EDI Processing Mode custom aribute is:

webMethods Module for EDI Installation and User’s Guide Version 9.12 231
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Flow Description
operation

Production—Send the internal-format document to the internal (back-

end) system, by adding your own logic or invoking a service that you
created.
A value other than Production (for example, Testing)—Invoke
wm.pub.flow:debugLog to log a message to the server log. For example, the
message may be, “Testing document was received but not sent to back-
end system.”

Logic to Process a Group Document when splitOption is Group

When the splitOption EDITPA variable is Group, Module for EDI does not create
Transaction documents. If you want to process individual transactions, you can do
so when you process the Group document. The following sample code illustrates the
processing of individual transactions within the group.

Flow Description
operation

1 Invoke the wm.b2b.editn:getTspace service to retrieve the content of the

Group document from the BizDocEnvelope (in the bizdoc variable)
to populate the edidata variable. You can use the getTspace service
regardless of whether the document is considered large.

webMethods Module for EDI Installation and User’s Guide Version 9.12 232
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Flow Description
operation

For more information about getTspace, see webMethods Module for EDI
Built-In Services Reference.

2 Invoke the wm.b2b.edi:envelopeProcess service to process the envelopes

in the Group document. This service converts the interchange, group,
and transaction set headers into an IData object named Values . The
contents of the transaction sets remain unparsed.
For ANSI X12 documents, Module for EDI creates an IData object of
the ISA/IEA, GS/GE, and ST/SE headers/trailers.
For UN/EDIFACT documents, Module for EDI creates an IData
object of the UNB/UNZ, UNG/UNE, and UNH/UNT headers/trailers.
When seing the input variables to the envelopeProcess service, there
is no need to validate or perform the compliance check on the Group
document because the module already performs this validation
during initial processing of the EDI document.
For more information about envelopeProcess, see webMethods Module for
EDI Built-In Services Reference.

3 If the wm.b2b.edi:envelopeProcess service returns errors, invoke the

wm.pub.flow:debugLog service to log a message to the server log.

4 Loop through the transaction set headers. Note that a Group

document contains only a single interchange and a single group
header. The data for the transaction set headers is within the Values
IData object:
For ANSI X12 documents, transaction set headers are in Values/ISA/
GS/ST (as shown in the sample code).
For UN/EDIFACT documents, transaction set headers are in Values/
UNB/UNG/UNH.

The remaining steps specify processing to perform for the content of each transaction.

Flow Description
operation

5 Invoke the wm.b2b.edi.util:getEDIstring service to convert the transaction

set header and trailer back to a string and concatenate them with the
transaction set contents. The resulting transaction set with header
and trailer can be either a String or InputStream object. For more

webMethods Module for EDI Installation and User’s Guide Version 9.12 233
 M
Even Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Flow Description
operation
information about the wm.b2b.edi.util:getEDIstring service, see webMethods
Module for EDI Built-In Services Reference.
You must have an element that contains the entire transaction set,
including header and trailer, before you can invoke the next service,
wm.b2b.edi:convertToValues. This is because convertToValues uses a flat file
schema for the EDI transaction set that includes the transaction set
header and trailer. If you input data without the header and trailer,
convertToValues returns errors.

6 Invoke the wm.b2b.edi:convertToValues service to:

Convert the content of the transaction set from either a String or
InputStream object to an IData object.
Validate the structure of the EDI transaction.
The inputs to the convertToValues service include the flat file schema for
the EDI transaction. convertToValues uses the flat file schema to determine
how to parse the transaction set into an IData object and validate its
structure.
For more information about convertToValues, see webMethods Module for
EDI Built-In Services Reference.

7 Map the data from the EDI transaction set into the internal format.
Now that the contents of the transaction set are an IData object, you
can access the data in the transaction set to map it to an IData object for
the internal-format document. Depending on the complexity of your
mapping requirements, you might need to add more logic than a MAP
flow operation, or create a separate service to perform the mapping.

8 Invoke the wm.b2b.edi:convertToString service to convert the internal-

format document from an IData object to a String.
The inputs to the convertToString service include the IData object, which
contains the data and the flat file schema for the document in internal
format. convertToString uses the flat file schema to determine how to
form the internal-format document. convertToString can also use an IS
document type to define the structure of the internal-format document.
For more information about convertToString, see webMethods Module for
EDI Built-In Services Reference.

9 Branch based on the value of the EDI Processing Mode custom aribute.
This aribute is in the bizdoc/Aributes/EDI Processing Mode variable.
Module for EDI sets the value of the EDI Processing Mode custom

webMethods Module for EDI Installation and User’s Guide Version 9.12 234
 M
Odd Header
Preparing to Process Inbound Non-TRADACOMS Documents Using Trading Networks

Flow Description
operation
aribute based on the seing of the EDITPA processingMode variable.
For more information, see "processingMode Variable" on page 70.

10 If the value of the EDI Processing Mode custom aribute is:

Production—Send the document in internal format to the back-end
system by adding your own logic or invoking a service you created.
A value other than Production (for example, Testing) —Invoke
wm.pub.flow:debugLog to log a message to the server log. For example,
the message may be, “Testing document was received but not sent to
back-end system.”

webMethods Module for EDI Installation and User’s Guide Version 9.12 235
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 236
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

12   Processing Inbound TRADACOMS Documents

Using Trading Networks

■ Overview ..................................................................................................................................... 238

■ Before Setting Up Processing of Inbound EDI Documents When Using TRADACOMS ............ 239
■ Specifying EDITPA Variables that Affect Inbound Processing When Using TRADACOMS ....... 240
■ Trading Networks Attributes and EDI Documents When Using TRADACOMS ......................... 240
■ Defining Processing Rules to Process Inbound EDI Documents When Using TRADACOMS ... 245
■ Coding Services to Process File and Batch Documents When Using TRADACOMS ............... 249

webMethods Module for EDI Installation and User’s Guide Version 9.12 237
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Overview
This chapter specifically addresses processing inbound TRADACOMS documents using
Trading Networks. For information about processing inbound documents using any
other EDI standard, see "Preparing to Process Inbound Non-TRADACOMS Documents
Using Trading Networks " on page 207.
When webMethods Trading Networks (Trading Networks) receives an EDI document, it
passes it to an EDI recognizer that performs the initial processing. The EDI recognizer is
installed in Trading Networks when you install webMethods Module for EDI (Module
for EDI). You can use EDITPA variables to tailor how the EDI recognizer processes an
inbound EDI document. For more information, see "Specifying EDITPA Variables that
Affect Inbound Processing When Using TRADACOMS" on page 240.
To prepare the EDI document for the processing that you want to perform against it,
the EDI recognizer splits the original inbound EDI document based on the seing of
the TRADACOMS/splitOption variable in the EDITPA. The EDI recognizer can split the
original EDI document into Transmission, Batch, and/or File documents. After forming
the transmission, batch, and file documents, the EDI recognizer sends the documents to
Trading Networks for normal processing.
You define the processing that Trading Networks performs against transmission and
batch documents, and files by defining processing rules. Processing rules consist of:
Criteria that Trading Networks uses to select the appropriate processing rule for a
document. To set the criteria, you can use Trading Networks aributes along with
other information that Trading Networks records about a document, for example,
the TN document type used for the document. This allows you to set up criteria
for processing rules so that Trading Networks selects the correct processing rule
for your document. For example, you can set up criteria so that Trading Networks
selects a processing rule only if it is from specific senders. For more information
about the document aributes that are available, see " Trading Networks Aributes
and EDI Documents When Using TRADACOMS" on page 240.
Actions that Trading Networks is to take against the document. You will typically
want to use the Execute a Service action in a processing rule to invoke a service
that you create to process the Transmission, Batch, or File document. For more
information about defining processing rules and creating a service to process a
Transmission, Batch, or File document, see "Defining Processing Rules to Process
Inbound EDI Documents When Using TRADACOMS" on page 245.

Note: This chapter describes how to set up basic inbound processing when using
Trading Networks. For information about seing up to validate transmission
and/or batch control numbers, see "Optional Inbound Processing When Using
Trading Networks " on page 257.

webMethods Module for EDI Installation and User’s Guide Version 9.12 238
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

For more information about processing EDI documents and business processes,
including an illustration of how EDI documents are passed to a business process, see
webMethods Module for EDI Concepts Guide.
For more information about Trading Networks document aributes and processing
rules, see the Trading Networks Concepts Guide and the webMethods Trading Networks
Administrator’s Guide for your release.

Before Setting Up Processing of Inbound EDI Documents

When Using TRADACOMS
When using the TRADACOMS standard, the following tasks must be performed before
seing up processing for inbound of EDI documents.

Task Description

1 Define the TN document types for the EDI documents that you want to
process. For instructions, see "Defining TN EDI Document Types" on page
37.
When you define the TN document types for EDI documents, the flat file
schemas that define the structure of the EDI documents to process are
created. Module for EDI uses the flat file schemas for parsing, converting,
and validating the structure of an inbound EDI document.

2 Optional. Create the flat file schema that defines the structure of an
internal-format document. Use Designer to create the flat file schema. For
more information about creating a flat file schema, see Flat File Schema
Developer’s Guide.

Note: You use the flat file schema created in this step if the service that
you create to process a file, or a transmission or batch document
might create an internal-format document. Module for EDI provides
a service that you can invoke to create the internal-format document
based on the flat file schema.

3 Define profiles for the senders and receivers in the inbound EDI document.
For more information about creating profiles, see "Defining Trading
Partner Profiles When Using TRADACOMS" on page 107 and the
webMethods Trading Networks Administrator’s Guide for your release.

4 Define the default EDITPA and optionally, the partner-specific EDITPAs

for the sender/receiver pairs in the EDI document. For more information
about creating EDITPAs, see "Defining EDI Trading Partner Agreements
When Using TRADACOMS" on page 109. For information about the
EDITPA variables that affect inbound processing, see "Specifying EDITPA

webMethods Module for EDI Installation and User’s Guide Version 9.12 239
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Task Description
Variables that Affect Inbound Processing When Using TRADACOMS" on
page 240.

Specifying EDITPA Variables that Affect Inbound Processing

When Using TRADACOMS
To tailor how you want Module for EDI to perform inbound processing, you must edit
the EDITPA variables. When using TRADACOMS, Module for EDI processes inbound
EDI documents one transmission segment at a time. For each transmission segment in an
inbound EDI document, the module obtains the EDITPA values to use for transmission
sender/receiver pair. The module uses these values when processing all documents
(transmission, batch, and file) for the transmission segment.
For a complete list and description of the TRADACOMS EDITPA variables, see
"TRADACOM Variables" on page 112.

Trading Networks Attributes and EDI Documents When Using

TRADACOMS
Trading Networks aributes specify the content from a document to use for later
processing. For example, you can define the processing rule criteria to select which
processing rule is executed based on the value of an aribute.
Trading Networks supports two types of aributes:
System aributes, which are defined by Trading Networks.
Custom aributes, which are additional aributes that are added to Trading
Networks. Module for EDI provides some custom aributes. Additionally, you can
write code to define your own custom aributes and assign them values.
At run time, Module for EDI uses information from the EDI document being processed
to set values for some of the system aributes and custom aributes.
You can use the aributes to:
Process EDI documents using content-based processing rules, that is, select a
processing rule for a document based on the value of the aributes extracted from
the document.
Search for saved documents based on aribute values.

webMethods Module for EDI Installation and User’s Guide Version 9.12 240
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

System Attributes that Module for EDI Sets When Using

TRADACOMS
When using TRADACOMS, Module for EDI sets the DocumentID and GroupID system
aributes using information from the EDI document. The module uses different
values based on whether it is assigning the aribute to a transmission, batch, or file
document. The sections below describe how the module sets each aribute for each type
of document (transmission, batch, and file).

DocumentID
The DocumentID system aribute is an identifier of the document. Module for EDI sets
the DocumentID as follows:

Type of Document Value Used for DocumentID

Transmission The sender's transmission reference (control number) specified

in the STX segment.

Batch The receiver's batch transmission reference (control number)

specified in the BAT segment.

File The file generation number in the message header's FIL

segment.

GroupID
Module for EDI hierarchically assigns the GroupID system aribute so that by viewing
the GroupID, you can determine the envelope to which an element originally belonged.
The module sets the GroupID as follows:

Type of Document Value Used for GroupID

Transmission The sender's transmission reference (control number).

Batch The sender's transmission reference/control number specified

in the transmission's segment, so you can determine to which
transmission the batch document belongs.

File The batch control number, so you can determine to which

batch the file document belongs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 241
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Custom Attributes that Module for EDI Sets When Using

TRADACOMS
When you install Module for EDI, the following custom aributes are added to Trading
Networks. You can use these aributes as criteria when designing processing rules. The
following table shows which aributes are stored for each document type (transmission,
batch, and file).

Custom Attribute Transmission Batch Type File Type

Type

Application Reference yes derived from derived from

transmission transmission

Priority Code yes derived from derived from

transmission transmission

Detail Message Count no no yes

Has VAT Message no no yes

Has Reconciliation yes no no

Message

Is Multiple Envelope yes no no

Version yes (only derived from no (determined

valid value is transmission by document
1) type)

You may also use these custom aributes:

Custom Attribute Description

Envelope CntrlNum Status These aributes indicate the control number

validation status of documents, thus enabling child
Group CntrlNum Status
documents to know the validation status of their
Transaction CntrlNum parent documents.
Status
When validating document control numbers, Module
for EDI sets this aribute to Valid, Duplicate, Out
of Sequence, or Not Validated.

webMethods Module for EDI Installation and User’s Guide Version 9.12 242
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Custom Attribute Description

For transmission documents, the module only sets

the aribute Envelope CntrlNum Status.
For batch documents, the module sets the following
aributes:
Envelope CntrlNum Status to indicate the status of
the associated transmission document.
Group CntrlNum Status To indicate the status of the
associated batch document.
For file documents, the module sets the following
aributes:
Envelope CntrlNum Status. Indicates the status of
the associated transmission document.
Group CntrlNum Status. Indicates the status of the
associated batch document. the module might
also set this aribute to Not Present.
Transaction CntrlNum Status. Indicates the status of
the associated transaction document.

Managing Your Own Custom Attributes for EDI Documents When

Using TRADACOMS
When you are using TRADACOMS and you want to create and use custom aributes of
your own, you must perform the following steps:

Step Description Where to Find More Information

1 Define the custom aributes in The webMethods Trading Networks

My webMethods. Administrator’s Guide for your
release.

2 Define the TN document type "Defining TN EDI Document Types"

for the type of EDI document on page 37.
with which you want to
associate the custom aribute.

3 Invoke the webMethods Module for EDI Built-In

wm.b2b.editn:addAttributeTypeToBizDoc Services Reference
service to associate the custom
document aribute that you

webMethods Module for EDI Installation and User’s Guide Version 9.12 243
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Step Description Where to Find More Information

created in the previous step
with the TN document type
you installed in the first step.

4 Define a processing rule that "Defining a Processing Rule that

uses your custom aributes. Uses Your Custom Aribute as
Criteria When Using TRADACOMS"
on page 245.

Setting Attribute Values at Run Time When Using TRADACOMS

As with other standards, you must create a service to set the aribute values at run
time when using TRADACOMS. To execute this service, include it as a parameter of
the Execute a Service processing action in a Trading Networks processing rule. Note
that your EDI document type or processing rule must use the Save Document to Database
preprocessing action to save the document content and aributes to the database.
Create a service that performs the following logic:
Obtain the values you want to use for each custom aribute.
For each aribute, invoke the wm.tn.doc:setAttribute service to set the value of the
aribute in the BizDocEnvelope.
Invoke the wm.tn.doc:updateAttributes service to update the values of the aributes in the
copy of the document that is saved in the Trading Networks database.
Example
Let’s say you are working with the File document type, and you want to associate the
PurchaseOrderNumber aribute with an ORDERS document. To do so, you would:
1. Install the TN document type for the ORDERS document.
2. Create the PurchaseOrderNumber aribute.
3. Invoke the wm.b2b.editn:addAttributeTypeToBizDoc service to associate the
PurchaseOrderNumber aribute with the TN document type for the ORDERS document.
4. Create a service that extracts the value for the PurchaseOrderNumber aribute from
the ORDERS document, and assign this service as input to the Execute a Service
processing action in the processing rule. Your service should do the following:
Invoke the wm.tn.doc:setAttribute service to set the value for the aribute in the
BizDocEnvelope
Invoke wm.tn.doc:updateAttributes to update the aributes in the saved copy of the
document in the Trading Networks database

webMethods Module for EDI Installation and User’s Guide Version 9.12 244
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Defining a Processing Rule that Uses Your Custom Attribute as Criteria When
Using TRADACOMS
To use the custom aributes you defined as criteria in a processing rule, you need to:
Associate custom aributes with EDI document types, as described in "Managing
Your Own Custom Aributes for EDI Documents When Using TRADACOMS" on
page 243.
Create a processing rule to process the document, considering the following:
Do not use content-based processing.
Leave the Extended Criteria tab of the Processing Rules screen blank.
In the Execute a Service processing rule, invoke a service that sets the values of the
custom aributes, as described in "Seing Aribute Values at Run Time When
Using TRADACOMS" on page 244.
Ensure that the service invokes the wm.tn.reroute service so that Trading Networks
selects another processing rule for the document. (The next processing rule uses
your custom aributes as criteria.)
Create a processing rule that uses the custom aributes as criteria in the Extended
Criteria tab.

Note: When you order your processing rules, be sure to list the processing rule
that uses your custom aributes as criteria before the processing rule that
sets the aribute values. This ensures that Trading Networks will skip
the processing rule that uses the custom aribute criteria the first time the
document is processed but select it the second time.

Defining Processing Rules to Process Inbound EDI

Documents When Using TRADACOMS
When using TRADACOMS, you can specify how Module for EDI processes
transmission, batch, and file documents that have been split from the original
inbound EDI document by using processing rules. Your processing rules specify the
preprocessing and processing actions that you want Trading Networks to perform
against the document, as well as the selection criteria that Trading Networks uses to
determine which processing rule to apply.
The processing rules you need to define are based on the TRADACOMS/splitOption
variable that you set in the EDITPA.

webMethods Module for EDI Installation and User’s Guide Version 9.12 245
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

If you set TRADACOMS/ Then define processing rules for...

splitOption to...

Transmission Transmission document

Batch Transmission document

Batch documents

File Transmission document

Batch documents
Each type of File document (for example, ORDHDR,
INVHDR, etc.)

Define processing rules using My webMethods. For more information, see the
webMethods Trading Networks Administrator’s Guide for your release.

Specifying Processing Rule Criteria When Using TRADACOMS

When you create a processing rule, you specify the criteria that Trading Networks uses
to select the appropriate processing rule for a transmission, batch, or file document. The
following table lists the criteria you can specify.

Use this criteria... To have Trading Networks select a processing rule based on...

Sender The sender of the document

Receiver The receiver of the document

Document Type The TN document type for the document

To have Trading Networks Set the Document Type criterion

select a processing rule for... to this TN document type...

Transmission document TRADACOMS Transmission

Batch document TRADACOMS Batch

File document A particular TRADACOMS

File type and version, such as
TRADACOMS 9 ORDHDR.

webMethods Module for EDI Installation and User’s Guide Version 9.12 246
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Use this criteria... To have Trading Networks select a processing rule based on...

Recognition Errors Whether Trading Networks or the EDI recognizer

encountered any errors during the recognition process

Extended Criteria The values of custom aributes

For example, on the Extended Criteria tab of the Processing
Rules Detail screen, you might specify that the EDI Status
aribute must have the value Duplicate Control Number
for Trading Networks to use the processing rule.
For information about the custom aributes that Module
for EDI sets, see "Custom Aributes that Module for EDI
Sets When Using TRADACOMS" on page 242. For
information about how to set your own custom aributes,
see "Managing Your Own Custom Aributes for EDI
Documents When Using TRADACOMS" on page 243.

Note: Module for EDI does not set the User Status system aribute, so do not use the
User Status criterion.

Specifying Preprocessing Actions When Using TRADACOMS

Default preprocessing actions are defined in TN document types. However, you can
override the seings in the processing rule. For more information about how the
preprocessing actions apply to EDI documents, see the section about preprocessing
actions in webMethods Module for EDI Concepts Guide.
The following table lists the preprocessing actions you can set in a processing rule and
the default seings for each action as set in the TN document types for EDI documents.

Preprocessing Description Default setting in TN document

action type for the EDI document

Validate Structure Validates the structure of the Validate the structure of the
EDI document envelope

Check for Determines if Trading Do not use Trading

Duplicate Networks already has this Networks check for
Document document in its database duplication

Save Document to Saves a copy of the Save document content,

Database document content, aributes, and activity log
aributes, and/or activity log

webMethods Module for EDI Installation and User’s Guide Version 9.12 247
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Preprocessing Description Default setting in TN document

action type for the EDI document
information to the Trading
Networks database

If a preprocessing action fails, Trading Networks records the error and continues
processing. Trading Networks records the error in the errors variable in the
BizDocEnvelope, which is in the bizdoc pipeline variable. Subsequent processing that
you add, for example a service invoked by the Execute a Service processing action, can
access the error information.

Note: You cannot use the Verify Digital Signature preprocessing action because
values for the SignedBody and Signature system aributes are not set for EDI
documents.

Specifying Processing Actions When Using TRADACOMS

You can use all of the Trading Networks processing actions for EDI documents.
If you want to process the information in the file of an inbound EDI document, for
example to use information from file documents to form a document that is to go to
a back-end system, you will primarily use the Execute a Service action. You create the
service that the Execute a Service processing action invokes.
In this scenario, the TRADACOMS/splitOption EDITPA variable must be set to File or
Batch.
For the file and/or batch documents that result from the split, you would define
processing rules that use the Execute a Service processing action to invoke a
service that acts on the file and/or batch documents. For more information
about how to create the services, see "Coding Services to Process File and Batch
Documents When Using TRADACOMS" on page 249.
There is no need to process the transmission document, so you can define a
processing rule that has no processing actions selected, which in effect causes
Trading Networks to ignore the document. Alternatively, you can set up your
processing rules to allow the Transmission document to fall through to the Default
rule, which only sets the User Status system aribute of the document to IGNORED.
If you use the Default rule, you do not need to define a processing rule for the
transmission document.
If you are sending the inbound EDI document through Trading Networks to simply
deliver it to a destination without processing the file, you will primarily use the
Deliver Document By action, with the TRADACOMS/splitOption EDITPA variable set
to Transmission. In this scenario, the only document sent to Trading Networks is
the transmission document. For more information about delivering documents, see
"Forming EDI Documents to Send Outbound When Using Trading Networks " on
page 289.

webMethods Module for EDI Installation and User’s Guide Version 9.12 248
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Coding Services to Process File and Batch Documents When

Using TRADACOMS
The logic you design in your processing service (set in the Execute a Service action)
depends on the types of documents that Module for EDI is spliing from the original
EDI document. This information is based on what is specified in the TRADACOMS/
splitOption EDITPA variable.

If TRADACOMS/splitOption Module for EDI creates...

is...

File File, batch, and transmission documents from the

original EDI document. When the split document is
of type:
File. Create a service that processes the file
contained in the File document. For example, form
an internal-format document based on the file
information and send the internal-format document
to an internal application, such as a back-end
system. For information about how to create this
service, see "Logic to Process a File Document" on
page 252.
Batch and transmission. Do not create a service. All
processing for these EDI documents is handled in
the processing of the file documents. You could set
up processing rules for the batch and transmission
documents that have no processing actions selected
or set up your processing rules so the transmission
document falls through to the Default rule.

Batch Batch and transmission documents from the original

EDI document. When the split document is of type:
Batch. Create a service that processes each file
within the batch. For information about how
to create this service, see "Logic to Map a File
Document to an Internal-Format Document" on
page 254.
Transmission. Do not create a service. All processing
for the EDI document would be complete in the
processing of the Batch document. You could set up
a processing rule for the Transmission document
that selects no processing actions or set up your

webMethods Module for EDI Installation and User’s Guide Version 9.12 249
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

If TRADACOMS/splitOption Module for EDI creates...

is...
processing rules so the Transmission document
falls through to the Default rule.

Transmission Transmission documents from the original EDI

document. You would set the TRADACOMS/
splitOption to Transmission if you want to simply
deliver the EDI document to its receiver.
For more information about how to deliver a
document, see "Delivering the Outbound EDI
Document" on page 297.

The services you create can use information that is in the pipeline. For information about
the data that is in the pipeline when your service is invoked, see "Information in the
Pipeline that Your Service Can Access When Using TRADACOMS" on page 250.

Information in the Pipeline that Your Service Can Access When

Using TRADACOMS
When a transmission, batch, or file document is passed to the processing rule, the
following information is accessible to your service from the pipeline:
BizDocEnvelope in the bizdoc variable. Use the BizDocEnvelope to retrieve
information that Trading Networks maintains about the document. The
BizDocEnvelope adheres to the wm.tn.rec:BizDocEnvelope IS document type. It is also
an instance of com.wm.app.tn.doc.BizDocEnvelope. For more information about the
BizDocEnvelope, see the webMethods Trading Networks Built-In Services Reference for
your release.
The following table lists some of the variables within the BizDocEnvelope.

Variable Description

DocumentID The EDI transmission control number/file generation number

from the transmission, batch, or file header as described in
"DocumentID" on page 241.

Aributes The custom aributes that were set for the document. For
information about the custom aributes that Module for EDI
sets, see "Custom Aributes that Module for EDI Sets When
Using TRADACOMS" on page 242.

Errors The errors that Trading Networks and Module for EDI
encountered while processing the document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 250
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

EDI document summary information in the envelopeDocuments variable. When

Trading Networks originally receives the EDI document, it passes it to the EDI
recognizer, which parses the EDI document. This EDI document summary is the
result of the parse. It is the entire original EDI document as an IData object.
You can use the EDI document summary information to derive a total document
count or to determine when all of the documents in the original EDI document have
completed processing. To do so, your service can perform a simple count of the
original documents and a count of the documents processed. When these counts
match, processing of the entire original EDI document is complete. You also can
perform a query within Trading Networks that checks the status of each document
using the Trading Networks internal ID for each document.
The following table shows the structure of the EDI document summary information
in the envelopeDocuments variable.

Variable Description

Document List Summary of the transmission document including the

envelopeDocuments
batch and file that it contains.

Key Description

docID A String that contains the Internal ID that Trading

Networks generated for the Transmission
document.

docTypeID A String that contains the internal ID of the

TN document type used for the Transmission
document.

docTypeName A String that contains the name of the TN document

type used for the Transmission document, for
example, TRADACOMS Transmission.

groupDocuments(optional) A Document List that contains a

summary of all the batch documents in the
transmission.

Key Description

docID A String that contains the Internal ID

that Trading Networks generated for
the Batch document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 251
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Variable Description

docTypeID A String that contains the Internal ID

of the TN document type used for the
Batch document.

docTypeNameA String that contains the name of the

TN document type used for the Batch
document, for example, Tradacoms Batch.

transactionDocuments
(optional) A Document List that
contains a summary of all the file
documents in the batch.

Key Description

docID A String that contains

the Internal ID that
Trading Networks
generated for the File
document.

docTypeID A String that contains

the Internal ID of the TN
document type used for
the File document.

docTypeName A String that contains

the name of the TN
document type used for
the File document, for
example, Tradacoms File.

Logic to Process a File Document

The following sample code can be invoked by a processing rule to process a file
document. This service creates one file document type that contains all the detail
messages contained in the file. Alternatively, you can write a service that creates a
file document type for each detail message, as described in "Storage Options for File
Document Types" on page 118.

webMethods Module for EDI Installation and User’s Guide Version 9.12 252
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Flow Description
operation

1 Invoke the EDI built-in service wm.b2b.edi.tradacoms.doc:isFileEnvelope to

determine whether a BizDocEnvelope contains a TRADACOMS File
document.

2 Invoke the wm.b2b.edi.tradacoms.doc:getFFSchemaNames service to return

the name of the flat file schemas that can be used to parse the parts of
the TRADACOMS file. This service returns up to four flat file schemas:
a header schema, a detail schema, a VAT schema (if present), and a
trailer schema.

3 Invoke the wm.b2b.edi.tradacoms.doc:getDocumentPartInfo service to return

the number of detail messages contained in the TRADACOMS file and
to determine whether the file contains VAT information.

webMethods Module for EDI Installation and User’s Guide Version 9.12 253
 M
Even Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Flow Description
operation

4 Invoke the wm.b2b.edi.tradacoms.doc:getDocumentPart service to return the

content part object representing the header message.

5 Invoke the wm.b2b.editn.util:getContentPartDataAsInputStream service to

obtain the data, as an input stream, from the content part. This service
determines whether the document is stored in memory or on disk.

6 Invoke the wm.b2b.edi.tradacoms:convertToValues service to convert the

content part input stream to an IS document (IData object) based on the
input flat file schemas.

7 Determine whether the file contains a VAT message. If it contains a

VAT message, parse the VAT message by invoking the getContentPartInfo,
getDocumentPartDataAsInputStream, and convertToValues services, as you did
for the header message.

8 Parse the trailer message by invoking the getContentPart,

getDocumentPartDataAsInputStream, and convertToValues services, as you did
for the header message.

9 Parse the detail messages by executing a loop and invoking the

getContentPart, getDocumentPartDataAsInputStream, and convertToValues
services for each detail message, as you did for the header message.
In addition, invoke the wm.b2b.edi.util.documentList:addDocToDocumentList
service to put all detail messages into a document list.

10 Append the documents to a document list by invoking the

pub.list:appendToDocumentList service.

For more information about these built-in services, see webMethods Module for EDI Built-
In Services Reference.

Logic to Map a File Document to an Internal-Format Document

The following sample code shows logic you might want to include to process a file
document that contains a file from an inbound EDI document. The processing in
the service below shows how to map information from the file to an internal-format
document and send the document to an internal application, that is, a back-end system.

webMethods Module for EDI Installation and User’s Guide Version 9.12 254
 M
Odd Header
Processing Inbound TRADACOMS Documents Using Trading Networks

Flow Description
operation

1 Invoke the wm.b2b.edi.tradacoms.compose:startTradacomsTransmission EDI

built-in service to create an STX segment for a transmission. This
service returns a TRADACOMS transmission object.

2 Invoke the wm.b2b.edi.tradacoms.compose:addToTradacomsTransmission

service to add the header message to the TRADACOMS
transmission object that the startTradacomsTransmission service
returned.

3 Invoke the addToTradacomsTransmission service again to add the detail

messages to the TRADACOMS transmission object.

4 Invoke the addToTradacomsTransmission service again to add the trailer

message to the TRADACOMS transmission object.

5 Invoke the wm.b2b.edi.tradacoms.compose:endTradacomsTransmission

service to create an END segment for the transmission.

6 Invoke the Integration Serverpub.io:streamToBytes built-in service to

convert the InputStream to bytes.

7 Invoke the Integration Serverpub.string:bytesToString built-in service to

convert the output of pub.io:streamToBytes to a string.

webMethods Module for EDI Installation and User’s Guide Version 9.12 255
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 256
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

13   Optional Inbound Processing When Using Trading

Networks

■ Overview ..................................................................................................................................... 258

■ Validating Inbound Control Numbers ......................................................................................... 258
■ Defining Processing Rules to Handle Documents with Invalid Control Numbers ...................... 265
■ Reprocessing EDI Documents with Invalid Control Numbers .................................................... 268
■ Automatically Generating Functional Acknowledgments ........................................................... 275
■ Automatically Generating Interchange Acknowledgments ......................................................... 284
■ Performing Optional Processing of Inbound EDI Documents .................................................... 284

webMethods Module for EDI Installation and User’s Guide Version 9.12 257
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Overview
During inbound processing, you can have webMethods Module for EDI (Module for
EDI) perform the following optional processing:
Validate inbound interchange and/or group control numbers (or TRADACOMS
transmission and/or batch control numbers). For more information, see "Validating
Inbound Control Numbers" on page 258 and "Performing Control Number
Validation" on page 261.
Automatically generate functional acknowledgments (FAs). For more information,
see "Automatically Generating Functional Acknowledgments" on page 275.

Note: Functional acknowledgments (FAs) are not applicable to the

TRADACOMS and VDA standards.

Automatically generate interchange acknowledgments (TA1). For more information,

see "Automatically Generating Interchange Acknowledgments" on page 284.
For information about defining control number information for your trading partners
and seing up control number validation, including turning on and off control number
validation, see "Defining Control Number Information for Trading Partners" on page
123.

Validating Inbound Control Numbers

During inbound processing, Module for EDI can validate the interchange and/or group
control numbers (or TRADACOMS transmission and/or batch control numbers) in
the headers of the inbound EDI document. Validation determines whether the control
numbers are in order, and therefore whether the EDI documents arrived in order.
To determine whether a control number is valid or invalid, Module for EDI looks up
the EDIControlNumber table entry that corresponds to the interchange or group header
(or transmission or batch header) of an inbound EDI document. It then compares
the control number from the header to the next expected control number in the
EDIControlNumber table entry to determine whether the control number is valid or
invalid.
For more information about the EDIControlNumber table, see "Managing Control
Number Information" on page 124.

Valid Control Numbers

Module for EDI considers the control number of an inbound EDI document to be valid
when it matches the next expected control number in the EDIControlNumber table
entry. How this process works depends on the EDI standard in use:

webMethods Module for EDI Installation and User’s Guide Version 9.12 258
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

For VDA documents. Unlike other EDI standards, the VDA message has two control
number fields at the envelope level: the old control number and the new control
number. (For this reason, no control number incrementing occurs.) If validation
is turned on, Module for EDI extracts the old control number from the document
and matches it against the one stored in the database. Then the module updates the
EDIControlNumber table with the value of the new control number field so that
the next document's old control number field can be validated against the current
document's new one.
For the ordering of VDA documents exchanged between trading partners, the first
document must have 00000 as the old control number, and the new control number
must be any positive number. For subsequent exchanges, the old control number of
that message must match the new control number fields of the previous message.
If the new control number field for the inbound document is greater than the control
number maximum, Module for EDI sets the value of the next expected control number
as the control number minimum.
For all other standards. Non-VDA documents contain a single control number,
which Module for EDI uses to compare with the control number entry in
the EDIControlNumber table. When Module for EDI determines a control
number is valid, it calculates the next expected control number, saves it in the
EDIControlNumber table, and continues processing the EDI document.
To determine the next expected control number, Module for EDI adds the control
number increment to the valid control number. If the result is greater than the control
number maximum, the module sets the next expected control number as the control
number minimum.

Invalid Control Numbers

Module for EDI considers the control number of an inbound EDI document to be invalid
when it does not match the next expected control number in the EDIControlNumber
table entry. Once a control number is determined to be invalid, the module determines
whether the invalid control number is a duplicate control number or an out-of-sequence
control number. Last, the module takes the action you define in "Actions Module for EDI
Can Take for Invalid Control Numbers" on page 262.

Duplicate Control Numbers

A duplicate control number is a control number that Module for EDI believes has already
been used and, therefore, might indicate a duplicate document. Generally, the module
considers a control number to be a duplicate if the control number from the header
is less than the next expected control number in the EDIControlNumber table (for
example, the module receives an EDI document with control number 6, but the expected
control number is 8).
However, a duplicate control number might be larger than the expected control number
when the next expected control number is close to the minimum. Module for EDI uses

webMethods Module for EDI Installation and User’s Guide Version 9.12 259
 M
Even Header
Optional Inbound Processing When Using Trading Networks

the control number window to determine a range of numbers greater than the expected
control number that should be considered duplicate, as shown in this example :

Note: Because Module for EDI only maintains the next expected control number
(not a list of all previously used control numbers), and because the next
expected control number can be set manually, the module might determine
that a control number is:
A duplicate, even though the control number was never received
previously.
Out-of-sequence, even though the control number has been received
already.

You define the action that you want Module for EDI to take if a document with
a duplicate or out-of-sequence control number arrives. For example, you can set
the module to prevent processing of documents with duplicate or out-of-sequence
control numbers. For more information, see "Actions Module for EDI Can Take for
Invalid Control Numbers" on page 262. Later, you can force the processing of these
documents. For more information, see "Reprocessing EDI Documents with Invalid
Control Numbers" on page 268 and "Reprocessing Documents with Out-of-Sequence
Control Numbers" on page 269.

Out-of-Sequence Control Numbers

An out-of-sequence control number indicates that there might be missing EDI documents;
that is, EDI documents that you should have already received have not yet arrived. A
control number is also considered out of sequence if it is not numeric.
Generally, Module for EDI considers a control number to be out of sequence if it is
greater than the expected control number. For example, the module receives an EDI
document with control number 8, but the expected control number is 6, indicating that
you did not receive the EDI documents with control numbers 6 and 7.
However, an out-of-sequence control number might be lower than the expected control
number as the expected control number approaches the control number maximum.
Module for EDI uses the control number window to determine a range of numbers

webMethods Module for EDI Installation and User’s Guide Version 9.12 260
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

lower than the expected control number that should be considered out-of-sequence, as
shown in this example :

Note: Module for EDI maintains only the next expected control number in the
EDIControlNumber table, not a list of all previously used control numbers.
Because the next expected control number can be manually set, the module
might determine that a control number is out of sequence even though a
document with the control number has already been received.

Performing Control Number Validation

When Module for EDI receives an EDI document, the module performs the following
steps:

Step Description

1 Module for EDI determines whether it is to validate the control number.

To determine whether to validate control numbers in inbound EDI
documents, the module uses the sender/receiver from the header and
finds the seings you have defined for that sender/receiver pair. For
information about how to allow validation, see "Turning Inbound Control
Number Validation On and Off" on page 132.
If the module is to validate the control number, the module continues with
the next step.

2 Using the sender/receiver, EDI standard/version, production mode,

and type that are identified in the interchange or group header (or the
transmission or batch header), the module locates the corresponding entry
in the EDIControlNumber table.

3 Module for EDI determines whether the control number is valid (that is, in
order) by comparing the control number from the header with the control
number from the EDIControlNumber table entry. The module maintains
the next expected control number in the EDIControlNumber table. The
control number is either valid or invalid, as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 261
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Step Description

Valid control number. The control number value from the header matches
the next expected control number in the EDIControlNumber table entry.
If there is no EDIControlNumber entry for the sender/receiver, EDI
standard/version, production mode, and type (for example, "Envelope"
or group type) identified in the interchange or group header, the module:
1. Assumes the control number is valid.
2. Adds an entry to the EDIControlNumber entry for the sender/
receiver, EDI standard/version, production mode, and type. In the
EDIControlNumber entry, the module sets the control number
maximum, minimum, increment, and window to their defaults and
calculates the next expected control number and saves this number
in the EDIControlNumber table entry. For more information, see
"Validating Inbound Control Numbers" on page 258.
3. Sets the Trading NetworksEDI Status custom aribute to Processed.
Invalid control number. The control number value from the header does
not match the next expected control number in the EDIControlNumber
table entry. When the control number is invalid, Module for EDI first
determines whether the control number is a duplicate or out-of-sequence,
and then takes the action you defined based on this information.
For more information about invalid control numbers, see "Invalid
Control Numbers" on page 259. For more information about the
actions the module takes for invalid control numbers, see "Actions
Module for EDI Can Take for Invalid Control Numbers" on page 262.

Actions Module for EDI Can Take for Invalid Control Numbers
The actions that you can define for duplicate or out-of-sequence control numbers are:

Action Where to Find More Information

Error & Continue "Error & Continue" on page 263

Process Normally "Process Normally" on page 263

Reject "Reject" on page 263

For information about how to define the action you want Module for EDI to take, see
"Defining Actions Module for EDI Can Take for Invalid Control Numbers" on page 136.

webMethods Module for EDI Installation and User’s Guide Version 9.12 262
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Error & Continue

When you select Error & Continue and Module for EDI encounters an invalid control
number, the module:
1. Logs the error to the Trading Networks activity log.
2. Adds the error to the BizDocEnvelope (in the bizdoc/Errors pipeline variable).
Because the error is logged to the BizDocEnvelope, you can use the Recognition Errors
criterion in a processing rule to select the documents that have errors.
3. Sets the next expected control number for the sender/receiver by incrementing the
control number in the appropriate EDIControlNumber table entry. The sender/
receiver pair is either:
For ANSI X12, UN/EDIFACT, or VDA: The sender/receiver identified on an
interchange header for an interchange control number or a group header for a
group control number.
For TRADACOMS: The sender/receiver identified on a transmission header for a
transmission control number or the sender/receiver identified on a batch header
for a batch control number.
For more information, see "Validating Inbound Control Numbers" on page 258.
4. Continues normal processing of the document.

Process Normally
When you select Process Normally and Module for EDI encounters an invalid control
number, the module performs these steps:
1. Logs the warning to the Trading Networks activity log.

Note: Because an error is not logged to the BizDocEnvelope, you cannot use the
Recognition Errors criterion in a processing rule to select the documents that
have errors.

2. Sets the next expected control number for the sender/receiver by incrementing
the control number in the appropriate EDIControlNumber table entry. For more
information, see "Validating Inbound Control Numbers" on page 258.
3. Continues normal processing of the document.

Reject
When you select Reject and Module for EDI encounters an invalid control number, it
does not perform normal processing on the document. Rather, the module:
1. Does not split the Interchange or Group document according to the seing of the
splitOption EDITPA variable (or the Transmission or Batch document according to
the seing of the TRADACOMS/splitOption EDITPA variable).

webMethods Module for EDI Installation and User’s Guide Version 9.12 263
 M
Even Header
Optional Inbound Processing When Using Trading Networks

For ANSI X12, UN/EDIFACT, or VDA:

If an interchange control number is invalid and the splitOption variable is set to
Group, Module for EDI does not create Group documents.

If an interchange control number is invalid and the splitOption variable is

set to Transaction, Module for EDI does not create Group and Transaction
documents.
(ANSI X12 and UN/EDIFACT only) If a group control number is invalid and the
splitOption variable is set to Transaction, Module for EDI does not create Group
and Transaction documents for the group that has the invalid control number.
For more information about the splitOption variable, see "splitOption Variable" on
page 71.
For TRADACOMS:
If a transmission control number is invalid and the TRADACOMS/splitOption
variable is set to Batch, the Module for EDI does not create Batch documents.
If a transmission control number is invalid and the TRADACOMS/splitOption
variable is set to File, Module for EDI does not create Batch or File documents.
If a batch control number is invalid and the TRADACOMS/splitOption variable is
set to File, Module for EDI does not create Batch or File documents for the batch
that has the invalid control number.
For more information about the TRADACOMS/splitOption variable, see
"TRADACOM Variables" on page 112.
2. Logs the error to the Trading Networks activity log.
3. Adds the error to the BizDocEnvelope (in the bizdoc/Errors pipeline variable).
Because the error is logged to the BizDocEnvelope, you can use the Recognition Errors
criterion in a processing rule to select documents have errors.
4. Sets the Trading NetworksEDI Status custom aribute based on whether the action is
for a duplicate control number or out-of-sequence control number:
For a duplicate control number, sets the EDI Status aribute to Duplicate
Control Number.

For an out-of-sequence control number, sets the EDI Status aribute to Out of
Sequence Control Number.

5. Continues to process the unsplit document by passing it to Trading Networks

processing rules. You can define a processing rule that has criteria that matches
documents with the Trading NetworksEDI Status custom aribute set to Duplicate
Control Number or Out of Sequence Control Number. The processing rule
should handle the rejected document, for example, by sending an administrator an
e-mail notification. For more information, see "Defining Processing Rules to Handle
Documents with Invalid Control Numbers" on page 265.

webMethods Module for EDI Installation and User’s Guide Version 9.12 264
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Additionally, you can later force the processing of documents that contain invalid
control numbers. For more information, see "Reprocessing EDI Documents with
Invalid Control Numbers" on page 268.

Note: If the control number is invalid, Module for EDI does not increment the
control number in the EDIControlNumber table.

Defining Processing Rules to Handle Documents with Invalid

Control Numbers
If you set the action to take for an invalid control number to Reject, you should define
a processing rule to handle the EDI document with the invalid control numbers. For
information about how to define the action, see "Actions Module for EDI Can Take for
Invalid Control Numbers" on page 262. For more information about the actions that
Module for EDI takes when you set the action to Reject, see "Reject" on page 263.
Module for EDI uses a Trading Networks custom aribute, EDI Status, to indicate
whether a document has an invalid control number. You can use this status in the
processing rule criteria.

Setting the EDI Status Custom Attribute for Control Number

Validation
Module for EDI sets the value of the EDI Status custom aribute for control number
validation of inbound EDI documents.

Custom Attribute Description

EDI Status Module for EDI sets this aribute to indicate whether a
control number for a document is valid. If the module
determines that a document contains:
Valid control number, it sets this aribute to Processed.
Duplicate control number, it sets this aribute to Duplicate
Control Number.

Out-of-sequence control number, it sets this aribute to Out

of Sequence Control Number.

For more information about duplicate or out-of-sequence

control numbers, see "Invalid Control Numbers" on page
259.

For information about other Trading Networks document aributes that Module for EDI
uses, see:

webMethods Module for EDI Installation and User’s Guide Version 9.12 265
 M
Even Header
Optional Inbound Processing When Using Trading Networks

For non-TRADACOMS users: " Trading Networks Aributes and EDI Documents"
on page 211.
For TRADACOMS users: " Trading Networks Aributes and EDI Documents When
Using TRADACOMS" on page 240.

Defining the Processing Rule to Handle Documents with Invalid

Control Numbers
In My webMethods, use the Administration > Integration > B2B > Processing Rules
page to define a processing rule for handling EDI documents with invalid control
numbers. When you define a processing rule, you define the criteria that you want
Trading Networks to use to select the processing rule, the preprocessing actions, and
the processing actions. For more information about creating processing rules, see the
webMethods Trading Networks Administrator’s Guide for your release.
The following table provides details about how to define the processing rules.

Processing Rule Tab Description

Extended Criteria To select EDI documents that Module for EDI rejected
because it detected an invalid control number and the action
to take was set to Reject, use the Extended Criteria of the
Trading Networks processing rules. You can use the Extended
Criteria to select documents based on the value of custom
aributes. In this case, you select documents based on the
value of the EDI Status custom aribute, as shown below.

To select documents with duplicate control numbers, specify:

Attribute Operator Value

EDI Status Equals Duplicate

Control Number

To select documents with out-of-sequence control numbers,

specify:

Attribute Operator Value

EDI Status Equals Out of Sequence

Control Number

webMethods Module for EDI Installation and User’s Guide Version 9.12 266
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Processing Rule Tab Description

Important:
When specifying the value for extended criteria, be
sure to use the exact combination of upper and lower
case leers.

Pre-Processing You should override the default preprocessing actions with

the following:

Action Description

Verify Digital Do not verify digital signature

Signature

Validate Structure Do not validate structure

Check for Do not use Trading Networks check

Duplicate for duplication
Document

Save Document to Save

Database

Note: If you do not select to save the content, Module for

EDI will automatically save the content so that you can
reprocess the document. For more information about
reprocessing, see "Reprocessing EDI Documents with
Invalid Control Numbers" on page 268.

Action Define the actions that you want to take to handle the
EDI document containing the invalid control number. For
example, you might select:
Alert e-mail to send an e-mail message to notify an
administrator of the problem.
Execute a service to invoke a service that you create to
perform processing. You might choose to write your own
service to send an e-mail message or perform some other
type of notification.

webMethods Module for EDI Installation and User’s Guide Version 9.12 267
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Reprocessing EDI Documents with Invalid Control Numbers

When you set the action to take for a document with a duplicate or out-of-sequence
control number to Reject, you can later reprocess the documents that have invalid
control numbers. For information about how to define the action, see "Defining
Actions Module for EDI Can Take for Invalid Control Numbers" on page 136. For more
information about how Module for EDI processes documents when the action is Reject,
see "Reject" on page 263.
The way you reprocess documents with invalid control numbers varies based on
whether the invalid control number is a duplicate control number or an out-of-sequence
control number.

Reprocessing Documents with Duplicate Control Numbers

For documents with duplicate control numbers, first ensure the document is not a
duplicate and that you have not already processed it. If you determine that you still
need to process a document, you can force the reprocessing.

To reprocess a document with a duplicate control number

1. To determine the EDI documents that were rejected because they contained
duplicate control numbers, from Software AG Designer, invoke the
wm.b2b.editn.util.reprocess.listUnprocessDoc service. When you invoke this service, specify
Duplicate for the type input parameter. The service returns a list of Trading
Networks internal IDs of documents that have duplicate control numbers.
2. For each Trading Networks internal ID returned by the
wm.b2b.editn.util.reprocess.listUnprocessDoc service, use that internal ID to view the
content of the document, as follows:
a. In My webMethods: Monitoring >Integration > B2B > Transactions
b. In the Transaction Search panel, select Internal ID from the search query field list,
select the Equals operator, and paste the internal ID into the Value box.
c. Select Search.
d. Select a transaction row that the query returns and then select the Content tab to
view contents of the document that had a duplicate control number.
3. If you want to reprocess a document, do one of the following:
In My webMethods, select Reprocess.
When you use this method, Module for EDI uses the default values for
generateFA and updateControlNumber , described below.
In Designer, invoke the wm.b2b.editn.util.reprocess.reprocessDocument service and
specify the following:

webMethods Module for EDI Installation and User’s Guide Version 9.12 268
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

For this input Specify...

parameter...

internalID Trading Networks internal ID of the document you

want to reprocess.

generateFA For ANSI X12 and UN/EDIFACT only. Whether you

want to generate functional acknowledgments (FAs)
for the document you are reprocessing. Specify one
of the following:

Value Meaning

true Generate FAs. Specify true when

reprocessing a document with a duplicate
interchange control number.

false Do not generate FAs. This is the default.

Specify false when reprocessing a
document with a duplicate group control
number.

updateControlNumber Whether you want to update the next expected

control number in the EDIControlNumber table.
Specify false (the default).

Reprocessing Documents with Out-of-Sequence Control Numbers

If you set the action to take for an out-of-sequence control number to Reject, you can
later reprocess the out-of-sequence documents.
Out-of-sequence control numbers in EDI document might indicate that there were
missing documents. Later, if the missing EDI documents arrive, you might want to force
the processing of the out-of-sequence document. This time, because the missing EDI
documents have arrived, the control number will no longer be out-of-sequence and
Module for EDI will be able to process it normally.
To force the processing of out-of-sequence documents, you can create a service that
locates all out-of-sequence documents and aempts to reprocess them. For information
about how to create the service, see "Creating a Service to Reprocess Documents with
Out-of-Sequence Control Numbers" on page 270.
Rather than invoke the service you create manually, you should use Integration Server
Administrator to schedule a user task that causes the Integration Server to periodically
invoke your service to reprocess any out-of-sequence documents. For more information

webMethods Module for EDI Installation and User’s Guide Version 9.12 269
 M
Even Header
Optional Inbound Processing When Using Trading Networks

about creating a user task to schedule a service to run periodically, see the webMethods
Integration Server Administrator’s Guide for your release.

Creating a Service to Reprocess Documents with Out-of-Sequence Control

Numbers
The following diagram shows sample code that includes the logic you need to locate and
reprocess out-of-sequence ANSI X12 documents. See the table below the diagram for
more information.

Flow operation Description

1 Invoke the wm.b2b.editn.util.reprocess:listInSequence service to retrieve

a list of EDI documents that had out-of-sequence control numbers,
but now due to missing documents arriving, are in sequence.
For more information about the listInSequence service, see the
webMethods Module for EDI Built-In Services Reference.

2 The wm.b2b.editn.util.reprocess:listInSequence service returns a list of

Trading Networks internal IDs in the docList parameter. This
list represents EDI documents that are now in sequence. Loop to
perform the following steps against each internal ID in the list.

webMethods Module for EDI Installation and User’s Guide Version 9.12 270
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Flow operation Description

3 Steps 3 through 6 are needed if you use automatic functional

acknowledgment (FA) generation for ANSI X12 or UN/
EDIFACT documents. If you use automatic FA generation, when
reprocessing Interchange documents, you will want to generate
FAs; however, when reprocessing Group documents, do not
generate FAs because the FAs have already been generated for
the document. For more about automatic FA generation, see
"Automatically Generating Functional Acknowledgments" on page
275.
Invoke the wm.tn.doc:view service to retrieve information about the
document. Specifically, the value of the EDI Group Type aribute is
needed to determine whether the document is an Interchange or
Group document.
When you invoke wm.tn.doc:view, set the following input
parameters:
Map the docList parameter under Pipeline In to internalID under
Service In.
Set the value of getContent under Service Into false.
Set the value of getRelated under Service In to false.

4 The value of the EDI Group Type aribute is in the bizdoc/Aributes/

EDI Group Type pipeline variable. To branch based on its value, set
the Switch property to the following:
bizdoc/Attributes/EDI Group Type

When bizdoc/Aributes/EDI Group Type is Envelope, it is an

Interchange document.
When bizdoc/Aributes/EDI Group Type is another value (for
example, PO), it is a Group document.

5 Add a MAP flow operation to set the value of the

generateFA parameter, which is an input to the
wm.b2b.editn.util.reprocess:reprocessDocument service.
To do so, with the MAP flow operation selected on the Pipeline tab,
add a generateFA parameter under Pipeline Out and set the value to
one of the following:
In the SEQUENCE for when the EDI Group Type aribute
is Envelope, set the value to true, which indicates the
wm.b2b.editn.util.reprocess:reprocessDocument service should generate
the FAs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 271
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Flow operation Description

In the SEQUENCE for when the EDI Group Type aribute is

another value, set the value to false, which indicates the
wm.b2b.editn.util.reprocess:reprocessDocument service should not
generate the FAs.
For example, the diagram shows the pipeline for the MAP when
the EDI Group Type aribute is Envelope (that is, the generateFA
parameter is set to true).

6 Use a MAP flow operation to clean up the pipeline by dropping all

parameters related to invoking the wm.tn.doc:view service. Drop the
following parameters: internalID , getContent , getRelated , bizdoc ,
sender , receiver , relatedDocCount , relatedDocs , groupDocCount , and
groupedDocs .

webMethods Module for EDI Installation and User’s Guide Version 9.12 272
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Flow operation Description

7 Invoke the wm.b2b.editn.util.reprocess:reprocessDocument service to

reprocess an EDI document that is now in sequence.
To set the inputs for this service, with this flow operation selected,
perform the following on the Pipeline tab:
Map the docList parameter under Pipeline In to internalID under
Service In.
If you added the generateFA parameter to the pipeline in the
previous steps, the generateFA parameter exists under Pipeline In
and is automatically mapped to the generateFA input parameter
under Service In. If you are not using automatic FA generation,
you can set the value of generateFA under Service In to false.
Set the value of the updateControlNumber parameter under Service
In to true. This is necessary so the service updates the next
expected control number in the EDIControlNumber table.
For more information about the reprocessDocument service, see
webMethods Module for EDI Built-In Services Reference.

8 After you reprocess a document, there might be another out-of-

sequence document that is now in sequence. This next document
that is now in sequence would be one that has the same sender/
receiver and group type as the one you just reprocessed. For
example, if you reprocess a Group document of group type "PO"
from sender A and receiver B, and the Group document had the

webMethods Module for EDI Installation and User’s Guide Version 9.12 273
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Flow operation Description

control number 4. The Group document of group type "PO" from
sender A and receiver B with control number 5 might also be
available to process, and it is now in sequence.
To locate and reprocess the next document in sequence, use a
REPEAT loop. You will exit this loop when a pipeline variable
becomes null, indicating there are no more next documents in
sequence. (See step 11 below.) When defining the properties for
the REPEAT loop, do the following:
Set the Repeat Interval property to -1.
Set the Repeat On property to SUCCESS.

9 Invoke the wm.b2b.editn.util.reprocess:nextInSequenceDoc service to

determine whether there is another document that had an out-
of-sequence control number that is now in sequence due to the
processing the document in step 2 above.
The input to this service (bizdoc ) is in the pipeline because it is an
output of the wm.b2b.editn.util.reprocess:reprocessDocument service. The
Pipeline In variable will automatically map to the Service In variable.
You should drop the bizdoc parameter in Pipeline Out.

If the nextInSequenceDoc service locates a next document, it returns

the Trading Networks internal ID of the document in the nextDoc
parameter. Otherwise, the nextDoc parameter will be null.
For more information about the nextInSequenceDoc service, see
webMethods Module for EDI Built-In Services Reference.

10 Use a BRANCH flow operation to branch based on the value of

the nextDoc parameter, which is the result of the nextInSequenceDoc
service.

11 If the value of nextDoc parameter is null, exit the REPEAT loop.

webMethods Module for EDI Installation and User’s Guide Version 9.12 274
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Flow operation Description

12 If the nextDoc parameter has a value, prepare to execute the

wm.b2b.editn.util.reprocess:reprocessDocument service against this next
document to reprocess it.
The following flow operations are similar to steps 3 through 6
described above. Differences are noted below.
INVOKE wm.tn.doc:view
When seing the inputs to this service, map the nextDoc
parameter under Pipeline In to internalID under Service In.
BRANCH on bizdoc/Aributes/EDI Group Type
SEQUENCE for seing generateFA when EDI Group Type is
Envelope

SEQUENCE for seing generateFA when EDI Group Type has

another value
MAP to drop variables related to invoking wm.tn.doc:view

13 Invoke the wm.b2b.editn.util.reprocess:reprocessDocument service against

the next document to reprocess it.
To set the inputs for this service, with this flow operation selected,
perform the following on the Pipeline tab:
Map the nextDoc parameter under Pipeline In to internalID under
Service In. You should drop the nextDoc parameter in Pipeline In.
If you added the generateFA parameter to the pipeline in the
previous steps, the generateFA parameter exists under Pipeline
In and is automatically mapped to the input variable generateFA
under Service In. If you are not using automatic FA generation,
you can set the value of generateFA under Service In to false.
Set the value of the updateControlNumber parameter under Service
In to true. This is necessary so the service updates the next
expected control number in the EDIControlNumber table.

Automatically Generating Functional Acknowledgments

Optionally, Module for EDI can automatically generate functional acknowledgments
(FAs) for inbound documents during processing. After the FAs are generated, the
module sends them to Trading Networks so they can be delivered to the sender of the
inbound document. You must define a processing rule to deliver the FAs.

webMethods Module for EDI Installation and User’s Guide Version 9.12 275
 M
Even Header
Optional Inbound Processing When Using Trading Networks

For more information about FAs, including the contents of a generated FA, see
"Generating Acknowledgments" on page 169. For more information about defining a
processing rule to deliver FAs, see "Defining a Processing Rule to Deliver FAs" on page
281.

Note: Functional acknowledgments (FAs) are not applicable to the TRADACOMS

and VDA standards.

The following table lists the tasks you must perform to set up automatic FA generation
and includes a cross reference to the section in this guide that provides more
information about each task.

Task Where to Find More Information

Ensure you have installed the "Configuring webMethods Module for EDI"
TN document types and flat on page 23
file schemas for the FA (997 or
CONTRL)

Turn on automatic FA "Turning Automatic FA Generation On and

generation Off" on page 277

Set the level of detail to include “FAGeneration/FALevel EDITPA Variable” in

in the generated FAs "FAGeneration Variables" on page 80

Set how to generate control “FAGeneration/generateControlNumber EDITPA

numbers for the FA Variable” in "FAGeneration Variables" on page
80

Determine how Module for "Determining How Module for EDI Reports
EDI sets the FA status for FA Status" on page 277
an interchange, group, or
transaction within an EDI
document

Define the action Module for "Defining Actions Module for EDI Takes Based
EDI takes for an interchange, on FA Status" on page 279
group, or transaction document
based on its FA status

Define one or more Trading "Defining Processing Rules to Process Inbound

Networks processing rules to EDI Documents" on page 222
perform normal processing
For more information about acceptable
on documents that have FA
FA statuses, see "Defining FA Statuses as
statuses defined as acceptable
Acceptable and Unacceptable" on page 277.

webMethods Module for EDI Installation and User’s Guide Version 9.12 276
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Task Where to Find More Information

Define one or more Trading "Defining Processing Rules for Documents

Networks processing rules with Unacceptable FA Statuses" on page
to perform processing 282
on documents that have
For more information about unacceptable
FA statuses defined as
FA statuses, see "Defining FA Statuses as
unacceptable
Acceptable and Unacceptable" on page 277.

Define a Trading Networks "Defining a Processing Rule to Deliver FAs" on

processing rule to deliver the page 281
generated FAs

Turning Automatic FA Generation On and Off

You set the FAGeneration/autoGenerateFA EDITPA variable to indicate whether you want
Module for EDI to automatically generate FAs for an interchange sender/receiver pair.
Because you turn automatic FA generation on or off using an EDITPA variable, you can
control whether the module automatically generates FAs for all sender/receiver pairs (by
seing the variable in the default EDITPA) or for specific sender/receiver pairs (by using
partner-specific EDITPAs).
For information about seing the FAGeneration/autoGenerateFA EDITPA variable, see
"FAGeneration Variables" on page 80.

Determining How Module for EDI Reports FA Status

Module for EDI uses the same information to determine the FA status for a transaction,
group, or interchange of an inbound EDI document whether the FA is generated by
the generateFA service or the FAGeneration/autoGenerateFA EDITPA variable. For more
information about how the module determines FA status, see "Determining How
Module for EDI Reports FA Status" on page 173.

Defining FA Statuses as Acceptable and Unacceptable

You use the FAGeneration/processDocument EDITPA variable to define FA statuses as
acceptable or unacceptable. Module for EDI processes documents that have acceptable
FA statuses normally and handles documents that have unacceptable FA statuses in a
different manner. For more information about defining FAGeneration/processDocument
EDITPA variable, see "FAGeneration Variables" on page 80.
The following table describes how Module for EDI processes a document based on the
document's FA status and the seing of the FAGeneration/processDocument EDITPA
variable.

webMethods Module for EDI Installation and User’s Guide Version 9.12 277
 M
Even Header
Optional Inbound Processing When Using Trading Networks

When and FA status of the document Module for EDI...

processDocument is...
is set to...

All Any of the following: Processes the document with

Not Allowed the acceptable FA status
normally.
Rejected
Partially Accepted
Accepted, But Errors Were
Noted

Only Accepted Accepted Processes the document with

the acceptable FA status
normally.

Any of the following: Handles the processing

Not Allowed differently for these
unacceptable FA statuses.
Rejected
Partially Accepted
Accepted, But Errors Were
Noted

Not Rejected Any of the following: Processes the document with

Accepted the acceptable FA status
normally.
Not Allowed
Partially Accepted
Accepted, But Errors Were
Noted

Rejected Handles the processing

different for these
unacceptable FA statuses.

For more information about how Module for EDI processes the documents based on
their FA statuses, see "Defining Actions Module for EDI Takes Based on FA Status" on
page 279.

Note: When you are using non-standard processing, Module

for EDI does not use the FAGeneration/processDocument
EDITPA variable. Instead, it uses the Process Document
seing that you set from the Interchange Information
Detail screen of the Module for EDI home page. For
more information about accessing and using this screen,

webMethods Module for EDI Installation and User’s Guide Version 9.12 278
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

see "Defining Interchange-Level Sender/Receiver Pair

Information" on page 376.

Defining Actions Module for EDI Takes Based on FA Status

Based on the splitOption EDITPA variable, Module for EDI can be working with an
Interchange document, a Group document, or a Transaction document. For more
information, see "splitOption Variable" on page 71.
For ANSI X12, the Group documents and Transaction documents each have an FA
status associated with them.
For a UN/EDIFACT document, the Interchange, Group, and Transaction documents
each have an FA status associated with them.
For more information about how each type of document is assigned an FA status, see
"Determining How Module for EDI Reports FA Status" on page 277.
You set how you want Module for EDI to process a document based on its FA status. The
module can:
Process documents normally when they have FA statuses that you define as
acceptable. For more information, see "Processing Documents with Acceptable FA
Statuses" on page 279. For information about designating acceptable FA statuses,
see "Defining FA Statuses as Acceptable and Unacceptable" on page 277.
Handle documents differently when they have FA statuses that you define as
unacceptable. For more information, see "Processing Documents with Unacceptable
FA Statuses" on page 280. For information about designating unacceptable FA
statuses, see "Defining FA Statuses as Acceptable and Unacceptable" on page 277.

Processing Documents with Acceptable FA Statuses

To process documents with acceptable FA statuses, Module for EDI performs the
following steps:

Step Description

1 Sets the EDI Status custom aribute for the Interchange, Group, or
Transaction document to Processed.

2 Splits the document, if appropriate:

For an Interchange document
If the splitOption is Group or Transaction and the UN/
EDIFACT document contains groups, Module for EDI creates
Group documents and processes the Group documents.
If the splitOption is Group or Transaction and the UN/
EDIFACT document does not contain groups, Module for EDI

webMethods Module for EDI Installation and User’s Guide Version 9.12 279
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Step Description
creates Transaction documents and processes the Transaction
documents.
For a Group document
If the splitOption is Transaction, Module for EDI creates
the Transaction documents and processes the Transaction
documents.

3 Sends the Interchange, Group, or Transaction document to

Trading Networks processing rules.

Processing Documents with Unacceptable FA Statuses

To process documents with unacceptable FA statuses, Module for EDI performs the
following steps:

Step Description

1 Sets the EDI Status custom aribute for the Interchange, Group, or
Transaction document based on the documents FA status. When
the FA status is:
Not Allowed, the module sets the EDI Status custom aribute to
Generate FA - Not Allowed
Rejected, the module sets the EDI Status custom aribute to
Generate FA - Rejected
Partially Accepted, the module sets the EDI Status custom
aribute to Generate FA - Partially Accepted
Accepted, But Errors Were Noted, the module sets the EDI Status
custom aribute to Generate FA - Accepted, But Errors Were
Noted

2 For Interchange and Group documents, saves the document to

the Trading Networks database regardless of the seing of the
Trading Networks Save Document to Database preprocessing
option.
For Transaction documents, does not do an automatic save.
The document is saved to the Trading Networks database only
if instructed to do so by the seing of the Save Document to
Database preprocessing option.

webMethods Module for EDI Installation and User’s Guide Version 9.12 280
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Step Description

3 Does not split an Interchange or Group document regardless of

the seing of the EDITPA splitOption variable.
For an Interchange document, if the splitOption is Group or
Transaction, the module does not create Group or Transaction
documents.
For a Group document, if the splitOption is Transaction, the
module does not create Transaction document.

4 Sends the Interchange, Group, or Transaction document that

has the unacceptable FA status to Trading Networks processing
rules. You should create a processing rule to handle these
documents. For more information, see "Defining Processing
Rules for Documents with Unacceptable FA Statuses" on page
282.

Defining a Processing Rule to Deliver FAs

Use the following procedure to create a processing rule to deliver the outbound FA that
Module for EDI generates.

To define a processing rule to deliver outbound FAs

1. In My webMethods: Administration > Integration > B2B > Processing Rules.
2. On the Processing Rules Details page, complete the information based on the
following table:

Processing Rule Tab Description

Criteria Use to select outbound FAs that Module for EDI generated,
based on the following criteria:
Receiver. If you want to perform different processing
based on the receiver, select specific receivers in the
Selected box. For information about the receiver set in the
BizDocEnvelope for an outbound FA, see "Output from
the generateFA Service" on page 183.
Document Type. The TN document type used for an
outbound FA will be one of the following:
For an ANSI X12: X12 Envelope
For a UN/EDIFACT: EDIFACT Envelope

webMethods Module for EDI Installation and User’s Guide Version 9.12 281
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Processing Rule Tab Description

In the Selected box, select the appropriate TN document

type.

Extended Criteria Use to select documents based on the value of custom

aributes. In this case, you select documents based on the
value of the EDI Outbound FA custom aribute, as shown
below.

Attribute Operator Value

EDI Outbound FA Equals true

Action Use to specify how to deliver the outbound FA. Use either
of the following processing rule actions:
Execute a Service. Invokes the service you created to
deliver the FA.
Deliver Document By. Batches the outbound FA or delivers
it to a VAN. For more information, see "Batching
EDI Documents" on page 311 and "Retrieving and
Delivering EDI Documents from and to VANs" on page
335.

For more information about defining processing rules, see the webMethods Trading
Networks Administrator’s Guide for your release.

Defining Processing Rules for Documents with Unacceptable FA

Statuses
Trading Networks provides the EDI Status custom aribute to indicate whether a
document has an unacceptable FA status. When defining processing rules for documents
with unacceptable FA statuses, use EDI Status in the criteria. For more information about
how the EDI Status custom aribute is set, see information about handling documents
with unacceptable FA statuses in "Defining Actions Module for EDI Takes Based on FA
Status" on page 279.
Use the information in the following table to assist you in defining a rule to process
documents with an FA status of unacceptable. For more information about defining
processing rules, see the webMethods Trading Networks Administrator’s Guide for your
release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 282
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Processing Rule Tab Description

Extended Criteria Use to select documents based on the value of custom

aributes. In this case, you select documents based on the
value of the EDI Status custom aribute. When a document
has an FA status of unacceptable, the EDI Status custom
aribute will be set to one of the following:
Generate FA - Not Allowed

Generate FA - Rejected

Generate FA - Partially Accepted

Generate FA - Accepted, But Errors Were Noted

The actual values available for the EDI Status custom aribute
are based on how you set up automatic FA generation,
specifically how you define acceptable and unacceptable FA
statuses. For more information, see "Defining FA Statuses as
Acceptable and Unacceptable" on page 277.
The following shows an example of how to set the extended
criteria to select the processing rule for documents that have
an unacceptable FA status of Rejected; that is, the value
of the EDI Status custom aribute is set to Generate FA -
Rejected. When specifying Value, be sure to use the exact
combination of uppercase and lowercase characters.

Attribute Operator Value

EDI Status Equals Generate FA -

Rejected

Important:
When you set up processing rules, you must set up
a different processing rule for each unacceptable
FA status. Do not list all possible values for the EDI
Status custom aribute on the Extended Criteria tab.
Trading Networks performs an AND operation for
all custom aribute criteria. As a result, a document
must exhibit all custom aribute criteria that you
specify for Trading Networks to select the processing
rule. If you define multiple rows for the EDI Status
custom aribute, Trading Networks will never use the
processing rule because a document will never have
the EDI Status custom aribute set to more than one
value.

webMethods Module for EDI Installation and User’s Guide Version 9.12 283
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Processing Rule Tab Description

Action Use to define the actions that you want to take to handle
EDI documents that have an FA status of unacceptable. For
example, you might select:
Alert e-mail to send an e-mail message to notify an
administrator of the problem.
Execute a Service to invoke a service that you create to
perform processing. You might choose to write your own
service to send an e-mail message or perform some other
type of notification.

Automatically Generating Interchange Acknowledgments

Module for EDI can optionally generate interchange acknowledgments (TA1s)
automatically when a payload is submied to Trading Networks.

To automatically generate interchange acknowledgments

1. Set the X12TA1Generation/autoGenerateTA1 EDITPA variable to On. The module
generates an envelope containing the TA1 segment.

Note: When both autoGenerateTA1 and autoGenerateFA are turned on, the
module creates two envelopes. The FA and the TA1 are not combined into
one envelope.

For more information about the X12TA1Generation/autoGenerateTA1 EDITPA

variable, see "FAGeneration Variables" on page 80.
2. Define a processing rule to deliver this envelope to the sender of the inbound
document.

Performing Optional Processing of Inbound EDI Documents

When Module for EDI receives an EDI document, it performs the following steps:

Step Description

1 The module parses an interchange from the EDI document.

2 The module determines whether it is to validate control numbers. If the

control numbers are:
Not to be validated, the module continues with step 3.

webMethods Module for EDI Installation and User’s Guide Version 9.12 284
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Step Description

To be validated, the module validates them. If the interchange control

number is:
Invalid, the module sets the EDI Status custom aribute for the
Interchange document based on the type of invalid control number
(duplicate or out-of-sequence) and the process stops at this step.
Valid, the process continues with the next step.
For more information about validating control numbers, see "Validating
Inbound Control Numbers" on page 258.

3 Module for EDI determines whether it is to automatically generate FAs for

the sender/receiver pair. If automatic FA Generation is:
Off, the process stops at this step.
On, the process continues with the next step.

4 For an ANSI X12 document, the module generates the FAs for the groups
in the interchange.
For a UN/EDIFACT document, the module generates the FAs for the
interchange.

Note: The FAs are not sent to Trading Networks processing rules at this
time.

In addition to generating the FAs during this step, Module for EDI also
obtains information about:
Whether any child element is not allowed in its envelope
Syntax errors for the interchange, groups, and transactions
Logical errors for the interchange, groups, and transactions
Because Module for EDI has information about the syntax errors and logical
errors for transactions, it can also determine the child rejection error status
for groups and interchanges.

5 Module for EDI determines whether it is to automatically generate TA1s for

the sender/receiver pair. If automatic TA1 generation is:
Off, the process stops at this step.
On, the process continues with the next step.

6 For an ANSI X12 document, the module generates the TA1s for the
interchange.

webMethods Module for EDI Installation and User’s Guide Version 9.12 285
 M
Even Header
Optional Inbound Processing When Using Trading Networks

Step Description

Note: The TA1s are not sent to Trading Networks processing rules at this
time.

7 For ANSI X12 documents, if the interchange contains groups, Module for
EDI works with each Group document that was split from the interchange,
as follows:
1. The module determines the FA status of each group and then uses this
information to determine how to handle the Group document. For more
information, see "Determining How Module for EDI Reports FA Status" on
page 277.
If the group FA status is acceptable, the module processes the Group
document normally.
If the group FA status is unacceptable, the module handles the Group
document differently.
For more information, see "Defining Actions Module for EDI Takes Based
on FA Status" on page 279.
2. If the Group document is being processed normally, that is, it has an
acceptable FA status, and the splitOption EDITPA variable is defined as
Transaction, Module for EDI works with each Transaction document that
was split from the group, as follows:
a. The module determines the FA status of the transaction and then
uses this information to determine how to handle the Transaction
document. For more information, see "Defining Actions Module for
EDI Takes Based on FA Status" on page 279.
If the transaction FA status is acceptable, the module processes the
Transaction document normally.
If the transaction FA status is unacceptable, the module handles the
Transaction document differently.
For more information, see "Defining Actions Module for EDI Takes
Based on FA Status" on page 279.
3. Module for EDI sends all Transaction and Group documents that are
processed normally to Trading Networks processing rules.

8 For a UN/EDIFACT document, if the splitOption is Transaction, Module

for EDI works with each Transaction document that was split from the
interchange (that is, transactions that are not within group envelopes).
1. Module for EDI determines the FA status of the Transaction and then uses
this information to determine how to handle the Transaction document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 286
 M
Odd Header
Optional Inbound Processing When Using Trading Networks

Step Description

If the FA status of the transaction is acceptable, the module processes

the Transaction document normally.
If the FA status of the transaction is unacceptable, the module handles
the Transaction document differently.
For more information, see "Defining FA Statuses as Acceptable and
Unacceptable" on page 277 and "Defining Actions Module for EDI
Takes Based on FA Status" on page 279.
2. If the Transaction document is processed normally, the module sends it to
Trading Networks processing rules.

9 Module for EDI sends the generated FAs to Trading Networks processing
rules.
When the FAs are processed through Trading Networks, the EDI recognizer
updates the EDITRACKING table for the FAs. Module for EDI uses the
EDITRACKING table to track FAs and related groups/transactions for
FA reconciliation. For more information about FA reconciliation, see
"Reconciling Functional Acknowledgments" on page 341.

10 Module for EDI sends the Interchange document to Trading Networks

processing rules.

webMethods Module for EDI Installation and User’s Guide Version 9.12 287
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 288
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

14   Forming EDI Documents to Send Outbound When

Using Trading Networks

■ Overview ..................................................................................................................................... 290

■ Preparing Trading Networks to Process Internal-Format Documents ........................................ 290
■ Creating the Service to Form the EDI Document ...................................................................... 291
■ Delivering the Outbound EDI Document ................................................................................... 297

webMethods Module for EDI Installation and User’s Guide Version 9.12 289
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Overview
You can send documents to webMethods Trading Networks (Trading Networks) from
internal applications (for example, back-end systems) and map information from
them into a standard EDI format document. When you use Trading Networks with
webMethods Module for EDI (Module for EDI), when forming the EDI documents, you
can access information for delimiters and headers that Module for EDI maintains in the
Trading Networks database.
This chapter describes how to:
Prepare Trading Networks to process internal-format documents. For more
information, see "Preparing Trading Networks to Process Internal-Format
Documents" on page 290.
Create a service to form the EDI document from an internal-format document. For
more information, see "Creating the Service to Form the EDI Document" on page
291.
Deliver the outbound EDI document. For more information, see "Delivering the
Outbound EDI Document" on page 297.
To learn more about forming outbound EDI documents when you are using Trading
Networks with Module for EDI, see webMethods Module for EDI Concepts Guide.

Preparing Trading Networks to Process Internal-Format

Documents
To prepare Trading Networks to receive an internal-format document and use
information in it to form an EDI document, define the following in Trading Networks:
Profiles for the sender and receiver of the internal-format document. For information about
defining profiles, see the webMethods Trading Networks Administrator’s Guide for your
release.
TN document type for the internal-format document. For information about defining TN
document types, see the webMethods Trading Networks Administrator’s Guide for your
release.
Processing rule for the internal-format document. For information about defining
processing rules, see the webMethods Trading Networks Administrator’s Guide for your
release. When you define the processing rule, use the Execute a Service processing
action to invoke the service you created to form the EDI document. For more
information about how to create the service to form the EDI document, see "Creating
the Service to Form the EDI Document" on page 291.
After forming the EDI document, you can deliver it. For more information, see
"Delivering the Outbound EDI Document" on page 297.

webMethods Module for EDI Installation and User’s Guide Version 9.12 290
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Creating the Service to Form the EDI Document

You can send documents to Trading Networks from internal applications (for example,
back-end systems) and create a service that maps information from the internal-format
documents into an EDI document. Module for EDI provides built-in services that you
can use to form the EDI document.
Additionally, because you are using Trading Networks, you can have the module
maintain the following information that you can access and use when forming EDI
documents:

Information Where the information is

stored

Delimiters to use for the outbound EDI document EDITPA

The following information that you use for the EDITPA

interchange header:
Authorization information qualifier
Authorization information
Security information qualifier
Security information

Control numbers to use in group and interchange EDIControlNumber table

headers (or batch, transmission, and file headers)

Note: For ANSI X12 and UN/EDIFACT users: When using

non-standard processing, you obtain the delimiters,
Authorization information and qualifier, and Security
information and qualifier from the interchange sender/
receiver pair information that you define using the Module
for EDI home page. For more information about defining
this information, see "Defining Interchange-Level Sender/
Receiver Pair Information" on page 376. For more
information about the difference between standard and non-
standard processing, see webMethods Module for EDI Concepts
Guide.

webMethods Module for EDI Installation and User’s Guide Version 9.12 291
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Before Creating the Service to Form an EDI Document

Before you create a service to form an EDI document from an internal-format document,
be sure you have the following:
The flat file schema that defines the structure of the EDI document that you are
forming. If you installed the TN document type for this EDI document, the Module
for EDI installed the flat file schema as well. If you did not install the TN document
type for this EDI document, see "Defining TN EDI Document Types" on page 37.
Optionally, the flat file schema that defines the structure of the internal-
format document. This is needed if your client passes the internal-format
document to your service in String format or as an InputStream. Your service
uses the flat file schema as input to the wm.b2b.edi:convertToValues service (or the
wm.b2b.edi.tradacoms:convertToValues service) to convert the internal-format document
to an IData object and optionally validate the document's structure. If your service
receives the document as an IData object, a flat file schema is not needed. Use
Software AG Designer to create the flat file schema. For more information, see the
Flat File Schema Developer’s Guide.
Optionally, an IS document type for the structure of the internal-format document.
This is needed if 1) your client passes the internal-format document to your service
as an IData object, and 2) you want to validate the internal-format document before
forming the EDI document. Your service uses the IS document type as input to the
pub.schema:validate service, which performs the structure validation. For information
about creating IS document types, see the webMethods Service Development Help for
your release.
Trading partner profiles of the internal-format document. For information about
creating profiles, see the webMethods Trading Networks Administrator’s Guide for your
release.
Trading partner profiles for sender and receiver of the outbound EDI document. For
information about creating profiles for senders and receivers of EDI documents, see
"Defining Trading Partner Profiles" on page 59.
Default and, optionally, partner-specific EDITPAs for the sender/receiver pairs in the
outbound EDI document. For information about creating EDITPAs, see "Defining
EDI Trading Partner Agreements" on page 61.

Note: For ANSI X12 and UN/EDIFACT users: When using non-
standard processing, you also have to define: 1) Interchange
sender/receiver pair information and 2) Group-level
sender/receiver pair associations. For more information,
see "Defining Interchange-Level Sender/Receiver Pair
Information" on page 376 and "Defining Group-Level
Sender/Receiver Pair Associations" on page 388. For more
information about the difference between standard and non-

webMethods Module for EDI Installation and User’s Guide Version 9.12 292
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

standard processing, see webMethods Module for EDI Concepts

Guide.

Creating the Service

Note: For ANSI X12 and UN/EDIFACT users: This section

describes how to create a service to form an outbound EDI
document when you are using standard processing. If you
are using non-standard processing, see "Creating the Service
When Using Non-Standard Processing" on page 397.

The following sample code illustrates how to form an ANSI X12 EDI document from an
internal-format document when using Trading Networks with Module for EDI.

Flow Description
operation

1 Invoke the wm.b2b.edi:convertToValues service (or the

wm.b2b.edi.tradacoms:convertToValues service for TRADACOMS
documents) to convert the incoming internal-format document that
is either a String or InputStream into an IData object. If you want,
you can set the input parameters of the convertToValues service to
have it validate the structure of the internal-format document.
The inputs to the convertToValues service include the internal-format
document and the flat file schema that defines the structure for
the internal-format document. For backward compatibility, you
can use an IS document type to define the structure of an internal-
format document rather than a flat file schema; however, it is
recommended that you use flat file schemas. For more information
about the convertToValues service, see webMethods Module for EDI
Built-In Services Reference.

Note: If the internal-format document is passed to your service

as an IData object, you can still validate its structure before

webMethods Module for EDI Installation and User’s Guide Version 9.12 293
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Flow Description
operation
forming the EDI document. See "Validating the Input
Internal-Format Document When It Is an IData Object" on
page 406.

2 Map data from the internal-format document IData object into the
EDI document IData object. Depending on the complexity of your
mapping requirements, you might need to add more logic than
a MAP flow operation or create a separate service to perform the
mapping.

3 Invoke the wm.b2b.editn.TPA:getEDITPAData service to obtain the

EDITPA data that contains delimiters and header information you
can use for the outbound EDI document. For more information
about the getEDITPAData service, see webMethods Module for EDI Built-
In Services Reference.

4 Invoke the wm.b2b.edi:convertToString service (or the

wm.b2b.edi.tradacoms:convertToString service for TRADACOMS) to
convert the EDI document from an IData object to String format.
The inputs to the convertToString service include:
The IData object that contains the data for your EDI document.
Map this IData object to the values input parameter of the
convertToString service.
The flat file schema for the EDI document. The convertToString
service uses the flat file schema to determine how to form the EDI
document.
For backward compatibility, you can use an IS document type as
input to the convertToString service rather than a flat file schema for
files with delimited fields and records.
The delimiters to use when creating the EDI document. Map the
delimiters from the EDITPA to the inputs of the convertToString
service:

webMethods Module for EDI Installation and User’s Guide Version 9.12 294
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Flow Description
operation

5 Optionally, invoke the convertToValues service against the EDI

document to validate the structure of your final EDI document.
The inputs to the convertToValues service include:
The EDI document. The string output parameter from the
convertToString service contains the EDI document. Map this to the
edidata input parameter of the convertToValues service.
The flat file schema that defines the structure for the EDI
document.

6 Invoke the wm.b2b.edi.util:addICEnvelope service to add the interchange

and group envelope to the EDI document. If you are creating a UN/
EDIFACT EDI document, use the wm.b2b.edi.util:addICEnvelopeEDIFACT
service. For more information, see "Adding UN/EDIFACT
Envelopes" on page 407.

Note: If you are creating a TRADACOMS EDI document, use the

services in the wm.b2b.edi.tradacoms.compose folder to add a
transmission envelope and a batch envelope (if specified) and
to obtain control numbers. For more information, see "Adding
TRADACOMS Envelopes and Obtaining Control Numbers"
on page 297.

When seing the inputs to the addICEnvelope:

Map the delimiters from the EDITPA to the inputs of the
addICEnvelope service:

webMethods Module for EDI Installation and User’s Guide Version 9.12 295
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Flow Description
operation

Map the information from the EDITPA to the inputs of the

addICEnvelope service:

Set the ctlFromTable parameter to true to have the service obtain

the control number. For more information, see "Obtaining
Control Numbers for Outbound Processing (ANSI X12 and UN/
EDIFACT)" on page 296.
For information about delivering the document, see "Delivering the
Outbound EDI Document" on page 297.

Obtaining Control Numbers for Outbound Processing (ANSI X12 and UN/
EDIFACT)
Module for EDI maintains information about control numbers in the
EDIControlNumber table, which is a Module for EDI-specific table in the Trading
Networks database.
For ANSI X12 and UN/EDIFACT documents, when you create services to form
outbound EDI documents, you can invoke the following services that are provided with
Module for EDI to add group and interchange headers to the outbound EDI document:

ANSI X12 UN/EDIFACT

wm.b2b.edi.util:addGroupEnvelope wm.b2b.edi.util:addGroupEnvelopeEDIFACT

wm.b2b.edi.util:addICEnvelope wm.b2b.edi.util:addICEnvelopeEDIFACT

webMethods Module for EDI Installation and User’s Guide Version 9.12 296
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

When invoking one of the above services to add a header, use the ctlFromTable or
grpCtlNumber input parameter to indicate whether you want to use the control
numbers from the EDIControlNumber table for group and interchange headers. If the
EDIControlNumber table does not have an entry for the group or interchange sender/
receiver pair, a row is added to the table for the sender/receiver pair and the control
number is set to 1.
You can set the initial values you want to use for sender/receiver pairs using the Module
for EDI home page. For instructions, see "Configuring Control Number Seings" on page
126.

Adding TRADACOMS Envelopes and Obtaining Control Numbers

The WmEDI package provides the following built-in services you can use to add
TRADACOMS transmission and batch envelopes:
wm.b2b.edi.tradacoms.compose:startTradacomsTransmission
Invoke this service to create an STX segment for a transmission. This service returns
a tradacomsTransmission object.
wm.b2b.edi.tradacoms.compose:addToTradacomsTransmission
1. Invoke this service to add the header message to the TRADACOMS transmission
object that the startTradacomsTransmission service returned.
2. Invoke the addToTradacomsTransmission service a second time to add the detail
messages to the TRADACOMS transmission object.
3. Invoke the addToTradacomsTransmission service a third time to add the trailer
message to the TRADACOMS transmission object.
wm.b2b.edi.tradacoms.compose:endTradacomsTransmission
Invoke this service to create an END segment for the transmission.
wm.b2b.edi.tradacoms.compose:startTradacomsBatch
Invoke this service to create a batch (BAT) segment for the transmission.
wm.b2b.editn.batch:getControlNumber (provided in the WmEDIforTN package)
Invoke this service to obtain the current control number from the
EDIControlNumber table. This table is a Module for EDI-specific table in the Trading
Networks database.
For more information about these services, see webMethods Module for EDI Built-In
Services Reference.

Delivering the Outbound EDI Document

This section describes three methods you can use to deliver the outbound EDI
document:

webMethods Module for EDI Installation and User’s Guide Version 9.12 297
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Add logic to the service that forms the EDI document to deliver it. For more
information, see "Delivering the EDI Document Directly from the Service that Forms
It" on page 298.
Submit the EDI document back to Trading Networks document recognition to have
the EDI recognizer within Trading Networks recognize the EDI document, and
then use a processing rule to deliver the EDI document. For more information, see
"Submiing the EDI Document to Trading Networks " on page 298.
Route the EDI document back to Trading Networks processing rules to use a
processing rule to deliver the document. For more information, see "Routing the
Outbound EDI Document to Trading Networks " on page 304.
To learn more about these three methods for delivering outbound EDI documents, see
webMethods Module for EDI Concepts Guide.

Delivering the EDI Document Directly from the Service that Forms It
In the service that you create to form the EDI document, you can add your own logic to
deliver the outbound EDI document.
When you deliver an EDI document directly from the service that forms the document
and you want to use the functional acknowledgment (FA) reconciliation feature of
Module for EDI, you must also invoke the wm.b2b.editn:trackEDIdocs service.

Note: Functional acknowledgments (FAs) are not applicable to the TRADACOMS

and VDA standards.

This service updates the EDITRACKING table that keeps track of Group documents
and their corresponding FAs. To use the FA reconciliation feature, you must enable FA
reconciliation on a per-partner-pair basis in the EDITPA. For more information about the
FAReconciliation EDITPA Variable, see "FAReconciliation Variable" on page 72. For more
information about how to generate FA reconciliation reports, see "Reconciling Functional
Acknowledgments" on page 341.
The following code sample shows a portion of the service to form EDI documents that
is described in "Creating the Service to Form the EDI Document" on page 291, with
additional flow operations added to invoke:
The wm.b2b.editn:trackEDIdocs service for FA reconciliation
A service that you create to deliver the EDI document

Submitting the EDI Document to Trading Networks

To submit the outbound EDI document back to Trading Networks, the document goes
back through Trading Networks document recognition. This means that the Module for

webMethods Module for EDI Installation and User’s Guide Version 9.12 298
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

EDI-specific recognizer, the EDI recognizer, receives control to perform processing on

the EDI document.
You define a processing rule to indicate how to deliver the outbound EDI document.

Specifying Variables that Affect Outbound Processing

Because the EDI document goes through document recognition, the EDITPA variables
that affect inbound processing also affect the outbound EDI document. For more
information, see "Specifying EDITPA Variables that Affect Inbound Processing" on page
210.
Note that the EDI recognizer will automatically perform FA reconciliation if enabled
by the FAReconciliation EDITPA variable. For more information, see "FAReconciliation
Variable" on page 72. For more information about how to generate FA reconciliation
reports, see "Reconciling Functional Acknowledgments" on page 341.
The following table lists the EDITPA variables that you should set differently when
they are used for outbound EDI documents. If you are using TRADACOMS, follow
the instructions in "Specifying Variables that Affect Outbound Processing When Using
TRADACOMS" on page 300.

EDITPA variable Description

splitOption The EDI recognizer will split the EDI document based on the
value of the splitOption EDITPA variable. For an outbound
document, set the splitOption variable to one of the following:
Interchange—The EDI document is delivered and FA
reconciliation is not performed.
Group—The EDI document is delivered and FA
reconciliation is performed.

Note: When the splitOption variable is set to Interchange but

the FAReconciliation variable is set to true to enable FA
reconciliation, the EDI recognizer will split at the group
level.

For more information about this EDITPA variable, see

"splitOption Variable" on page 71.

ControlNumberManagement/
For an outbound document, set this EDITPA variable to
validateInboundEnvelopeControlNumbers
false so Module for EDI does not aempt to validate the
interchange control numbers in the outbound document.
For more information about this EDITPA variable, see
"ControlNumberManagement Variables" on page 88.

When you are using non-standard processing, Module for

EDI does not use this EDITPA variable. Instead, it uses the

webMethods Module for EDI Installation and User’s Guide Version 9.12 299
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

EDITPA variable Description

Validate inbound envelope control numbers seing that you
set from the Interchange Information Detail screen of the
Module for EDI home page.
For more information about this screen, see "Defining
Interchange-Level Sender/Receiver Pair Information" on page
376.

ControlNumberManagement/
For an outbound document, set this EDITPA variable to false
validateInboundGroupControlNumbers
so Module for EDI does not aempt to validate the group
control numbers in the outbound document.
For more information about this EDITPA variable, see
"ControlNumberManagement Variables" on page 88.

FAGeneration/ For an outbound document, set this EDITPA variable to Off

autoGenerateFA so Module for EDI does not automatically generate FAs for
your outbound document.

Specifying Variables that Affect Outbound Processing When Using

TRADACOMS
Because the EDI document goes through document recognition, the EDITPA variables
that affect inbound processing also affect the outbound EDI document. For more
information, see "Specifying EDITPA Variables that Affect Inbound Processing When
Using TRADACOMS" on page 240.
You should set the following EDITPA variables for outbound EDI documents:
TRADACOMS/splitOption
TRADACOMS/OutBound/createReconciliationMessage
TRADACOMS/OutBound/recipientTransmissionReference
TRADACOMS/OutBound/applicationReference
TRADACOMS/OutBound/applicationReferenceFromFile
For more information about these variables, see "Defining Trading Partner Information
When Using TRADACOMS" on page 105.

Preparing Trading Networks to Deliver the EDI Document

The Trading Networks objects that you need to create vary based on whether you set the
splitOption variable to Interchange (or Transmission) or Group (or Batch).
If the splitOption variable is Interchange (or Transmission), define the following in
Trading Networks:

webMethods Module for EDI Installation and User’s Guide Version 9.12 300
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Profiles for the senders and receivers in the outbound EDI document.
For instructions when using standards other than TRADACOMS, see
"Defining Trading Partner Profiles" on page 59
For instructions when using TRADACOMS, see "Defining Trading Partner
Profiles When Using TRADACOMS" on page 107
TN document type for the Interchange (or Transmission) document that the
EDI recognizer creates from the outbound EDI document. For instructions
about how to define TN document types, see the webMethods Trading Networks
Administrator’s Guide for your release.
Processing rule for the Interchange (or Transmission) document. For instructions
about how to define processing rules, see the webMethods Trading Networks
Administrator’s Guide for your release. When you define the processing rule, use
one of the following:
Execute a Service processing action to invoke the service you created to deliver
the EDI document.
Deliver Document By processing action to batch the outbound EDI document
or deliver it to a VAN. For more information, see "Batching EDI Documents"
on page 311, and "Retrieving and Delivering EDI Documents from and to
VANs" on page 335.
If the splitOption variable is Group (or Batch), define the following in Trading
Networks:
Profiles for the senders and receivers in the outbound EDI document.
For instructions when using standards other than TRADACOMS, see
"Defining Trading Partner Profiles" on page 59
For instructions when using TRADACOMS, see "Defining Trading Partner
Profiles When Using TRADACOMS" on page 107
TN document type for the Interchange and Group (or Transmission and Batch)
documents that the EDI recognizer creates from the outbound EDI document.
For instructions about defining TN document types, see the webMethods Trading
Networks Administrator’s Guide for your release.
Processing rule for the Interchange and Group (or Transmission and Batch)
documents. For instructions about defining processing rules, see the webMethods
Trading Networks Administrator’s Guide for your release. When you define
the processing rule for the Interchange (or Batch) document, use one of the
following:
Execute a Service processing action to invoke the service you created to deliver
the EDI document.
Deliver Document By processing action to batch the outbound EDI document
or deliver it to a VAN. For more information, see "Batching EDI Documents"

webMethods Module for EDI Installation and User’s Guide Version 9.12 301
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

on page 311, and "Retrieving and Delivering EDI Documents from and to
VANs" on page 335.

Adding Logic to the Service that Forms the EDI Document to Submit to Trading
Networks
To submit a document to Trading Networks document recognition, in the service that
you created to form the EDI document, invoke the wm.tn.doc.xml:routeXml service.
The following code sample shows a portion of the service to form EDI documents that is
described in "Creating the Service to Form the EDI Document" on page 291, with an
additional INVOKE flow operation added to invoke the wm.tn.doc.xml:routeXml service.

Preparing the Pipeline to Invoke the wm.tn.doc.xml:routeXML Service

When you invoke the wm.tn.doc.xml:routeXml service, you should have the document in
the edidata parameter in Pipeline In. Previous operations in this service placed data in
an edidata parameter. The following describes how to map an ANSI X12 document
to deliver into the edidata parameter without losing the value of the current edidata
parameter.

Step Description

1 Select the INVOKE wm.b2b.edi.util:addICEnvelope flow operation.

2 In Pipeline Out, create a document. (In the figure below, the new document
is named DocToDeliver.) Within the document, create a string named
edidata . Then map the output from the addICEnvelope service, which is in
the outDocument parameter, to your new edidata parameter, as shown:

webMethods Module for EDI Installation and User’s Guide Version 9.12 302
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Step Description

3 Click the INVOKE wm.tn.doc.xml:routeXml flow operation and view

its properties. In the Properties panel, set the Scope property to the
name of the document that you created to hold the output from the
addICEnvelope service (for example, DocToDeliver). This causes the INVOKE
wm.tn.doc.xml:routeXml flow operation to execute using only the pipeline
variables within the specified scope document.

4 After seing the scope, when you select the INVOKE wm.tn.doc.xml:routeXml
flow operation, Pipeline In contains only the edidata parameter, as
illustrated in the figure below.

webMethods Module for EDI Installation and User’s Guide Version 9.12 303
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Step Description

5 When you use scope, the output from the wm.tn.doc.xml:routeXml service
also goes into the document that you used for the scope (for example,
DocToDeliver). After invoking the wm.tn.doc.xml:routeXml service, you can
drop all parameters in the document that you created, as shown:

Routing the Outbound EDI Document to Trading Networks

To route the EDI document through Trading Networks, the document goes back to
Trading Networks processing rules, bypassing document recognition. Because the
result of document recognition is a BizDocEnvelope that is sent to the processing
rules and you are bypassing this step, you must form the BizDocEnvelope that you
send to the processing rule. You send the BizDocEnvelope to the processing rules by
invoking the wm.tn.route:routeBizdoc service. For more information about how to form the

webMethods Module for EDI Installation and User’s Guide Version 9.12 304
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

BizDocEnvelope, see "Creating a BizDocEnvelope for the Outbound EDI Document" on

page 305.
Additionally, when you route a document through Trading Networks, if you want to
use the functional acknowledgment (FA) reconciliation feature of Module for EDI, you
must invoke the wm.b2b.editn:trackEDIdocs service. This service updates the EDITRACKING
table that keeps track of Group documents and their corresponding FAs. To use the FA
reconciliation feature, you must enable FA reconciliation on a per-partner-pair basis in
the EDITPA. For more information, see "FAReconciliation Variable" on page 72. For more
information about how to generate FA reconciliation reports, see "Reconciling Functional
Acknowledgments" on page 341.

Adding Logic to the Service that Forms the EDI Document that Routes through
Trading Networks
To route a document through Trading Networks, in the service that you created to form
the EDI document, invoke the wm.tn.route:routeBizdoc service.
The following code sample shows a portion of the service to form EDI documents that
is described in "Creating the Service to Form the EDI Document" on page 291, with
additional flow operations added to invoke:
The wm.b2b.editn:trackEDIdocs service to do FA reconciliation.
A service that you define to create a BizDocEnvelope for the outbound EDI
document (the sample invokes the createEDIBizDoc service). For more information
about how to create this service, see "Creating a BizDocEnvelope for the Outbound
EDI Document" on page 305.
The wm.tn.route:routeBizdoc service to send the BizDocEnvelope to the Trading
Networks processing rules.

Creating a BizDocEnvelope for the Outbound EDI Document

This section describes how to create the createEDIBizDoc service that is used in the code
sample in "Adding Logic to the Service that Forms the EDI Document that Routes
through Trading Networks " on page 305.
The service creates a BizDocEnvelope and adds the outbound EDI document to the
BizDocEnvelope as a content part.
The following table lists the input parameters for the createEDIBizDoc service:

webMethods Module for EDI Installation and User’s Guide Version 9.12 305
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Input Parameter Description

OutboundEDIDoc The outbound EDI document in string format.

sender The sender ID for the sender of the outbound EDI document.
This is the sender at the interchange or transmission level.

senderQualifier The EDI ID qualifier for the sender, for example, 01 if you
specify a D-U-N-S number for sender .

receiver The receiver ID for the receiver of the outbound EDI

document. This is the receiver at the interchange or
transmission level.

receiverQualifier The EDI ID qualifier for the receiver, for example, 01 if you
specify a D-U-N-S number for receiver .

standard The EDI standard of the outbound EDI document; standard

should be one of the following:
X12 for an ANSI X12 document

UNEDIFACT for a UN/EDIFACT document

VDA for a VDA document

TRADACOMS for a TRADACOMS document

controlNumber The interchange or transmission control number to use for

the Trading Networks DocumentID and GroupID system
aributes.

encoding Optional. The name of a registered IANA character set

(for example, ISO-8859-1) that is used as input to the
pub.string:stringToBytes service and then used to convert the EDI
document into byte[] format. To use the default encoding,
set this value to autoDetect. If you specify an unsupported
encoding, an exception will be thrown.

The following table shows the output parameter for the createEDIBizDoc service:

webMethods Module for EDI Installation and User’s Guide Version 9.12 306
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Output Parameter Description

bizdoc The BizDocEnvelope for the outbound EDI document.

This is a Document Reference to the IS document type,
wm.tn.rec:BizDocEnvelope.

The following figure illustrates the flow operations used for the service that creates a
BizDocEnvelope for the outbound EDI document.

Flow operation Description

1 Invoke the pub.string:stringToBytes service to convert the outbound

EDI document from string format to a byte[]. Map the input
parameters of the createBizDoc service, OutboundEDIDoc and
encoding, to the input parameters of the stringToBytes service, string
and encoding , respectively.
Map the output of the stringToBytes service (bytes).
Convert the format to a byte[] because the service to add the
content part to the BizDocEnvelope requires the content part to be
in byte[] format.

2 Invoke the wm.b2b.editn:ediPartnerIDToTNPartnerID service to retrieve

the Trading Networks internal ID for the sender. Map the input
parameters of the createBizDoc service, sender and senderQualifier,
to the input parameters of the ediPartnerIDToTNPartnerID service,
identifier and qualifier , respectively.
Map the output of the ediPartnerIDToTNPartnerID service (id ), to
senderID , which is a parameter that you define in Pipeline Out.

webMethods Module for EDI Installation and User’s Guide Version 9.12 307
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Flow operation Description

3 Use a BRANCH operation to branch based on whether the

senderID is null. If senderID is null, use a MAP flow operation
to set the value of senderID to 000000000000000000000000 (24
zeros), which indicates the Unknown partner.

4 Invoke the wm.b2b.editn:ediPartnerIDToTNPartnerID service to retrieve

the Trading Networks internal ID for the receiver. Map the input
parameters of the createBizDoc service, receiver and receiverQualifier ,
to the input parameters of the ediPartnerIDToTNPartnerID service,
identifier and qualifier , respectively.
Map the output of the ediPartnerIDToTNPartnerID service, id, to
receiverID , which is a parameter that you define in Pipeline Out.

5 Use a BRANCH operation to branch based on whether the

receiverID is null. If receiverID is null, use a MAP flow operation
to set the value of receiverID to 000000000000000000000000 (24
zeros), which indicates the Unknown partner.

6 Invoke the wm.tn.doctype:view service to determine the Trading

Networks internal ID for the TN document type to use for the
outbound EDI document. Specify the name of the TN document
type as input, and you can retrieve the internal ID from the output.
The name of the TN document type will be either 1) X12 Envelope,
2) UNEDIFACT Envelope, or 3) TRADACOMS Transmission. For example,
to set this value at run time, set the value of the typeName input
parameter for the view service as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 308
 M
Odd Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Flow operation Description

The variable substitution %standard% picks up the value of the

standard input parameter of the createBizDoc service, which should
be X12, UNEDIFACT, or TRADACOMS.

7 Invoke the wm.tn.doc:createNewEnvelope service to create the

BizDocEnvelope for the outbound EDI document. To set the
inputs to the createNewEnvelope service, map:
The Trading Networks internal IDs for the sender and receiver,
which are in Pipeline In in the senderID and receiverID parameters,
to the Service In variables, senderID and receiverID , respectively.
The controlNumber input parameter of the createBizDoc service,
which is in Pipeline In, to the Service In variables, documentID and
groupID .
The Trading Networks internal ID for the TN document type,
which is in Pipeline In in the type/TypeID variable to the Service
IntypeID parameter.

webMethods Module for EDI Installation and User’s Guide Version 9.12 309
 M
Even Header
Forming EDI Documents to Send Outbound When Using Trading Networks

Flow operation Description

8 Invoke the wm.tn.doc:addContentPart service to add the outbound EDI

document (in byte[] format) to the BizDocEnvelope. To set the
inputs to the addContentPart service:
Map the content of the outbound EDI document that is in byte[]
format, which is in Pipeline In in the EDIcontent parameter to the
Service InpartBytes parameter.
Set the value of the Service InpartName parameter to EDIdata.
Set the value of the Service InstorageType parameter to database.

webMethods Module for EDI Installation and User’s Guide Version 9.12 310
 M
Odd Header
Batching EDI Documents

15   Batching EDI Documents

■ Overview ..................................................................................................................................... 312
■ Indicating How Many Batch EDI Documents to Create ............................................................. 312
■ How Documents Are Combined to Create the Batch EDI Document ........................................ 313
■ Extracting Transactions and Sorting the Batched Documents ................................................... 313
■ Recombining the Transactions into the Batch EDI Document ................................................... 321
■ Before You Can Batch EDI Documents ..................................................................................... 326
■ Controlling How the batchProcess Service Forms the Batch Document ................................... 327
■ Preparing to Batch EDI Documents ........................................................................................... 329
■ Delivering the Batch EDI Document .......................................................................................... 331
■ Viewing Batched EDI Documents .............................................................................................. 333

webMethods Module for EDI Installation and User’s Guide Version 9.12 311
 M
Even Header
Batching EDI Documents

Overview
Important:You cannot use the EDI batching feature if you are using non-
standard processing. For more information about processing
levels, see “Using Standard or Non-Standard Processing” in
webMethods Module for EDI Concepts Guide.

The EDI batching feature uses webMethods Trading Networks (Trading Networks)
scheduled delivery. That is, you set up a public scheduled delivery queue that will
receive the EDI documents that you want to batch into a batch EDI document. You
define processing rules that use the Deliver Document By processing action to place EDI
documents into the scheduled delivery queue.
When you define the scheduled delivery, you associate it with a service. To batch EDI
documents, you use the wm.b2b.editn.batch:batchProcess service, which is provided with
webMethods Module for EDI (Module for EDI). The batchProcess service acts on the EDI
documents in the scheduled delivery queue to create a batch EDI document.
Trading Networks uses large document handling for batching EDI documents. For more
information about large document handling, see "Handling Large Documents When
Using Trading Networks " on page 163.

Note: You cannot batch VDA documents.

To learn more about the basics of batching EDI documents, see the webMethods Module
for EDI Concepts Guide.

Indicating How Many Batch EDI Documents to Create

Use the batchProcess service oneBatchQueue input parameter to indicate how many
output batch EDI documents you want the batchProcess service to create. You can set the
oneBatchQueue parameter to one of the following:
SINGLEOUTPUT, which indicates that you want all the EDI documents in the
scheduled delivery queue to be combined into one batch EDI document that has
multiple interchanges or TRADACOMS transmissions.
MULTIPLEOUTPUTS, which indicates that you want the EDI documents in the queue
to be combined into multiple output batch EDI documents, where each batch EDI
document contains one interchange or TRADACOMS transmission.

Important: If you set oneBatchQueue to NONE, this signals that you want to use
backward compatibility and have the batchProcess service combine the
documents in the method available in version 6.0.1 of Module for EDI.

webMethods Module for EDI Installation and User’s Guide Version 9.12 312
 M
Odd Header
Batching EDI Documents

For more information, see the webMethods Trading Networks Built-In

Services Reference for your release.

How Documents Are Combined to Create the Batch EDI

Document
When you define a scheduled delivery queue for batching documents, you associate a
schedule with the queue. When the schedule indicates, Trading Networks invokes the
batchProcess service to act on all EDI documents in the queue to combine them into one or
more batch EDI documents.
To create the batch EDI document(s), the batchProcess service:
1. Extracts the transactions or messages (or TRADACOMS files) from the EDI
documents in the queue and sorts them. For more information, see "Extracting
Transactions and Sorting the Batched Documents" on page 313.
2. Recombines the transactions or messages (or TRADACOMS files) into the batch
EDI document(s). For more information, see "Recombining the Transactions into the
Batch EDI Document" on page 321.

Extracting Transactions and Sorting the Batched Documents

For each EDI document in the queue, the batchProcess service extracts the transactions
in the EDI document and sorts them. The following list describes how the batchProcess
service processes the EDI documents in the queue when the documents have
interchange headers or TRADACOMS transmission headers. For information about how
the batchProcess service sorts EDI documents in the queue that do not have interchange or
transmission headers, see "When EDI Documents Have No Interchange or Transmission
Header" on page 316.
For each transaction in an EDI document:
1. The batchProcess service extracts a transaction from the EDI document.
2. The batchProcess service uses the sender/receiver from the interchange or
transmission header of the EDI document to locate the EDITPA variables to use. For
more information about the EDITPA variables that the batchProcess service uses, see
"Controlling How the batchProcess Service Forms the Batch Document" on page
327.
3. The batchProcess service sorts the transactions. For more information, see "Sorting
Transactions in the Queued Documents" on page 314.
4. Each queued EDI document is associated with a Trading Networks delivery task.
After all transactions for an EDI document have been extracted, the batchProcess
service updates the task status. For more information, see "Updating the Task Status
and Publishing Documents for Failed Tasks" on page 320.

webMethods Module for EDI Installation and User’s Guide Version 9.12 313
 M
Even Header
Batching EDI Documents

Sorting Transactions in the Queued Documents

Module for EDI sorts the transactions in EDI documents in the batch queue. This section
describes how Module for EDI sorts the EDI documents when they have interchange
or transmission headers. For information about how Module for EDI sorts documents
when they do not have interchange or transmission headers, see "When EDI Documents
Have No Interchange or Transmission Header" on page 316.

Collection Areas Representing an Interchange in the Final Batch EDI

Document
You can think of sorting as if the batchProcess service was placing each transaction
from an EDI document into a collection area. Each collection area is associated with
the following items, which the batchProcess service obtains from the interchange or
transmission header of the document.
Each collection area has the same:
EDI standard and version
Interchange or transmission sender/receiver
Production mode (for example, Production or Testing)
Each collection area becomes an interchange or transmission segment in the final
batch EDI document.

Subcollections Representing a Group in the Final Batch EDI Document

Within a collection area are subcollections that are associated with the following items,
which the batchProcess service obtains from the group header (or TRADACOMS batch
header) of the document.
Each subcollection area has the same:
Group type (or TRADACOMS batch type)
Version of the EDI standard (for example, 4010)
Group sender/receiver (or TRADACOMS batch sender/receiver)
Each subcollection becomes a group segment (or TRADACOMS batch segment)
within the interchange (or TRADACOMS transmission) in the final batch EDI
document.

Note: The batchProcess service provides an input parameter, createGroup , which

enables you to add a group or a TRADACOMS batch.

The following figure illustrates an example of collection and subcollection areas used for
batching EDI documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 314
 M
Odd Header
Batching EDI Documents

Delimiters Associated with Collection Areas

Each collection area is also associated with a set of delimiters that all transactions in that
collection use.
The delimiters for the collection area are determined as follows:
1. The batchProcess service uses the value from its delimiters input parameter.
2. If you do not specify a value for the delimiters input parameter, the batchProcess
service uses the sender and receiver from the interchange or transmission header to
locate the EDITPA values and uses the EDITPA delimiters variables.
3. If there are no values for the EDITPA delimiters variables in the partner-specific and
default EDITPAs, the batchProcess service uses its own defaults.
For more information, see "Delimiters Used for the Batch EDI Document" on page
319.
Using the interchange or transmission header from the original EDI document, the
batchProcess service determines whether the transaction uses the same delimiters as
those associated with the collection area. If the transaction uses the same delimiters, the
batchProcess service places the document in the collection area. If the transaction uses
different delimiters, the batchProcess service replaces the delimiters in the transaction
with those used by the collection area before it places the transaction into the collection
area.

Example of Sorting Documents

The following diagram shows three EDI documents in a scheduled delivery queue.

webMethods Module for EDI Installation and User’s Guide Version 9.12 315
 M
Even Header
Batching EDI Documents

The following figure shows how the transactions from the above three documents are
sorted into collection areas.

When EDI Documents Have No Interchange or Transmission Header

You can place EDI documents that do not have interchange or TRADACOMS
transmission headers in the queue. As described in "How Documents Are Combined to
Create the Batch EDI Document" on page 313, the batchProcess service typically uses
information from the interchange or transmission headers when sorting the documents.
The following lists describes how the batchProcess service behaves when the interchange
or transmission headers are not available.
For each transaction in an EDI document that does not have an interchange or
transmission header:
1. The batchProcess service extracts a transaction from the EDI document.
2. The batchProcess service uses its senderIDQualifier , senderID , receiverIDQualifier , and
receiverID input parameters to determine the EDITPA to use. For more information

webMethods Module for EDI Installation and User’s Guide Version 9.12 316
 M
Odd Header
Batching EDI Documents

about the EDITPA variables that the batchProcess service uses, see "Controlling How
the batchProcess Service Forms the Batch Document" on page 327.
3. The batchProcess service sorts the transactions. For more information, see "Sorting
Transactions when Queued Documents Have No Interchange Headers" on page
317.
4. Each queued EDI document is associated with a Trading Networks delivery task.
After all transactions for an EDI document have been extracted, the batchProcess
service updates the task status. For more information, see "Updating the Task Status
and Publishing Documents for Failed Tasks" on page 320.

Sorting Transactions when Queued Documents Have No Interchange Headers

This section describes how Module for EDI sorts the transactions of queued EDI
documents when they have no interchange or transmission headers. For information
about how Module for EDI sorts transactions when the EDI documents have interchange
or transmission headers, see "Sorting Transactions in the Queued Documents" on page
314.

Default Collection Area (Interchange in the Final Batch EDI Document)

First the batchProcess service sorts the transactions into the default collection area. The
default collection area will become an interchange or transmission in the final batch EDI
document. The default collection area is associated with the following items, which the
batchProcess service obtains from its input parameters:

Item From Where It Is Obtained

EDI standard The standard input parameter of the batchProcess service.

In the final batch EDI document, the interchange or
transmission that corresponds to the default collection area
will use this EDI standard.

Version of the The version input parameter of the batchProcess service. In the
EDI standard final batch EDI document, the interchange or transmission
that corresponds to the default collection area will use this
version.

Interchange or The following inputs of the batchProcess service:

transmission senderIDQualifier , senderID , receiverIDQualifier , and
sender/receiver receiverID . In the final batch EDI document, the interchange
or transmission that corresponds to the default collection
area will use this sender and this receiver.

Production The environment input parameter of the batchProcess

mode (for service. In the final batch EDI document, the interchange or
example,

webMethods Module for EDI Installation and User’s Guide Version 9.12 317
 M
Even Header
Batching EDI Documents

Item From Where It Is Obtained

Production or transmission that corresponds to the default collection area
Testing) will use this production mode.

Subcollections when there Are No Headers (Groups in the Final Batch EDI Document)
The batchProcess further sorts the transaction into a subcollection. Each subcollection
becomes a group (or a TRADACOMS batch) in the final batch EDI document. If the
EDI document has group headers, the batchProcess service sorts the transaction into the
subcollection as described in "Subcollections Representing a Group in the Final Batch
EDI Document" on page 314. If the EDI document does not have group headers, it
uses the following:

Item From Where It Is Obtained

Group type Determined based on the type of transaction; for example,

if the transaction is an ANSI X12 850 (which is a purchase
order), the batchProcess service uses the group type PO

Version of the Obtained from the version input parameter of the batchProcess
EDI standard service
(for example,
4010)

Group sender/ Obtained from the following inputs of the batchProcess

receiver service: senderID and receiverID

Delimiters Associated with the Default Collection Area

The default collection area is associated with a set of delimiters.
The delimiters for the default collection area are determined as follows:
1. The batchProcess service uses the values from its delimiters input parameter.
2. If you do not specify a value for the delimiters input parameter, the batchProcess
service uses its senderIDQualifier , senderID , receiverIDQualifier , and receiverID input
parameters to locate the EDITPA values and uses the EDITPA delimiters variables.
3. If there are no values for the EDITPA delimiters variables in the partner-specific and
default EDITPAs, the batchProcess service uses its own defaults.
For more information, see "Delimiters Used for the Batch EDI Document" on page
319.
The batchProcess service cannot replace delimiters before placing transactions in a
collection area. When the interchange or transmission header is available, the batchProcess
service can determine the delimiters used by the transaction from the queue, and as a

webMethods Module for EDI Installation and User’s Guide Version 9.12 318
 M
Odd Header
Batching EDI Documents

result, can determine whether the transaction uses delimiters that are different from
those used by the collection area. When the interchange or transmission header is
not available, the batchProcess service is unable to determine the delimiters used by a
transaction; therefore, the service cannot replace delimiters if they do not match.

Important: If you place EDI documents into a scheduled delivery queue for batching
and the EDI documents do not have interchange or transmission headers,
you must ensure that the delimiters that the EDI documents use match the
delimiters of the default collection area. If there is a delimiter mismatch, the
batchProcess service will create a batch EDI document that is not valid and
that will not be able to be processed.

Delimiters Used for the Batch EDI Document

For ANSI X12 and UN/EDIFACT documents, each collection area is associated with a set
of delimiters:
Record delimiter
Field delimiter
Subfield delimiter
Release character (used by UN/EDIFACT)

Note: For TRADACOMS documents, Module for EDI provides built-in support for
the following TRADACOMS delimiters: segment terminator, data element
separator, sub-element separator, and segment code separator. You cannot
modify this list of delimiters. TRADACOMS users should skip this section
and continue reading "Updating the Task Status and Publishing Documents
for Failed Tasks" on page 320.

The batchProcess service uses these delimiters when it combines the transactions in the
collection area into the final batch EDI document(s). The batchProcess service determines
the delimiters to use for a collection in the following order:
1. The batchProcess service delimiters input parameter. If you specify the batchProcess
service delimiters input parameter, the batchProcess service uses the delimiters you
specify for all collection areas. As a result, all interchanges in the output batch EDI
document(s) will all have the same delimiters.
2. The delimiters EDITPA variables. If you leave the batchProcess service delimiters
input parameter null, the batchProcess service uses the delimiters EDITPA variable to
determine the delimiters to use for a collection area. Leave the batchProcess service
delimiters input parameter if you want the interchange segments of the output batch
EDI document(s) to use different delimiters.
How the batchProcess service locates the EDITPA varies based on whether the EDI
document in the batch queue has interchange headers, as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 319
 M
Even Header
Batching EDI Documents

If the EDI document has interchange headers, the batchProcess service uses the
sender and receiver from the interchange header to locate the EDITPA.
If the EDI document does not have interchange headers, the batchProcess service
uses its senderIDQualifier , senderID , receiverIDQualifier , and receiverID input
parameters to locate the EDITPA.
3. Module for EDI defaults for delimiters. If the batchProcess service cannot obtain
delimiters from either its delimiters input parameter or the delimiters EDITPA
variable, it uses the following default for delimiters:

Type of delimiter Default to use when cannot obtain delimiter value from other
sources

For ANSI X12 For UN/EDIFACT

Record \n (newline ‘ (apostrophe)

character)

Field * (asterisk) + (plus sign)

Subfield : (colon) : (colon)

Release (not used by ANSI ? (question mark)

character X12)

Updating the Task Status and Publishing Documents for Failed Tasks
Each EDI document in the queue of documents that are being batched is associated with
a Trading Networks delivery task. You can view tasks from the Monitoring > Integration
B2B > Tasks page in My webMethods. The batchProcess service updates the status of the
delivery tasks to one of the following as it sorts the transactions:

Task Status Description

success If the batchProcess service successfully extracts and sorts the

transactions from an EDI document, the batchProcess service sets the
delivery task status to success. The transactions from the document
will be included in a final batch EDI document.

fail If the batchProcess service cannot extract and sort the transactions
from an EDI document, the batchProcess service sets the delivery
task status to fail. This can occur, for example, if the document in
the queue is not a properly formed EDI document. The transactions

webMethods Module for EDI Installation and User’s Guide Version 9.12 320
 M
Odd Header
Batching EDI Documents

Task Status Description

from the document will not be included in the final batch EDI
document.
If a task fails, you can have the batchProcess service publish an IS
document to notify you of the failure. The batchProcess service
publishes the document if the publishBatchFailEvent EDITPA
variable is set to true. For more information, ANSI X12 and UN/
EDIFACT users should see "publishBatchFailEvent Variable" on
page 74 and TRADACOMS users should see "TRADACOMS/
publishBatchFailEvent EDITPA Variable" in "TRADACOM
Variables" on page 112.
The format of the IS document is defined by the
wm.b2b.editn.rec:batchFailRecord IS document type. To view
the format of this IS document, see the description of the
wm.b2b.editn.rec:batchFailRecord IS document type in the webMethods
Module for EDI Built-In Services Reference.
To handle the failure, you can use Software AG Designer to
create Integration Server triggers that subscribe to the published
documents. For details, see the Publish-Subscribe Developer’s Guide
for your release.

Recombining the Transactions into the Batch EDI Document

When recombining the transactions to create the final batch EDI document(s), the
batchProcess:
Adds interchange or TRADACOMS transmission headers with the following
information:
Sender associated with the collection area
Receiver associated with the collection area
EDI standard associated with the collection area
Production mode associated with the collection area
Delimiters associated with the collection area
Other interchange values (for example, ISA01, ISA02, UNB01, UNB07) that the
batchProcess service obtains from the ICheaderInfo EDITPA variables. If the value
of an ICheaderInfo variable is not specified, the batchProcess service uses the value
from the interchange header in the original EDI document. For information about
the ICheaderInfo variables, see "ICheaderInfo Variables" on page 77.
Adds group or TRADACOMS batch headers with the following information:
Sender associated with the subcollection

webMethods Module for EDI Installation and User’s Guide Version 9.12 321
 M
Even Header
Batching EDI Documents

Receiver associated with the subcollection

Group or batch type associated with the subcollection
EDI version associated with the subcollection
GS07 value that the batchProcess service obtains from the ICheaderInfo/GS/
GS07 EDITPA variable. If the value of an ICheaderInfo/GS/GS07 variable is not
specified, the batchProcess service uses the value from the group header in the
original EDI document. For information about the ICheaderInfo variables, see
"ICheaderInfo Variables" on page 77.
Performs FA reconciliation. The batchProcess service tracks groups in the batch EDI
document(s) for FA reconciliation. That is, for each group in the final batch EDI
document(s) and for each functional acknowledgment (that is, ANSI X12 997 or
UN/EDIFACT CONTRL), the batchProcess service updates the EDITRACKING table,
honoring the FAReconciliation EDITPA variable. For more information about the
seings for the FAReconciliation EDITPA variable, see "FAReconciliation Variable" on
page 72. For more information about FA reconciliation, see "Reconciling Functional
Acknowledgments" on page 341.

Note: Functional acknowledgments (FAs) are not applicable to TRADACOMS.

Creates one or more output batch EDI documents. The batchProcess service
determines how many batch EDI documents to create based on the oneBatchQueue
input parameter. That is, if oneBatchQueue is SINGLEOUTPUT, the batchProcess service
creates a single output batch EDI document. If oneBatchQueue is MULTIPLEOUTPUTS,
the batchProcess service creates multiple output batch EDI documents, each
containing a single interchange or transmission. For more information, see
"Indicating How Many Batch EDI Documents to Create" on page 312.
After creating the final output batch EDI document(s), the batchProcess service creates
a BizDocEnvelope for each batch EDI document that it created and sends each
BizDocEnvelope to Trading Networks processing rules. You create a processing rule
that specifies the action to deliver the batch EDI document. For more information, see
"Delivering the Batch EDI Document" on page 331.

Creating the Batch EDI Document when Using SINGLEOUTPUT

The following diagram illustrates how the batchProcess service combines the transactions
from the collection areas when the oneBatchQueue input parameter is SINGLEOUTPUT.
The batchProcess service combines all transactions from all collection areas into a single
batch EDI document. For more information, see the table following the diagram.

webMethods Module for EDI Installation and User’s Guide Version 9.12 322
 M
Odd Header
Batching EDI Documents

Step Description

1 For each collection area, the batchProcess service combines the transactions
in the collection area. Each collection becomes an interchange in the
final EDI batch document, with each subcollection a group within the
interchange.

2 The batchProcess service obtains the EDITPA information for the sender/
receiver associated with the collection area. It uses information associated

webMethods Module for EDI Installation and User’s Guide Version 9.12 323
 M
Even Header
Batching EDI Documents

Step Description
with the collection area, the subcollections, and the EDITPA to create the
interchange and group headers as follows:
Uses the sender/receiver, EDI standard, production mode, and delimiters
associated with the collection area for the interchange headers.
Obtains fields for the interchange header from the EDITPA ICHeaderInfo
variables. If an ICHeaderInfo EDITPA variable does not have a value, the
batchProcess service uses the corresponding value from the interchange
header of the original document. For more information about the
ICheaderInfo variables, see "ICheaderInfo Variables" on page 77.
Uses the sender/receiver, group type, version of the EDI standard
associated with a subcollection for a group header.
Obtains the value of the GS07 field (for ANSI X12) from the EDITPA
ICHeaderInfo/GS/GS07 variable. If this variable does not have a value, it
uses the GS07 from the original EDI document. For more information, see
"ICheaderInfo Variables" on page 77.

3 After recombining the information for all collection areas, the batchProcess
service creates a BizDocEnvelope for the final batch EDI document. The
batchProcess service sets the sender and receiver for the BizDocEnvelope
to the sender/receiver identified in its senderIDQualifier , senderID ,
receiverIDQualifier , and receiverID input parameters. It then sends the
BizDocEnvelope to Trading Networks processing rules for routing.

Note: If you use Sender or Receiver criteria in the processing rule to route
the final batch EDI document, identify the final batch EDI document
using the sender/receiver of the BizDocEnvelope.

Creating the Batch EDI Document when Using MULTIPLEOUTPUTS

The following diagram illustrates how the batchProcess service combines the
transactions from the collection areas when the oneBatchQueue input parameter is
MULTIPLEOUTPUTS. The batchProcess service combines the transactions from each
collection area into a single batch EDI document that contains a single interchange. The
result is multiple output batch EDI documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 324
 M
Odd Header
Batching EDI Documents

Step Description

1 For each collection area, the batchProcess service combines the transactions
in the collection area. Each collection becomes a single batch EDI document
that contains a single interchange with each subcollection a group within
the interchange.

2 As when oneBatchQueue is SINGLEOUTPUT, when oneBatchQueue

is MULTIPLEOUTPUTS, the batchProcess service obtains the EDITPA
information for the sender/receiver that are associated with the collection

webMethods Module for EDI Installation and User’s Guide Version 9.12 325
 M
Even Header
Batching EDI Documents

Step Description
area. It uses information associated with the collection area, the
subcollections, and the EDITPA to create the interchange and group
headers. For more information, see step 2 in "Creating the Batch EDI
Document when Using SINGLEOUTPUT" on page 322.

3 For each collection area, after recombining the transactions in the collection
area, the batchProcess service creates a BizDocEnvelope for the final batch
EDI document. The batchProcess service sets the sender and receiver for the
BizDocEnvelope to the sender/receiver associated with the collection area.
Then it sends the BizDocEnvelope to Trading Networks processing rules
for routing.

Note: If you use Sender or Receiver criteria in the processing rule to route
the final batch EDI document, identify the final batch EDI document
using the sender/receiver of the BizDocEnvelope.

Before You Can Batch EDI Documents

Before Module for EDI can batch EDI documents, you must perform the following high-
level steps.

Step Description Where to Find More Information

1 Install the TN document types for the "Defining TN EDI Document

EDI documents that you will place in Types" on page 37
the scheduled delivery queues.

2 Install the TN document types for the "Defining TN EDI Document

final batch EDI document. You need Types" on page 37
to install the TN document types for
the envelope (for example, the TN
document type X12 Envelope) and the
group or TRADACOMS batch (for
example, the TN document type X12
Group).

3 Define the default and, optionally, ANSI X12 and UN/

the partner-specific EDITPAs for the EDIFACT users: "Defining
interchange or transmission sender/ EDI Trading Partner
receiver pairs. Agreements" on page 61
TRADACOMS users:
"Defining EDI Trading
Partner Agreements When

webMethods Module for EDI Installation and User’s Guide Version 9.12 326
 M
Odd Header
Batching EDI Documents

Step Description Where to Find More Information

Using TRADACOMS" on
page 109
For more information
about the EDITPA
variables that affect
batching EDI documents:
"EDITPA Variables that the
batchProcess Service Uses"
on page 328.

4 Configure the "Configuring Module for

wa.server.tspace.timeToLive property. EDI for Large Document
Because Trading Networks uses large Handling" on page 164
document handling for EDI batching,
the wa.server.tspace.timeToLive
property must be set so that Integration
Server can access the file from Tspace
and store it in the Trading Networks
database.

Controlling How the batchProcess Service Forms the Batch

Document
You control how the batchProcess service combines the EDI documents in a schedule
delivery queue by:
Using the input parameters of the batchProcess service. You define the input
parameters to the batchProcess service when you define the scheduled delivery
queues in Trading Networks. Trading Networks invokes the service to act on
documents that are placed in the scheduled delivery queue using the input
parameters that you specify. For more information, see "Defining the Scheduled
Delivery Queues" on page 330.
Defining EDITPA variables that are used during batch processing. For more
information, see "EDITPA Variables that the batchProcess Service Uses" on page
328. For more information about EDITPAs in general, ANSI X12 and UN/
EDIFACT users should see "Defining EDI Trading Partner Agreements" on page 61
and TRADACOMS users should see "Defining EDI Trading Partner Agreements
When Using TRADACOMS" on page 109.

webMethods Module for EDI Installation and User’s Guide Version 9.12 327
 M
Even Header
Batching EDI Documents

EDITPA Variables that the batchProcess Service Uses

The batchProcess service uses EDITPA variables when sorting transactions in the EDI
documents in the scheduled delivery queue and when recombining the transactions into
the final batch EDI document(s).

EDITPA Variables Used when Sorting Transactions

The following table lists the EDITPA variables that the batchProcess service uses when
sorting the transactions.

EDITPA Variable Description

publishBatchFailEvent The batchProcess service uses this variable to determine

whether you want the service to publish an IS document
to notify you when it cannot sort the transactions from
a queued EDI document into a collection area, and
therefore will not be able to include those transactions
in the final batch EDI document. For more information,
see "publishBatchFailEvent Variable" on page 74 and
"Updating the Task Status and Publishing Documents for
Failed Tasks" on page 320.

delimiters ANSI X12 and UN/EDIFACT only. The batchProcess service

uses this variable when the batchProcess service delimiters
input variable is null. In this situation, the batchProcess
service uses the EDITPA delimiters for collection areas
and therefore in the interchanges (or TRADACOMS
transmissions) in the final batch EDI document(s). For
more information, see "Delimiters Used for the Batch EDI
Document" on page 319.

EDITPA Variables Used when Recombining Transactions

The following table lists the EDITPA variables that the batchProcess service uses when
recombining the transactions.

Note: These variables are applicable only to ANSI X12 and UN/EDIFACT
documents.

EDITPA Variables Description

UNAmode The batchProcess service uses this variable to determine

whether to create a UNA segment prior to the interchange
in the final batch EDI document. The UNAmode variable

webMethods Module for EDI Installation and User’s Guide Version 9.12 328
 M
Odd Header
Batching EDI Documents

EDITPA Variables Description

is specific to UN/EDIFACT. For more information, see
"UNAmode Variable" on page 74.

ICheaderInfo The batchProcess service uses these variables to construct the

interchange headers in the final batch EDI document. For
an X12 group header, the batchProcess service also uses the
ICHeaderInfo/GS/GS07 variable for the group header.
For more information about the ICheaderInfo variables, see
"ICheaderInfo Variables" on page 77.

Note: If the ICheaderInfo variables do not have a value, the

batchProcess service uses the values from the headers in
the original document.

Preparing to Batch EDI Documents

The following table describes the tasks you must perform to batch EDI documents, as
well as where to find more information about each task.

Task Description Where to Find More Information

1 Determine the number of "Determining the Number of

scheduled delivery queues you Queues You Need to Define" on
need to define. page 329

2 Define the scheduled delivery "Defining the Scheduled Delivery

queues for batching EDI Queues" on page 330
documents.

3 Define the processing rules "Defining Processing Rules to

to deliver documents to the Batch EDI Documents" on page
scheduled delivery queues. 331

Determining the Number of Queues You Need to Define

The number of scheduled delivery queues you need depends on the number of
destinations to which you want to send batch EDI documents. Create one scheduled
delivery queue for each destination. For example, you might create one queue to batch
data destined for the GXS VAN, a second queue for batch data to go to the MCI VAN,
and a third queue for batch data directed to a specific company.

webMethods Module for EDI Installation and User’s Guide Version 9.12 329
 M
Even Header
Batching EDI Documents

Defining the Scheduled Delivery Queues

To create a scheduled delivery queue, define a public queue in My webMethods. The
following table describes information that you need to supply when defining the queue.
For more information about creating public queues, see the webMethods Trading Networks
Administrator’s Guide for your release.

Public Queue Description

Setting

Queue name The name you want to give the scheduled delivery queue.
For example, if you are defining a queue for EDI documents
for which the receiver is CYG Company, you might set the
Queue Name to "CYG Queue."

Delivery service The delivery service you want to associate with the queue.
Select EDI Batch.

Note: When you install Module for EDI, the Module

automatically registers the wm.b2b.editn:batchProcess
service with Trading Networks as a scheduled delivery
service and assigns it the name EDI Batch. You assign the
batchProcess service to a scheduled delivery queue by
selecting EDI Batch for Delivery Service.

Inputs The inputs for the batchProcess service. When Trading

Networks invokes the batchProcess service, Trading
Networks passes the inputs that you specify in these input
parameters. For more information, see the description of the
wm.b2b.editn.batch:batchProcess service in webMethods Module for
EDI Built-In Services Reference.

State The state of the queue. Select Enable, Disable, Drain, or Suspend
Delivery. For more information about these states, see the
webMethods Trading Networks Administrator’s Guide for your
release.

Schedule When you want Trading Networks to invoke the batchProcess

service to act on the EDI documents in the queue you are
defining. When defining a schedule, consider how often your
trading partners, VAN, etc., should receive the batch EDI
documents.

webMethods Module for EDI Installation and User’s Guide Version 9.12 330
 M
Odd Header
Batching EDI Documents

Note: It is recommended that you do not set up private queues for EDI batching
because of the limitations that private queues pose. EDI batching with private
queues results in EDI documents always going to a specific receiver's queue
because you define private queues in a trading partner profile.

Defining Processing Rules to Batch EDI Documents

Use My webMethods to define processing rules that instruct Trading Networks to place
an EDI document into a scheduled delivery queue that is being used for batching EDI
documents. The following table provides specific information.
For more detailed information about creating processing rules, see the webMethods
Trading Networks Administrator’s Guide for your release.

On this Processing Specify...

Rules tab...

Criteria The standard criteria you want to use. Specify criteria

that describes the EDI documents you want to place in a
scheduled delivery queue.

Extended Criteria You will not need to use extended criteria.

Action What you want Trading Networks to do with the EDI

document it is processing.
To place the document into a scheduled delivery queue that
is used for batching EDI documents, do the following:
1. Select Deliver Document By processing action.
2. For the Deliver Document By processing action, select
Scheduled Delivery.
3. Select the appropriate scheduled delivery queue that you
associated with the EDI Batch delivery service from the list of
registered queues.

Delivering the Batch EDI Document

After the batchProcess service creates the final batch EDI document, it sends the batch EDI
document to Trading Networks processing rules. You create another Trading Networks
processing rule to deliver the final batch EDI document.
When defining the processing rule to deliver a batch EDI document, use the EDI Batch
custom aribute. For a batch EDI document, the EDI Batch custom aribute is set to

webMethods Module for EDI Installation and User’s Guide Version 9.12 331
 M
Even Header
Batching EDI Documents

Interchange. You can use the EDI Batch custom aribute in the extended criteria of the
processing rule so the processing rule is only used for a batch EDI document.
To deliver a batch EDI document, the processing rule can use one of the following
actions:
Execute a Service processing action to invoke a service that you create to deliver the
final batch EDI document
Deliver Document By processing action to send the document to a VAN
In My webMethods, use the Administration > Integration > B2B > Processing Rules page
to define a processing rule in Trading Networks. The following table provides details
about how to define the processing rules.

On this Specify...
Processing
Rules tab...

Criteria The standard criteria you want to use to select the processing
rule. Specify criteria that describes the final batch EDI
document that the batchProcess service creates.

Note: If you use the Sender and/or Receiver criteria, the

sender/receiver you need to specify is that of the
BizDocEnvelope for the final batch EDI document.
The sender/receiver are different based on whether the
batchProcess service oneBatchQueue input parameter
is SINGLEOUTPUT or MULTIPLEOUTPUTS. For more
information, see step 3 in "Creating the Batch EDI
Document when Using SINGLEOUTPUT" on page
322 and "Creating the Batch EDI Document when
Using MULTIPLEOUTPUTS" on page 324.

Extended The custom aributes that you want to use as criteria to

Criteria select the processing rule. The following shows the extended
criterion you should add:

Attribute Operator Value

EDI Batch Equals Interchange

Action How you want Trading Networks to deliver the final batch
EDI document.
Select Execute a Service processing action to invoke a service
that you create to deliver the final batch EDI document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 332
 M
Odd Header
Batching EDI Documents

On this Specify...
Processing
Rules tab...

Select Deliver Document By processing action to send the

document to a VAN. For more information, see "Preparing to
Deliver Documents to VANs" on page 337.

For more information about creating processing rules, see the webMethods Trading
Networks Administrator’s Guide for your release.

Viewing Batched EDI Documents

Trading Networks can show the relationship between EDI batched documents and the
individual documents that were used to create them. The name of this relationship is
EDI Batch.

To view the relationship between EDI batched documents and individual documents
1. In My webMethods: Monitoring > Integration > B2B > Transactions
2. Search for the EDI batch document for which you want to view the related
documents. For information about searching documents, see the webMethods Trading
Networks User’s Guide for your release.
3. In the search results, locate the EDI batch document for which you want to view
related documents and then click or View Related Documents.
Trading Networks displays the Related Document page.

webMethods Module for EDI Installation and User’s Guide Version 9.12 333
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 334
 M
Odd Header
Retrieving and Delivering EDI Documents from and to VANs

16   Retrieving and Delivering EDI Documents from and

to VANs

■ Overview ..................................................................................................................................... 336

■ Preparing to Retrieve Documents from a VAN .......................................................................... 336
■ Preparing to Deliver Documents to VANs .................................................................................. 337
■ Handling Conventions Required by Specific VANs .................................................................... 339
■ Customizing Built-In Services to Connect to Another VAN ........................................................ 340

webMethods Module for EDI Installation and User’s Guide Version 9.12 335
 M
Even Header
Retrieving and Delivering EDI Documents from and to VANs

Overview
When using webMethods Module for EDI (Module for EDI) with webMethods Trading
Networks (Trading Networks), you can connect to Value Added Networks (VANs) to
retrieve inbound EDI documents and to deliver outbound EDI documents.
Software AG has tested and certified Module for EDI to connect with the GXS and MCI
VANs. If you need to connect to another VAN, you might need to customize the services
that Module for EDI provides to suit the specific VAN connectivity.
To learn more about VANs and how Module for EDI works with VANS, see the
webMethods Trading Networks Administrator’s Guide for your release.

Preparing to Retrieve Documents from a VAN

To retrieve inbound EDI documents from a VAN, invoke the
VAN.VANConnectivity:getFromVAN service. You can schedule this service to run when you
want to retrieve inbound EDI documents from the VAN. To do so, set up a user task for
the service. For information about how to use Integration Server Administrator to set up
a user task, see the webMethods Integration Server Administrator’s Guide for your release.
The input parameters that you supply for the getFromVAN service identify the VAN to
which you want to connect to retrieve EDI documents. The following table describes
other input parameters to the getFromVAN service that you can use to specify optional
actions that you might want the service to perform in addition to retrieving the inbound
EDI documents. To learn about all the input parameters to this service, see webMethods
Module for EDI Built-In Services Reference.

Use this input To have the getFromVAN service perform this optional action...
parameter...

saveInboundToTN Submit the retrieved inbound EDI documents to Trading

Networks for processing. If you set the saveInboundToTN
parameter to yes, the retrieved inbound EDI documents are
processed through Trading Networks like any other inbound
EDI documents.

getReport Get VAN-generated reports after receiving the inbound EDI

documents.

In addition to, or instead of, invoking the getFromVAN service, you can have the
VAN.VANConnectivity.putToVAN service retrieve waiting inbound EDI documents when it
delivers outbound EDI documents to the VAN. For more information about the putToVAN
service, see "Preparing to Deliver Documents to VANs" on page 337.

webMethods Module for EDI Installation and User’s Guide Version 9.12 336
 M
Odd Header
Retrieving and Delivering EDI Documents from and to VANs

Note: Because the putToVAN service is registered in Trading Networks as a scheduled

delivery service and assigned the name VANFTP, this chapter also refers to the
putToVAN service as the VANFTP service.

Preparing to Deliver Documents to VANs

To send outbound EDI documents to a VAN, you define a:
Scheduled delivery queue in Trading Networks to hold outbound EDI documents
that are to be sent to a VAN
Processing rule to place outbound EDI documents into the scheduled delivery queue

Defining the Scheduled Delivery Queue

To define a scheduled delivery queue for delivering EDI documents to a VAN, you
define a Trading Networks public queue using My webMethods. You define one queue
for each VAN to which you want to deliver documents. For example, if you want to
connect to GXS and MCI, you must define a public queue for GXS and MCI. If you want,
you can set up more than one queue for a VAN. For example, you might define multiple
queues for a single VAN if you have more than one account for the VAN.
When you define the queue, you:
Assign the queue a name. You can give the queue any name you want. When you
define a processing rule to place outbound EDI documents in the queue, you will
select the queue by the name you assign it.
Associate the queue with a scheduled delivery service. You associate the queue with
the VANFTP scheduled delivery service. The VANFTP scheduled delivery service is the
VAN.VANConnectivity:putToVAN service. Module for EDI registers the putToVAN service as
a Trading Networks scheduled delivery service and assigns it the name VANFTP in
Trading Networks. The VANFTP service uses FTP to deliver documents to a specific
VAN.
Assign a state. Define whether Trading Networks can add delivery tasks into a
queue and deliver the documents that correspond to the delivery tasks in the queues.
Assign the input values for the VANFTP service. Set the values for the VANFTP service
to indicate the VAN to which you want to connect and to set optional actions you
want the VANFTP service to perform. For example, you can indicate that you want to
retrieve VAN-generated reports.
Associate the queue with a schedule. You specify the times that you want to deliver
the outbound EDI documents to the VAN. At the times specified by the schedule,
Trading Networks invokes the VANFTP scheduled delivery service to send the
outbound EDI documents that are in the queue to the VAN.

webMethods Module for EDI Installation and User’s Guide Version 9.12 337
 M
Even Header
Retrieving and Delivering EDI Documents from and to VANs

The following table describes information that you need to supply when defining the
public queue in My webMethods.

Public Queue Setting Description

Queue name The name you want to give the scheduled delivery queue. For
example, if you are defining a queue to hold EDI documents
to be sent to the MCI VAN, you might name the queue "MCI
Queue".

Delivery service The delivery service you want to associate with the queue.
Select VANFTP.

Inputs The inputs for the VANFTP service. When Trading Networks
invokes the VANFTP service, Trading Networks passes the
inputs that you specify in the input parameters.
The input parameters that you specify for the VANFTP service
identify the VAN to which you want to connect to deliver
the EDI documents in the queue. The following describes
other input parameters to the VANFTP service that you can
use to specify optional actions that you might want the
VANFTP service to perform in addition to delivering the
outbound EDI documents. To learn about all the input
parameters to the VANFTP service, see the description of the
VAN.VANConnectivity:putToVAN service in webMethods Module for
EDI Built-In Services Reference.

Use this input To have the VANFTP service perform this

parameter... optional action...

getReport Get VAN-generated reports after

delivering the outbound EDI
documents.

getInbound Retrieve inbound EDI documents from

the VAN after it delivers the outbound
EDI documents from the queue. The
VANFTP service always submits the
inbound EDI documents that it retrieves
to Trading Networks for processing.

State The state of the queue. Select Enable, Disable, Drain, or Suspend
Delivery. For more information about these states, see the
webMethods Trading Networks Administrator’s Guide for your
release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 338
 M
Odd Header
Retrieving and Delivering EDI Documents from and to VANs

Public Queue Setting Description

Schedule When you want Trading Networks to invoke the VANFTP

service to deliver the EDI documents in the queue you are
defining.

Note: You should not set private queues for delivering EDI documents to VANs.
You can only use a private queue for a specific trading partner while public
queues can be used by multiple trading partners.

Defining a Processing Rule to Place Documents in the Queue

To deliver an outbound EDI document to a VAN, you define processing rules that
instruct Trading Networks to place the outbound EDI document into a scheduled
delivery queue that is associated with the VANFTP service.
Use My webMethods to define a processing rule in Trading Networks. For more
information, see the webMethods Trading Networks Administrator’s Guide for your release.
When specifying actions on the Action tab:
Select the Deliver Document By processing action.
Select Schedule Delivery.
Select the appropriate scheduled delivery queue that you associated with the
VANFTP service from the list of registered queues.

Handling Conventions Required by Specific VANs

Each VAN has its own conventions and idiosyncrasies that you should be aware
of when seing input parameters to the VAN:VANConnectivity:getFromVAN service to
send EDI documents to a VAN, as well as when seing the input parameters to the
VAN:VANConnectivity:putToVAN (VANFTP) service to retrieve EDI documents from a VAN.
For example:
Some VANs require you to provide account names when connecting, while others do
not.
Some VANs have delineated inbound and outbound document boxes, while others
do not.
Some VANs support the retrieval of documents based on a file name paern, while
others do not.
The availability and variety of reports, as well as the ways in which you access them,
differs from VAN to VAN.

webMethods Module for EDI Installation and User’s Guide Version 9.12 339
 M
Even Header
Retrieving and Delivering EDI Documents from and to VANs

Customizing Built-In Services to Connect to Another VAN

When connecting to a VAN other than GXS, ICC.NET, or MCI, always begin by
aempting to connect to the VAN using the information described in "Preparing to
Retrieve Documents from a VAN" on page 336. If you encounter problems executing
the VAN.VANConnectivity:getFromVAN service and/or the VAN.VANConnectivity:putToVAN (VANFTP)
service, you need to create customized services.
Create your customized services using the VAN.VANConnectivity:getFromVAN and the
VAN:VANConnectivity:putToVAN (VANFTP) services as templates. Be sure to give the
customized services different names. Your customized services should use the
FTP connectivity services that are provided in the VAN.VANConnectivity folder of the
WmEDIforTN package.
If you created a customized service to replace the VAN.VANConnectivity:getFromVAN
service, you can create a scheduled user task to have the service executed at the
times you want to retrieve the EDI documents from the VAN. For information about
how to use Integration Server Administrator to set up a user task, see the webMethods
Integration Server Administrator’s Guide for your release.
If you created a customized service to replace the VAN.VANConnectivity:putToVAN
(VANFTP) service, do the following:
1. Register your customized service as a Trading Networks scheduled delivery
service. To do so, invoke the wm.tn.delivery:registerService service. For information
about this service, see the webMethods Trading Networks Built-In Services Reference
for your release.
2. Update the definition for the scheduled delivery queue that you created for
sending EDI documents to VANs by replacing the VANFTP delivery service with
the registered service name of your customized service. In My webMethods, do
this on the Public Queue Information page (Administration > Integration > B2B >
Public Queues, select the queue, and click Edit).

webMethods Module for EDI Installation and User’s Guide Version 9.12 340
 M
Odd Header
Reconciling Functional Acknowledgments

17   Reconciling Functional Acknowledgments

■ Overview ..................................................................................................................................... 342
■ Turning FA Reconciliation On or Off .......................................................................................... 343
■ Information Module for EDI Records to Reconcile FAs ............................................................. 343

webMethods Module for EDI Installation and User’s Guide Version 9.12 341
 M
Even Header
Reconciling Functional Acknowledgments

Overview
When you use Module for EDI with Trading Networks, Module for EDI can reconcile
Functional Acknowledgments (FAs) to their related EDI documents.

Note: Functional acknowledgments are not applicable to TRADACOMS or VDA.

To learn more about:

What a functional acknowledgment (FA) is, see webMethods Module for EDI Concepts
Guide.
The Module for EDIwm.b2b.edi.util:generateFA service, which generates FAs, see
"Generating Acknowledgments" on page 169.
How to generate an FA when using Trading Networks, see "Automatically
Generating Functional Acknowledgments" on page 275.

FA Reconciliation
To perform FA reconciliation, Module for EDI records each Group/Interchange EDI
document that it sends and receives through Trading Networks. Whether it records a
Group or an Interchange document depends on the EDI standard of the document.
For ANSI X12, Module for EDI records each Group document that it sends or
receives through Trading Networks.
For UN/EDIFACT, Module for EDI records each Interchange-level document.
Module for EDI records information about these documents in the EDITRACKING
table, which is a module-specific table in the Trading Networks database.
When Module for EDI receives the FA that corresponds to a Group/Interchange EDI
document, the module updates the FA status for the Group/Interchange document in the
EDITRACKING table.
For ANSI X12, the FA is the 997 document, which acknowledges the group envelope
and all of its contents.
For UN/EDIFACT, the FA is the CONTRL message, which acknowledges an
interchange envelope and all of its contents.

Important: For Module for EDI to be able to record information for Group/Interchange
EDI documents and to update the FA status when the FA is sent or received,
you must exchange the Group/Interchange EDI document and the FAs
through Trading Networks. In addition, for the document to appear in the
EDITRACKING table, the document must be persisted to Trading Networks,
and the document must have both a sender ID and a receiver ID.

webMethods Module for EDI Installation and User’s Guide Version 9.12 342
 M
Odd Header
Reconciling Functional Acknowledgments

Turning FA Reconciliation On or Off

FA reconciliation is enabled on a partner pair (sender/receiver) or group type basis.
For partner pairs, you define whether you want to reconcile FAs using the
FAReconciliation EDITPA variable. Set this variable to On if you want Module
for EDI to reconcile and auto-generate FAs based on partner pairs; set it to Off if
you do not. If you want to turn FA reconciliation on or off for all partners, set the
FAReconciliation EDITPA variable in the default EDITPA and leave FAReconciliation
blank in all partner-specific EDITPAs.
For group types, you also define whether you want to reconcile FAs using the
FAReconciliation EDITPA variable. In addition, you can define how the FA for
different group types is reconciled using the FAGeneration/DocumentSeings/
autoGenerateFA and FAGeneration/DocumentSeings/groupType EDITPA variables.
The following table summarizes the use cases for FA reconciliation of group types.

When FAReconciliation And the FAGeneration/ Module for EDI...

is set to... DocumentSettings
variables are...

true Not present Reconciles the FA for all groups

true Present Reconciles the FA for each group

according to the values in the
FAGeneration/DocumentSeings
variables

false Not present Does not reconcile FAs

false Present Does not reconcile FAs

For more information about EDITPA variables, see "FAReconciliation Variable" on page
72 and "FAGeneration Variables" on page 80. For more information about default and
partner-specific EDITPAs, see "Defining EDI Trading Partner Agreements" on page 61.

Information Module for EDI Records to Reconcile FAs

When an ANSI Group or UN/EDIFACT Interchange document is sent or received
through Trading Networks, Module for EDI records an entry for the document in the
EDITRACKING table. Regardless of whether FA reconciliation is on or off, the module
always records information in the EDITRACKING table for Group/Interchange EDI
documents that are exchanged through Trading Networks. However, the value that

webMethods Module for EDI Installation and User’s Guide Version 9.12 343
 M
Even Header
Reconciling Functional Acknowledgments

the module records as the FA status for the Group/Interchange EDI documents in the
EDITRACKING table is different based on whether FA reconciliation is on or off.
When an FA is sent or received through Trading Networks, Module for EDI aempts
to locate an entry in the EDITRACKING table for the corresponding Group/
Interchange EDI document. The module uses the document IDs to match the FA to
the corresponding Group/Interchange EDI document. The document ID of a Group
document is the group control number. The document ID of an Interchange document is
the IC control number. For more information, see "DocumentID" on page 241.

Note: For Module for EDI to reconcile FAs with Group/Interchange EDI documents,
the FAs and the Group/Interchange EDI documents must be exchanged on the
same Integration Server.

The following table describes the information that Module for EDI records in the
EDITRACKING table.

Type of document When FAReconciliation is true, When FAReconciliation is false,

exchanged Module for EDI.... Module for EDI....
through Trading
Networks

ANSI X12 Adds an entry to the Adds an entry to the

Group EDITRACKING table for EDITRACKING table for
the Group/Interchange the Group/Interchange
-OR-
document and sets the FA document and sets the FA
UN/EDIFACT status to None. status to Disable.
Interchange

FA Aempts to locate the Aempts to locate the

Group/Interchange Group/Interchange
document to which the FA document to which the FA
corresponds. corresponds.
If Module for EDI locates If Module for EDI locates
the Group/Interchange the Group/Interchange
document, it updates the document:
FA status for the Group/
If the current FA
Interchange document
status for the Group/
based on the status in
Interchange document
the FA. For example, if
is Disable, the Module
the status in the FA is
does nothing.
“A” (Accept), Module for
EDI updates the FA status If the current FA
in the EDITRACKING status for the Group/
table to Accept. For a list of Interchange document
values for the FA status in is None, the Module
the EDITRACKING table,

webMethods Module for EDI Installation and User’s Guide Version 9.12 344
 M
Odd Header
Reconciling Functional Acknowledgments

Type of document When FAReconciliation is true, When FAReconciliation is false,

exchanged Module for EDI.... Module for EDI....
through Trading
Networks
see "FA Statuses" on page updates the FA status
345. to Disable.
If Module for EDI does If Module for EDI does
not locate the Group/ not locate the Group/
Interchange document, Interchange document,
it adds an entry to the it adds an entry to the
EDITRACKING table for EDITRACKING table for
the FA. the FA.

FA Statuses
The following table lists the values of the FA status recorded for an ANSI X12 Group or
UN/EDIFACT Interchange document in the EDITRACKING table.

FA Status Description

None Module for EDI has not yet received or sent an FA to

acknowledge this document.

Disable The FAReconciliation EDITPA variable is set to false,

which disables FA reconciliation and reporting. For more
information about this variable, see "FAReconciliation
Variable" on page 72.

Duplicate Module for EDI has one or more other documents recorded
in the EDITRACKING table that match the FA for this
document. For more information, see "Controlling FA Status
for Documents Submied Multiple Times" on page 346.

Error Module for EDI received an FA for which it could not locate a
matching document in the EDITRACKING table. The module
adds an entry to the EDITRACKING table for the FA and
assigns it this status.

Duplicate FA/ Module for EDI received more than one FA that matches this
Errors document.

Accept Module for EDI received a single FA that matches this

document and the FA has either:

webMethods Module for EDI Installation and User’s Guide Version 9.12 345
 M
Even Header
Reconciling Functional Acknowledgments

FA Status Description

An “A” (Accept) status on the confirmed level (ANSI X12)

A “7” status on the confirmed level (UN/EDIFACT)

Accept with Module for EDI received a single FA that matches this
Errors document and the FA has an “E” (Errors) status on the
confirmed level.

Partially Accept Module for EDI received a single FA that matches this
document and the FA has a “P” (Partially Accept) status on
the confirmed level.

Reject Module for EDI received a single FA that matches this

document and the FA has either:
An “R” (Reject) status on the confirmed level (ANSI X12)
An “4” status on the confirmed level (UN/EDIFACT)

FA Errors Module for EDI encountered other unknown errors.

Interchange Module for EDI received an interchange.

Received

Controlling FA Status for Documents Submitted Multiple Times

Perform the following procedure to control how Module for EDI assigns FA status when
you send (or receive) a document multiple times before the receiver returns an FA.

To control what happens when a document is sent multiple times before receiving an FA
1. In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2. In the Module for EDI Configuration Properties section, add or update the
EDIResolveDuplicates property as follows:

Value Description

false When you send a document multiple times before the

receiver returns an FA, the status of each document is set
to None ("100") in the EDITRACKING table. This indicates
that the Module for EDI has not yet received an FA to
acknowledge the document.
When the receiver returns an FA for one of these documents,
the status of each document is changed to Duplicate

webMethods Module for EDI Installation and User’s Guide Version 9.12 346
 M
Odd Header
Reconciling Functional Acknowledgments

Value Description
(“120”). This indicates that multiple documents exist in the
EDITRACKING table that match the FA for this document.
This is the default.

Note: This behavior also applies to documents that you

receive.

true When you send a document the first time, its status is set to
None (“100”) in the EDITRACKING table. This indicates that
Module for EDI has not yet received an FA to acknowledge
the document.
If the same document is sent again before the receiver returns
an FA, the status of the first document changes to Duplicate
(“120”). This indicates that multiple documents exist in the
EDITRACKING table that match the FA for this document.
The status of the second document is set to None. This
behavior occurs for each subsequent document sent before
an FA is returned.
When the receiver returns an FA, the FA will acknowledge
only the document that was sent last. The status of the
document that was sent last will be set according to the FA
status reported in the FA document. The status of all prior
documents remains Duplicate.

Note: This behavior also applies to documents that you

receive.

3. Click Save. Module for EDI updates the configuration in memory so the changes take
effect immediately and in the WmEDI/config/properties.cnf file.

Setting FA Status Manually

You can manually set the FA status of EDI documents that did not receive any
acknowledgments if the following circumstances are met:
The document is a group-level transaction, for example, X12 Group and
UNEDIFACT Group document types.
FA reconciliation is enabled (that is, the FAReconciliation EDITPA variable is set to
true). For more information about this variable, see "FAReconciliation Variable" on
page 72.
Edit EDI FA Status Aributes data permission is set to true.

To manually set the FA status

In My webMethods: Monitoring > Integration > B2B > Transactions.

webMethods Module for EDI Installation and User’s Guide Version 9.12 347
 M
Even Header
Reconciling Functional Acknowledgments

Search for the transaction of interest, and then click the Details icon.
In the Transaction Details section of the Transactions page, click the Attributes tab.
From the EDI FA Status list, select the desired FA status.
Click Save.

webMethods Module for EDI Installation and User’s Guide Version 9.12 348
 M
Odd Header
Viewing Log Information for EDI Documents

18   Viewing Log Information for EDI Documents

■ Overview ..................................................................................................................................... 350
■ Viewing the Server Log .............................................................................................................. 350
■ Viewing the Trading Networks Activity Log ................................................................................ 350

webMethods Module for EDI Installation and User’s Guide Version 9.12 349
 M
Even Header
Viewing Log Information for EDI Documents

Overview
During processing, webMethods Module for EDI (Module for EDI) logs information to
the server log. Additionally, if you are using Module for EDI with webMethods Trading
Networks (Trading Networks), Module for EDI also logs information to the Trading
Networks activity log.

Viewing the Server Log

Module for EDI logs informational, warning, and error messages to the server log of
Integration Server. The messages that Module for EDI adds to the server log have one of
the following keys:

Key For messages issued from the...

EDICOR WmEDI package of Module for EDI

EDIFTN WmEDIforTN package of Module for EDI

The key is part of the identification of a message. For example, the following is a
message that is issued from the WmEDI package of Module for EDI and uses the key,
EDICOR:
[EDICOR.000020.000404] No transaction set defined for SEF

To view the server log, use Integration Server Administrator. For more information, see
the webMethods Integration Server Administrator’s Guide for your release.

Viewing the Trading Networks Activity Log

Module for EDI writes information about EDI document processing activity to the
Trading Networks activity log. Examples of activities that are wrien to this log include
the following:
EDI document processing. When an interchange, group, or transaction document is
processed, the activity log entry with the activity class Processing states that the
document was processed and identifies the sender, receiver, and agreement ID.
EDITPA used. The activity log entry with the activity class Processing specifies the
EDITPA Trading Networks used to process the EDI document.
TPA additions and changes.If the Trading Networks configuration property
tn.tpa.EnableLogTPA is set to true, the activity log entry with the activity class TPA
Usage and Settings specifies when the TPA was created or revised and by whom,
describes which parameters changed, and identifies the sender, receiver, and

webMethods Module for EDI Installation and User’s Guide Version 9.12 350
 M
Odd Header
Viewing Log Information for EDI Documents

agreement ID. For more information about the tn.tpa.EnableLogTPA property, see the
webMethods Trading Networks Administrator’s Guide for your release.

Note: Whenever you reset the value of tn.tpa.EnableLogTPA , you must reload the
WmTN package to reflect the changes.

For more information on searching the activity log entries based on the activity class
associated with the entries you want to view, see the webMethods Trading Networks User’s
Guide for your release.
You can view the activity log from My webMethods. For instructions, see the webMethods
Trading Networks User’s Guide for your release.

webMethods Module for EDI Installation and User’s Guide Version 9.12 351
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 352
 M
Odd Header
Viewing Information about EDI Documents

19   Viewing Information about EDI Documents

■ Overview ..................................................................................................................................... 354
■ EDI Documents You Can View .................................................................................................. 354
■ Viewing EDI Documents ............................................................................................................ 355
■ Viewing Information about EDI Documents in Queues ............................................................. 357
■ Viewing Related Documents with Relationship Labels .............................................................. 358

webMethods Module for EDI Installation and User’s Guide Version 9.12 353
 M
Even Header
Viewing Information about EDI Documents

Overview
When you use webMethods Module for EDI (Module for EDI) with webMethods
Trading Networks (Trading Networks), you can view the EDI documents that have
passed through your system if they have been saved to the Trading Networks database.
You view documents (transactions) from My webMethods.
To learn more about viewing documents, see the webMethods Trading Networks User’s
Guide for your release.

EDI Documents You Can View

By default, all Interchange, Group, and Transaction documents that Module for EDI
creates based on the seing of the splitOption EDITPA variable are saved to the Trading
Networks database.
For TRADACOMS documents all Transmission, Batch, and File documents that Module
for EDI creates based on the seing of the TRADACOMS/splitOption EDITPA variable
are saved to the Trading Networks database.
The default is to save the documents because of the TN document types that you install
for EDI documents. In the TN document types, the Trading NetworksSave Document
to Database pre-processing action is set so the Interchange, Group, and Transaction
documents (or Transmission, Batch, and File documents) are saved.
Additionally, you can save the original EDI document from which Module for EDI
split the Interchange, Group, and Transaction documents (or Transmission, Batch,
and File documents). You define whether to save the original EDI document using the
persistMultipleDocEnvelope EDITPA variable.
Refer to the following table to learn where to go for more information.

For this EDI To learn more about... See...

standard...

ANSI X12 How Module for EDI uses the webMethods Module for EDI
and UN/ EDITPA variable splitOption Concepts Guide and "splitOption
EDIFACT to split documents into Variable" on page 71
Interchange, Group, and
Transaction documents

EDITPAs and how to define "Defining EDI Trading Partner

them Agreements" on page 61

webMethods Module for EDI Installation and User’s Guide Version 9.12 354
 M
Odd Header
Viewing Information about EDI Documents

For this EDI To learn more about... See...

standard...

The persistMultipleDocEnvelope "PersistMultipleDocEnvelope

EDITPA variable Variable" on page 69

TRADACOMS How the Module for EDI webMethods Module for

uses the EDITPA variable EDI Concepts Guide and
TRADACOMS/splitOption "TRADACOM Variables" on
to split documents into page 112
Transmission, Batch, and File
documents

EDITPAs and how to define "Defining EDI Trading Partner

them Agreements When Using
TRADACOMS" on page 109

The persistMultipleDocEnvelope "TRADACOM Variables" on

EDITPA variable for page 112
TRADACOMS documents

Viewing EDI Documents

You can view the following types of information about your EDI documents on the
Transactions page in My webMethods:
Sender and receiver of the EDI document
Date the document was received
Processing status of the EDI document
User status
Document type
Related documents (for example, the functional acknowledgment [FA] that is
associated with an ANSI X12 Group document)
By default, My webMethods displays the related documents identified by their control
numbers. If a document does not contain a control number (for example, it is an invalid
document), the document relationships cannot be displayed based on control numbers.
Instead, a warning message will be logged for the envelope or group document's
activity.

Note: You can override this default to display related documents identified by their
relationship labels instead of by their control numbers. For example, if you
view an ANSI X12 envelope, the screen displays that envelope's related group

webMethods Module for EDI Installation and User’s Guide Version 9.12 355
 M
Even Header
Viewing Information about EDI Documents

with the relationship label Envelope - Group. To set the flag that controls this,
see "Viewing Related Documents with Relationship Labels" on page 358.

For more information about viewing documents, see the webMethods Trading Networks
User’s Guide for your release.

Trading Networks Processing Status and EDI Documents

The following table describes the processing statuses that Trading Networks sets while
processing EDI documents. You can use these statuses as criteria for selecting the EDI
documents that you want to view.

Processing Status Description

NEW Trading Networks has received the EDI document but it

has not yet completed recognizing and/or processing the
document with its processing rules.

QUEUED The document is an EDI document that is either in a

scheduled delivery queue for EDI batch processing or for
delivery to VAN.
For more information about EDI batch processing, "Batching
EDI Documents" on page 311. For more information
about delivering documents to VANs, see "Retrieving and
Delivering EDI Documents from and to VANs" on page 335.

DONE Trading Networks has completed its processing of the EDI

document. Note that the following processing actions might
not be complete:
Execute a Service. Execution of the service might not be
complete if it was invoked asynchronously or executed
using a service execution task.
Deliver Document By. The document might not be delivered to
the receiving partner yet.

DONE W/ Trading Networks has completed its processing of the EDI

ERRORS document. However, errors occurred during document
recognition or document processing. Note that the following
processing actions might not be complete:
Execute a Service. Execution of the service might not be
complete if it was invoked asynchronously or executed
using a service execution task.

webMethods Module for EDI Installation and User’s Guide Version 9.12 356
 M
Odd Header
Viewing Information about EDI Documents

Processing Status Description

Deliver Document By. The document might not be delivered to

the receiving partner yet.

ABORTED Trading Networks encountered a fatal error before

completing the processing specified in the processing rule.
This status is typically used in one of the following situations:
Trading Networks detected an infinite loop in the
processing rule. That is, a document triggers a processing
rule that creates and submits a new document that triggers
the same processing rule again.
Trading Networks encountered an internal error.
The built-in service wm.tn.route:abort was executed for the
service. For more information about this service, see the
webMethods Trading Networks Built-In Services Reference for
your release.

Viewing Information about EDI Documents in Queues

When you use the Deliver Document By processing action of a processing rule to place a
document in a scheduled delivery queue, Trading Networks keeps track of the delivery
using a delivery task. Trading Networks actually places the delivery task, which is
associated with the document to deliver, in the scheduled delivery queue. You use
scheduled delivery queues when you want to batch EDI documents or when you want
to deliver EDI documents to VANs. To view information about the progress of the
batching or delivery, use the Tasks page in My webMethods.

For more information about... See...

Delivery tasks The webMethods Trading Networks User’s Guide for

your release.

How to set up to batch EDI "Batching EDI Documents" on page 311

documents

How to set up to deliver EDI "Retrieving and Delivering EDI Documents from
documents to VANs and to VANs" on page 335

webMethods Module for EDI Installation and User’s Guide Version 9.12 357
 M
Even Header
Viewing Information about EDI Documents

Viewing Related Documents with Relationship Labels

When you view related documents, by default the screen displays the related documents
identified by their control numbers. You can override this default to display the related
documents identified by their relationship labels instead. For example, if you view
an ANSI X12 envelope, the screen displays that envelope's related group with the
relationship label Envelope - Group. To do this, set the EDIUseNewRelationshipLabel
property to true, as described below.

Note: All documents that were submied to Trading Networks before you set this
property to true will continue to be identified by their control numbers, not by
relationship labels.

Note: Relationship labels do not apply to the VDA standard.

To set the relationship label property

1. In My webMethods: Administration > Integration > B2B Settings > Configure Properties.
2. In the Module for EDI Configuration Properties section, set the
EDIUseNewRelationshipLabel property to true.
3. Click Save.
When you set this property, Module for EDI updates the configuration in memory so
the changes take effect immediately and in the WmEDI/config/properties.cnf file.
The following table lists the relationship labels of related documents.

For... If you view related documents for...

UN/EDIFACT and Envelope

all supported sub-
Related transactions are shown labeled Envelope -
standards
Transaction
Related groups are shown labeled Envelope - Group
Related functional acknowledgments (FAs) are shown
labeled Envelope - FA
Related duplicate FAs are shown labeled one of the
following:
Envelope - DUP_FA, where the FA (either sent or
received) acknowledges a document that has
already been acknowledged
Envelope - Duplicate_Doc, where the FA (either
sent or received) can acknowledge more than

webMethods Module for EDI Installation and User’s Guide Version 9.12 358
 M
Odd Header
Viewing Information about EDI Documents

For... If you view related documents for...

one identical document that has not been
acknowledged

Transaction
Related envelopes are shown labeled Envelope -
Transaction
Related groups are shown labeled Group - Transaction

Group
Related groups are shown labeled Envelope - Group
Related transactions are shown labeled Group -
Transaction

Functional Acknowledgment (FA)

Related envelopes are shown labeled Envelope - FA
If the FA is a duplicate FA, related envelopes are
shown labeled Envelope - DUP_FA and Envelope -
Duplicate_Doc

TRADACOMS Transmission
Related files are shown labeled Transmission - File
Related batches are shown labeled Transmission - Batch

Batch
Related files are shown labeled Batch - File
Related batches are shown labeled Transmission - Batch

File
Related transmissions are shown labeled Transmission
- File
Related batches are shown labeled Batch - File

Multiple-envelope Multiple-envelope documents and their child

documents documents are shown labeled Multiple Envelope -
Envelope

webMethods Module for EDI Installation and User’s Guide Version 9.12 359
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 360
 M
Odd Header
Including Documents in a Business Process

20   Including Documents in a Business Process

■ Overview ..................................................................................................................................... 362
■ Designing the Process Model .................................................................................................... 362
■ Assigning Conversation IDs to EDI Documents ........................................................................ 367
■ Sample Business Process ......................................................................................................... 369
■ Monitoring Your Business Processes ........................................................................................ 370

webMethods Module for EDI Installation and User’s Guide Version 9.12 361
 M
Even Header
Including Documents in a Business Process

Overview
Using Software AG Designer (Designer), you design a process model that describes
your business process (also called a conversation) that involves EDI documents. For an
EDI document to be involved in a business process, it must have a conversation ID.
A conversation ID is a identifier that is unique to an instance of a business process.
All documents involved in the same instance of a business process contain the same
conversation ID.
When webMethods Module for EDI (Module for EDI) receives an EDI document, it
splits the original inbound EDI document based on the EDITPA splitOption variable.
Module for EDI can split the original EDI document into Interchange, Group, and/or
Transaction documents. The Interchange, Group, and/or Transaction documents are
passed to a business process when they contain a conversation ID.
Module for EDI always assigns the Interchange and Group documents conversation
IDs. Consequently, the Interchange and Group documents are always passed to Process
Engine, which is the facility of Integration Server that executes and manages business
processes in Integration Server.
Module for EDI only assigns a conversation ID to a Transaction document if you have
created an instance ID query that identifies the value to set for the conversation ID. You
define instance ID query for specific transaction sets (for example, X12 4010 850) using
the WmEDIforTN home page.

Note: You cannot process TRADACOMS documents in a business process.

For more information about processing EDI documents in business processes, including
an illustration of how EDI documents are passed to a business process, see webMethods
Module for EDI Concepts Guide.
For more information about using process models in Designer, see the
webMethods BPM Process Development Help for your release.

Designing the Process Model

You design a process model that involves EDI documents in the same way that you
would form any process model. For more information, see the webMethods BPM Process
Development Help for your release.
Sample process models that involve EDI documents are provided in the Knowledge
Center on the Empower Product Support website at hps://empower.softwareag.com.
You can import and view the sample models in Designer.
Business processes that involve EDI documents typically only involve the Transaction
document and the level of the document for the functional acknowledgment (that is, a
Group document for ANSI X12 and an Interchange document for UN/EDIFACT).

webMethods Module for EDI Installation and User’s Guide Version 9.12 362
 M
Odd Header
Including Documents in a Business Process

When you define the process model, the first step always involves waiting for a
document. You assign an input subscription to that step to specify the type of document
for which to wait. You identify the document by its TN document type. You can set
criteria for the start document so that the process begins only if the document contains
specific information. For example, you can set criteria so that the process starts only if
the sender of the start document is a specific partner. You set the criteria by assigning a
subscribe filter to the start step.
At run time, when the document arrives, the business process begins.

Sample Process Models for ANSI X12

The following diagrams illustrate how a sender and a receiver might set up criteria and
actions for business processes involving ANSI X12 documents. See the tables after the
diagrams for more information.

Note: The steps for sender and receiver are shown in single process models to
illustrate how they interact. To establish these business processes, you create a
separate process model for each sender and receiver.

The following diagram illustrates the processing of an ANSI X12 Group document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 363
 M
Even Header
Including Documents in a Business Process

Step Description

1 The business process starts when a document (for example, SAP R/3
IDOC) is received from the sender's back-end system.

2 The sender sends an ANSI X12 Group document.

3 The sender waits for the 997 (Functional Acknowledgment).

4 The receiver business process begins when the ANSI X12 Group document
is received.

5 In response to the ANSI X12 Group document, the receiver sends the 997
(Functional Acknowledgment) back to the sender.

Following any send or wait step, partners can choose to perform optional business logic.
The following diagram illustrates the processing of an ANSI X12 850 Transaction
document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 364
 M
Odd Header
Including Documents in a Business Process

Step Description

1 The business process starts when a document (for example, SAP R/3 IDOC)
is received from the sender's back-end system.

2 The sender sends an ANSI X12 850 Transaction document.

3 The sender waits for the response document (for example, 855 PO
Acknowledgment).

4 The receiver business process begins when the ANSI X12 850 Transaction
document is received.

5 In response to the ANSI X12 850 Transaction document, the receiver sends
the response document (for example, 855 PO Acknowledgment) back to
the sender.

Following any send or wait step, partners can choose to perform optional business logic.

Sample Process Models for UN/EDIFACT

The following diagrams illustrate how a sender and a receiver might set up criteria and
actions for business processes involving UN/EDIFACT documents. See the tables after
each diagram for more information.

Note: The steps for sender and receiver are shown in single process models to
illustrate how they interact. To establish these business processes, you create a
separate process model for each sender and receiver.

The following diagram illustrates the processing of the UN/EDIFACT Interchange

document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 365
 M
Even Header
Including Documents in a Business Process

Step Description

1 The business process starts when a document (for example, SAP R/3 IDOC)
is received from the sender's back-end system.

2 The sender sends a UN/EDIFACT Interchange document.

3 The sender waits for the CONTRL message (Functional Acknowledgment).

4 The receiver business process begins when the UN/EDIFACT Interchange

document is received.

5 In response to the UN/EDIFACT Interchange document, the receiver sends

the CONTRL message (Functional Acknowledgment) back to the sender.

Following any send or wait step, partners can choose to perform optional business logic.
The following diagram illustrates processing for the UN/EDIFACT Transaction
document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 366
 M
Odd Header
Including Documents in a Business Process

Step Description

1 The business process starts when a document (for example, SAP R/3 IDOC)
is received from the sender's back-end system.

2 The sender sends a UN/EDIFACT ORDERS message.

3 The sender waits for the response message (for example, ORDERSP
receipt).

4 The receiver business process begins when the UN/EDIFACT ORDERS

message is received.

5 In response to the UN/EDIFACT ORDERS message, the receiver sends the

response document (for example, ORDERSP receipt) back to the sender.

Following any send or wait step, partners can choose to perform optional business logic.

Assigning Conversation IDs to EDI Documents

For a document to be involved in a business process, it must have a conversation ID.
This section describes how Module for EDI assigns a conversation ID to the Interchange,

webMethods Module for EDI Installation and User’s Guide Version 9.12 367
 M
Even Header
Including Documents in a Business Process

Group, and Transaction documents. The general format of a conversation ID is either of

the following:
receiverID-senderID-instanceID

senderID-receiverID-instanceID

When assigning the conversation ID, Module for EDI first aempts to assign the
conversation ID as receiverID-senderID-instanceID. It checks to see if this
conversation ID already exists and if it does, uses it, so that the document rejoins a
running business process.
If the first conversation ID does not exist, Module for EDI flips the receiverID and
senderID and uses the conversation ID senderID-receiverID-instanceID, which
should be a new conversation ID and therefore start a new business process.
The value of instanceID varies based on whether the document is an Interchange
document, Group document, or Transaction document.

Instance IDs for Interchange, Group, and Transaction Documents

The following table describes what Module for EDI uses for the instanceID portion of the
conversation ID.

Type of Document Instance ID Additional Information

Interchange Control number Module for EDI always assigns a

from interchange conversation ID to the Interchange
envelope document. The conversation ID has
one of the following formats:
receiverID-senderID-controlNum

senderID-receiverID-controlNum

Group Control number Module for EDI always assigns

from group a conversation ID to the Group
envelope document. The conversation ID has the
one of the following formats:
receiverID-senderID-controlNum

senderID-receiverID-controlNum

Transaction Value of instance Module for EDI only assigns a

ID query conversation ID if you define an
instance ID query for the transaction
set that corresponds to the Transaction
document. For example, if you
want Module for EDI to assign a
conversation ID for a Transaction

webMethods Module for EDI Installation and User’s Guide Version 9.12 368
 M
Odd Header
Including Documents in a Business Process

Type of Document Instance ID Additional Information

document that contains an X12 4010
850 transaction set, you must define
an instance ID query for an X12 4010
850 transaction. You define instance ID
queries from the WmEDIforTN home
page.

Note:This feature is deprecated in Module

for EDI. Use the procedure to set
a conversation ID as described
in "Flat File Schema Namespace
Conventions" on page 44 instead.

Instance IDs for Functional Acknowledgments

It is recommended that you use the following instance IDs for functional
acknowledgments (FAs):
For an ANSI X12 997, use ST/AK1/AK102, which corresponds to the group control
number.
For a UN/EDIFACT CONTRL message, use UCI/03, which corresponds to the
interchange control number.

Sample Business Process

The WmEDIsamples package, which you can download from the Technical community
area of the Empower Product Support website at hps://empower.softwareag.com,
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 Module for EDIINT (which
is also included in the WmEDIsamples package), set up the Module for
EDIINT sample before seing up this sample business process.

To learn about, set up, and run the sample

1. Download the WmEDIsamples package from the Technical community area of the
Empower Product Support website at hps://empower.softwareag.com

Important: Delete the WmEDIsamples package before going into production.

2. Open Integration Server Administrator if it is not already open.

webMethods Module for EDI Installation and User’s Guide Version 9.12 369
 M
Even Header
Including Documents in a Business Process

3. In the Solutions menu of the navigation panel, click EDI. Integration Server
Administrator opens a new browser window to display the Module for EDI home
page.
4. From the Module for EDI home page, in the EDI Processes menu of the navigation
panel, click Run a Demo.
To continue, follow the instructions on the home page.

Monitoring Your Business Processes

Use webMethods Monitor to monitor business processes that involve EDI documents.
For more information, see webMethods Monitor User’s Guide.

webMethods Module for EDI Installation and User’s Guide Version 9.12 370
 M
Odd Header
Non-Standard Processing

A   Non-Standard Processing
■ Overview ..................................................................................................................................... 372
■ Defining Partner Information When Using Non-Standard Processing ....................................... 372
■ Defining Control Number Information for Partners When Using Non-Standard Processing ....... 392
■ Processing Inbound EDI Documents using Trading Networks and Non-Standard
Processing ........................................................................................................................................ 395
■ Forming EDI Documents to Send Outbound When Using Trading Networks and Non-Standard
Processing ........................................................................................................................................ 397

webMethods Module for EDI Installation and User’s Guide Version 9.12 371
 M
Even Header
Non-Standard Processing

Overview
Module for EDI can process the interchange, groups, and transaction sets of an ANSI
X12 or UN/EDIFACT EDI document using either standard or non-standard processing.
For standard processing, Module for EDI processes the interchange, all its groups, and
all its transactions sets using seings that you define for the interchange sender/
receiver pair.
For non-standard processing, you can specify different processing seings for each
group within the interchange. Module for EDI processes the groups and the
transactions sets within each group using the seings you define for the group
sender/receiver pairs.
For more information about standard versus non-standard processing, see webMethods
Module for EDI Concepts Guide.
This appendix contains only information for when non-standard processing differs from
standard processing.

Defining Partner Information When Using Non-Standard

Processing
Important: This section describes how to define partner information when using non-
standard processing. It does not contain all information about defining
partner information, but only areas that are different from standard
processing. You should also read the information provided in "Defining
Trading Partner Information" on page 57.

The following table lists the information you must define for interchange and group
sender/receiver pairs that will be in the EDI documents you expect to process.

For... Define...

Interchange Interchange sender receiver pair information that you

sender/receiver set using the Module for EDI home page. For more
pairs information, see "Defining Interchange-Level Sender/
Receiver Pair Information" on page 376.

Group sender/ Trading Networks profiles for each group sender and
receiver pairs receiver. For more information, see "Defining Trading
Networks Profiles When Using Non-Standard Processing"
on page 373.

webMethods Module for EDI Installation and User’s Guide Version 9.12 372
 M
Odd Header
Non-Standard Processing

For... Define...

Relationship of All the group sender/receiver pairs that are associated

group sender/ with the interchange sender/receiver pair. You define this
receiver pairs to information using the Module for EDI home page. For more
the interchange information, see "Defining Group-Level Sender/Receiver
sender/receiver Pair Associations" on page 388.

Tailoring Default EDITPA that defines the seings that you want to
howModule for use for most partner pairs.
EDIprocesses
Partner-specific EDITPAs for group sender/receiver pairs if
documents
you want to override the seings in the default EDITPA.
For more information, see "Defining EDI Trading
Partner Agreements" on page 61. For information related
specifically to non-standard processing, see "Defining
a Partner-Specific EDITPA When Using Non-Standard
Processing" on page 374.

HowModule for Whether to validate control numbers. For more information,

EDIvalidates see "Turning Inbound Control Number Validation On or Off
control numbers When Using Non-Standard Processing" on page 393.
in documents from
Actions Module for EDI is to take when it encounters
a sender/receiver
invalid control numbers. For more information, see
pair
"Defining Actions for Invalid Control Numbers" on page
393.
Control number validation seings (control number
maximum, minimum, increment, and window). For more
information, see "Configuring Control Number Seings" on
page 126.

Defining Trading Networks Profiles When Using Non-Standard

Processing
To identify the trading partners with whom you want to exchange documents, set up
profiles. You must define profiles for:
Your own corporation if you have not already done so. This is referred to as the My
Enterprise profile in Trading Networks.
Your trading partners only at the group level.
For more information about defining Trading Networks profiles, see "Defining Trading
Partner Profiles" on page 59.

webMethods Module for EDI Installation and User’s Guide Version 9.12 373
 M
Even Header
Non-Standard Processing

Defining a Partner-Specific EDITPA When Using Non-Standard

Processing
You only need to create partner-specific EDITPAs if you have one or more sender/
receiver pairs that require seings that are different from those you specify in the
default EDITPA. When creating a partner-specific EDITPA, you have to specify only
the information that is different from the defaults. Define partner-specific EDITPAs for
group-level sender/receiver pairs.
For more information about default and partner-specific EDITPAs, see "Defining EDI
Trading Partner Agreements" on page 61. For more information about defining partner-
specific EDITPAs, see "Defining a Partner-Specific EDITPA" on page 63.

Note: You can disable partner-specific EDITPAs. When you disable a partner-
specific EDITPA, Module for EDI functions as if the partner-specific EDITPA
does not exist. That is, Module for EDI uses the values in the default EDITPA.

wm.b2b.editn.TPA:EDITPA IS Document Type When Using Non-Standard

Processing
When you create an EDITPA, you supply values for the variables in the
wm.b2b.editn.TPA:EDITPA IS document type. This section describes only the EDITPA
variables that are affected by non-standard processing. For a description of all the
EDITPA variables, see "wm.b2b.editn.TPA:EDITPA IS Document Type" on page 65.
splitOption EDITTPA Variable Default: Transaction
The splitOption variable indicates how you want the Module for EDI to split an
interchange segment with in an EDI document. You can specify Interchange, Group, or
Transaction.
When you are using non-standard processing and you specify Interchange, Module for
EDI will split the document at the Group level.
For more information, see “splitOption EDITPA Variable” in "splitOption Variable" on
page 71.
ControlNumberManagement/validateInboundEnvelopeControlNumbers EDITPA Variable Default:
false
When you are using non-standard processing, Module for EDI does not use this EDITPA
variable. Instead it uses the Validate inbound envelope control numbers seing that you set
from the Interchange Information Detail screen of Module for EDI home page.
For more information about accessing and using this screen, see "Defining Interchange-
Level Sender/Receiver Pair Information" on page 376.

webMethods Module for EDI Installation and User’s Guide Version 9.12 374
 M
Odd Header
Non-Standard Processing

ControlNumberManagement/duplicateControlNumberAction EDITPA Variable Default: Error &

Continue
The ControlNumberManagement/duplicateControlNumberAction variable indicates the
action you want Module for EDI to take when it encounters a duplicate control number
in an inbound document.
When you are using non-standard processing, this EDITPA is only used for duplicate
group control numbers. To set the action for duplicate interchange control numbers,
use the Duplicate control number action seing that you set from the Interchange
Information Detail screen of the Module for EDI home page. For more information about
accessing and using this screen, see "Defining Interchange-Level Sender/Receiver Pair
Information" on page 376.
You can specify one of the following for ControlNumberManagement/
duplicateControlNumberAction :
Error & Continue

ProcessNormally

Reject
For more information, see “ControlNumberManagement/duplicateControlNumberAction
EDITPA Variable” in "ControlNumberManagement Variables" on page 88.
ControlNumberManagement/outOfSequenceControlNumberAction EDITPA Variable Default: Error &
Continue
The ControlNumberManagement/outOfSequenceControlNumberAction variable indicates the
action you want Module for EDI to take when it encounters an out-of-sequence control
number in an inbound document.
When you are using non-standard processing, this EDITPA is only used for out-of-
sequence group control numbers. To set the action for out-of-sequence interchange
control numbers, use the Out of sequence control number action seing that you set from
the Interchange Information Detail screen of the Module for EDI home page. For more
information about accessing and using this screen, see "Defining Interchange-Level
Sender/Receiver Pair Information" on page 376.
You can specify one of the following for ControlNumberManagement/
outOfSequenceControlNumberAction :
Error & Continue

ProcessNormally

Reject
For more information, see “useReverseRoute EDITPA Variable” in "useReverseRoute
Variable" on page 92.
FAGeneration EDITPA Variables
When you are using non-standard processing, Module for EDI does not use any of the
FAGeneration EDITPA variables. Instead, Module for EDI uses the corresponding values
that you specify on the Interchange Information Detail screen of the Module for EDI

webMethods Module for EDI Installation and User’s Guide Version 9.12 375
 M
Even Header
Non-Standard Processing

home page. For more information about accessing and using this screen, see "Defining
Interchange-Level Sender/Receiver Pair Information" on page 376.

Defining Interchange-Level Sender/Receiver Pair Information

When you are using non-standard processing, Module for EDI uses the sender and
receiver identified on the group envelope header to retrieve the Trading Networks
profiles for the sender and receiver and to obtain a partner-specific EDITPA for the
sender/receiver pair, if one exists.

The group envelope header in a EDI document contains only the value for the sender
and receiver without the corresponding EDI ID qualifier code. For example, it might
contain the D-U-N-S number for the sender (186704136), but not the EDI ID qualifier
(01) that indicates that the value is a D-U-N-S number. Both the EDI ID qualifier and
the value for the partner are required for Module for EDI and for Trading Networks to
obtain the correct profiles and EDITPA to process the document.
You define interchange-level sender/receiver pair information to provide the EDI ID
qualifiers for the group level senders and receivers. Using the WmEDIforTN home page
you define the EDI ID qualifier to use for the group sender and group receiver based
on the interchange sender/receiver pair. In other words, when an EDI document has a
specific interchange sender/receiver pair, you specify the group EDI ID qualifiers that
you want Module for EDI and Trading Networks to use for the group header sender and
receiver.
Additionally, when you define the interchange-level sender/receiver pair information,
you can specify information that services you create to form outbound EDI documents
can use. Specifically, you can define the information to form the interchange headers for
outbound EDI documents.
Module for EDI stores the interchange-level sender/receiver pair information that you
define in the EDIEnvelope table, which is a Module for EDI-specific table in the Trading
Networks database.
To define interchange-level sender/receiver pair information, perform the following
procedure for each interchange-level sender/receiver pair that you expect in the EDI
documents that you want Module for EDI to process.

Tip: If you want to define information for an interchange sender/receiver pair that
is similar to a pair you have already defined, you can copy the information
for the existing pair and modify it. For instructions, see "Editing and Deleting
Interchange-Level Sender/Receiver Pair Information" on page 387.

webMethods Module for EDI Installation and User’s Guide Version 9.12 376
 M
Odd Header
Non-Standard Processing

To define information for an interchange-level sender/receiver pair

1. Open Integration Server Administrator if it is not already open.
2. In the Solutions menu of the navigation panel, click EDI. Integration Server
Administrator opens a new browser window to display the Module for EDI home
page.
3. From the Module for EDI home page, in the Partner Set Up menu of the navigation
panel, click Manage Interchange Info.
4. Click Add Interchange Information.
5. In the ID Qualifiers section of the screen, specify the following to identify a specific
interchange sender/receiver pair:

For this ID Specify...

Qualifiers field...

Sender ID The sender ID for the interchange-level sender. For

example, if the sender is identified with a D-U-N-S
number in the interchange header, specify the sender's D-
U-N-S number.

Sender Qualifier The EDI ID qualifier that corresponds to the sender ID. For
example, 01 for a D-U-N-S number.

Receiver ID The receiver ID for the interchange-level receiver.

Receiver Qualifier The EDI ID qualifier that corresponds to the receiver ID.

6. In the Envelope Information section of the screen, specify the production mode of the
documents being exchanged between the trading partners. Select Production, Testing,
or Custom.
7. In the Inbound Information section of the screen, specify the following information that
the Module for EDI uses when processing an inbound EDI document:

For this Inbound Specify...

Information field...

Create Doc Whether you want Module for EDI to save the interchange
document to the Trading Networks database when
processing a document from the interchange sender/
receiver pair defined in the ID Qualifiers section of the
screen. Specify either Yes or No.

webMethods Module for EDI Installation and User’s Guide Version 9.12 377
 M
Even Header
Non-Standard Processing

For this Inbound Specify...

Information field...

Note: If you select to save the document, Trading Networks

sets both the sender and receiver that it associates
with the saved documents as Unknown. Trading
Networks is unable to associate the actual sender and
receiver because that would require the sender and
receiver to have a profile, and when you use non-
standard processing, you do not create profiles for
interchange-level senders and receivers.

GS Sender The EDI ID qualifier that corresponds to the sender value

Qualifier on the group header in the document. Specify * (asterisk) if
you want to use the EDI ID qualifier from the interchange
header.

GS Receiver The EDI ID qualifier that corresponds to the receiver value

Qualifier on the group header in the document. Specify * (asterisk) if
you want to use the EDI ID qualifier from the interchange
header.

8. In the Inbound Information - Control Number Validation section of the screen, specify the
following seings that Module for EDI uses when validating interchange control
numbers in an inbound EDI document. For more information about how these
seings are used, see " Trading Networks Aributes and EDI Documents" on page
211.

Note: To set up control number validation for group control numbers, use the
ControlNumberManagement EDITPA variables, which are described starting
with "wm.b2b.editn.TPA:EDITPA IS Document Type When Using Non-
Standard Processing" on page 374.

For this Inbound Specify...

Control Number
Validation field...

Validate inbound Whether you want Module for EDI to verify the control
envelope control numbers in the interchange header when processing
numbers a document from the interchange sender/receiver pair
defined in the ID Qualifiers section of the screen. Specify
either Yes or No.

webMethods Module for EDI Installation and User’s Guide Version 9.12 378
 M
Odd Header
Non-Standard Processing

For this Inbound Specify...

Control Number
Validation field...

Duplicate control The action you want Module for EDI to take when it
number action encounters a duplicate control number in an interchange
header.

Select... To have Module for EDI

Error & Continue Module for EDI logs the error;

then continues to process the EDI
document that contains the invalid
control number normally.

Process Normally Module for EDI logs a warning;

then continues to process the EDI
document that contains the invalid
control number normally.

Reject Module for EDI logs the error and

does not process the document
normally. Module for EDI does not
split the EDI document. Typically,
Module for EDI splits an inbound
EDI based on the EDITPA splitOption
variable and sends the documents it
splits out to Trading Networks for
processing. However, if you select
Reject, Module for EDI sends the
document without spliing it to
Trading Networks processing rules.
Additionally, Module for EDI sets
the Trading Networks custom
aribute EDI Status as follows:
For a duplicate control number, sets
the custom aribute EDI Status to
Duplicate Control Number.
For an out-of-sequence control
number, sets the custom aribute
EDI Status to Out of Sequence
Control Number. Note that
this is for the Out of sequence
control number action field that is
described below.

webMethods Module for EDI Installation and User’s Guide Version 9.12 379
 M
Even Header
Non-Standard Processing

For this Inbound Specify...

Control Number
Validation field...

You can use the custom aribute EDI

Status in processing rule criteria. You
should create a processing rule to
handle this rejected document. For
information, see "Defining Processing
Rules to Handle Documents with
Invalid Control Numbers" on page
265.

Out of sequence The action you want Module for EDI to take when it
control number encounters an out-of-sequence control number in an
action interchange header. Select Error & Continue, Process
Normally, or Reject. For a description of these seings, see
the descriptions of the seings above for Duplicate control
number action.
You can later force processing of the out-of-sequence
document if you want. For more information, see
"Reprocessing Documents with Out-of-Sequence Control
Numbers" on page 269.

9. In the Inbound Information - FA Generation section of the screen, specify the following
information that Module for EDI uses to determine whether it should automatically
generate functional acknowledgments (FAs) for inbound EDI document and seings
for generating the FAs. For more information about automatic FA generation, see
"Automatically Generating Functional Acknowledgments" on page 275.
a. In the Auto Generate FA field, specify whether you want to turn automatic FA
generation on as follows:

Specify... To have Module for EDI...

On Always automatically generate FAs.

Per Document Automatically generate FAs based on the indicator flag in

the interchange header (ISA14 ore UNB09).

Off Never automatically generate FAs.

b. In the FA Level field, specify the level of detail that you want Module for EDI to
acknowledge in the FAs that it generates as follows:

webMethods Module for EDI Installation and User’s Guide Version 9.12 380
 M
Odd Header
Non-Standard Processing

Specify... To have Module for EDI acknowledge at the...

Default Envelope level (group for ANSI X12 and interchange for
UN/EDIFACT)

TransactionSet Transaction set level

Segment Segment level

Element Element level

Note: If you are generating FAs at the element level, be

sure to configure the maximum number of errors to
report per FA transaction. For more information, see
"Configuring the Maximum Number of Transaction
Errors" on page 172.

c. In the Process Document field, specify how you want Module for EDI to process a
transaction, group, or UN/EDIFACT interchange based on its FA status. Use this
field to define the FA statuses that are acceptable and unacceptable.
For acceptable FA statuses, Module for EDI processes a transaction, group, or
UN/EDIFACT interchange using its normal processing. For unacceptable FA
statuses, Module for EDI performs different processing.

Specify... If you want...

All Acceptable FA statuses: all statuses

Unacceptable FA statuses: no FA statuses are unacceptable

Only Acceptable FA statuses: Accepted

Accepted
Unacceptable FA statuses:
Not Allowed
Rejected
Partially Accepted
Accepted, But Errors Were Noted

Not Rejected Acceptable FA statuses:

Not Allowed
Partially Accepted
Accepted, But Errors Were Noted

webMethods Module for EDI Installation and User’s Guide Version 9.12 381
 M
Even Header
Non-Standard Processing

Specify... If you want...

Accepted
Unacceptable FA statuses: Rejected

For more information, see "Defining Actions Module for EDI Takes Based on FA
Status" on page 279.
d. In the Generate Control Number field, specify how Module for EDI is to generate the
control numbers that are used in the interchange and group headers of the FAs
that are automatically generated. Select one of the following:

Specify... To have Module for EDI...

From Inbound Use the control numbers from the corresponding headers
Document of the inbound EDI document that the FA acknowledges.

Random Randomly generate control numbers for the interchange

and group headers of the FA.

From Control Obtain the control numbers from the EDIControlNumber

Number Table table.

e. In the Syntax Error Status field, specify how you want Module for EDI to report the
syntax error status for a transaction, group, or UN/EDIFACT interchange. The
Module for EDI uses the syntax error status along with the logical error status
and child transaction rejected status (if applicable) to determine the FA status for
a transaction, group, or UN/EDIFACT interchange.

Specify... To have Module for EDI...

Rejected Report the syntax error status as Rejected if syntax errors

are encountered. Select this option if you want to reject
elements that have syntax errors.

Accepted, Report the syntax error status as Accepted, But Errors

But Errors Were Noted if syntax errors are encountered. Select this
Were Noted option if you want to know whether there are syntax
errors, but do not want to reject an element because of
them.

Accepted Report the syntax error status as Accepted regardless of

any syntax errors that might be encountered. Select this
option if you do not want to check for syntax errors.

webMethods Module for EDI Installation and User’s Guide Version 9.12 382
 M
Odd Header
Non-Standard Processing

f. In the Logical Error Status field, specify how you want Module for EDI to report
the logical error status for a transaction, group, or UN/EDIFACT interchange.
Module for EDI uses the logical error status along with the syntax error status
and child transaction rejected status (if applicable) to determine the FA status for
a transaction, group, or UN/EDIFACT interchange.
Set the status as follows:

Specify... To have Module for EDI report the logical errors as...

Rejected Rejected if they are encountered. Specify this option if

you want to reject elements that have logical errors.

Accepted, Accepted, But Errors Were Noted if they are

But Errors encountered. Specify this option if you want to know
Were Noted whether there are logical errors, but do not want to reject
an element because of them.

Accepted Accepted regardless of any logical errors that might be

encountered. Specify this option if you do not want to
check for logical errors.

g. In the Child Transaction Rejected Status field, specify how you want Module for
EDI to report the child transaction rejected status for a group or UN/EDIFACT
interchange.
The child transaction rejected status indicates whether child elements of a group
or UN/EDIFACT interchange have an FA status of "Rejected".
Specify one of the following:

Specify... To have Module for EDI...

Rejected Report the child transaction rejected status as:

Rejected if the FA status of any of the child transactions
is either Rejected or Accepted, But Errors Were
Noted.

Accepted if the FA statuses of all the child transactions

are Accepted.

Partially Report the child transaction rejected status as:

Accepted
Rejected if the FA statuses of all of the child transactions
are Rejected.
Partially Accepted if the FA status of at least one
child transaction is Accepted, but the FA status of other

webMethods Module for EDI Installation and User’s Guide Version 9.12 383
 M
Even Header
Non-Standard Processing

Specify... To have Module for EDI...

child transactions are Rejected, Accepted, But Errors
Were Noted, or both.

Accepted, But Errors Were Noted if the FA statuses

of the child transactions are Rejected, Accepted, But
Errors Were Noted, or both, and no child transactions
are Accepted.
Accepted if the FA statuses of all the child transactions
are Accepted.

Accepted, Report the child transaction rejected status as:

But Errors
Rejected if all the child transactions are Rejected.
Were Noted
Accepted, But Errors Were Noted if the FA statuses
of the child transactions are Rejected, Accepted, But
Errors Were Noted, and Accepted.

Accepted if the FA statuses of all the child transactions

are Accepted.

10. In the Outbound Information - FA Generation section of the screen, specify the following
information that Module for EDI uses to for the sender and receiver in the
BizDocEnvelope that it creates for the FA. When defining a Trading Networks
processing rule to deliver the FA, you use the BizDocEnvelope information when
defining the processing rule criteria.

For this Outbound Specify...

Information - FA
Generation field...

Sender The trading partner that you want to identify as the

sender of the FA for Trading Networks processing.

Receiver The trading partner that you want to identify as the

receiver of the FA for Trading Networks processing.

Add Group Whether to add a group to the FA.

Select... To have Module for EDI...

Yes Add a group to the FA.

No Not add a group to the FA. This is

the default.

webMethods Module for EDI Installation and User’s Guide Version 9.12 384
 M
Odd Header
Non-Standard Processing

For this Outbound Specify...

Information - FA
Generation field...

Control Number Whether to pad control numbers in the FA with leading

With Leading Zero zeros.

Yes Pad control numbers in the FA

with leading zeros.

No Do not pad control numbers with

leading zeros.

11. In the Outbound Information - Delimiters section of the screen, specify the following
information that a service you create to form outbound EDI documents can use:

For this Outbound Specify...

Information -
Delimiters field...

Segment The segment terminator for the outbound EDI document

(for example, "+"). The default is the new line character.

Field The field separator for each EDI segment (for example, !).
The default is the "*" character.

SubField The separator for composite elements (e.g, *). The default
is the ":" character.

Release The release character for the outbound EDI document (for
example, "?").

Decimal The decimal separator to use in the outbound EDI

document. If you want the outbound document to use the
European format, specify the "," character. For example,
using the European format a number would be formaed
as 100,10 (European format) instead of 100.10, as is
common in the US.

12. In the Outbound Information - Envelope Information section of the screen, specify the
following information that a service you create to form outbound EDI documents
can use to form the interchange headers:

webMethods Module for EDI Installation and User’s Guide Version 9.12 385
 M
Even Header
Non-Standard Processing

For this Outbound Specify...

Information
- Envelope
Information field...

ISA01 The value to use for the ISA01 element of an ANSI X12
interchange header in the outbound EDI document.

ISA02 The value to use for the ISA02 element of an ANSI X12
interchange header in the outbound EDI document.

ISA03 The value to use for the ISA03 element of an ANSI X12
interchange header in the outbound EDI document.

ISA04 The value to use for the ISA04 element of an ANSI X12
interchange header in the outbound EDI document.

ISA011 The value to use for the ISA11 element of an ANSI X12
interchange header in the outbound EDI document.

ISA012 The value to use for the ISA12 element of an ANSI X12
interchange header in the outbound EDI document.

ISA014 The value to use for the ISA14 element of an ANSI X12
interchange header in the outbound EDI document.

UNB01 The value to use for the UNB01 element of a UN/EDIFACT

UNB header in the outbound EDI document.

UNB06 The value to use for the UNB06 element of a UN/EDIFACT

UNB header in the outbound EDI document.

UNB07 The value to use for the UNB07 element of a UN/EDIFACT

UNB header in the outbound EDI document.

UNB08 The value to use for the UNB08 element of a UN/EDIFACT

UNB header in the outbound EDI document.

UNB09 The value to use for the UNB09 element of a UN/EDIFACT

UNB header in the outbound EDI document.

UNB10 The value to use for the UNB10 element of a UN/EDIFACT

UNB header in the outbound EDI document.

webMethods Module for EDI Installation and User’s Guide Version 9.12 386
 M
Odd Header
Non-Standard Processing

For this Outbound Specify...

Information
- Envelope
Information field...

UNB11 The value to use for the UNB11 element of a UN/EDIFACT

UNB header in the outbound EDI document.

13. Click Save Changes. Module for EDI adds the information you defined for the
interchange sender/receiver pair identified in the ID Qualifiers section of the screen to
the EDIEnvelope table in the Trading Networks database.

Editing and Deleting Interchange-Level Sender/Receiver Pair Information

At times you might want to edit, delete, or copy information of a defined interchange-
level sender/receiver pair. To display the information with which you want to work, you
first search for the interchange-level sender/receiver pair to have Module for EDI display
its information. Then you can edit, delete, or copy the information.

To edit existing Interchange-level sender/receiver pair information

1. Open Integration Server Administrator if it is not already open.
2. In the Solutions menu of the navigation panel, click EDI. Integration Server
Administrator opens a new browser window to display the Module for EDI home
page.
3. From the Module for EDI home page, in the Partner Set Up menu of the navigation
panel, click Manage Interchange Info.
4. To search for the information with which you want to work, specify one or more of
the following criteria:

For this field... Specify...

Sender ID The sender ID of the interchange-level sender/receiver

pairs that you want to display.

Sender Qualifier The EDI ID qualifier of the sender of the interchange-level

sender/receiver pairs that you want to display.

Receiver ID The receiver ID of the interchange-level sender/receiver

pairs that you want to display.

Receiver Qualifier The EDI ID qualifier of the receiver of the interchange-

level sender/receiver pairs that you want to display.

webMethods Module for EDI Installation and User’s Guide Version 9.12 387
 M
Even Header
Non-Standard Processing

For this field... Specify...

Production Mode The production mode specified in the information for the
interchange-level sender/receiver pairs that you want to
display.

Sort By How you want Module for EDI to sort the returned list of
interchange-level sender/receiver pairs.

Maximum Results The maximum number of matching interchange-level

sender/receiver pairs you want Module for EDI to return.

5. Click Search. Module for EDI displays the list of interchange-level sender/receiver
pairs that match your criteria at the boom of the screen.
6. You can edit, delete, or copy information for any of the listed interchange sender/
receiver pairs.
To edit information for an interchange sender/receiver pair, click in the Edit
column. Module for EDI displays the information for the interchange sender/
receiver pair. You can edit fields as necessary.
To delete information for an interchange sender/receiver pair, click in the
Delete column.
To copy information for an interchange sender/receiver pair, click in the
Copy column. This enables you to define information for a new interchange
sender/receiver pair that uses most of the same information as the original
interchange sender/receiver pair. Module for EDI displays the information for
the new interchange sender/receiver pair. You can edit fields as necessary.
7. If you edited or made a copy of information for an interchange sender/receiver pair,
click Save Changes to complete the procedure.

Defining Group-Level Sender/Receiver Pair Associations

You define group-level sender/receiver pair associations to associate sender/receiver
pairs at the group level with a specific interchange-level sender/receiver pair. For
example, group-level sender A and receiver B are associated with interchange-level
sender X and receiver Y.

Group sender Group receiver Interchange sender Interchange receiver

A B X Y

When you define group-level sender/receiver pair associations, you must define all the
group-level sender/receiver pairs that are associated with a single interchange-level

webMethods Module for EDI Installation and User’s Guide Version 9.12 388
 M
Odd Header
Non-Standard Processing

sender/receiver pair. A group-level sender/receiver pair can be associated with only one
Interchange-level sender/receiver pair.

Group sender Group receiver Interchange sender Interchange receiver

A B X Y

C B

D B

A C

D E X Z

D F

These associations are for use by services that you create to form outbound EDI
documents. Because you are using non-standard processing, your service will have the
group-level senders and receivers. However, to create an interchange header for the
outbound EDI document, your service requires the interchange-level sender/receiver
pair. To make a correlation between group-level sender/receiver to interchange-level
sender/receiver, your service uses the group-level sender/receiver pair associations
that you define. For example, if your service has group-level sender A and receiver B,
using the group-level sender/receiver pair associations, the service can determine that
the associated interchange-level sender/receiver pair is interchange-level sender X and
receiver Y.
After your service retrieves the interchange-level sender/receiver pair information, your
service can create the interchange headers by using the information you defined for the
interchange sender/receiver pair.
Module for EDI saves the group-level sender/pair associations in the EDIGroup
table, which is a Module for EDI-specific table in the Trading Networks database.
The EDIGroup table works together with the EDIEnvelope table, which contains
the interchange-level sender/receiver pair information that is described in "Defining
Interchange-Level Sender/Receiver Pair Information" on page 376. The following
graphic illustrates how the EDIEnvelope and EDIGroup tables work together.

webMethods Module for EDI Installation and User’s Guide Version 9.12 389
 M
Even Header
Non-Standard Processing

Use the following procedure to associate group-level sender/receiver pairs with a

specific interchange-level sender/receiver pair. You must define the information for
the interchange-level sender/receiver pair before you can associate group-level sender/
receiver pairs with it. For instructions for defining interchange-level sender/receiver
pairs, see "Defining Interchange-Level Sender/Receiver Pair Information" on page
376.

To define Group-level sender/receiver pair associations

1. Open Integration Server Administrator if it is not already open.
2. In the Solutions menu of the navigation panel, click EDI. Integration Server
Administrator opens a new browser window to display the Module for EDI home
page.
3. From the Module for EDI home page, in the Partner Set Up menu of the navigation
panel, click Manage Interchange Info.
4. To search for the interchange-level sender/receiver pair with which you want to
associate group-level sender/receiver pairs, specify one or more of these criteria:

For this field... Specify...

Sender ID The sender ID of the interchange-level sender/receiver

pairs that you want to display.

Sender Qualifier The EDI ID qualifier of the sender of the interchange-level

sender/receiver pairs that you want to display.

Receiver ID The receiver ID of the interchange-level sender/receiver

pairs that you want to display.

webMethods Module for EDI Installation and User’s Guide Version 9.12 390
 M
Odd Header
Non-Standard Processing

For this field... Specify...

Receiver Qualifier The EDI ID qualifier of the receiver of the interchange-

level sender/receiver pairs that you want to display.

Production Mode The production mode specified in the information for the
interchange-level sender/receiver pairs that you want to
display.

Sort By How you want Module for EDI to sort the returned list of
interchange-level sender/receiver pairs.

Maximum Results The maximum number of matching interchange-level

sender/receiver pairs you want Module for EDI to return.

5. Click Search. Module for EDI displays the list of interchange-level sender/receiver
pairs that match your criteria at the boom of the screen.
6. In the row for the interchange-level sender/receiver pair to which you want to
associate group-level sender/receiver pairs, click in the GS column. Module for
EDI displays the Cross Reference > GS Pairs screen that lists the interchange-level
sender/receiver pair and any existing group-level sender/receiver pairs.
7. For each group-level sender/receiver pair that you want to associate with the
interchange-level sender/receiver pair, perform the following:
a. Click Add GS Pair. Module for EDI displays the Add GS Pairs screen.
b. Specify the following about the group-level sender/receiver pair:

For this field... Specify...

Sender ID The sender ID for the group-level sender.

Sender The EDI ID qualifier for the group-level sender.

Qualifier

Receiver ID The receiver ID for the group-level receiver.

Receiver The EDI ID qualifier for the group-level receiver.

Qualifier

c. Click the Save Changes buon.

webMethods Module for EDI Installation and User’s Guide Version 9.12 391
 M
Even Header
Non-Standard Processing

Querying for Group-Level Sender/Receiver Pair Associations

At times you might want to view the group-level sender/receiver pair associations
information, for example to determine whether you already have created an association
for a group-level sender/receiver pair.

To query for existing group-level sender/receiver pair associations

1. Open Integration Server Administrator if it is not already open.
2. In the Solutions menu of the navigation panel, click EDI. Integration Server
Administrator opens a new browser window to display the Module for EDI home
page.
3. From the Module for EDI home page, in the Partner Set Up menu of the navigation
panel, click Query Envelope IDs.
4. To search for the group-level sender/receiver pair that you want to view, specify one
or more of the following criteria:

For this field... Specify

ID The sender ID or receiver ID for a group-level sender or

receiver.

Qualifier The EDI ID qualifier associated with either the group-level

sender or receiver.

Sort By How you want Module for EDI to sort the returned list of
group sender/receiver pairs.

Maximum Results The maximum number of matching group-level sender/

receiver pairs you want Module for EDI to return

5. Click Search. Module for EDI displays the list of group-level sender/receiver pairs
that match your criteria at the boom of the screen.

Defining Control Number Information for Partners When

Using Non-Standard Processing
Important: This section describes the areas of defining control number information that
is different when you are using non-standard processing. It does not contain
all information about defining control number information for partners. You
should also read the information provided in "Defining Control Number
Information for Trading Partners" on page 123.

webMethods Module for EDI Installation and User’s Guide Version 9.12 392
 M
Odd Header
Non-Standard Processing

Turning Inbound Control Number Validation On or Off When Using

Non-Standard Processing
When using non-standard processing, the way you turn validation on or off is different
for interchange control numbers and group control numbers:

Type of Control How to turn validation on or off

Number

Interchange Use the Validate inbound envelope control numbers seing on the
Module for EDI home page. For more information about how
to define this seing, see "Defining Interchange-Level Sender/
Receiver Pair Information" on page 376.

Group Use the EDITPA variable ControlNumberManagement/

validateInboundGroupControlNumbers . To turn group control
number validation:
On, set to true
Off, set to false
For more information, see “ControlNumberManagement/
validateInboundGroupControlNumbers EDITPA Variable” in
"ControlNumberManagement Variables" on page 88.

Defining Actions for Invalid Control Numbers

When using non-standard processing, you specify the actions to take for invalid
interchange and group control number in different ways as described in the table below.
For a list of the actions you can specify and a description of each action, see "Defining
Actions Module for EDI Can Take for Invalid Control Numbers" on page 136.

Type of control Duplicate or Out-of- How to define the action

number sequence

Interchange Duplicate Use the Duplicate control number

action seing on the Module for
EDI home page. For instructions for
defining this seing, see "Defining
Interchange-Level Sender/Receiver Pair
Information" on page 376.

Out-of-sequence Use the Out of sequence control number

action seing on the Module for

webMethods Module for EDI Installation and User’s Guide Version 9.12 393
 M
Even Header
Non-Standard Processing

Type of control Duplicate or Out-of- How to define the action

number sequence
EDI home page. For instructions for
defining this seing, see "Defining
Interchange-Level Sender/Receiver Pair
Information" on page 376.

Group Duplicate Use the EDITPA variable

ControlNumberManagement/
duplicateControlNumberAction .
For a list of the seings for
this EDITPA variable, see
“ControlNumberManagement/
duplicateControlNumberAction
EDITPA Variable” in
"ControlNumberManagement
Variables" on page 88.

Out-of-sequence Use the EDITPA variable

ControlNumberManagement/
outOfSequenceControlNumberAction .
For a list of the seings for this
EDITPA variable and a description
of the processing the Module
for EDI performs for each, see
“useReverseRoute EDITPA Variable” in
"useReverseRoute Variable" on page
92.

Defining the Control Number Settings

Important: This section does not provide the complete procedure for defining control
number seings. It describes the different information you must provide
when using non-standard processing. For the complete procedure, see
"Defining the Control Number Seings" on page 394.

You define control number seings for a unique combination of:

sender/receiver pair
production mode (for example, Testing for Production)
EDI standard and version
type, that is, "Envelope" or group type (for example, PO)

webMethods Module for EDI Installation and User’s Guide Version 9.12 394
 M
Odd Header
Non-Standard Processing

When defining the seings and you are using non-standard processing, you must
supply different values for the sender/receiver pair that you define in the ID Pair
Information section of the Add Control Number screen. For non-standard processing,
supply the following for the ID Pair Information fields listed below:

For this ID Pair Specify

Information field...

Sender ID The sender ID for the interchange or group.

Sender Qualifier The EDI ID qualifier associated with the sender ID, for
example, 01 to identify a D-U-N-S number.

Receiver ID The receiver ID for the interchange or group.

Receiver Qualifier The EDI ID qualifier associated with the receiver ID, for
example, 01 to identify a D-U-N-S number.

Processing Inbound EDI Documents using Trading Networks

and Non-Standard Processing
Important: This section describes how you need to set up items for inbound processing
differently when using non-standard processing. It does not contain all
information about inbound processing or seing up inbound processing.
You should also read the information provided in "Optional Inbound
Processing When Using Trading Networks " on page 257.

Before You Can Process Inbound EDI Documents

In addition to the items listed in Preparing to Receive EDI Documents in "Preparing to
Process Inbound Non-TRADACOMS Documents Using Trading Networks " on page
207, when using non-standard processing you must also define the interchange sender/
receiver pair information. For instructions on defining this information, see "Defining
Interchange-Level Sender/Receiver Pair Information" on page 376.

Variables that Affect Inbound Processing

When using non-standard processing, you must define the information for interchange/
sender receiver pairs that is described in the table below. You define this information
using the Module for EDI home page. For more information about these seings

webMethods Module for EDI Installation and User’s Guide Version 9.12 395
 M
Even Header
Non-Standard Processing

including how to define them, see "Defining Interchange-Level Sender/Receiver Pair

Information" on page 376.
In addition to the information described in this section, you must also define EDITPA
variables for group sender/receiver pairs. For information about the EDITPA variables
that you must define, see "Specifying EDITPA Variables that Affect Inbound Processing"
on page 210.

Interchange Sender/ Description

Receiver Pair
Inbound Information
Setting

Create Doc Whether you want the Module for EDI to save the
Interchange document to the Trading Networks database.

GS Sender The EDI ID qualifier to use with the sender IDs on the group
Qualifier headers.

GS Receiver The EDI ID qualifier to use with the receiver IDs on the
Qualifier group headers.

Validate inbound Whether you want Module for EDI to verify the control
envelope control numbers in the interchange header of the interchange
numbers segment that it is processing.

Duplicate control The action that you want Module for EDI to take when it
number action encounters a duplicate control number in the interchange
header of the interchange segment that it is processing.

Out of sequence The action that you want Module for EDI to take when
control number it encounters an out-of-sequence control number in the
action interchange header of the interchange segment that it is
processing.

Auto Generate FA Whether you want Module for EDI to automatically generate
FAs for an inbound EDI document. If you specify On or Per
Document for Auto Generate FA, specify the other variables in
the Inbound Information - FA Generation section.

webMethods Module for EDI Installation and User’s Guide Version 9.12 396
 M
Odd Header
Non-Standard Processing

Forming EDI Documents to Send Outbound When Using

Trading Networks and Non-Standard Processing
Important: This section describes how you need to set up items for outbound processing
differently when using non-standard processing. It does not contain all
information about outbound processing or seing up outbound processing.
You should also read the information provided in "Forming EDI Documents
to Send Outbound When Using Trading Networks " on page 289.

Before Creating the Service to Form an EDI Document

In addition to the items listed in "Before Creating the Service to Form an EDI Document"
on page 292, when using non-standard processing you must also define:
Interchange sender/receiver pair information. For instructions on defining this
information, see "Defining Interchange-Level Sender/Receiver Pair Information" on
page 376.
Group-level sender/receiver pair associations. For instructions on defining this
information, see "Defining Group-Level Sender/Receiver Pair Associations" on page
388.

Creating the Service When Using Non-Standard Processing

The following shows sample code that illustrates how to form an EDI document from
an internal-format document when using Trading Networks with Module for EDI and
when using non-standard processing.

webMethods Module for EDI Installation and User’s Guide Version 9.12 397
 M
Even Header

webMethods Module for EDI Installation and User’s Guide Version 9.12 398
 M
Odd Header
Using Module for EDI Decoupled from Trading Networks

B   Using Module for EDI Decoupled from Trading

Networks

■ Overview ..................................................................................................................................... 400

■ Configuring Module for EDI Decoupled from Trading Networks ................................................ 401
■ Preparing Module for EDI Decoupled from Trading Networks ................................................... 402
■ Creating Flat File Schemas for EDI Documents ........................................................................ 403
■ Forming EDI Documents and Sending Them Outbound ........................................................... 406
■ Example ...................................................................................................................................... 407

webMethods Module for EDI Installation and User’s Guide Version 9.12 399
 M
Even Header
Using Module for EDI Decoupled from Trading Networks

Overview
webMethods Module for EDI offers built-in services in WmEDI and WmEDIforTN
packages. The WmEDI package contains the core EDI document processing built-in
services. The WmEDIforTN package contains additional built-in services for processing
EDI documents using webMethods Trading Networks (Trading Networks).
In a distributed environment, to handle heavy EDI document processing loads, you can
configure some of your servers to do the job of just translating the EDI documents by
decoupling Module for EDI from Trading Networks. You can have a centralized Trading
Networks server for storing the transactions in your EDI network and routing the EDI
documents to your partners.
This appendix describes how to configure your EDI network nodes to use only the basic
EDI document parsing and validating services available in the WmEDI package.

Note: When you use Module for EDI decoupled from Trading Networks, you must
install Module for EDI on each Integration Server in the cluster, and each
installation must be identical. For information on running Integration Server
in a clustered environment, see the webMethods Integration Server Clustering
Guide for your release.

Using Only the WmEDI Package with Integration Server

The basic EDI engine of Module for EDI (that is, the WmEDI package) functions as a
toolkit that you can use to build your own EDI solution. Module for EDI provides the
following functionality when you use only the WmEDI package with webMethods
Integration Server:
Process most EDI standards, such as ANSI X12, VICS, UCS, UN/EDIFACT, ODETTE,
EANCOM, and VDA

Note: The WmEDI package does not support TRADACOMS document

processing.

Parse, convert, format, and validate EDI documents

Process EDI documents containing multiple interchanges/groups/transactions with
multiple versions
Generate functional acknowledgments (FAs), if they are applicable to your standard
Create envelopes for EDI documents
Transport EDI documents using the FTP, HTTP, and HTTPS protocols

webMethods Module for EDI Installation and User’s Guide Version 9.12 400
 M
Odd Header
Using Module for EDI Decoupled from Trading Networks

Configuring Module for EDI Decoupled from Trading

Networks
Before you can process EDI documents, ensure you have set up the items required for
parsing and validating EDI documents and converting documents from EDI format to
the format required by your internal applications and vice versa.
To perform these functions, Module for EDI uses flat file schemas. You create flat
file schemas that define the structure of EDI documents. Also, you can create flat file
schemas that define the structure of your internal format documents. You associate
format services with your flat file schemas that are invoked to convert field values in a
document from EDI format to the internal format, and vice versa.
The following high-level steps must be taken to create your own EDI solution.

Step Description Where to Find More Information

1 Set up Module for EDI decoupled "Preparing Module for EDI

from Trading Networks. Decoupled from Trading Networks
" on page 402

2 Create flat file schemas for EDI "Creating Flat File Schemas for EDI
documents. Documents" on page 403

3 If you want to use EDI built- "Creating Flat File Schemas for
in services to convert internal- Internal-Format Documents" on
format documents (for example, page 36
documents from a back-end
system) from IData objects to
Strings and vice versa, create a
flat file schema that defines the
structure of the internal-format
documents.

4 Configure how you want format "Configuring Format Services to

services to convert field values in Convert Field Values" on page 32
documents from EDI format to
internal format, and vice versa.

5 Specify how to associate format "Associating the EDI Format

services to fields defined in a flat Services with EDI Data Types" on
file schema for an EDI document. page 35

webMethods Module for EDI Installation and User’s Guide Version 9.12 401
 M
Even Header
Using Module for EDI Decoupled from Trading Networks

Step Description Where to Find More Information

6 Create clients to send the EDI "Creating Clients that Send EDI
documents to Integration Server. Documents to Integration Server "
on page 143

7 Create the services to process "Creating the Service the Client

your EDI documents. The Invokes to Handle EDI Documents"
WmEDI package of Module for on page 145
EDI provides built-in services
that provide the functionality
to support the EDI standard.
When you create the service that
processes your EDI documents,
you add logic to invoke the
provided built-in services.

8 Use the wm.b2b.edi.util:generateFA "Generating Acknowledgments" on

service to generate and send page 169
functional acknowledgments
(FAs) for EDI documents.

9 Form EDI documents to be sent "Forming EDI Documents and

outbound. Sending Them Outbound" on page
406

Preparing Module for EDI Decoupled from Trading Networks

To set up Module for EDI decoupled from Trading Networks, you must perform these
high-level steps:

Step Description Where to Find More Information

1 Install Module for EDI. "Installing Module for EDI "

on page 16

2 Disable WmEDIforTN and WmTN The webMethods Integration

packages. Server Administrator’s Guide
for your release.
By disabling the WmEDIforTN and
WmTN packages, Module for EDI does
not route the EDI documents to Trading
Networks for additional EDI document
processing. You can now speed up EDI
document processing by using only

webMethods Module for EDI Installation and User’s Guide Version 9.12 402
 M
Odd Header
Using Module for EDI Decoupled from Trading Networks

Step Description Where to Find More Information

the core built-in services in the WmEDI
package.

Note:The user interface in My webMethods

is not available when you disable the
WmTN package. Use the Module for
EDI home page in Integration Server
Administrator to configure Module
for EDI.

3 Define the Module for EDI properties "Defining Module for EDI
in the properties.cnf configuration Properties" on page 26
file. For handling large documents,
set an appropriate value for the
EDIBigDocThreshold property.

Creating Flat File Schemas for EDI Documents

You may need to create a flat file schema for each type of EDI transaction you want to
process. You can create an EDI flat file schema from either:
Standard Exchange Format (SEF) file
IDOC (for SAP system users)
You should create flat file schemas manually only if both of the following are true:
You are not using the Module for EDI in conjunction with Trading Networks
You are processing ANSI X12 or UN/EDIFACT documents (or documents of any
supported sub-standard)
You do not have to manually create flat file schemas from a SEF file or from an IDOC if
either of the following cases applies:
You are using Module for EDI in conjunction with Trading Networks. The flat file
schemas are created automatically for you when you use the procedure described in
"Defining TN EDI Document Types" on page 37.

Important: If you are processing documents of the TRADACOMS EDI standard, you
must use Module for EDI in conjunction with Trading Networks.

You are processing non-standard EDI formats or a user-defined format (such as a

non-EDI flat file). You must create flat file schemas from Software AG Designer using
the functionality in the WmFlatFile package instead of using one of the methods
described in "Creating Flat File Schemas for EDI Documents" on page 403. For
more information, see Flat File Schema Developer’s Guide.

webMethods Module for EDI Installation and User’s Guide Version 9.12 403
 M
Even Header
Using Module for EDI Decoupled from Trading Networks

Creating a Flat File Schema from a SEF File

Module for EDI provides the wm.b2b.edi:SEFParse service to create flat file schemas
from a SEF file. This service extracts information about the EDI document's structure,
separators, and segments from the SEF file and transfers the information to a flat file
schema.
If you want to have the wm.b2b.edi:SEFParse service automatically assign format services
to fields in the flat file template, configure the EDI format services that you want
to associate with the different data types before you create a flat file schema. For
instructions, see "Associating the EDI Format Services with EDI Data Types" on page 35.
For a description of this service, see webMethods Module for EDI Built-In Services Reference.

Note: If you are using Module for EDI in conjunction with Trading Networks, you
do not need to use the wm.b2b.edi:SEFParse service to create the flat file schema.
The flat file schemas are created automatically for you when you use the
procedure described in "Defining TN EDI Document Types" on page 37.

To create a flat file schema from a SEF file, you must perform these high-level steps:

Step Description

1 Determine where the SEF file you want to use is located, either on your
local file system or on the Web.
Many SEF files are provided with Module for EDI. When you install
Module for EDI, the installer stores each SEF file as:
WmEDI/pub/SEFs/standard /version .sef

where
standard represents the EDI standard (for example, X12) and version
represents the EDI standard version (for example, 4010).
For example:
WmEDI/pub/SEFs/X12/4010.sef

2 Create the flat file dictionary for the EDI standard and version that you are
using.

3 Invoke the wm.b2b.edi:SEFParse service from Designer. The inputs to the

service include the location of the SEF file you want to use, the EDI
transaction set (or TRADACOMS File) name, and the package name and
namespace name in which you want the service to create the schema.
The targetSchema input parameter specifies the name you want to give the
flat file schema being created.

webMethods Module for EDI Installation and User’s Guide Version 9.12 404
 M
Odd Header
Using Module for EDI Decoupled from Trading Networks

Step Description

For all supported EDI standards except TRADACOMS, use the following
naming convention for targetSchema if you plan to use Trading Networks:
EDIFFSchema.standard .Vversion :Tname

where:
standard represents the EDI standard (for example, X12), version
represents the EDI standard version (for example, 4010), and name
represents the EDI transaction (for example, 850).
For example: EDIFFSchema.X12.V4010:T850
For the TRADACOMS EDI standard, the wm.b2b.edi:SEFParse service
creates a temporary flat file schema. Use the following naming convention
for targetSchema :
EDIFFSchema.TRADACOMS.Vversion :Tname :TEMP_SCHEMA

where:
version represents the version of the TRADACOMS File document type
(for example, v2) and name represents the name of the TRADACOMS File
document type (for example, ORDHDR)
This temporary flat file schema contains all the messages
contained in the TRADACOMS file. You should then execute the
wm.b2b.edi.tradacoms.ui:modifyTradacomsSchema service to split the flat file
schema into one flat file schema per MHD segment in the TRADACOMS
file.
This temporary flat file schema will be deleted upon successful execution of
the wm.b2b.edi.tradacoms.ui:modifyTradacomsSchema service.

4 For descriptions of all the input parameters of these services, see

webMethods Module for EDI Built-In Services Reference.

5 From Designer, make changes to the flat file schema to meet your site's
needs. For example, you might want to change some of the format services
that are associated with fields or if you do not want a format service
executed for a field, remove the format service for that field.

Creating a Flat File Schema from an IDOC

Module for EDI provides the wm.b2b.edi:createIDOCtemplate service to create flat file
schemas from an SAP IDOC. This service queries the SAP system directly for the IDOC
that you want to use to create the schema. For more information about this service, see
webMethods Module for EDI Built-In Services Reference.

webMethods Module for EDI Installation and User’s Guide Version 9.12 405
 M
Even Header
Using Module for EDI Decoupled from Trading Networks

To create a flat file schema from an SAP IDOC, you must perform the following high-
level steps.

Step Description

1 Invoke the wm.b2b.edi:createIDOCtemplate service (e.g, from Designer). The

inputs to the service include the SAP server name, the IDOC name, the
IDOC version, and the package name and namespace name in which you
want the service to create the schema.
For descriptions of all the input parameters, see the descriptions of the
wm.b2b.edi:createIDOCtemplate service in webMethods Module for EDI Built-In
Services Reference.

2 From Designer, make changes to the flat file schema to meet your site's
needs. For example, you might want to assign format services to fields in
the flat file schema.

Forming EDI Documents and Sending Them Outbound

You can send documents to Integration Server from internal applications (for example,
back-end systems) and map information from them into a standard EDI format
document. The basic EDI engine of Module for EDI (that is, the WmEDI package)
provides tools that you need to create the EDI document.
The client that sends the internal-format document to Integration Server should invoke
a service that you create to form the EDI document and deliver it. This section provides
information about how to create the service to form the EDI document.
For more information about forming EDI documents to send outbound, see webMethods
Module for EDI Concepts Guide.

Validating the Input Internal-Format Document When It Is an IData

Object
The logic in the scenario described above assumes the internal-format document is
passed to your service as a String or InputStream. In this situation, you can have the
wm.b2b.edi:convertToValues service validate the document. If your client passes the internal-
format document to your service as an IData object and you want to validate the
internal-format document before converting it to an EDI document, you can replace the
logic that invokes the convertToValues service with logic that uses the pub.schema:validate
service, as shown in the following diagram.

webMethods Module for EDI Installation and User’s Guide Version 9.12 406
 M
Odd Header
Using Module for EDI Decoupled from Trading Networks

When you use the pub.schema:validate service, you must have an IS document type that
defines the structure of the internal-format document. For more information about the
pub.schema:validate service, see the webMethods Integration Server Built-In Services Reference
for your release.

Adding UN/EDIFACT Envelopes

To add the appropriate group and interchange envelopes for a UN/EDIFACT EDI
document, you invoke the wm.b2b.edi.util:addICEnvelopeEDIFACT service rather than invoke
the wm.b2b.edi.util:addGroupEnvelope and wm.b2b.edi.util:addICEnvelope services, as shown in the
following diagram.

For more information about the wm.b2b.edi.util:addICEnvelopeEDIFACT service, see

webMethods Module for EDI Built-In Services Reference.

Checking Your Work

If you want to validate the resulting EDI document envelope and check compliance
as a fail-safe measure, you can provide EDI document envelope as input to
thewm.b2b.edi:envelopeProcess service or the wm.b2b.edi.util:generateFA service. For more
information about these services, see webMethods Module for EDI Built-In Services
Reference.

Example
The Tutorial.XMLtoEDI:processXMLSource service in the WmEDIsamples package converts
an XML document into an outbound EDI (ANSI X12) document. The WmEDIsamples

webMethods Module for EDI Installation and User’s Guide Version 9.12 407
 M
Even Header
Using Module for EDI Decoupled from Trading Networks

package is located in the Knowledge Center Samples area on the Empower Product
Support website at hps://empower.softwareag.com. The samples in this folder have
been certified, meaning that they have been tested by Software AG.

Important: Delete the WmEDIsamples package before going into production.

webMethods Module for EDI Installation and User’s Guide Version 9.12 408
 M
Index

Index external ID types to Trading Networks for EDI ID

qualifiers 60
group and interchange headers to outb ound EDI
Numerics document 296
997 document, functional acknowledgment 170, UN/EDIFACT envelopes 148, 407
342 addToTradacomsTransmission service 297
advantages of
A processing document segment by segment 194
ABORTED, processing status on Transaction processing entire document at one time 193
Analysis screen 357 Agreement Details screen 63, 110
Accept FA status, FA reconciliation 345 Agreement ID, EDITPA 63, 63, 110, 111
Accept with Errors FA status, FA reconciliation 346 Agreement Status of EDITPA 62, 110
Accepted setting Alert e-mail processing rule action
Logical Error Status field 383 setting when FA status unacceptable 284
logicalErrorStatus input variable of generateFA setting when i nvalid control number 267
176 All setting
Syntax Error Status field 382 FAGeneration/processDocument EDI TPA
syntaxErrorStatus input variable of generateFA variable 81
175 FAGeneration/processDocument EDITPA
Accepted, But Errors Were N oted s etting variable 278
Syntax Error Status field 382 Process Document field 381
Accepted, But Errors Were Noted setting ANSI X12 810 document
Child Transaction Rejected Status field 384 example of iterative processing 200
Logical Error Status field 383 example of mapping 202
logicalErrorStatus input variable of generateFA ANSI X12 997 document
176 ST/AK1/AK102 instance ID 369
syntaxErrorStatus input variable of generateFA ANSI X12 document 145, 407
175 business process 362
acknowledgmen ts, functional (FAs) 275 EDI Processing Mode, custom attribute 71
acti ons, for i nvalid control numbers FA reconciliation 342
Reject 263 sample process models 363
Action, processing rule criteria 331, 332 ANSI X12 Group document
actions, for invalid control numbers FA status 345
Er ror&Continue 263 FAReconciliation 344
Error&Continue 379 ANSI X12 group envelope 170
Process Normally 263, 379 ANSI X12 interchange header 386
Reject 379 ANSI X12 standard, FA 997 document 170
activity log, viewing 351 application/EDI
Add Group field, Outbound Information - FA conte nt type 144
Generation 384 content type 157
add NewEDIVersion service 53 edidata data type 192
addi ng application/EDIstream
control number information 132 content type 144, 156
addICEnvelope edidata data type 192
addICEnvelope service 295 application/UNEDIFACT
adding content type 144, 157
control number information 128 edidata data type 192
external ID types for EDI ID qualifiers 60 application/x
-wmedisemiwrap132 content type 157

webMethods Module for EDI Installation and User’s Guide Version 9.12 409
 M
Index

-wmedisemiwrap80 content type 157 collection areas for interchanges in batch EDI
-wmediwrap132 content type 157 data 314
-wmediwrap80 content type 157 combining EDI documents in queue 313
application/X12 creating
and data type for edidata variable 192 multiple documents each with one interchange
content type 144, 157 312
applyFormat, fo rmat service 35 single document with multiple interchanges
As sig n EDI Module Specific Permiss ions in My 312
webMethods 25 delimiters
assigning conversation IDs to EDI documents 367 for collection areas 315
associating replacing to match output EDI batch data 315
custom attribute with EDI document 243 to use for batch EDI document 319
EDI format services with EDI data types 36 used when no interchange header 318
group-level sender/receiver pair 388 Deliver Document By processing action 331,
queue with scheduled delivery service 337 333
attributes delivering batch EDI document 331
system 212, 241 erro r, IS document published 321
Trading Networks 211 example of sorting documents to be batched 315
Attributes variable in pipeline 228, 250 Execute a Service processing action 332, 332,
Auto Generate FA field 380 332
automatic generation of FAs 276 extracting and sorting transactions from
documents
B so they can be batched 313
back-end systems 290 steps for 313, 316
batch and transmission headers failure notification, setting publishBatchFailEvent
control numbers for outbound EDI documents variable 321
291 headers
batch control number group in batch EDI document 321
validating 114 interchange in batch EDI document 321
batch criter ia EDITPA variable 93 when no interchange header in documents to
batch criteria E DI TPA variable 95 be batched 316
batch criteria EDITPA variable 93, 93, 97 prerequisites to batching when using Trading
Batch documents, TRADA COMS Networks 326
system attribute 241 private queues, why not to use 331
Batch documents, TRADACOMS processing rule to deliver batch EDI document
DocumentID system attribute 241 331
GroupID system attribute 241 recombining transactions to form batch EDI
viewing 354 document 321
batch headers setting up how to batch 329
control numbers, validating 114 subcollection areas for groups in batch EDI data
validating batch control numbers 114 314
batchcriteria EDITPA variable 96 task status, updating for document included in
batching batch 313, 317
and FA reconciliation 322 viewing progress of 357
and UNAmode EDITPA variable 74 wm.b2b.editn.batch
BizDocEnvelope for final batch EDI document batchProcess service 312, 327
322 Before you Begin 401
bi zdoc variable
in pipeline 250

webMethods Module for EDI Installation and User’s Guide Version 9.12 410
 M
Index

bizdoc variable codes, validation 184

in pipeline 228 coding services to process Transaction and Group
output for c reateEDIBizDoc service 307 documents 226, 249
bizdoc/Attributes/EDI Processing Mode variable collection are as for batching
231, 234 delimiters
BizDocEnvelope when no interchange header 318
for final batch EDI document 322 collection areas for batching
in pipeline 228, 250 definition 314
service to create for outbound EDI document 307 delimiters
boundary characters of mainframe EDI documents associated with 319
157 associated with d efault col lection area 318
business process compliance che ck
ANSI X12 documents, sample process models wm.b2b.edi
363 envelopeProcess service 198
defined 362 compliance check 198
EDI documents, Transaction document 362 for EDI documents, description 198
monitor 370 for processing document iterative ly 205
UN/EDIFACT documents, sample process variable of envelopeProcess service 199
models 365 complianceCheck variable for wm.b2b.edi
envelopePr oc ess service 199
C con trol number window
cap, control number definition 127
default 127 concat en ating
defining 126 transaction contents with its header and trailer
definition 127 into a String 197
set ting 132 concatenating
setting 128 ISA05, ISA06, and GS02 fields 68
Check for Duplicate Document pre-processi ng ISA07, ISA08, and GS03 fields 68
action configuration file
setting when invalid control number 267 properties.cnf 26
Check for Duplicate Document pre-processing properties.cnf, EDI Module 109, 164, 172, 346,
action 225, 247 358
child t ransa ct ion rejected status sample-proper ties.cnf 26
description 176 configuring
child transaction rejected st atus EDI Module for large document handling 164
and FA status for UN/EDIFACT i n t erchange File Polling listener port 154
180 how to convert fi eld values in documents 33
child transaction rejected status maximum number of transaction errors 172
and FA status for group 179 Configuring the EDI Module for Load Balancing in
Child Transaction Rejected Status field 383 an EDI Network 402
client content of EDI document, viewing 355
application/EDI stream 144 content type
content type 144 and edidata variable 192
content type to send EDI documents to TN 156 application/EDI content type 144, 157
FTP 151 application/EDIstream 144, 156
HTTP 149 application/UNIEDIFACT 144, 157
Integration Server that submits the documents to application/X12 144, 157
Trading Networks 156 application/x-wmedisemiwrap132 157
application/x-wmedisemiwrap80 157

webMethods Module for EDI Installation and User’s Guide Version 9.12 411
 M
Index

application/x-wmediwrap132 157 Reject 263, 379

application/x-wmediwrap80 content type 157 adding inform ation 132
boundary characters of mainframe EDI adding information 128
documents 157 cap
File Polling 161 default 127
non-mainframe EDI document 156 defining 126
of client to send EDI documents to TN 156 definition 127
Content type field, File Polling listener port 153 defining
CONTRL message, functional acknowledgment settings 126, 128, 132
170, 342 determining whether valid 258
control num ber window duplicate
example of using to determine out-of-sequence defining action for 137, 137, 138
260 definition 259, 259
control num bers reprocessing documents with 268
validation user status of document 264
interchange cont rol numbers 89 group headers 258
control numb ers increment
out-of-sequence default 126
definition 260 defining 126
control number cap definition 126
Control Number Cap field 131 interchange headers 258
default 127 invalid and EDITPA splitOption variable use 263
defining 126 minimum
definition 127 default 127
setting 128, 132 defining 126
Control Number field 131 definition 127
control number increment next expected 126
Control Number Increment field 131 obtaining for outbound processing 296
default 126 obtaining for outbound processing,
defining 126 TRADACOMS 297
definition 126 outbound EDI documents 291
setting 128, 132 out-of-sequence
control number minimum defining action for 137, 137, 138
Control Number Minimum field 131 reprocessing documents with 268
default 127 service to reprocess documents with 270
defining 126 user status of document 264
definition 127 processing rule to handle i nva lid control number
setting 128 265
control number window searching for 138
Control Number Window field 131 setting initial value 128, 132
default 127 val idation
defining 126 transmission control numbers 113
example of using to determine duplicate 259 validation 258
setting 128, 132 batch control numbers 114
control numbers file control numbers 114
actions when invalid group control numbers 89
Error&Continue 263, 379 turning on or off 132
Proces s Normally 263 window
Process Normally 379 default 127

webMethods Module for EDI Installation and User’s Guide Version 9.12 412
 M
Index

defining 126 profiles 107

definition 127 service
example of using to determine duplicate 259 form EDI document 144, 406
example of using to determine out-of- process EDI documents, prerequisites 192
sequence 260 Creating a Service to process the EDI Docume nt
controlNumber input variable 306 144
controlnumber minimum Creating a Service to process the EDI Document
setting 132 144
ControlNumberManagement criteria, processing rules 223, 246
duplicateControlNumberAction EDITPA var iable batch EDI documents 331
89 deliver batch EDI document 332
duplicateControlNumberAction EDITPA variable document with invalid control number 266
90, 375 outbound FA 281
outOfSequenceControlNumberAction EDITPA Cross Reference GS Pairs screen 391
variable 375 ctlFromTable variable 296, 297
useReverseRouting EDITPA variable 92 custom attribu tes
validateInboundEnvelopeControlNumbers EDI FA Sta tus 217
EDITPA variable 89 custom attributes
use during outbound processing 299 defined 211, 240
validateInboundGroupControlNumbers EDITPA defining processing r ule 222
variable 83, 87, 87, 89, 91 defining processing rule 245
use during outbound processing 300 EDI Group Type 215
conversation ID EDI Outbound FA 215
assigning to EDI documents 367 processing rules outbound FAs 282
business process, instance of 362 EDI Processing Mode 70, 215
instanceID 367, 368 EDI Status 215, 265
ConversationID system attribute 212, 213 processing rules for documents with invalid
conversations 362 control numbers 266
defined 362 processing rules for documents with
converting unacceptable FA statuses 283
EDI documents to IData objects iteratively 166 EDI Vers ion 216
field values 32, 33 Envelope Cnt rlNum Status 216
segment or group of segments to IData object Envelope CntrlNum Status 242
203 Group CntrlNum Status 216, 242
unparsed section to IData object 204 setting value at run time 221, 244
XML document into, example of 145, 407 that EDI Module sets 214, 242, 265
convertToValues service Transaction CntrlNum Status 242
convertToValues service 197 Custom Mode
Create Doc field 377, 396 and ISA015 field of ANSI X12 document 71
creating envelope information 377
client to Integration Server 144 processingMode variable 70
custom document attributes for EDI documents customizing
243 EDI flat file schema for iterative processing 199
customized services to connect to other VANs services to connect to other VANs 340
340
flat file schema D
for internal-format documents 36 Data Status of EDITPA 62, 110
from SAP IDOC 406 De liver Document By pro cessi n g ac tion
FTP client 151

webMethods Module for EDI Installation and User’s Guide Version 9.12 413
 M
Index

outbound FA 282 interchange-level sender/receiver pair

Decimal field 385 information 387
default delimiters 385
EDITPA 62, 65, 109 batching EDI documents 319
defining 62 defaults used in batching when cannot be
defining when using TRADACOMS 110 retrieved from other sources 320
modifying 62 EDITPA variable 328
modifying when using TRADACOMS 110 outbound EDI documents 291
FTP port 9021 151 used in batch EDI documents 315
pre-processing settings 225, 247 wm.b2b.editn.batch
Default setting batchProcess service 328
FA Level field 381 delimiters/field EDITPA varia ble 75
defin ing delimiters/record EDITPA variable 75, 88, 95, 98,
processing rule to 99, 99, 99
process document with invalid control number delimiters/release EDITPA variable 76
265 delimiters/subfield EDITPA variable 75
defining Deliver Document By processing action 226, 248
control number settings 128, 132 delivering batch EDI document 332
custom document attributes for EDI documents delivering EDI documents to VANs 339
243 processing rule criteria 331, 333
default EDITPA 62 scheduled delivery queue 312
default EDITPA when using TRADACOMS 110 viewing information about EDI documents in
group-level sender/receiver pairs 388 queues 357
interchange-level sender/receiver pairs 376 delivering
for non-standard processing 376 EDI d o cument
partner information for directly from service that forms it 298
non-standard processing 372 EDI document
standard processing 58, 106 methods available 297
partner-specific EDITPA 63, 374 routing via Trading Networks 304
partner-specific EDITPA when using submitting to Trading Networks 298
TRADACOMS 110 Delivery Service
process model 363 public queue setting 330, 338
processing rule to delivery tasks
batch EDI documents 331 scheduled delivery queue 357
deliver EDI documents to VANs 339 statuses for batch EDI documents 320
deliver final batch EDI document 331 diagram of
proce ss outbound FAs 281 batching documents
process document with invalid control number example of collection and subcollection areas
282 314
process inbound EDI documents 245 multiple batch documents each with single
use custom attribut e as cri teria 222 interchange 324
use custom attribute as criteria 245 MULTIPLEOUTPUTS batching 324
profiles 59, 107, 373 one batch docu me n t with multiple
scheduled delivery queues 330 interchanges 322
determining number of queues 329 scheduled delivery queue to hold documents
to deliver EDI documents to VAN 337 315
Defining EDI Module Properties 26 SINGLEOUTPUT batching 322
deleting transactions sorted into collection areas 316

webMethods Module for EDI Installation and User’s Guide Version 9.12 414
 M
Index

control numbers in ANSI X12 ISA, GS, and ST digital signature, Verify Digital Signature pre-
headers 212 processing action 225, 248
del ivering outbound EDI document 305 Disable FA status, FA reconciliation 73, 345
delivering outbound EDI document disabling FA reconciliation 73
delivering from the service that forms it 298 disadvantages of
drop variables after invoking wm.tn.doc.xml processing document segment by segment 194
304 processing entire document at one time 193
setting scope to prepare to execute routeXml do cTypeName variable 252
service 303 docID variable 229, 229, 229, 251, 251, 252
submitting back to Trading Networks 302 DocResxxxxx.dat, large file naming 165
form ing outbound EDI document docTypeID variable 229, 229, 230, 251, 252, 252
service to create a Biz DocEnvelope 307 docTypeN ame variable 229
forming outbound EDI docume nt docTypeName variable 229, 230, 251, 252
limiting pipeline elements to execute the docum ents
routeXml service 303 in ternal-format 36
forming outbound EDI document document IDs
drop variables after invoking wm.tn.doc.xml FA reconciliation 344
304 Document T ype 223
pipeline after setting scope for the INVOKE Document Type
routeXml flow operation 303 processing rule critiera 223, 246
saving output from the addICenvelope service documentation
302 using effectively 13
setting scope to prepare to execute routeXml DocumentID
service 303 system attribute 212, 212, 241, 241, 306
when using non-standard processing 397 variable in pipel ine 250
when using standard processing 293 variable in pipeline 228
generating FAs documents
invoking generateFA before invoking EDI 401
envelopeProcess 181 DONE processing status on Transaction Analysis
inbo und EDIdo cument screen 356
process ing Transact ion document 230 DONE W/ ERRORS processing status on
inbound EDI document Transaction Analysis screen 356
processing entire document at one time 195, DUNS external ID type, Trading Networks 60
406 Duplicate control number action field 379, 393, 396
processing iteratively, segment by segment duplicate control numbers
203 defining action for 137, 137, 138
processing Transaction document 253 reprocessing documents with 268
processing transactions in a Group document user status 264
232 Duplicate FA status, FA reconciliation 345
Process Model Illustrati ng Proc essing of Duplicate FA/Errors status, FA reconciliation 345
UN/EDIFACT Transa ction document 365,
366 E
Process Model Illustrating Processing of EANCOM variables
ANSI X12 850 Transaction document 364 autoGenerateAUTACK 101
ANSI X12 Group document 363 EANCOMAUTACK/configuration
UN/EDIFACT Interchange document 365 characterSetEncoding 103
reprocessing documents with out-of-sequence digestAlgorithm 102
control numbers 270 paddingAlgorithm 103

webMethods Module for EDI Installation and User’s Guide Version 9.12 415
 M
Index

signingAlgorithm 103 process inbound 245

signingScope 102 reconciling with FAs 342
EANCOMAUTACK/processInboundAUTACK 102 sending to Integration Server 144
EANCOMAUTACKn/configuration using File Polling 153
filteringAlgorithm 103 submitting to Trading Networks 156
ED I TPA summary information 228, 251
delimiters viewing
record variable 99 related documents 358
ED ITPA variables viewing content 355
IChe aderInfo/ISA/I SA11 87 viewing on Transaction Analysis screen 354
EDI Bat ch delivery service 330 ways to process 193
EDI Batch custom attri bute EDI FA Status custom attribute 217
associating with batch EDI do cument 331 EDI Group Type custom attribute 215
EDI Batch custom attribute EDI ID qua lifier
Interchange value 332 Receiver Qualifier 395
processing rule criteria 332 EDI ID quali fier
EDI content type 153 Sender Qualifier 142
EDI data types, associating with format services 35 EDI ID qualifier
EDI doc u ments adding external ID types for 60
batching, prerequisites 326 adding external ID types to Trading Networks 60
EDI documents 75 and partnersd5 external ID 59, 107
and splitOption variable 71 and Trading Networks 60
and Trading Networks attributes 211, 240 envelopeIdentifier/receiver/qualifier variable 77
associating custom attributes with 243 envelopeIdentifier/sender/ID variable 76
combining those to be batched 313 for D-U-N-S number as external ID type 60
configuring how to convert field values 33 GS Receiver Qualifier 378, 396
conversation IDs 367 GS Sender Qualifier 378, 396
converting to IData objects iteratively 166 Receiver Qualifier 141, 377, 387, 391, 391
creating ReceiverQualifier 130
flat file schema for 403 Sender Qualifier 129, 377, 387, 390, 391, 395
from internal-format document 144 EDI Module
service to form outbound 406 content handler 144, 153
service to form outbound, prerequisites for 292 Conversatio nID system attribute 212
flat file schema that defines structure 403 custom attributes 214, 242, 265
forming outbound using standard processing 293 DocumentID system attrib ute 212
information you can access for outbound 291 DocumentID system attribute 212, 241, 241
large 166 EDI FA Status custom attribute 217
logic to include in service to EDI Group Type custom attribute 215
form EDI document 145 EDI Outbound FA custom attribute 215
process EDI documents 193 EDI Processing Mode custom attribute 215
process EDI documents iteratively 202 EDI Status custom attribute 215, 265
outbound 290 EDI Version custom attribute 216
processing inbound Envelope CntrlNum Status custom attribute 216,
entire document at one time 181, 193, 194 242
segment by segment 182, 193, 199 Group CntrlNum Status custom attribute 216,
using Trading Networks 208, 238 242
processing rule GroupID system a ttribute 241
process document with invalid control number GroupID system attribute 212, 213, 241
265, 282 home page

webMethods Module for EDI Installation and User’s Guide Version 9.12 416
 M
Index

adding interchange sender/receiver pair Processed 216, 216

information 377 processing rules for documents with invalid
defining group-level sender/receiver pair control numbers 266, 282, 283
associations 390 EDI TPA
deleting interchange sender/receiver pair definition 109
information 387 EDI Trading Partner Agreement 61, 109
EDI Processes menu 370 EDI Version custom attribute 216
editing interchange sender/receiver pair EDIControlNumber table 296, 297, 297
information 387 settings contained in 126
Manage Interchange Info 377, 387, 390 use 135
Partner Set Up menu 377, 387, 390, 392 EDICOR server log key 350
Query Envelope IDs 392 edidata pipeline va riable
querying for group-level sender/receiver pair generating FAs 182
associations 392 edidata pipeline variable 144
Run a Demo 370 and application/X12 content type 192
run demo of EDI documents in a business and content type 192
process 370 application/EDI 192
server log 350 application/EDIstream 192
system attributes 212, 241 application/UNEDIFACT 192
Transaction CntrlNum Status custom attribute file polling 153
242 generating FAs 181
EDI Outbound FA custom attribute 215 inputs for service 192
EDI Processes menu of EDI Module home page non-mainframe EDI documents 156
370 EDIEnvelope table 376, 389
EDI Processing Mode custom attribute 70, 215, EDIFFSchema folder 37, 44
231, 234 EDIFTN server log key 350
Testing 232, 235 EDIGroup table 389
EDI recogni zer EDIMaxFATransactionErrors configuration property
parsing EDI document 228 172
EDI recognizer EDITPA
and FAReconciliation EDITPA variable 299 bat ch criteria variable 93
and Trading Networks 208, 238, 298, 298 batc h criteria variable 96
group level split 299 batch criteria variable 93, 93, 95, 97
parsing EDI document 251 Contro lNumber Management
EDI standards validateInboundGroupControlNumber s
adding support for new versions 53 variable 87
EDI Status cu stom attribute ControlNumbe rManagement
Generate FA - Partially Accepted 280 validateInboundEnvelopeControlNumbers va
EDI Status custo m attribute 89
Generate FA - Rejected 280 ControlNumberManagement
EDI Status custom attribu te duplicateControlNumberAction variable 89,
values for invalid control numbers 265 90, 375
EDI Status custom attribute 215, 265 outOfSequence ControlNumbe rAction
Duplicate Control Number 265 variable 375
Generate FA - Accepted, But Errors Were Noted useReverseRouting variable 92
280 validateInbound GroupControlNumbers
Generate FA - Not Allowed 280 variable 83
how set 215 validateInboundGroupControlNumbers
Out of Sequence Control Number 265 variable 87, 89, 91

webMethods Module for EDI Installation and User’s Guide Version 9.12 417
 M
Index

default 62, 109 duplicateControlNumberAction variable 114

definition 61 outOfSequenceControlNumberAction variable
delimiters 115
field variable 75 validateInbo undBatchControlNumbers
record variable 75, 88, 95, 98, 99, 99 variable 114
release variable 76 validateInboundBatchControlNum bers
subfield variable 75 variable 116
envelopeIden tifier validateInboundBatchControlNumbers variable
sender/qualifier variable 76 116, 117, 117
envelopeIdentifier validateInboundFileControlNumbers variable
receiver/ID variable 77 114
receiver/qualifier variable 77 validateInboundTransmissionControlNumbers
sender/ID variable 76 variable 113
FAGener ati on TRADACOMS/enforceApplicationReference
rejectionRules/logicalErrorStatus variable 85 variable 116
FAGeneration TRADACOMS/splitOption variable 112
autoGenerateFA variable 80 TRADACOMS/storageOption variable 113
FALevel variable 80 Trading Networks Console 63
generateControlNumber variable 82 UNAmode variable 74
processDocument variable 81 wm.b2b.editn.TPA
rejectionRules/childTransactionRejectedStatus EDITPA IS doc ument type 112
variable 85 EDITPA IS docum e nt ty pe 65
rejectionRules/syntaxErrorStatus variable 84 EDITPA v ariables
FAReconciliation variable 72 delimiters/field 75
GSRouting EDITPA va riables
receiverQualifier variable 69 ICheaderInfo/ISA/ISA11 87
routingMode variables 67 EDITPA variab les
senderQualifier variable 68 ICheaderInfo/ISA/ISA11 86
ICheaderIn fo EDITPA variables
UNB/UNB06 variable 79 BatchCriteria 93, 93, 96, 97
ICheaderInfo delimiters 328
GS/GS07 variable 79 delimiters/record 75, 88, 95, 98, 99, 99, 99
ISA/ISA01 variable 78 delimiters/release 76
ISA/ISA02 variable 78 delimiters/subfield 75
ISA/ISA03 variable 78 envelope Identifier/sender/qualifier 76
ISA/ISA04 variable 78 envelopeIdentifier/receiver/ID 77
ISA/ISA11 variable 78, 86, 87, 87, 87, 87, 87 envelopeIdentifier/receiver/qualifier 77
UNB/UNB01 variable 79 envelopeIdentifier/sender /ID 76
UNB/UNB08 variable 79 FAGene ration/rejectionRules/logicalErrorStatus
IS Document Type 63, 64, 110, 111 85
My webMethods 63, 111 FAGeneration/autoGenerateFA 80
partner-specific 62, 62, 62, 109 FAGeneration/FALevel 80
persistMultipleDocEnvelop evariable 69 FAGeneration/generateControlNumber 82
persistMultipleDocEnvelope variable 117 FAGeneration/processDocument 81
processingMode variable 70, 231, 234 FAGeneration/rejectionRules/
publishBatchFailEvent variable 74, 118 childTransactionRejectedStatus 85
routingMode variable 67 FAGeneration/rejectionRules/syntaxErrorStatus
splitOption variable 71, 374 84
TRADACOMS/ControlNumberManagement FAReconciliation 72, 322, 343

webMethods Module for EDI Installation and User’s Guide Version 9.12 418
 M
Index

GSRouting/receiverQualifier 69 envelopeProcess service 196

GSRouting/routingMode 67 Error FA status, FA reconc iliation 345
GSRouting/senderQualifier 68 Error&Continue setting
ICh eaderInfo/GS/GS07 79 action when invalid control number 263
ICh eaderInfo/ISA/ISA11 78 ControlNumberManagement
ICheaderInfo 329 duplicateControlNumberAction EDITPA
ICheaderInfo/ISA/IS A11 87 variable 375
ICheaderInfo/ISA/ISA01 78 outOfSequenceControlNumberAction EDITPA
ICheaderInfo/ISA/ISA02 78 variable 375
ICheaderInfo/ISA/ISA03 78 Duplicate control number action field 379
ICheaderInfo/ISA/ISA04 78 Out of sequence control number action field 379
ICheaderInfo/ISA/ISA11 87, 87 errors
ICheaderInfo/UNB/UNB01 79 array and generateFA service 182
ICheaderInfo/UNB/UNB06 79 convertToValues service 146
ICheaderInfo/UNB/UNB08 79 FA transaction 173
processing with Trading Networks 210, 240 maximum number to report per FA transaction
processingMode 70 172
publishBatchFailEvent 74, 118, 321, 328 recognition 224, 247
splitOption 71, 374 variable in th e Bi zD ocEnvel ope, 248
TRADACOMS/enforceApplicationReference 116 variable in the BizDocEnvelope, 225
TRADACOMS/splitOption 112 wm.b2b.edi
TRADACOMS/storageOption 113 convertToValues 234
UNAmode 74, 328 envelopeProcess service 233
wm.b2b.editn.batch wm.pub.flow
batchProcess service 328, 328 debugLog service 233
EDITRACKING table Errors variable in pipeline 228, 250
FAReconciliation 344 example of
updates during batching EDI documents 322 ANSI X12 810 document, looping 200
EDIUseNewRelationshipLabel flag, setting 358 ANSI X12 document, mapping 202
Element setting conventions for VANs 339
FA Level field 381 converting XML document into outbound EDI
elements (ANSI X12) document 145, 407
definition in SEF file 35 EDI Module setting system attributes 212
enabling FA reconciliation 343 input variables for
encoding input variable 306 pub.client 150, 152, 158
endTradacomsTransmission service 297 sampleServices 205, 205, 206
Envelope CntrlNum Status custom attribute 216, service that sets attribute values at run time 221,
242 244
envelope validation, wm.b2b.edi Tutorial.EDItoXML
envelopeProcess service 198 processEDI850_4101 service 206
envelopeDocuments variable 228, 229, 251, 251 Execute a Service processing action 221, 225,
envelopeIdentifier/receiver/ID E DIT PA varia b le 244, 248
77 batch EDI document 332
envelopeIdentifier/receiver/qualifier EDITPA delivering batch EDI do cument 332
variable 77 FA status unacceptable 284
envelopeIdentifier/sender/ID EDITPA variable 76 invalid control number 267
envelopeIdentifier/sender/qualifier EDITPA variable outbound FA 282
76 processing inbound EDI document 209, 238
envelopeProcess service

webMethods Module for EDI Installation and User’s Guide Version 9.12 419
 M
Index

Extended Criteria for processing rules 224, 247, use during outbound processing 300
331, 332 FALevel ED ITPA variable 80
external ID types generateControlNumber EDITPA variable 82
and GSRouting variables 67 processDocument EDITPA variable 81
defined 60 rejectionRules/childTransactionRejectedStatus
DUNS (Trading Networks) 60 EDITPA variable 85
for EDI ID qualifiers 60 rejectionRules/logicalError Status EDITPA
Mutually-Defined (Trading Networks) 60 variable 85
external IDs rejectionRules/syntaxErrorStatus EDITPA
and GSRouting variables 67 variable 84
when defining profiles 59 fail delivery task status 320
external IDs, TRADACOMS false, setting
when defining profiles 107 FAReconciliation EDITPA variable 344
externalFormatString, format service 34 isEnabled format service 34
FAReconciliation EDIT PA variable
F and splitOption value 71
FA Er rors, FA reconciliation 346 FAReconciliation EDITPA variable 72, 343
FA Level field 380 and batching 322
FA reconciliation 343 and EDI recognizer 299
and batching 322 FAs
disabled 73 997 documents 170, 342
enabled 343 autom a tic generation of FAs
statuses in report 345 steps to generate 284
FA s tatus es automatic generation of FAs
FA reconciliation report generated FA description 183
FA Errors 346 how EDI Module processes documents based
FA statuses on FA status 279
acceptable 277 setting up 276
FA reco nciliation report turning on or off 277
Reject 346 automatically generating 275
FA reconciliation report child tran saction rejected status, determining
Accept 345 176
Accept with Errors 346 child transaction
Disable 73, 345 whether allowed in group 174
Duplicate 345 whether any rejected 176
Duplicate FA/Errors 345 configuring maximum number of transaction
Error 345 errors 172
Interchange Received 346 CONTRL message 170, 342
None 345 errors, configuring maximum number to report
Partially Allowed 346 172
how generateFA service determines 173 FA statuses, acceptable 277
processing rule to handle documents with un FA statuses, unacceptable 277
acceptable 282 FAReconciliation 344
unacceptable 277 gene rating
values of, in EDITRACKING Table 345 FAs when processing documents iteratively
FAGeneration segment by segment 182
addGroup EDITPA variable 83 generated FA description 183
autoGenerateFA EDITPA variable 80 generating
FAs automatically 275

webMethods Module for EDI Installation and User’s Guide Version 9.12 420
 M
Index

FAs manually 170 SAP IDOC 405

FAs when processing documents all at one customizing
time 181 iterative processing 199
instance IDs for 369 with Trading Networks 37
logical error status, determining 176 defining
Not Allowed, determining status 174 EDI document structure 403
output from wm.b2b.edi.util internal-format document structure 192
generateFA service 183 EDIFFSchema folder 37, 44
prerequisites for generating 172 format services 32, 35
processing rule to process outbound 281 naming convention 405
reconciliation with EDI documents 342 SEF file and wm.b2b.edi
service for creating 170 SEFParse service 35
status 345 TN document type 44
status of FA, determining status 175 Trading Networks 32
syntax error status, determining 175 with multiple consecutive HL segments 45
through Trading Networks 342 fo rmatserv ices
validation codes 184 in ternalFormatString setting 34
wm.b2b.edi.util format services
generateFA service 170 applyFormat setting 35
Field field 385 associating with
field separator 385 EDI data types 35
in outbound EDI document 75 fields in flat file schema 32
field values converting field values 32
how to convert 33 defined 32
file control number externalFormatString setting 34
validating 114 flat file schemas 35
File documents, TRADACOMS format.xml configu ration file
DocumentID system attribute 241 entries 33
GroupID system attribute 241 format.xml configuration file
sample code for 252, 254 associating EDI format services with EDI data
system attribute 241 types 35
viewing 354 From Control Number Table setting of Generate
file headers Control Number field 382
control numbers, validating 114 From Inbound Document setting of Generate
validating file control numbers 114 Control Number field 382
File Pol ling FTP client
to submit documents to Trading Networks 160 creating 151
File Polling logic to include 151
listener port 154 non-mainframe EDI documents 156
non-mainframe EDI documents 156 wm.tn
wm.tn. receive service 157
receive service 157 FTP listening port 159
File Polling listener port 153, 153, 161 FTP method
flat file schemas port 8021 151
creating for submitting EDI documents 151
each type of EDI document 45, 403 to IS FTP port 151
internal-format document 36 to Trading Networks via FTP port 159
creating from functional acknowledgments (FAs) 170
IDOC 405

webMethods Module for EDI Installation and User’s Guide Version 9.12 421
 M
Index

Execute a Service processing action 227

G GroupID system attribute 213
Generate Control Number field 382 GS Only variable 67
generateFA service GS&ISA variable 68
generateFA service 170 instance IDs 368
generating OFF variable 68
functional ackn owledgmen ts (FAs) sample code for 232
automatically 275 system attribute 212
functional acknowledgment s (FAs) viewing 354
turning automatic generation on or off 277 group envelopes
functional acknowledgments (FAs) interchange-level sender/receiver pair 376
by invoking generateFA service 180 wm.b2b.edi.util
prerequisites to invoking generateFA service addGroupEnvelope service 147
172 Group Type field
interchange headers in batch EDI document 329 control number setting 130, 140
getEDIstr i ng service group type, determining based on transaction type
getEDIst 197 318
getFromVAN service Group, splitOption va riable
getFromVAN service 336 processing Group document 232
getReport input variable to getFromVAN service Group, splitOption variable
336 outbound processing of EDI documents 299
getTspace service setting up Trading Networks to deliver EDI
getTspace service 230 document 301
group groupDocuments variable 229, 251
and interchange headers 291 GroupID sys tem attribute 241
control numbers GroupID system attr ibute 213
compliance check 199 GroupID system attribute 212, 241, 306
validating 89 group-level sender/receiver pairs 388
counts, compliance che ck 199 and interchange-level sender/receiver pair 388
envelopes 376 partner information to define 58
FA status of FA 175 viewing 392
FA status, determining 179 grpCtlNumber variable 297
of segments, converting to IData object 203 GS Receiver Qualifier field 378, 396
sender and receiver pairs 388 GS Sender Qualifier field 378, 396
group and interchange headers GSRo uting/routingMode
adding to o u tbound EDI document 296 and GSRouting/senderQua lifier 68
control numbers 258 GSRoutin g/routing Mode EDITPA variable 67
control numbers for outbound EDI documents GSRouting/receiverQualifier EDITPA variable 69
291 when routingMode is GSOnly 69
fina l batch EDI document 321 GSRouting/routingMode
validating group control numbers 89 and GSRouting/receiverQualifier 69
validating inte rchange control numbers 89 GSRouting/routingMode EDITPA variable 67
Group CntrlNum Status custom attribute 216, 242 senderQualifer variable 68
Group documents GSRouting/senderQualifier EDITPA variable 68
ANSI X12 business process 362 when routingMode is GSOnly 68
ANSI X12 FA reconciliation 342
conversation ID 214, 362 H
DocumentID system attribute 212

webMethods Module for EDI Installation and User’s Guide Version 9.12 422
 M
Index

HL segments, multiple consecutive HL segments validating internal-format document 406

with same name 45 IData objects
home page, EDI Module conv erting
EDI Processes menu 370 EDI transaction set to 197
Manage Interchange Info 377, 387, 390 converting 32
Par tner Set Up menu 387 EDI documents to 166
Partner Set Up menu 377, 390, 392 internal-format document to String format 198
Query Envelope IDs 392 creating from EDI documents 203
Run a Demo 370 group of segments converting to 203
HTTP client segment converting to 203
logic to include 149 unparsed section converting to 204
non-mainframe EDI documents 156 validating internal-format document 148
requirements for 149 IDOC
wm.tn flat file schema from 403, 405
receive service 157 using to create flat file schemas 405
HTTP method in creme nt, control num ber
and EDI line break omission 150 defin ing 126
submitting EDI documents to IS 149 in ternal-format documents
HTTP POST method 149, 150 con verting 36
to wm.tn inbound EDI documents
receive service 158 and FA reconciliation 72
HTTPS client and generating FAs 170
non-mainframe EDI documents 156 control number validation 135
wm.tn flat file schemas to parse and validate 32
receive service 157 Inbound Information - Control Number Validation
fields 378
I Inbound Information - FA Generation fields 380
ICC.NET VAN 336 Inbound Information fields 377
ICheaderInfo EDITPA variable, wm.b2b.editn.batch non-standard processing 210, 240
batchProcess service 329 processing rules 222, 245
ICheaderInfo/GS/GS07 EDITPA variable 79 processing using Trading Networks 208, 238
ICheaderInfo/IS A/ISA11 EDITPA variable 86 retrieving from VAN 336
ICheaderInfo/ISA/ ISA01 EDITP A variable 78 sample logic for processing 194
ICheaderInfo/ISA/ISA0 3 EDITPA variable 78 standard processing 210, 240
ICheaderInfo/ISA/ISA02 EDITPA variable 78 variables for pro cessing 210
ICheaderInfo/ISA/ISA04 EDITPA variable 78 variables for processing 240
ICheaderInfo/ISA/ISA11 ED ITPA variable 87 Inbound Information fields 377
ICheaderInfo/ISA/ISA11 EDITPA variable 78, 87, Control Number Validation 378
87, 87, 87 FA Generation 380
ICheaderInfo/UNB/UNB01 EDITPA variable 79 increment, control number
ICheaderInfo/UNB/UNB06 EDITPA variable 79 default 126
ICheaderInfo/UNB/UNB08 EDITPA variable 79 definition 126
ICValues variable 182 setting 128, 132
ID Quali fiers 377 Initialization Service, EDITPA 64, 111
ID Qualifiers input variables
Receiver ID 377, 387, 390, 391 controlNumber 306
Sender ID 377, 387, 390, 391 createEDI B izDoc Service 305
IData obj ects ctlFromTable 297
encoding 306

webMethods Module for EDI Installation and User’s Guide Version 9.12 423
 M
Index

getReport 336 conversation ID 214, 362

grpCtlNumber 297 DocumentID system attribute 212
oneBatchQueue 312, 322 Execute a Service processing act ion 227
illustration of MULTIPLEOUTPUTS setting 324 Execute a Service processing action 227, 227
illustration of SINGLEOUTPUT setting 322 GroupID system attribute 213
OutboundEDIDoc 306 GS Only variable 67
pub.client instance IDs 368
ftp service 152 OFF variable 68
http service 150, 158 system attribute 212
receiver 306 UN/EDIFACT business process 362
receiverID 316, 317, 318, 320, 324 UN/EDIFACT FA reconciliation 342
receiverIDQualifier 316, 317, 320, 324 viewing 354
receiverQualifier 306 interchange envelopes
saveInboundToTN 336 creating batch EDI document with multiple 312
sender 306 creating batch EDI document with one 312
senderID 316, 317, 318, 320, 324 persistMultipleDocEnvelope EDITPA variable 69
senderIDQualifier 316, 317, 320, 324 validation 198
senderQualifier 306 for processing document iteratively 205
standard 306 wm.b2b.edi
VAN envelopeProcess service 198
VANConnectivity 339 wm.b2b.edi.util
VAN.VANConnectivity addICEnvelope service 147
getFromVAN service 336 interchange headers
wm.b2b. edi.util batching when not headers not present in
generateFA service 181 documents 316
wm.b2b.edi control numbers 258
envelopeProcess service 198 control numbers, validating 89
wm.b2b.editn.batch final batch EDI document 321
batchProcess service 327 information for outbound EDI document 291
InputStream Interchange Received FA status, FA reconciliation
application/EDI stream content type 144, 156, 346
192 interchange segments, splitOption variable 71
converting to IData object 197 interchange sender/receiver pairs
Install the webMethods EDI Module 16 and group-level sender/receiver pairs 388
instance ID 368 defining 376
FAs 369 defining for non-standard processing 376
Group document 368 editing and deleting 387
Interchange document 368 partner information to define 58
query 362 settings that affect inbound processsing 395
Transaction document 368 Interchange setting, splitOption EDITPA variable
int e rchange se gments, splitOption variable 374 outbound processing of EDI documents 299
Integration Server setting up Trading Networks to deliver EDI
client 144 document 300
sending EDI documents to for processing 144 interchanges, UN/EDIFACT
interchange contro l number FA status, determining 180
compliancecheck 199 interconnectivity to another VAN 340
interchange control number internal-f o rmat documents
valida ting 89 creati ng
Interchange documents flat file schema s for 36

webMethods Module for EDI Installation and User’s Guide Version 9.12 424
 M
Index

internal-format documents iterator variable

converting from IData object to String object 198 converting EDI do cuments to IData objects
creating iteratively 166
EDI document from 144 processing document segment by segment 199
flat file schema that defines structure 192
IData object 148, 198, 406 K
mapping keys, server log 350
data to format 193
information from line item segments into, L
example of 202 large documents
setting up Trading Networks to process 290 and the EDI Module configuration file 165
internalFormatString, format service 34 iterator variable, convertToValues service 199
Invalid structure 138 memory constraints 166
invoking processing 166
services to add group and interchange headers using Trading Networks 164
297 services in WmEDI package 164
wm.b2b.edi.util with Trading Networks 165, 165
generateFA service after wm.b2b.edi 182 wm.b2b.edi
generateFAservice before wm.b2b.edi 181 envelopeProcess service 165
wm.tn.do c.xml LateFA/LateFATime EDITPA Variable 98
routeXml service 302 line breaks, omitting from EDI documents 150
IS document t ypes logging information
wm.tn.rec activity log 350
BizDoc Envelope IS 250 server log 350
IS document ty pes logic to include in
EDITPA 63 FTP client 151
IS document types HTTP client 149
EDITPA 64, 110, 111 sample to process
for internal-format document structure 145 inbound EDI document 194
wm.b2b.editn.rec Transaction document 230
batchFailDocument 321 service
wm.b2b.editn.TPA that Execute a Service action invokes 226,
ED ITPA 63 249
EDITPA 64, 65, 110, 111, 112 to form EDI document 145
wm.tn.rec to process E DI documents 193
BizDocEnvelope IS 228 to process EDI document iteratively 202
IS documents to validate internal-format document befor e
converting to 32 converting to EDI document 406
ISA01 field 386 to validate internal-format document before
ISA011 field 386 converting to EDI document 148
ISA012 field 386 service that forms the EDI document to route it
ISA014 field 386 through Trading Networks 305
ISA02 field 386 service that forms the EDI document to submit it
ISA03 field 386 to Trading Networks 302
ISA04 field 386 logical error status
iteratively and FA status for group 179
converting documents to IData objects 166, 167 and FA status for transaction 178
processing document, segment by segment and FA status for UN/E DIFACT interchange 180
182, 193, 199

webMethods Module for EDI Installation and User’s Guide Version 9.12 425
 M
Index

description 176 None FA status, FA reconciliation 345

Logical Error Status field 383 non-standard EDI formats, and flat file schema 403
looping non-standard processing
sample code for processing entire inbound EDI defined 372
document at one time 196 defining interchange-level sender/receiver pairs
376
M partner information to define 372
mapping sample code for forming document 397
ANSI X12 812 document, example of 202 sender/receiver pairs 376, 388
data Not Rejected setting
to format an internal-format document 193 FAGeneration/processDocument EDITPA
when using addICEnvelope service 295 variable 82, 278
Maximum Results Process Document field 381
group-level sender/receiver pairs 388, 391, 392 nt
MCI VAN 336 generating FAs
memory constraints, large documents 166 invoking generateFA when processing an
minimum, control number inbound document iteratively, segment by
default 127 segment 183
defining 126 number of scheduled delivery queues 329
definition 127
setting 128, 132 O
Modifiable Data Status of EDITPA 62, 110 Off setting
modifying default EDITPA 62 Auto Generate FA field 380
modifying default EDITPA when using On setting
TRADACOMS 110 Auto Generate field 380
monitoring business process 370 oneBatchQueue input variable 322
Monitoring Directory field 153 description of settings 312
MULTIPLEOUTPUTS illustration of SINGLEOUTPUT setting 322, 324
illustration 324 MULTIPLEOUTPUTS 312
oneBatchQueue variable 312 null 312
Mutually-Defined external ID type, Trading SINGLEOUTPUT 312
Networks 60 Only Accepted setting
My webMethods FAGeneration/processDocument EDITPA
creating default EDITPA when using variable 81, 278
TRADACOMS 110 Process Document field 381
creating EDITPA 111 ou tbound EDI documents
modifying default EDITPA when using release character 76
TRADACOMS 110 Out of sequence control number action field 380,
393, 396
N outbound ED I documents
namespace convention composite elements sep arator 75
flat file schema control numbers 136
ANSI X12, UN/EDIFACT 44 outbound EDI documen ts
namespace directory (ns) 151 created by batching feature 74
NEW processing status on Transaction Analysis outbound EDI documents
screen 356 adding group and interchange he a d ers to 296
no n-standard processing and FA reconciliation 72
settings for interchange sender/receive pairs 395 and queue 337

webMethods Module for EDI Installation and User’s Guide Version 9.12 426
 M
Index

BizDocEnvelope 305
built-in services to form 291 P
control numbers 296 packages
control numbers, TRADACOMS 136, 297 WmEDI 192, 402
delimi t ers/record variable 75 WmEDIsamples 196
delimiters/record variable 88, 95, 99 WmFlatFile 34
delivering Partial ly Accepted setting
delivery methods 297 Child Transaction Rejected Status field 383
directly from service that forms it 298 Partially Accept FA status, FA reconciliation 346
to VANs 336 partner information
field separator 75 non-standard processing 372
flow service examples 145, 407 standard processing 58, 106
receiver ID and envelopeIdentifier/sender/ID Partner Set Up menu of EDI Mo dule home page
variable 77 392
routing through Trading Networks 304 Partner Set Up menu of EDI Module h ome page
segment terminator 75 377
sender ID and envelopeIdentifier/sender/ID Partner Set Up menu of EDI Module home page
variable 76 387, 390
sending to Trading Networks from internal partner-specific EDITPA 62, 62, 62, 65, 109
applications 290 defining 63, 374
submitting back to Trading Networks 298 defining when using TRADACOMS 110
variables for processing 299 Per Document setting
variables for processing TRADACOMS Auto Generate FA field 380
documents 300 PERL scripts 149
wm.b2b.editn persistMultipleDocEnvelope EDITPA variable 69,
trackEDIdocs service to record in 117
EDITRACKING table 72 persistOriginalEnvelope EDITPA Variable 96, 97
Outbound Information pipeline
Deli miters field 385 after setting scope for the INVOKE routeXml flow
Envelope Information fie ld 386 operation 303
FA Generation fields 384 Attributes variable 228, 250
OutboundEDIDoc input variable 306 bizdoc var iable 250
out-of-sequence control numbers bizdoc variable 228
defining action for 137, 137, 138 BizDocEnvelope 228, 250
definition 260 diag ram of, after setting scope for INVOKE
reprocessing documents with 268 routeXML flow operation 303
service to reprocess documents with 270 diagram of, after setting scope for INVOKE
user status 264 routeXML flow operation 303
outputs DocumentID variable 228, 250
bizdoc variable 307 edidata variable 144
from wm.b2b.edi.util Errors variable 228, 250
generateFA service 183 information in that your service can access 250
overriding pr e-processing settings with processing information inthatyour service can access 228
rule settings 225 using scope to temporarily limit pipeline variables
overriding pre-processing settings with processing 303
rule settings 247 port
Overview 16, 16, 21 8021 for FTP 151
File Polling listener 161

webMethods Module for EDI Installation and User’s Guide Version 9.12 427
 M
Index

FTP listening 159 profiles 107

number 5555 150, 158 customizing the EDI flat file schema for iterative
of URL service to process EDI docum ent 150 processing 199
POST an EDI document to defining
aservice 150 control number settings 128
wm.tn group-level sender/receiver pair associations
receive service 158 390
Pr oduction Mode information for interchange-level sender/
control number information 130 receiver pair 377
pre-processing actions processing rule 223, 246
default 225, 247 scheduled delivery service for delivering EDI
when invalid control number 267 documents to VANs 338
prerequ isites for editing and deleting interchange-level sender/
batching EDI documents receiver pair information 387
using Trading Networks 326 mod ifying default EDITPAs 63
cre ating service to modifying default EDITPAs when using
form EDI documents 292 TRADACOMS 110
prerequisites for querying for existing group-level sender/receiver
creating service to pair associations 392
form EDI documents 144 searching for existing control numbers 139
process EDI documents 192 to run sample busines process 369
generating functional acknowledgments (FAs) viewing
172 EDI documents using Trading Networks
proc essing EDI documents Console 356
using Trading Networks 209 information about queued EDI documents 357
processing EDI documents 16, 21 server log 350
using Trading Networks 24, 239 Trading Networks activity log 351
private queues 331 proces sing rules
proced ures and EDI Pr oc essin g Mode custom attributes 70
defining Process Document field 278, 381
control num ber se ttings 132 process models 362
procedures defining 363
adding Process Normally setting
control numb er information 132 action when invalid control number 263
control number information 128 Duplicate control number action field 379
external ID types to Trading Networks for EDI Out of seq u en c e control number action field
ID qualifiers 60 379
associating processing
custom attribute with EDI document 243 EDI documents 401
EDI format services with EDI data types 36 Group docume nts, sample code 232
configuring inbound EDI documents using Trading Networks
EDI Module for large document handling 164 208, 238
how to convert field values in documents 33 internal-forma tdoc uments with Trading
maximum number of transaction errors 172 Networks 290
creating iteratively 199
customized services to connect to other VANs large documents 166
340 using Trading Networks 164
flat file schema from a SAP IDOC 406 non-standard 372
partner-specific EDITPA 63 standard 372

webMethods Module for EDI Installation and User’s Guide Version 9.12 428
 M
Index

TRADACOMS File documents, sample code setting values of attributes at run time 221, 244
252, 254 Trading Networks 208, 238
Transaction document, sample code 230 use custom attribute as criteria 222, 245
processing actions 225, 248 Processing Service field 154
documents with unacceptable FA statuses 284 processingM ode EDI TPA variable 70
outbound FA 282 ProcessNormally setting of
when invalid control number 267 ControlNumberManagement
processing EDI documents duplicateControlNu mberAction EDITPA variable
entire docum e nt at one time 375
advanta ges of 193 outOfSequenceControlNumberAction EDITPA
entire document at one time 181, 193, 194 variable 375
disadvantages of 193 Production Mode
sample code 194 and IMB11 field of UN/EDIFACT document 71
inbound document iteratively 202 and ISA015 field of ANSI X12 document 71
iteratively, segment by segment 182, 193, 199 control number information 140
prerequisites 21 custom attribute 232, 235
with Trading Networks 24 envelope information 377
segment by segment 182, 193, 199 group-level sender/receiver pairs 391
advantages of 194 interchange-level sender/receiver pairs 388
disadvantages of 194 processingMode variable 70
using Trading Networks, prerequisites 209, 239 profiles
ways to 193 creating 107
processing rules 208, 238 defining 59, 107, 373
and GSRoutin g var iables 67 properti es.cnf file, EDI Module
and Trading Networks attributes 211, 240 EDIResolveDuplicates property 346
batching properties.cnf file, EDI Module
EDI documents 331 EDIMaxFATransactionErrors property 172
criteria 223, 246 properties.cnf file, Trading Networks
outbou nd FA 281 tn.tspace.location property 165, 165
when invalid control number 266 tn.tspace.max property 165, 165
deliver EDI documents to VANs 339 tn.tspace.timeToLive property 165, 165
delivering batch EDI document 331 Proposed, EDITPA Agreement Status 62, 110
documents with unacceptable FA statuses 282 pub.client
Ex ecute a Service action ftp service 152, 159
inbound EDI documents 238 http service 149
Execute a Service action 221, 244 example of, with wm.tn 158
inbound EDI documents 209 pub.io
overriding pre-processing settings 225, 247 streamToBytes service
pre-processing actions when invalid control processing File documents 255
number 267 pub.list
process document with invalid control number appendToD ocumentList service
265, 282 processing File documents 254
process inbound EDI documents 245 pub.schema
process outbound FAs 281 validate service 148, 406
processi ng actions pub.string
when invalid control number 267 bytesToString service
processing actions 225, 248 processing File documents 255
documents with unacceptable FA statuses 284 stringToBytes service 307
outbound FA 282 public queue

webMethods Module for EDI Installation and User’s Guide Version 9.12 429
 M
Index

associated with scheduled deliver service 337 receiverIDQua lifier input variable 320
public scheduled delivery queue 312 receiverIDQualifier input variable 316, 317, 324
settings 330, 338 receiverQualifier input variable 306
VANs 337 Recognition Errors processing rules critieria 224,
publishBatchFailEvent EDITPA variable 74, 118, 247
321, 328 Reject FA status, FA reconciliation 346
Reject setting
Q action when invalid control number 263
Qualifier for group-level sender/receiver pairs 392 Cont r olNumberManag ement
querying for existing group-level sender/receiver outOfSequenceControlNumberActi on EDITPA
pair associations 392 variable 375
Queue Name 330, 338 ControlNumberManagement
QUEUED processing status on Transaction duplicateControlNumberAction EDITPA
Analysis screen 356 variable 375
queues Duplicate control number action field 379
private 331 Out of sequence control number action field 379
scheduled 312 Rejected setting
Child Transaction Rejected Status field 383
R Logical Error Status field 383
Random setting logicalErrorStatus input variable of generateFA
Generate Control Number field 382 176
Re ceiver ID Syntax Error Status field 382
adding control numb er information 140 syntaxErrorStatus input variable of generateFA
rec eiverID input variable 317 175
rece iver related documents flag, setting 358
Interchange, Group, T ransac tion documents 67 release character 76
receiver Release field 385
and GSRouting/routingM ode variable 67 requirements for
input variable for createEDIBizDoc Service 306 HTTP client 149
interchange-level 376 submitting EDI documents to Trading Networks
Receiver via HTTP 158
EDIT PA 63 trading pa rtner relationships, met in EDITPA 62
EDITPA 64, 110, 111 trading partner relationships, met in EDITPA 110
processing rule critieria 223, 246 retrieving inbound EDI documents from a VAN 336
Receiver field, Outbound Information - FA routing outbound EDI documents through Trading
Generation 384 Networks 304
Receiver ID routingMode variable 67
adding control number information 130, 140, run time, setting values of custom attributes 221,
395 244
group-level sender/receiver pairs 390, 391
interchange-level sender/receiver pairs 377, 387 S
Receiver Qualifier sample
adding control number informat ion 130 business process 369
adding control number information 141, 395 code 194
group-level sender/receiver pairs 391, 391 process models 369
interchange-level sender/receiver pairs 377, 387 sample code
receiverID inp ut variable 320 creating service when using non-stand ard
receiverID input variable 316, 318, 324 processing 397

webMethods Module for EDI Installation and User’s Guide Version 9.12 430
 M
Index

delivering outbound EDI document from service creating flat file schema from 403
that forms it 298 flat file schema a nd wm.b2b .edi
forming EDI document using standard SEFParse service 35
processing 293 segment
processing converting to IData object 203
entire document at one time 194 counts, complia nce che ck 199
inbound EDI document iteratively 202 processing document by 182, 193, 199
Transaction document 230 Segment field 385
processing Group document 232 Segment setting
routi ng EDI document through Trading Networks FA Level field 381
305 segment terminator in outbound EDI document 75
routing EDI document through Trading Networks selecting
305 EDI documents to view on the Transaction
submitting outbound EDI document back to Tr Analysis screen 356
ading Ne two rks 302 processing rule, criteria 331, 332
sample process models sender
ANSI X12 documents 363 and GSRouting/routingMode v ariable 67
UN/EDIFACT Interchange documents 365 input variable for createEDIBizDoc service
sampleServices service 306
Iterator810 service 206 interchange-level 376
UNEDIFACTToValues 196 Sender
UNEDIFACTtoValues service 205 EDITPA 63, 64, 110, 111
X12toValues service 205 processing rule criteria 223, 246
SAP IDOC 403, 405 Sender field, Outbound Information - FA Generation
files 405 384
Save Document to Database pre-pr ocessing action Sender ID
225 adding control number information 129, 141,
Save Document to Database pre-processing action 395
247 group-level sender/receiver pairs 390, 391
EDI documents 354 interchange-level sender/receiver pairs 377, 387
setting when invalid control number 267 Sender Qualifi er
saveInboundToTN, input variable to getFromVAN adding control number information 129
service 336 Sender Qualifier
Schedule, scheduled delivery queue 330 adding control number information 142, 395
scheduled delivery queues group-level sender/receiver pairs 390, 391
batching 312 interchange-level sender/receiver pairs 377, 387
defining 330 senderID input variable 316, 318, 320, 324
delivery task 357 senderID input variables 317
number to define 329 senderIDQualifier input variable 316, 317, 320, 324
VANs 337 senderQualifier input variable 306
viewing information about EDI documents in sending
queue 357 EDI documents to Integration Server 144
scheduled delivery service associated with public using File Polling 153
queue 337 outbound document to Trading Networks from
se nder internal applications 290
Interchange, Group, Transaction documents 67 separator
searching for control numbers 138 composite elements 75
security header information 291 field 75
SEF file ser vic es

webMethods Module for EDI Installation and User’s Guide Version 9.12 431
 M
Index

wm.b2b.edi.tradacoms.compose 255 wm.b2b.edi.tradacoms.compose 255, 255, 297,

serv ices 297, 297, 297
wm.b2b.editn.TPA 65 wm.b2b.edi.tradacoms.doc 253, 253, 253, 254
server log 350 wm.b2b.edi.util 147, 147, 147, 148, 149, 170,
keys 350 181, 197, 204, 233, 295, 296, 296, 296, 296,
viewing 350 302, 407
services wm.b2b.editn 72, 230, 232, 298, 305, 305, 307
check envelope compliance 198 wm.b2b.editn .util 254
create wm.b2b.editn.batch
BizDocEnvelope and add outbound EDI batchProcess service 312, 327
document 305 wm.b2b.editn.T PA 112
flat file schemas from SAP IDOCs 405 wm.b2b.editn.TPA 64, 111, 294
customized to connect to another VAN 340 wm.b2b.editn.util.reprocess 268, 268, 270, 273,
EDI Batch delivery service 330 274
EDI Module, validate EDI envelopes 198, 198 wm.b2b.util.documentList 254
form EDI document 406 wm.tn
format 32 receive service 157, 158
getFromVAN service 336 wm.tn.doc 309, 310
Initialization Service for EDITPA 64, 111 wm.tn.doc.xml
large document in WmEDI package 164 routeXml service 302, 302, 304
processing 232, 235 wm.tn.doctype
Transaction and Group documents 226, 249 view service 308
pub.client 149, 152, 159 wm.tn.route
pub.io 255 routeBizdoc service 305
pub.list 254 Set In puts
pub.schema public queue setting 338
validate service 148, 406 Set Inputs
pub.string 255 public queue setting 330
stringToBytes service 307 setting up
sampleServices 205, 205, 206 File Polling 154
set attribute values at runtime 221, 244 to batc h EDI documents 329
to process EDI documents when using File Trading Networks to deliver EDI document bas
Polling 154 ed on splitOption variable 300
Tutorial.EDItoXML 206 Trading Networks to process in ternal-format
Tutorial.XMLtoEDI 145, 407 documents 290
validate EDI envelopes 198 settings
VAN.VANConnectivity 336, 337 applyFormat (of format serv ice) 35
wm .b2b.editn.batch externalFormatString (of format service) 34
batchProcess service 331 for interchange sender/receiver pairs 395
wm.b2 b .edi 32 internalFormatString (of format service) 34
wm.b2b.e di.util 407 isEnabled (of format service) 34
wm.b2b.edi 33, 35, 146, 149, 165, 166, 167, name (of format service) 34
195, 197, 198, 199, 203, 231, 231, 233, 234, public queue 330, 338
293, 294, 404, 405, 407 SINGLEOUTPUT
convertToValues service 234 illustration 322
wm.b2b.edi.tradacoms 32, 33 oneBatchQueue variable 312
convertToString service 294 Sort By
convertToValues service 254, 293 group-level sender/receiver pairs 391, 392
interchange-level sender/receiver pairs 388

webMethods Module for EDI Installation and User’s Guide Version 9.12 432
 M
Index

specifying Accept 345

pre-proces sing actions when invalid control Accept with Errors 346
number 267 Disable 345
processing actions 225, 248 Duplicate 345
documents with unacceptable FA statuses 284 Duplicate FA/Errors 345
outbound FA 282 FA Errors 346
when invalid control number 267 Interchange Received 346
processing rules criteria 223, 246 None 345
outbound FA 281 Partially Accept 346
when invalid cont rol number 266 Reject 346
spli tOption EDITPA variable processing rule to handle documents with
and FAReconciliation 71 unacceptable 282
splitOption EDITPA variable 71, 374 unacceptable 277
and Trading Networks 208 String
business process 362 application/EDI content type 192
documents saved to Trading Networks database application/UNEDIFACT content type 192
354 application/X12 content type 192
Execute a Service processing action 226 converting
not used when invalid control number 263 EDI document to 144, 157
outbound processing of EDI documents 299 internal-form document from IData object to
possible values 71 String format 198
processing rule for inbound EDI documents 223 to IData object 197
use during outbound processing 299 SubField 385
st ruc tu re submitting EDI documents
of element definition 35 FTP method 151
ST/AK1/AK102 instance ID 369 HTTP method 149
Standard Exchange Format (SEF) file 403 to Trading Networks
Standard field, Control Number Infor mation 130 File Polling 160
Standard field, Control Number Information 142 FTP method 159
standard input variable 306 HTTP method 158
standard processing HTTPS method 158
defined 372 My webMethods method 161
forming EDI document, sample code 293 to deliver it 298
partner information to define 58, 106 success delivery task status 320
turning control number validation on or off 132 sy stem attributes
startTradacomsBatch service 297 GroupID 213
startTradacomsTransmission service 297 syntax error stat us
statuses and FA status for transaction 178
delivery tasks associated with documents being syntax error status
batched 320 and FA status for group 179
FA 345 and FA status for UN/EDIFACT i nterchange 180
processing, view on Transaction Analysis screen description 175
356 Syntax Error Status field 382
statuses ,FA system attributes
FA reconciliation report ConversationID 213
Error 345 defined 211, 240
statuses, FA DocumentID 212, 241, 306
acceptable 277 GroupId 306
FA reconciliation report GroupID 241

webMethods Module for EDI Installation and User’s Guide Version 9.12 433
 M
Index

that EDI Module sets 212, 241 Trading Networks 208, 238
User Status 224, 247 ac tivity log 350
and EDI recognizer 208, 238, 298, 298
T database 354, 354
targetSchema 404 delivering EDI document
Tasks page 357 Group splitOption variable 301
Testing Mode Interchange splitOption variable 300
and IMB11 field of UN/EDIFACT document 71 delivery tasks and batching EDI documents 313,
and ISA015 field of ANSI X12 document 71 317, 320
custom attribute 232, 235 DocumentID system attribute 212, 241
envelope information 377 DUNS external ID type 60
processingMode variable 70 EDIFFSchema folder 37, 44
TN document types EDITPA variables 210, 240
assigning custom document attributes to 243 FAs 342
flat file schema 44 flat file schemas 32
Trading Networks processing 208, 238 GroupID system attribute 212, 241
tn.tspace.location configuration property 165 large document handling 164
tn.tspace.max configuration property 165 Mutually-Defined external ID type 60
tn.tspace.timeToLive configuration property 165 processing EDI documents 156
TPA 61, 109 processing inbound EDI documents 208, 238
tr ansmission headers providing EDI ID qualifiers 60
control num bers, validating 113 public queue 337
TRADACOMS EDI documents routing outbound EDI documents through 304
adding outbound envelopes and obtaining submitting documents to via File Polilng 160
control numbers 297 TN document types 208, 238
and storageOption variable 113 Trading Networks attributes 211
TRADACOMS/ControlNumberManagement and EDI documents 211, 240
duplicateControlNumberAction EDITPA variable custom attributes 211, 240
114 system attributes 211, 240
outOfSequenceControlNumberAction EDITPA Trading Networks Console
variable 115 creating default EDITPA 63
validateInboundBatchControlNumbers EDITPA creating EDITPA 63
variable 114, 116, 116, 117, 117 profiles, creating 107
validateInboundFileControlNumbers EDITPA trading partners
variable 114 creating profiles 107
validateInboundTransmissionControlNumbers defining profiles 59, 373
EDITPA variable 113 transact ionDocument variable 252
TRADACOMS/enforceApplicationReference transaction
EDITPA variable 116 control numbers, compliance check 199
TRADACOMS/splitOption EDITPA variable 112 counts, compliance check 199
and Trading Networks 238 FA status of FA 175
documents saved to Trading Networks database FA status, determining 178
354 Not Allowed FA status 174
Execute a Service processing action 248 Transaction CntrlNum Status custom attribute 242
processing rule for inbound EDI documents 245 Transaction docume nts
TRADACOMS/storageOption EDITPA variable 113 processing, sample code 230
tradi ng partners Transaction documen ts
defining profiles 107 DocumentID system attribute 212
Transaction documents

webMethods Module for EDI Installation and User’s Guide Version 9.12 434
 M
Index

business processes involving EDI documents UN/EDIFACT EDI document

362 adding envelope 148, 407
conversation ID 214, 362 EDI Processing Mode, custom attribute 71
Execute a Service processing action 226 FA reconciliation 342
GroupID system attribute 213 wm.b2b.edi.util
GS Only variable 67 addICEnvelopeEDIFACT service 147
GS&ISA variable 68 UN/EDIFACT Interchange document
instance IDs 368 FA status 345
OFF variable 68 FAReconciliation 344
syste m attribute 212 sample process models 365
viewing 354 UN/EDIFACT UNB header 386
transactionDocument variable 229 UNAmode EDITPA variable 74, 328
TransactionSet setting UNB01 field 386
FA Level field 381 UNB06 field 386
transmi ssion envelopes UNB07 field 386
persistMultipleDocEnvelope EDITPA variable UNB08 field 386
117 UNB09 field 386
transmission control number UNB10 field 386
validating 113 UNB11 field 387
Transmission documents, TRADACOMS unDefData element 166
DocumentID system attribute 241 unparsed section, converting to IData object 204
GroupID system attribute 241 URL
system attribute 241 myEDIServices.v1
viewing 354 processEDIDoc service 149
transmission headers wm.tn
validating transmission control numbers 113 receive service 158
transmission segments, splitOption variable 112 user status
transmission sender/receiver pairs doc ument with duplicate control number 264
defining profiles for 106 document with out-of-sequence control number
triggers, to handle notification of batching failure 264
321 User Status system attribute, not used 224, 247
true, setting user-defined format, and flat file schema 403
FAReconciliation EDITPA variable 344 Using EDI Module User Interfaces 25
isEnabled format service 34
tspace 166 V
Tutorial.EDItoXML va riables
processEDI850_4101 service 206 FAGeneration
Tutorial.XMLtoEDI FALevel EDITPA variable 80
processXMLSource service 145, 407 generateControlNu mber EDITPA variable 82
publishBatchFailEvent EDITPA variable 74
U Validate inbound envelope control numbers field
UCI/03 instance ID 369 133, 378, 393, 396
UN/EDIFACT Validate Structure pre-processing action 225, 247
business process 362 setting when invalid control number 267
standard, CONTRL message 170 validate variable, for wm.b2b.edi
UN/EDIFACT CONTRL envelopeProcess service 198
message 170 validation
UCI/03 instance ID 369 codes for FAs 184

webMethods Module for EDI Installation and User’s Guide Version 9.12 435
 M
Index

control numbers 258, 258 validateInboundEnvelope ControlNumbers

turning on or off 132 EDITPA variables 89
EDI envelopes, mechanism 198 validateInboundGroupControlNumbers
interchange service 198 EDITPA variables 83, 87, 89
internal-format do cum ent before converting to ctlFromTable 296
EDI document 406 delimiters/ record EDITPA variable 88
internal-format document before converting to delimiters/field EDI TPA va riable 75
EDI document 148 delimiters/record EDITPA variable 75, 95, 98,
Value Added Networks (VANs) 336 99, 99, 99
Values variable 182 delimiters/release EDITPA variable 76
VAN.VANConnectivity delimiters/subfield EDITPA variable 75
getFromVAN service 336 doc TypeName 252
input variables 336 docID 229, 229, 229, 251, 251, 252
putToVAN(VANFTP) service 337 docTypeID 229, 229, 230, 251, 252, 252
VANs docTypeName 229, 229, 230, 251, 252
connecting to another VAN by customizing built- edidata 144
in services 340 EDITPA 112, 374
connectivity 336 envelopeDocuments 228, 251
conventions of different VANs 339 envelopeIdentifier/receiver/ID EDITPA variable
defining processing rules 339 77
retrieving inbound EDI documents from 336 envelopeIdentifier/receiver/qualifier EDITPA
scheduled delivery queue 337 variable 77
Trading Networks public queue 337 envelopeIdentifier/sender/ID EDITPA variable 76
viewing deliv ery progr es sof 357 FAGenerati on
var iables reje ctionRule s/ logic alErrorSta tus EDITPA
ICheaderInfo/ISA/ISA11 EDITPA var iable 87 variable 85
vari ables FAGeneration
ICheaderInfo/ISA/ISA11 EDITPA variable 87 addGroup EDITPA 83
varia bles autoGenerateFA EDITPA variable 80
envelopeIdentifier/ sender/qu alifier EDITPA v a r processDocument EDITPA variable 81
iab le 76 rejectionRules/childTransactionRejectedStatus
variables EDITPA variable 85
Ba tchCriteria EDITPA variable 95 rejectionRules/syntaxErrorStatus EDITPA
BatchCriteria EDITPA variab le 93 variable 84
BatchCriteria EDITPA variable 93, 93, 96, 97 FAReconciliation EDITPA variable 72
bizdoc/Attribu t es/EDI Processing Mode 231 groupDocuments 229, 251
bizdoc/Attributes/ EDI Processin g Mode 234 GSRouting/routingMode EDITPA variables 67
ControlN umberManagement ICheaderInfo/GS/G S07 EDITPA variable 79
validateInboundGroupControlNumbers ICheaderInfo/IS A/ISA11 EDITPA variable 86
EDITPA variables 91 ICheaderInfo/ISA/ IS A01 EDITPA variable 78
ControlNumberManagement ICheaderInfo/ISA/ISA02 EDITPA variable 78
duplicateControlNumberAction EDITPA ICheaderInfo/ISA/ISA03 EDITPA variable 78
variables 89, 90, 375 ICheaderInfo/ISA/ISA04 EDITPA variable 78
outOfSequenceControlNumberAction EDITPA ICheaderInfo/ISA/ISA11 EDITPA variable 78, 87,
variables 375 87, 87
useReverseRouting EDITPA variables 92 ICheaderInfo/UNB/UNB01EDITPA variable 79
valida teInboundGroupControlNumbers ICheaderInfo/UNB/UNB06 EDITPA variable 79
EDITPA variables 87 ICheaderInfo/UNB/UNB08 EDITPA variable 79
input 150

webMethods Module for EDI Installation and User’s Guide Version 9.12 436
 M
Index

interator 199 defining 126

persistMultipleDocEnvelope EDITPA variables definition 127
69, 117 example of using to determine duplicate 259
processingMode EDITPA variable 70 example of using to determine out-of-sequence
publishBatchFailEvent EDITPA variable 118 260
routingMode variable 67 setting 128, 132
splitOption 71, 374 wm . b2 b.editn.rec
TRAD ACOMS/ControlNumberManagement batchFailDo cument IS document type 321
validateInboundTransmissionControlNumbers wm .b2b.edi
EDITPA variables 113 envelopeProcess service
TRADACOMS/ControlNumbe rManagement invoking after wm.b2b.edi.util 182
validateInboundBatch ControlNumbers wm.b 2 b.edi
EDITPA variables 116 convertToValues service
TRADACOMS/ControlNumberManagement EDI Module configuration file 166
duplicateControlNumberAction EDITPA wm.b2b. edi.tradacoms
variables 114 convertToString service
outOfSequenceControlNumberAction EDITPA forming EDI document using standard
variables 115 processing 294
validateInboundBatchControlNumbers EDITPA wm.b2b.edi
variables 114, 116, 117, 117 convertToString service 33
validateInboundFileControlNumbers EDITPA forming EDI document using standard
variables 114 processing 294
TRADACOMS/enforceApplicationReference 116 processing 231, 234
TRADACOMS/splitOption 112 convertToValues service 32
TRADACOMS/storageOption 113 converting 166
transactionDocuments 229, 252 creating service to form EDI document 146
UNAmode EDITPA variable 74 customizing EDI flat file schema for iterative
Verify Digital Signature pre-processing action 225, processing 199
248 forming EDI document using standard
setting when invalid control number 267 processing 293
Version field iterator input variable 199
control nu mber informati on 130 large document handling 164, 166, 167
control number information 142 logic to processing an inbound EDI document
versions, adding a new version of an EDI standard iteratively 203
53 processing 199, 231, 234
viewing sample code for processing entire inbound
EDI documents on Transaction Analysis screen EDI document at one time 197
354 validating internal-format document 148, 406
group-level sender/receiver pair associations 392 createIDOCtemplate se rvice 405
server log 350 envel opeProcess service
Trading Networks activity log 351 large d ocument handling 165
envelopePr ocess service
W sample code for processing entire inbound
webMethods Designer, designing process models EDI document at one time 195
362 envelopeProcess servi ce
webMethods Monitor, business processes 370 invoking after wm.b2b.edi.util 181
window, control number envelopeProcess service 149, 198, 407
default 127 complianceCheck variable 199
EDI Module configuration file 165

webMethods Module for EDI Installation and User’s Guide Version 9.12 437
 M
Index

large document handling 164 obtaining control numbers for outbound

processing Group documents 233 processing 296
validate variable 198 addICEnvelopeEDIFACT serv ice 407
SEFParse service addICEnvelopeEDIFACT service 147, 148
assigning format services 35 obtaining control numbers for outbound
creating flat fil e schemas 404 processing 296
wm.b2b.edi.tradacoms EDIconcat service, logic to processing an
convertToString service 33 inbound EDI document iteratively 204
convertToValues servi ce 32 generateFA service 149, 170, 407
convertToValues service determin ing FA status 173
forming EDI document using stan dard generating functional acknowledgments (FA)
processing 293 170
large document handling 164 input variables for 181
processing 254 invoking 181, 182
wm.b2b.edi.tradacoms.compose large document handling 164
addToTradacomsTransmission service 297 output 183
adding Transmission and Batch envelopes getEDIstring service
297 processing Group documents 233
endTradacomsTransmi s sio n s e r vice sample code for processing en t ire inbound
adding Transmission and Batch envelopes EDI document at one time 197
297 wm.b2b.editn
endTradacomsTransmission service 297 ediPartnerIDToTNPartnerID service, retrieving
processing File documents 255 Trading Networks internal ID 307
startTradacomsBatch service 297 get Tspace service
adding Transmission and Batch envelopes processing Transaction documents 230
297 getTspace service
startTradacomsTransmission service 297 processing Group docume nts 232
adding Transmission and Batch envelopes trackEDIdocs ser vice
297 routing EDI document through Trading
processing File documents 255, 255 Networks 305
wm.b2b.edi.tradacoms.doc trackEDIdocs service 72
ge tContentPart service delivering EDI document directly from the
processing File documents 254 service that forms it 298
getD ocument P artInfo service routing EDI document thro ugh Trading
processing File documents 253 Networks 305
getFFSchemaNames service wm.b2b.editn.batch
processing File documents 253 batchProcess service 312
isFileEnvelope service assigning scheduled delivery queue to 330
processing File documents 253 create BizDocEnvelope for final batch EDI
wm.b2b.edi.util document 322
addGroupEnvelope service 147 EDITPA variables 328, 328
obtaining control numbers for outbound final batch EDI document 331
processing 296 forming batch document 327
addGroupEnvelopeEDIFACT service input variables 327
obtaining contr ol numbers for outbound oneBatchQueue input variable 312
processing 296 publishing IS document to notify of batching
addICEnvelope service 147, 302 failure 313, 317
forming EDI document using standard replacing delimiters to match those in output
processing 295 batch EDI document 315

webMethods Module for EDI Installation and User’s Guide Version 9.12 438
 M
Index

steps to extract and sort transactions to be view service, determining Trading Networks
batched 313, 316 internal ID 308
wm.b2b.editn.TPA wm.tn.rec
EDITPA IS document type 63, 64, 65, 110, 111, BizDocEnvelope IS document type 228, 250
112 wm.tn.route
getEDITPAData service 294 routeBizdoc service, routing document through
initService 64, 65, 111, 112 Trading Networks 305
wm.b2b.editn.util WmEDI package
getContentPartDataAsInputStream service EDI Module 192, 402
processing File documents 254 EDICOR server log key 350
wm.b2b.editn.util.repro cess large document handling 164
listInSequence service, reprocessing out-of- large document processing 164
sequence documents 270 wm.b2b.edi.tradacoms.compose 297
wm.b2b.editn.util.reprocess WmEDIconfig directory 214
listUnprocessedDocuments service, locating WmEDIforTN package
documents with duplicate control numbers 268 EDIFFSchema folder 37, 44
nextInSequenceDoc service, reprocessing out-o EDIFTN server log key 350
f-sequence documents 274 EDITPA 62, 110
reprocessDocument service WmEDIsamples package
reprocessing duplicate documents 268 downloading 196
reprocessing out-of -sequence documents 273 outbound flow services 145, 407
wm.b2b.util.documentList sampleServices
addDocToDocu mentList service UNEDIFACTToValues 196
processing File documents 254 Tutorial.XMLtoEDI
wm.pub.flow processX MLSource service 145
debugLog service, processing Transaction processXMLSource service 407
documents 232, 235 WmFlatFile package configuration 34
wm.tn
receive service X
and pub.client 158, 159 XML documents
client invokes 157 converting into outbound EDI (ANSI X12),
example of 159 example of 145, 407
File Polling 161 XML-to-EDI fl ow service example 145
port number 5555 for HTTP 158 XML-to-EDI flow service example 407
POST EDI document to 158
sending 157, 158, 159, 161 Symbols
URL of for HTTP 158 _RID_ element 166
wm.tn.doc
addContentPart service, adding outbound EDI
doc ument to BizDocEnv elo pe 310
createNewEnvelope service, creating
BizDocEnvelope for outbound EDI document 309
wm.tn.doc.xml
routeXml service
preparing pipeline to invoke 302, 304
sending multiple EDI documents 161
submitting document to Trading Networks for
document recognition 302
wm.tn.doctype

webMethods Module for EDI Installation and User’s Guide Version 9.12 439