webMethods EDI Modules

Upgrading from 4.x to 6.5

Overview
This document explains how to upgrade from webMethods EDI Module: Core
Component 4.x, webMethods EDI Module: Trading Networks Component 4.x, and
webMethods EDI Module: EDIINT Component 4.x to the corresponding 6.5 modules: the
EDI Module and the EDIINT Module.
Note: In webMethods EDI Modules 6.1, the WmEDIforTN package was added to the EDI
Module. The pre-6.1 component, called webMethods EDI Module: Trading Networks
Component, no longer exists.
6.5 webMethods components use flat file schemas instead of templates to convert and
validate EDI documents. If you upgrade to EDI Module 6.5, then, you must do the
following:
For EDI transactions, upgrade to EDI Module 6.5 and create flat file schemas from
original SEFs or IDOCs.
For non-EDI documents, upgrade to EDI Module 6.5 and convert existing 4.x
templates to flat file schemas.
Note: If you upgrade to EDI Module 6.5 and later add an EDI document type to Trading
Networks, Trading Networks creates a corresponding flat file schema automatically.
For more information about flat file schemas, including modifying them to perform
validation, see the Flat File Schema Developers Guide and the webMethods EDI Module Users
Guide.

Upgrade and Create Flat File Schemas for EDI Transactions

1

If you are upgrading to EDI Module 6.5 and plan to use Trading Networks, upgrade
to Trading Networks 6.5. For instructions, see that upgrade procedure.

Download webMethods Installer 6.5 from the webMethods Advantage Web site at
http://advantage.webmethods.com and install the EDI Module and the EDIINT
Module (optional) on the same machine as Integration Server 6.5. When the installer
prompts you to specify the installation directory, specify the webMethods installation
directory (by default, webMethods6). The installer automatically installs the
components you select in the Integration Server 6.5 installation directory.
Important! For complete instructions on installing, configuring, and completing the
installation of the 6.5 EDI Module and EDIINT, see the webMethods Installation Guide.

EDI-UPG-4xto65-20050429

webMethods EDI Modules: Upgrading from 4.x to 6.5

EDI Module 6.5 offers new flat file validation and formatting options. These services
let you reformat the values of fields according to the EDI X12 and UN/EDIFACT
standards. The format services are enabled by default. Mapping services written for
EDI Module 4.x, however, expect field values to contain unformatted values. You can
(but do not have to) modify your mapping services to handle field values reformatted
according to the EDI X12 and UN/EDIFACT standards.
If you do not want to modify mapping services to handle field values reformatted
according to the EDI X12 and UN/EDIFACT standards, the flat file schemas you
create cannot have format services specified. To prevent format services from
being specified when you create flat file schemas, follow these steps:
1

Navigate to the Integration Server_directory\packages\WmEDI\config and

back up the format.xml file.

Remove all <DatatypeFormat> tags from the format.xml file.

Restart Integration Server.

If you later want to include format services in flat file schemas and you have not
customized the flat file schemas using Developer, restore the original format.xml
file, delete the flat file schemas, and recreate them using the EDI Module 6.5
service wm.b2b.edi:SEFParse.
If you later want to include format services in flat file schemas and you have
customized the flat file schemas using Developer, add the format services to each
flat file schema using Developer. For instructions, see the Flat File Schema
Developers Guide.
If you want to modify mapping services to handle formatted values, follow these
steps:
1

Call the wm.b2b.edi:convertToValues service in the EDI Modules WmEDI

package instead of the Integration Server service pub.schema:validate to validate
EDI documents. Set the validate flag in the wm.b2b.edi:convertToValues service to
true.

If the mapping services contained formatting operations that are now

performed by the flat file schemas, remove those operations from the services.

For more information and for detailed instructions, see the Flat File Schema
Developers Guide.
4

If you are upgrading to EDI Module 6.5, create flat file schemas for EDI transactions
using the instructions in the webMethods EDI Module Users Guide. Name each flat file
schema using this convention:
EDIFFSchema.document_standard.Vdocument_standard_version:Ttemplate_name
This naming convention provides backwards compatibility with 4.x versions. The EDI
Module 6.5 service wm.b2b.edi.templateMgr:getTemplate has been modified to return the
name of a flat file schema, and it uses this naming convention to construct the correct

EDI-UPG-4xto65-20050429

webMethods EDI Modules: Upgrading from 4.x to 6.5

name. The flat file schema name is then used by the EDI Module 6.5 services
wm.b2b.edi:convertToString and convertToValues. (In 4.x versions, these services used a
template name.)
5

If you are upgrading to EDI Module 6.5 and plan to use Trading Networks, open
Developer and run the wm.b2b.editn.migration:updateBizDocs and
wm.b2b.editn.migration:updateProcessingRulesAttribute services in the EDI Modules
WmEDIforTN package.

Upgrade and Convert Existing Templates to Flat File Schemas

for Non-EDI Documents
1

If you are upgrading to EDI Module 6.5 and plan to use Trading Networks, upgrade
to Trading Networks 6.5. For instructions, see that upgrade procedure.

If you are upgrading to EDI Module 6.5, follow these steps:

a

Navigate to the Integration Server_directory\packages\WmEDI\pub directory in

the 4.x installation and back up the template.bin file.

If you have flow services that have built-in 4.x templates (that is, templates that
are stored in the pipeline rather than in the template manager), do the following
for each flow service:

Store the flow services built-in templates in the 4.x template manager by
running the service wm.b2b.edi.templateMgr:putTemplate for the flow service.

Modify the flow service to use the wm.b2b.edi.templateMgr:getTemplate service to

get the templates from the template manager.

Remove the built-in templates from the flow service.

Migrate the 4.x templates to the 6.5 installation, as follows:

1

Start Integration Server 4.x, then open Integration Server Administrator.

Go to the Packages > Management page.

Locate a package other than WmEDI that contains templates to migrate. In

the Archive column for the package, click
Packages > Management > Default > Archive page.

EDI-UPG-4xto65-20050429

. The system displays the

Scroll to the bottom of the page, then click Create Archive. The system creates a
zip file that contains the package and places the zip file in the Integration
Server_directory\replicate\outbound directory.

With the exception of the WmEDI package, repeat these steps for all packages
that contain 4.x templates to migrate to the 6.5 installation.

Navigate to the Integration Server_directory\replicate\outbound directory in

the 4.x installation.

webMethods EDI Modules: Upgrading from 4.x to 6.5

Copy all the zip files you just created to the Integration Server_directory\
replicate\inbound directory in the 6.5 installation.

In the Integration Server Administrator for the 6.5 installation, go to the

Packages > Management > Install Inbound Releases page.

In the Release file name list, click one of the zip files you just copied to the 6.5
installation, then click Install Release. The system installs the package, then
displays a message that says the package has been installed and activated.

10 Repeat the previous step for each of the zip files you copied to the 6.5
installation.
3

Download webMethods Installer 6.5 from the webMethods Advantage Web site at
http://advantage.webmethods.com and install the EDI Module and the EDIINT
Module (optional) on the same machine as Integration Server 6.5. When the installer
prompts you to specify the installation directory, specify the webMethods installation
directory (by default, webMethods6). The installer automatically installs the
components you select in the Integration Server 6.5 installation directory.
Important! For complete instructions on installing, configuring, and completing the
installation of the 6.5 EDI Module and EDIINT, see the webMethods Installation Guide.

If you are upgrading to EDI Module 6.5, follow these steps:

a

Move the backup copy you made of the 4.x template.bin file to the Integration
Server_directory\packages\WmEDI\pub directory in the 6.5 installation.

Go to the webMethods EDI Module home page at http://Integration

Server_6.1_host:Integration Server_6.5_port/WmEDI. Click Migrate, then click here.
The page lists the 4.x templates you just copied to the 6.5 installation.

Follow the instructions to convert each 4.x template into a flat file schema. The
system stores each flat file schema in the same package that contains the original
template. The naming convention for flat file schemas is as follows:
EDIFFSchema.document_standard.Vdocument_standard_version:Ttemplate_name
If the original template does not indicate a document standard or document
standard version, document_standard and document_standard_version do not appear
in the name.
This naming convention provides backwards compatibility with 4.x versions. The
wm.b2b.edi.templateMgr:getTemplate service in the EDI Module 6.5s WmEDI package
has been modified to return the name of a flat file schema, and it uses this naming
convention to construct the correct name. The flat file schema name is then used
by the wm.b2b.edi:convertToString and convertToValues services in the 6.5 EDI Modules
WmEDI package. (In 4.x versions, these services used a template name.)

EDI-UPG-4xto65-20050429

If you are upgrading to EDI Module 6.5 and plan to use Trading Networks, open
Developer and run the wm.b2b.editn.migration:updateBizDocs and

webMethods EDI Modules: Upgrading from 4.x to 6.5

wm.b2b.editn.migration:updateProcessingRulesAttribute services in the EDI Modules

WmEDIforTN package.
When you are sure the entire 6.5 installation is working correctly, uninstall the
components in the old installation in the order shown below.

Uninstall webMethods EDI Module: Core Component 4.x

When you are sure the 6.5 installation is working correctly, uninstall the 4.x components
by deleting the WmEDI and WmEDIsamples packages from the Integration Server in the
4.x installation. See the webMethods Integration Server Administrators Guide for instructions
on deleting packages.

Uninstall webMethods EDI Module: EDIINT Component 4.x

When you are sure the 6.5 installation is working correctly, uninstall the 4.x components
by deleting the WmEDIINT package from the Integration Server in the 4.x installation. See
the webMethods Integration Server Administrators Guide for instructions on deleting
packages.

Uninstall webMethods EDI Module: Trading Networks

Component 4.x
When you are sure the 6.5 installation is working correctly, uninstall the 4.x components
by deleting WmEDIforTN package from the Integration Server in the old installation. See
the webMethods Integration Server Administrators Guide for instructions on deleting
packages.

webMethods Administrator, webMethods Broker, webMethods Dashboard, webMethods Developer, webMethods Fabric, webMethods Glue, webMethods
Installer, webMethods Integration Server, webMethods Mainframe, webMethods Manager, webMethods Mobile, webMethods Modeler, webMethods
Monitor, webMethods Optimize, webMethods Portal, webMethods Trading Networks, and webMethods Workflow are trademarks of webMethods, Inc.
webMethods and the webMethods logo are registered trademarks of webMethods, Inc.
Copyright 2005 by webMethods, Inc. All rights reserved, including the right of reproduction in whole or in part in any form.

EDI-UPG-4xto65-20050429