Gentran For ISeries User Guide
Gentran For ISeries User Guide
User Guide
Release 3.5
0241-350-USER01-0001
April 2008
Warranty Disclaimer
This documentation and the Sterling Commerce Software which it describes are licensed either "AS IS" or with a
limited warranty, as set forth in the Sterling Commerce license agreement. Other than any limited warranties provided,
NO OTHER WARRANTY IS EXPRESSED AND NONE SHALL BE IMPLIED, INCLUDING THE WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR USE OR FOR A PARTICULAR PURPOSE. The applicable Sterling
Commerce entity reserves the right to revise this publication from time to time and to make changes in the content
hereof without the obligation to notify any person or entity of such revisions or changes.
The Third Party Software is provided 'AS IS' WITHOUT ANY WARRANTY AND ANY EXPRESSED OR IMPLIED
WARRANTIES, INCLUDING BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, AND
FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. FURTHER, IF YOU ARE LOCATED OR ACCESSING
THIS SOFTWARE IN THE UNITED STATES, ANY EXPRESS OR IMPLIED WARRANTY REGARDING TITLE OR
NON-INFRINGEMENT ARE DISCLAIMED.
Table of Contents
Preface Before You Begin
How is the Documentation Organized? .................................................................... P-1
In this Book .............................................................................................................. P-1
What is in Each Chapter? ......................................................................................... P-2
Other Gentran:Server for iSeries Manuals ............................................................... P-4
Chapter 1 8
In this Chapter .......................................................................................................... 1-1
What is Gentran:Server? ........................................................................................... 1-2
What Does Gentran:Server Do? ............................................................................... 1-3
Take a Closer Look at Gentran:Server ..................................................................... 1-5
Use the Gentran:Server Panels ................................................................................. 1-9
Get Help .................................................................................................................. 1-30
Use the ezEDI Feature ............................................................................................ 1-36
Print Reports in Gentran:Server ............................................................................. 1-39
Product Support and Remote Maintenance ............................................................ 1-41
Chapter 3 Partner
In this Chapter .......................................................................................................... 3-1
What is a Partner? ..................................................................................................... 3-1
What does the Partner Subsystem Do? ..................................................................... 3-2
Take a Closer Look at the Partner Profile ................................................................ 3-3
Prepare to Set Up the Partner Profile ....................................................................... 3-6
Panel Quick Reference ............................................................................................. 3-8
Use the Partner Panels ............................................................................................ 3-11
Chapter 7 Standards
In this Chapter .......................................................................................................... 7-1
What are Standards? ................................................................................................. 7-1
What Does the Standards Subsystem Do? ................................................................ 7-2
Panel Quick Reference ............................................................................................. 7-3
Using the Standards Panels ...................................................................................... 7-7
Reports .................................................................................................................... 7-54
Common Questions ................................................................................................ 7-66
Glossary
Definition of Terms ................................................................................................. G-1
Reserved Word Constants ..................................................................................... G-12
Application Data Types ......................................................................................... G-18
EDI Data Types ..................................................................................................... G-24
Index
Both the organization and flow of information in this manual follow the online organization of the
Gentran:Server system and the natural way you might work as you set up your EDI system. For
this reason, you can expect to find variations in the style and content of individual chapters as they
are tailored to the needs of their particular audiences.
In this Book
This manual is task-oriented. You can use the Table of Contents to locate information about
specific tasks and procedures. The index, on the other hand, can help you if you need information
regarding individual panels or field definitions. For more detailed descriptions of individual panels
and field definitions as they apply to each panel, please use the online help.
Apart from the opening chapter, “System Essentials,” which everyone should read, most
Gentran:Server users do not need to read every chapter in this manual. The following chapter
summaries will help you determine which areas are most pertinent to your use of the system.
This chapter provides an overview of the Gentran:Server system, including the online help
feature. The chapter also covers general techniques for using the system. It explains how
to move from one panel to the next, how to use the function keys and options, and other
important information.We recommend that everyone read this chapter.
2. Environment Control
This chapter presents the procedures for setting up each user’s personal work
environment, including the parameters for output destinations, batch job description, and
data formats. The chapter also covers the procedures for defining security at the
Subsystem, Function, and Data levels.
The audience for this chapter is the EDI Coordinator or Security Officer (QSECOFR),
who should be solely responsible for these tasks.
3. Partner
This chapter defines the procedures associated with creating and managing the Trading
Partner profile. It includes instructions for using the ezPART command and explanations
of some common scenarios you might encounter. This chapter also includes
recommendations for parameter settings and in-depth explanations for the more advanced
user.
The Application Definition and Mapping tasks are closely associated. This chapter
provides an overview and introduction to the entire process. Information is included about
the types of application files that can be interfaced with Gentran:Server as well as how to
structure the application files. If you are not familiar with Mapping or if you simply want
to know more details about the Mapping process, this chapter is very useful.
5. Application Definition
The Application Definition defines the application interface format for translation. You
need to set up the Application Definition before you can begin the Mapping process. This
chapter defines the step-by-step procedures to set up and maintain Outbound and Inbound
Application Definitions.
The chapter also includes instructions for using the ezAPPDEF command as well as more
detailed information about the three types of application files with which Gentran:Server
can interface.
6. Transaction Mapping
The Transaction Map defines how your data is converted from the Application Definition
format to the EDI format requested by your Trading Partner. This chapter explains how to
perform several mapping tasks and provides instructions for using the ezMAP command.
7. Standards
This chapter explains the procedures for viewing and printing Standards online, applying
changes to the Standards to meet your business requirements, creating new Standards, and
selecting specific Transactions for the batch Standards file.
The Manager’s Implementation Planner is designed to assist you with the process of
collecting, organizing and prioritizing the information required to successfully implement
EDI. The Planner includes EDI tutorial materials and other planning and implementation
materials.
The Technical Reference Guide provides information on advanced topics and technical system
information for operating the Gentran:Server system. The guide includes system messages and
program and command names.
Gentran:Server for iSeries Release 3.5 Release Notes (including Impact to Existing
Users)
The Release Notes describe system enhancements and new functions that have been
incorporated into this release. Please read the Release 3.5 Release Notes carefully prior to
installing Gentran:Server.
The Impact section of the Release Notes gives users of previous Gentran:Server for iSeries
releases information on structural changes, including any changes to commands, CLs, and
database files. These may necessitate changes to your implementation of Gentran:Server for
iSeries. Please read the Impact section carefully prior to installation of this version of
Gentran:Server.
1 System Essentials
In this Chapter
Gentran:Server provides the flexibility, efficiency, and thoroughness needed to meet even the most
demanding EDI requirements. To take full advantage of this powerful system, it is important that
you understand some basic concepts before you begin. “System Essentials” serves as an
introductory chapter to help you become familiar with the system’s purpose, features,
organization, and operation. This chapter covers the following topics:
What is Gentran:Server?
Gentran:Server is a data translation and management system. It is an integral part of Electronic
Data Interchange (EDI), which is the application-to-application exchange of key business
documents in a standard format via a computer-to-computer communication link. This exchange
takes place between you and your trading partners (those with whom you do business). For
example, EDI would allow you to electronically transmit purchase orders to a supplier if that
supplier had set up their computer system to perform EDI with your organization.
In EDI, trading partners typically transmit files to each other in special formats called “Standards.”
EDI requires data to be translated in two directions:
1. Inbound — Translate data received from your trading partner in EDI standard format into
the proper format for input to your application programs
2. Outbound — Translate output files from your application programs into the EDI standard
required to send data to your partner
This is where Gentran:Server fits into the EDI process. Gentran:Server acts as an interface
between your in-house applications and the EDI standards. It allows you to present all your
business documents in an EDI standard format and to interpret documents that you receive in
standard format. The following figure shows the role Gentran:Server plays in the flow of data
during EDI.
Gentran:Server Value-
Application Translates data from EDI Added
standards to application
file format and visa versa
Network
Trading
Partner
(SEE the Manager’s Implementation Planner (MIP) for more information about EDI in general.
The MIP manual contains an excellent introduction and diagrams depicting typical EDI
transactions.)
Translation would be a relatively simple procedure if you were dealing with just one standard and
one partner. However, each industry has specific requirements, and every partner has different
business specifications. This means that you must have the ability to communicate in the
appropriate standard for each partner. The process is further complicated by the need to
acknowledge the receipt of documents, to monitor data for errors, and to manage the entire process
of sending and receiving EDI transmissions.
Gentran:Server also supports EDI in many other ways. The powerful Mapping module translates
data between your application and an EDI standard format (ANSI X12, UCS, WINS, TDCC,
TRADACOMS, or EDIFACT). The system also checks the syntax of inbound and outbound data
thoroughly to ensure it complies with the specified EDI standard.
With Gentran:Server, you can set many options on a per-partner basis to tailor the system to both
your environment and your partner’s environment. The sophisticated, yet simple-to-use, online
interface allows you to easily manage Gentran:Server – without the need for system programming.
Management controls provide Audit Trails, Environment Control and error reporting.
Simplifies start up with ezEDI: This is a helpful feature that automatically guides you
through the tasks of setting up the basic files and data necessary to begin using
Gentran:Server.
Offers online help: Gentran:Server provides context-sensitive help at a field and panel
level as well as a key word search index, which is integrated into Gentran:Server.
Handles all EDI transactions: The system uses tables to define all EDI transactions,
segments and elements, which include ANSI X12 transactions as well as the Air, Ocean,
Motor, and Rail standards of TDCC, UCS, WINS, TRADACOMS, and EDIFACT.
Supports multiple versions: You may use as many or as few versions as your trading
partners require. New versions of standards are supplied by Sterling Commerce after they
are published by the appropriate standards committee.
Allows partner-specific decisions: Many specifications can vary by trading partner. For
example, each partner may have different mapping and acknowledgment requirements.
Provides Audit functions: Gentran:Server can perform audit functions on all incoming and
outgoing transactions, groups and interchanges. In addition, an Audit Inquiry function is
available.
Allows you to reprocess suspended data: Inbound data that does not meet all predefined
requirements is stored in a suspense file so you can determine how to process it later.
Generates envelope segments: Specify the partner envelope information once and
Gentran:Server uses it thereafter to generate envelopes. The system automatically
generates the appropriate interchange, functional group and transaction envelope
segments.
Day-to-day user interaction is recommended to review the online Audit and Communications
systems to monitor the EDI document flow. A specially designed process window (Audit) gives
you an online view of the EDI document flow. It allows you to monitor the periodic tasks and data
to ensure that normal processing occurs.
(SEE the other chapters in this manual and the Technical Reference Guide for detailed
explanations of how Gentran:Server manages EDI transactions. The “Processing” chapter in the
Technical Reference Guide thoroughly explains how data flows through Gentran:Server during the
batch operations. You can also access information through the online help and the Search Index
features.)
Subsystem Purpose
Application Definition Identify the format of the input and output data files for your
application programs.
Transaction Mapping Define the relationship between your application file layouts (as
defined in the application definition) and the EDI standard
required by a given trading partner.
Communications Set up the profiles and scripts for data transmissions between you
and your partner(s).
Standards Display and maintain EDI standards online. Also allows you to
create customized versions.
Processing Execute the programs that are associated with the editing and
translation of inbound and outbound EDI data; install and delete
standards.
System Administration Control system activities through the Global Parameters, Job
Scheduler, EDI Monitor, Network Command Interface, and
System Configuration menu.
Gentran:Viewpoint Track the flow of inbound and outbound documents as they are
processed by Gentran:Server. (This subsystem is sold as a
separate module, so only those customers who have purchased
Viewpoint may access it.)
# NOTE
The Gentran main menu includes two panels of options from which to choose. Press Page
Down to view all options.
Figure 1.1 illustrates the main menu and lists all the subsystems in Gentran:Server.
Figure 1.2 illustrates the functions that make up the System Administration subsystem. This
subsystem has an underlying menu that lists its functions, but that is not true for all the other
subsystems. Most subsystems go directly into “Work with” panels.
1. Global Parameters
2. Work with Job Scheduler
3. Work with EDI Monitor
4. Work with Network Command Interface
5. Work with Batch Error Message File
6. Set TELEKOM Network Processing Parameters (SETTELEKOM)
7. Display Current Point Release (PTR)
Selection or command
===>
As you use Gentran:Server, keep in mind that the functions within each subsystem are linked
together like a network. Your path (the sequence of panels that display) depends on the data that
you type on each panel. This flexible structure allows Gentran:Server to move quickly between the
functions without multiple layers of menu trees.
# NOTE
In addition to the subsystems, the main menu includes the Gentran:Server Search Index,
which displays online help for glossary terms, field definitions, and other topical information
available as hypertext.
To use Gentran:Server, you must have a valid iSeries user profile. Gentran:Server uses your
iSeries User ID to identify who you are, to control which subsystems and functions you can access,
and to track the changes that you make in any files.
Your iSeries Security Officer can give you instructions for using the terminal hardware and
operating system at your location. You should be familiar with basic iSeries concepts prior to using
Gentran:Server.
Based on the configuration of your iSeries user profile and the conventions in place at your site,
you might start up Gentran:Server in one of three ways.
From a Menu
Many sites set up their own menu structure or customize third-party software so Gentran can
be invoked from a menu.
Other Gentran:Server menus available from the command line include: Processing (GO
GENPRC), System Administration (GO GENSYS), System Configuration (GO
GENSYSCFG), Audit (GO GENAUD), Communications (GO GENCOM), and Message
Center (GO GENMSG).
To use Gentran security, you can invoke all menus (except GENMAIN) using the
GENEXMNU command and pass the menu name, that is, ‘GENEXMNU GENPRC.’ This
performs security checking to see if the user is authorized to access the subsystem before
invoking the menu.
# NOTE
Prior to accessing Gentran, you may have to add one or more Gentran:Server libraries to your
library list. If you are unsure about this process, please contact your System Administrator
for instructions on adding or modifying entries in your library list. The default libraries which
are supplied with Gentran:Server are G3X5DTA, G3X5PGM, G3X5SAMP, and
G3X5TOOL. Make sure the library QTEMP is in your library list.
From GENMAIN, you can access any of the Gentran:Server subsystems by typing the associated
option number on the command line and pressing Enter. For example, if you want to Work with
Partners, type ‘1’ on the command line and press Enter.
Gentran:Server displays the data entry panel, Work with Partners (EDIX005-FMT01). At this
point, you can enter the field values required to set up your partner.
For most Gentran:Server subsystems, selecting a main menu option displays a data entry panel.
There are some subsystems, however, such as Processing, that display another menu. In this case,
simply select a menu option on the new menu so a data entry or command panel displays.
If Gentran:Server does not display a menu, the next panel to display depends on the entries that
you made on the previous panel. In a sense, Gentran:Server “protects” you from making mistakes
or omissions. Based on the entries you make on various Gentran:Server panels, the system leads
you through a series of related panels on which you need to fill in information before you can
complete the task. This “captive” feature ensures that the EDI transactions you create have all the
information necessary to be processed successfully.
The following list contains components that are present on all Gentran:Server panels:
Panel Description
User’s Initials
Message Line
Function Keys
Panel Fields
System Date/Time
The following list contains components that are present only on some Gentran:Server panels:
Option Fields
Option Codes
Panel Continuation
Command Line
option fields
message line panel panel
fields function keys continuation
# NOTE
Gentran:Server command prompt panels vary from the panel format shown above. (SEE the
“Programs and Commands” chapter in the Technical Reference Guide for a list of the
Gentran:Server commands.)
Panel Description
This is a textual name for the panel. Since panel descriptions are not always unique, be careful
when you refer to panels by name. Always check both the panel description and the
program/format name.
# NOTE
Using Captive Panels
Many Gentran:Server panels are “captive.” This means that the panel automatically displays
based on the values you entered on a previous panel. You can tell whether a new panel has
displayed by checking the program name and format name, which are unique identifiers
located on the upper left corner of the panel. (SEE the sections on options and function keys
later in this chapter for more information about moving between panels.)
Option Codes
Option codes display only on panels that display multiple records. Option codes are numbers that
represent actions to be performed on one or more of the records. For example, in the previous
figure, the panel displays multiple partner profiles. The option codes represent actions that can be
performed on one or more of the partners. Additional option codes can be shown by pressing F23
(More Options), where available.
Option Fields
To select an option, type the number in the Option field to the left of the appropriate line item(s)
and press Enter. You can perform more than one option (that is, View, Copy, Add, Change,
Delete) associated with a field maintenance task at a time. Type as many option codes in the option
fields as you like, then press Enter. The system performs the options starting at the top of the
panel and continuing down to the bottom of the page.
# NOTE
With the exception of “Work with” panels, options can be carried forward from one page to
the next.
Panel Fields
You must enter values in one or more fields on each panel. These fields describe the EDI
transactions you are creating and/or instruct Gentran:Server on what to do with the transactions
you are creating. Depending on the types of information being entered, the panel fields display on
various areas of the panel. The field values that you enter are not entered into the system until you
press a specific function key, usually Enter or F10 (Update). Pressing this key enters all the field
values on the panel into the system at the same time. (SEE the “Function Keys” section later in this
chapter for more information about entering data into the system).
User’s Initials
Your initials are defined in the Environment Control subsystem. These always display in the upper
right corner of the panel. (By the way, have you been introduced to Elizabeth D. Ingram? Liz was
kind enough to supply all the tutorial materials for this manual and her initials (EDI) display on
every panel.)
Message Line
In response to actions that you perform, the system displays messages just below the function
keys. Always be sure to read the messages displayed in this area. For additional information, place
the cursor on the message and press F1 (Help). This is available for most messages.
Function Keys
The list of function keys displays at the bottom of the panel. Function keys perform many actions
such as exiting from a panel, printing a report or sorting a file. Gentran:Server uses a wide variety
of function keys. Each panel displays only those functions keys that are active for that particular
panel. Consult your hardware manual for information about using multiple key strokes to access
the higher numbered function keys. Additional function keys can be shown by pressing F24 (More
Keys).
Panel Continuation
Some panels contain more information than the screen can display at one time. These panels are
designed as multiple “pages.” Panels with multiple pages display the word “More...” at the bottom
right corner of the panel. Use the Page Up (Roll Down) and Page Down (Roll Up) keys on your
keyboard to move between the multiple pages of the panel.
Access Mode
This defines the type of activity you can perform on a panel. Typically, the mode is
determined by the option you selected on the previous panel. For example, you could
select option ‘1’ (Create) on a panel so the next panel is accessed in “create mode,”
allowing you to add a new record.
Captive Panel
Captive panels refer to panels that are “tied” together and must be reviewed before
“creates” are performed. This arrangement prevents you from inadvertently missing a
panel which contains important information critical for processing.
In create mode, if F10 (Update) is pressed from a panel that has associated captive panels,
the system displays the next captive panel with a message indicating that you must review
this panel before updating. Once all captive panels have been reviewed, press F10 again to
actually add the record and return to the calling panel.
To access captive panels in any mode, press Enter or F8 (Next) to advance forward or
press F7 (Back) to advance backward. To confirm updates, press F10.
F1=Help
Provides either additional information about the panel in general or about a specific field
within the panel depending on where the cursor is located on the panel when you press F1.
When displaying help information for a field, you can press F2 (Extended help) to get panel
help. This help can be printed. (SEE “Getting Help” later in this chapter for more information
about online help.)
F3=Exit
Ends the current function and returns you to the display from which the function was
started.
F4=Prompt
Supplies a window containing valid field values or a selection list for the appropriate file.
When you press F4 on a menu or in a field on a “Work with” panel for which no values
have been defined, the system displays the iSeries’ Major Command Groups (MAJOR)
panel. Press F3 (Exit) or F12 (Cancel) to return to the active panel.
F5=Refresh
Redisplays the panel with the most recent information and removes any outstanding
selections or keyed data.
F7=Back
Displays the previous panel associated with a captive panel (associated with the same
record).
F8=Next
Displays the next panel associated with a captive panel.
F9=Retrieve
Shows the last command entered on the command line along with any included
parameters. Press this key once to retrieve the last command you ran. Press this key twice
to retrieve the next to the last command you ran. Press additional times for each
corresponding command you wish to retrieve.
If no commands were entered, or, you are not authorized to use the iSeries command line
(as defined in your iSeries user profile), no command is retrieved and the panel redisplays.
F10=Update
Updates the record and returns to the calling program from which you invoked this panel.
F11=Delete
Confirms the delete operation and deletes all records associated with this ID. The system
automatically returns to the calling program from which you invoked this panel.
F12=Cancel
Returns to the previous menu or display. When on a single record panel, outstanding
updates (must apply using (Update)) are cancelled.
On a multi-record panel, updates applied by pressing Enter are not lost when F12
(Cancel) is pressed.
F13=Services
Displays a pop-up window with available options for other functions that can be invoked.
The system suspends actions for the current panel and branches to the selected function (if
authorized). Upon completion, the system returns to the Services Window. You can select
another option or cancel (F12) to the calling program from which you invoked the
Services function. Typically, options are available for tasks related to the current panel.
F15=Sort
Displays a pop-up window with available sort criteria. The cursor is positioned next to the
field currently controlling the Sort order for the display. Selecting different sorting options
affects the Position-to field(s) shown at the top of the panel. The default sort order for each
of the “Work With” panels is set in the System Configuration file (SEE the “System
Considerations” chapter in the Technical Reference Guide for more information about the
System Configuration file.)
If a record is protected, the rolling update is prohibited. If a record is not protected, the
system performs a rolling update. In view mode, rolling is performed, but no data is
updated.
If a record is protected, the rolling update is prohibited. If a record is not protected, the
system performs a rolling update. In view mode, rolling is performed, but no data is
updated.
F21=Print
Submits the appropriate Print Report job to be executed.
F22=Resequence
Redisplays this multi-record panel forcing any re-sequencing of records to occur.
Typically, a sequence number is used as a key field. As new records are added, you can
refresh the panel with F22 (Resequence) to display all the records in their new order based
on the sequence number used.
F23=More Options
Displays additional option codes available with this panel. You can scroll through all
available option codes by pressing F23 (More Options) repeatedly.
F24=More Keys
Displays additional function keys available with this panel. You can scroll through all
available function keys by pressing F24 (More Keys) repeatedly.
F9=All Parameters
Shows parameters that are normally displayed only when specific values are entered in
other fields.
F10=Additional Parameters
Provides selections usually related to printing and job options.
Enter
Enter can be used for positioning into a display list or advancing to a function when using
an option. Enter is also used to update information on panels. In this case, edits are
performed and, if successful, the data is updated. On single record panels, F10 (Update)
must be pressed to confirm the update, otherwise changes are lost when F12 (Cancel) is
pressed.
Help
Provides additional information about using the panel or a specific field on the panel.
Some keyboards have a specific Help key that can also be used to access the same Help
information as F1 (Help).
Home
When pressed on a Gentran panel, Home moves the cursor to the primary “Position-to”
field at the top of the panel.
Print
Prints information currently displayed. Print does not print data from files. Use the
separate options and function keys within Gentran to print data.
Tab Key
Tab moves the cursor from one field to the next on the panel, left to right, top to bottom.
To move the cursor in reverse (bottom to top, right to left), press Shift and Tab
simultaneously.
Using a mouse
If your computer hardware is configured with a mouse, you can position the mouse cursor
on a panel field anywhere on the panel, click the mouse button and begin to enter values in
the field. Additionally, to execute a menu option or function key, you can double click the
mouse button on that menu option or function key. See your System Administrator to
determine if you have the proper hardware and software to use your mouse with the
iSeries.
Many panels include a list of available option codes you can use for navigation to advance to a
desired panel or function. Available option codes display in the top portion of the panel. Press F23
(More Options) repeatedly to display additional option codes.
To use the options, type the option code in the Opt (Option) field next to the desired identifiers and
press Enter. You can type option codes next to more than one entry at a time to perform more than
one task, one after the other.
The key entry line must be used when creating a record. It can also be used for other options with
entry of the specific parameters.
1=Create
To create a new record, type ‘1’ in the option field, fill in the required identifier(s) on the
key entry line and press Enter. The system advances you to a subsequent panel in create
mode, where you can add the record by completing the required fields and pressing F10
(Update).
2=Revise
To revise an existing record, type ‘2’ in the option field next to the desired entry and press
Enter. You can also type in the desired identifier(s) on the key entry line with option ‘2’
and press Enter. The system advances you to a subsequent panel in revise mode where
you can modify the record by updating the desired fields and pressing F10 (Update).
3=Copy
The copy function can be performed at several levels. When selected on a “Work with”
panel, the entire selected definition is copied to a new definition. For example, if the copy
function was selected from the Work with Application Definition panel
(EDIX550-FMT01), the entire definition is copied to a new definition.
On lower levels within a subsystem, the copy function, in many places, only copies a
single record. For example, if the copy function was selected on the Application Fields
panel (EDIX554-CTL01), only a single record is copied.
When the copy function is invoked, a pop-up window displays to allow entry of the key
fields necessary to create the new record(s). For more information, press F1 (Help) while
in the copy window.
4=Delete
The delete function can be performed at several levels. When using this function on a
“Work with” panel, the entire selected definition is deleted. On lower levels within a
subsystem, the delete function might only delete a single record. For example, if the delete
function was selected on the Application Fields panel (EDIX554-CTL01), only a single
record is deleted.
When accessing a panel in delete mode, F11 (Delete) must be pressed to confirm the
deletion, On multi-record panels, option ‘4’ must be typed to indicate the records to be
deleted. In this case, no confirmation is requested.
5=View
The view option is selected as an access mode for single record panels when no
information should be changed. When using F16 (Prev Rcd) and F17 (Next Rcd), records
are accessed in a rolling view mode instead of a rolling update mode.
Since you cannot specify a view-only mode on multi-record panels, you must ensure no
changes are made. The data rights for a subsystem can be set to ‘3’ to ensure a user can
only view data throughout that entire subsystem. Alternately, the entire definition can be
protected by setting the Update-Allowed flag to ‘N.’ (SEE the “Environment Control”
chapter for more information about the Update-Allowed flag.)
6=Print
The print option prompts the appropriate print report command for the user to submit. If
selected beside an ID on a “Work with” panel, the identifier is pre-loaded into the
command.
The print function is also available on many panels by using F21 (Print). This function
automatically submits the appropriate print report to batch for the currently displayed
identifier.
F4 (Prompt) is very helpful in these situations, and may be pressed while on a field. This function
key displays at the bottom of many Gentran:Server panels such as the one in the following figure.
On “Work with” panels, you must enter an option on the key entry line, with F4 (Prompt) pressed
on any field on the key entry line; if available, a list of valid values displays. If you press F4
(Prompt) without an option specified or pressed outside the key entry line, the system displays the
iSeries Major Command Groups (MAJOR) menu.
The following two examples illustrate using the F4 (Prompt) feature from a file maintenance panel
and a “Work with” panel.
Position to Code . . . . . . . . . PO
1=Select
Code Description
Fil 1 PO PURCHASE ORDER TRANSACTION (850) 360
EDI PR PURCHASE ORDER ACKNOWLEDGEMENT (855) 360
EDI PS PLANNING SCHEDULE WITH RELEASE (830) 360
Rec PT PRODUCT TRANSFER AND RESALE 077 1 90
Len More...
App F1=Help F3=Exit F12=Cancel F15=Sort
Upd
Figure 1.5 Using the F4 (Prompt) Function Key from a File Maintenance panel
# NOTE
If an option is entered and the cursor is on a field for which there is no prompt information
available when F4 (Prompt) is pressed, the system displays the message “Prompt function
not defined for (fieldname).”
Figure 1.6 Using the F4 (Prompt) Function Key on a “Work with” panel
# NOTE
If an option is entered and the cursor is on a field for which there is no prompt information
available when F4 (Prompt) is pressed, the system displays the message “Prompt function
not defined for (fieldname).”
Shortcuts
Gentran:Server provides many features to make your work quicker and easier. The following
shortcuts can be used by novice as well as experienced Gentran:Server users.
For example, if you wish to access the Work with Partners panel (EDIX005-FMT01), type one of
the following commands on the command line and press Enter.
J PAR
JUMP PAR
J 005
This table lists the predefined quick names for the J or Jump command.
MP Mapping Menu
ST Standards Transactions
SS Standards Segments
SC Standards Codes
To directly access a Gentran program (for online screens), type the following command on the
command line and press Enter:
There are many situations in which this feature could be useful. Perhaps a co-worker asks you for
information about EDI information that is in Gentran which is totally unrelated to the work that
you are currently doing. If you know the program name of the function that contains this
information, you can use the EXCPGM command to quickly display that function and then return
to your work. (SEE the “Programs and Commands” chapter in the Technical Reference Guide for
more information.) Also, it is common to create your own menus providing direct access to
pertinent functions.
The special command, GENEXCMD, performs Gentran security authorization checking prior to
prompting. To use this method, type the following command on the command line and press Enter
or use in a menu source as follows:
The special command, GENEXMNU, performs Gentran security authorization checking prior to
invoking the menu. To use this method, type the following command on the command line and
press Enter or use in your own menu source as follows:
Gentran has another special “shortcut” feature to handle this situation. On some Gentran panels,
you may notice the F13 (Services) function key. Pressing this key displays a pop-up window with
a list of menu options related to your current task, as shown in Figure 1.7.
If, for example, you are entering values on the Transaction Map Segments panel
(EDIX504-CTL01), pressing F13 (Services) displays a pop-up window as shown in the figure
above. In this example, option ‘2’ advances you to the Application Records panel to verify that the
Loop IDs for the records and segments match.
At this point, you can select any one of the menu options, and Gentran:Server displays a new
panel. Type all the field values as you would normally do. When you are finished with the panel,
press the appropriate key to exit. Gentran returns to the Service Menu again. At this point, you can
select another menu option or press F12 (Cancel) or F3 (Exit) to return to the exact point at which
you left the original panel.
# NOTE
Command line usage is determined by your iSeries user profile. SEE your System
Administrator for more information.
Figure 1.8 illustrates prompting the Process Transactions Inbound (PRCTRNIN) command from
the command line using F4.
More...
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
Figure 1.8 Using the PRCTRNIN command from the command line
# NOTE
When you execute a Gentran-specific command from the command line, information is
retrieved from your Gentran:Server environment profile to control the runtime environment.
(SEE the “Environment Control” chapter for more information.)
Get Help
Additional help for using Gentran:Server for iSeries, beyond what you find in the documentation
set, is available in a variety of ways.
Gentran:Server for iSeries online help is context-sensitive. This means that the information
displayed is based on the current panel and the position of the cursor on the panel. This allows you
to access either specific information about a field or general information about the whole panel.
Online help is accessed by first positioning the cursor in one of the context-sensitive areas of the
panel, as shown in the following figure. Press F1 (Help) or the HELP key, depending on your
keyboard, and a pop-up help window displays on top of the current panel so that the given field is
still visible.
Figure 1.9 shows the areas on a panel for which Gentran:Server for iSeries provides
context-sensitive help.
Help for Options Help for the Entire Panel
Pressing F1 (Help) with the cursor in the System message area activates the iSeries help utility for
system messages. All messages issued for the online panels have first level help. Many errors also
have second level help that further explains that specific error, identifies its cause, or suggests a
course of action to remedy the error. To display second level help, place the cursor on any message
and press F1 (Help).
Sometimes more than one message is issued. A plus sign (+) displays at the right side of the
message line whenever additional messages exist. Move the cursor to the message line and press
Page Down (Roll Up) or Page Up (Roll Down) to scroll through all error messages issued.
Messages are shown from the language-specific error message file, GENERRxxx, where ‘xxx’
represents the language ID (i.e., GENERRENU is the English error message file).
# NOTE
In most cases, the generic field definitions are not included in the paper documentation. As
you read the manuals, you may find it convenient to have an active Gentran session in front
of you so that you can access the field definitions and other online information.
Position to Version ID . . . . . .
................................................................
Type option ( :Position to (Version ID, Name) - Help :
1=Create 2 : :
: Use this field to go to a specific area in the list. It :
Opt Version I : is used for quick repositioning of the list, not for :
: creating a subset of the list. The system will position :
ABI001 : the list to the closest matching entry. :
ANA001 : :
A2/4 : If more than 1 field exists for positioning, the second :
A2/5 : field is only used if a full entry occurs for the first :
A2/6 : position-to field. :
A2/7 : :
A2/8 : When the position-to field is a date or time, the value :
C2/4 : entered is not validated for normal dates and times. :
C2/5 : Bottom :
: F2=Extended help F10=Move to top F11=Search Index :
Parameters or : F12=Cancel F13=Information Assistant F24=More keys :
===> : :
F1=Help F3=E :..............................................................:
While there is some variation in content for individual panel descriptions, in general, the help for
the entire panel typically includes an overview that describes the purpose of the panel; activities
that can be performed from the panel; related topics; field definitions; and function key definitions.
Use Hypertext
On some online help panels, certain words or phrases are underlined and/or highlighted in
high-intensity. This indicates that additional information (hypertext) is available for the
highlighted text. To display the additional information, either move the mouse or press Tab until
the cursor is positioned in the highlighted text. Press Enter.
# NOTE
All of the definitions available through hypertext are also available through the Search Index.
(SEE “Using the Search Index” section.)
Figure 1.12 shows words that have hypertext definitions available through Gentran online help.
Figure 1.12 Accessing hypertext definitions by moving the cursor onto the word and
pressing Enter
From the Gentran:Server main menu (GENMAIN): select menu option ‘12’ (Search
Index)
# NOTE
The Gentran:Server Search Index is called “GENSCHIDX” and is found in the
Gentran:Server program library (G3X5PGM).
Using either the mouse or the Tab key, position the cursor in the option field next to the
selection you would like to view or print. Type ‘5’ to view the topic, and ‘6’ to print the
topic. Multiple entries may be selected at one time.
Type a key word or a portion of a key word or phrase on the command line and press
Enter. The system searches an internal table of key words and synonyms and displays a
list of topics that best match the words you entered. Type ‘5’ to view the topic; ‘6’ to print
the topic.
You can use either upper or lowercase letters – the search is not case sensitive.
Make the topic you enter as complete and specific as possible. For example, if you type
only the word “job,” the system displays a long list of topics about jobs. For a shorter list
of more specific topics, you could type “changing the position of a job queue.”
The ezEDI feature consists of five separate commands, each of which can be entered on the
command line independently, or selected from the corresponding “Work with” panel. (Also see
Figure 1.13.)
# NOTE
Like other commands, the ezEDI commands can be executed from the command line only if
you have Limit Capabilities set to ‘*No’ or ‘*Partial’ in your iSeries user profile.
ezEDI
The ezEDI command is a tool to help you get started with setting up your EDI system with
Gentran:Server. The command steps you through all the panels associated with all of the other
ezEDI commands as well as the global parameters.
Setting up your EDI system consists of the following steps: defining a trading partner, an
application definition, a map definition, setting the global parameters to customize the EDI
system or leaving the default settings as is, and finally defining a communication Profile ID.
For each step, you are shown the minimum panels necessary to define the information.
Typically, this command would be used just to get you started. As additional information
needs to be defined, the individual ezEDI commands can be used.
The global parameters were set with default values when you installed your software. You
have the capability of customizing your EDI system by modifying these parameters, which are
used during the batch translation process. ezEDI steps you through three global parameter
panels, allowing you to customize these values or leave the default settings.
ezPART
The ezPART command is a tool to help you define your trading partners to the system. In EDI,
anyone with whom you transfer documents is called a trading partner. Setting up a partner is
similar to making an entry in an electronic Rolodex. All the information needed to do EDI
with the partner (i.e., an electronic mailing address and documents being traded) is stored in
one place where it can be conveniently accessed.
The ezPART command steps you through a series of panels which are essential for defining
information about your trading partners. This includes the control (interchange) group,
transaction, name and address (optional), and cross reference panels.
ezAPPDEF
The ezAPPDEF command is a tool to help you define the application definition to be used in
conjunction with the map definition. This identifies the layout of the application file(s) to be
used during translation with the EDI format. For example, if you are sending invoices
electronically, the application definition needs to identify all the files and fields to be used to
generate the invoice, such as the invoice header and detail line item file.
The ezAPPDEF command steps you through the panels which are essential for defining the
application definition. This includes the Application ID, files/records, and fields panels.
ezMAP
The ezMAP command is a tool to help you define the mapping definition to be used during
translation to convert data between an application layout and an EDI layout. The application
layout must be defined prior to defining the map and is done via the application definition. The
EDI layout is defined by selecting those segments from the standards that will be sent or
received and then linked to the application by defining how the fields are associated with the
EDI elements.
The ezMAP command steps you through the panels which are essential for defining the map
(transaction definition). This includes the Transaction ID panel, the Copy Segments panel, and
the Map Segments panel.
ezCOMM
The ezCOMM command is a tool that helps you customize the communication profile
(CN3BSC for BSC or CN3SNA for SNA) supplied with the software to communicate with
COMMERCE:Network (the Value Added Network for Sterling Commerce). The
communication profile contains information necessary for the system to create a line,
controller, and device description, which is used in the actual communication session. It is
necessary to modify the default parameters to work with your modem and choice of protocol
(i.e., line speed and manual or auto-dial) and specific phone number to be dialed.
The ezCOMM command steps you through the panels essential for customizing the CN3BSC
or CN3SNA profile. This includes the Profile maintenance panels and the Network Profile
panel, which is used to define your mailbox ID and password to access Commerce:Network.
You can use the ezEDI commands to create new entries, edit existing entries and/or delete entries.
If you have questions about panel or field definitions, remember that you can access online help
for any panel or field by positioning the cursor and then pressing F1 (Help). (SEE “Using Online
Help” in this chapter for more detailed instructions.)
STOP
CAUTION
The ezEDI commands proceed forward only through all the associated panels. Once the
command is entered, you cannot interrupt the process or back up to previous panels. Be sure
to collect all your materials and allow yourself sufficient time prior to initiating an ezEDI
command.
# NOTE
For more detailed information regarding individual panels associated with each ezEDI
command, please refer to the online help as well as the documentation for each particular
subsystem in this manual.
ezEDI
There are two general types of reports in Gentran:Server; User-generated reports and
System-generated reports, which are illustrated in the following figures.
User-generated reports
User-generated reports are optional reports which are initiated by a user request. This usually
occurs when you select Option ‘6’ (Print) or you press F21 (Print). Many of these reports can also
be generated from the command line.
System-generated reports
System-generated reports occur automatically, regardless of requests by the user. These types of
reports generally occur when activities such as purges and processing occur. At these times the
system automatically creates a report documenting the task just performed.
System-generated reports are generated automatically as a result of executing a job. The following
figure shows an example of this situation. When the Process Transactions Inbound (PRCTRNIN)
command is executed, the system generates the Inbound Editor and Mapper reports, as shown in
Figure 1.14.
More...
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
Figure 1.14 Inbound Editor and Mapper reports are generated automatically
User-generated reports generally have a panel for entering report parameters similar to the one
shown in Figure 1.15 for the Partner file. This can be particularly useful for tailoring the report to
exactly the kind of information that you need.
Each report has a unique identifier. The program name of the program which generated the report
is always displayed in the top left corner of the report.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
By default, all reports go to the iSeries Output Queue defined for your user ID. (SEE the
“Environment Control” chapter for more information on defining Output Queues in a user’s
Environment Profile.) If you like, you can also customize the print job.
General Information
Sterling Commerce Software Support (SSS) configures a temporary, dial-up connection between
Sterling Commerce’s Customer Service iSeries system and your system. This connection allows
Sterling Commerce to directly assist you with the resolution of software problems.
The SSS connection uses display station pass-through and SNADS. This enables the support
personnel to sign on to your system and diagnose the problem. If necessary, they can retrieve
diagnostic data for further analysis or send you a program fix.
This allows Sterling Commerce to be responsive to critical situations that demand the ultimate in
customer support.
SSS requires a number of objects and SNADS configuration entries. These are created when you
issue the SSSCONFIG command. They are all given names starting with SSSx, where x is the
“User qualifier character” specified on the SSSCONFIG command. The user qualifier character
you use is determined by the support person with whom you are working.
System Requirements
These are the requirements for using SSS:
1. SSSCONFIG creates a user profile and names it SSSxUSER, where x is the user qualifier
character. Sterling Commerce customer support uses the SSSxUSER profile to access
your system.
2. A user profile with at least SECADM authority must be used to run SSSCONFIG. This is
necessary to create the SSSxUSER profile and make the necessary SNADS distribution
directory entries. Likewise, SECADM is required for SSSREMOVE.
3. Your system must have the subsystems QSNADS and QCMN active, and must have a
communications entry for device *ALL and mode *ANY in the QCMN subsystem. You
can see which subsystems are active by using the WRKSBS command. Both subsystems
must display on the Work with Subsystems display. Assuming QCMN displays, you can
check for the communications entry by doing an option 5 (Display subsystem description)
and then 8 (Communications entries). SSSCONFIG does not set up the subsystems or
communications entry.
4. Your system must have a communications line and synchronous modem available. Your
best bet is to use the line and modem that are used for IBM ECS (Electronic Customer
Support). You need to know the resource name (LINxxx) to which the modem is attached.
Tell the support person working with you the phone number to dial to connect to that
modem.
1. Verify the availability of the system requirements listed previously. Tell the customer
support person the phone number to dial to connect to your modem.
2. Use the SSSCONFIG command to configure your system to answer. Specify the user
qualifier character given to you by customer support.
3. If the customer support person will need to access your Gentran:Server system, use the
“Work with Environment Control” option from the GENMAIN menu to add the user id
SSSxUSER which corresponds to the user profile created by SSSCONFIG.
# NOTE
Replace the x in SSSxUSER with the user qualifier character from step 2.
5. When customer support has finished using the connection, use the SSSOFF command to
make the SSS connection unavailable, and make your line and modem available for other
uses.
6. If customer support needs to access your machine again, use the SSSON command to
make the SSS connection available.
7. When the problem has been resolved to the point that customer support no longer needs to
access your system, delete the SSS configuration by using the SSSREMOVE command.
Specify the same user qualifier character that was used for SSSCONFIG.
Command Descriptions
SSSCONFIG
The SSSCONFIG command is used to configure your system to run Sterling Commerce Software
Support. This includes creating line, controller, and device descriptions, creating the SSSxUSER
profile, and adding the entries needed for SNADS. To make them easy to identify, all of the objects
created have names starting with SSSx, where x is the user qualifier character.
# NOTE
The SSSCONFIG command requires at least SECADM authority to run. Since not everyone
has SECADM authority, you may need to get the system administrator to run the
SSSCONFIG command.
Once configured, the system can be enabled and disabled without any special authority, so the
system administrator is not needed again until you want to delete the SSS configuration.
Field Definitions
User Qualifier Character
This parameter specifies the character that will be used to qualify all names of objects used
for the SSS connection. For example, if the user qualifier is A, the profile SSSAUSER will
be created, and the session will use line SSSALN, controller SSSACT, and device
SSSADV. The support person you are working with will tell you the user qualifier
character to use.
) RECOMMENDATION
Ideally, the SSSxUSER profile should be modeled after the profile used by the
person working with customer support. That way, when customer support signs on
as SSSxUSER, they will have the same library list, job description, authorities, and
see the same displays and menus as the person with whom they are working.
As the SSSCONFIG command configures your system, progress messages display. The command
should complete in a minute or two. If it completes successfully, your system will be waiting to
answer a call from Sterling Commerce’s customer service system.
SSSREMOVE
The SSSREMOVE command allows you to “clean up” your system after Sterling Commerce
customer support has finished using SSS. It will delete all the objects and SNADS entries that SSS
created. It will not delete the SSS programs and commands, so SSS can be reconfigured any time
you need it.
# NOTE
This command must be run from a user profile with at least SECADM authority.
You must not be signed on as SSSxUSER when you issue the SSSREMOVE command, because it
needs to delete the user profile.
The SSSREMOVE command requires one parameter, which is the user qualifier character. Specify
the same user qualifier character that was used on the SSSCONFIG command.
SSSON
The SSSON command varies on the line (SSSxLN), controller (SSSxCT), and device (SSSxDV)
used by SSS and verifies that they achieve the proper state for connection. If they do not, a
warning message will be issued.
When the line, controller, and device are varied on, the communications line and modem are
available for SSS, and are not available for other uses.
The line, controller, and device must be varied on before the modem will answer calls and allow a
connection to be established.
The SSSON command accepts one optional parameter: the user qualifier character. You should not
need to specify this parameter.
SSSOFF
The SSSOFF command varies off the line, controller, and device and verifies that they all achieve
varied off status.
You should use the SSSOFF command after Sterling Commerce has finished using your machine.
This stops your system from answering calls, and makes the SSS connection temporarily
unavailable. If Sterling Commerce needs to access your system again, you can use the SSSON
command to make the connection available.
Varying off the configuration makes the communications line and modem available for other uses,
such as ECS. Therefore, you should always keep the configuration varied off when the SSS
connection is not needed.
The SSSOFF command accepts one optional parameter: the user qualifier character. You should
not need to specify this parameter.
Command Examples
After completing the SSSCONFIG command, the SSS system will be varied on and
waiting to answer a call.
# NOTE
The user profile issuing the SSSCONFIG command must have at least SECADM
authority. Therefore, the SSSAUSER profile in this example would be created with
equivalent authority because the MODEL parameter was allowed to default to
*CURRENT.
After completing this command, the SSS system will be varied on and waiting to answer a
call.
2 Environment Control
In this Chapter
¾ What is Environment Control? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
¾ What Does the Environment Control Subsystem Do? . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
¾ Panel Quick Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
¾ Use the Environment Control Panels . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Access the Subsystem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Manage User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
Define the Environment Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-7
Define the Security Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-9
¾ Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
EBDI201—Environment Control Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-14
1. Environment profile – parameters (such as the User ID, Name, Division, Output Queue,
Language ID, Date Format, etc.) that affect the environment in which the user runs jobs.
2. Security profile – authority codes that define which Gentran:Server subsystems and
functions the user can access and whether the user has privilege to view data only or to
update data.
Add new users to the Gentran:Server system by creating a new user profile or copying an
existing one.
View, modify, or delete existing user profiles.
Define environment options that control how the user’s jobs run.
Identify which subsystems and functions each user can access.
Define each user’s update privileges for the subsystems and/or functions to which they have
access.
Print environment control profiles.
# NOTE
All Gentran:Server User IDs must be valid User IDs on the iSeries system. See your Security
Officer (QSECOFR) for the iSeries User IDs for your site.
Figure 2.2 shows panel EDIX200-FMT01 and three ways to use it.
Select an Option
The Work with Environment Control panel (EDIX200-FMT01) has five options:
To create a user profile, you must specify a valid iSeries user profile that is not yet defined in
Gentran:Server. All other options (revise, copy, delete, view, and print) can be performed only
after a User ID has been created in Gentran:Server.
Specify a User ID
There are three ways to specify a User ID on panel EDIX200-FMT01:
1. Type ‘1’ and the new User ID on the key entry line and press Enter. (The value you type
for User ID must be a valid iSeries User ID.)
2. The system displays the Environment Control panel (EDIX201-FMT01), which defines
the user’s environment profile. (This panel is shown later in the chapter.) Notice that the
field entries are the environment parameters from the iSeries user profile. Change the
appropriate fields and press Enter, F8 (Next), or F10 (Update).
When you create a new Gentran:Server User ID through the copy option, the system copies the
specified environment profile as it currently exists. The copy option does not retrieve the
parameters from the iSeries user profile.
4. The system adds the new Gentran:Server User ID and returns to the Work with
Environment Control panel (EDIX200-FMT01).
—OR—
Type ‘2’ and the User ID on the key entry line and press Enter.
2. The system displays the Environment Control panel (EDIX201-FMT01), which defines
the Environment Profile. (This panel is shown later in the chapter.) Type the new
information in the appropriate fields and press Enter or F8 (Next).
3. The system displays the Environment Control panel (EDIX201-CTL02), which defines
the user’s Security Profile. (This panel is also described later in the chapter.) Change the
appropriate authority codes and press F10 (Update).
—OR—
Type ‘3’ and the existing User ID on the key entry line and press Enter.
2. A pop-up window displays with a single field, “Copy To.” Type the User ID for the new
User Profile in this field. (Remember that you must type a valid iSeries User ID.) The
system displays panel EDIX201-FMT01.
3. If you need to make changes to the new User Profile, follow Steps 2, 3, and 4 in the
procedure topic “Create a User Profile.”
—OR —
Type ‘4’ and the User ID on the key entry line and press Enter.
2. Confirm that you want to delete the record by pressing F11 (Delete). To cancel the Delete
function, press F12 (Cancel).
—OR—
Type ‘5’ and the User ID on the key entry line and press Enter.
2. The system displays the Environment Control panel (EDIX201-FMT01), which defines
the environment profile and is described later in the section.
3. To view the security profile, press Enter or F8 (Next) and the system displays the
Environment Control panel (EDIX201-CTL02), which is described later in the section.
—OR—
Type ‘6’ and the User ID on the key entry line and press Enter.
Division . . . . . . . . . . . . . 000
Last Name. . . . . . . . . . . . . Ingram
First Name . . . . . . . . . . . . Elizabeth
MI . . . . . . . . . . . . . . . . D
Initials . . . . . . . . . . . . . EDI
When you first access panel EDIX201-FMT01 to create a new user, the fields contain the run time
parameters from the user’s iSeries user profile. (SEE the iSeries documentation or your Security
Officer (QSECOFR) for more information.) Any values you change on this panel will override
the user’s iSeries options for Gentran jobs that are executed.
Field Information
This section contains information about specific fields, and in some cases, recommendations for
settings.
Date fields on panels (excluding commands, which are controlled through the system
configuration file – see Note below)
Report dates
# NOTE
To apply these date settings to command panels, use *ENVCTL as the value in the ‘Set
Gentran Date Formats for Commands’ option on the system configuration file. (SEE the
“System Configuration” chapter in the Technical Reference Guide for more information.)
Language ID
The Language ID identifies the language-specific message file used for Gentran processing. By
default, the system supports English message files (denoted as ENU or ENP). Press F4 (Prompt)
for a list of valid values.
The Environment Control panel (EDIX201-CTL02) defines a user’s security profile. This panel
allows the EDI Coordinator to control each user’s access to whole subsystems and to individual
functions within subsystems. Panel EDIX201-CTL02 also determines the data privileges (view
only or update) for the subsystems and/or functions to which the user has access.
)RECOMMENDATION
The EDI Coordinator (System Administrator) and iSeries Security Officer (QSECOFR)
should be the only ones with update access to the Environment Control panel
(EDIX201-CTL02). This is necessary to protect the integrity of the system.
Figure 2.4 shows the primary components on the Environment Control panel (EDIX201-CTL02).
As you work with panel EDIX201-CTL02, keep in mind that you can use online help to display
the valid authority codes (and their meanings) for each level. To do this, move the cursor to the
authority code field and press F1 (Help). To select a code, press F4 (Prompt).
When you create a new user profile, all the authority codes are initially set to ‘1.’ To change the
authority codes, move the cursor and type over the existing value. When you finish making
changes, press Enter or F10 (Update). Press Enter to resequence information on the panel (the
subsystem, function, and data level entries) based on the new authority codes you entered on the
panel. Press F10 (Update) to confirm the add of the new user profile and return to the Work with
Environment Control panel (EDIX200-FMT01).
Subsystem
This field lists the subsystems:
Application Definition
Audit
Communications
Environment Control
Message Center
Partner
Processing
SAP Extension
Standards
System Administration
Transaction Mapping
Viewpoint
# NOTE
The Utilities subsystem is listed with the Gentran:Server subsystems on the Environment
Control panel (EDIX201-CTL02). This subsystem is for internal use only. The authority
code should be set to ‘1.’
Level
This field defines the scope of the authority code. Security can be defined for these three levels:
Subsystem – the authority code applies to accessing the whole subsystem identified
underneath “Subsystem” on the panel.
Function – the authority code applies to accessing the part of the subsystem identified
underneath “Function Name” on the panel. Function names are either panel names (like Work
with Application Definition and Application Fields) or F4 (Prompt) windows such as
Application Definition Search. Function levels display on the panel only if the Subsystem
level authority code is ‘2’ (partial access). The valid values for authority codes are explained
in the subtopic “Authority Codes.”
Data – the authority code applies to the data on the panels within the whole subsystem (if the
Subsystem level authority code is ‘1’) or within a function (if the Subsystem level authority
code is ‘2’). Data levels do not display on the panel if the Subsystem level authority code is ‘3’
(no access).
Function Name
When the Level field is set to Function, there is an entry in the Function Name field, otherwise this
field is blank. The function name consists of the program or command name and a corresponding
description.
Authority Codes
The authority codes vary in meaning based on whether the Level field (two columns to the right of
the authority code) contains “Subsystem,” “Function,” or “Data.”
‘1’ ALL – The user has access to the entire subsystem. When the Subsystem level authority
code is ‘1,’ the panel does not display individual functions since the user has access to all
functions in the subsystem. The panel displays the Data level authority code, which
determines the user’s data update privileges for the given subsystem. In the security
profiles for the EDI coordinator and Security Officer (QSECOFR), every Subsystem level
authority code should be ‘1.’
‘2’ PARTIAL – The user’s access to the subsystem is defined on a function-by-function basis.
Access is determined by the authority code on each line that contains “Function” in the
Level field. (SEE “Function” below for details.) When the Subsystem level authority code
is ‘2,’ the panel displays all the functions in the subsystem, with an authority code
associated with each one. The panel also displays the Data level authority codes, which
determines the user’s data update privileges for the subsystem.
# NOTE
The Subsystem level authority code must be set to ‘2’ (PARTIAL) if you want to define
access at the Function level (on a function-by-function basis).
‘3’ NONE – The user cannot access the subsystem. (The name of the subsystem still displays
on the GENMAIN menu, but the user cannot access the subsystem panels.) When the
Subsystem level authority code is ‘3,’ the panel does not display Function level or Data
level authority codes since they have no meaning in this case.
‘1’ ALL – The user can access the function listed under “Function Name.”
‘3’ NONE – The user cannot access the function listed under “Function Name.”
# NOTE
The Data level authority code determines the user’s data update privileges for the subsystem.
To define Data level privileges, the Subsystem level authority code must be set to ‘1’ (ALL)
or ‘2’ (PARTIAL).
If the Subsystem level authority code is ‘1,’ then the Data level code applies to the data on
any panel within the whole subsystem.
If the Subsystem level authority code is ‘2,’ then the Data level authority code applies to data
on only those panels within the given function.
Data level can have an authority code of ‘1,’ ‘2,’ or ‘3,’ as explained below.
‘1’ ALL – The user can update the data if the Update Allowed field is set to ‘Y.’ The user can
change the Update Allowed field.
‘2’ PARTIAL – The user can update the data if the Update Allowed field is ‘Y.’ The user has
display only rights if the Update Allowed field is ‘N.’ The user cannot change the Update
Allowed field.
‘3’ NONE – The user can only display the data. The user cannot change the data or the
Update Allowed field.
Reports
EBDI201—Environment Control Report
Special Considerations
Like all other Gentran:Server reports, the Environment Control Profile Report automatically goes
to the Output Queue defined for the user running the job.
EBDI201 RUN DATE 04/30/08 ENVIRONMENT CONTROL PROFILE REPORT RUN TIME 16:40:06 PAGE 1
USER ID. . . . . . . QSECOFR JOB DESCRIPTION. . . GENTRAN PRINT FILE. . . . . . . . . . . . . QSYSPRT
DIVISION . . . . . . 000 PRINT DEVICE . . . . PRTHOLD GENTRAN:SERVER PROGRAM LIBRARY. . . G3X5PGM
LAST NAME. . . . . . Officer OUTPUT QUEUE . . . . PRTHOLD GENTRAN:SERVER DATA LIBRARY . . . . G3X5TSTDTA
FIRST NAME . . . . . Security MESSAGE QUEUE. . . . QSECOFR DATE FORMAT/DATE SEPARATOR. . . . . *SYSVAL *SYSVAL
MIDDLE INITIAL . . . JOB QUEUE. . . . . . QBATCH LANGUAGE ID . . . . . . . . . . . . ENU
Sample Report
INITIALS . . . . . . SEC
SEC SUBSYSTEM LEVEL FUNCTION NAME
------------------------------------------------------------------------------------------------------------------------------------
1 Application Definition Subsystem
1 Application Definition Function APPCPY Copy Application ID
1 Application Definition Function APPRENBR Application Renumber
1 Application Definition Function APPSYNCH Application Synchronization
1 Application Definition Function EDIX550 Work with Application Definition
1 Application Definition Function EDIX551 Application Definition Search
1 Application Definition Function EDIX552 Application Definition
1 Application Definition Function EDIX553 Application Records
1 Application Definition Function EDIX554 Application Fields
1 Application Definition Function EDIX556 Application Key Structure
1 Application Definition Function EDIX556S Application Field Key Prompt
1 Application Definition Function EDIX559 Application Partner Reference
1 Application Definition Function EDIX559S Application Partner Reference Prompt
1 Application Definition Function EDIX560 Application Envelope Definition
1 Application Definition Function EZAPPDEF ez Application Definition
1 Application Definition Function EZAPPDEF2 ez Application Definition
2 - 15
Environment Control Reports
Report Header
Job Description Specifies the job description under which the Gentran server jobs are
executed.
Gentran:Server Name of the library where all Gentran:Server programs are stored.
Program Library
Output Queue Specifies the name of the output queue to which the output files will be
printed.
Gentran:Server Data Specifies the name of the library where all Gentran:Server data files are
Library stored.
Message Queue Specifies the name of the queue where the messages are stored.
Date Format/ Specifies the format and separator used when displaying dates on
Date Separator screen and in printed reports.
Job Queue Specifies the name of the job queue to which the jobs are submitted.
Detail Section
Sec(urity) Code Identifies whether the user can access a subsystem or function.
Common Questions
What if I want two Gentran:Server User IDs?
If you are both the QSECOFR (or EDI Coordinator) and a Gentran:Server user, you may want two
User IDs with different Security Profiles. Another reason for two User IDs is to define two
different environment profiles (i.e. different job descriptions or division codes).
To have two Gentran:Server User IDs, you need two separate iSeries User IDs and then follow the
steps in “Creating a User ID.”
# NOTE
See “Define the Environment Profile” on page 7 in this chapter for more information about
setting up environment profiles, and see the “System Configuration” chapter in the Technical
Reference Guide for more information about working with the system configuration file.
3 Partner
In this Chapter
The “Partner” chapter explains what the trading partner profile is and how it is used within
Gentran:Server for iSeries. You must set up a partner profile for every trading partner with whom
you exchange inbound and/or outbound EDI transactions. This chapter covers the following
topics:
What is a Partner?
In EDI, anyone to whom you transfer documents is called your trading partner. These trading
partners may have been known to you as your “Customers” or “Vendors.” You can think of the
trading partner subsystem as a Rolodex that holds all the information about your trading partner(s).
If you mail a document to your trading partner, you need to know the destination address and
where that information is stored. The same type of information is needed by Gentran:Server when
the document is sent electronically. Setting up the partner profile entails identifying key
characteristics of your EDI environment and your partner’s environment associated with “how the
mail is sent” and “where it is sent.”
Define cross references between Partner IDs and segments in the EDI control envelope
Figure 3.1 shows the structure of the partner profile with the eight different types of records used.
Trading Partner ID
User Error
Group Defined Rejection
Cross
Transaction Reference
Mandatory
Optional
An EDI standard contains three levels of control that allows you to verify the accuracy and
completeness of the data that you exchange with your trading partner. Each level is referred to as a
“control envelope.” A control envelope contains two data segments (an EDI data segment is
defined as one or more related data elements):
The Envelope Header Segment precedes the EDI data to which it pertains.
When you set up the trading partner profile in Gentran:Server, you define these controls.
User Information
Besides the required EDI control information that you identify for each trading partner,
Gentran:Server allows you to define several optional pieces of information.
User Defined
This file contains additional notes (FYI comments and scratch pads) that you may want to
maintain for a particular trading partner.
This information can be particularly useful if you have a special need for accessing information
stored in the Partner file from your own programs.
Data Separation
“Data Separation” provides the instruction on how to route or “split” the data. Splitting is used
during inbound processing to route or separate the data into different intermediate processing files
(called split files). These split files are passed to another step in the processing.
Although splitting is not required, it is highly recommended. Splitting improves the efficiency and
throughput of the mapper. It also enables you to trap unexpected documents and it allows for better
error recovery of documents trapped.
Data should be split based on the type of application it is destined for. For example, purchase order
documents should be grouped together and mapped into purchase order application files. Invoice
documents should be grouped together, separate from the Orders, and mapped into invoice
application files. (SEE the “Splitting” chapter in the Technical Reference Guide for more
information on data splitting.)
Cross Referencing
Setting up a cross reference is like setting up an alias or a nickname. Referring back to our
Rolodex address analogy, defining a cross reference is similar to setting up multiple indexes or
names for the same Rolodex card. You might want to reference the card by Vendor ID, perhaps by
Vendor name or zip code, or whatever is convenient for you. You still want only one card with
complete information about your partner; you just want to cross reference it in a variety of ways.
The Gentran:Server cross referencing feature allows you to ‘tie’ various fields in either the EDI
Control Envelope or in your application files to the partner profile. While this is not a required task
in Gentran:Server, there are times when cross referencing can result in a significant savings of
time and effort.
Error Rejection
Error rejection is managed by a combination of parameters defined in the Global Parameters
subsystem and in the Partner subsystem.
Error records may be added to the partner profile to identify how Gentran:Server should manage
data that does not pass compliance checking against the standards. This is done to prevent records
from being sent out or from being interfaced to your applications.
Before you begin to enter information into the Gentran:Server Work with Partner subsystem, you
may also find it beneficial to spend some time collecting and preparing the information which you
will need. Doing so will significantly simplify the tasks which you will need to perform.
The following questionnaire can assist you with this process, with some examples included inside
parentheses. (For a detailed worksheet, SEE the Manager’s Implementation Planner.)
What is your trading partner’s EDI ID and Qualifier for the interchange level?
Usually, a DUNS number or phone number is used. (ISA05-06)
What is your company’s EDI ID and Qualifier for the interchange level?
Usually, a DUNS number or phone number is used. (ISA07-08)
What is your partner’s group level EDI ID and what is yours? (GS02/GS03)
Will you be sending the same EDI ID at the group and interchange levels?
Are you doing inbound sequence number checking? If so, at what level (interchange, group, or
transaction)?
Inbound sequence number checking means checking inbound control numbers to verify if they
are received in the proper sequence.
For ANSI X12 users only: what is your partner’s Authorization and Qualifier, if used?
(ISA01-02)
For BG users only: what is your partner’s Communication ID, if used? (BG01)
For ANSI X12 users only: what is your partner’s Security Code and Qualifier, if used?
(ISA03-04)
For BG users only: what is your partner’s Password, if used? (BG02)
What separators and terminators does your partner require? Are there certain characters that
your partner cannot recognize? Are there certain values that might be found in the data? These
will be used in the envelopes for outbound data.
• Subelement Separator:
If using ISA envelopes, “>” is recommended
• Element Separator:
If using BG envelopes, “*” is recommended
If using ISA envelopes, “*” is recommended
• Segment Terminator:
If using BG envelopes, “HEX15” is recommended
If using ISA envelopes, “HEX15” is recommended
Which documents (groups and transactions) will you exchange with this partner and which
direction are they going (inbound or outbound)?
For example, an ANSI X12 purchase order is transaction ID 850.
EDIX012-FMT01 Partner Control Base Select option ‘1’ through ‘5’ on panel
Information EDIX005-FMT01
Partner Control
Type ‘EXCPGM EDIX012’ on the command
line
EDIX031-FMT01 Partner Group Base Select option ‘1’ though ‘5’ on panel
Information EDIX030-FMT01
Partner Group
Type ‘EXCPGM EDIX031’ on the command
line
Print Partner File Print a partner or Select option ‘6’ on panel EDIX005
(PRTPAR) range of partners
Press F21 (Prt Part) on partner panels
Type ‘PRTPAR’ on the command line
Print Partner Cross Print cross references Select option ‘31’ on panel EDIX005
Reference for one or multiple
(PRTPXR) partners Press F20 (Prt X-Ref) on panel EDIX008
Type ‘PRTPXR’ on the command line
Selected Print Print Partner Query Select option ‘32’ on panel EDIX005
Partner Queries Reports using
(PRTPARQRY) selection criteria Type ‘PRTPARQRY’ on the command line
Figure 3.2 Select option ‘1’ on the GENMAIN menu to Work with Partners
Selecting the “Work with Partners” option from the main menu, as shown in Figure 3.2, displays
the Work with Partners panel (EDIX005-FMT01), as shown in Figure 3.3. All tasks associated
with setting up and/or modifying the trading partner profile are available from the Work with
Partners panel.
You can complete some of these tasks from a single panel; other tasks require that you complete
more than one panel of information. For these tasks, Gentran:Server steps you through all the
required panels and prompts you to fill in all the information necessary to complete the task.
Some tasks are required tasks; others are optional and can be performed as your needs dictate.
16=Error Rej 17=Cross Ref 30=Copy Partner 31=Print X-Ref 32=Print Qry
Figure 3.3 The Work with Partners panel is the starting point for all partner-related tasks
You can perform the following tasks, which are documented in this chapter, from the Work with
Partner panel (EDIX005-FMT01):
Print Reports
Access Partners
There are several ways to access partner information by using different sorting methods. Press F15
(Sort) to access the list of Sort options. You can sort partners by:
Partner Name
Partner ID, Partner Qualifier, Partner Cross Reference, Cross Reference Qualifier
Figure 3.4 shows the Work with Partners panel (EDIX005-FMT01) after pressing F15 (Sort).
The Partner Cross Reference listing is extremely useful when you have an EDI identifier from the
ISA or GS envelope, for example, and you need to work with that partner. Figure 3.5 shows
partners sorted by Cross Reference ID and Qualifier.
MODEL 123456789
AAA WAREHOUSE CO 11 01 459281001
C13579 987654321
C13579 987654321 01
BG-PARTNER BGPARTNER
ISA-PARTNER ISA2
MYCOMPANY MYDUNS
ICS-PARTNER SUPPLIER 375
TPCOMPANY TPCO
More...
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Figure 3.5 Work with Partners panel sorted by Cross Reference ID, Qual
By sorting partners this way, you can access the Work with Partners panel by the EDI identifier or
cross reference ID and maintain the corresponding partner.
# NOTE
The default sort for the Work with Partners panel is set as an option on the System
Configuration menu, Set Partner Sort Option. SEE the Technical Reference Guide for more
information about working with system configuration options.
During this task you will be asked to enter a new Partner ID, determine the interchange type for the
partner profile and then enter information about the partner’s interchange type into various panels.
Figure 3.6 illustrates the order to enter the partner information.
Partner Control
(EDIX012-FMT01)
Step 2:
Enter the Partner Control Information
Partner Control
(EDIX012-FMTnn)
Step 3:
Enter the Outbound Partner Information
# NOTE
This example walks you through setting up a partner for an ISA interchange. If you need to
set up a partner for a different type of interchange, such as the BG interchange (often used in
the Grocery industry), you can follow the same steps as described here. The only difference is
the fields on individual panels.
Gentran:Server requires that you define a unique “profile” for every partner with whom you
exchange EDI documents. The Partner ID when combined with the Partner Qualifier forms a
unique identifier for the partner profile. You may use any alphanumeric value you like for the
Partner ID. Typically, most users choose an easily recognizable reference.
)RECOMMENDATION
Choose a Partner ID from one of these three types:
1. Description ID: Select a name such as a company name.
2. Application ID: Select the partner name as recognized by your internal
applications, such as Vendor ID or Customer Number.
3. EDI ID: Choose the identifier that your partner is known by on the EDI
control envelope such as a DUNS number, UCS or VICS Comm ID, or
Phone Number.
Figure 3.7 Work with Partners panel (EDIX005-FMT01): Defining a new Partner ID
To define a new partner profile, on the Work with Partner panel (EDIX005-FMT01), type ‘1’ in
the Option field on the key entry line, type the Partner ID on the key entry line, and press Enter.
# NOTE
In Figure 3.7, TPCOMPANY is being used as the Trading Partner ID. TPCOMPANY is
already defined in the Tutorial library (G3X5SAMP) where you can reference it to follow the
entries added throughout the examples. If you would like to follow along with the tutorial,
you can also create a new Partner ID (say, EDICOMPANY) and follow the steps, entering the
values exactly as described in this section.
The Partner Control panel (EDIX012-FMT01) displays next, as shown in Figure 3.8.
Partner Control panel (EDIX012-FMTnn – where ‘nn’ will vary based on the interchange
type) is used only for outbound processing information and indicates the values loaded into the
EDI control envelope interchange header for transmissions.
Only a few of the fields on the first partner control panel are mandatory. The rest of the fields can
be either left blank or filled in at a later time when you know more about how you would like to
run your application. See the description of the particular panels later in this chapter for details.
For this example, we will only fill in the mandatory fields.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . *** Name Not on File***
Division . . . . . . . . . . . . . 000
Interchange Header Option. . . . . ISA
Last Incoming Sequence Number. . .
GS Sender ID Qualifier . . . . . . N
GS Receiver ID Qualifier . . . . . N
Expect a TA1, AC1, or UCI. . . . . N
Acknowledge Interchange. . . . . . N
Acknowledge Group or Trans . . . . T
Acknowledge Errors . . . . . . . . N
Purge Acknowledged . . . . . . . . N
Purge Reported . . . . . . . . . . N
Purge Older Than Days. . . . . . .
Last Incoming BG Password . . . . Set 209 Errors . . . N
Comm Profile ID. . . . . . . . . . CN3BSC Group Profile ID . . N
Last Incoming UNB/STX Seq. No. . . Update Allowed . . . Y
Figure 3.8 Required fields for the Partner Control panel (EDIX012-FMT01)
If you are not doing outbound processing, you may skip the next panel. To do so, press F10
(Update). The message “Unable to process request. Panel must be reviewed.” displays. Since the
interchange envelope is not required for inbound processing, you may ignore this message. Press
F10 (Update) again to return to the Work with Partners panel (EDIX005-FMT01) where you can
execute other tasks.
If you are planning to do outbound processing, (for example, for invoices), then the additional
panel of information must be filled in. In this case, after entering all the required information, you
should press Enter. You will be automatically advanced to the next panel. The field descriptions
for EDIX012-FMTnn and recommended entries follow.
This feature is not commonly used and may only benefit you if you have several users
defining partners or several divisions using Gentran:Server. In these cases, users are
limited from accessing or modifying partner information that is not relevant to them.
) RECOMMENDATION
Leave the default value that displays. If you are unsure, talk with the individual
responsible for Gentran:Server administration.
) RECOMMENDATION
Specify the Interchange Header Option that your partner is going to send you or is
requesting from you.
Partner Name
You may notice in Figure 3.8 that the Partner Name field contains the value “*** Name
Not On File ***.” This will automatically default to the Partner ID that you entered when
the record is updated. You can change the name to be something other than the Partner ID
by using option 13, Name & Address. This process is described in detail later in this
section.
# NOTE
The incoming control number must be numeric to activate this feature. The global
parameter, Sequential Check Control or Sequential Error Control, must also be
turned on (set to ‘Y’). (SEE the “Global Parameters” chapter in the Technical
Reference Guide for more information.)
For example, let’s say that the value in this field is ‘1’ and you receive an interchange from
your trading partner with a control number of ‘5.’ A message displays on the Inbound
Editor Report indicating that control number ‘5’ was received, but ‘2’ was expected. The
control number ‘5’ is also updated for this partner.
The benefit of this feature is only realized if you contact the partner whenever this happens
and try to determine if you missed some interchanges. Typically this is not done, as it is
time consuming and often does not lead to missing data. It usually happens when your
partner reprocessed data without resetting the control numbers, leading to a jump in the
numbers you receive.
# NOTE
This field is not applicable for EDIFACT or TRADACOMS documents.
) RECOMMENDATION
Leave the Last Incoming Sequence Number field blank to deactivate the feature.
If you plan on using this feature (set the flag to ‘Y’ or ‘I’), it is advisable to set the Partner
ID equal to the Interchange Identifier as well as the Qualifier.
‘Y’ Gentran:Server looks for a partner using two fields: the Group Identifier from the
GS envelope tagged with the Qualifier from this panel.
‘N’ Gentran:Server looks for a partner using just the Group Identifier from the GS
envelope. Blanks are filled in for the qualifier. If the partner is not found, the
Cross Reference file is searched for a match. This value is the default.
‘I’ Gentran:Server looks for a partner using two fields: the Group Identifier field
from the GS envelope tagged with the Qualifier field from the partner that was
selected at the interchange level.
# NOTE
This field is not applicable for EDIFACT or TRADACOM documents.
) RECOMMENDATION
Set these fields to ‘N’ and leave the corresponding 2-byte qualifiers blank. You need
to set up all identifiers for this partner in the Partner Cross Reference file.
When processing outbound interchanges, the Outbound Editor logs the interchange in the
Audit file if the Audit Interchange global parameter is set to ‘Y.’
There is an acknowledgment status flag for every interchange logged in the Audit file. The
flag can be used when printing the Audit report to determine if all documents sent to your
partner have been acknowledged. If the interchange is not specifically acknowledged with
this TA1 or AC1 acknowledgment or UCI segment, the status flag is blank. If you print the
Audit Report showing all unacknowledged documents, the interchanges display even
though you may not have expected your partner to acknowledge it. In this case, it is not an
error to have not received an interchange acknowledgment. The user may want a method
of turning this feature off for any document that is not expected to be acknowledged.
) RECOMMENDATION
Set this to ‘N’ since interchange acknowledgments are not typically used in the
industry. Normally, your partner does not acknowledge ANSI interchanges sent to
them. If utilizing EDIFACT standards, the UCI interchange segment is used.
Acknowledge Interchange
This flag is used for inbound processing to determine if an interchange acknowledgment is
generated in response to the interchange just received. The interchange acknowledgment
is similar to specifying that you simply received an envelope of data, but have not looked
inside it to see what it contains.
The Inbound Editor looks at this flag if the Acknowledge Interchange global parameter is
set to ‘N’ and the Partner Acknowledge global parameter is set to ‘Y.’ If an ISA
interchange was received and this partner option is set to ‘Y,’ the Inbound Editor generates
the TA1 acknowledgment that acknowledges just the interchange. For an ICS interchange,
the AC1 acknowledgment is generated. For a UNA or UNB interchange, a CONTRL
acknowledgment is generated with the UCI segment.
) RECOMMENDATION
Set this to ‘N,’ unless a partner specifically asks for an interchange
acknowledgment. The UCI segment for EDIFACT is more commonly used.
The Inbound Editor looks at this flag if the Acknowledge Group and Acknowledge
Transactions global parameters are set to ‘N’ and the Partner Acknowledge global
parameter is ‘Y.’ Valid values are:
The type of functional acknowledgment may be the 997, 999, or CONTRL. Typically,
acknowledgments are sent at the transaction level so every document can be noted that it
was properly received.
If this field is modified to BLANK from a G or T, then all group records for this partner
are updated automatically with ‘N’ for the acknowledgement specific group and all
transactions.
# NOTE
This field is not applicable for TRADACOMS documents.
) RECOMMENDATION
Set this to ‘T’ unless a partner has indicated that you will only acknowledge at the
group level or not at all.
Acknowledge Errors
This flag is used for inbound processing to determine if an acknowledgment (interchange
or functional) is generated with errors encountered while compliance checking is being
done on incoming EDI data.
If this flag is set to ‘Y,’ the acknowledgment flag is overridden and an acknowledgment is
forcefully generated when an error is encountered, regardless of the level. An interchange
acknowledgment is generated if an error occurred at the interchange level, or for the group
and/or transaction if an error occurred at that level.
In addition, extra segments are generated in order to explain what type of error occurred,
which segment it occurred in, and the value that was in error. For the 997-type of
acknowledgment, the AK3 and AK4 pair of segments are sent back within the
acknowledgment to convey the error information. For the 999, the A1 segment contains
error information. The UCS and UCD segments convey error information for the
CONTRL. Typically, errors are not used since they need to be mapped into a document to
be effectively used, which is rare. Your partner must indicate if they want to see errors.
# NOTE
This field is not applicable for TRADACOMS documents.
) RECOMMENDATION
Set the Acknowledge Errors field to ‘N,’ unless a partner has indicated otherwise.
It is important to note that these options are only used for the Audit Purge by Partner
command (AUDITPURGE). The normal mode of purging data in the Audit file is to use
the Purge Audit command (PRGAUD) from the Audit subsystem. That option only uses
the run-time parameters to globally purge the Audit file.
If you have a specific need to retain data longer than the run-time parameters for a partner
versus another partner, you may run the customized Audit Purge command
(AUDITPURGE) instead. The Audit Purge command uses no run-time parameters – only
the parameters established on every partner’s Control record. (SEE the “Audit” chapter in
the Technical Reference Guide for more information on AUDITPURGE.)
These three parameters are used in conjunction with the AUDITPURGE command
process to purge:
if acknowledged
and if reported
and if older than x number of days
If you want to purge “If Acknowledged” and “older than X number of days” regardless of
whether it has been reported, specify ‘N’ for reported.
) RECOMMENDATION
Set to ‘N’ to deactivate (leave Purge Older Than Days blank). To purge the Audit
file data, use the normal purge process (PRGAUD) from the Work with Audit
subsystem.
If the BG partner global parameter is set to ‘Y,’ Gentran:Server verifies that the value in
the BG02 matches the BG Password field entered on this panel. If it does not match, the
data is suspended. If it does match, processing continues as normal. The exception to this
rule is if the BG Password was left blank in the Partner file. In this instance, no
verification is performed for the partner.
If receiving BG interchanges, set the BG Password to the value expected in the incoming
BG02 element.
) RECOMMENDATION
To deactivate, leave this field blank.
Comm Profile ID
This field is used for outbound processing to indicate where all outbound data for this
partner is routed to in the Work with Communications subsystem, unless the group profile
ID flag is set to ‘Y’ and there is a valid comm profile ID found at the group level. Unlike
some translation software, Gentran:Server integrates the communication module with the
translation module for one complete system. There are many Communication Profile IDs
that are pre-shipped with Gentran:Server. (SEE the “Using Communications” chapter in
the Communications Guide for more information.) Additional profiles may be created for
connections to other networks or with direct-connect partners.
If left blank, all data sent outbound to this partner is routed to the Communication Profile
ID called DEFAULT.
# NOTE
This profile ID can be overridden at the time of processing by specifying a Comm Profile ID
on the PRCTRNOUT (Process Transactions Outbound) command. If the profile is specified
on the processing command, all data for all partners processed in that run will be routed to the
override profile ID instead of the partner’s Comm Profile ID.
The Comm Profile ID is the only connection between the Processing subsystem of
Gentran:Server and the Work with Communications subsystem of Gentran:Server. For
example, when communications are established for a network, the information about the
number to dial, the line to use, etc. is stored under the Comm Profile ID in the Work with
Communication subsystem. EDI data that is ready to be transmitted to this network is
loaded into the outbound queue under the specific Comm Profile ID. It is sent when a
communication session is established for the specific network.
STOP CAUTION
The Comm Profile ID must exist in the Communications Profile directory before it
can be entered on this panel. You may leave the Comm Profile ID field blank and
then update it when you know the Profile ID to be used. Press F4 (Prompt) to obtain
a list of valid profiles.
) RECOMMENDATION
Set this to the Communication Profile ID that represents where this partner’s EDI
data is sent, whether it is a Network or a Direct-Connect. If it is unknown at this
time, use the Profile ID called DEFAULT.
Group Profile ID
This flag is used to indicate whether or not the communication profile ID should be
overridden at the group level. If ‘Y’ is specified, it indicates that the group record should
be looked up to see if there is a comm profile that should override the partner/interchange
level profile. ‘N’ indicates that all data should be routed to the comm profile ID specified
at the interchange/control level. The default is ‘N’.
# NOTE
The system will set this flag to a ‘Y’ automatically whenever a group record for this partner
is updated and contains a group level Comm Profile ID.
Update Allowed
This flag is only used for online file maintenance to determine if any updates are allowed
to be made to this partner profile ID. If set to ‘N,’ no maintenance can be performed for
this partner.
If maintenance needs to be performed, the user must change the Update Allowed flag to a
‘Y.’ Updates can then be made from any partner record.
# NOTE
The user must have authority to change the Update Allowed flag for the partner.
Authority is set in the Work with Environment Control subsystem. The user must
have a Level 1 authority to the Work with Partner subsystem to change the Update
Allowed Flag.
) RECOMMENDATION
Set the Update Allowed to ‘Y.’ Before going into production, change the flag to ‘N’
to prevent any inadvertent changes.
The panel you see next depends on the interchange type which you entered on the previous panel.
In our example, because the ISA interchange type was entered on the previous panel, the Partner
Control panel (EDIX012-FMT05) displays next, as shown in Figure 3.9.
The cursor is positioned at the Authorization Qual field when this panel displays.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . *** Name Not On File ***
Figure 3.9 Outbound Partner Control Information for an ISA interchange type
To enter the outbound partner control information, type the field values as shown in Figure 3.9,
then press F10 (Update) to add the field values.
# NOTE
SEE your X12 standards manual for more information about what values are loaded into an
ISA segment.
Field Descriptions
If you are doing outbound processing, all the fields on this panel must be filled in, except for the
Authorization and Security Code fields, which can be left blank. At this time however, you may
not know all the information that is required to complete the panel. Enter as much information as
you can at this time. Gentran:Server allows you to exit the panel without entering all the field
values. If you are doing outbound processing, you must return to this panel and fill in all the
ISA segment fields.
is usually you. However, this information is not typically used since authorization
information is not usually required within the industry.
If you are not using the authorization information, the Authorization Qualifier must be
coded as ‘00’ to indicate that the contents of the Authorization field are blank.
) RECOMMENDATION
Type the value ‘00’ in Authorization Qual and leave the Authorization field blank.
If you are not using the security information, the Security Code Qualifier needs to be
coded as ‘00’ to indicate that the contents of the Security Code are blank.
) RECOMMENDATION
Type the value ‘00’ in Security Code Qual and leave Security Code blank.
The Sender ID Qualifier indicates what type of identifier is used in the Sender ID. For
instance, if a DUNS number is used, the Qualifier is ‘01.’ If a descriptive identifier is used,
the Qualifier is ‘ZZ.’ Refer to your standards manual for a complete listing of valid
qualifiers and identifiers.
) RECOMMENDATION
If you know your company’s DUNS number, type the value ‘01’ in Sender ID Qual
and enter your DUNS number in Sender ID. If you do not know this number, enter
the value of ‘ZZ’ in Sender ID Qual and a brief descriptive name for your company
in the Sender ID.
# NOTE
Make a note of the values for the Sender Qual and Sender ID fields. Cross reference
these values back to the Partner ID used to create yourself as a partner for inbound
splitting in Gentran:Server. You will set yourself up as a partner in a future step.
Your partner provides the identifier and qualifier. Discuss this with their EDI contact.
# NOTE
Make a note of the values for the Receiver Qual and Receiver ID. Cross reference
these values back to the Partner ID used to set up your trading partner.
Control Standards ID
The Standards ID value indicates whether this interchange is for domestic or international
use. ‘U’ indicates USA EDI Community, while ‘E’ indicates EDIFACT. This flag does not
impact any processing – it is just a requirement of using the ISA interchange segment.
) RECOMMENDATION
Type ‘U’ for the Control Standards ID flag.
Version
This value represents the version of the interchange, not the version of the document.
Typical interchange versions are: 00300, and 00400. Do not mistake this version with the
document version which is similar to: 002040, 003020, 004010, etc. Not all interchange
types have a version, but the ISA does. It is used to compliance check the interchange.
Typically, the interchange version is chosen based on the version of the document. Most
EDI users, when sending a document in a version higher than 004010, send the
interchange version as 00400. Review this value with your partner’s EDI contact.
Use
This indicator is not used for envelope generation. It is used by the Inbound and Outbound
Editors to override the interchange version in the EDI data that is compliance checked.
The Use flag is ONLY evaluated if the Interchange Version global parameter is set to
“Y” or “A.” (SEE the “Global Parameters” chapter in the Technical Reference Guide for
more information.)
‘A’ Always use the version coded in the Partner file for ISA12, regardless of the
version that is actually in the data.
‘I’ Use the version in the input data. Never override the version in the data.
Therefore, the version coded on this panel is never used for compliance checking.
‘D’ Default. Use the version in the input data, if valid. If the version is not found in the
Standards file, override the version and use the version coded in the Partner file
for compliance checking.
) RECOMMENDATION
Set this to ‘D’ for now and change the flag on an “as-needed” basis in the future.
Control Number
The control number is an identifier for the electronic document. Each envelope gets
“stamped” with a unique number to aid in tracking it. The interchange control number is
increased by one each time an interchange is sent out to this partner. Note that the number
gets increased immediately prior to loading it into the envelope. You can start the counting
at any number you desire.
) RECOMMENDATION
Initialize the Control Number value to ‘0.’
Ack Requested
This flag allows you to request that an interchange acknowledgment be sent back to you.
This does not mean that you are requesting a functional acknowledgment. Since the
interchange acknowledgment contains little information, it is not used in the industry and
is not very beneficial. The flag is similar to a “byte on/byte off” type of indicator. The
value ‘0’ indicates you do not want the acknowledgment. The value ‘1’ indicates you do
want the acknowledgment.
) RECOMMENDATION
Set the Ack Requested value to ‘0.’ This indicates that you do not want the TA1
interchange acknowledgment.
Subelement Separator
This separator indicates what special character is used for subelements. Even if your EDI
data does not include any subelements, this separator must still be sent and must not be
equal to the element separator. Refer to your X12 standards manual for more information
about subelements. Subelements were introduced to the X12 standards in version 004010,
where it was added to the MEA segment.
) RECOMMENDATION
The most common subelement separator is the greater-than sign (>). Review this
value with your partner’s EDI contact.
Element Separator
This separator is placed in the outbound EDI data between each element in a segment. It
must be a unique character that is not present in the data. Otherwise, it is impossible to
correctly parse the data once it is received.
) RECOMMENDATION
The most common separator is the asterisk (*). Review this value with your
partner’s EDI contact.
Segment Terminator
The terminator is placed in the outbound EDI data at the end of each segment. It must be a
unique character that is not present in the data and is not equal to the element separator.
Otherwise, it is impossible to correctly parse the data once received.
) RECOMMENDATION
The most common terminator is Hex 15 (new line character). Review this value with
your partner’s EDI contact.
Partner Group
(EDIX031-FMT01)
Step 2:
Enter the Group Information
Partner Group
(EDIX031-FMTnn)
Step 3:
Enter the Outbound Group Information
The first step in working with partner groups is to select the appropriate functional group ID(s).
This task begins from the Work with Partner Groups panel (EDIX030-FMT01). This panel may
contain partner defined groups for all Partner IDs, or for selected Partner IDs. This is determined
by the manner in which the Work with Partner Groups panel is accessed.
11 TPCOMPANY TPCOMPANY
UNA-PARTNER EXAMPLE OF A UNA PARTNER
VENDOR-1 TUTORIAL - XYZ COMPUTER COMPANY
VENDOR-2 TUTORIAL - BULK PAPER COMPANY
VENDOR-3 TUTORIAL - TWO WAY COMMUNICATIONS
VENDOR-4 TUTORIAL - RANDOM OFFICE SUPPLY
123456789 RECEIVER RECORD FOR SEPARATION
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Figure 3.11 Access the Work with Partner Groups panel (EDIX030-FMT01) from the Work
with Partners panel (EDIX005-FMT01)
Type ‘11’ in the Option field beside the Partner ID whose group ID’s you want to access on the
Work with Partners panel (EDIX005-FMT01), as shown in Figure 3.11. Press Enter.
When you first access the Work with Partner Group panel (EDIX030-FMT01) as shown in Figure
3.12, you will notice that there is one Group ID already defined – !!!DFT. This is the default
Functional Group ID which was automatically created when you set up the new partner profile.
Gentran:Server recommends that you create a functional group record for every type of document
you intend to trade with your partner – both inbound and outbound. For this example, two
functional groups will be examined:
Figure 3.12 describes the creation of the Group ID on the Work with Partner Groups panel
(EDIX030-FMT01).
Opt Group ID
1 PO
!!!DFT
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
To create a new group ID for the partner, type ‘1’ in the Option field, and the functional group
code in the Group ID field on the key entry line. Press Enter. Repeat this action for each group
that needs to be created. In our example, we’ve created a group ID for inbound purchase orders
(PO) and for outbound invoices (IN). After completing the necessary entries for a group code and
pressing Enter on panel EDIX030-FMT01, the Partner Group panel (EDIX031-FMT01) displays.
Field Descriptions
Group ID
The Group ID is the actual Functional Group ID from the standards in the GS01 element.
You will need to refer to your standards manual for a list of group identifiers that
correspond to a document, or press F4 (Prompt) for a list of valid Functional Group IDs.
# NOTE
The Group ID MUST be valid according to the standards. If you do not have a
standards manual, look up the code in Gentran:Server’s Work with Standards
subsystem (use the Default version to find the GS segment and look for codes under
the GS01).
The next step in defining the functional group(s) for the partner is to enter various compliance and
acceptance parameters for the functional group. The values that are entered on this panel depend
on the type of functional group being defined for the partner. There are two panels for partner
group information:
Partner Group panel (EDIX031-FMTnn), is used only for outbound processing information
and indicates the values loaded into the EDI control envelope group header for transmissions.
Figure 3.13 and Figure 3.14 display required and recommended values to enter for the two types of
functional groups being used in the example. Only a few of these fields are mandatory. The rest of
the fields can be either left blank or filled in at a later time when you know more about how you
would like to run your application.
Figure 3.13 Recommended and Required field values for an inbound group
To enter the required value for the functional group ‘PO’ (inbound purchase order), type the
standard version desired in the Compliance Version field. (You may also type the recommended
field values as shown in Figure 3.13.)
After completing the entries, press F10 (Update) to add the values. If the Send Group Outbound
field is set to ‘Y,’ an additional Partner Group panel (EDIX031-FMTnn) displays to specify the
outbound envelope information. This panel will vary based on the type of interchange selected. If
Send Group Outbound is set to ‘N,’ you will be returned to the Work with Partner Group panel
(EDIX030-FMT01).
Figure 3.14 Recommended & Required field values for an outbound group
To enter the required value for the functional group ‘IN’ (outbound invoice), type the standard
version desired in the Compliance Version field. (You may also type the recommended field values
as shown in Figure 3.14.)
After completing the entries, press F10 (Update) to add the values. If the Send Group Outbound
field is set to ‘Y,’ an additional partner group panel (EDIX031-FMTnn) displays to specify the
outbound envelope information. This panel will vary based on the type of interchange selected. If
Send Group Outbound is set to ‘N,’ you will be returned to the Work with Partner Group panel
(EDIX030-FMT01).
) RECOMMENDATION
Set the Compliance Version to the value that was requested by your trading partner
for this particular group.
‘A’ Always use the version coded in the Partner file for the Compliance Version
(above), regardless of the version that is actually in the data.
‘I’ Use the version in the input data. Never override the version in the data.
Therefore, the version coded on the panel above is never looked at to determine
compliance checking.
‘D’ Default. Use the version in the input data if valid. If the version is not found in the
Standards file, override the version and use the version coded in the Partner file
for the Compliance Version (above).
) RECOMMENDATION
Set the Compliance Version Use field to ‘D’ for now and change it on an
“as-needed” basis in the future.
Inbound Y N
Outbound N Y
Set the Verify Group global parameter to ‘Y’ to use this feature. If the global parameter is
‘Y’ and the Accept flag is ‘N,’ the incoming group is suspended. If the global parameter is
set to ‘N,’ it does not matter what the Accept flag is since it is not looked at.
) RECOMMENDATION
For inbound documents, set the Accept flag to ‘Y’ and the Send flag to ‘N.’ For
outbound documents, set the Accept flag to ‘N’ and the Send flag to ‘Y.’
This flag is only used for inbound groups to determine what kind of acknowledgment
Gentran:Server will generate. If this is an outbound group, leave this flag blank. If you are
receiving this functional group and are not generating an acknowledgment, leave this field
blank. (SEE the “Setting Up a New Partner Profile” section in this chapter for more
information about turning off acknowledgments.)
If you are acknowledging this functional group, indicate which type of acknowledgment
to generate. Type either ‘997’ (functional acknowledgment – used for X12 documents),
‘999’ (acceptance/rejection advice – used for UCS documents), or ‘CONTRL’ (EDIFACT
Control Message – used for EDIFACT documents). This needs to be determined by your
trading partner.
)RECOMMENDATION
If this is an inbound transaction and your trading partner is using X12 or UCS standards,
leave this field blank to accept the default value of ‘997’ unless your trading partner has
requested a ‘999.’ If your trading partner is using EDIFACT standards, type ‘CONTRL.’ For
outbound transactions, leave this field blank.
When processing groups outbound, the Outbound Editor (EBDI002) logs the group in the
Audit file if the Audit Group global parameter is set to ‘Y’ (SEE the “Global Parameters”
chapter in the Technical Reference Guide for more information).
There is an acknowledgment status flag for every group logged in the Audit file. The flag
can be used when printing the Audit Unacknowledged Activity Report to determine if all
documents sent to your partner have been acknowledged. If the group has not been
acknowledged by your partner with an AK1, B5, or UCF segment, the ACK status flag in
the Audit file is blank. Even if you do not expect acknowledgment of documents, a blank
status flag will cause a document to display if you print the Audit Report showing all
unacknowledged documents.
In this case, it is not an error to have not received a group acknowledgment. You may want
a method of turning this feature off for any document that is not expected to be
acknowledged. The EDIFACT UNG segment is typically not used.
When processing groups inbound, the same process is true. However, the report identifies
received groups that are not yet acknowledged. For those groups that you do not expect to
acknowledge, set the flag to ‘N’ to not view the unacknowledged groups as errors.
# NOTE
The incoming control number must be numeric to activate this feature. Only
applicable if used with the Sequential Check Control or Sequential Error Control
global parameter.
The benefit to this feature is only realized when you contact the partner to determine if you
missed some interchanges. However, this is time consuming and often does not happen. It
usually happens when your partner reprocessed their data without resetting the control
numbers, leading to the jump in the sequence of numbers you receive.
) RECOMMENDATION
Leave this field blank to deactivate this feature.
Comm Profile ID
This field is used to indicate the group level communication profile ID, if specified. The
comm profile ID can override the interchange level by specifying a group comm profile
ID and setting the flag ‘Group Profile ID’ on the control/interchange record to ‘Y’.
The default is ‘*INT’, which indicates the comm profile ID is determined at the
interchange level for all data being sent to this partner. To override that comm profile ID
for the data being sent for this functional group, enter a valid comm profile ID or press F4
(Prompt) for a list of valid communication profiles. If a group comm profile is specified,
the interchange flag ‘Group Profile ID’ will automatically be set to ‘Y’ by the system.
The panel you see next depends on the Interchange Control Type entered on the Partner Control
panel (EDIX012-FMT01). In our example, because the ISA interchange type was entered, the
Partner Group panel (EDIX031-FMT04) displays.
The Partner Group panel (EDIX031-FMT04) is used to specify the values that are placed in the
group envelope when sending data outbound. For this example, it identifies the values loaded into
the GS segment when sending this particular group outbound to your partner.
The Partner Group panel (EDIX031-FMT04) displays, with the cursor positioned at the
Applications Senders Code field.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . Trading Partner Example Company
Group ID . . . . . . . . . . . . . IN
To exit from the Partner Group panel (EDIX031-FMT04)—or any other outbound partner group
panel that you may be using—press F10 (Update). Pressing this key updates the values you have
entered to the partner profile and returns you to the Work with Partner Groups panel
(EDIX030-FMT01).
# NOTE
For outbound processing, all the fields on this panel must be filled in, except for the
Transaction Segment ID and the Transaction Control Number which may be left blank. If you
don’t know all the information that is required to complete the panel at this time, enter as
much information as you can. Gentran:Server allows you to exit from the panel without
completing the panel information. For outbound processing, you must return to this panel
and fill in the GS Segment fields.
) RECOMMENDATION
If you know your company’s DUNS number, type it in this field. If you do not know
this number, type a brief descriptive name for your company.
# NOTE
Make a note of the Sender (GS02). This value is cross referenced back to the ID used
to create yourself as a partner in Gentran:Server. For inbound splitting, you will be
asked to set yourself up as a partner.
) RECOMMENDATION
Your partner indicates what Receiver code to use. Discuss this with your partner’s
EDI contact.
# NOTE
Make a note of the Receiver (GS03). Cross reference this value back to the Partner
ID used to set up your trading partner. You are asked to do this in a later task. It is
helpful to have made a note of this value in preparation for that task.
The GS04 and GS05 codes are date and time stamps. These are generated by the system at
run-time and are therefore left off the panel.
Control Number
This is the GS06 code. The Control Number is an identifier for the electronic document.
Each envelope gets “stamped” with a unique number to aid in tracking it. The group
control number is increased by one each time this particular group is sent out to this
partner. Note that the number is increased immediately prior to loading it into the
envelope. You can start the counting at any number you desire.
) RECOMMENDATION
Initialize the Control Number value to ‘0.’
) RECOMMENDATION
Typically, the Responsible Agency Code is an ‘X.’ If you are sending the BG
interchange, set this field to ‘T.’ Review this with your partner’s EDI contact.
Version
The Version code is loaded into the GS08 element. If left blank, the Compliance Version
on the Partner Group panel (EDIX031-FMT01) for this group is automatically loaded into
the GS08 element.
Some people prefer to leave the version blank. If this field is left blank and they move up
to a new version, only Compliance Version will have to be changed. The only downfall to
leaving it blank is that it may not be clear to a user what value is loaded into the GS08.
) RECOMMENDATION
Enter the same version as loaded in the Compliance Version on the Partner Group
panel (EDIX031-FMT01), or leave it blank.
Let’s use two examples to illustrate this feature. In these examples, the documents being
used are: the 875 UCS purchase order and the 876 UCS purchase order change, both of
which belong to the same functional group, ‘OG.’ In both examples, assume three
purchase orders (875) are sent first, followed by two purchase order changes (876).
The Transaction Segment ID is set to ‘ST’ and the Transaction Control Number is
initialized with ‘0’. The generated control numbers are shown below.
875 1
875 2
875 3
876 4
876 5
875 1
875 2
875 3
876 1
876 2
) RECOMMENDATION
Leave both the Transaction Segment ID and the Transaction Control Number blank.
Partner Transaction
(EDIX041-FMT01)
Step 2:
Enter the Transaction Set Information
Partner Transaction
(EDIX041-FMTnn)
Step 3:
Enter the Outbound Transaction Information
The first step in working with partner transactions is to select the appropriate transaction ID(s).
The Work with Partner Transactions panel (EDIX040-FMT01) may contain partner defined
transactions for all Partner IDs or for selected Partner IDs. This is determined by the manner in
which the Work with Partner Transactions panel is accessed.
12 TPCOMPANY TPCOMPANY
UNA-PARTNER EXAMPLE OF A UNA PARTNER
VENDOR-1 TUTORIAL - XYZ COMPUTER COMPANY
VENDOR-2 TUTORIAL - BULK PAPER COMPANY
VENDOR-3 TUTORIAL - TWO WAY COMMUNICATIONS
VENDOR-4 TUTORIAL - RANDOM OFFICE SUPPLY
123456789 RECEIVER RECORD FOR SEPARATION
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Figure 3.17 Access the Work with Partner Transactions panel (EDIX040-FMT01)
On the Work with Partners panel, type ‘12’ in the Option field next to the partner profile created in
the previous task, as shown in Figure 3.17, and press Enter.
When you first access the Work with Partner Transactions panel (EDIX040-FMT01), as shown in
Figure 3.18, you will notice that there is one Transaction ID already defined – !!!DFT. This is the
default Transaction ID which was automatically created when you set up the new partner profile.
Gentran:Server recommends that you create a transaction record for every type of document you
intend to trade with your partner – either inbound or outbound.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
To create a new Transaction ID for the partner, type ‘1’ in the Option field; in the Trans ID field,
type the Transaction ID (as shown in Figure 3.18), then press Enter. When Enter is pressed,
Gentran:Server automatically advances to the Partner Transaction panel (EDIX041-FMT01). To
follow the example, type ‘850’ as the Trans ID for purchase orders, then repeat this step using
‘810’ as the Trans ID for invoices.
Field Descriptions
Transaction ID
This ID must be the actual Transaction Set ID from the standards in the ST01 element.
(Press F4 [Prompt] or SEE your standards manual for a list of transaction set identifiers or
look up the code in the Gentran:Server Work with Standards subsystem [use the default
version to find the ST segment and look for codes under the ST01.].) Gentran:Server must
find a transaction record for the resolved partner if the Verify Transaction global
parameter is turned on. Otherwise, the transaction is suspended. This verification is
performed by the Inbound and Outbound Editors.
)RECOMMENDATION
The Transaction ID must be set to the transaction set number for the EDI document
according to the standards. (SEE your standards manual for a complete listing of transaction
set numbers.)
The next step is to enter various transaction mapping and validation parameters for the transaction
set. The values entered on this panel depend on the type of transaction set being defined for the
partner. The same panel is used for entering information for all transaction sets.
Gentran:Server allows you to exit from the Partner Transaction panel (EDIX041-FMT01) without
completing the entry of field values. You may, however, want to return to this panel prior to
processing in order to enter additional information. Figure 3.19 and Figure 3.20 display
recommended values to enter for the two types of transaction sets being used in the example.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . Trading Partner Example Company
Transaction ID . . . . . . . . . . 850
Recommended
Test or Production . . . . . . . . T
Transaction Map ID Inbound . . . .
Transaction Map ID Outbound. . . .
Accept Transaction Inbound . . . . Y
Send Transaction Outbound. . . . . N
Validate Codes Inbound . . . . . . Y
Validate Codes Outbound. . . . . . Y
Expect an AK2, A2, or UCM. . . . . Y
Transaction Acknowledgement Type . 997
Acknowledgment Overdue in . . . . . Hours Minutes
Acknowledge Specific Trans. . . . . Y
Figure 3.19 Recommended and Required Fields for an inbound ‘850’ Transaction Set
To enter the transaction set information for an inbound Transaction ID ‘850,’ type in the values
shown in Figure 3.19 and press Enter. If the Send Transaction Outbound field is set to ‘Y,’ the
Partner Transaction panel (EDIX041-FMTnn) displays next.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . Trading Partner Example Company
Transaction ID . . . . . . . . . . 810
Recommended
Test or Production . . . . . . . . T
Transaction Map ID Inbound . . . .
Transaction Map ID Outbound. . . .
Accept Transaction Inbound . . . . Y
Send Transaction Outbound. . . . . Y
Validate Codes Inbound . . . . . . Y
Validate Codes Outbound. . . . . . Y
Expect an AK2, A2, or UCM. . . . . Y
Transaction Acknowledgement Type .
Acknowledgment Overdue in . . . . . Hours Minutes
Acknowledge Specific Trans. . . . . Y
Figure 3.20 Recommended field values for outbound ‘810’ Transaction Set
To enter the transaction set information for an outbound Transaction ID ‘810,’ type in the values
shown in Figure 3.20 and press Enter. If the Send Transaction Outbound field is set to ‘Y,’ the
Partner Transaction panel (EDIX041-FMTnn) displays next.
The Outbound Mapper/Envelope uses this flag as partial input when determining what the
ISA Test or Production flag (ISA15) is. The following table shows how the flags are used
together to generate the ISA15 flag.
# NOTE
T = Test, D = Development, P = Production.
T T T
T P T
P T T
P P P
T D T
P D T
For the status of the interchange in the ISA15 element to be ‘P’ for production, both the
partner and the map must be at a production status.
) RECOMMENDATION
Set this to ‘T’ for now. When moving the transaction into production, update the flag
to ‘P.’
1. General map for a specific version that can be used for all partners to translate
data between the application format and the EDI format.
2. Partner-specific map for a specific version that can be used for one or more
partners to translate data between the application format and the EDI format.
If there is a partner-specific map used for this current partner, type the map name in the
inbound field for an inbound document, or in the outbound field if it is an outbound
document. If these fields are left blank, Gentran:Server looks for a general map for the
specific version received or sent in order to perform the translation.
The map must exist in the Transaction Directory under Mapping Integration before being
entered on this panel.
For inbound documents, it is common to use general maps that are inclusive of all segments
that your partners may be sending. If the data is there, it is mapped. Otherwise, it is ignored. It
is not necessary to map any more data than what is necessary for your internal application.
For outbound documents, it is common to create partner-specific maps for each partner. Most
partners ask for specific information to be sent. It is easier to copy an existing map and modify
it for the new partner than to add special if-conditions to see if this particular partner gets a
particular segment or an element.
)RECOMMENDATION
Leave these fields blank. If it is decided at a later point to use partner-specific maps, the
Transaction ID under the partner can be updated.
Inbound Y N
Outbound N Y
Set the Verify Transaction global parameter to ‘Y’ for this function. If the global
parameter is ‘Y’ and the Accept Flag is ‘N,’ the incoming transaction is suspended. If the
Verify Transaction global parameter is set to ‘N,’ it does not matter what the Accept flag is
set to since it is not viewed.
) RECOMMENDATION
For inbound documents, set the Accept Flag to ‘Y.’ For outbound documents, set
Send Flag to ‘Y.’
) RECOMMENDATION
Set these fields to ‘N’ for the direction processed. During testing, it is helpful to set
this to ‘Y’ to see invalid data.
When processing outbound transactions, the Outbound Editor (EBDI002) logs the
transaction in the Audit file if the Audit Transaction global parameter is set to ‘Y’ (SEE
the “Global Parameters” chapter in the Technical Reference Guide for more information).
There is an acknowledgment status flag for every transaction logged in the Audit file. It
can be used when printing the Audit report to determine if all documents sent to your
partner have been acknowledged. If the transaction has not been acknowledged by your
partner with an AK2, A2, or UCM segment, the status flag is still blank. If you choose to
print the Audit report showing all unacknowledged documents, the transactions display
even though you may not have expected your partner to acknowledge it.
In this case, it is not an error to have not received a transaction acknowledgment. You may
want a method of turning this feature off for any document that is not expected to be
acknowledged.
When processing transactions inbound, the same process is true. However, the report
identifies received transactions that are not yet acknowledged. For those transactions you
do not expect to acknowledge, set the flag to ‘N’ to not view the unacknowledged
transactions as errors.
) RECOMMENDATION
Set to ‘Y’ for inbound and outbound transactions that you want to be acknowledged.
For transactions not acknowledged, such as ‘997,’ ‘999,’ and CONTRL
acknowledgments, set the flag to ‘N.’
This flag is only used for inbound transactions to determine what kind of acknowledgment
Gentran:Server generates. If this is an outbound transaction, leave this field blank. If you
are receiving this transaction and are not generating an acknowledgment, leave this field
blank.
) RECOMMENDATION
If this is an inbound transaction and your trading partner is using X12 or UCS
standards, leave this field blank to accept the default value of ‘997’ unless your
trading partner has requested a ‘999.’ If your trading partner is using EDIFACT
standards, type ‘CONTRL.’ For outbound transactions, leave this field blank.
The panel you see next (EDIX041-FMTnn) depends on the interchange type entered for the
partner. For our example, Partner Transaction panel (EDIX041-FMT04) displays next, because we
entered it as an ISA interchange type on the Partner Control panel (EDIX012-FMT01).
The Partner Transaction panel (EDIX041-FMT04) is used to specify the values that are placed in
the transaction envelope when sending data outbound. For this example, it identifies values loaded
into the ST segment when sending this particular transaction set outbound to your partner.
# NOTE
Refer to your standards manual for more information about what values should be loaded in
the ST segment.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . TPCOMPANY
Transaction ID . . . . . . . . . . 810
Figure 3.21 Outbound Partner Transaction Information for an 810 Transaction Set
To enter the outbound partner transaction information for an outbound transaction set, type the
initial control number in the Control Number field and press F10 (Update) to add the value, as
shown in Figure 3.21. You will return to the Work with Partner Transactions panel
(EDIX040-FMT01).
) RECOMMENDATION
Initialize this Control Number to ‘0.’
Version
This field is for documentation purposes only. There is no element in the ST segment that
contains the version. It is provided so the user can easily see what version is being sent
outbound for this document. The actual version for this transaction set is associated with
the group. Refer to the group record for this partner to determine the actual version that is
used.
Partner Control
(EDIX035-FMT01)
Step 2:
Enter the Name & Address Information
Figure 3.22 Steps in the ‘Enter Partner Name & Address’ task
Only one Name and Address record can be defined for the trading partner. This task begins from
the Partner Name & Address panel (EDIX035-FMT01).
13 TPCOMPANY TPCOMPANY
UNA-PARTNER EXAMPLE OF A UNA PARTNER
VENDOR-1 TUTORIAL - XYZ COMPUTER COMPANY
VENDOR-2 TUTORIAL - BULK PAPER COMPANY
VENDOR-3 TUTORIAL - TWO WAY COMMUNICATIONS
VENDOR-4 TUTORIAL - RANDOM OFFICE SUPPLY
123456789 RECEIVER RECORD FOR SEPARATION
Bottom
Parameters or command
===>
F4=Prompt F5=Refresh F9=Retrieve F24=More Keys
Figure 3.23 Access the Partner Name & Address panel (EDIX035-FMT01)
To access this panel, on the Work with Partner panel (EDIX005-FMT01) type ‘13’ in the Option
field next to the Partner ID whose name and address record you want to access, as shown in Figure
3.23. Press Enter, and Gentran:Server automatically advances to the Partner Name & Address
panel (EDIX035-FMT01).
Since the contents of this panel are optional, you may enter information in the form most
convenient to you.
Partner ID . . . . . . . . . . . . TPCOMPANY
Qual Name. . . . . . . . . . . . .
City . . . . . . . . . . . . . . . Anycity
State. . . . . . . . . . . . . . . OH
Zip. . . . . . . . . . . . . . . . 43017 -
Country Code . . . . . . . . . . .
Contact. . . . . . . . . . . . . . EDI Contact Name/Phone
Phone. . . . . . . . . . . . . . . ( 614 ) 793 - 7000 x 5101
International Dial Code. . . . . . 000
Fax. . . . . . . . . . . . . . . . ( ) - Dial Code. . . .
E-mail Address . . . . . . . . . .
Enter the name and address of your trading partner: you may use the format shown in Figure 3.24
or one of your own. Once you have entered the information, press F10 (Update). Pressing this key
will update the values you have entered to the partner profile and return you to the Work with
Partner panel (EDIX005-FMT01).
Contact, Phone, International Dial Code, Fax, Dial Code, E-mail Address
Enter the primary EDI contact, phone and fax numbers, and e-mail address for this partner.
This ‘optional’ information is valuable. It is extremely useful to have a central location for
the EDI contact that you can access. Often, you may have to contact your partner for
acknowledgments that have not been received or for additional information about a
document you are preparing to trade.
Figure 3.25 Steps in the ‘Enter Partner User Defined Information’ task
This task begins from the Work with Partner User Defined panel (EDIX046-FMT01).
Bottom
Parameters or command
===>
F4=Prompt F5=Refresh F9=Retrieve F24=More Keys
To access this panel, type option ‘14’ on the Work with Partners panel (EDIX005-FMT01) beside
the Partner ID whose user-defined record(s) you want to access, as shown in Figure 3.26, and press
Enter.
When you press Enter in the previous step, Gentran:Server automatically advances to the Work
with Partner User Defined panel (EDIX046-FMT01), which is shown in Figure 3.27.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
To create a new user defined record for a partner, type ‘1’ in the Option field and a record ID in the
Record ID field on the key entry line. Press Enter, and Gentran:Server automatically advances to
the Partner User Defined panel (EDIX045-FMT01).
Record ID
This field is the key to the user-defined record. It is a 4-byte alphanumeric field that
uniquely identifies the information for the specified partner. The field cannot be blank.
For the example, we have already entered two User-Defined records for you. Record
‘I001’ has a leading indicator of ‘I’ that categorizes the record as Informational data,
followed by a sequential number to sequence all the informational data records. We also
have records beginning with ‘Q’ for questions and ‘P’ for problems. There is no rule for
determining the value of this field.
) RECOMMENDATION
Devise a naming convention that includes a sequential counter.
When Enter is pressed in the previous step, Gentran:Server automatically advances to the Work
with Partner User Defined panel (EDIX045-FMT01) as shown in Figure 3.28.
Partner ID . . . . . . . . . . . . TPCOMPANY
Qualifier. . . . . . . . . . . . .
Name . . . . . . . . . . . . . . . TRADING PARTNER EXAMPLE COMPANY
Record ID. . . . . . . . . . . . . I001
1 1 2 2 3 3 4
1...5....0....5....0....5....0....5....0
User Data. . . . . . . . . . . . . Request to send EDI PO’s: 7/1/99
To enter information for this record, type up to a 240-character message in the User Data field, as
shown in Figure 3.28. When you have finished entering your data, press F10 (Update) to add the
information. You will be returned to the Work with Partner User Defined panel
(EDIX046-FMT01).
User Data
This comment field is 240-bytes in length. Any information may be stored about this
partner. It can be used at your discretion. Some users have devised a format for this data
portion and access the record from their own applications to retrieve specific EDI data.
Error rejection is considered an advanced task in Gentran:Server. You should not attempt to set up
error rejection until you are thoroughly familiar with what error rejection is, how it occurs and
most importantly, how to recover from it. Figure 3.29 shows the order to enter this information.
Figure 3.29 Steps in the Work with Partner Error Rejection task
This task begins from the Work with Partner Error Rejection panel (EDIX056-FMT01).
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
To access this panel, type ‘16’ in the Option field on the Work with Partners panel
(EDIX005-FMT01) next to the Partner ID that you want to set up with error rejection, as shown in
Figure 3.30. Press Enter.
# NOTE
This access method displays only the error rejection records for the selected partner. To
display all error rejection records for all partners, type ‘16’ in the Option field on the key
entry line and press Enter.
When you press Enter, Gentran:Server automatically advances to the Work with Partner Error
Rejection panel (EDIX056-FMT01).
All fields must be filled in to create a new error rejection record for this partner.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
To create a new error rejection record using the ‘Create’ option, type ‘1’ in the Option field; type
the Level value (P, G, or T), Level ID, and Error Number in the appropriate fields, as shown in
Figure 3.31, then press Enter.
If an error can occur at more than one level, you need to set up multiple rejection records
at each desired level. Valid values are:
STOP CAUTION
For outbound processing, if rejection occurs at any level, the entire interchange will
be rejected. This is because the envelopes have already been wrapped around the
data with counts that indicate the number of transaction sets.
Level ID
This field identifies which specific groups or transaction sets are rejected if the specified
error occurs. The Level ID must be blank if the Level is ‘P.’ The Level ID can specify
‘ALL’ to indicate that if the specified error occurs for any transaction or group (depending
on the level), the data is rejected. If you wish to reject a specific group or transaction when
the error occurs, enter the actual transaction or group identifier.
For example, if you want to reject a 209 error for the group’s PO (purchase orders) and IN
(invoices), you need to add two error rejection records: one for Level ID = PO and one for
Level ID = IN for the same Level and the same error number.
Error Number
This field identifies the specific error number for which you are setting up rejection. If this
error occurs for the indicated transaction or group and direction, reject the data. (SEE the
“System Messages” chapter in the Technical Reference Guide for a complete list of error
numbers.)
Types of errors that can be set up are syntax errors such as error #62, which means
‘Missing Indicated Element.’ These errors are those that are encountered during
compliance checking by the Inbound and Outbound Editor.
STOP CAUTION
You cannot reject data based on the content of the data, such as an invalid item
number or a missing store number. Only compliance errors for deviations from the
standards format can be rejected. If data needs to be flagged or rejected based on
application information, you can perform detailed mapping or you can send back the
824 Application Advice transaction to a partner to indicate those errors.
The final step is to designate whether the error rejection record is to be used for inbound and/or
outbound processing. Pressing Enter on the Work with Partner Error Rejection panel
(EDIX056-FMT01) takes you to the Partner Error Rejection panel (EDIX055-FMT01), as shown
in Figure 3.32.
Partner ID . . . . . . . . . . . . TPCOMPANY
Partner Qual . . . . . . . . . . .
Partner Name . . . . . . . . . . . TRADING PARTNER EXAMPLE COMPANY
Level. . . . . . . . . . . . . . . T
Level ID . . . . . . . . . . . . . ALL
Error Number . . . . . . . . . . . 0209
Reject Inbound . . . . . . . . . . Y
Reject Outbound. . . . . . . . . . N
Figure 3.32 Specify whether error rejection is for inbound and/or outbound processing
To define error rejection as inbound and/or outbound for this error number, type either ‘Y’ or ‘N’
in the Reject Inbound and Reject Outbound fields, then press F10 (Update). Pressing this key
updates the values you have entered to the partner profile and returns you to the Partner Error
Rejection panel (EDIX056-FMT01).
Field Descriptions
Reject Inbound
This field is an error rejection indicator for inbound processing. If the data associated with
the specified error number should be rejected when it occurs during inbound processing,
set the flag to ‘Y;’ otherwise, set the flag to ‘N.’
Reject Outbound
This field is an error rejection indicator for outbound processing. If the data associated
with the specified error number should be rejected when it occurs during outbound
processing, set the flag to ‘Y;’ otherwise, set the flag to ‘N.’
Figure 3.33 Steps in the ‘Work with Partner Cross Referencing’ task
On the Work with Partners panel (EDIX005-FMT01), type ‘17’ in the Option field beside the
Partner ID for whom you want to set up a cross reference (as shown in Figure 3.34) and press
Enter. The Work with Partner Cross Reference panel (EDIX008-CTL01) displays.
# NOTE
You can see which partners have cross references by changing the sort order on the Work
with Partners panel (EDIX005-FMT01) to partner, partner qualifier, cross reference, cross
reference qualifier. When sorted this way, new columns for cross references and cross
reference qualifiers display on the panel.
These are the different sorts available for the Work with Partners panel (EDIX005-FMT01):
– Partner, Partner Qualifier (default sort)
– Partner Name
– Cross Reference, Cross Reference Qualifier
– Partner, Partner Qualifier, Cross Reference, Cross Reference Qualifier
Cross reference entries are used to help Gentran:Server find the Partner ID in the Partner file
during translation processing. Identifiers may be used that are different from the Partner ID. The
cross reference entries “tie” the other identifier(s) back to the Partner ID.
Partner ID . . . . . . . . . . . . TPCOMPANY
Qualifier. . . . . . . . . . . . .
Partner Name . . . . . . . . . . . TRADING PARTNER EXAMPLE COMPANY
Position to X-Ref . . . . . . . . _______________________________
Type option, press Enter.
4=Delete
More...
F1=Help F4=Prompt F5=Refresh F10=Update F12=Cancel F24=More Keys
STOP
CAUTION
The cross reference value (X-Ref) cannot already exist in the Partner Cross Reference file (it
cannot be tied to another partner).
To access the entire list of cross references on the Partner Cross Reference panel
(EDIX008-CTL01), press F4 (Prompt) on the X-Ref field. A window displays a list of cross
references for all Partner IDs sequenced by the cross reference entry (as shown in Figure 3.37).
Optionally, you can work with any partner cross reference from the Work with Partners panel
(EDIX005-FMT01) when sorted by the cross reference ID.
Typical scenarios where setting up cross reference entries may be required include the following:
1. Cross referencing the interchange header in the EDI control envelope to the Partner
ID and qualifier:
For outbound processing, cross reference the interchange envelope Receiver ID and
Qualifier. (The Receiver ID is stored in the ISA08 element; the qualifier in the ISA07
element.)
For inbound processing, cross reference the interchange envelope Sender ID and Qualifier.
(The Sender ID is stored in the ISA05 element; the Qualifier in the ISA06 element)
In our example, the ‘TPCOMPANY ZZ’ ID and Qualifier have been set up for interchange
header cross referencing.
2. Cross referencing the functional group header in the EDI control envelope to the
Partner ID:
For outbound processing, cross reference the group envelope Receiver ID. (The Receiver
ID is stored in the GS03 element.)
For inbound processing, cross reference the group envelope Sender ID. (The Sender ID is
stored in the GS02 element.)
For our example, no cross reference entry is needed since the functional group envelope
value is the same value as the partner, which is TPCOMPANY. (The qualifier is not
retained at the functional group level in the EDI control envelope.)
3. Cross referencing the application partner reference to the Partner ID and qualifier:
For outbound processing, the partner reference fields maintained in the Application
Definition subsystem can be cross referenced to a Partner ID and qualifier.
In our example, this value has yet to be determined, so no cross reference can be added at
this time. However, it can be added at a later time once it is determined.
# NOTE
SEE the “Application Definition” chapter for a detailed explanation of the partner
reference fields.
If Gentran:Server rejects your input when you attempt to set up a new cross reference on the
Partner Cross Reference panel (EDIX008-CTL01), it may be because the X-Ref value specified
already exists in the cross reference file.
Partner ID . . . . . . . . . . . . TPCOMPANY
Qualifier. . . . . . . . . . . . .
Partner Name . . . . . . . . . . . TRADING PARTNER EXAMPLE COMPANY
Position to X-Ref . . . . . . . . _______________________________
Type option, press Enter.
4=Delete
More...
F1=Help F4=Prompt F5=Refresh F10=Update F12=Cancel F24=More Keys
Duplicate record key in member PARXREF.
Gentran:Server is informing you that you have already set up a cross reference between the
TPCOMPANY trading partner and TPDUNS with the 01 qualifier cross reference. In this
particular case, it is easy to see why the error has occurred.
After you have been using Gentran:Server for a while, however, you may have many cross
references set up and it may not be as easy to see where the duplication has occurred. If this is the
case, you can use F4 (Prompt) to see all cross references set up for all partners. Also, you can print
a Cross Reference Report (PRTPXR), sorted by cross reference or by partner ID by pressing F20
(Prt X-Ref) on this panel, or by choosing option ‘31’ (Print X-Ref) on the Work with Partners
panel. (SEE the “Print a Partner X-Ref Report” section later in this chapter for more information.)
Another option for working with cross references is to use the ‘X-Ref/Qual’ alternate sort option
on the Work with Partners panel (EDIX005-FMT01) and then position to the specific cross
reference value.
Partner ID . . . . . . . . . . . . TPCOMPANY
Qualifier. . . . . . . . . . . . .
Partner Name . . . . . . . . . . . TRADING PARTNER EXAMPLE COMPANY
Position to X-Ref . . . . . . . . _______________________________
Type option, press Enter.
4=Delete
More...
F1=Help F4=Prompt F5=Refresh F10=Update F12=Cancel F24=More Keys
Partner ID . . . . . . . . . . . . TPCOMPANY
Qualifier. . . . . . . . . . . . .
Partner Name . . . . . . . . . . . TRADING PARTNER EXAMPLE COMPANY
Position to X-Ref . . . . . . . . _______________________________
Type option, press Enter.
4=Delete
: :
Figure 3.37 List of all cross references set up for all partners
This list can be useful for identifying the Partner ID associated with a specific cross reference
entry (for example, when a duplicate cross reference is found). In the window, you can use F15
(Sort) to sort by X-Ref or Partner ID.
To work with partners by using the cross reference identifier, use the Work with Partners panel
(EDIX005-FMT01) and press F15 (Sort) to sort by the cross reference ID.
Data separation instructions are stored either under the trading partner or under the partner ID for
your company. The choice of how you want splitting to work should be made early in your setup
because it can only be processed by one method or the other. Splitting can occur based on the
sender of the data (your trading partner) or the receiver of the data (your company). The preferred
method is to set up data separation based on the receiver since it simplifies the setup and is easier
to maintain.
The receiver method is used if you want to route all documents to the same split file to be
processed by the same application definition. Sub-splitting can also be used to further break apart
the data to be processed by different applications, provided there is some piece of unique
information in the data between the transaction envelopes.
The sender method is used when you need to route the same document types to different split files
to be processed by different applications based on the sender ID (trading partner) in the envelopes.
Sub-splitting can also be used with this method.
# NOTE
The method chosen needs to match the global parameter settings for ‘Split by Partner’. If the
‘Split by Partner’ parameter is ‘N’, data separation records are looked up during processing
using the receiver ID. If ‘Y’, instruction records are looked up using the sender ID.
This section documents the procedures for completing the partner setup portion of splitting. (SEE
the “Splitting” chapter in the Technical Reference Guide for more information and troubleshooting
assistance.)
Figure 3.38 shows the steps in setting up for data separation. You should already be familiar with
most of these steps from the preceding sections of this chapter. For the steps already documented,
only a cursory explanation is given.
Figure 3.38 Steps in the ‘Work with Partner Data Separation’ task
This task begins from the Work with Partner Data Separation panel (EDIX051-FMT01).
The Work with Partner Data separation panel (EDIX051) can be accessed for all partners or a
specific partner.
C13579 G PO 0001
C13579 T 810 0001
C13579 T 850 0001
C24680 G PO 0001
C24680 T 810 0001
C24680 T 850 0001
INSPARTNER T ICLANA 0005
INSPARTNER T ORDERS 0003
INSPARTNER T ORDHDR 0003
More...
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
Figure 3.39 Access the Partner Data Separation panel for all partners
To access data separation records for all partners, type ‘15’ in the Option field on the key entry line
and leave the Partner ID blank, as shown in Figure 3.39.
G FA 0025
G OG 0001
G PO 0001
G TX 0006
T ORDERS 0002
T 860 0005
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
Figure 3.40 Access the Partner Data Separation panel for a specific partner
To access data separation records for a specific partner, type option ‘15’ on the Work with Partners
panel (EDIX005-FMT01) beside the Partner ID whose data separation record(s) you want to
access and press Enter, as shown in Figure 3.40.
# NOTE
If you are setting up splitting based on the receiver ID, specify the partner ID created for your
own company. You need to create a partner if one does not already exist. If you are setting up
splitting based on the sender ID, select the appropriate trading partner ID.
The Work with Partner Data Separation panel (EDIX051-FMT01) displays, as shown in Figure
3.41. Repeat this step for each type of inbound document you expect to receive, including
acknowledgments.
# NOTE
The Split Output global parameter files must be set to ‘Y’ in order for data separation to
function.The Split by Partner global parameter should be set to ‘N’ when setting up records
under the receiver partner (your company), and to ‘Y’ when you are setting up the records
using the partner’s ID.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
Level
This field is one of the key fields to the data separation record. It indicates whether the
splitting occurs at the group or transaction level. Applicable values are:
G (Group)
T (Transaction)
If there is not a specific need to set up splitting differently for transactions than for groups,
set up splitting at the group level. This setup prevents extra direction records (instructions)
from being written out for each transaction within the group. If you do not know the
Group ID but do know the Transaction Set number, set up splitting at the transaction level.
Level ID
This is the second key field to the data separation record. Use the Level ID indicator for
splitting. If the level is ‘G,’ the Level ID contains a valid functional group identifier. If the
level is ‘T,’ the level ID contains a valid Transaction Set Number.
The Partner Data Separation panel (EDIX050-FMT01), as shown in Figure 3.42, is used to
identify the split file(s) that the data is to be loaded into.
You can duplicate incoming EDI data into more than one split file by entering multiple split file
numbers in the extra blanks. Even though it is not commonly used, this might help you to test or
archive transactions.
Partner ID . . . . . . . . . . . . MYCOMPANY
Partner Qual . . . . . . . . . . .
Partner Name . . . . . . . . . . . MYCOMPANY (for inbound splitting)
Level. . . . . . . . . . . . . . . T
Level ID . . . . . . . . . . . . . 997
Figure 3.42 Enter the split file number(s) into the blank fields
To define the split files to be used for data separation, type a number (1-80) for each split file to be
used in a blank field (from left to right) and press F10 (Update) to add the values. The system
returns you to the Work with Partner Data Separation panel (EDIX051-FMT01).
# NOTE
Repeat the data separation steps 2 and 3 for each inbound document that you are currently
receiving. Make sure to include the functional acknowledgment in this setup.
The reason for more than one slot for output files is so the data can be duplicated, if
desired, into more than one output file. For instance, the user can take the purchase order
data that is placed in Split File 1 and duplicate the data into Split file 10 if it simplifies
testing.
) RECOMMENDATION
Type a number from 1 to 80 on the first slot available. This is where the inbound
transaction set or Group ID marked in Level ID is placed prior to mapping. The
Mapper needs to read the same input file for its step in translating the EDI format to
the application format.
When you copy a partner profile, Gentran:Server copies all the partner records into the new
partner profile with the exception of the cross reference records and the partner name & address
records (where only the Name field is set to the Partner ID). These panels need to be set up
individually. You can modify these panels at any time after the copy is completed. Figure 3.43
shows the order to enter this information.
Partner Control
(EDIX012-FMT01)
Step 2:
Modify the New Partner Records
Partner Control
(EDIX012-FMTnn)
Step 3:
Enter Additional Partner Information
(EDIXnnn-FMTnn)
Step 3:
Modify Partner Information as needed
The Copy option steps through several Gentran:Server panels where you can modify entries as the
new partner profile is being built by Gentran:Server.
3 MODEL MODEL
MYCOMPANY MYCOMPANY (for inbound splitting)
Copy To
NEWCOMPANY
F3=Exit F12=Cancel
More...
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
For this example, we are copying from a Partner ID called MODEL. This partner profile is similar
to the TPCOMPANY partner that was created during the ‘Setting up an New Partner Profile’ task.
On the Work with Partners panel (EDIX005-FMT01), access the Copy To window by typing ‘3’ in
the Option field next to the Partner ID whose partner profile is to be copied, (for our example in
Figure 3.44, we used MODEL), and press Enter. In the Copy To window, type the new Partner ID
and Qualifier and press Enter.
)RECOMMENDATION
If you intend to set up several partner profiles, create one or more ‘template’ profiles that you
can easily copy from.
Pressing Enter in the previous step displays the Partner Control panel (EDIX012-FMT01), as
shown in Figure 3.45. The system fills in all the field values from the original partner profile. At
this point, you can either accept the panel exactly as it is, or modify the field values.
Partner ID . . . . . . . . . . . . NEWCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . *** Name Not On File ***
Division . . . . . . . . . . . . . 000
Interchange Header Option. . . . . ISA
Last Incoming Sequence Number. . .
GS Sender ID Qualifier . . . . . . N
GS Receiver ID Qualifier . . . . . N
Expect a TA1, AC1, or UCI. . . . . N
Acknowledge Interchange. . . . . . N
Acknowledge Group or Trans . . . . T
Acknowledge Errors . . . . . . . . N
Purge Acknowledged . . . . . . . .
Purge Reported . . . . . . . . . .
Purge Older Than Days. . . . . . .
Last Incoming BG Password . . . . Set 209 Errors . . . N
Comm Profile ID. . . . . . . . . . CN3BSC Group Profile ID . . N
Last Incoming UNB/STX Seq. No. . . Update Allowed . . . Y
On the Partner Control panel (EDIX012-FMT01), leave the values as they display and press
Enter.
# NOTE
If you are not doing outbound processing, you may skip the next panel. To do so, press F10
(Update). The message “Unable to process request. Panel must be reviewed.” displays. Since
the interchange envelope is not required for inbound processing, you may ignore this
message. Press F10 (Update) again to return to the Work with Partners panel
(EDIX005-FMT01) where you can launch other tasks.
If you are copying a Partner ID setup for outbound processing, to exit, either press F10 (Update) or
Enter. Pressing either key takes you to the second Partner Control panel (EDIX012-FMTnn). The
exact panel depends on the interchange header that was defined on the first Partner Control panel
(EDIX012-FMT01).
The panel you will see next (EDIX012-FMTnn) depends on the type of interchange header that
was defined for the partner. For our example, the ISA interchange was specified, so the Partner
Control panel (EDIX012-FMT05) displays next, as shown in Figure 3.46.
Partner ID . . . . . . . . . . . . NEWCOMPANY
Partner Qualifier. . . . . . . . .
Partner Name . . . . . . . . . . . *** Name Not On File ***
Figure 3.46 Values for the new partner profile can be changed selectively
On Partner Control panel (EDIX012-FMT05), leave the values as they display and press F10
(Update) to add the values and return to the Work with Partner panel (EDIX005-FMT01).
Although Gentran:Server copies all the panels from the original partner profile to the new partner
profile, you will probably want to modify, add and/or delete some of the records which were
copied.
Other tasks which you might want to complete after copying a partner profile include:
The Copy option copies the Partner ID into the Name field on the Partner Name &
Address panel (EDIX035-FMT01) and leaves the other fields blank. You might want to
modify the name and fill in the other fields.
The Copy option copies all the User Defined records from the original partner profile to
the new partner profile. You might want to modify, add or delete some of these records.
The Copy option does not copy cross references. You might want to set up cross
references for your new partner profile.
When you copy a partner profile between libraries, Gentran:Server copies all the partner records
and all the partner field values into the new partner profile. The new partner profile is an exact
duplicate of the original.
Copy Partner ID
(PTRCPY)
Step 2:
Specify the source and destination libraries
Figure 3.47 Steps in the ‘Copy a Partner Profile Between Libraries’ task
This task begins from the Copy Partner ID command panel (PTRCPY).
On the Work with Partners panel (EDIX005-FMT01), type ‘30’ in the Option field next to the
Partner ID for the partner profile that you want to copy from, and press Enter. (For our example in
Figure 3.48, we used TPCOMPANY.)
Gentran:Server next displays the Copy Partner ID command panel (PTRCPY), as shown in
Figure 3.49.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Figure 3.49 Specify a source and a destination library for the TPCOMPANY partner profile
At this point you must identify the source and destination libraries. Type values for the From
Library field and To Library field and press Enter. Pressing this key starts the Copy Partner
command and returns you to the Work with Partner panel (EDIX005-FMT01). Figure 3.49
illustrates the TPCOMPANY partner profile being copied from a test library named
G3X5TSTDTA to a production library named G3X5DTA.
Field Descriptions
Partner ID
This is the Partner ID for the partner profile which you want to copy. Enter the Partner ID.
STOP CAUTION
The partner profile to be copied cannot exist in the destination library.
Qualifier
This is the Qualifier for the partner profile which you want to copy. Enter the Qualifier.
From Library
This is the source library in which the partner profile is currently residing.
To Library
This is the destination library for the copied partner profile.
STOP CAUTION
Before you can use this feature, you must have Gentran:Server configured in the
destination library.
Schedule Job
Use this field to specify whether the Copy Partner command should be scheduled as a job.
The default value for this field is “*NO.”
If you decide to run the Copy Partner command using the Gentran Job Scheduler, type
‘*YES’ in this field. The system will access the Job Scheduler function, where you can
further define the job run for automatic queueing. You may queue and run the Copy
Partner command on a periodic basis through this process. However, the Gentran:Server
Job Scheduler function in the Work with System Administration subsystem can also
enable you to establish a master schedule (one-time) for the job to automatically run on a
periodic basis.
When you rename a partner profile, Gentran:Server updates all partner records and cross-
reference records associated with the new partner ID and qualifier.
Rename To
..
F3=Exit F12=Cancel
On the Work with Partners panel (EDIX005-FMT01), access the Rename To window by typing
‘7’ in the Option field next to the Partner ID whose partner profile is to be renamed, as shown in
Figure 3.50. Press Enter. The Rename To window displays.
In the Rename To window, type the new Partner ID and qualifier and press Enter.
The partner report is designed to duplicate the format of the on-line partner panels for easier
readability. It prints a separate section for each of the components of the Partner Profile:
interchange, groups, transactions sets, name & address, etc. (SEE the sections in this chapter
regarding panel layouts and field definitions for more information.)
# NOTE
SEE the “Reports” section in this chapter for a detailed description of the contents of the
partner report.
The Print option can be used to print a report for one partner profile, a range of partner profiles or
all partner profiles.
Figure 3.52 Select the Report option for a Single partner or for all partners
To access the Print Partner File command panel (PRTPAR) for an individual partner, on the Work
with Partners panel (EDIX005-FMT01), type ‘6’ in the Option field next to the Partner ID for the
partner profile that you want to print, then press Enter. (For our example in Figure 3.52, we used
TPCOMPANY.)
The Print Partner File (PRTPAR) command panel displays next, as shown in Figure 3.53.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Gentran:Server provides several filtering options which allow you to selectively print all or some
of the partner profiles in the Partner file. The system builds the filter based on the combined values
entered in the fields on the PRTPAR command panel:
If you accessed the PRTPAR command by typing a ‘6’ in the Option field beside a single
Partner ID, Gentran:Server displays the Partner ID in the “Select Partners From” field and
the “Select Partners To” field. All the print options are already entered. Press Enter to
start the report.
A range of Partner IDs can be printed by typing in a ‘beginning’ and ‘ending’ Partner ID
in the “Select Partners From (*ALL)” and the “Select Partners To (*END)” fields
respectively.
# NOTE
Typing ‘*ALL’ in the “Select Partners From (*ALL)” field prints all partner profiles
regardless of the value in the “Select Partners to (*END)” field.
If you only want to print partner profiles for partners belonging to a single interchange,
type the interchange value in the “Select Interchange to Print” field. Gentran:Server uses
this value, combined with the values entered in the other fields, to filter the output.
If you only want to print partner profiles for partners belonging to a single version, type
the interchange version value in the Select Int. Version to Print field. Gentran:Server uses
this value, combined with the values entered in the other fields, to filter the output.
Gentran:Server also allows you to either print the partner report immediately, or optionally, to
customize the input to the Gentran Job Scheduler.
To access the Gentran Job Scheduler from the PRTPAR command panel, type ‘*YES’ in the
‘Schedule Job’ field.
# NOTE
SEE the “Reports” section in this chapter for a detailed description of the contents of the
Partner X-Ref Report.
The Print X-Ref option can be used to print a cross reference report for one partner or a range of
partners.
Figure 3.55 Select the Cross Reference Report (Print X-Ref) option
(for a single partner)
To access the Print Partner X-Ref Report command panel (PRTPXR) for an individual partner, on
the Work with Partners panel (EDIX005-FMT01), type ‘31’ in the Option field next to the Partner
ID for the partner profile that you want to print and press Enter. (For our example in Figure 3.55,
we used TPCOMPANY.) To print cross references for all partners, type ‘31’ in the option field on
the key entry line and specify the sort order.
Optionally, to print cross references for a selected partner, you can access the Report option from
the Partner Cross Reference panel (EDIX008-CTL01) by pressing F20 (Prt X-Ref).
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Because you typed option ‘31’ next to the Partner ID TPCOMPANY (instead of on the key entry
line) on the Work with Partners panel, the PRTPXR panel will load that partner’s ID in the Select
Partners From and Select Partners To fields and display and print cross references for the selected
partner. This is shown in Figure 3.56. Leave all fields at the defaults and press Enter. The system
returns you to the Work with Partner panel (EDIX005-FMT01).
In the example, the Schedule Job field has been left at the default value ‘*NO.’ If this field is set to
‘*YES,’ pressing Enter takes you to the Schedule Job panel (SCHJOB). (SEE the “Job Scheduler”
chapter in the Technical Reference Guide for more detailed information on scheduling print jobs.)
The Print Qry option can be used to print Partner Query reports using specific selection criteria
depending on the query report selected.
Figure 3.58 Select the Partner Query Report (Print Qry) option
To access the Print Selected Partner Queries command (PRTPARQRY) on the Work with Partners
panel (EDIX005), type ‘32’ in the option field on the key entry line (this option is independent of
the partner, so the option can be placed anywhere in the subfile) and press Enter. See Figure 3.58.
The Print Selected Partner Queries (PRTPARQRY) command panel displays (Figure 3.59).
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
On the Print Selected Partner Queries (PRTPARQRY) panel, there are several types of queries that
can be selected and, based upon that selection, different selection parameters display to further
specify the criteria to be printed. Select the query type and press Enter. Additional selection
criteria displays, depending on the query type selected. Fill in the additional selection fields (press
F1 for additional help) and press Enter. The query will either be run interactively or submitted to
batch to run, but defaults to run in batch.
STOP
CAUTION
To keep the setup process as simple as possible, remember that the ezEDI commands, once
initiated, proceed forward only through all associated panels. You cannot interrupt the
process or back up to previous panels. Be sure to collect all your materials and allow yourself
sufficient time prior to initiating an ezEDI command.
Type ‘50’ in the Option field on the key entry line and press Enter, as shown in Figure 3.60.
Press Enter, and the ezPart introduction displays, as shown in Figure 3.61. Press Enter.
The ezPART command is a tool to help you define your Trading Partners to
the system. In EDI, anyone with whom you transfer documents is called a
Trading Partner. Setting up a Partner is similar to making an entry in
an Electronic Rolodex. All the information needed to do EDI with the
partner (ie., electronic mailing address and documents being traded) is
stored in one place where it can be conveniently accessed.
The ezPART command steps you through a series of panels which are essential
for defining information about your Trading Partner. This includes the
control (interchange), group, transaction, name and address (optional), and
cross reference panels.
Figure 3.62 shows the ezPart panels in the order you need to enter the information.
Partner Control
(EDIX012-FMT00)
See Task:
Set up a New Partner Profile
Partner Control
(EDIX012-FMT01)
See Task:
Set up a New Partner Profile
Partner Groups
(EDIX030-FMT01)
See Task:
Work with Partner Groups
Partner Transactions
(EDIX040-FMT01)
See Task:
Work with Partner Transactions
Reports
EBDI006B – Partner File Report
Contents of the Report
The Partner File Report is designed to show the format of the on-line partner profile panels. The
following list contains the sections in the order they will be on the report. If there is no data
pertaining to some sections, the sections will not be on the report.
From the Work with Partners panel (EDIX005-FMT01) by selecting option ‘6’ for an
individual Partner ID.
In both cases, you can filter the report by entering values for one or more of the following print
options:
EBDI006B RUN DATE 04/30/08 FORMATTED PARTNER FILE RECORDS RUN TIME 12:00:00 PAGE 1
options by accessing the Gentran Job Scheduler from the PRTPAR command which submits the
EBDI006B RUN DATE 04/30/08 FORMATTED PARTNER FILE RECORDS RUN TIME 12:00:00
PARTNER ID = TPCOMPANY QUAL = 01
CITY:ANYCITY
ST:OH ZIP: 43016 COUNTRY CODE: US
CONTACT:EDI CONTACT NAME/PHONE
PHONE: (614) 793-7000 EXT. 5010 INTERNATIONAL DIAL CODE: 000
FAX: (614) 614-8888 FAX DIAL CODE: 888
E-MAIL ADDRESS: EDI_USER@STERCOMM.COM
3 - 105
3 - 106
Partner
EBDI006B RUN DATE 04/30/08 FORMATTED PARTNER FILE RECORDS RUN TIME 12:00:00
PAGE 3
Partner ID
Partner Qualifier
X-Ref
X-Ref Qualifier
SEE the section ‘Printing a Partner X-Ref Report’ for more information on defining what
information is on the report.
The report columns change according to what sort order you select. If ‘*PARTNER’ is selected,
then Partner ID displays as the left column. If ‘*X-REF’ is selected, then the cross reference
displays as the left column. Selection criteria prints at the top of the report, identifying the run time
selections.
1. From the Work with Partners panel (EDIX005-FMT01) by selecting option ‘31’ for an
individual Partner ID, or on the key entry line for all partners.
2. From the command line by typing ‘PRTPXR’ and pressing F4 (Prompt).
3. From the Partner Cross Reference panel (EDIX008-CTL01) by pressing F20 (Prt X-Ref).
For the first two methods above, you can select the report format by typing ‘*PARTNER’ or
‘*XREF’ in the Sort By field on the PRTPXR command panel. If you use the third method to
access the report, it will automatically print the cross reference report for the currently displayed
partner only.
Special Considerations
Like all other Gentran:Server reports, the Partner Cross Reference Report (Figure 3.66)
automatically goes to your default iSeries Output Queue. You can modify the Output queue
options through the Environment Control setup for this user, or by accessing the Gentran Job
Scheduler from the PRTPXR command which submits the report. To do this, type ‘*YES’ in the
Schedule Job? field.
EBDI006G RUN DATE: 04/30/08 PARTNER CROSS REFERENCE REPORT RUN TIME 12:00:00 PAGE 1
TPCOMPANY TPCOMPANY ZZ
TPCOMPANY TPDUNS
TPCOMPANY TPDUNS 01
TRAVEL PEOPLE ** NO X-REFS FOUND **
Common Questions
What is the partner profile and what is it used for?
The partner profile is similar to an electronic rolodex, where all the information about how to “do
EDI” with a partner is stored. In EDI, anyone with whom you transfer documents is called your
trading partner. These trading partners may have been known as your Customer or Vendor. If you
were to mail a document to your trading partner, you need to know the destination address and
where that information is stored. The same type of information is needed by Gentran:Server when
the document is sent electronically.
The envelope type that the EDI data is “stuffed” into for transmission.
Same Interchange and Group Identifiers: If the partner identified on the interchange and
group envelope is for the same entity (similar to a “corporate” identifier), different divisions
are usually handled within the data (in the N1 loop). An example of this is when multiple
different bill-to and ship-to identifiers are contained within the entity. In this case, only one
Partner ID is needed. This method is often used when the partner is processing the EDI data
centrally and then distributing it to the different divisions.
Same Interchange, Different Group Identifiers: There are two scenarios for this type: one
for multiple divisions and one for a single company with different identifiers for each
document.
n If the interchange indicates a “corporate” identifier (an ID that represents the whole com-
pany) while the group envelope identifies different divisions, multiple partners need to be
created in Gentran:Server, one for each unique sender/receiver combination on the group
envelope. This scenario is very common for multiple divisions. By creating unique part-
ners for each division, each one indicates the same identifier at the interchange level.
However, each division has its own identifier for each group envelope.
o If the interchange indicates a “corporate” identifier while each document group contains a
different identifier, only one partner is needed. This scenario is not common, but it is one
that has been required in the past. The data is for one entity (not for multiple divisions).
However, a different identifier is used to distinguish between document types. Since
Gentran:Server allows you to identify a different identifier on each functional group
record, only one single partner is needed.
Different Interchange, Different Group Identifiers: This option is the same as “Same
Interchange, Different Group Identifiers.” Multiple partners need to be created for each
sender/receiver combination. The only difference is that on the interchange, different
identifiers are used for each division.
Gentran:Server uses the same principle. Since there may be several different identifiers that are
used to refer to the same partner, such as envelope identifiers and internal identifiers, it is tedious
to set up the same partner over and over. These “alias” identifiers can be tied back to the single
Partner ID by using the Cross Reference file, just like the Yellow Pages does by pointing you to the
listing where the address and phone numbers are stored.
If the partner that was set up is not found, and the Partner Verification global parameter is turned
on, Gentran:Server places the data in the Suspense File. Error messages are also printed on the
processing reports indicating that the partner has not been found. In order to correct this problem,
set up Cross-Reference entries in the Partner Cross Reference file to “tie” the unknown identifier
to the Partner ID. (SEE the step-by-step procedure for creating a partner in this chapter.)
4 Mapping: Getting
Started
In this Chapter
This chapter is an introduction to the Mapping subsystem. It is recommended that you read this
chapter before starting the actual task of creating the map, using the next two chapters,
“Application Definition” and “Transaction Mapping.”
# NOTE
You may also want to read the “Mapping Integration” section of the Manager’s
Implementation Planner before continuing. This section includes an overview of additional
material to reference and the initial steps that are performed in mapping.
What is Mapping?
Mapping is the definition of how to move data between your application format and the EDI
format requested by your trading partner. The definition is sophisticated enough to include special
manipulations that need to be done as the data is moved or special conditions that need to be
evaluated before the data is manipulated or moved. Within the scope of Gentran:Server, several
synonyms are used to refer to mapping. A map can also be referred to as a Transaction ID or a
Transaction Definition.
Mapping Features
Below are mapping features found in Gentran:Server.
Ability to retrieve DDS (Data Description Specifications) to define application layouts.
Point-to-point connection between application data and EDI data.
One mapping definition that can be used for multiple trading partners.
Automatic conversion of dates (e.g., converting MMDDYY to YYYYMMDD).
Ability to move literal values into the target data file even if these literal values do not exist in
the Source Data file (application data to EDI data, and vice versa).
Ability to convert internal code values into EDI-specific code values.
Creation of new maps for the same version by copying old maps.
Ability to migrate maps from one EDI version to another EDI version.
“Re-link” maps if the application format changes.
Ability to copy application definitions, maps, and tables from one library to another library
(that is, move information from a test environment to a production environment).
Ability to map from application files to EDI envelopes.
Provide advanced functionalities, namely:
1. Subfield mapping (that is, concatenating multiple fields together to be moved into
one single EDI element or “decatenating” an EDI element into multiple
application fields).
2. Arithmetic Operations (+, -, *, /).
3. Conditional mapping (if... then... else logic).
4. User Exits (APIs – Application Program Interfaces)
How does the application interface with Gentran:Server for inbound and outbound
processing?
Does the data have to be reformatted from Master files before the data is passed to
Gentran:Server for processing?
The files interfacing with Gentran:Server are not typically the Master files. Rather, they are
temporary work files, or “application link files,” containing extracted data that is sent out via EDI
to the specific trading partners (for outbound processing), or they are temporary work files, or
“application link files,” containing data that was received via EDI from specific trading partners
that needs to be loaded or interfaced with the Master files (e.g., Order Entry System). It is possible
to interface directly with the Master files. However, it is not advisable due to the potential
problems that may arise if it is necessary to reprocess the data. Figure 4.1 illustrates the typical
procedure for interfacing application data with Gentran:Server.
Master User-defined
File(s) Application
Program
Interface(s) Application
Link File(s)
Gentran:Server
Translation
User-defined Application
Application Link File(s)
Program
Interface(s)
Master
File(s)
Communications
Logical: One externally described multi-format logical file (created via DDS).
Flat file: One internally described physical file (created using record length instead of DDS).
# NOTE
The record length for any file cannot exceed 10,000 bytes.
Externally Described Physical Files (P) are the most common type. Multiple physical files can
be used. Most transactions require a physical file per area of the EDI document, such as one for the
Header, one for the Detail, and optionally one for the Summary.
STOP
CAUTION
For outbound processing, each physical file used must contain at least one key field, or one
must be defined on the Application Key Structure panel (EDIX559-FMT01). A time stamp
field (Z type field in the DDS) cannot be a key field. There cannot be more than 32 physical
files defined to an application definition for outbound processing.
For outbound processing, Gentran:Server first dynamically generates DDS and creates a
Multi-Format Logical file over all the physical files specified. It is impossible for Gentran:Server
to process the data with integrity if there are no keys on the physical files, or no keys contained in
the logical file. If no keys exist on the physical files, it is possible to identify fields that should be
key fields for the multi-format logical file that is created at run-time.
The logical file that Gentran:Server creates for outbound processing is used as input to the Mapper.
This enables all the records for the same document to be processed together in one file by reading
the records sequentially. The keys of the physical files need to tie all the records together for a
single document. It is common to use a primary key of partner first, then the document number so
fewer interchanges will be generated for the single document. (HINT: This saves you time and
money!)
For inbound processing, Gentran:Server does not require the physical files to contain key fields
because it is not necessary to generate the multi-format logical file over them.
Externally Described Multi-format Logical Files (L) can be used effectively for outbound
processing, but they are generally not used for inbound processing. If they are used, you must
create the multi-format logical file yourself using DDS over the same physical files mentioned
above instead of having Gentran:Server create this file.
There are valid reasons for creating the logical file yourself, namely:
Record selection can be used. Since you create the DDS yourself, specific records can be
selected using the SELECT/OMIT keyword in the DDS. For example, records can be selected
from all physical files if a status flag indicates the data is destined for EDI but has not yet been
interfaced to Gentran:Server.
Problem determination might be easier if the file was created by the user prior to processing.
The file may be a permanent logical file or a temporary file that is created at the beginning of
the EDI processing stream.
For large files, processing can be enhanced with the use of a logical.
Many users are not familiar with the Multi-Format Logical file and may not have the time or
desire to get acquainted with it.
Extra DDS needs to be generated and maintained for the logical file.
The logical file must be created prior to processing. The file may be a permanent file that
requires extra overhead for maintaining the access paths.
Internally Described Physical File (I) is also known as the “flat file,” containing multiple-record
formats that are in the same offset of each record. The format of the records is typically defined
internally within each program it is used in. The data needs to be sorted by the user or user
program before outbound processing in the order of partner and document. All records needed to
produce one single document for a partner must be grouped together.
Using the invoice as an example, the Header record for one invoice is followed by all the Detail
line item records for the same invoice, then by a Header record for the second invoice, and so
forth. For inbound processing, it is common to load a sort key on the front of every record during
mapping so that the user’s post-processing program(s) can sort the records based on the
requirements of the application interface.
U3/0 880
Map General
004020
004020 810 Map
810 Map Partner Spec.
General
Application
Data ID
Invoice File(s)
004010
004010 810 Map
810 Map Functional Groups: IN, IG
General
Partner Spec.
“Hub of the Wheel”
Transaction IDs
Invoice Segments
Transaction Sets:810, 880
“Spokes of the Wheel”
General maps
Partner-specific maps
General maps are intended to be used for many trading partners to define how the data is
translated between formats for a particular EDI version. It is common to use a General map for
inbound processing that is robust enough to include all the EDI data that any trading partner may
send you.
Partner-specific maps are used for a specific trading partner or sets of trading partners that differs
from the “general” method for translating the data between formats. It is common for outbound
processing to use partner-specific maps since most trading partners request to have data sent “just
the way they want it.” In this case, you can copy an existing map and modify it for the new trading
partner.
# NOTE
To use a specific map for a trading partner, you MUST identify the map in the trading
partner’s profile. (SEE the “Partner” chapter for more information.)
Your application format should be dictated by the needs of your application. In the following
example, the application is structured around the invoice. Additional information is added to
include information specific to EDI that is not printed on the paper invoice.
# NOTE
The Header data from the paper invoice is moved into the Header portion of the electronic
invoice, Detail data is moved into the Detail portion, and so on.
Figure 4.3 describes the data that is moved into the EDI format for each segment.
Interchange (ISA)
Group (GS)
Equals
Transaction (ST)
BIG*20040925*971220001*20040915*24873 N/L
INVOICE NTE*GEN*RUSH ORDER N/L
Inv #: 971220001 PO No: 24873 REF*DP*A158 N/L
Inv Date: 09-25-04 PO Date: 09-15-04 N1*BT*SUNNY RETAILERS*01*103868929 N/L
Bill To: Ship To: N3*1509 N. BRIDGE AVE. N/L
Sunny Retailers Sunny Retailers H N4*SUNNYVALE*CA*96810 N/L
1509 N. Bridge Ave Store # 608 Dept. A158
Sunnyvale, CA 96810 1509 N. Bridge Ave.
N1*ST**92*508 N/L
Sunnyvale, CA 96810 N1*RE*FANCY DESIGNERS N/L
Bill of Lading: Terms N3*PO BOX 7180 N/L
Pro #: 2% 10 Net 30 N4*RICHMOND*OH*43019 N/L
Comments: Rush Order
ITD*01*3*2**10**30 N/L
Remit To: Fancy Designers, PO Box 7180 DTM*011*20040125 N/L
Richmond, OH 43019
Unit IT1**1*EA*470.50**UP*052177002578*VP*601422 N/L
Qty Item # Description Price Total PID*F****ANTIQUE CURIO CABINET N/L
1 601422 Antique Curio 470.50 470.50 D IT1**7*EA*95.90**UP*052177002685*VP*648019 N/L
Cabinet
7 648019 Oak End Table 95.90 671.30 PID*F****OAK END TABLE N/L
2 633485 Crystal Etched 85.00 170.00 IT1**2*EA*85.00*UP*052177002653*VP*633485 N/L
Lamp
4 486371 Brass Magazine 15.99 63.96
PID*F****CRYSTAL ETCHED LAMP N/L
Rack IT1**4*EA*15.99**UP*052177002615*VP*486371 N/L
PID*F****BRASS MAGAZINE RACK N/L
Routing: UPS Invoice Total: $ 1375.76
Total Qty Shipped: 14 S
TDS*137576 N/L
CAD****UPS N/L
CTT*4 N/L
Figure 4.3 Application Format for Paper Invoice to be Moved into EDI Invoice
08 Receiver ID Partner’s DUNS Ask your partner what identifier you use
# to identify them when sending this
document outbound.
03 Application Receiver’s Partner’s Ask your partner what code you use to
Code DUNS # identify them when sending this
document outbound.
01 Date/Time Qualifier 011 Indicates the date below is the Ship date
(when product was shipped).
05 Description Oak End Table Item Description for the End Table.
01 Total Invoice Amount 1375.76 Sum of all extended line items for the
total invoice amount (if allowances or
charges exist, this amount is net of
these).
04 SCAC (Standard Carrier UPS Carrier Code for how the product was
Alpha Code) shipped for this invoice; follow the
Public SCAC Guidelines for Carrier
Codes.
With this example, you can have three different application files: one containing all the Header
information, one containing information for each line item, and one containing the Summary
control totals for each invoice. All three may be created using DDS source with a key field of
partner and invoice number. This is just one example of how to approach the design of the
application format that is input to the mapping.
1. Select the standard, standards version, transaction set, and segments to be used.
2. Define the application files. The example provided in the previous figure can be
used as a model for your document and application format.
4. Analyze the application data fields and determine which EDI elements are
logically linked. Define the loops if needed.
# NOTE
For outbound processing, Loop IDs must match those on the EDI
transaction.
6. Complete mapping worksheets (blank worksheets are available at the end of the
“Transaction Mapping” chapter).
7. Create the map. (SEE the “Transaction Mapping” chapter for a step-by-step
procedure for creating maps in Gentran:Server.)
9. Develop outbound test data (or request inbound test data from your trading
partner) and thoroughly test the data through all translation processing, and verify
the results.
Alternatively, you may use the Gentran:Server Mapping Job Aid in the Manager’s Implementation
Planner to build a transaction map.
# NOTE
SEE the Glossary in this manual for a list of reserved word constants, application data types,
and EDI data types. These are useful during the actual creation of the map in Gentran:Server.
An overview of the processing steps for the Mapper is provided in Figure 4.5.
Gentran:Server uses an 800K Input buffer to help write the Output records or Segments after being
translated, as shown in the following figure. The asterisk indicates where the buffer is being
cleared. (SEE the “Processing” chapter in the Technical Reference Guide for an advanced review.)
Start Doc
* Header Segments
A
C
C
R
E
S
E
Header
Processing
Header
Records
U R
*
M H V Detail Detail
Detail Segments U A E Processing Records
L S D
A H C
T O
*
O N
Section 1 Segments R Section 1 Section 1
S Processing Records
S T T W
O A O
T N R Sections 1 to 9 are processed
A T D
*
L S S
Section 9 Segments S Section 9 Section 9
Processing Records
End Doc
5 Application Definition
In this Chapter
)RECOMMENDATION
It is strongly recommended that you review the “Mapping: Getting Started” chapter in this
manual before continuing. It introduces you to the theory of mapping in Gentran:Server and
provides the basic information you need to create your application file format.
This chapter describes what an application definition is and where it is used. Step-by-step
procedures are provided to guide you in creating an application definition for each type of
application file that can be interfaced with Gentran:Server.
The application definition is then used to create a link between the application files and the
transaction definition (which is the EDI format). This link is established by identifying how the
application data fields are related to the EDI elements. The term “element” is similar to the term
“field.”
Maintain key structures for outbound application definitions that use externally defined
physical files
Print or re-retrieve DDS for those applications that contain the changed file (RRTVDDS)
EDIX556-CTL01 Revise or view the Key Structure Select option ‘12’ on panel
for the outbound application EDIX550-FMT01
Application Key
Structure Type ‘EXCPGM EDIX556’ on
the command line
APPSYNCH Re-synchronize all maps linked Re-retrieve the DDS using option
to the application if the DDS has ‘12’ on panel EDIX553
Application been re-retrieved or if manual (submitted automatically)
Synchronization updates have been made to the
application Re-retrieve the DDS using F18 on
panel EDIX552-FMT01
(submitted automatically)
Select option ‘32’ on panel
EDIX550
Prompt ‘APPSYNCH’ on the
command line
Select option ‘13’ on the
GENMAP menu
To access the Application Definition subsystem, select ‘2’ (Work with Application Definition) on
the Gentran:Server for iSeries menu (GENMAIN), as shown in Figure 5.1.
The system displays the Work with Application Definition panel (EDIX550-FMT01). Each task in
this chapter begins at the Work with Application Definition panel.
# NOTE
You can also access the Work with Application Definition panel from the Mapping Menu by
selecting option ‘3’ on the GENMAIN menu and then selecting option ‘1’ on the GENMAP
menu.
The use of the application definition panels is illustrated in the form of tasks. The tasks in this
chapter describe the following:
While the scenarios define specific applications, they are based on common steps taken to define
any application. Use these tasks as a guide to set up your application definition.
# NOTE
All files necessary for each scenario have already been created in library (G3X5SAMP).
Off-line Preparation
Before you define the application definition to Gentran:Server, you may find it beneficial to spend
some time designing the format of your application files. Doing so makes it much easier to
complete the steps to create your application definition.
Analyze your application master files to determine which fields are required to build the EDI
document.
You must define the contents of each externally defined physical file including the Field Name,
Field Length, and Data Type using the Data Description Specification (DDS).
# NOTE
It is not necessary for your DDS to identify any fields as keys. You can use Gentran:Server to
define which fields should be keys.
Looking at the “paper invoice” on the next page (Figure 5.2), we determined that three files were
necessary to send the sample invoice; Header, Comment and Detail. The Header file is used to
store the Header portion of the invoice. Even though the comments are included in the Header
portion of the paper invoice, they are stored in a separate file. This enables you to send multiple
comments within a single electronic invoice. A Summary file is not required because we use
reserved words to map the Summary Segments.
Interchange (ISA)
INVOICE
Group (GS)
Inv #: 971220001 PO No: 24873
Inv Date: 09-25-04 PO Date: 09-15-04
Unit
Qty Item # Description Total
Price
S TDS*137576 N/L
CAD****UPS N/L
Routing: UPS Invoice Total: $ 1375.76 CTT*4 N/L
Total Qty Shipped: 14
Figure 5.2 Application Format for Paper Invoice to be Moved into EDI Invoice
Figure 5.3 shows the fields that will be needed to build the sample invoice.
2. Type ‘INVOUTPEDI’ in the Application ID field and ‘S’ in the S/R (Send/Receive) field
and press Enter. The name ‘INVOUTPEDI’ is an example of an Application ID to use.
You may use any name you wish (that is, your company’s initials).
Field Descriptions
Application ID
This field is the single identifier for your application definition under which all
information is stored. Name the application based on the type of document it is (i.e.,
INVOUTP for outbound invoices), rather than by the transaction set or partner. Make the
definition comprehensive enough to interface to various different EDI formats including
X12, UCS, and EDIFACT.
Send or Receive
The value for this field is ‘S’ for send or ‘R’ for receive. An application definition must be
unique per direction. If you expect to send and receive, two definitions are required (one
for each direction).
The Application Definition panel (EDIX552-FMT01), Figure 5.5, is where you specify the
characteristics of a particular application definition. This is the header to the entire application
definition.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . INVOICE OUTBOUND - PHYSICAL
Functional Groups. . . . . . . . . IN
File Type. . . . . . . . . . . . . P
EDI Split File . . . . . . . . . .
EDI Sub-Split File . . . . . . . .
Record Type Start Position . . . .
Length . . . . . . . . . . . . . .
Application File . . . . . . . . .
Update Allowed . . . . . . . . . . Y
You must enter the information required for this panel: Description, Functional Groups, and
Application File Type.
1. Type the Description of the application definition as shown on the above panel.
2. Type ‘IN’ (Functional Group ID for an invoice) in the Functional Groups field. Press F4
(Prompt) for a list of valid Functional Group IDs.
3. Type ‘P’ in the File Type field to indicate that the application files are externally defined
physical files. Press F4 (Prompt) for a list of valid file types.
4. Press F10 (Update) to save the information you just entered and to return to the Work with
Application Definition panel (EDIX550-FMT01).
Field Descriptions
Division Code
The Division Code is assigned from your security profile within Gentran:Server.
Description
This field is used to describe the application definition. Typically, the field includes the
type of document being sent. If desired, include the direction and type of files being used
(that is, DDS).
Functional Groups
Up to five functional groups can be used with an application definition. You must supply
valid Functional Group IDs as defined by the EDI standards.
File Type
This field is one of the most important fields on this panel. It identifies what type of file
you use to interface to Gentran:Server for a particular application definition. The type of
file you use can be different from application to application.
Update Allowed
Set this field to ‘Y’ to allow updates to be made to this definition. Once you begin testing,
you may want to change this to ‘N’ to prevent inadvertent updates to the definition.
Application Records/Files
The first step in defining the files for your application definition is to access the Application
Records/Files panel (EDIX553-CTL01).
Access ‘INVOUTPEDI’ for the sample invoice application you are creating in this scenario (as
shown in Figure 5.6).
The next step is to add physical file names to the definition that will be interfaced with
Gentran:Server.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . INVOICE OUTBOUND - PHYSICAL
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
You must enter the basic information required for this panel: Sequence Number, File Name, Area,
Max Use, Mandatory Code, and Description (Write Flag is required for inbound). Once you press
F10 (Update) or Enter, Gentran:Server automatically retrieves the DDS for each file.
2. Type ‘D’ in the A (Area) field and ‘6000’ in the Loop ID field for Sequence ‘30.’
STOP
CAUTION
Option ‘12’ (Re-retrieve DDS) re-retrieves the DDS (file layout from the external physical
file). The user is prompted to confirm the re-retrieve function. Any changes made to the
application fields, such as the Data Type or Field Value (inbound only) are preserved as long
as the DDS type and field length have not changed. An exception report is produced and
should be reviewed. Additionally, upon exiting this panel after the DDS has been
re-retrieved, the APPSYNCH command is automatically submitted to re-synchronize all
maps linked to this application definition. The resynch report(s) should be reviewed.
Field Descriptions
Sequence Number
This field helps the user to list the files in the order in which the data is processed. It is
typical to sequence by 10’s to allow additional files to be inserted at any time.
Record/Files
This field contains the name of the physical file, not the record name. There is not a place
to qualify the library for processing or for the DDS retrieval. The first file found in the
library list is used. The same file cannot be repeated within the definition.
Area
This field is the area code that this file is assigned to based on the corresponding EDI
standards area codes. Press F4 (Prompt) for a list of valid area codes. There must be at
least one Header file. It is common to have at least one file per area, with the exception of
the summary.
Loop ID
This field is used to connect one or more application files with the multiple occurrence of
an EDI loop. In this scenario, the Detail file has one record read per iteration of the IT1
line item loop according to the EDI format for an invoice.
If the application definition did not have the Loop ID on the Detail file (WPEINVITM),
then only one ‘IT1’ line item loop is ever generated and sent out. The remaining line items
are dropped.
Max Use
This field identifies how many times in a row a record is read or written per iteration of the
corresponding loop or area. In this scenario, the invoice Header file has a Max Use of ‘1’
and the invoice Detail file has a Max Use of ‘1.’ This means that only one Header record is
read per invoice and only one Detail record is read per iteration of a line item loop. Invoice
Comments can occur up to ten times for every invoice Header file.
Mandatory Code
This code indicates whether the file is mandatory or optional (M or O, respectively).
Although it is required, it is informational only.
Write Flag
This field, with values of ‘Y’ (yes) or ‘N’ (no), indicates whether the application record is
written. For outbound, this field must be left BLANK.
Set the flag to ‘Y’ for inbound, unless you have a special circumstances where you do not
want records written to the file.
Description
A meaningful description is recommended. It indicates the kind of information in the file
and is very helpful for ongoing maintenance.
Application Fields
The next step in defining the application is to access the Application Fields panel
(EDIX544-CTL01).
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . INVOICE OUTBOUND - PHYSICAL
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
Type ‘11’ (Fields) in the Option field next to the first file (as shown in Figure 5.8) and press
Enter. The Application Fields panel (EDIX554-CTL01) displays.
Make modifications to the field definition for each file in the application. The fields retrieved from
the DDS display on the panel, as shown in Figure 5.9.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Record/File Sequence Number. . . . 10
Description. . . . . . . . . . . . INVOICE HEADER
Record/File. . . . . . . . . . . . WPEINVHDR
Review the field information retrieved and make any necessary modifications. Page Down to
review more fields. Press F17 (Next Rcd) to advance to the next file that was defined and repeat
this step. When finished, press F10 (Update).
Data types for Date fields are changed to specific data types known to Gentran:Server to allow
the conversion of the date format
Field Values may be added to set the default values (for inbound only)
Descriptions may be changed to clarify field definitions
Mandatory Codes may be changed to optional codes
The dates in the sample invoice are stored in the YYYYMMDD format, so we need to make these
changes:
1. Type ‘CY’ in the Type field for Sequence 20 and 30. This allows Gentran:Server to
convert the date from a YYYYMMDD format to a YYMMDD for EDI.
2. Press F10 (Update).
# NOTE
In this scenario, no modifications are required to the Comment and Detail files. If
you wish to view the fields for other application files, press F17 (Next Rcd) to
advance to the next file.
Field Descriptions
Sequence Number
This field is similar to the file Sequence number on the Application Records/Files panel. It
must be a unique number within the file.
The fields are retrieved in the order they exist in the file. They need to stay in this order.
When Gentran:Server retrieves the field information, it sequences them by increments of
five to allow for insertion of fields.
Field Name
The field contains the actual field name retrieved from the file but is prefixed by a unique
identifier for this file. This identifier always starts with ‘F’ for file and is tagged with the
Sequence Number, as shown at the top of the panel. A period is used between this file
identifier and the actual field name. This is the field name that is referenced for mapping
in Gentran:Server (including the period).
# NOTE
The field name MUST be unique across all files within an application definition. If a
field has the same name in more than one file, Gentran:Server requires the name to
be different. To ensure this rule, prefix each field with a unique identifier.
Type
This field is retrieved from the file and converted to valid data types for Gentran:Server.
Press F4 (Prompt) for a list of valid data types (including packed fields, signed fields, and
alphanumeric fields). It cannot automatically identify the format your date fields are in.
These fields are retrieved as signed or packed depending on how they were defined in your
file.
Start
This field indicates the starting position in the file. It is retrieved from the file
automatically.
Length
This field identifies the physical length of the field in the file. The physical length is the
amount of space it takes up, not the actual exploded field length. For example, if you had a
packed date field that took up 4 bytes, but was actually 6 bytes when unpacked, the field
length is four bytes. Gentran:Server retrieves this information for you.
Mandatory Code
This code defaults to ‘M’ for all fields upon retrieval. This code indicates whether the field
is mandatory or optional (M or O, respectively). Only mark a field as mandatory when it
will always be there on every occurrence of the record for which it is defined. For
inbound, mandatory fields will cause a warning message to be issued if no data is found to
be moved to the field.
Description
This description is retrieved from the DDS and may be modified to provide a more
meaningful description. The entire description is not always shown during the mapping
process.
) RECOMMENDATION
It may be helpful to have the most important part of the description, which
differentiates the field, at the beginning of the field.
Field Value
This value is not loaded by Gentran:Server when retrieving the DDS. This column must be
loaded by the user afterwards and is ONLY used for inbound. It is used to move a default
value into the application field after mapping and prior to writing the record. The default
values for the L date types, T time types, and Z date/time stamp are not required here. The
inbound mapper forces these values when necessary.
If the field was not loaded during the mapping process, you may want to load a default
value. Literals, reserved words, and envelope values can be typed into this field to be
moved into the application field. (SEE the “Glossary” for more information on reserved
words). If a field already has a value (loaded during the mapping process), the contents of
the Field Value will not overlay that value.
This feature can be very useful for loading key fields into a file. It is also helpful in
loading information that may not be transmitted in the EDI document but needs to be
added to your files prior to interfacing to your application system.
At this point, if you are creating an inbound application definition, you are ready to begin
mapping. If you are creating an outbound application definition, please continue with the section
on the following page.
# NOTE
This section and the two that follow (Application Partner Reference and Application
Envelope Definition) apply to outbound application definitions only – if you are creating an
inbound application definition, skip these sections.
Outbound application definitions for externally defined physical files require a key structure to
relate all the physical files in the application definition. Gentran:Server retrieves the keys (if you
identified them) for each file when the DDS for a physical file is retrieved. It is important to make
sure that the key fields are aligned properly. Otherwise, you will receive an error message when
Gentran:Server attempts to create the logical file which is used to process the data.
# NOTE
It is not necessary for your DDS to identify any fields as keys. You can use the Application
Key Structure panel after retrieving the file in Gentran:Server to define which fields should
be keys.
Type ‘12’ in the Option field next to the desired Application ID (as shown in Figure 5.10) and
press Enter. You can access the Application Key Structure panel (EDIX556-CTL01) only if you
set the application file type to “P” on the Application Definition panel (EDIX552-FMT01).
The purpose of this panel is to show the key fields defined for each physical file in your
application definition. It allows you to set them up so Gentran:Server can create the Multi-Format
Logical File (GENMFLF) during processing. If there are no key fields identified in the physical
files that you created, you can enter the fields that should be used as keys for logical processing.
STOP
CAUTION
EACH PHYSICAL FILE USED MUST CONTAIN AT LEAST ONE KEY FIELD
DEFINED IN THE APPLICATION KEY STRUCTURE. This is mandatory because
Gentran:Server dynamically generates DDS and creates a multi-format logical file over all
the Physical Files (at run-time) before processing starts. It is impossible for Gentran:Server
to process the data if there are no keys defined on the Application Key Structure.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . INVOICE OUTBOUND - PHYSICAL
Bottom
F1=Help F4=Prompt F10=Update F19=Left F20=Right F24=More Keys
Enter the key fields to complete the basic information required for Gentran:Server to build a
logical file. When finished, press F10 (Update).
In the example in Figure 5.11, the key fields for Key 3 in files WPEINVCMT and WPEINVITM
do not match. Continue with the next step to make the correction.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . INVOICE OUTBOUND - PHYSICAL
Bottom
F1=Help F4=Prompt F10=Update F19=Left F20=Right F24=More Keys
When the key fields across the files do not match, the keys need to be aligned as follows:
1. WPEINVITM does not align with WPEINVCMT. Move the item # (IDITEM) over to
Key 4. The third key for the item file does not match the third key of a sequence # from the
Comment file. It needs to be moved over to a new key by itself. (See Figure 5.12.)
STOP CAUTION
The message, “Field types different for Key xx,” displays if you tried to update a file
whose key fields did not match against another file. The non-matching key field
number is also displayed on the panel.
During processing, EBDI073 verifies that the DDS was generated for the logical file and that the
file has the proper key alignment. If the title can’t be created, the job log shows the program
message “Error Code: D,” and a spool file is generated that shows the errors encountered when
OS/400 attempted to create the multi-format logical file, as shown in Figure 5.13.
Figure 5.13 Job Log with program message from EBDI073 showing DDS and error
Expanded Source
Application Definition
SEQNBR *...+....1....+....2....+....3....+....4....+....5....+....6....+....
100 R REINVHDR PFILE(WPEINVHDR )
200 A K IHB2#
300 A K IHINV#
500 A R REINVCMT PFILE(WPEINVCMT )
600 A K ICB2#
700 A K ICINV#
800 A K ICSEQ#
1000 A R REINVITM PFILE(WPEINVITM )
1100 A K IDB2#
1200 A K IDINV#
1300 A K IDITEM
out of alignment, as shown in Figure 5.14.
* * * * * E N D O F E X P A N D E D S O U R C E * * * * *
Messages
ID Severity Number
* CPF3238 40 1 Message . . . : Key field IDITEM not same as previous formats.
Messages Summary
1 0 0 0 1
* * * * * E N D O F C O M P I L A T I O N * * * * *
Figure 5.14 DDS not generated when key structure is incorrect (not aligned)
The DDS from the logical file is generated if the logical file command is issued when the keys are
Expanded Source
SEQNBR *...+....1....+....2....+....3....+....4....+....5....+....6....+....
100 R REINVHDR PFILE(WPEINVHDR )
200 A K IHB2#
300 A K IHINV#
400 A K *NONE
500 A K *NONE
700 A R REINVCMT PFILE(WPEINVCMT )
800 A K ICB2#
900 A K ICINV#
1000 A K ICSEQ#
1100 A K *NONE
1300 A R REINVITM PFILE(WPEINVITM )
* * * * * E N D O F E X P A N D E D S O U R C E * * * * *
Application Definition for Externally Defined Physical Files
Messages Summary
0 0 0 0 0
* * * * * E N D O F C O M P I L A T I O N * * * * *
were skipped and left BLANK on the Application Key Structure panel), as shown in Figure 5.15.
When Gentran:Server generates the DDS, it loads ‘*NONE’ in the non-significant keys (keys that
Application Definition
5 - 25
Application Definition Application Definition for Externally Defined Physical Files
# NOTE
This section and the one that follows (Application Envelope Definition) apply to outbound
application definitions only – if you are creating an inbound application definition, skip these
sections.
The first step in defining the application partner reference is to access the Application Partner
Reference panel (EDIX559-FMT01). The application partner reference is only used for outbound
documents.
Type ‘13’ (App Part Ref) in the Option field next to the desired Application ID, as shown in Figure
5.16, and press Enter. The action displays the Application Partner Reference panel
(EDIX559-FMT01).
The application partner reference is the link between your data and the partner profile. It identifies
a specific place in the application file where Gentran:Server will look for the partner who receives
the data. The Application Partner Reference panel (EDIX559-FMT01) allows you to specify the
name of a field (or fields) in the application header file that contains the application partner
reference.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Application Select
Field Name . . . . . . . . . . . .
Enter the application partner reference field and press F10 (Update).
To specify the field name that will be used as the application partner reference in the example (as
shown in Figure 5.17), complete the following instructions:
2. Press F10 (Update) and return to the Work with Application Definition panel
(EDIX550-FMT01).
# NOTE
If your partner is set up in the Partner file, add a partner cross reference to point this field (or
fields) back to the Partner ID as defined. If no field exists in the header for the partner, the
partner needs to be provided as a run-time parameter on the outbound processing command.
(SEE the “Partner” chapter for more information on cross references.)
Field Descriptions
Application Partner Reference Field Name
This application field identifies the partner that receives this data via EDI. Provide a value
that is known to Gentran:Server in the application definition (including the File identifier).
This field is used along with the Qual Field Name to look up the partner in the Partner file
or Partner Cross Reference file.
STOP CAUTION
This field MUST be alphanumeric and MUST exist in a Header file in your
application definition.
If your partner is not set up in the Partner file, add a partner cross reference to point this
field (or fields) back to the Partner ID as defined. If no field exists in the Header for the
partner, the partner needs to be provided as a run-time parameter on the outbound
processing command. (SEE the “Partner” chapter for more information on cross
references.)
In our example, the BILLTO ACCT# from the invoice Header File identifies our partner.
1. To process the 980 Group Totals transaction with the 210 Motor Invoice
transaction.
2. To process the 850 Purchase Order transaction with the 860 Purchase Order
Change transaction.
One field would need to be defined as the Application Select field, whose contents would
identify which transaction map should be selected. If the 850 should be selected, the
selected field contains ‘O’ for original order. If the 860 should be selected, the field
contains ‘C’ for change order. These values for the Application Select field would be
defined on the Transaction ID.
# NOTE
This section applies to outbound application definitions only – if you are creating an inbound
application definition, skip this section.
The application envelope definition enables you to globally change an envelope value for all
partners for a particular application definition. For example, if you wanted to test an application
definition and indicate to all the partners who would receive the data processed that it is test data,
you could use this function to change the Sender ID to ‘TESTID’ for all partners, rather than
change the Sender ID on each partner’s profile. The Sender ID from the partner profiles would be
overridden.
The first step is to access the Application Envelope Definition panel (EDIX560-FMT01).
From the Work with Application Definition (EDIX550-FMT01) panel, type ‘14’ (Envelopes) in
the Option field next to the desired Application ID (as shown in Figure 5.18), and press Enter. The
action displays the Application Envelope Definition panel (EDIX560-FMT01).
The Application Envelope Definition panel (Figure 5.19) enables you to define the application
data fields containing envelope field data such as sender/receiver IDs, qualifiers, control number,
security and communications IDs, application reference information, priority codes and test
indicators. Any remaining envelope information not entered or not available on this panel will be
obtained from the Partner file.
STOP
CAUTION
While field names are verified by Gentran:Server, no verification is performed on the data
in the application data fields. It is the user’s responsibility to ensure that the data in the
application file is valid.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
# NOTE
Do not specify any fields on the panel for this example.
Field Descriptions
Interchange Sender Id A 15-position alphanumeric field used to enter ISA06, BG03, UNB02
the application data field that identifies the (code or name), and
interchange sender. STX02 (code) elements
(Interchange Sender Id) A 15-position alphanumeric field used to enter ISA05, UNB02
Qual the application data field that identifies the (qualifier), and STX02
Interchange Sender Id Qualifier. (name) elements
Group Sender Id A 15-position alphanumeric field used to enter GS02 and UNG02 (code
the application data field that identifies the or name) elements
Group Sender ID.
(Group Sender Id) Qual A 15-position alphanumeric field used to enter UNG02 (qualifier)
the application data field that identifies the element
Group Sender Id Qualifier.
Interchange Receiver Id A 15-position alphanumeric field used to enter ISA08, BG04, UNB03
the application data field that identifies the (code or name), and
Interchange Receiver Id. STX03 (code) elements
(Interchange Receiver Id) A 15-position alphanumeric field used to enter ISA07, UNB03,
Qual the application data field that identifies the (qualifier), and STX03
Interchange Receiver Id Qualifier. (name) elements
Group Receiver Id A 15-position alphanumeric field used to enter GS03 and UNG03 (code
the application data field that identifies the or name) elements
Group Receiver Id.
(Group Receiver Id) Qual A 15-position alphanumeric field used to enter UNG03 (qualifier)
the application data field that identifies the element
Group Receiver Id Qualifier.
Interchange Control Num A 15-position alphanumeric field used to enter ISA13, BG07, UNG05,
the application data field that identifies the and STX05 elements
Interchange Control Number.
Group Control Num A 15-position alphanumeric field used to enter GS06 and UNG05
the application data field that identifies the elements
Group Control Number.
Transaction Control Num A 15-position alphanumeric field used to enter ST02 and UNH01
the application data field that identifies the
Transaction Control Number.
ISA/UNB Test Indicator A 15-position alphanumeric field used to enter ISA15 and UNB11
the application data field that identifies the elements
ISA/UNB Test Indicator.
UNB/STX Appl A 15-position alphanumeric field used to enter UNB07 and STX07
Reference the application data field that identifies the elements
UNB/STX application reference.
UNB/STX Priority Code A 15-position alphanumeric field used to enter UNB08, and STX08
the application data field that identifies the elements
UNB/STX Priority Code.
STX Recipient Trans Ref A 15-position alphanumeric field used to enter STX06 element
the application data field that identifies the
STX Recipient Transmission Reference.
UNH03 Common Access A 15-position alphanumeric field used to enter UNH03 element
Reference the application data field that identifies the
UNH03 Common Access Reference.
At this point, you have finished creating an outbound application definition. You are ready to
begin mapping.
Off-line Preparation
Before you enter Gentran:Server to create an application definition, you may find it beneficial to
spend some time designing the format of your application file. Doing so will make it much easier
to complete the steps to create your application definition.
Analyze your application master files to determine which fields are required to build the EDI
document.
You must create the “flat” file that you will define inside Gentran:Server. Use the length of the
longest record when creating the physical file.
We can see in Figure 5.20 that this file has three unique types of records. A 3-character code
beginning in the 21st column of each record tells us what type of record we are dealing with.
1. Header Record (or 001 record) – This required record will occur once per document and
contains most of the general information for the purchase order. Each time we encounter
one of these records in the application file, we want a new EDI document generated.
2. Comment Record (or 002 record) – This is an optional record that contains free form
comments about the specific purchase order we are creating. These records will follow the
header record in the application file. Up to ten of these records can be generated by our
application for each document. Each time one of these records is encountered, we need to
generate a comment in the EDI document.
3. Detail Record (or 005 record) – One of these records will occur in the application file for
each item to be ordered. At least one of these records is required per document. The
current application can generate up to 200,000 of these records per document.
2. Type ‘POFILE1’ in the Appl(ication) ID field and ‘S’ in the S/R (Send/Receive) field and
press Enter. The name ‘POFILE1’ is an example of an Application ID to use. You may
use any name you wish (i.e., your company’s initials).
Field Descriptions
Application ID
This field is the single identifier for your application definition under which all
information is stored. Name the application based on the type of document it is (i.e.,
POFILE for outbound purchase orders), rather than by the transaction set or partner. Make
the definition comprehensive enough to interface to various different EDI formats
including X12, UCS, and EDIFACT.
Send or Receive
The value for this field is ‘S’ for send or ‘R’ for receive. An application definition must be
unique per direction. If you expect to send and receive, two definitions are required (one
for each direction).
The Application Definition panel, Figure 5.22, is where you specify the characteristics of a
particular application definition. This is the header to the entire application definition.
EDIX552 Application Definition EDI 04/30/08
FMT01 12:00:00
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . PURCHASE ORDER - OUTBOUND
Functional Groups. . . . . . . . . PO
File Type. . . . . . . . . . . . . I
EDI Split File . . . . . . . . . .
EDI Sub-Split File . . . . . . . .
Record Type Start Position . . . . 21
Length . . . . . . . . . . . . . . 03
Application File . . . . . . . . . POFILE
Update Allowed . . . . . . . . . . Y
Enter the information required for this panel: Description, Functional Group, Application File
Type, Record Type Start Position, Length, and the Application File you are going to describe.
1. Type the Description of the application definition as shown on the above panel.
2. Type ‘PO’ (Functional Group ID for purchase order) in the Functional Groups field. Press
F4 (Prompt) for a list of valid Functional Group IDs.
3. Type ‘I’ in the File Type field to indicate that the application file is an internally defined
file. Press F4 (Prompt) for a list of valid file types.
4. Specify ‘POFILE’ as the name of the application file. Press F10 (Update) to save the
information you just entered and to return you to the Work with Application Definition
panel (EDIX550-FMT01).
Field Descriptions
Division Code
The Division Code is assigned from your security profile within Gentran:Server.
Description
This field is used to describe the application definition. Typically, the field includes the
type of document being sent.
Functional Groups
Up to five functional groups can be used with an application definition. You must supply
valid Functional Group ID as defined by the EDI standards.
File Type
This field is one of the most important on this panel. It identifies what type of files you use
to interface to Gentran:Server for this particular application definition. The type of files
you use can be different from application to application.
Length
This field contains the length of the record type mentioned above, to indicate how many
bytes are used. The length cannot exceed 10 bytes. The record type and length is
mandatory for outbound documents that use an internally defined file. These fields enable
Gentran:Server to locate each record during processing. If inbound and the records do not
have a record type, type a value of ‘1’.
Application File
This field contains the name of the internally defined physical file that is interfaced with
Gentran:Server. The file MUST exist to add the Application Data ID. For outbound
processing, the file MUST exist in the library list. For inbound processing, if the file does
not exist, data is written to the default physical file (GT41001) in the Gentran:Server data
library (that is, G3X5DTA). This file name and a message is logged in the inbound
processing job log. In the example, the file ‘POFILE’ is used.
Update Allowed
Set this field to ‘Y’ to allow updates to be made to this definition. Once you begin testing,
you may want to change this to ‘N’ to prevent inadvertent updates to the definition.
Application Records/Files
The first step in defining the records for your application definition is to access the Application
Records/Files panel (EDIX553-CTL01).
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘11’ (Rec/Files) in the Option field next to the appropriate application and press Enter.
Access ‘POFILE1’ for the sample purchase order application you are creating, as shown in
Figure 5.23.
The next step is to add all the unique record types to the application definition that are interfaced.
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . PURCHASE ORDER - OUTBOUND
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
You must enter the basic information required for this panel: Sequence Number, Record Name,
Area, Max Use, Mandatory Code, and Description (Write Flag is required for inbound).
Three records will be defined for this scenario, as shown in Figure 5.24.
1. Type “010” for the first Sequence. (For subsequent records the sequence number will be
020, 030) The cursor will advance to the (Rec/File) field.
Each record is assigned a unique sequence number. It is suggested that these sequence
numbers be assigned in increments of 10 to allow for future insertion.
2. Type ‘001’ for the first Rec/File entry. (For subsequent records, the Record will be 002
and 005).
The values 001, 002, and 005 describes the data that will be present in each record in the
positions defined by the Record Type Start and Length fields on the Application Data
panel (EDIX552-FMT01). For this application, bytes 21, 22, and 23 are used to define the
record type.
3. Enter the area of the document the records will occur in the application File. In this
example, type ‘H’ for record 001, ‘H’ for record 002, and ‘D’ for record 005.
5. Type ‘8000’ in the Loop ID field for Record 005. The 005 Record is associated with the
main detail loop of the purchase order.
7. Press Enter.
Field Descriptions
Sequence Number
This field helps the user to list the records in the order in which the data is processed.
Record/Files
This field contains the name of the record. For outbound, this MUST match the actual
record type that displays in the record as indicated on the Application Data ID. In our
example, we indicated that the record type begins at position 21 for a length of 3. The
contents of those 3 bytes are either ‘001,’ ‘002,’ or ‘005.’ For inbound, there is no
restriction on the record type entered.
Area
This field is the area code that this record is assigned to based on the corresponding EDI
standards area codes. Press F4 (Prompt) for a list of valid area codes. There must be at
least one Header record. It is common to have at least record per area, with the exception
of the summary.
Loop ID
This field is used to connect one or more application records with the multiple occurrence
of an EDI loop. In this example, the Detail record has one record read per iteration of the
PO1 line item loop according to the EDI format for a purchase order. If the application
definition did not have the Loop ID on the Detail record (005), then only one PO1 line
item loop is ever generated and sent out. The remaining line items are dropped.
Max Use
This field identifies how many times in a row a record is read or written per iteration of the
corresponding loop or area. In this example, the purchase order Header record has a Max
Use of 1 and the purchase order Detail record has a Max Use of 1. This means that only
one purchase order Header record is read per purchase order, and only one purchase order
Detail record is read per iteration of a line item loop. The purchase order Header
Comments record can occur up to ten times for every purchase order Header record.
Mandatory Code
This code indicates whether the record is mandatory or optional (M or O, respectively).
Although it is required, it is informational only.
Write Flag
This field, with values of ‘Y’ (yes) or ‘N’ (no), indicates whether the application record is
written. For outbound, this field has no meaning and Gentran:Server leaves the field
BLANK.
Description
A meaningful description is recommended. It indicates the kind of information in the
record and is very helpful for ongoing maintenance.
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . PURCHASE ORDER - OUTBOUND
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
Type ‘11’ (Fields) in the Option field next to each record, as shown in Figure 5.25, and press
Enter. The Application Fields panel (EDIX554-CTL01) displays.
The next step is to define the fields for each record in the application definition.
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Record/File Sequence Number. . . . 10
Description. . . . . . . . . . . . PO HEADER RECORD
Record/File. . . . . . . . . . . . 001
Add all the field information for this record that is shown in Figure 5.26. Use Page Down to see
additional pages of fields. When finished, press Enter or F10 (Update). Repeat this step for record
002 and record 005.
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Record/File Sequence Number. . . . 20
Description. . . . . . . . . . . . PO COMMENTS RECORD
Record/File. . . . . . . . . . . . 002
More...
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Add the fields for Sequence 20 that are shown in Figure 5.28 and press F10 (Update).
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Record/File Sequence Number. . . . 30
Description. . . . . . . . . . . . PO DETAIL RECORD
Record/File. . . . . . . . . . . . 005
Add the fields for Sequence 30 that are shown in Figure 5.30 and press F10 (Update).
Field Descriptions
Sequence Number
This field is similar to the record sequence number. It is used to list the fields contained in
each record. It must be a unique number within the record.
Field Name
This field contains the name of the field as known to Gentran:Server.
# NOTE
The field name MUST be unique across all records within an application definition.
If a field has the same name in more than one record, Gentran:Server requires the
name to be different. To ensure this rule, prefix each field with a unique identifier.
For example, ‘001’ can be used to prefix the field name in the first Header record.
Type
This field contains the Data Type of the application field (not the EDI Data Type). Press
F4 (Prompt) for a list of valid data types.
Start
This field is the starting position in the record.
Length
This field contains the physical length of the field in the record. The physical length is the
amount of space it takes up, not the actual exploded field length. For example, if you had a
packed date field that took up 4 bytes, but was actually 6 bytes when unpacked, the field
length is 4-bytes.
Mandatory Code
This Code indicates whether the field is mandatory or optional (M or O, respectively).
Only make a field as mandatory when it will always be there on every occurrence of the
record for which it is defined. For inbound, mandatory fields will cause a warning
message to be issued if no data is found to be moved to the field. For outbound, this field
is informational only.
Description
Provide a meaningful description for the application field. Within Gentran:Server, the
entire description is not always shown during the mapping process.
) RECOMMENDATION
It may be helpful to have the most important part of the description, which
differentiates the field, at the beginning of the field.
Field Value
This column must be loaded by the user and is ONLY used for inbound. It is used to move
a default value into the application field after mapping and prior to writing the record.
If the field was not loaded during the mapping process, you may want to load a default
value. Literals, reserved words, and envelope values can be typed into this field to be
moved into the application field. SEE the “Glossary” for more information on reserved
words. If a field already has a value (loaded during the mapping process), the contents of
the Field Value will not overlay the value previously mapped.
This feature can be very useful for loading key fields into a file. It is also helpful in
loading information that may not be transmitted in the EDI document but needs to be
added to your files prior to interfacing to your application system.
At this point, if you are creating an inbound application definition, you are ready to begin
mapping. If you are creating an outbound application definition, please continue with the section
on the following page.
# NOTE
This section and the one that follows (Application Envelope Definition) apply to outbound
application definitions only – if you are creating an inbound application definition, skip these
sections.
The first step in defining the application partner reference is to access the Application Partner
Reference panel (EDIX559-FMT01). The application partner reference is only used for outbound
documents.
From the Work with Application Definition (EDIX550-FMT01) panel, type ‘13’ (App Part Ref) in
the Option field next to the desired Application ID and press Enter, as shown in Figure 5.32. The
action displays the Application Partner Reference panel (EDIX559-FMT01).
The application partner reference identifies a specific place in the application file Gentran:Server
looks for the partner who receives the data. The Application Partner Reference panel
(EDIX559-FMT01) allows you to specify the field name in the application header file that
contains the application partner reference.
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
Application Select
Field Name . . . . . . . . . . . .
To specify the field name that will be used as the application partner reference in this scenario (as
shown in Figure 5.33), complete the following instructions:
2. Press F10 (Update) and return to the Work with Application Definition panel
(EDIX550-FMT01).
# NOTE
If your partner is set up in the Partner file, add a partner cross reference to point this field (or
fields) back to the Partner ID as defined. If no field exists in the header for the partner, the
partner needs to be provided as a run-time parameter on the outbound processing command.
(SEE the “Partner” chapter for more information on cross references.)
Field Descriptions
Application Partner Reference Field Name
This application field identifies the partner that receives this data via EDI. Provide a value
that is known to Gentran:Server in the application definition (including the File identifier).
This field is used along with the Qual Field Name to look up the partner in the Partner file
or Partner Cross Reference file.
STOP CAUTION
This field MUST be alphanumeric and MUST exist in a Header record in your
application definition.
If your partner is not set up in the Partner file, add a partner cross reference to point this
field (or fields) back to the Partner ID as defined. If no field exists in the Header for the
partner, the partner needs to be provided as a run-time parameter on the outbound
processing command. (SEE the “Partner” chapter for more information on cross
references.)
In our example, the Vendor Number from the purchase order Header Record identifies our
partner.
1. To process the 980 Group Totals transaction with the 210 Motor Invoice
transaction.
2. To process the 850 Purchase Order transaction with the 860 Purchase Order
Change transaction.
One field would need to be defined as the Application Select field, whose contents would
identify which transaction map should be selected. If the 850 should be selected, the
selected field contains ‘O’ for original order. If the 860 should be selected, the field
contains ‘C’ for change order. These values for the Application Select field would be
defined on the Transaction ID.
# NOTE
This section applies to outbound application definitions only – if you are creating an inbound
application definition, skip this section.
The application envelope definition enables you to globally change an envelope value for all
partners for a particular application definition. For example, if you wanted to test an application
definition and indicate to all the partners who would receive the data processed that it is test data,
you could use this function to change the Sender ID to ‘TESTID” for all partners, rather than
change the Sender ID on each partner’s profile. The Sender ID from the partner profiles would be
overridden.
The first step is to access the Application Envelope Definition panel (EDIX560-FMT01).
Type ‘14’ (Envelopes) in the Option field next to the desired Application ID and press Enter. The
action displays the Application Envelope Definition panel (EDIX560-FMT01).
The Application Envelope Definition panel enables you to define the application data fields
containing envelope field data such as sender/receiver IDs, qualifiers, control number, security and
communications IDs, application reference information, priority codes and test indicators. Any
remaining envelope information not entered or not available on this panel will be obtained from
the Partner file.
STOP
CAUTION
While field names are verified by Gentran:Server, no verification is performed on the data
in the application data fields. It is the user’s responsibility to ensure that the data in the
application file is valid.
Application ID . . . . . . . . . . POFILE1
Send or Receive. . . . . . . . . . S
There are no mandatory fields for this panel. Type values in the fields you want to change and
press F10 (Update).
# NOTE
Do not specify any fields on the panel for this example.
Field Descriptions
Interchange Sender Id A 15-position alphanumeric field used to enter ISA06, BG03, UNB02
the application data field that identifies the (code or name), and
interchange sender. STX02 (code) elements
(Interchange Sender Id) A 15-position alphanumeric field used to enter ISA05, UNB02
Qual the application data field that identifies the (qualifier), and STX02
Interchange Sender Id Qualifier. (name) elements
Group Sender Id A 15-position alphanumeric field used to enter GS02 and UNG02 (code
the application data field that identifies the or name) elements
Group Sender ID.
(Group Sender Id) Qual A 15-position alphanumeric field used to enter UNG02 (qualifier)
the application data field that identifies the element
Group Sender Id Qualifier.
Interchange Receiver Id A 15-position alphanumeric field used to enter ISA08, BG04, UNB03
the application data field that identifies the (code or name), and
Interchange Receiver Id. STX03 (code) elements
(Interchange Receiver Id) A 15-position alphanumeric field used to enter ISA07, UNB03,
Qual the application data field that identifies the (qualifier), and STX03
Interchange Receiver Id Qualifier. (name) elements
Group Receiver Id A 15-position alphanumeric field used to enter GS03 and UNG03 (code
the application data field that identifies the or name) elements
Group Receiver Id.
(Group Receiver Id) Qual A 15-position alphanumeric field used to enter UNG03 (qualifier)
the application data field that identifies the element
Group Receiver Id Qualifier.
Interchange Control Num A 15-position alphanumeric field used to enter ISA13, BG07, UNG05,
the application data field that identifies the and STX05 elements
Interchange Control Number.
Group Control Num A 15-position alphanumeric field used to enter GS06 and UNG05
the application data field that identifies the elements
Group Control Number.
Transaction Control Num A 15-position alphanumeric field used to enter ST02 and UNH01
the application data field that identifies the
Transaction Control Number.
ISA/UNB Test Indicator A 15-position alphanumeric field used to enter ISA15 and UNB11
the application data field that identifies the elements
ISA/UNB Test Indicator.
UNB/STX Appl A 15-position alphanumeric field used to enter UNB07 and STX07
Reference the application data field that identifies the elements
UNB/STX application reference.
UNB/STX Priority Code A 15-position alphanumeric field used to enter UNB08 and STX08
the application data field that identifies the elements
UNB/STX Priority Code.
STX Recipient Trans Ref A 15-position alphanumeric field used to enter STX06 element
the application data field that identifies the
STX Recipient Transmission Reference.
UNH03 Common Access A 15-position alphanumeric field used to enter UNH03 element
Reference the application data field that identifies the
UNH03 Common Access Reference.
At this point, you have finished creating an outbound application definition. You are ready to
begin mapping.
Off-line Preparation
Before you begin using Gentran:Server to create an application definition, you may find it
beneficial to spend some time designing the format of your application files. Doing so will make it
much easier to complete the steps to create your application definition.
Analyze your application master files to determine which fields must be populated by your
partner’s EDI document.
To begin structuring your application definition, you must determine the files (for example,
Header and Detail) required to update your application master files. For this scenario, we will use
one Header and one Detail file to update the master files.
Define the contents of each physical file including the Field Name, Field Length, and Data Type
using Data Description Specifications (DDS). Then create a multi-format logical file over the
physical files using a DDS to identify the key fields that will be used to join the physical files.
Figure 5.36 shows the fields that will be needed to build the sample purchase order.
To define an Application ID for the sample purchase order, complete the following instructions:
2. Type ‘SEMPOEDI’ in the Appl(ication) ID field and ‘R’ in the S/R (Send/Receive) field
and press Enter. The name ‘SEMPOEDI’ is an example of an Application ID to use. You
may use any name you wish (i.e., your company’s initials).
Field Descriptions
Application ID
This field is the single identifier for your application definition under which all
information is stored. Name the application based on the type of document it is (i.e.,
‘SEMPOEDI’ for inbound purchase orders), rather than by the transaction set or partner.
Make the ID comprehensive enough to interface to various EDI formats including X12,
UCS, and EDIFACT.
Send or Receive
The value for this field is ‘S’ for send or ‘R’ for receive. An application definition must be
unique per direction. If you expect to send and receive purchase orders, two definitions are
required (one for each direction).
The Application Definition panel (EDIX552-FMT01) is where you specify the characteristics of a
particular application definition. This is also the panel where you identify the split and sub-split
file that will be read to create the application file. (SEE the “Splitting” chapter in the Technical
Reference Guide for a complete discussion of split files.)
Application ID . . . . . . . . . . SEMPOEDI
Send or Receive. . . . . . . . . . R
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . SEM CLASS: PO INB(subsplit #1)
Functional Groups. . . . . . . . . PO
File Type. . . . . . . . . . . . . L
EDI Split File . . . . . . . . . . 00001
EDI Sub-Split File . . . . . . . .
Record Type Start Position . . . .
Length . . . . . . . . . . . . . .
Application File . . . . . . . . . POLGL
Update Allowed . . . . . . . . . . Y
You must enter the information required for this panel: Description, Functional Groups,
Application File Type, EDI Split File (inbound only), EDI Sub-Split File (inbound only), and
Application File (name of your logical file).
STOP CAUTION
The logical file MUST exist and be found in your current library list in order to
continue. The record and field information is retrieved from this file.
1. Type the description of the application definition as shown on the above panel.
2. Type ‘PO’ (Functional Group ID for a purchase order) in the Functional Groups field.
Press F4 (Prompt) for a list of valid Functional Group IDs.
3. Type ‘L’ in the File Type field to indicate that the application file is a externally defined
multi-format logical file. Press F4 (Prompt) for a list of valid file types.
6. Press F10 (Update) to save the information you just entered and return to the “Work with
Application Definition” panel (EDIX550-FMT01).
Gentran:Server will use the multi-format logical file to retrieve the DDS and generate the file and
field definitions. The message “DDS has been generated for the Application Files and Fields”
displays at the bottom of the panel.
STOP
CAUTION
F18 (Re-retv. DDS) re-retrieves the DDS (file layout from the external logical file). The user
is prompted to confirm the re-retrieve function. Any changes made to the application
records/files, such as the Area Code, Description, Loop ID, and Max Use are preserved if the
physical file is still part of the logical file being re-retrieved. Any changes made to the
application fields, such as the Data Type or Field Value (inbound only), are preserved as long
as the field length and the DDS type have not changed. An exception report is produced and
should be reviewed. Additionally, upon exiting this panel after the DDS has been
re-retrieved, the APPSYNCH command is automatically submitted to re-synchronize all
maps linked to this application definition. The resynch report(s) should be reviewed.
Field Descriptions
Division Code
The Division Code is assigned from your security profile within Gentran:Server.
Description
This field is used to describe the application definition. Typically, the field includes the
type of document being sent. If desired, include the direction and type of files being used
(i.e., DDS).
Functional Groups
Up to five functional groups can be used with an application definition. You must supply a
valid Functional Group ID as defined by the EDI standards.
File Type
This field is one of the most important on this panel. It identifies what type of file you use
to interface to Gentran:Server for this particular application definition. The type of file
you use can be different from application to application.
Application File
This field identifies the name of the Multi-format logical file that interfaces to
Gentran:Server. It is a single logical file that you must create prior to processing. The
logical file must exist to create the application definition.
Update Allowed
Set this field to ‘Y’ to allow updates to be made to this definition. Once you begin testing,
you may want to change this to ‘N’ to prevent inadvertent updates to the definition.
Application Records/Files
The first step in defining the file for your application definition is to access the Application
Records/Files panel (EDIX553-CTL01).
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘11’ (Rec/Files) in the Option field next to the appropriate application and press Enter.
Access ‘SEMPOEDI’ for the sample purchase order you are creating in this scenario.
The next step is to modify the file information in the application definition.
Application ID . . . . . . . . . . SEMPOEDI
Send or Receive. . . . . . . . . . R
Description. . . . . . . . . . . . SEM CLASS: PO INB(subsplit #1)
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
Enter the information as shown on the above panel to define the purchase order Header and Detail
files for the sample purchase order.
Field Descriptions
Sequence Number
This field helps the user to list the files in the order in which the data is processed.
Gentran:Server automatically generates sequence numbers.
Record/File
This is the name for each of the physical files identified within the Logical file you
created. Gentran:Server retrieves these names.
Area
This is the area code that this file is assigned to based on the corresponding EDI standards
area codes. Press F4 (Prompt) for a list of valid area codes. There must be at least one
Header record. It is common to have at least one file per area, with the exception of the
summary.
Loop ID
This field is used to connect one or more application files with the multiple occurrence of
an EDI loop. In this example, the Detail file has one record read per iteration of the PO1
line item loop.
Max Use
This field identifies how many times in a row a record is written per iteration of the
corresponding loop or area. In this example, the purchase order Header file has a Max Use
of 1 and the Detail file has a Max Use of ‘1.’ This means that only one Header record is
written per PO and only one Detail record is written per iteration of a single line item loop.
In the case of an external logical file, Gentran:Server defaults all files to a value of ‘1.’
Mandatory Code
This code indicates whether the file is mandatory or optional (M or O, respectively).
Although it is required, it is informational only.
Write Flag
This field, with values of ‘Y’ (Yes) and ‘N’ (No), indicates whether the application record
is written, For outbound, this field has no meaning and Gentran:Server leaves the field
BLANK. For inbound, Gentran:Server defaults this value to ‘Y’ to indicate that the record
is written.
Description
A meaningful description is recommended. It indicates the kind of information in the file
and is very helpful for ongoing maintenance. In the case of logical file type,
Gentran:Server retrieves the text description from the physical file. The description can be
modified, if desired.
Application Fields
The first step in defining the application fields is to access the Application Fields panel
(EDIX554-CTL01).
Application ID . . . . . . . . . . SEMPOEDI
Send or Receive. . . . . . . . . . R
Description. . . . . . . . . . . . SEM CLASS: PO INB(subsplit #1)
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
Type ‘11’ (Fields) in the Option field next to the first file and press Enter. This displays the
Application Fields panel (EDIX554-CTL01).
Make modifications to the field definition for each file in the application. The fields retrieved from
the DDS display on the panel.
Application ID . . . . . . . . . . SEMPOEDI
Send or Receive. . . . . . . . . . R
Record/File Sequence Number. . . . 10
Description. . . . . . . . . . . . Training Class: PO Header
Record/File. . . . . . . . . . . . POHEADER
Review the field information retrieved and make any necessary modifications. Page Down to
review more fields. Press F17 (Next Rcd) to update this record and advance to the next file that
was retrieved and repeat this step. When finished, press F10 (Update).
Data types for Date fields should be changed to specific data types known to Gentran:Server to
allow the conversion of the date format
Since the purchase order date is stored in the YYYYMMDD format in our sample application and
a default value for Customer Number is required, we need to make the following changes:
1. Type ‘CY’ in the Type field for the PO Header file to convert the purchase order date to a
‘YYYYMMDD’ format.
2. Type the reserved word ‘SENDER-ID’ in the Field Value field next to the Customer
Number. This instructs Gentran:Server to use the resolved sender ID (the partner
cross-reference is used to locate the sender ID) as the default value to be mapped to the
Customer Number field. (SEE the “Glossary” for more information on reserved words.)
3. Press F17 (Next Rcd) to update the application fields and advance to the next file.
Field Descriptions
Sequence Number
This field is similar to the file Sequence number on the Application Records/Files panel. It
must be a unique number within the file.
The fields are retrieved in the order they exist in the file. They need to stay in this order.
When Gentran:Server retrieves the field information, it sequences them by increments of
five to allow for insertion of fields. If you re-retrieve the DDS, you can override the
incrementing number of ‘5’ and specify a smaller number, for example.
Field Name
The field contains the actual field name retrieved from the file but is prefixed by a unique
identifier for this file. This identifier always starts with ‘F’ for file and is tagged with the
Sequence Number, as shown at the top of the panel. A period is used between this file
identifier and the actual field name. This is the field name that is referenced for mapping
in Gentran:Server (including the period) to ensure uniqueness.
# NOTE
The field name MUST be unique across all files within an application definition. If a
field has the same name in more than one file, Gentran:Server requires the name to
be different. To ensure this rule, prefix each field with a unique identifier.
Type
This field is retrieved from the file and converted to valid data types for Gentran:Server.
Press F4 (Prompt) for a list of valid data types. This includes packed fields, signed fields,
and alphanumeric fields. Typically, it cannot automatically identify the format your date
fields are in, with the exception of ‘L’ and ‘Z’ application data types. These fields are
retrieved as signed or packed depending on how they were defined in your file.
Start
This field indicates the starting position in the file. It is retrieved from the file
automatically.
Length
This field identifies the physical length of the field in the file. The physical length is the
amount of space it takes up, not the actual exploded field length. For example, if you had a
packed date field that took up 4 bytes, but was actually 6 bytes when unpacked, the field
length is 4-bytes. Gentran:Server retrieves this information for you.
Mandatory Code
This code defaults to ‘M’ for all fields upon retrieval. This code indicates whether the field
is mandatory or optional (M or O, respectively). Only mark a field as mandatory when it
will always be on every occurrence of the record for which it is defined. For inbound,
mandatory fields will cause a warning message to be issued if no data is found to be
moved to the field.
Description
This description is retrieved from the DDS and may be modified to provide a more
meaningful description. The entire description is not always shown during the mapping
process.
) RECOMMENDATION
It may be helpful to have the most important part of the description, which
differentiates the field, at the beginning of the field.
Field Value
This value is not loaded by Gentran:Server when retrieving the DDS. This column must be
loaded by the user afterwards and is ONLY used for inbound. It is used to move a default
value into the application field after mapping and prior to writing the record. The default
values for the L date types, T time types, and Z date/time stamp are not required here. The
inbound mapper will force these values when necessary.
If the field was not loaded during the mapping process, you may want to load a default
value. Literals, reserved words, and envelope values can be typed into this field to be
moved into the application field. (SEE the “Glossary” for more information on reserved
words). If a field already has a value (loaded during the mapping process), the contents of
the Field Value will not overlay the value previously mapped.
This feature can be very useful for loading key fields into a file. It is also helpful in
loading information that may not be transmitted in the EDI document but needs to be
added to your files prior to interfacing to your application system.
In this scenario, Customer Number and PO Number are used to group the Header and Detail files
for a particular purchase order.
Application ID . . . . . . . . . . SEMPOEDI
Send or Receive. . . . . . . . . . R
Record/File Sequence Number. . . . 20
Description. . . . . . . . . . . . Training Class: PO Detail
Record/File. . . . . . . . . . . . PODETAIL
To ensure the values loaded into these fields are the same as the values loaded into the
corresponding fields in the Header file, make the following modifications:
1. Type ‘CY’ in the Type field to convert the purchase order date to a YYYYMMDD format
for the application.
2. Type the reserved word ‘SENDER-ID’ in the Field Value field next to Customer Number.
This instructs Gentran:Server to use the resolved sender ID as the default value to be
mapped to the Customer Number field.
3. Type the reserved word ‘CONSTANT-02’ in the Field Value field next to PO Date. This
instructs Gentran:Server to use the value stored in CONSTANT-02 as the default value to
be mapped to the PO Date field. Since the PO Date is not received in the Detail area, it
will be mapped to CONSTANT-02 in the Header area when you create the map.
4. Type ‘CONSTANT-01’ in the Field Value field next to PO Number. Since the PO
Number is not received in the Detail area, it will be loaded to CONSTANT-01 in the
Header area when you create the map.
At this point, if you are creating an inbound application definition, you are ready to begin
mapping. If you are creating an outbound application definition, please continue with the section
on the following page.
# NOTE
This section and the one that follows (Application Envelope Definition) apply to outbound
application definitions only – if you are creating an inbound application definition, skip these
sections.
If you are creating an outbound application definition, the first step in defining the application
partner reference is to access the Application Partner Reference panel (EDIX559-FMT01).
Type ‘13’ (App Part Ref) in the Option field next to the desired Application ID, and press Enter.
The action displays the Application Partner Reference panel (EDIX559-FMT01).
The application partner reference identifies a specific place in the application file Gentran:Server
looks for the partner who receives the data. The Application Partner Reference panel
(EDIX559-FMT01) allows you to specify the name of a field (or fields) in the application header
file that contains the application partner reference.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
Application Select
Field Name . . . . . . . . . . . .
Enter the Application Partner Reference field and press F10 (Update).
Field Descriptions
Application Partner Reference Field Name
This application field identifies the partner that receives this data via EDI. Provide a value
that is known to Gentran:Server in the application definition (including the File identifier).
This field is used along with the Qual Field Name to look up the partner in the Partner file
or Partner Cross Reference file.
STOP CAUTION
This field MUST be alphanumeric and must exist in a header file in your application
definition.
# NOTE
If your partner is set up in the Partner file, add a partner cross reference to point this field (or
fields) back to the Partner ID as defined. If no field exists in the header for the partner, the
partner needs to be provided as a run-time parameter on the outbound processing command.
(SEE the “Partner” chapter for more information on cross references.)
1. To process the 980 group totals transaction with the 210 Motor invoice
transaction.
2. To process the 850 purchase order transaction with the 860 purchase order change
transaction.
One field would need to be defined as the Application Select field, whose contents would
identify which transaction map should be selected. If the 850 should be selected, the
selected field contains ‘O’ for original order. If the 860 should be selected, the field
contains ‘C’ for change order. These values for the Application Select field would be
defined on the Transaction ID.
# NOTE
This section applies to outbound application definitions only – if you are creating an inbound
application definition, skip this section.
The application envelope definition enables you to globally change an envelope value for all
partners for a particular application definition. For example, if you wanted to test an application
definition and indicate to all the partners who would receive the data processed that it is test data,
you could use this function to change the Sender ID to ‘TESTID’ for all partners, rather than
change the Sender ID on each partner’s profile. The Sender ID from the partner profiles would be
overridden.
The first step is to access the Application Envelope Definition panel (EDIX560-FMT01).
Type ‘14’ (Envelopes) in the Option field next to the desired Application ID, and press Enter. The
action displays the Application Envelope Definition panel (EDIX560-FMT01).
The Application Envelope Definition panel enables you to define the application data fields
containing envelope field data such as sender/receiver IDs, qualifiers, control number, security and
communications IDs, application reference information, priority codes and test indicators. Any
remaining envelope information not entered or not available on this panel will be obtained from
the Partner file.
STOP
CAUTION
While field names are verified by Gentran:Server, no verification is performed on the data
in the application data fields. It is the user’s responsibility to ensure that the data in the
application file is valid.
Application ID . . . . . . . . . . INVOUTPEDI
Send or Receive. . . . . . . . . . S
# NOTE
Do not specify any fields on the panel for this example.
Field Descriptions
Interchange Sender Id A 15-position alphanumeric field used to enter ISA06, BG03, UNB02
the application data field that identifies the (code or name), and
interchange sender. STX02 (code) elements
(Interchange Sender Id) A 15-position alphanumeric field used to enter ISA05, UNB02
Qual the application data field that identifies the (qualifier), and STX02
Interchange Sender Id Qualifier. (name) elements
Group Sender Id A 15-position alphanumeric field used to enter GS02 and UNG02 (code
the application data field that identifies the or name) elements
Group Sender ID.
(Group Sender Id) Qual A 15-position alphanumeric field used to enter UNG02 (qualifier)
the application data field that identifies the element
Group Sender Id Qualifier.
Interchange Receiver Id A 15-position alphanumeric field used to enter ISA08, BG04, UNB03
the application data field that identifies the (code or name), and
Interchange Receiver Id. STX03 (code) elements
(Interchange Receiver Id) A 15-position alphanumeric field used to enter ISA07, UNB03,
Qual the application data field that identifies the (qualifier), and STX03
Interchange Receiver Id Qualifier. (name) elements
Group Receiver Id A 15-position alphanumeric field used to enter GS03 and UNG03 (code
the application data field that identifies the or name) elements
Group Receiver Id.
(Group Receiver Id) Qual A 15-position alphanumeric field used to enter UNG03 (qualifier)
the application data field that identifies the element
Group Receiver Id Qualifier.
Interchange Control Num A 15-position alphanumeric field used to enter ISA13, BG07, UNG05,
the application data field that identifies the and STX05 elements
Interchange Control Number.
Group Control Num A 15-position alphanumeric field used to enter GS06 and UNG05
the application data field that identifies the elements
Group Control Number.
Transaction Control Num A 15-position alphanumeric field used to enter ST02 and UNH01
the application data field that identifies the
Transaction Control Number.
ISA/UNB Test Indicator A 15-position alphanumeric field used to enter ISA15 and UNB11
the application data field that identifies the elements
ISA/UNB Test Indicator.
UNB/STX Appl A 15-position alphanumeric field used to enter UNB07 and STX07
Reference the application data field that identifies the elements
UNB/STX application reference.
UNB/STX Priority Code A 15-position alphanumeric field used to enter UNB08 and STX08
the application data field that identifies the elements
UNB/STX Priority Code.
STX Recipient Trans Ref A 15-position alphanumeric field used to enter STX06 element
the application data field that identifies the
STX Recipient Transmission Reference.
UNH03 Common Access A 15-position alphanumeric field used to enter UNH03 element
Reference the application data field that identifies the
UNH03 Common Access Reference.
At this point, you have finished creating an outbound application definition. You are ready to
begin mapping.
1. Type ‘3’ (Copy) in the Option field next to the Application ID you want to copy on the
Work with Application Definition panel (EDIX550-FMT01).
3. Type the name of the new Application ID and ‘S’ for Send or ‘R’ for Receive and press
Enter.
4. This action takes you to the Application Definition panel (EDIX552-FMT01) so you can
modify the description.
5. Press F10 (Update). This action creates a new application definition by copying the entire
definition from the existing Application ID.
STOP
CAUTION
The application definition you are creating must not already exist.
The following panel shows how to access the Copy Applications (APPCPY) panel.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘30’ (Copy App ID) in the Option field next to the Application ID you want to copy and press
Enter.
Next, Gentran:Server displays the Copy Applications (APPCPY) panel with the source Copy
From Application ID and Send/Receive indicator already defined. The system has also supplied a
default name of the library where the Copy From application definition ID resides.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
To define the information for the target application definition (Copy To), complete the following
instructions:
1. Type the Application ID name that you want this Application ID to have in your target
environment.
2. Type ‘S’ (Send) or ‘R’ (Receive), depending on the type of Application ID you are
copying.
3. Type the library name in which the Copy To Application ID will reside.
5. At this point, you can run the copy job one of three ways: type ‘*YES’ to use the Job
Scheduler feature; press Enter to immediately submit the job to your queue to run; or
press F10 (Additional parameters) and type ‘*YES’ for Run Interactively to run the copy
job on your screen.
STOP
CAUTION
The Copy To Application ID cannot already exist in the Copy To library.
The first step in renumbering the application is to access the APPRENBR panel, as shown below.
Type ‘31’ (App Renumber) in the Option field next to the Application ID you want to renumber
and press Enter.
# NOTE
After the application renumber has completed, the Application Synchronization
(APPSYNCH) must be executed to bring the transactions into agreement with the
application.
The following panel allows you to specify the parameters to renumber the application records and
fields.
Bottom
At this point, you can run the application renumber job one of three ways:
Interactively: Press F10 for additional parameters and type *YES for Run Interactively.
Job Scheduler: Type *YES in the Schedule Job field to run the job at a later time.
The system automatically invokes the command after re-retrieving the DDS. You can manually
invoke the APPSYNCH command if you make changes without re-retrieving the DDS.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘32’ (App Synch) in the Opt field next to the appropriate Application and press Enter. The
APPSYNCH panel displays.
The following panel is used to re-synchronize all maps linked to the selected application. A map is
linked to an application using the Transaction Map Definition (EDIX503) panel.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
Type the desired parameter options and press Enter. A report (EBDI586) prints, identifying the
linked maps. Then, the MAPSYNCH report (EBDI589) is printed for the re-synchronization of
those maps.
# NOTE
The Application Synchronization is executed automatically when you re-retrieve the DDS for
a file using the Application Definition panel (EDIX552) or Application Records/Files panel
(EDIX553).
The first step in printing an application definition is to access the Print Application Files
(PRTAPP) panel.
Type option ‘6’ (Print) next to the application and press Enter. The Print Application Files
(PRTAPP) panel displays.
The Print Application Files (PRTAPP) panel allows you to print information about the files,
records, and fields for a specific application document. You can specify an inbound or outbound
application for printing.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
At this point, you can run the job one of three ways:
Interactively: Press F10 for additional parameters and type *YES for Run Interactively.
Job Scheduler: Type *YES in the Schedule Job field to run the job at a later time.
To re-retrieve the DDS for the changed file, select *UPDATE on the LISTUPD parm. An
exception report (EDIX558) is printed and the APPSYNCH command is invoked to resynchronize
the associated maps.
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More Keys
STOP
CAUTION
After you type the ezEDI or ezAPPDEF command, the system proceeds forward only
through all associated panels. You cannot interrupt the process or back up to previous panels.
Be sure to collect all your materials and allow sufficient time before you initiate an ezEDI
command.
The ezAPPDEF command leads you through the panels which are key to setting up application
definitions. After global parameters are defined, Gentran:Server requires that you define the
organization of your data files for each application. If your application involves sending invoices,
for example, the application definition must identify all the files in your system which must be
included on the invoice – a Header and Detail file, perhaps – as well as the specific requirements
for each file and field.
Type ‘50’ (ezAPPDEF) on the key entry line, as shown in Figure 5.57, and press Enter.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
The panel shown in Figure 5.58 displays, followed by the panels listed in the flowchart in Figure
5.59.
The ezAPPDEF command is a tool to help you define the application definition
that will be used in conjunction with the map definition. This identifies
the layout of the application file(s) that will be used during translation
with the EDI format. For example, if you are sending invoices electronically,
the Application Definition needs to identify all the files and fields
that will be used to generate the invoice, such as the invoice header and
detail line item file.
The ezAPPDEF command steps you through the panels which are essential for
defining the application definition. This includes the Application ID,
files/records, and fields panels.
F3=Exit
Figure 5.59 lists the rest of the ezAPPDEF panels and the order in which they display.
Application Definition
(EDIX552-FMT00)
See Task:
Create an Outbound Appl Def
Application Definition
(EDIX552-FMT01)
See Task:
Create an Outbound Appl Def
Application Definition
(EDIX553-CTL01)
See Task:
Create an Outbound Appl Def
Application Fields
(EDIX554-CTL01)
Option ‘11’ See Task:
(Rec/Files) Create an Outbound Appl Def
Figure 5.59 Panels the system leads you through for the ezAPPDEF command
Reports
EBDI054 – Application Definition Report
Special Considerations
Like all other Gentran:Server reports, the Application Definition report automatically goes to the
iSeries Output Queue defined for the user running the job. (SEE the “Environment Control”
chapter in this guide to set up a user’s Output Queue.)
Report Header
Record Type Start/Length Starting position in the application record for the
record type and the length of the record type
STX Recipient Trans Ref Identifies the STX recipient transmission reference
UNH03 Common Access Reference Identifies the UNH03 common access reference
The report is system-generated when the user re-retrieves the DDS (file layout for an externally
described file) for any file in a selected application definition. This is done using option ‘12’
(Re-retrieve DDS) on the Application Records/Files panel (EDIX553) or by using F18 (Re-rtv.
DDS) on the Application Definition panel (EDIX552-FMT01). Upon exiting the panel, the
APPSYNCH command is automatically submitted and a report is generated.
Sterling Commerce
Field Description
Time This field shows the time the report was processed, shown in
hh:mm:ss format.
Date The date the report was processed, shown in the user’s format,
is provided in this field.
Map Name This field provides the Transaction Map ID that is linked to the
selected application definition.
Tran ID The field lists the Transaction (or Message) Set ID for the
standards used in the map (e.g., ‘850’ identifies a purchase
order transaction).
Special Considerations
Like all other Gentran:Server reports, the Application DDS Re-retrieve Exception Report
automatically goes to the iSeries Output Queue defined for the user running the job. (SEE the
“Environment Control” chapter for instructions to set up a user’s Output Queue.)
SEQ SEQ FIELD NAME GEN DDS LEN START C FIELD VALUE
NEW 010 005 F010.FILEINDEX AN A 12 1 M FILEINDEX
OLD 010 005 F010.FILEINDEX AN 12 1 M File Index *DDS TYPE CHANGE
NEW 010 010 F010.WHSNO AN A 1 13 M WHSNO
OLD 010 010 F010.WHSNO AN 1 13 M Warehouse Number *DDS TYPE CHANGE
NEW 010 015 F010.SUPPLIER AN A 13 14 M SUPPLIER
OLD 010 015 F010.SUPPLIER AN 3 14 M Supplier *DDS TYPE CHANGE
NEW 010 020 F010.NAME AN A 35 27 M NAME
OLD 010 020 F010.NAME AN 35 27 M Name *DDS TYPE CHANGE
NEW 010 025 F010.GENNO S0 S 4 62 M GENNO
OLD 010 025 F010.GENNO S0 4 62 M Generation Number *DDS TYPE CHANGE
TOTAL FIELDS PROCESSED:
NEW --- 5
OLD --- 5
NUMBER OF EXCEPTIONS: 5
Sterling Commerce
Field Description
Report Header
Application ID Application ID
Send or Receive Code that identifies whether the application definition is a send
file (S) or a receiving file (R)
Field Value Application field value (valid only for inbound definitions)
Total Records Processed This field prints only if an entire logical file was re-retrieved.
New: Total number of new application records processed
Old: Total number of old application records processed
Number of Exceptions: Total number of exceptions encountered
during the re-retrieval of DDS. Record exceptions occur only
when new records are added or old records are deleted
Field Description
Note: This part of the report prints only for outbound definitions and only when an exception
occurred updating the information specified in the report header.
Reason Displays either a warning message that the field no longer exists
or that the field could not be updated due to a record lock
PARAMETER RECORD:
APPLICATION ID: SEMPOEDI R
STARTING REC SEQ: 050
INCREMENT: 005
STARTING FLD SEQ: 050
INCREMENT: 005
RESTART: N
THE FOLLOWING TRANSACTIONS MUST BE RUN THROUGH THE RE-SYNCH PROGRAM --> EBDI589:
ANSI2040PO R
ANSI2040P1 R
ANSI3010PO R
ANSI3020P1 R
FINAL TOTALS:
APPLICATION RECORDS READ: 3
(successful completion)
APPLICATION FIELDS READ: 31
TEMPORARY RECORDS WRITTEN: 3
TEMPORARY FIELDS WRITTEN: 31
APPLICATION RECORDS DELETED: 3
APPLICATION FIELDS DELETED: 31
NEW APPLICATION RECORDS WRITTEN: 3
NEW APPLICATION FIELDS WRITTEN: 31
PARTNER REFERENCE FIELDS READ: 1
PARTNER REFERENCE FIELDS UPDATED: 1
ENVELOPE STRUCTURE FIELDS READ: 0
ENVELOPE STRUCTURE FIELDS UPDATED: 0
Field Description
Parameter Record
Starting Rec Seq This field identifies the sequence number of the record (the
order of the record within the document) that sequencing
begins with.
Increment This field identifies the number that the program uses to
increment the record sequence number.
Starting Field Seq This field identifies the sequence number of the field (the order
of the field within the record) that sequencing begins with.
Increment This field identifies the number that the program uses to
increment the field sequence number.
Restart This field displays the switch entered in the parameter record
indicating whether or not to restart the application when
processing is complete (‘Y’ = Yes, ‘N’ = No). If nothing or
garbage is entered in the restart switch in the parameter record,
the default is ‘N.’
The Following Transactions This field identifies the Transaction ID(s) of the transactions
Must Be Run Through the that must be processed through the Batch Transaction Mapping
Re-Synch Program —> Definition Re-Synch program (program EBDI589).
EBDI589:
Final Totals
Application Records Read This field displays the total number of application records read
during execution of the program.
Application Fields Read This field displays the total number of application fields read
during execution of the program.
Temporary Records Written This field displays the total number of records written to the
temporary file during execution of the program.
Temporary Fields Written This field displays the total number of fields written to the
temporary file during execution of the program.
Application Records Deleted This field displays the total number of application records
deleted during execution of the program.
Field Description
Application Fields Deleted This field displays the total number of application fields
deleted during execution of the program.
New Application Records This field displays the total number of new application records
Written written during execution of the program.
New Application Fields This field displays the total number of new application fields
Written written during execution of the program.
Partner Reference Fields This field displays the total number of application partner
Read reference fields read.
Partner Reference Fields This field displays the total number of application partner
Updated reference fields updated. If the record and field sequence have
not changed, this number will be ‘0’.
Envelope Structure Fields This field displays the total number of envelope structure fields
Read read. If there are no envelope mappings defined for the
application, this number will be ‘0’.
Envelope Structure Fields This field displays the total number of envelope structure fields
Updated updated. If the number read was not zero, these fields will be
updated if the record or field sequence has changed.
Special Considerations
Like all other Gentran:Server reports, the Print Re-retrieve through RRTVDDS Command
automatically goes to the Output Queue defined for the user running the job. (SEE the
“Environment Control” chapter for instructions to set up a user's Output Queue.)
Field Description
Application ID Application ID
Common Questions
What are the Max Use and Loop ID fields used for?
The Max Use and Loop ID are used to align the application records to the Segments from the
transaction side. Review the transaction set being sent or received prior to setting the values on the
application records to see how the data loops are formatted. If you are unsure of what to load when
setting up the application definition initially, type ‘1’ for Max Use and leave the Loop ID BLANK.
These can be updated later, after you have determined how the records are linked to the Segments.
The Max Use identifies how many times the application record is read or written per iteration
(occurrence) of the corresponding loop or area from the transaction side. The Loop ID ties
multiple records together that go with a loop that occurs multiple times on the transaction side. The
Loop ID also ties multiple Segments together with a particular record on the application side that
occurs multiple times.
If you pass a file to Gentran:Server for outbound processing, how is Gentran:Server supposed to
know which partner it should be sent to? There are only two ways for Gentran:Server to determine
who that partner is:
1. Identify the partner on the Outbound Processing Command (PRCTRNOUT) under the
parameters, RECEIVER ID and RECEIVER ID QUAL. There is a problem with this
method because ALL the data in the file is sent to the partner.
2. Use the application partner reference on the application data ID to identify the field that
Gentran:Server looks at to determine the partner. The contents of that field is used to
resolve the partner. This allows the file to contain data for multiple partners. This is the
normal method chosen.
If you are using externally described files (physical or multi-format logical), you can retrieve the
DDS again into the application definition in Gentran:Server. If you have made any modifications
to the fields after the files were retrieved (such as changing the data type for dates so that the
conversion takes place automatically or field values for the inbound definition), those changes are
retained as long as both the DDS type and the field length have not changed. If either have
changed, then modifications made to the old definition are not applied to the new field. A report is
printed automatically when using the re-retrieve function that lists any exceptions that occurred
(new fields added, old fields dropped, or changes to existing fields).
The re-retrieve DDS function also updates the Application Partner Reference, Envelope
Definitions, and Key Structure automatically with the new location of the same fields. If a field no
longer exists, part two of the report lists these exceptions.
Use the Application Synchronization (APPSYNCH) command to resynch all maps linked to the
application.
Application ID . . . . . . . . . . SEMPOEDI
Send or Receive. . . . . . . . . . R
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . SEM CLASS: PO INB(subsplit #1)
Functional Groups. . . . . . . . . PO
File Type. . . . . . . . . . . . . L
EDI Split File . . . . . . . . . . 00001
EDI Sub-Split File . . . . . . . . 1
Record Type Start Position . . . .
Length . . . . . . . . . . . . . .
Application File . . . . . . . . . POLGL
Update Allowed . . . . . . . . . . Y
Press F18 a second time to confirm that you want to overlay the current DDS and generate a new
DDS. A completion message displays after the DDS has been retrieved.
# NOTE
An exception report is automatically generated and should be reviewed.
If the DDS was retrieved, the APPSYNCH command is automatically submitted upon exiting the
panel and a message displays. This re-synchronizes all linked maps.
Application ID . . . . . . . . . . INVOUTP
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . Invoice Outbound (Phys file)
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
A message displays indicating that the DDS was re-retrieved for the file along with the
incrementor number used to sequence the fields.
# NOTE
An exception report is automatically generated and should be reviewed.
If the DDS was retrieved, the APPSYNCH command is automatically submitted upon exiting the
panel and a message displays. This re-synchronizes all linked maps.
Processing the 980 Group Totals transaction with the 210 Motor Invoice transaction.
Processing the 850 Purchase Order transaction with the 860 Purchase Order Change
transaction.
One field needs to be defined as the Application Select field. The contents of this field identify
which transaction map is desired. For example, if the purchase order application definition is being
processed, the field to select the 850 transaction map may contain ‘O’ for an original order, while
the field to select the 860 transaction map may contain ‘C’ for a change order. These values for the
Application Select field need to be defined on the Transaction ID as well.
The following steps illustrate the setup of the Application Select feature for the 210 Freight
Invoice and the 980 Group Totals. They are both tied to the Application Data ID, FRTINVOUT,
for outbound Freight Invoices.
STOP
CAUTION
Application Select can only be used for outbound processing.
Bottom
Parameters or command
===>
F1=Help F12=Cancel F9=Retrieve F15=Sort F23=More Options F24=More Keys
Type ‘11’ (Rec/Files) next to the Application ID to be revised for the Application Select feature
and press Enter.
Application ID . . . . . . . . . . FRTINVOUT
Send or Receive. . . . . . . . . . S
Description. . . . . . . . . . . . FREIGHT INV OUTBOUND (210/980)
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
Type ‘11’ (Fields) next to the Header Record/File field and press Enter.
Application ID . . . . . . . . . . FRTINVOUT
Send or Receive. . . . . . . . . . S
Record/File Sequence Number. . . . 010
Description. . . . . . . . . . . . INV HEADER RECORD
Record/File. . . . . . . . . . . . 001
Change the data type of the field used to determine the map selection. Here, the field
‘001-TRANS-SET’ contains the transaction set of ‘210’ or ‘980.’ It is defined with a data type of
‘AS’ for Application Select. Only one field can be defined for this feature. When finished, press
F10 (Update).
# NOTE
You can only define a field as an Application Select field in the Header Record or File.
Step 2: Display the Application Partner Reference to verify the Application Select Field
Application ID . . . . . . . . . . FRTINVOUT
Send or Receive. . . . . . . . . . S
Application Select
Field Name . . . . . . . . . . . . 001-TRANS-SET
Verify the field displayed for Application Select. Remember, this field is protected and is only
displayed if a field was defined with a data type of ‘AS.’ The Application Select feature is only
valid for outbound. The Application Select field must be in a Header Record/File.
Step 3: Tie the Application Select Values to the first Transaction Map
Transaction ID . . . . . . . . . . 210SM2/8
Send or Receive. . . . . . . . . . S
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . OUTBOUND 210 M2/8 (APP.SELECT)
Standards Version. . . . . . . . . M2/8
Transaction Set. . . . . . . . . . 210
Transaction Set Release. . . . . . 0
Transaction Status . . . . . . . . T
Use Code . . . . . . . . . . . . . G
Envelope Type. . . . . . . . . . . U
Application ID . . . . . . . . . . FRTINVOUT
Application Selection Field Values 210 210 210
210 210 210
Update Allowed . . . . . . . . . . Y
There are maps for two transaction sets that need to be updated with Application Select Values of
210 and 980. The field defined as the Application Select field contains the value ‘210’ when the
map for the Freight invoice is selected. Type this value in the Application Select field. You may
have up to six different values defined to select this map. If not using all six fields, duplicate the
‘210’ value in each slot since a BLANK value is valid for Application Select.
STOP
CAUTION
Application Select values cannot be entered unless the Application Data ID that this
Transaction ID is tied to has a field already defined as Application Select.
Step 4: Tie the Application Select Values to the next Transaction Map
Transaction ID . . . . . . . . . . 980SM2/8
Send or Receive. . . . . . . . . . S
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . OUTBOUND 980 M2/8 (APP.SELECT)
Standards Version. . . . . . . . . M2/8
Transaction Set. . . . . . . . . . 980
Transaction Set Release. . . . . . 0
Transaction Status . . . . . . . . T
Use Code . . . . . . . . . . . . . G
Envelope Type. . . . . . . . . . . U
Application ID . . . . . . . . . . FRTINVOUT
Application Selection Field Values 980 980 980
980 980 980
Update Allowed . . . . . . . . . . Y
The field defined as the Application Select field contains the value '980' when the map for the
Group Totals is selected. Type this value in the Application Select field. You may have up to six
different values defined to select this map. If not using all six fields, duplicate the ‘980’ value in
each slot since a BLANK value is valid for Application Select.
Where does Gentran:Server get the Default values for the ‘L’
date type, ‘T’ time types, and ‘Z’ date/time stamp?
For an application field value of ‘L’, ‘T’, or ‘Z,’ IBM forces a specific default value for each
format. It is not possible to write an application record with spaces or zeros in those date/time
fields. For inbound applications, the field values have to be in the specified format or a file error
will occur when trying to write the application record. The appropriate default value is forced in
the inbound mapper when a valid value is not mapped to these fields. The default values for each
type are shown in this table.
DDS Data Default Value (for inbound Gentran Data Type When
Format
Type applications) Retrieved by DDS
L *ISO or 0001-01-01 L
*JIS
L *USA 01/01/0001 LU
L *EUR 01.01.0001 LE
T *HMS 00:00:00 TI
*JIS
T *ISO 00.00.00 TE
*EUR
T *USA 00:00 AM TU
T With 00 00 00 TB
*HMS
Timsep
(‘ ‘)
6 Transaction Mapping
In this Chapter
This chapter explains what a transaction map is and where it is used within Gentran:Server.
Step-by-step procedures are provided to assist you in creating an outbound and an inbound map.
As examples, an invoice was selected for the outbound map and a purchase order for the inbound
map. The chapter covers the following topics:
¾ Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6-174
The map is then used to create a link with the application definition. The link is established by
identifying how the transaction elements are related to the application fields.
Create, modify, delete, view, and copy Translation and Validation Tables
EDIX500-FMT01 Create, revise, copy, delete, Select option ‘2’ on the GENMAP
view, or print transaction maps menu
Work with
Transaction Mapping Type ‘EXCPGM EDIX500’ on the
command line
EDIX513 Work with application fields, Select option ‘1’ (Create), ‘2’
extended mapping, subfields, (Revise), ‘5’ (View) on panel
Extended Inbound and codes for an element map EDIX506-FMT01 (you must be
Mapping working with an inbound map)
EDIX351-FMT01 Work with sub-split files Select option ‘1’ (Create), ‘2’
(Revise), or ‘5’ (View) on panel
Sub-Split Table EDIX350-FMT01
PRTMAP Print a transaction map file Select option ‘6’ (Print) on panel
EDIX500-FMT01
Print Mapping Files
Type ‘PRTMAP’ on the command
line
Select option ‘11’ on the
GENMAP menu
CEDCPY Copy codes and data from a Select option ‘30’ on panel
Table ID EDIX580-FMT01
Copy Code and Data
Type ‘CEDCPY’ on the command
line
PRTTRNTBL Print a translation table file Select option ‘6’ (Print) on panel
EDIX580-FMT01
Print translation
tables Type ‘PRTTRNTBL’ on the
command line
Select option ‘12’ on the
GENMAP menu
Overview
This section explains how to use the Transaction Mapping panels through the following tasks:
While the scenarios define specific maps and tables, they are based on common steps taken to
define any map or table. Use these tasks as a guide to set up your own maps and tables.
Select option ‘2’ from the GENMAP menu to access the Work with Transaction Mapping panel.
Parameters or command
===>
F1=Help F6=More/Less F12=Cancel F15=Sort F23=More Options F24=More Keys
View Additional Fields from the Work with Transaction Mapping Panel
Press F6 (More/Less) from the Work with Transaction Mapping panel to view the subfile with an
additional row of information.
Parameters or command
===>
F1=Help F6=More/Less F12=Cancel F15=Sort F23=More Options F24=More Keys
The Work with Transaction Mapping panel (EDIX500-FMT01) provides you with the option for
creating a new Transaction ID. Typically, most users choose a name that identifies the transaction,
version, and partner-specific code. The name you choose must be unique.
3. Type ‘S’ in the S/R (Send/Receive) field to indicate that this map will be used to send data
to your trading partner and press Enter. This action displays the Transaction Map
Definition panel (EDIX503-FMT01).
Field Descriptions
Transaction ID
This field contains the single identifier under which all the connections between the EDI
format and the application format are stored. It is also referred to as the map name. This is
the primary key when identifying a map.
Send or Receive
This field identifies whether the map will be used to translate inbound or outbound data.
The values are ‘S’ for send or ‘R’ for receive. It is the secondary key when identifying a
map.
The Transaction Map Definition panel (EDIX503-FMT01) is where you specify the characteristics
of your Transaction ID.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . Outbound Invoice 004010 (demo)
Standards Version. . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction Set Release. . . . . . 0
Transaction Status . . . . . . . . T
Use Code . . . . . . . . . . . . . P
Envelope Type. . . . . . . . . . . X
Application ID . . . . . . . . . . INVOUTPEDI
Application Selection Field Values
Update Allowed . . . . . . . . . . Y
To define the map associated with the sample invoice, complete the following instructions:
1. Type the information as shown on the panel for the following fields:
Description
Standards Version
Transaction Status
Use Code
Envelope Type
Application ID
# NOTE
Press F4 (Prompt) on each of the fields (except Description and Update Allowed) to
select or see your available options. If you are unsure about what any field means or
what kind of information you must enter, move the cursor into the field and press F1
(Help).
2. Make sure the Update Allowed flag is set to ‘Y’ and press F10 (Update) to update the
panel. This action displays the ‘Work with Transaction Mapping’ panel
(EDIX500-FMT01) and displays the message “Create Operation Successful’” at the
bottom of the panel.
Field Descriptions
Division
The division code is defaulted from your Gentran:Server user profile, which is defined in
the Environmental Control subsystem. The division code is used to limit the information a
user can see online or modify. The ‘000’ division code is a Global division code that
allows you to modify any map, regardless of the specific division it was assigned.
Description
This field is used to provide a description of the map. It displays on the Work with
Transaction Mapping panel (EDIX500-FMT01) and it can be used to help differentiate
maps.
Standards Version
This field reflects the full version code as known in the standards. (SEE the “Standards”
chapter for more information on available versions.) If you are using an X12 version,
supply the leading zeros. Remember to tag the subset code with the version you are using
(if necessary), such as 004010VICS. SEE the Standards Maintenance subsystem within
online Gentran:Server if you are unsure of the version.
Transaction Set/Release
This field is the actual Transaction Set ID for the document being sent in the EDI format.
The value is specific to the standards and can be found in a standards manual, in
Gentran:Server Standards Maintenance subsystem, or from your trading partner. The
Release code is only needed if the version is for TRADACOMS. The default is ‘0.’
Transaction Status
This field indicates the status of this map. It is used in conjunction with the status of the
partner’s transaction record to determine the value of the Test/Production flag in the
ISA15 element. If the status is ‘P’ (Production) and the status of the trading partner’s
record for the transaction is ‘P,’ the value in the ISA15 element will be ‘P.’ Both statuses
must be a ‘P.” Otherwise, the ISA15 element will contain a ‘T’ (Test).
Use Code
This flag identifies whether the map is for general purpose or for specific trading partners.
There should only be one map classified as ‘G’ (General) for a particular
transaction-version combination. When processing, the first general-type map for the
requested version is selected. Any additional maps for the same version and transaction
are ignored. General maps are typically comprehensive and include the largest subset of
segments that any partner can send.
Partner-specific maps are useful when the EDI format for a particular partner is different
than the format used by most of your partners. It is common to have partner-specific maps
for outbound documents. Most partners request specific segments or want some segments
omitted. It is simpler to make a copy of the general map and modify it for a partner. It is
fairly common to use one general map for many partners for Inbound documents.
Envelope Type
This flag identifies the type of envelope or standards being used for this map. The flag
corresponds to the transaction set. For example, the 810 transaction is an X12 invoice, so
the type is set to ‘X.’
Application ID
This field contains the name of the Application ID that this map is tied to. In “Mapping
Getting Started,” there is a Bicycle Wheel diagram that shows the relationship between
transactions and the Application ID. This field is where that connection is made. In this
example, the map is tied to the Application ID ‘INVOUTPEDI,’ which was set up in the
“Application Definition” chapter.
Update Allowed
Specify ‘Y’ (Yes) to allow updates to be made to this map while you develop and test it.
When you move this map into production, you may want to set this flag to 'N’ (No) to
prevent modifications from being made without the proper authority.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘12’ (Copy Segments) in the Option field next to the Transaction ID you just created and
press Enter. The Copy Segments from Standard panel (EDIX502-CTL01) displays, allowing you
to select the segments to be copied.
The Copy Segments from Standard panel (EDIX502-CTL01) displays all the segments contained
in the specified transaction set and standards version. It allows you to choose the EDI segments
you will need for your map.
This list is an example of segments that could be requested by your partner and will be used for
this example.
H BIG
H NTE
H REF
H N1 1000
H N3 1000
H N4 1000
H DTM
D IT1 6000
D PID 6100
S TDS
S CTT
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Quite often, the segments that need to be included in your map are requested by your trading
partner. The previous table lists the segments that are required for this sample invoice map. This
list corresponds with the “Reference Table – Contents of the X12 Invoice” table in the “Mapping
Getting Started” chapter.
To copy the segments into your map, complete the following instructions:
1. Type ‘3’ (Copy) in the Option field next to each segment as shown on the following
panels. Press Page Up/Page Down to select additional segments to be copied.
# NOTE
If you are modifying a map, the segments that are already included are highlighted.
They also are protected to prevent duplicate segments from being copied. All
mandatory segments will have a ‘3’ already in the Option field.
2. When you have finished selecting the segments, press Enter or F10 (Update) to copy
them into your map. This action returns you to the Work with Transaction Mapping panel
(EDIX500-FMT01).
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Bottom
F1=Help F10=Update F12=Cancel F13=Services
Press Enter to copy segments and remain on this panel or F10 to copy segments and exit.
The next step is to access the Transaction Map Segments panel (EDIX504-CTL01) to review the
copied segments.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Update Operation Successful.
Type ‘11’ (Segments) in the Option field next to the new Transaction ID and press Enter. This
action displays the Transaction Map Segments panels (EDIX504-CTL01) with the segments you
copied in the previous step.
Compare the copied segments against the segments in the “List of Segments Requested by
Partner” table to verify that all the segments were copied.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
Press Page Up/Page Down to review all the segments. If extra segments were copied by accident,
use option ‘4’ to delete the segments. If a segment is missing, press F13 (Services) to branch to the
Copy Segments from Standard panel (EDIX502-CTL01) and copy the segment.
Step 7: Align the segments in the Map with the Application Records
Aligning segments with the application files or records consists of a three-step procedure:
modifying segment information, copying segments for manual loops, and modifying segment
information for the copied segments.
“Aligning” the segments means that the segments and loops must match the record structure in the
application definition to which this map is tied.
How does Gentran:Server know when to generate multiple occurrences of segments and loops?
Gentran:Server looks at the Max Use and the Loop ID fields to get more than one segment or
group of segments generated. If the value in the Max Use field is greater than ‘1,’ Gentran attempts
to generate another occurrence of the same segment. If a group of segments needs to be generated
more than one time, a loop ID may be entered with a Max Loop value.
The application format that is used to interface with the EDI format must be considered. Each
company may have different numbers of records and record structures that interface with the same
EDI format. There is no “one way” to perform the alignment. Below is an abstract example that
compares looping with the wheels of a car.
Think of the application record as the left wheel on a car, the transaction segment or loop as the
right wheel on a car, and the Loop ID as the axle between the two wheels. The axle keeps both
wheels turning in sync so the car can move forward. Likewise, if a record is read on the application
side, a segment or a loop needs to be written on the EDI side to keep both in sync.
For the detail line items, one record is read and one line item loop is written. To get more
occurrences, both the record and the loop are tied together with a Loop ID. This way they stay in
sync and can continue to be read and written until there is no more information.
If a situation exists where one record is read and more than one segment or loop needs to be
written, manual looping needs to be used instead of a Loop ID. In this case, only one crank of the
wheel occurs on the application side so the transaction side needs to be modified to have only one
crank of the wheel. To do this, the Max Loop values and the Loop IDs must be removed from the
segments. The segments then must be manually copied to occur again. It makes no difference to
the trading partner how the multiple occurrences of the segments and loops are created, only that
they are present and in the correct order.
In this example, manual looping is needed for the header area. There needs to be multiple
occurrences of segments and loops in the EDI format, even though all the data for the looping is
coming from one single application record.
The following table illustrates how the records need to be aligned with the segments. Each record
is listed with the associated segments it produces. It contains the correct settings for the Max Use
and Loop ID fields for the application and transaction definition. (SEE the “Designing an
Outbound Transaction Map – Segment Level” section in this chapter for more information about
Max Use and Loop ID fields.) Comments are provided to explain the modifications needed for the
segments in the sample map.
STOP
CAUTION
You cannot have any mismatching Loop IDs for outbound documents. That is, there cannot
be a Loop ID on the transaction side that is not on the application side and vice versa. If Loop
IDs are mismatched, processing is terminated immediately with an error message.
N4 * H 1 remove loop ID
The next several steps show how to change and copy segment information to properly align the
segments. If you skip these steps, the segments might not be written or not written as many times
as expected during translation.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
To align the segments in this sample invoice map, complete the following instructions:
1. Change the Max Use for NTE to be 10 (no more than 10 segments based on the
application record’s Max Use).
5. Change the descriptions to denote specific information such as the Department Number
for the REF and Billto Name for the N1. This helps in the element mapping procedure as
well as in maintaining the map in the future.
6. Change the Max Use for N3 to be 1. Press Page Down to display the next panel.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
8. Change the Loop ID for PID to 6000 with no Max Loop and Max Use to 1.
The next step in aligning the segments is to create manual loops by copying existing segments. In
this example, the segments in the N1 loop from the Billto loop need to be copied to create two
more occurrences for the Shipto and Remit-to name loops. The N1 loop for the Billto information
is at segment sequence 700 through 1000. The next segment sequence occurs at 1500. This allows
another N1 segment to be copied somewhere between sequence 1000 and 1500, say 1010.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
To create manual loops for the sample invoice, complete the following instructions:
1. Select the first segment to be copied (in this example it is the N1 segment at sequence 700)
using Option ‘3’ and press Enter. This action displays the Copy To window.
2. Type ‘1010’ on the blank line in the window and press Enter. This action redisplays the
panel showing the copied segment ID ‘1010.’ (You may have to page down to view the
copied segment.)
3. Repeat the same instructions to copy segment ID N1 to 1020, N3 to 1030, and N4 to 1040.
You can perform multiple copies by typing ‘3’ next to all the segments to be copied.
In order to generate the TDS segment in the summary section, we have to sum the extended line
item dollar amounts. This can be accomplished by using a dummy segment. Dummy segments are
not written out during processing and are often used to load constants, hash-totals, and
accumulators.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
Copy To p
4350
F3=Exit F12=Cancel W
F
Y
Y
3 8000 S TDS M 1 TOTAL MONETARY VALUE SUMMAR Y
8800 S CTT O 1 TRANSACTION TOTALS Y
More...
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
1. Type ‘3’ (Copy) in the Option field next to the TDS segment (Sequence Number 8000)
and press Enter. This action displays the Copy To window.
2. Type ‘4350’ on the blank line in the window and press Enter.
The last step in aligning the segments is to modify the segments that you copied in the previous
steps.
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
1. Change the information in the Description fields of the N1 segments to “SHIPTO NAME”
and “REMITTO NAME” respectively.
2. For the TDS at sequence number 4350, change the area code to D (detail) and type the
loop ID ‘6000’ to match the loop IDs used for the detail area. If the loop ID is not
included, only the last item record will be calculated for an extended amount.
3. For the detail, TDS, change the write flag from ‘Y’ to ‘N’ to prevent the segment from
being written to the output EDI data file.
Now that the segments are aligned to work with our application definition, we need to define what
will be mapped to each element. The first step in element mapping is to access the Element
Mapping Outbound panel (EDIX511).
Transaction ID . . . . . . . . . . 810S41EDI
Send or Receive. . . . . . . . . . S
Transaction Set. . . . . . . . . . 810
Standard . . . . . . . . . . . . . 004010
Type ‘11’ (Elem Map) in the Option field next to the first segment as shown on the panel and press
Enter. This action displays the Element Mapping Outbound panel (EDIX511).
# NOTE
Please see the “Using Split Screen Map Option” section in this chapter if you choose to use
option 14, Split Screen Map.
The element mapping you will perform in the next several steps is based on the instructions
provided in the “Contents of the X12 Invoice” table in the “Mapping Getting Started” chapter.
Application fields can be entered in the Mapping Constant/Field field or selected from a list of
available fields. The panel below shows how to use option ‘1’ (Appl Fields) to select an
application field.
om
Type ‘1’ in the Option field next to Element ‘1’ (Invoice Date) and press Enter. This action
displays a window from which you can select the desired application field.
# NOTE
The window displays only header fields since the BIG segment is a header segment.
Data is mapped from header to header, detail to detail, and summary to summary
according to established rules.
Type ‘1’ (select) in the Option field next to the desired item in the window as shown on the panel
and press Enter to populate the Mapping field.
In this step you will map the remaining elements in the BIG segment.
Bottom
F5=Refresh F16=Prev Rcd F17=Next Rcd F21=Prt Map F24=More Keys
The next several steps show how to map the NTE segment. The panel below shows how you can
perform element mapping by selecting a data element code from the standards.
F1=He
To select a data element code to map to Element No. 1, complete the following instructions:
1. Type ‘13’ (Codes) in the Option field next to Element No. 1 and press Enter.
2. From the window that displays, select option ‘1’ to pull the EDI code ‘GEN’ into your
element map. The code ‘GEN’ indicates that this is a general type of message that pertains
to the whole document. It qualifies the type of note reference that follows in the next
element. It should be mapped only if the message exists. This can be accomplished by
conditional mapping which is described in the next step.
3. Type ‘F020.ICMSG’ as shown on the next panel to map the message field into Element
No. 2 and press Enter to update panel.
As stated in the previous step, the EDI code ‘GEN’ is only written if there is a message. If this
condition was not set up, the code would always be moved into the NTE segment and a
compliance error would occur for the conditional requirements not met. This would happen
because a qualifier would exist without the element it is qualifying. Therefore, you must update the
element with extended mapping information to set the condition for the data to be moved.
Extended mapping allows you to define extended mapping instructions for data elements that
require conditional mapping as well as calculations, user-defined routines, and accumulator value
calculations for total fields. If you have a literal value that is more than 15 positions long, you can
specify it on the extended mapping screen. See Step 18:.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Type ‘11’ (Ext Map) in the Option field next to ‘GEN’ as shown on the panel above and press
Enter. This action displays the Work with Element Mapping panel (EDIX506-FMT01).
In this step you will select the element that requires extended mapping.
Figure 6.24 Work with Extended Mapping panel (EDIX506-FMT01) – NTE Segment
Type ‘2’ (Revise) in the Option field next to the ‘GEN’ constant and press Enter to display the
Extended Outbound Mapping panel (EDIX508-FMT01).
As mentioned in Step 16, if you have a longer literal value, you can specify it in the 65-position
long Element field. This long Element field functions the same as the 15-position field, except that
is cannot be used for computation. Both fields cannot be specified.
In this step you will specify an if-condition that will prevent code ‘GEN’ from being written if
there is no message.
# NOTE
The default mode (either More or Less) is set in the System Configuration file and is used for
the initial display of the panel.
1. Type ‘F020.ICMSG’ on the “If” line under the Value field to identify the application field
to be checked, and ‘GT’ (greater than) in the Op (Operator) field. Press F4 (Prompt) for a
list of valid operators that can be used in the Operator field for the if-condition.
2. To check for a BLANK field, enter in the literal value of a single blank character. Any
literal value MUST be enclosed in single quotes.
3. Press F10 (Update) to update the panel. This action returns you to the previous panel and
displays the message “Revise Operation Successful” at the bottom of the panel.
4. Press F12 (Cancel) to return to the Element Mapping Outbound panel (EDIX511). Notice
the ‘Y’ that displays in the Ext Map field for Element No 10. This indicates that an
Extended Mapping panel exists for this element.
The next several steps show how to map the REF segment.
Bottom
F5=Refresh F16=Prev Rcd F17=Next Rcd F21=Prt Map F24=More Keys
1. Type the code ‘DP’ as shown on the panel. The code ‘DP’ indicates that the type of
reference number that follows is a department number. It should be mapped only if the
Ship-to department number exists.
2. Type ‘F010.IHSDPT’ as shown on the panel to map the Ship To department number to
Element No. 2 and press Enter.
3. Type ‘11’ (Ext Map) in the Option field next to Element No. ‘1’ and press Enter. This
action displays the Work with Extended Mapping panel (EDIX506-FMT01). Type ‘2’
(Revise) in the Option field next to sequence 400 element 10 and press Enter.
In this step you will specify an if-condition that will prevent code ‘DP’ from being written if there
is no Ship To department number.
1. Type the information as shown on the panel for the REF segment to specify the
if-condition as shown on this panel.
2. Press F10 (Update). This action returns you to the Work with Extended Mapping panel
(EDIX506-FMT01).
3. Press F12 (Cancel) to return to the Element Mapping Outbound panel (EDIX511).
In this step you will map the N1 segment for the Billto location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
1. Map the Entity Identifier and the Name. For Billto information, use the code ‘BT’ and
retrieve the Billto name from the application field listing. Since the Billto name will
always be present in the application file, there is no need to define an if-condition for
Element No. 1.
2. Press F17 (Next Rcd) to update the map and advance to the next segment.
In this step you will map the N3 segment for the Billto location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
In this step you will map the N4 segment for the Billto location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
1. Map the City, State, and Postal Code for the Billto location as shown on the panel and
press Enter.
2. Press F17 (Next Rcd) to update the panel and advance to the next segment.
In this step you will map the N1 segment for the Ship To location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
To map the N1 segment for the Shipto location, complete the following instructions:
1. Select or enter the application fields to map all four elements for the N1 for the Shipto as
shown on the panel. The Identification Code Qualifier, ‘92,’ indicates that the Shipto
Entity can be determined by the identifier in Element 4, which is a customer-supplied
store number. This store number can be accessed in the user’s application system to
determine the complete address for the Shipto. This prevents the N3 and N4 segments
from having to be sent.
In many cases, the vendor has to maintain store information either in Gentran:Server by
using a Data Translation table or in their application system.
2. Press F17 (Next Rcd) to update the panel and advance to the next segment.
In this step you will map the N1 segment for the Remit To location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
1. Map the Entity Identifier Code and the Name for the Remit To as shown on the panel. This
segment identifies where the invoice payment should be sent.
2. Press F17 (Next Rcd) to update the panel and advance to the next segment.
In this step you will map the N3 segment for the Remit To location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Subfield Mapping
Step 27: Map the N4 Segment for the Remit-to
In the next several steps you will map the N4 segment for the Remit To location. The postal code
for the Remit To location consists of two fields. The first is 5 characters and the second is the
4-character extension. These two fields can be concatenated within Gentran:Server at the time of
mapping by performing subfield mapping. Subfield mapping allows the user to break a single
element into multiple “sub-elements.” An application field, constant, or literal value can be moved
into each “sub-element.”
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Type ‘12’ in the Option field next to the Postal Code and press Enter. This action advances you to
the Subfield panel (EDIX507-CTL01).
Step 28: Create Subfields for the Postal code for Segment N4
The panel below shows how to define “sub-elements” for a particular element.
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
To create two subfields to handle the postal code, complete the following instructions:
1. Type the information shown on the above panel. Choose any sequence number between
030 and 040. Gentran:Server adds a suffix of ‘0’ on every element in the segment to allow
sub-elements to be inserted between contiguous elements.
2. Press F10 (Update) to add the two “sub-elements” to the map. This action returns you to
the Element Mapping Outbound panel (EDIX511).
Step 29: Map the Enhanced N4 Segment for the Geographic Location
This is the last step in mapping the N4 segment for the Remit-to location.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
In this step you will map the DTM segment for the Ship Date.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Segment IT1 is the first segment in the detail loop. It contains the information that needs to be
mapped for the line item segment. The assigned identification number in Element 1 is a line
counter, which is often requested in the EDI documents. In this example, this value is accumulated
within Gentran:Server using ACCUMULATOR-01 since there is no application field that has this
information. The Accumulators work by adding one each time they are invoked. In this situation,
the accumulator increments every time another line item segment is generated.
2. Select or enter the application fields or EDI codes to map the IT1 Segment with the data
shown on the previous panel. Map the Quantity that was shipped, the Unit-of-Measure
(which will be run through a code table and converted to the appropriate EDI value at
run-time), the Unit Price, the UPC number, and the Vendor’s Product number. Qualifiers
for the UPC and Vendor’s Product numbers are ‘UP’ and ‘VP.’ Press Enter to update the
panel. A warning message displays for the Unit of Measure. Press Enter to clear the
message because you will be using a code table for the Unit of Measure and are not
concerned with the truncation warning.
# NOTE
The Code table for unit of measure conversion, UNITMEAS, must be created prior
to mapping the elements of this segment. (For more information about creating
tables, SEE the ‘Creating a Code Translation Table’ task in this chapter.)
The next several steps show how to add extended mapping to the IT1 segment.
1. Type ‘11’ in the option field next to Element 1 as shown on the above panel and press
Enter. This action displays the Work with Extended Mapping panel (EDIX506-FMT01).
2. Type ‘2’ (Revise) in the option field next to the first extended map and press Enter.
Although this element is loaded from the Reserved Word, ACCUMULATOR-01, you must
increment the Accumulator so it will work like a counter. For each line item loop that is sent, the
assigned identification number will be incremented by one. At the end of the invoice, the
accumulator indicates the total number of line items that were sent.
1. Type the desired accumulator number in the field, 'Add 1 to Accumulator #.’ For this
example, type ‘01.’ Additional accumulators are available, some of which get cleared at
the beginning of the document, while others get cleared at the beginning of the
interchange, group, or detail section. To see a list of available values for this field, press
F4 (Prompt). (For more information, press F1 to see online help about accumulators; also,
see the section “Reserved Word Constants” in the Glossary in this manual.)
2. Press F17 (Next Rcd) to update this record and advance to the next element within the IT1
segment.
Step 34: Update the Extended Map for the Quantity Shipped
In this step you will add the extended map information for the Quantity Shipped. At the end of the
invoice, the hash total indicates the total quantity shipped for the invoice.
# NOTE
If you choose to round this value, it does not round the numbers first and then sum
the total in HASH-TOTAL-01. If you want to round your values before summing the
total, see “Map the CTT Segment.”
2. Sum the total quantity for the invoice by adding this line item’s quantity to the Reserved
Word, HASH-TOTAL-01.
3. Code the desired hash total number in the field, ‘Add to Hash Total #.’ Use ‘01.’
Additional hash totals are available. They may get cleared at the beginning of the detail
section, document (header section), group, or interchange. To see a list of available values
for this field, press F4 (Prompt). (For more information, press F1 to see online help about
hash totals; also, see “Reserved Word Constants” in the Glossary in this manual.)
4. Press F10 (Update) to return to the Work with Extended Mapping panel
(EDIX506-FMT01).
5. Press F12 (Cancel) to return to the Element Mapping Outbound panel (EDIX511).
The following panel shows you how to map the item description.
Bottom
F5=Refresh F16=Prev Rcd F17=Next Rcd F21=Prt Map F24=More Keys
For this example, a Dummy TDS segment will be used to calculate and save the extended line item
amount for each line item. The next several steps show how to use the extended mapping to sum
the extended line item amounts.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Figure 6.43 Element Mapping Outbound panel (EDIX511) – Dummy TDS Segment
To access the Extended Outbound Mapping panel (EDIX508-FMT01), complete the following:
1. Type ‘11’ (Ext Map) in the Option field next to Element No. ‘1’ and press Enter. This
action displays the Work with Extended Mapping panel (EDIX506-FMT01).
2. Type ‘2’ (Revise) in the Option field next to the first extended map and press Enter.
Step 37: Update the Extended Map for the Dummy TDS Segment
The following panel shows how to update the extended map to calculate and save the total
extended line item amount.
Figure 6.44 Completed Mapping for the TDS Dummy Segment (EDIX508-FMT01)
1. Enter the Quantity Application field in the first Value column for the Element. The Op
code is ‘*’ for multiplication. Enter the Unit Price Application field in the second Value
column for the element. The result of the following calculation is added to the hash total:
At the end of the invoice, the reserved word Hash-Total-02 contains the total dollar
amount of the invoice. If there are any discounts, charges, or allowances for the invoice,
these need to be summed in Hash-Total-02.
# NOTE
Because this is a dummy segment, turning on the Round Element here does not
change the result of the calculation. However, if you would like to round up the total
dollar amount of the invoice in Hash-Total-02, you can change the Round Element
to ‘Y’. See “Map the TDS Segment in the Summary Area.”
Press F4 (Prompt) for a list of Operators that can be used for arithmetic operations on the
Element line. Calculations are performed from left to right, not by mathematical hierarchy.
Press F10 (Update) to update the extended map. This action displays the Work with
Extended Mapping panel (EDIX506-FMT01).
2. Press F12 (Cancel) to return to the Element Mapping Outbound panel (EDIX511).
3. Press F17 (Next Rcd) to advance to the next segment.
There is no summary application file. The total invoice amount has been calculated internally
within Gentran:Server using the Reserved Word Constants. There was a TDS Dummy Segment
that was included in the Detail area. It calculated and summed the extended line item's amount.
Since it was included in the Detail area, every line item was calculated and summed.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Map the Reserved Word, HASH-TOTAL-02, since it contains the sum of all detail items in the
Total Invoice Amount element (Element 1) as shown in Figure 6.45, above. If you do not want to
round up the amount in Hash-Total-02, press F17 (Next Rcd) to update the panel and advance to
the next segment. If the amount in Hash-Total-02 has more decimal places than allowed in the
element being mapped to, the extra decimals are truncated.
The rounding option is only used for the numeric data types and for mapping an element that has
more decimal places than allowed in the mapped-to element. The value is truncated is you do not
have this option turned on. If you wish to round the decimal values, complete the following steps:
1. Type ‘11’ in the option field next to Element 1 with HASH-TOTAL-02 mapped to it.
Press Enter. This displays the Work with Extended Mapping panel (EDIX506-FMT01).
2. Type ‘2’ (Revise) in the option field next to the first extended map and press Enter.
3. On the Extended Outbound Mapping panel (EDIX508-FMT01), type ‘Y’ next to the
Round Element field as shown in Figure 6.46, below.
Gentran:Server for iSeries allows you to enter comments for extended maps.
To add comments to element 1 of the TDS segment, press F14 (Notes) on the Extended Outbound
Mapping (EDIX508-FMT01) panel. .
Enter comments and press F10 (Update). Extended Outbound Mapping panel is displayed. Press
F5 (Refresh), the function key ‘F14=Notes’ changes to ‘F14=Notes*. The ‘*’ denotes there are
notes for this element.
Press F10 (Update) to return to the Work with Extended Mapping panel (EDIX506-FMT01).
Press F12 (cancel) to return to the Element Mapping Outbound panel (EDIX511).
The CTT is a control-type segment included in many of the transaction sets. It carries some control
totals used to ensure that all of the line items are included in the document. The CTT01 element in
this document contains the number of line item loops generated for this document. This is
calculated within Gentran:Server by using ACCUMULATOR-01. The CTT02 element is optional.
If used, it contains the total quantity that was shipped (sum of all the IT102’s). This value is
calculated internally by using HASH-TOTAL-01.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F13=Services F24=More Keys
Type the values for Elements 1 and 2 as shown on panel and press F10 (Update).
Summary
At this point, you are finished creating an outbound map. Press F12 (Cancel) to return to the Work
with Transaction Mapping panel (EDIX500-FMT01).
Off-line Preparation
Before you enter Gentran:Server to create an inbound transaction map, you may find it beneficial
to use the following worksheets to establish the relationship between your EDI elements and your
application fields. If the worksheets are filled out carefully, actually mapping the document will be
a simpler task.
2. A firm definition as to which EDI segments might be received and where in the
application the received elements should go.
3. What special processing requirements are needed (that is, you must translate the EDI unit
of measure received into an application unit of measure).
4. A firm understanding of the reserved word constants that are automatically loaded by the
Gentran:Server inbound mapping program. (SEE the Glossary in this manual for more
information about Reserved Words.)
Fill out one worksheet for each application record. List each application field defined for the
record and indicate the source Element for the application field under the standard element
column. Note any special processing requirements.
You will need to write down an application field twice if the field will be loaded with one value
when a certain condition exists and another value when another condition exists.
SENDER-ID CUSTNUM
BEG02 TYPCODE
TOTAMT
Figure 6.48 Mapping Field Level Worksheet – Purchase Order Header Record
SENDER-ID CUSTNUM
CONSTANT-02 PODATE
PO104 UNITPR
CONSTANT-01 PONUM
PO102 QTYORD
PID05 DESC
Figure 6.49 Mapping Field Level worksheet – Purchase Order Detail Record
As each element is entered on the worksheet, look for corresponding entries on the Field Level
worksheets that were just completed. Make one entry on the Element Level worksheet for each
reference to that element on the Field Level worksheet.
As each field level entry is transferred to the Element Level worksheet, place a check-mark in the
XFER column of the Field Level worksheet, next to the entry. When this process is finished, the
only entries that should remain unchecked are those that are loaded from literal or reserved word
constants.
BEG Segment
The following elements are referenced:
F010.TYPCODE BEG02
N1 Segment
The following elements are referenced:
N3 Segment
The following elements are referenced:
N4 Segment
The following elements are referenced:
PO1 Segment
The following elements are referenced:
F020.QTYORD PO102
F030.UNITPR PO104
If PO106 = ‘PI’ or ‘CB,’ translate
F020.ITEMNUM PO107 EDI item # using SEMDATA table
PID Segment
The following element is referenced:
F020.DESC PID05
For the same reason, do not eliminate the loop IDs or change the Max Use of any segment to one
(1), unless you are certain that the segment will not loop. On inbound maps, assume the worst case
scenario. Use the Type, Loop ID, and Max Use fields directly as copied from the standard.
List the application records down the left side of the worksheet. If an application record will be
generated each time an EDI loop is processed, assign it the appropriate loop ID. Assign the
application records an area and a Max Use.
Use the application file formats created in the “Application Definition” chapter as a reference.
Draw lines from each application record to each segment that “contributes” data to its generation.
Examine the segment/record relationship. If any EDI segment maps to an application record in a
different area of the document, then you have an error that must be corrected before you can
proceed with mapping.
Application Record Type Loop ID Max Use Relationship Segment ID Type Loop ID Max Use
Transaction Mapping
PO Header H 1 BEG H 1
N3 H 4000 2
N4 H 4000 1
PO1 D 8000 1
PID D 8150 1
CTT S 1
The Work with Transaction Mapping panel (EDIX500-FMT01) provides you with the option for
creating a new Transaction ID. Typically, most users choose a name that identifies the transaction,
version, and partner-specific code. The name you choose must be unique.
3. Type ‘R’ in the S/R (Send/Receive) field to indicate that this is an inbound map that will
be used to translate your trading partner’s EDI format and press Enter.
Field Descriptions
Transaction ID
This field contains the single identifier under which all the connections between the EDI
format and the application format are stored. It is also referred to as the map name. This is
the primary key when identifying a map.
Send or Receive
Type ‘S’ (Send) in this field when setting up an outbound document or ‘R’ (Receive) when
setting up an inbound document. It is the secondary key when identifying a map.
The Transaction Map Definition panel (EDIX503-FMT01) is where you specify the characteristics
of a particular map.
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . Purchase Order Inbound 004010
Standards Version. . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
Transaction Set Release. . . . . . 0
Transaction Status . . . . . . . . T
Use Code . . . . . . . . . . . . . P
Envelope Type. . . . . . . . . . . X
Application ID . . . . . . . . . . SEMPOAPPL
Application Selection Field Values
Update Allowed . . . . . . . . . . Y
1. Type the information as shown on the panel for the following fields.
Description
Standards Version
Transaction Set
Transaction Status
Use Code
Envelope Type
Application ID
# NOTE
You must know the name of the Application ID previously created and to which this
Transaction is “tied.” Press F4 (Prompt) for a list of applications from which to choose. The
transaction (or map) is the definition of how to move data between the EDI format and the
application format. It is imperative that the application definition already exist in
Gentran:Server and it must be identified correctly in order for the Transaction ID to be added.
2. Make sure that the Update Allowed flag is set to ‘Y’ (Yes) and Press F10 (Update) to
create the new transaction map. This action displays the Work with Transaction Mapping
panel (EDIX500-FMT01) and displays the message ‘Create Operation Successful’ on the
Message Line at the bottom of the panel.
Field Descriptions
Division Code
Type '000,’ the Global Division Code unless you are assigned a specific division code in
your security profile.
Description
Provide a meaningful description for the map. It displays on the Work with Transaction
Mapping panel (EDIX500-FMT01) and it can be used to help differentiate maps. If you
are setting up a partner-specific map, the description should identify the partner.
Standards Version
This field reflects the full version code as known in the standards. (SEE the “Standards”
chapter for more information on available versions.) If using X12 versions, supply the
leading zeros. Remember to tag the subset code with the version you are using, such as
VICS. SEE the Standards Maintenance subsystem within online Gentran:Server if you are
unsure of the version.
Transaction Set/Release
This field is the actual Transaction Set ID for the document being received in EDI format.
The value is specific to the standards and can be found in the “Standards” chapter in this
document, in the Gentran:Server Standards Maintenance subsystem, or from your trading
partner. The Release code is only needed if the version is for TRADACOMS.
Transaction Status
This field indicates the status of this map. It is typically used to document the status of the
map.
Use Code
This flag identifies whether the map is for general purpose or for specific trading partners.
There should only be one map classified as ‘G’ (General) for a particular
transaction-version combination. When processing, the first general-type map for the
requested version is selected. Any additional maps for the same version and transaction
are ignored. General maps are typically comprehensive and include the largest subset of
segments that any partner can send.
Partner-specific maps are useful when the EDI format for a particular partner is different
than the format used by most of your partners. It is common to have partner-specific maps
for outbound documents. Most partners request specific segments or want some segments
omitted. It is simpler to make a copy of the general map and modify it for a partner. It is
fairly common to use one general map for all partners for inbound documents.
Envelope Type
This flag identifies the type of envelope or standards being used for this map. The flag
corresponds to the transaction set. For example, the 850 transaction is an X12 purchase
order, so the type is set to ‘X.’
Application ID
This field contains the name of the Application ID that this map is tied to. In “Mapping
Getting Started,” there is a Bicycle Wheel diagram that shows the relationship between
transactions and the Application ID. This field is where that connection is made. In this
example, the map is tied back to the Application ID ‘SEMPOEDI,’ which was created in
the “Application Definition” chapter. If you didn’t create an application, you can select
‘SEMPOAPPL’ which was supplied with the system.
Update Allowed
Specify ‘Y’ (Yes) to allow updates to be made to this map definition while developing and
testing it. When moving this map into production, you may want to modify this flag to be
'N’ (No) to prevent modifications from being made without the proper authority.
Type ‘12’ (Copy Segments) in the Option field next the appropriate Transaction ID and press
Enter. This action displays the Copy Segments from Standard panel (EDIX502-CTL01).
Step 4: Copy Segments from the Standard into the New Map
The Copy Segments from Standard panel (EDIX502-CTL01) displays all the segments contained
in the specified transaction set and standards version. It allows you to choose the EDI segments
from the standards that you will need for this map.
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
1. Type ‘3’ (Copy) in the Option field next to each segment as shown on the following
panels. Page Up/Page Down to select additional segments to be copied.
# NOTE
If you are modifying a map, the segments that are already included in the map are
highlighted and protected to prevent duplicate segments from being copied. All
mandatory segments will have a ‘3’ already in the option field.
2. When you have finished selecting the segments, press Enter to copy the segments and
remain on the panel or press F10 (Update) to copy all the selected segments into your
map. This action returns you to the Work with Transaction Mapping panel
(EDIX500-FMT01).
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Standard . . . . . . . . . . . . . 004010
Transaction Set. . . . . . . . . . 850
Bottom
F1=Help F10=Update F12=Cancel F13=Services
The next step is to access the Transaction Map Segments panel (EDIX504-CTL01) to review the
copied segments.
Review the copied segments against the Element Level worksheets to verify that all the segments
were copied.
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Transaction Set. . . . . . . . . . 850
Standard . . . . . . . . . . . . . 004010
Press Page Up/Page Down to see additional segments. If extra segments were copied by accident,
use Option ‘4’ to delete the segment. If a segment is missing, press F13 (Services) to branch to the
Copy Segments from Standard panel (EDIX502-CTL01) and copy the segment.
The first step in element mapping is to access the Element Mapping Inbound panel (EDIX514).
Transaction ID . . . . . . . . . . POMAP4010
Send or Receive. . . . . . . . . . R
Transaction Set. . . . . . . . . . 850
Standard . . . . . . . . . . . . . 004010
# NOTE
Please see the “Using Split Screen Map Option” section in this chapter if you choose to use
option 14, Split Screen Map.
In the next several steps you will map the elements in the BEG segment.
Application fields can be entered in the Mapping Constant/Field or selected from a list of available
fields. The panel below shows how to use option ‘1’ (Appl Fields) to select an application field.
# NOTE
The window displays only header fields since the BEG segment is a header segment. Data is
mapped from header to header, detail to detail, and summary to summary according to
established rules.
The following panel shows how you can select an application field to map to an element.
F1=
Type ‘1’ (Select) in the Option field next to the desired item in the window as shown in the above
panel and press Enter. The field is selected and mapped to the element selected.
In this step you will map the remaining elements in the BEG segment.
If you recall from our worksheet that we need to save the purchase order number into a constant.
Therefore, we need to add extended mapping information for Element Number 3.
The first step in entering extended mapping information is to access the Work with Extended
Mapping panel (EDIX506-FMT01).
Type ‘11’ in the Option field next to Purchase Order Number as shown on the panel above and
press Enter. This action displays the Work with Extended Mapping panel (EDIX506-FMT01).
The next step is to access the Extended Inbound Mapping panel (EDIX513-FMT01).
Figure 6.69 Work with Extended Mapping panel (EDIX506-FMT01) – BEG Segment
Type ‘2’ (Revise) in the Option field next to Element 30 and press Enter. This action displays the
Extended Inbound Mapping panel (EDIX513-FMT01).
Step 13: View Detailed Information About the Element Being Mapped
Gentran:Server allows you to view detailed information about the element you are working with.
Press F2 (More/Less) on the Extended Inbound Mapping panel (EDIX513-FMT01) to view the
detailed information about the element you are working with. F2 is a toggle switch to display less
or more information.
# NOTE
The default mode (either More or Less) is set in the System Configuration file and is used for
the initial display of the panel.
There are two Target fields on the EDIX513-FMT01 Panel. The 65-position Target field
functions the same as the 15-position Target field, expect that no calculation can be
performed on it. Only one of these fields can be specified.
Step 14: Save the Purchase Order Number and Purchase Order Date into a Constant
In this step you will specify the constant number to which the purchase order number will be
saved.
Type ‘01’ in the Save in Constant # field and press F17 (Next Rcd) twice to update and advance to
Element 50.
Type ‘02’ in the Save in Constant # field. Press F10 (Update) to update and return to the Work with
Extended Mapping panel (EDIX506). Press F12 (Cancel) to return to the Element Mapping
Inbound (EDIX514). Press F17 (Next Rcd) to advance to the next segment. Additional constants
are available. Depending on the number selected, they will get cleared at the beginning of the
detail section, document (header section), group, or interchange. To see a list of available values
for this field, press F4 (Prompt). (For more information, press F1 to see online help about
constants; also, see the section “Reserved Word Constants” in the Glossary in this manual.)
Step 15: Define the Global Conditions for the N1 Shipto Element
We determined in our preparation stage that the code “ST” in element N101 would indicate a
Shipto entity. Therefore, in order to populate the Shipto application fields, we need to define a
global condition that checks for the code “ST” in the N1 segment.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
1. Type ‘N1/10/4100’ (Segment ID, Element Sequence, Segment Sequence) and ‘EQ’ in the
Operation field on the Condition line as shown on the above panel.
# NOTE
Values in the field/constant field must be enclosed in single
quotes (‘) to indicate a literal value.
Once you’ve defined the global condition, you must apply it to a specific map number for each
element. The panel below illustrates how to apply our global Shipto condition to map number ‘0.’
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
Press F19 (Apply Global) to specify the mapping number. Type ‘0’ in the Apply to Map window
and press Enter. The previous panel is redisplayed showing all the elements to be conditioned.
The code ‘C,’ indicating that an if-condition has been applied, displays in the Ext Map field for
each element in the segment.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
Next, you’ll define a global condition for the Billto entity. Since we are using map number ‘0’ to
check for the Shipto entity, we will apply the Billto global condition to map number ‘1.’
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
Enter the information including ‘BT’ in the Cond(ition) line as shown on the above panel. Press
F19 (Apply Global) to display the Apply to Map window. Type ‘1’ in the window and press Enter.
The alternate map will be created even though the mapping panel returns to the mapping number 0
record.
# NOTE
When you press F17 (Next Rcd), the system advances to the mapping number 1 record that
was just created.
Now that you have defined the global conditions, you must identify the application fields that will
be populated by the N1 segment. The next several steps illustrate how to map the N1 segment.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
1. Type ‘F010.SHIPTONAME’ in the Mapping Target field next to Element Number 2 and
press Enter. Since the mapping number is currently set to ‘0’, “F010.SHIPTONAME”
will be the Mapping Target field for map number ‘0.’
2. Press F17 (Next Rcd) to update and advance to Mapping number 1 for the N1 segment.
In this step, you will map the Billto Name on the N1 segment.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
1. Type ‘F010.BILLTONAME’ in the Mapping Target Field next to the element number 2 or
use option 1 to prompt the list of application fields to select the BILLTONAME field.
Notice you are on mapping number 1 (an alternate mapping for the N1 segment as an “else
condition”).
2. Press F17 (Next Rcd) to update and advance to the next segment.
Step 21: Define the Global Condition for the ShipTo Address Information
As you can see from the element worksheets, we need to map the N3 segment to the address lines
for both the Shipto and Billto locations. To accomplish this, we can define the same global
conditions as we defined for the N1 segment.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
1. Type ‘N1/10/4100,’ ‘EQ,’ and ‘ST’ in the Field, Op, and Field/Constant fields on the
Cond(ition) line.
2. Press F19 (Apply Global) to display the Apply to Map window and type ‘0’ in the
window.
Step 22: Define the Global Condition for the Bill To Address Information
Next, you’ll need to define a global condition for the Billto address information. Since we are
using map number ‘0’ to check for the Shipto address information, we will apply the Billto global
condition to map number 1.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
Type ‘N1/10/4100,’ ‘EQ,’ and ‘BT’ on the Condition line as shown on the above panel. Press F19
(Apply Global) and type ‘1’ in the Apply to Map window. Press Enter to apply the global
condition to map 1. The alternate map will be created even though the system returns to the
mapping number 0 record.
In this step you will specify the application fields that will be used to store the Shipto addresses.
Bottom
F5=Refresh F16=Prev Rcd F17=Next Rcd F13=Services F24=More Keys
Type the information as shown above in the Mapping Target field and press F17 (Next Rcd) to
update and advance to the next segment. Note the “C” in the Map field for the two elements that
indicates that the elements have been conditioned.
In this step you will specify the application fields that will be used to store the Billto addresses.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
1. Type the information as shown above in the Mapping Target fields. Note the “C” in the
Map field for the two elements that indicates that the elements have been conditioned.
2. Press F17 (Next Rcd) to update and advance to the next segment.
Subfield Mapping
Step 25: Map the N4 Segment for the Geographic Location
Before you can complete element mapping for the N4 Segment, you must create “sub-elements” or
subfields for the Postal Code (Element 3). From the element worksheet, you can see that the Postal
Code for the Billto location consists of two fields. The first field stores the first 5 characters of the
zip code, and the second field stores the 4-character extension. These two fields can be mapped
from one element by Gentran:Server at the time of mapping by performing subfield mapping.
Subfield mapping allows the user to break a single element into multiple “sub-elements.” Each
sub-element can then be mapped to an application field.
The panel below illustrates how to access the Subfield panel (EDIX507-CTL01), on which you
can define subfields for a particular element.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
Step 26: Create Subfields for the Postal code for Segment N4
The worksheet indicates that only one field containing all nine digits is needed to store the Postal
Code for the Shipto location. Normally, we would map the Postal Code (Element 3) directly to the
Shipto postal code. We must create a third subfield that allows us to map the entire nine digits,
because the original element (Element 3) cannot be mapped.
The panel below illustrates how to create the three subfields needed to handle the billto and shipto
postal codes.
More...
F1=Help F4=Prompt F10=Update F12=Cancel F24=More Keys
To define the subelements for the Postal Code, complete the following instructions:
1. Type the information as shown on the above panel. Choose any sequence number between
030 and 040. Gentran:Server adds a suffix of “0” to every element in the segment to allow
subelements to be inserted between two contiguous elements.
2. Press F10 (update) to add the three “subfields” and return to the Element Mapping
Inbound panel (EDIX514).
The panel below shows where the new subelements are inserted in the N4 segment. Note that the
Postal Code element has a data type of “SF,” which indicates that it is broken into subfields. As
mentioned in a previous step, this element cannot be mapped from directly.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
Step 28: Define the Global Condition for the Ship To Location Information
The N4 segment also requires global conditioning to determine what type of N1 loop was
received.
26
09
6 C O AN LOCATION IDENTIFIER 60 310 Y
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
1. Type ‘N1/10/4100,’ ‘EQ,’ and ‘ST’ in the Field, Op, and Field/Constant fields on the
Cond(ition) line as shown on the above panel.
2. Press F19 (Apply Global) to specify the mapping number, namely ‘0,’ to apply the global
condition to.
3. Type ‘0’ in the window and press Enter. The alternate map will be created even though
the system returns to the mapping 0 record.
Next, you’ll need to define a global condition for the N1 Billto segment. Once again, we will apply
the condition to map number ‘1.’
F1=
1. Type ‘N1/10/4100,’ ‘EQ,’ and ‘BT’ in the Field, Op, and Field/Constant fields on the
Cond(ition) line as shown on the Element Mapping Inbound panel.
2. Press F19 (Apply Global) to specify the mapping number, namely ‘1,’ to apply the global
condition to.
3. Type ‘1’ in the window and press Enter. The alternate map will be created even though
the screen returns to the mapping number 0 record.
In this step you will specify the application fields that will be used to store the Shipto geographic
location.
Bottom
F5=Refresh F16=Prev Rcd F17=Next Rcd F13=Services F24=More Keys
Type the information as shown on the above panel or use option 1 to select the fields from the
window. Note that Element Map Sequence 33, which has a length of 9, is mapped to the Shipto
postal code.
Press F17 (Next Rcd) to update and advance to the mapping number 1 created for the N4 segment.
In this step you will map the Billto city and state on the N4 segment.
Bottom
F5=Refresh F16=Prev Rcd F17=Next Rcd F13=Services F24=More Keys
Invalid Option entered.
To map the Billto information, type the field names as shown or use option 1 to select the fields
from the window.
Press F17 (Next Rcd) to update and advance to the next segment.
Segment PO1 contains the line item information. It is the first segment in the detail area. The next
several steps demonstrate how to map the PO1 segment in the sample purchase order.
The first step in mapping the PO1 segment is to select application field “F020.QTYORD.”
F1=
1. Type ‘1’ in the Option field next to the second element and press Enter to display a
window as shown on the above panel.
# NOTE
This window displays only detail fields as the PO1 segment is a detail segment.
2. Type ‘1’ (Select) in the window next to Quantity Ordered and press Enter.
Unit Price
Item number (which will be run through a data table and converted)
# NOTE
The Code and Data tables, SEMCODE and SEMDATA, must be created prior to mapping the
elements of this segment. If you get an error message when you try to update this panel, you
must first build these tables. Use F13 (Services) to exit this panel and build the required
tables without losing any changes you may have made up to this point. SEE the “Creating a
Code Translation Table” and “Creating a Data Translation” tasks in this chapter for more
information about code and data translation tables.
More...
a. Type ‘11’ and press Enter to display the Work with Extended Mapping panel
(EDIX506-FMT01).
b. In the Option field next to the first extended map, type ‘2’ and press Enter.
c. An input field for the #DEC field is displayed. Enter a decimal position between 0
and 5 that you would like to round it to.
3. Type ‘SEMCODE’ in the Table ID field next to Element Number 3. During processing,
Gentran:Server will use this table to convert the EDI code for unit of measure to the code
used by your application.
a. Type ‘11’ and press Enter to display the Work with Extended Mapping panel
(EDIX506-FMT01).
b. In the Option field next to the first extended map, type ‘2’ and press Enter.
c. An input field for the #DEC field is displayed. Enter a decimal position between 0
and 5 that you would like to round it to.
5. Type ‘SEMDATA’ in the Table ID field next to Element Number 7. During processing,
Gentran:Server will use this table to convert the data in this element to a value that can be
recognized by your application.
You can see from the worksheets that we expect to receive two item numbers: Purchaser’s (PI) and
Vendor’s (VN). Therefore, we need to create two if-conditions to map the item numbers to the
appropriate application field.
Type ‘11’ (Ext Map) in the Option field next to the Product/Service ID (Element 7) and press
Enter.
The next step is to access the Extended Inbound Mapping panel (EDIX513-FMT01).
Figure 6.92 Work with Extended Mapping panel (EDIX506-FMT01) – Seg Seq 7600
Type ‘2’ in the Option field next to Seg Seq 7600, Ele Seq 70 and press Enter.
The following panel shows how to define an if-condition to handle the purchase order number.
Type ‘PO1/60/7600,’ ‘EQ,’ and ‘PI’ on the If line. Type ‘O’ (or) in the And/Or field, and
‘PO1/60/7600,’ ‘EQ,’ and ‘CB” in the next three fields as shown above.
Press F10 (Update). The Work with Extended Mapping panel (EDIX506-FMT01) displays, with
the message “Revise Operation Successful”.
Gentran:Server allows you to create a new extended map by copying an existing extended map.
Copy To
1
F3=Exit F12=Cancel
Figure 6.94 Work with Extended Mapping panel (EDIX506-FMT01) – PO1 Segment
Type ‘3’ (Copy) in the Option field next to Element Sequence 70, Map number 0 and press Enter.
A Copy To window displays. Type ‘1’ in the window and press Enter.
Now that the new extended map has been created, it needs to be modified to handle the vendor’s
item number.
Figure 6.95 Work with Extended Mapping panel (EDIX506-FMT01) – PO1 Segment
Type ‘2’ (Revise) in the Option field next to map 1 for Ele Seq 70 as shown on the above panel and
press Enter. This action displays the Extended Inbound Mapping panel (EDIX513-FMT01).
In this step you will modify extended map number 1 to handle the vendor part number.
1. Since the EDI code “VN” identifies the vendor part number, you need to modify the
if-condition as shown on the panel and press F10 (Update). This action updates the
extended map and returns you to the Work with Extended Mapping panel
(EDIX506-FMT01).
2. Press F12 (Cancel) to return to the Element Mapping Inbound panel (EDIX514).
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
The CTT segment is a control-type segment included in many of the transaction sets. It carries
summary control numbers that are used to ensure that all of the line items were included in the
document. Since there is no summary application file in the sample purchase order, there is no
need to map the CTT segment. However, because we expect to receive a CTT in each transaction
set, it must be included in the map. Otherwise, Gentran:Server would create an error message
during processing.
Bottom
F1=Help F4=Prompt F10=Update F12=Cancel F19=Apply Global F24=More Keys
In Conclusion
At this point, you have finished creating an inbound map. Press F12 (Cancel) twice to return you
to the Work with Transaction Mapping panel (EDIX500-FMT01).
# NOTE
You can perform the same functions using this option as the Element Mapping Outbound
(EDIX511) panel. The same is true of the Element Mapping Inbound (EDIX514), except you
cannot apply global conditioning using this option.
To access the Split Screen Map option, type ‘14’ beside a segment on the Transaction Map
Segments (EDIX504) panel and press Enter.
Transaction ID . . . . . . . . . . SEMPO4010
Send or Receive. . . . . . . . . . R
Transaction Set. . . . . . . . . . 850
Standard . . . . . . . . . . . . . 004010
Two panels display in a split screen mode. The application fields display at the top with the
program label EDIX526. The program header varies slightly for inbound and outbound.
The top portion is used for selecting application fields to be mapped. The bottom portion contains
the Segment Elements with the program label EDIX524 (inbound) or EDIX525 (outbound). The
bottom portion contains information to be updated.
The cursor is positioned in the bottom portion of the display. At this point, the application portion
of the screen (top) is protected. The options and functions apply only to the bottom portion of the
display.
To map an application field to the element, type ‘1’ next to the element you want to map and press
Enter.
Control is now transferred to the application portion of the display. The function keys change and
the bottom portion of the panel is protected.
Find the application field the element is to be mapped to. Type ‘1’ next to the application field and
press Enter. The field is brought down in the target field of the element that is being mapped.
Control is transferred back to the segment element portion of the panel. The options and function
keys change to reflect this.
Press Enter to update and remain on this panel or F17 (Next Rcd) to update and advance to the
next segment.
# NOTE
Press F12 (Cancel) to leave the application portion of the screen without changing any of the
data.
Continue with the selection until the segment has been mapped.
Offline Preparation
Before you enter Gentran:Server to create a code translation table, you may find it helpful to
determine the code requirements for your particular application.
In this task you will create a table to translate a unit of measure code. The table below lists some of
the codes that may be found in an application along with their corresponding EDI code.
BOX BX BOXES
CASE CA CASE
DOZ DZ DOZEN
EACH EA EACH
FEET FT FEET
PAD PD PADS
REAM RM REAMS
UNIT UN UNITS
The first step in creating a code translation table is to access the Work with Transaction Mapping
panel (EDIX500-FMT01).
Type ‘13’ (Tables) in the Option field on the key entry line and press Enter. This action displays
the Work with Tables panel (EDIX580-FMT01). Tables are independent of the maps, so it does not
matter if option 13 is specified on the key entry line or beside a map.
This panel provides you with the option for creating a new Table ID. You may make the Table ID
unique by using any value you like.
Position to Table ID . . . . . . .
To create a table for the Unit of Measure code ‘UNITMEAS1,’ follow these steps:
2. Type ‘UNITMEAS1’ in the Table ID field and ‘C’ (for a code type table) in the Type field
on the key entry line and press Enter. This action displays the Define Translation Table
panel (EDIX581-FMT01) where you will define the characteristics of the Unit of Measure
table.
In this step, you will create a Code Translation table for the Unit of Measure code example.
Table ID . . . . . . . . . . . . . UNITMEAS1
Partner ID . . . . . . . . . . . .
Partner Qualifier. . . . . . . . .
Division Code. . . . . . . . . . . 000
Type . . . . . . . . . . . . . . . C
Description. . . . . . . . . . . . Internal t EDI UOM (tutorial 1)
Standard Version . . . . . . . . . 004010
Standard Element Ref . . . . . . . 0355
Release. . . . . . . . . . . . . .
Standard Minimum Length. . . . . .
Standard Maximum Length. . . . . .
Standard Data Type . . . . . . . .
Application Minimum Length . . . . 1
Application Maximum Length . . . . 4
Application Data Type. . . . . . . AN
Update Allowed . . . . . . . . . . Y
Identify the standard element and application field information as shown on the above panel. Press
F10 (Update) to create the table. The system retrieves the values for the Standard Minimum and
Standard Maximum Length fields based on the values in the Standard Version and Standard
Element Reference fields.
# NOTE
The version entered does not mean it is only for the version specified. This table may be used
for other versions of the standard if the characteristics of the element have not changed.
Standard Version
This required field reflects the full version code as known in the standards. (SEE the
“Standards” chapter for more information on available versions.)
Release (Number)
The Release code is only used for ‘TRADACOMS.’ Leave this field BLANK except for
‘TRADACOMS,’ which is ‘0.’
Update Allowed
This field defines whether or not the translation table may be updated. Type ‘Y’ (Yes) to
indicate that this table can be modified by the user. When moving the Translation tables
into production, you may want to set this flag to ‘N’ (No) to prevent modifications from
being made without the proper authority.
The next step is to access the Code Translation panel to begin entering application and standard
code values.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘12’ in the Option field next to Table ID ‘UNITMEAS1’ and press Enter.
The Code Translation panel (EDIX583-CTL01) is where you identify the application Codes and
their corresponding standard codes for a particular table.
Table ID . . . . . . . . . . . . . UNITMEAS1
Position to STD Code
Use the table you created in the “Offline Preparation” section of this task to enter the standard
code, application code, and standard code description as shown in the above panel.
Press F10 (Update) to update the panel and return you to the Work with Tables panel
(EDIX580-FMT01).
Offline Preparation
Before you enter Gentran:Server to create a Data Translation table, you may find it helpful to
determine the Translation Data requirements.
Internal
DUNS Number Description
Name
The first step in creating a Data Translation table is to access the Work with Transaction Mapping
panel (EDIX500-FMT01).
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘13’ (Tables) in the Option field on the key entry line and press Enter. This action displays
the Work with Tables panel (EDIX580-FMT01). Tables are independent of the maps, so it does not
matter if option 13 is specified on the key entry line or beside a map.
This panel provides you with the option for creating a new Data Translation ID. You may make the
Table ID unique by using any value you like.
Position to Table ID . . . . . . .
To create a new DUNS table to convert your DUNS number, Follow these instructions:
1. Type ‘1’ in the Option field and ‘DUNS1’ in the Table ID field on the key entry line.
2. Type ‘D’ in the Type field to indicate this is a Data Translation table and press Enter. This
action displays the Define Translation Table panel (EDIX581-FMT00).
Data Translation tables are often partner specific. The following panel allows you to tie a Table ID
to a specific partner.
Copy From
For this example, you will not identify a specific Partner ID. Press Enter to advance to the Define
Translation Table panel (EDIX581-FMT01).
In this step, you will create a Data Translation Table for the DUNS number example.
Table ID . . . . . . . . . . . . . DUNS1
Partner ID . . . . . . . . . . . .
Partner Qualifier. . . . . . . . .
Division Code. . . . . . . . . . . 000
Type . . . . . . . . . . . . . . . D
Description. . . . . . . . . . . . INTERNAL VENDOR TO DUNS CONVERSION
Standard Version . . . . . . . . . 004010
Standard Element Ref . . . . . . . 0067
Release. . . . . . . . . . . . . .
Standard Minimum Length. . . . . . 2
Standard Maximum Length. . . . . . 17
Standard Data Type . . . . . . . . ID
Application Minimum Length . . . . 9
Application Maximum Length . . . . 13
Application Data Type. . . . . . . AN
Update Allowed . . . . . . . . . . Y
Identify the standard element information and the application field information as shown on the
above panel. Press F10 (Update) to create the Data Translation table and return to the Define
Translation Table panel (EDIX581-FMT00). The system retrieves the values for the Standard
Minimum and Standard Maximum Length fields based on the values in the Standard Version and
Standard Element Reference fields. Press F12 (Cancel) to return to the Work with Tables panel
(EDIX580-FMT01).
# NOTE
The version entered does not mean it is only for the version specified. This table may be used
for other versions of the standard if the characteristics of the element have not changed.
Standard Version
This required field reflects the full version code as known in the standards. (SEE the
“Standards” chapter for more information on available versions.)
Release (Number)
The Release code is only used for ‘TRADACOMS.’ Leave this field BLANK except for
TRADACOMS, which is ‘0.’
Update Allowed
This field defines whether or not the translation table may be updated. Type ‘Y’ (Yes) to
indicate that this table can be modified by the user. When moving the Translation tables
into production, you may want to set this flag to ‘N’ (No) to prevent modifications from
being made without the proper authority.
The next step is to access the Data By Partner Translation panel (EDIX584-CTL01) to begin
entering the data values.
Position to Table ID . . . . . . .
To access the Data Translation by Partner panel, type ‘12’ (Tables) in the Option field next to the
‘DUNS1’ Table ID and press Enter.
Your application Data Translation By Partner panel (EDIX584-CTL01) is where you identify your
partner’s data values and your data values.
More...
F1=Help F5=Refresh F10=Update F12=Cancel F21=Prt Table F24=More Keys
Press F10 (Update) to update the panel and return you to the Work with Tables panel
(EDIX580-FMT01).
Offline Preparation
Before you enter Gentran:Server to create a Data Validation table, you may find it helpful to
determine what data needs to be validated.
During this task, you will create a validation table for the remittance type qualifier. The following
table lists the valid data values for the remittance type code.
SE SELLING PARTY
The first step in creating a Data Validation table is to access the Work with Transaction Mapping
panel (EDIX500-FMT01).
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘13’ (Tables) in the Option field on the key entry line and press Enter. This action displays
the Work with Tables panel (EDIX580-FMT01). Tables are independent of the maps, so it does not
matter if option 13 is specified on the key entry line or beside a map.
The following panel identifies the creation of the Data Validation table on the Work with Tables
panel (EDIX580-FMT01).
Position to Table ID . . . . . . .
1. Type ‘1’ in the Option field and ‘REMIT1’ in the Table ID field on the key entry line.
2. Type ‘V’ for Validation in the Data Type field and press Enter. This action displays the
Define Translation Table panel (EDIX581-FMT01) where the validation characteristics
will be defined.
Identify the standard element information and the application field information on the Define
Translation Table panel (EDIX581-FMT01).
Table ID . . . . . . . . . . . . . REMIT1
Partner ID . . . . . . . . . . . .
Partner Qualifier. . . . . . . . .
Division Code. . . . . . . . . . . 000
Type . . . . . . . . . . . . . . . V
Description. . . . . . . . . . . . REMITTANCE TYPE NAME QUALIFIER
Standard Version . . . . . . . . . 004010
Standard Element Ref . . . . . . . 0098
Release. . . . . . . . . . . . . .
Standard Minimum Length. . . . . . 2
Standard Maximum Length. . . . . . 3
Standard Data Type . . . . . . . . ID
Application Minimum Length . . . . 2
Application Maximum Length . . . . 2
Application Data Type. . . . . . . AN
Update Allowed . . . . . . . . . . Y
Type the information as shown on the above panel and press F10 (Update) to create the table. The
system retrieves the values for the Standard Minimum and Standard Maximum Length fields
based on the values in the Standard Version and Standard Element Reference fields.
# NOTE
The version entered does not mean it is only for the version specified. This table may be used
for other versions of the standard if the characteristics of the element have not changed.
Standard Version
This required field reflects the full version code as known in the standards. (SEE the
“Standards” chapter for more information on available versions.)
Release (Number)
The Release code is only used for ‘TRADACOMS.’ Leave this field BLANK except for
‘TRADACOMS,’ which is ‘0.’
Update Allowed
This field defines whether or not the translation table may be updated. Type ‘Y’ (Yes) to
indicate that this table can be modified by the user. When moving the Translation tables
into production, you may want to set this flag to ‘N’ (No) to prevent modifications from
being made without the proper authority.
The next step is to access the Data Validation panel (EDIX585-FMT01) to begin entering the Data
Validation fields.
Position to Table ID . . . . . . .
Type ‘12’ in the Option code next to the ‘REMIT1’ Table ID and press Enter.
The Data Validation panel (EDIX585-CTL01) is where you identify the description of the data
values. The following panel shows you the valid data values for the ‘REMIT1’ Table ID.
Table ID . . . . . . . . . . . . . REMIT1
Position to Data Value . . . . . .
More...
F1=Help F5=Refresh F10=Update F12=Cancel F21=Prt Table F24=More Keys
Create the table by typing the information as shown in the above panel and press F10 (Update) to
return you to the Work with Tables panel (EDIX580-FMT01). A message prints on the Message
Line to inform you if the update was successful.
In this task, you will copy the Table ID ‘UNITMEAS1’ into a new table called ‘UNITMEAS2.’
The following panel shows you how to copy a Translation Table using the Copy To window.
Copy To
UNITMEAS2 C
F3=Exit F12=Cancel
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Figure 6.120 Work with Tables Panel Displaying Copy To Window (EDIX580-FMT01)
1. Type ‘3’ (Copy) in the Option field next to the ‘UNITMEAS1’ Table ID and press Enter.
2. A “Copy To” window displays where you can type in the new table ID and the code for
the table. Type ‘UNITMEAS2’ and ‘C’ for Code table and press Enter.
3. Press F10 (Update) to update the new table you just created. This action will return you to
the Work with Tables panel (EDIX580-FMT01).
STOP CAUTION
The Translation table that you are copying cannot exist in the destination library.
The following panel shows how to access the Copy Code and Data panel (CEDCPY). In the
example, we will copy the ‘UNITMEAS1’ code table we created earlier.
Position to Table ID . . . . . . .
Type ‘30’ (Copy/Data) in the option field next to the appropriate Table ID and press Enter.
Next, Gentran:Server displays the Copy Code and Data panel (CEDCPY). The values from the
original table are pre-loaded into the Copy From Table ID and Table Type fields.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Type the name of the Copy From Library, Copy to Table ID and Library. At this point, you can run
the copy job one of three ways: Type ‘*YES’ to use the Job Scheduler feature, press Enter to
immediately submit the job to your queue to run, or press F10 (Additional parameters) and type
‘*YES’ for Run Interactively to run the copy job on your screen.
Copy From
Table ID
A 10-position alphanumeric field used to enter the name of the source Table ID that you
want to copy from.
Table Type
A 1-position alphabetic field used to specify whether the Table ID you are copying from
is:
“C” Code
“D” Data
“V” Validation
Library
A 10-position alphanumeric field used to specify the library in which the source Table ID
resides.
Copy To
Table ID
A 10-position alphanumeric field used to enter the name of the target Table ID that you
want to copy the application to.
Table Type
A one-position alphabetic field used to specify whether the new table is a
“C” Code
“D” Data
“V” Validation
Library
A 10-position alphanumeric field used to specify the library in which the target Table ID
will reside.
Schedule Job?
A 4-position alphabetic field used to designate whether you want to run the Table ID
program by scheduling it as a job. Default value for this field is “*NO.”
If you decide to run the copy job using the Job Scheduling feature, type ‘*YES’ in this
field. The system displays the Schedule Job panel that is used to further define the job run
for automatic queuing. You may queue and run the copy job on a periodic basis; however,
the Job Scheduling feature enables you to establish a master schedule (one-time) for the
job to automatically run on a periodic basis.
A report produced for the code translation table contains table definition information used by the
transaction mapping system to translate between your application code values and the EDI
standard codes values.
A report produced for the data translation table by partner contains the table definition
information used by the transaction mapping system to translate data between you and specified
trading partners.
A report produced for the validation translation table lists the data value descriptions used to
validate data in the transaction mapping system.
Position to Table ID . . . . . . .
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type option ‘6’ (Print) next to the map and press Enter to display the PRTTRNTBL panel.
Specify what type of translation table to print from the Print Translation Tables (PRTTRNTBL)
panel.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
If you select “D” for data translation, you may specify a Partner ID/Qualifier to print, or type
“*ALL’.
At this point, you can run the print job one of three ways: Type ‘*YES’ to run the job
interactively, press Enter to run the job in batch (default), or press F10 for additional parameters
and specify ‘*YES’ at the Schedule Job? prompt.
The first step in creating sub-split conditions is to access the Work with Sub-Splits panel
(EDIX350-FMT01).
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘14’ (Sub-Split) in the Option field next to the ‘SEMPO4010’ Transaction ID. Press Enter.
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F24=More Keys
No Records found equal to or greater than Search request.
Type the information shown on the above panel and press Enter. This action displays the
Sub-Split Table panel (EDIX351-FMT01) where you can define the values to be used for
sub-splitting.
SS (Sub-Split)
This field identifies the sub-split file. Valid values are ‘01’ through ‘80.’
Standards Version
This field reflects the full version code as known in the standards. SEE the “Standards”
chapter in this document for more information on available versions. If using X12
versions, supply the leading zeros. Remember to tag the subset code with the version you
are using, such as VICS. If you are unsure of the version, look it up in the Standards
Maintenance subsystem within online Gentran:Server (SEE the “Standards” chapter in
this document for more information).
Transaction Set/Release
This field is the actual Transaction Set ID for the document being sent or received in EDI
format. The value is specific to the standards and can be found in a Standards Manual, in
the Gentran:Server Standards Maintenance subsystem, or from your trading partner. The
Release code is only needed if the version is for TRADACOMS.
Seg 1 (Seg 2)
This is the segment Gentran:Server checks to determine if the sub-split criteria is met.
Ele 1 (Ele 2)
Gentran:Server checks the values in the fields to determine if the inbound data should be
written to the sub-split file specified in the SS (Sub-Split) field.
The Sub-Split Table panel (EDIX351-FMT01) is where you specify the criteria for a sub-split
table. It allows you to define conditions that Gentran:Server checks when sub-splitting inbound
data.
And/Or . . . . . . . . . . . . . . O
Segment 2. . . . . . . . . . . . . BEG
Element 2. . . . . . . . . . . . . 2
Operator 2 . . . . . . . . . . . . EQ
Element 2 Value. . . . . . . . . . CR
Type the information as shown on the Sub-Split Table panel and Press F10 (Update) to save the
record. You must type values in the Operator 1 and Element 1 Value fields as well as in the
And/Or, Operator 2, and Element 2 Value fields.
This action returns you to the Work with Sub-Splits panel (EDIX350-FMT01). You can press F12
(Cancel) on the latter panel to return to the Work with Transaction Mapping panel
(EDIX500-FMT01).
• LT Less than
• LE Less than or equal to
• EQ Equal to
• NE Not equal
• GT Greater than
• GE Greater than or equal to
Element 1 (2) Value
A 232-position alphanumeric field used to enter the argument of a logical expression.
And/Or
A 1-position alphabetic field used to enter either a value of ‘A’ to indicate “And,” or a
value of ‘O’ to indicate “Or,” when continuing with a compound logical expression.
Status
A 1-position alphabetic field with a description defining the status flag. This flag
designates whether the sub-split record is to be Active or Inactive for processing. The
default value is ‘A.’
STOP
CAUTION
This task should only be performed if the new map and the original map use the same
standards version. If you wish to copy a map from one version to another, you must use the
Version Compare and Conversion (VERCNVT) panel.
Copy To
810S41NEW S
F3=Exit F12=Cancel
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘3’ (Copy) in the Option field next to the map you want to copy and press Enter. This action
displays the “Copy To” window. Type the name of the new map and the appropriate send/receive
indicator and press Enter. This action displays the Transaction Map Definition panel
(EDIX503-FMT01).
Transaction ID . . . . . . . . . . 810S41NEW
Send or Receive. . . . . . . . . . S
Division . . . . . . . . . . . . . 000
Description. . . . . . . . . . . . Outbound Invoice 004010 (demo)
Standards Version. . . . . . . . . 004010
Transaction Set. . . . . . . . . . 810
Transaction Set Release. . . . . .
Transaction Status . . . . . . . . T
Use Code . . . . . . . . . . . . . P
Envelope Type. . . . . . . . . . . X
Application ID . . . . . . . . . . INVOUT
Application Selection Field Values
Update Allowed . . . . . . . . . . Y
# NOTE
The version and transaction set fields are protected when the Create by copy (option 3)
option is used because the segments contained in the map are for a different version and/or
transaction. Use the Version Conversion (VERCNVT) feature to copy a map from one
version to another. If the transaction set is different, you must copy from a map with the same
transaction set or create a new map (option 1).
STOP
CAUTION
The transaction map to be copied cannot exist in the destination library.
The following panel shows you how to access the Copy Transaction (TRNCPY) panel.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘30’ in the Option field beside the map that you wish to copy and press Enter. In this above
example, we will copy ‘810S41TPC2’ into a new library.
Next, Gentran:Server displays the Copy Transactions (TRNCPY) panel. The values from the
original map are pre-loaded into the Transaction ID and Send/Receive fields.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
STOP
CAUTION
The new Transaction ID must NOT exist. If it does, the conversion fails.
The first step in converting a map is to access the Version Compare and Conversion (VERCNVT)
panel.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘31’ (Version Cnvrt.) in the option field next to the appropriate Transaction ID and press
Enter. This action displays panel VERCNVT.
The conversion may be executed by two methods. The first method converts each segment to the
new version of the standard. The second method (copy only) copies each segment into the new
map only if it exists in the new standard. With either method, the order of the segments will not
change even though they may be different in the new standard. The elements within the segments
will be arranged to agree with the new version.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Specify the new Transaction ID and version as shown on the above panel. At this point, you can
run the job one of three ways: Type ‘*YES’ to use the Job Scheduler feature, press Enter to
immediately submit the job to your queue to run, or press F10 (Additional parameters) and type
‘*YES’ for Run Interactively to run the copy job on your screen.
A report is created that must be reviewed that identifies changes that you may need to make
manually to your new map.
The first step in synchronizing a map is to access the Mapping Synchronization (MAPSYNCH)
panel.
Bottom
Parameters or command
===>
F1=Help F3=Exit F12=Cancel F15=Sort F23=More Options F24=More Keys
Type ‘32’ (Mapping Synch) in the option field next to the appropriate Transaction ID and press
Enter. This action displays panel MAPSYNCH.
Type the name of the Transactions ID(s) and appropriate Send/Receive code(s) as shown on the
above panel and press Enter. The mapping synchronization job will immediately be queued to run.
Application Sequence
Standard Sequence
Validation
When a mapping report is produced in application sequence, the report illustrates the current
mapping status of the records and fields in your application files to/from the segments and data
elements in the EDI standards.
When a mapping report is produced in standard sequence, the report illustrates the current
mapping status of segments and segment elements in the EDI standard to/from the records and
fields in your application files.
The Mapping Validation Report lists errors detected by the system after it examines how the
elements are mapped within an outbound transaction map.
The Summary Report lists all mapping references to reserved words, user exit programs, and
mapping translation tables. The Summary Report can be generated by itself or in addition to any of
the other three report formats.
The first step in printing a transaction map is to access the Print Mapping Files (PRTMAP) panel.
Bottom
Parameters or command
===>
F1=Help F3=Exit F9=Retrieve F15=Sort F23=More Options F24=More Keys
Type option ‘6’ (Print) next to the map and press Enter. This action displays the PRTMAP panel.
The Print Mapping Files (PRTMAP) panel allows you to print the map in application, standard,
validation sequence, or in extended mapping notes. You can specify to print either inbound or
outbound maps, and qualify the detail level of the report by selecting to print all fields (elements,
for standard sequence) on the report, or just those fields (elements, for standard sequence) that
were mapped.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
The Summary Report prints all mapping references to reserved words, user exits, and translation
tables. This report can be generated by itself using *SUM for the report type or in conjunction with
any of the other three report types by specifying ‘*YES’ in the Map Summary Report Parameter.
At this point, you can run the job one of three ways: interactively (specify ‘*YES’ for Run
Interactively), in batch (press Enter, since this is the default), or schedule it to run later (press F10
for additional parameters and specify ‘*YES’ for Schedule Job?).
STOP
CAUTION
After you enter the ezEDI or ezMAP command, the system proceeds forward only through
all the associated panels. You cannot interrupt the process or back up to previous panels. Be
sure to collect all your materials and allow sufficient time before you initiate an ezEDI
command.
The ezMAP command steps you through the panels which are key to defining the “translation
map” between your system and EDI standard formats for documents.
The ezMAP command is a tool to help you define the mapping definition that
will be used during translation to convert data between an application
layout and an EDI layout. The application layout must be defined prior to
defining the map and is done via the Application Definition. The EDI layout
is defined by selecting those segments from the standards that will be sent
or received and then linked to the application by defining how the fields
are associated with the EDI elements.
The ezMAP command steps you through the panels which are essential for
defining the map (transaction definition). This includes the Transaction ID
panel, the Copy Segments panel, and the Map Segments panel.
F3=Exit
The following figure shows the rest of the ezMAP panels and the order in which they display.
Figure 6.139 Panels the system leads you through after you enter ‘ezMAP’
Reports
EBDI052 – Mapping Report – Standard Sequence
The segments and elements in your map: sorted by segment sequence number
Special Considerations
Like all other Gentran:Server reports, the Mapping Report automatically goes to the iSeries Output
Queue defined for the user running the job. (SEE the “Environment Control” chapter for
instructions to set up a user’s Output Queue.)
Application Transaction
Definition Mapping
Files Files
Standard
Codes
File
EBDI052
Mapping Report
Standard
Sequence
TRANSLATION ID: 810S41EDI SEND OR RECEIVE: S NAME: OUTBOUND INVOICE 4010 (demo) DATE 04/30/08
STANDARD VERSION: 004010 TRANSACTION SET: 810 USE CODE: P ENVELOPE TYPE: X TIME 12:00:00
APPLICATION ID: INVOUTPEDI SEND OR RECEIVE: S NAME: OUTBOUND APPLICATION 810 INT/EXT: P
Send or Receive Code that identifies whether the map is used for inbound (R) or
outbound (S) transaction translations
Transaction Set Code defined in the EDI standards that identifies the transaction set
being translated (i.e. “850” identifies a purchase order transaction set)
Use Code Code that identifies whether this map is used for general translation
(G) or for translating data for a particular group of trading partners (P)
Send or Receive Code that identifies whether the application definition is a send file (S)
or a receiving file (R)
Int(ernal)/Ext(ernal) Code that identifies whether the application file type is an externally
defined physical file (P), an internally defined physical file (I), or an
externally defined logical file (L)
Trading Partner Fields Field name in the application definition that is set up for application
partner reference
Qual(ified) Qualifier field name in the application definition that contains the
trading partner qualifier that is set up for application partner reference
H/D Code that identifies whether the Segment is a Header (H) Segment,
Detail (D) Segment, or a Summary (S) Segment
M(andatory)/ Code that identifies whether this segment is mandatory (M), optional
C(onditional) (O), conditional (C), or Float (F) Segment
Loop Loop ID
Max L(oop) Maximum number of times that a loop may be repeated in the
transaction
Write Flag Identifies whether or not that segment is to be written. It shows what
segments are being used as “dummy” mapping segments. Valid values
are ‘Yes’ or ‘No’ (outbound maps only).
R(ounding) Indicates whether or not the numeric data types are to be rounded
The application fields in your map: sorted by application record sequence number
The Segments and Elements to which the application fields are mapped
Special Considerations
Like all other Gentran:Server reports, the Mapping Report automatically goes to the iSeries Output
Queue defined for the user running the job. (SEE the “Environment Control” chapter for
instructions to set up a user’s Output Queue.)
Application Transaction
Definition Mapping
Files Files
EBDI053
Mapping Report
Application
Sequence
Send or Receive Code that identifies whether the map is used for inbound (R) or
outbound (S) transaction translations
Transaction Set Code defined in the EDI standards that identifies the transaction set
being translated (i.e. “850” identifies a purchase order transaction set)
Use Code Code that identifies whether this map is used for general translation
or for translating data for a particular group of trading partners
Send or Receive Code that identifies whether the application definition is a send file
(S) or a receiving file (R).
Int(ernal)/Ext(ernal) Code that identifies whether the application file type is an externally
defined physical file (P), an internally defined physical file (I), or an
externally defined logical file (L)
(MC) Code that identifies whether this record is mandatory (M) or optional
(O)
H/D Code that identifies whether this record is a Header (H) record, Detail
(D) record, or a Summary (S) record
Loop Loop ID
Max U(se) Maximum number of times this record may be repeated in a data
structure (i.e., the Header area, Summary area, or an application loop)
Write Flag Identifies whether or not that record is to be written. It shows which
records are being used as “dummy” mapping records. Valid values
are ‘Yes’ and ‘No’ (inbound maps only).
(MC) Code that identifies whether this record is mandatory (M) or optional
(O)
R(ounding) Indicates whether or not the numeric data types are to be rounded
All reserved words referenced in the application field values that are used in the corresponding
application (for inbound maps only)
All user exits within the map (segment and element level)
Special Considerations
Like all other Gentran:Server reports, the mapping report automatically goes to the iSeries Output
Queue defined for the user running the job. SEE the “Environment Control” chapter for
instructions on how to set up a user’s Output Queue.
TRANSLATION ID: 810S41EDI SEND OR RECEIVE: S NAME: Outbound Invoice 004010 DATE: 04/30/08
STANDARD VERSION: 004010 TRANSACTION SET: 810 USE CODE: P ENVELOPE TYPE: X TIME: 12:00:00
APPLICATION ID: INVOUTP SEND OR RECEIVE: S NAME: Invoice Outbound (Phys) Y2K INT/EXT: P
SEGMENT ELEMENT
RESERVED WORD SEG ID SEQUENCE SEQUENCE MAP CONDITION
6 - 187
Reports
Header Information
Send or Receive Code that identifies whether the map is used for inbound (R) or
outbound (S) transaction translations
Transaction Set Code defined in the EDI standards that identifies the transaction set
being translated (i.e. “850” identifies a purchase order transaction set)
Use Code Code that identifies whether this map is used for general translation
or for translating data for a particular group of trading partners
Send or Receive Code that identifies whether the application definition is a send file
(S) or a receiving file (R).
Int(ernal)/Ext(ernal) Code that identifies whether the application file type is an externally
defined physical file (P), an internally defined physical file (I), or an
externally defined logical file (L)
Reserved Word Name of the reserved word that is referenced in the map.Reserved
words are shown in the following order: Accumulators, Constants,
Hash-Totals, miscellaneous reserved words (envelope references and
others such as Current-Date) in alphabetic sequence. Tables are
shown next, followed by User Exits and Application Field Values
(for inbound maps only).
Seg ID Segment Identifier where the mapping for the reserved word is
defined. If the reserved word is mentioned on the definition
anywhere, it should be printed.
Map Element Map number for the mapping definition (from 00-99).
Condition If conditions are defined for this mapping definition. If the reserved
word is referenced in the condition, the mapping definition is
included.
Table Line
Description Description for the Table from the Table Definition Header. If the
header can’t be found in the table file, a warning message is printed.
Type Type of table: Code, Validation, or Data. If the table can’t be found in
the table file, only the 1-byte code (C, V or D) is printed.
Partner For Data tables, if the table is found in the table file, Partner specific
information (ID and Qualifier) is printed. If more than 1 data table
exists with the same name, a message is printed indicating that there
are multiple partner-specific tables.
Segment Sequence Segment sequence number where the user exit is referenced.
Element Sequence Element sequence number where the user exit is referenced (only for
element level user exits).
Map Element map number where the user exit is referenced (only for
element level user exits).
User Exit The program name that is referenced as the user exit. The level of the
user exit is printed in parentheses, either element level or segment
level.
Application Field For inbound maps, this label is printed at the end of the report if there
Values: was at least 1 reserved word referenced in the application field value
field for the corresponding application definition defined in this map.
Segment Sequence In the Segment Sequence column, the record sequence for the
reserved word mapping on the field value is printed.
Element Sequence In the Element Sequence column, the field sequence for the reserved
word mapping on the field value is printed.
Detailed segment information including the Segment ID, its Sequence number, and the
segment type
Detailed Element information including the specific Element, its element sequence number,
and description of the element within the segment that caused the error
Special Considerations
Like all other Gentran:Server reports, the Mapping Report automatically goes to the iSeries Output
Queue defined for the user running the job. (SEE the “Environment Control” chapter for
instructions to set up a user’s Output Queue.)
Standards Standards
Segment Code
File File
Transaction
Header
File
Standards Transaction
Transaction EBDI082 Segment
File File
Transaction
Element
File
Mapping
Validation
Report
EBDI082 M A P P I N G V A L I D A T I O N R E P O R T PAGE 1
TRANSLATION ID : ANSI4010P1 SEND OR RECEIVE: S NAME: ANSI 004010 OUTBOUND POS DATE 04/30/08
STANDARD VERSION: 004010 TRANSACTION SET: 850 USE CODE: G ENVELOPE TYPE: X TIME 12:00:00
APPLICATION ID : POFILE
SEG ID H/D SEG SEQ ELEM ELE SEQ DESCRIPTION MAPPING ERROR/RELATIONSHIP
6 - 193
Reports
Send or Receive Code that identifies whether the map is used for inbound (R) or
outbound (S) transaction translations
Date Date the report was printed, shown in the user’s format as defined in
the Environment Control subsystem.
Transaction Set Code defined in the EDI standards that identifies the transaction set
being translated (e.g., “850” identifies a purchase order transaction set)
Use Code Code that identifies whether this map is used for General Translation
(G) or for translating data for a particular group of trading partners (P)
H/D Code that identifies whether the segment is a header (H) segment,
detail (D) segment, float (F) segment, or a summary (S) segment
Ele(ment) Seq(uence) Sequence number of the element that caused the error
Detailed segment information including the Segment ID, its Sequence number, and the
Segment Type
Detailed Element information including the specific Element, its Element Sequence Number,
and a description of the Element
Special Considerations
Like all other Gentran:Server reports, the Mapping Report automatically goes to the iSeries Output
Queue defined for the user running the jobs. (SEE the “Environment Control” chapter for
instructions to set up an Output Queue).
TRANSLATION ID: POMAP4010 SEND OR RECEIVE: R NAME: po inb 4010 DATE 04/22/08
STANDARD VERSION: 004010 TRANSACTION SET: 850 USE CODE: P ENVELOPE TYPE: X TIME 10:44:27
APPLICATION ID: SEMPOAPPL SEND OR RECEIVE: R NAME: Class Tutorial: Inbound PO INT/EXT: L
SEG ID H/D SEG SEQ ELEM ELE SEQ DESCRIPTION MAP# NOTES
PO1 D 7600 0234 70 PRODUCT/SERVICE ID IF PO106 = 'PI' OR 'CB', TRANSLATE EDI ITEM # USING SEMDATA TABLE
Send or Receive Code that identifies whether the map is used for inbound (R) or
outbound (S) transaction translations
Date Date the report was printed, shown in the user’s format as defined in
the Environment Control subsystem.
Transaction Set Code defined in the EDI standards that identifies the transaction set
being translated (e.g., “850” identifies a purchase order transaction set)
Use Code Code that identifies whether this map is used for General Translation
(G) or for translating data for a particular group of trading partners (P)
H/D Code that identifies whether the segment is a header (H) segment,
detail (D) segment, float (F) segment, or a summary (S) segment
Ele(ment) Seq(uence) Sequence number of the element that caused the error
Code Translation Report – displays application and EDI standard code values
Data Translation Report – displays partner-specific data values and your application specific
data values
Validation Translation Report – displays data values and the descriptions of the data values.
The identifier “EBDI580” also displays in the User Data field associated with the spooled report in
the Output Queue.
Special Considerations
Like all other Gentran:Server reports, the Mapping Report automatically goes to the iSeries Output
Queue defined for the user running the job. (SEE the “Environment Control” chapter for
instructions to set up a user’s Output Queue.)
EBDI580 RUN DATE 04/30/08 CODE TRANSLATION TABLE REPORT RUN TIME 16:14:24 PAGE 1
TABLE ID: UNITMEAS1 PARTNER ID: QUAL:
TYPE: CODE DESCRIPTION: Internal t EDI U OM (tutorial 1) DIVISION: 000
STANDARD VERSION: 004010 STANDARD MIN LENGTH: 2 APPLICATION MIN LENGTH: 1
STANDARD ELEMENT REF: 0355 STANDARD MAX LENGTH: 2 APPLICATION MAX LENGTH: 4
RELEASE: 0 STANDARD DATA TYPE: ID APPLICATION DATA TYPE: AN
STANDARD APPLICATION
CODE CODE STANDARD CODE DESCRIPTION
-------------------------
6 - 199
Reports
Header Information
Partner ID/Qual Identifies a specific trading partner for which the data translation table
is valid
Standard Min(imum) Displays the minimum length of the field as defined by the Standards.
Length
Standard Max(imum) Displays the maximum length of the field as defined by the Standards
Length
Standard Data Type Identifies the data element type as defined by the standards
EBDI580 RUN DATE 04/30/08 DATA TRANSLATION TABLE RUN TIME 12:00:00 PAGE 1
REPORT
TABLE ID: DUNS PARTNER ID: QUAL:
TYPE: DATA DESCRIPTION: INTERNAL VENDOR TO DUNS CONVERSION DIVISION: 000
STANDARD VERSION: 002040 STANDARD MIN LENGTH: 2 APPLICATION MIN LENGTH: 9
STANDARD ELEMENT REF: 0067 STANDARD MAX LENGTH: 17 APPLICATION MAX LENGTH: 13
6 - 201
Reports
Header Information
Partner ID/Qual Identifies a specific trading partner for which the data translation table
is valid
Standard Min(imum) Displays the minimum length of the field as defined by the Standards.
Length
Standard Max(imum) Displays the maximum length of the field as defined by the Standards
Length
Standard Data Type Identifies the data element type as defined by the standards
6 - 203
Reports
Header Information
Partner ID/Qual Identifies a specific trading partner for which the data translation table
is valid
Standard Min(imum) Displays the minimum length of the field as defined by the Standards.
Length
Standard Max(imum) Displays the maximum length of the field as defined by the Standards
Length
Standard Data Type Identifies the data element type as defined by the standards
Common Questions
Can I copy a map from one version to another?
Yes. A mapping utility (VERCNVT) is available that allows you to migrate an existing map to a
new map for a different version. This procedure converts the map to the new version of the
standard, noting any places in the map where the automated conversion was impossible and
manual intervention is required. Segments and Elements are converted using the new version’s
format. Characteristics about elements that changed between versions, such as data types,
min/max lengths, and mandatory/optional codes are printed on the report.
Internally-described file (created using the record length parameter with multiple record types
rather than DDS).
SEE the “Mapping – Getting Started” chapter for more information on file types.
1. For inbound or outbound, Max Use MUST be equal to one for the first application record
defined to an area such as the Header area (the first Header record identifies the beginning
of a new document and can have only one per document). This is also true for the first
transaction segment in an area.
2. For inbound or outbound, Max Use MUST be equal to one for the first application record
in a loop, identified by having a Loop ID. For inbound, it means the record is written only
one time per occurrence of the incoming loop. For outbound, it means the record occurs
only once per iteration of the loop being generated.
An example is if you had one detail line item record that is used to generate a PO1 line
item loop for an 850 purchase order. The Max Use on the application record should be
one, indicating one record generates a single PO1 line item loop. Now it is possible to
have a secondary detail record with a max use of 100. For instance, the secondary record is
used to generate a single segment multiple times, such as the SDQ segment, in the
transaction within the PO1 loop. In this case, the application record occurs multiple times
for every occurrence of the line item record. If you had a situation where the first record in
the loop occurs multiple times, add a dummy segment at the beginning of the loop that has
a Max Use of one.
3. For inbound or outbound on the transaction map, only use the Max Loop on the first
segment starting the loop. Max loop is only used on the transaction side and identifies how
many iterations of a loop should be generated or will be coming in.
4. For outbound, the Loop IDs MUST MATCH between the application definition and the
transaction map. If a mismatch of a Loop ID exists between both sides, the processing is
halted immediately before any actual translation occurs. Message 673, “Transaction Loop
defined that is not in Application,” or 672, “Application Loop defined that is not in
Transaction,” is printed on the Mapping Error report indicating which side has a Loop ID
that does not exist in the other side. The information column contains the mismatched
Loop ID.
STOP
CAUTION
A Loop ID of ‘0100’ is not equal to a Loop ID of ‘b100.’ The Loop ID is a 4-byte
alphanumeric field. Likewise, a Loop ID of ‘b100’ is not the same as a Loop ID of ‘100b,’
since one has a leading blank, while the other has a trailing blank. Look closely at the Loop
IDs that are printed on the Mapping report that are in error.
The Loop IDs are used to align or match records to segments between the application and the
transaction. This alignment is done while trying to preserve multiple occurrences of the same data
structure (like the Name/Address loop structure that may occur several times for various names
and addresses).
What is the difference between Max Use and Max Loop on the
Transaction Definition?
The Max Use identifies how many times a single segment occurs while the Max Loop identifies
how many times an entire loop (multiple segments bound together by the Loop ID) occurs. Only
use the Max Loop on the first segment within the loop. Refer to the Mapping Rules in Question #4
above.
When using the SDQ, a PO1 line item segment identifies the product number and the total quantity
ordered for the entire Billto (sum of all the Shipto quantities). The SDQ then identifies each shipto
location and how much of the total quantity is sent to that specific location. The sum of all the
quantities in the SDQ’s should be equal to the quantity provided on the PO1 item segment. There
can be 10 qty/location combinations (called “buckets”) in each SDQ segment, with a total of 500
SDQ segments allowed for every PO1 line item.
There are several methods that can be used to map the SDQ segment, as detailed below:
Method 1: Use an External Physical File Matching the SDQ Segment format
Create a separate application record to contain SDQ information and format the record to mimic
the layout of the SDQ segment, which contains 10 buckets of Qty/location combinations. These
fields could be Qty1, LOC1, QTY2, LOC2, etc. Map each bucket in the SDQ to a corresponding
bucket on the application record. Each record represents a single SDQ.
Method 2: Use an Internal Physical File Containing one Bucket of information from the SDQ
Segment
Create a separate application record to contain one bucket of quantity and location information
from the SDQ segment. Copy this record in the Gentran:Server application definition to occur up
to 10 times by using a unique record type for each record (i.e., D02A, D02B, etc.). Even though
the format of each record is the same, you must have unique record names in the application
definition. For each of the 10 records, move the same record type into the record using the Field
Value, such as D02. This has the appearance after the mapping process that all D02 records were
created using the same format.
In this case, one SDQ segment generates 10 records, each of which contains only one Qty/location
combination. Map the first bucket in the SDQ segment to the first application record (i.e., D02A),
map the second bucket in the SDQ segment to the second application record (i.e., D02B), etc. Tie
the SDQ segment to all 10 records using a Loop ID (the Max Use for both must be one so the
looping occurs based on the Loop ID). You can use the Loop ID of ‘SDQ’ or the Loop ID that
exists on the SDQ segment in the transaction definition. Just make sure the Loop ID is the same for
both the segment and all 10 records (yes, each record for the SDQ must have the Loop ID entered).
If you don’t use a Loop ID, you will only get one occurrence of the SDQ mapped.
Method 3: Use an External Physical File Containing one Bucket from the SDQ Segment
Follow the Method 2 process, but use externally-described physical files instead of
multiple-record formats in the internally-described file. Create 10 physical files with unique names
(you can use the same DDS to create each one). Define each of the physical files to the application
definition and retrieve the DDS for each one (even though they are the same). The rest of the
process would be the same as Method 1.
How sectioning works and how to implement it can best be explained with an example. Please be
advised that this example is an oversimplification of a real situation, but should be sufficient to
explain the feature.
For example purposes, we are a supplier to a major automotive manufacturer (or retailer, etc.). It
has been decided that we are going to begin sending Advance Shipping Notices (ASNs) to our
trading partner. Our products are on a two day order/replenishment cycle, so it has been decided
that we will transmit one ASN at 5:00 p.m. that will describe all of the shipments that will arrive at
the manufacturer the next day. These ASNs will describe each order that is contained in each
shipment and each item that is contained in each order. Typically, two shipments with 40 orders
each are shipped to the manufacturer daily. Each of these orders contains an average of 40 items.
Our application file, that was developed specifically to support the ASN, contains the following
record types:
ASN record
This 200-character record occurs once per day and contains basic information about the ASN
to be transmitted.
Shipment record
This 80-character record occurs once for each shipment destined for the manufacturer. It
contains information such as estimated arrival, transportation mode, carrier, etc.
Order record
This 50-character record occurs once for each order that is included on each shipment. It
contains basic information relating to the original purchase order.
Item record
This 200-character record occurs once for each item that is being shipped for each order. It
contains detailed information about quantity, price, and any shortages.
ASN H 1
SHIP D HL 1
ORD D HL1 1
ITEM D HL2 1
This application structure shows that the Detail section of the document contains three records in
loops with ITEM nested underneath ORD and ORD nested underneath SHIP.
Because of the structure of the ANSI 856 transaction set (the definition of the ASN), the
transaction definition would be defined as follows:
BSN H 1
HL (Shipment) D HL 1
TD1 D HL 1
TD5 D HL 1
DTM D HL 1
FOB D HL 1
N1 D HL 1
HL (Order) D HL1 1
REF D HL1 1
DTM D HL1 1
HL (Item) D HL2 1
SN1 D HL2 1
PID D HL2 1
MEA D HL2 1
The following diagram shows the correspondence of the application records to the EDI segments:
ASN H BSN H
SHIP D HL HL D HL
(Shipment)
DTM D HL
FOB D HL
N1 D HL
HL (Order) D HL1
REF D HL1
DTM D HL1
HL (Item) D HL2
SN1 D HL2
PID D HL2
MEA D HL2
This structure for the application and transaction definition is technically correct and will produce
the desired results. One consideration, however, is that by definition one iteration of the Detail
section will consist of one SHIP record and all of the ORD and ITEM records that occur before the
next SHIP record. Our statistics indicate that we should expect an average of 40 orders with 40
items each for each shipment. This means that we would be attempting to hold one Ship record, 40
ORD records, and 1600 item records in memory prior to mapping that unit of work. A quick
calculation determines that on the average it will be necessary to store 322,080 characters. This
exceeds the capacity of the regular mappers by a factor of 10. In this situation, it is necessary to
section the application and transaction definition.
1. Go to the Application Records panel. Examine the record definitions. We want to break
the detail section down into smaller components that will be processed independently.
Sections should usually be defined working from “the top down.”
By having the SHIP, ORD, and ITEM records all defined in the Detail section, we would
have to process an average of 1641 records in each Detail unit of work. If we set up a
section break on the ORD record, then a separate unit of work would be defined that
includes only the ORD and ITEM records. This would translate into an average of 41
records or 8050 characters in the largest unit of work. By establishing this break at the
ORD record, the SHIP record will be processed by itself.
The section that includes the ORD and the ITEM records can now be processed with the
regular mapper, as long as we receive no orders with more than 160 items. If we can make
the processing more efficient by breaking the Detail section at the ORD record, it stands to
reason that it would be even more efficient to also break it at the ITEM record.
2. To actually implement sectioning: for the records that are going to be part of a new
section, change the “D” in the area column to a valid section number. Valid entries are “1”
through “9.” In this case we will leave the SHIP record in the “D” section. The ORD
record will be put in the “1” section and the ITEM record will be put in the “2” section.
There is no requirement that you must number the sections consecutively.
3. Corresponding changes must also be made to the segments in the transaction definition.
This is accomplished on the Segments panel. Simply change the “D” in the area column
for the segments that correspond to the application records that were changed. Be sure to
use the same section number that was used for the application record. When the
application and the transaction definition have been sectioned, the records to segments
correspondence will be as follows:
ASN H BSN H
SHIP D HL HL D HL
(Shipment)
DTM D HL
FOB D HL
N1 D HL
HL (Order) 1 HL1
REF 1 HL1
DTM 1 HL1
HL (Item) 2 HL2
SN1 2 HL2
PID 2 HL2
MEA 2 HL2
Please note that the only thing that changed was the Area identifier for the ORD and ITEM records
and the Area identifiers for the corresponding EDI segments.
Data can only be moved directly from a corresponding section. This is just an extension of the
original mapping rule that data cannot be moved from one area to another (i.e., you cannot
move data from the Header area directly to the Detail area). If it is necessary to have data from
one section mapped into another, it must be mapped directly in its own section, saved into a
constant or hash total, and then loaded from the constant or hash total to its ultimate
destination.
No attempt will be made to map data to a section (“1” through “9”) unless some input is
received that is in that section. This means that you cannot generate an outbound segment that
is composed of all literals, unless an input record is received that is in the corresponding
section. This could possibly be a problem for existing maps where LS and LE segments were
generated with no corresponding input.
A section must be defined by contiguous input and output. It is not permissible to define a
section “4” that has a section “5” record in the middle of it.
The following guidelines are suggestions. If any of the following cases exist processing your
inbound or outbound data, you should consider sectioning your map.
You estimate that looping structures in the Detail area of your document will cause you to
table more than 10 to 20 input records prior to processing output. This estimate is the number
of records that are between each occurrence of the first Detail record defined.
Your document contains loops nested more than two levels deep.
1. The ‘IF’ conditions, if used, are evaluated. If the conditions are true, processing continues.
If the conditions are false, the next extended map is selected for processing.
3. The element or application field loads into a work area (simple map), or the arithmetic line
is evaluated and the result moves to the work area.
4. Table operations, if used, perform using the work area generated in the previous step. If
the table operation fails, spaces move to the work area and the ‘field used’ flag is not set.
5. The work area, if used, passes to the specified user exit. The user exit can change the work
field and/or any CONSTANT, HASH-TOTAL, or ACCUMULATOR.
6. The specified HASH-TOTAL, if used, increments by the amount in the work area.
8. The work area moves to the EDI data element or application target field.
9. If the result of the mapping is spaces, the value specified in the Application Field Value
loads as a default (Inbound only).
7 Standards
In this Chapter
This chapter describes what Standards are and where they are used. Step-by-step procedures are
provided to guide you in creating or maintaining a standards version. Various tasks you can
perform with standards are described in this tutorial. This chapter contains the following sections:
Create new EDI standards for special translation requirements of a trading partner
Select specific transactions for use in data translation for one or more versions
)RECOMMENDATION
Use of the Standards Maintenance feature should be restricted to the EDI
Coordinator/System Administrator. All others should have data rights of ‘3’ for viewing the
standards.
The entire concept behind “standardization” is that the rules remain the same for all trading
partners. Alterations of public standards should be limited to agency-issued corrections and
enhancements. Creation of special versions should be limited to those situations required between
trading partners. (SEE the “Environment Control” chapter for more information on restrictions to
the Standards Maintenance feature.)
# NOTE
Sterling Commerce will issue regular modifications to the standards versions. Therefore, you
will not need to perform the Standards Maintenance to update the standard yourself, unless
you intend to use these corrections before the scheduled Gentran:Server release.
EDIX110-FMT01 Define the version and set the Select an option (1-5) and
Update Allowed flag to ‘Y’ Version ID on panel
Standards Version (Yes) EDIX100-FMT01
Type ‘EXCPGM EDIX110’ on
the command line
EDIX150-FMT01 View the Activity for a Segment Select option ‘12’ on panel
Element EDIX140-CTL01
Standards Segment
Element Activity Select option ‘14’ on panel
EDIX100-FMT01
Type ‘EXCPGM EDIX150’ on
the command line
EDIX180-CTL01 View transactions in use for a Select option ‘17’ next to the
standards version Version ID on panel
Standards EDIX100-FMT01
Transaction in Use
Type ‘EXCPGM EDIX180’ on
the command line
EDIX197-CTL01 Displays the data element codes Select option ‘11’ on panel
for a data element in your batch EDIX196-CTL01
Batch Standards standards file
Code Definition
Print Standards File Print one or more transactions Select option ‘6’ on panel
(PRTSTD) for a standards version EDIX100-FMT01
Prompt ‘PRTSTD’ on the
command line
Print Standards File Print one or more transactions Select option ‘6’ on panel
(PRTSTD120) for a standards version EDIX120-CTL01
Standard File Extract Runs program EBDI030 which Select option ‘30’ on panel
(EXTSTD) loads the selected versions and EDIX100-FMT01
transactions
Type ‘EXTSTD’ on the
command line
Print Versions/ Trans Print all or specific versions Select option ‘31’ on panel
on Tape found on a Standards tape or EDIX100-FMT01
(PRTSTDTAP) CD-ROM
Prompt ‘PRTSTDTAP’ on the
command line
Print Batch Standards Print all or specific versions Select option ‘32’ on panel
File (PRTSTDBAT) found in the batch processing EDIX100-FMT01
file
Prompt ‘PRTSTDBAT’ on the
command line
Print Transactions in Print all or specific versions Select option ‘33’ on panel
Use (PRTSTDUSE) selected in the online standards EDIX100-FMT01
file
Prompt ‘PRTSTDUSE’ on the
command line
Copy Standards Copy a standard from one Select option ‘34’ on panel
(STDCPY) library to another EDIX100-FMT01
Can also be used to copy one or Select option ‘30’ on panel
more transactions EDIX120-FMT01
Prompt ‘STDCPY’ on the
command line
# NOTE
To use the Gentran:Server for iSeries Release 3.5 Tutorials, you must add the tutorial library
(G3X5SAMP) to your library list before the Gentran:Server data library (G3X5DTA).
To access the Standards subsystem, select option ‘5’ (Work with Standards) on the Gentran:Server
for iSeries menu (GENMAIN). All tasks associated with standards will begin through this option.
The system displays the Work with Standards panel (EDIX100-FMT01). In order to complete
these tasks, you will now walk through the other panels by using the “Work with Standards” panel.
Three terms that you should be familiar with in order to use the Standards panels are:
Versions are periodic releases of an EDI standard that include updates and/or changes to the
standard.
Transactions represent document types, such as purchase orders or invoices, that are required
to effectively define the data being transmitted.
The use of the Standards panels is illustrated in the form of tasks that you may perform most
frequently with standards. This tutorial consists of five individual tasks, as follows:
Use Option codes for Quick access methods to the Standards version panels
Select transactions you will use for inbound and outbound processing
STOP CAUTION
Use caution if you create a new standards version. You should always, to the best of
your ability, use the public EDI standards. You are responsible for maintaining any
new (Proprietary) standards that you create.
Print all information for selected transactions of a specific standards version (PRTSTD)
Apply file maintenance of standards in the same manner as all other Gentran:Server system file
maintenance using ADD, UPDATE, and DELETE. The standards records, however, are critical, so
exercise extreme caution when you alter or delete them. If you modify them judiciously and with
care you will be able to stay up-to-date with standards agency releases.
You can maintain (for example, change or update) a specific version at any of the three basic levels
listed below.
Transaction
Segment
Segment Element
# NOTE
This task is intended only to illustrate how to modify an EDI standards version. Unless you
have full authority to revise, do not attempt to update information while using this tutorial.
Press Home and the arrow keys to move the cursor to the Position to Version ID field at the top of
the panel. Type ‘004010’ and press Enter. This version is positioned to the top of the list as shown
in the above figure.
Next, type ‘2’ (Revise) in the Option field next to the selected version and press Enter. The system
displays the Standards Version panel (EDIX110-FMT01) in the Revision mode.
# NOTE
To display the Standards Version panel, you can also use the key entry line to enter the values
in the Option and Version ID fields and press Enter.
Version ID . . . . . . . . . . . . 004010
Envelope Type. . . . . . . . . . . X
If the Update Allowed flag is already set to ‘Y’, press F12 (Cancel) to exit the panel and return to
the Work with Standards panel.
# NOTE
Setting the Update Allowed flag to ‘Y’ is an essential step to enable you to make updates.
However, only those users with a level ‘1’ authority to the data for the standards, as defined
in Environment Control, can modify this flag.
Type ‘11’ (Transactions) in the Option field next to the selected version on the Work with
Standards panel and press Enter. A list of all the transactions that exist for this version displays on
the Standards Transaction panel (EDIX120-CTL01).
Version ID . . . . . . . . . . . . 004010
More...
Type ‘11’ (Segments) in the Option field next to the selected transaction and press Enter. The
segments that exist for this transaction display on the Standards Segment panel
(EDIX130-CTL01).
Version ID . . . . . . . . . . . . 004010
Transaction Code . . . . . . . . . 850
Release. . . . . . . . . . . . . . 0
Position to Segment Sequence . . .
Type option, press Enter.
4=Delete 11=Seg Elements
To view a specific segment for this transaction, type ‘11’ (Seg Elements) in the Option field next to
the segment (‘BEG’) and press Enter. The system displays the Standards Segment Element panel
(EDIX140-CTL01) where you can view all the elements for this specific Segment.
Version ID . . . . . . . . . . . . 004010
Segment ID . . . . . . . . . . . . BEG
To view the definition of this element, type ‘13’ (Elem Def) in the Option field next to the first
Element (Element ID ‘0353’) and press Enter. The system displays the Standards Data Element
Definition panel (EDIX160-CTL01).
Note the value of ‘Y’ in the Ad In (Audit Indicator) field next to Element ID ‘0324.’ An Audit
Indicator of ‘Y’ means that detailed information (for example, invoice number or purchase order
number) about the segment element is passed (written) to the Doc Info field in the Audit File to
relate the actual Document Number with the Control Number used in the EDI Envelope. A
BLANK in this field means that detailed information is not passed or written to the Doc Info field
in the Audit File.
# NOTE
Only one field may be defined as the Audit Indicator for a transaction set and it must be
defined on a Header Segment.
Version ID . . . . . . . . . . . . 004010
Opt ID Description
11 0353 TRANSACTION SET PURPOSE CODE
Type ID Minimum Length 2 Maximum Length 2
Cobol Name TRANSACTION-SET-PURPO Composite Code Def
More...
The cursor is positioned into the list of all Element IDs for this version next to the Element ID that
you selected on the previous panel.
To view the codes for this Segment Element, type ‘11’ (Codes) in the Option field next to the
selected Data Element definition and press Enter.
# NOTE
Only elements of type ‘ID’ have a list of valid codes that can be used in the EDI data. The
system displays the Standards Data Element Code Definition panel (EDIX170-CTL01).
Version ID . . . . . . . . . . . . 004010
Data Element ID. . . . . . . . . . 0353
Minimum Length . . . . . . . . . . 2
Maximum Length . . . . . . . . . . 2
Composite/
Opt Code Description
70 NEW CODE
More...
F1=Help F4=Prompt F5=Refresh F10=Update F24=More Keys
+
The above figure illustrates how to view and access the Element codes. You may use the Position
to Code field to quickly locate a specific Element Code. Use Page Up and Page Down to scroll
through the list. From this panel you can press F12 (Cancel) repeatedly to return to the Work with
Standards panel.
# NOTE
The quick access method can be used for each level in a Version ID. Below is a list of the
option codes for each quick access panel:
12 = Segments
13 = Segment Elements
14 = Segment Activity
15 = Element Definition
16 = Codes
18 = Grp/Tran Dir
In this task, you will use the quick access method to view Segment Element Codes. A key panel
will allow you to identify which Version ID and Data Element ID you plan to modify or add.
STOP
CAUTION
When using the quick access method, Gentran:Server will ask you for the complete Version
ID number along with the different level ID that is applicable. Be sure that you know the
Version ID and Data Element ID you wish to modify or add. In this task, you will locate the
last Element Code ‘50 Register’ in the ‘0353’ Element ID in the ‘004010’ Version ID.
To display the Standards Data Element Code Definition panel (EDIX170-FMT00), type ‘16’
(Codes) in the Option field of the selected version and press Enter.
Version ID . . . . . . . . . . . . 004010
Data Element ID. . . . . . . . . . 0353
This key panel is shown so you can select the Data Element ID for which to see codes. To display
the Standards Data Element Code Definition panel (EDIX170-CTL01), type ‘0353’ (Transaction
Set Purpose Code) in the Data Element ID field and press Enter.
# NOTE
If the Data Element ID is not known, you can press F17 (Next Rcd) to roll into the Standards
Data Element Code Definition panel (EDIX170-CTL01) for the first Element ID defined for
the specified version.
Version ID . . . . . . . . . . . . 004010
Data Element ID. . . . . . . . . . 0353
Minimum Length . . . . . . . . . . 2
Maximum Length . . . . . . . . . . 2
Position to Code . . . . . . . . . 50
Composite/
Opt Code Description
49 ORIGINAL - NO RESPONSE NECESSARY
5C CHARGEABLE RESUBMISSION
50 REGISTER
51 HISTORICAL INQUIRY
52 RESPONSE TO HISTORICAL INQUIRY
More...
F1=Help F4=Prompt F5=Refresh F10=Update F24=More Keys
+
Enter the desired Element Code in the Position to Code field. New codes can be inserted at the end
of the list. To quickly locate the end of the Element Code list, type all “9’s” and press Enter.
If you wish to view additional Element Codes, use Page Up and Page Down to scroll through the
list. To exit, press F12 (Cancel) repeatedly to return to the Work with Standards panel.
When changes have been made to the online standards (for example, adding new online
standards, adding Element Codes).
In this task, you are asked to select several transactions that you wish to include for EDI translation
within a specific version.
Selecting the standards versions and transactions in use is the first of a two-step procedure. After
selecting the versions and transactions, execute the command ‘EXTSTD’ (option ‘30’ on the Work
with Standards panel) to rebuild the Batch Standards File (GT00TBP). The EXTSTD command
runs program EBDI030 which loads the versions and transactions you have selected. The Editor
programs use the Batch Standards File to check your EDI data for compliance to the standards.
# NOTE
The version’s Update Allowed flag must be set to a ‘Y’ before transactions can be selected.
STOP
CAUTION
This task is intended only to illustrate how one can modify an EDI standards version. Unless
you have full authority to revise, do not attempt to update information while using this
tutorial. You can, however, use the tutorials to view or print the standards.
Type ‘17’ (Tran in Use) in the Option field next to the Version ID you are using and press Enter.
(If necessary, use the Position to Version ID field to display the Version ID at the top of the list.)
The system displays the Standards Transactions in Use panel (EDIX180-CTL01).
Version ID . . . . . . . . . . . . 004010
Description. . . . . . . . . . . . ANSI VERSION 4 RELEASE 1 SUBRELEASE
Type ‘1’ (Select) next to each transaction that you are using for the specified version. Use Page Up
or Page Down to select additional transactions for this version. When you have selected all of the
necessary transactions, press Enter to update or F10 to update and exit. The system updates the
version and redisplays the Work with Standards panel. A message displays, indicating that the
record was successfully updated.
You must select all versions and transactions you are using before running the Standards Table
Extract. The Standards Table Extract replaces your current Batch Standards File with only those
versions and transactions that are selected.
Type ‘30’ (Std Table Ext) on the key entry line on the Work with Standards panel
(EDIX100-FMT01) and press Enter.
Executing the EXTSTD command reduces the size of your Batch Standards File by extracting (for
use) only the versions and transactions that you have selected in the previous steps. A smaller file
may decrease the processing time needed to compliance check your EDI data to standards.
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
If you decide to schedule the Standard File Extract job, the system displays the Schedule Job
(SCHJOB) panel, where you may set up the job run parameters. (SEE the “Job Scheduler” chapter
in the Technical Reference Guide for more information.)
Press F3 (Exit) or F12 (Cancel) at this time. If you want to submit the EXTSTD command, press
Enter. This command should be executed by the System Administrator.
# NOTE
The original version of the batch standards file, GT00TBP, will be saved and restored if the
Extract Standards job does not build the batch standards file successfully.
STOP
CAUTION
Inbound and outbound processing (PRCTRNIN and PRCTRNOUT) should not be executed
while the EXTSTD command is running.
Type ‘18’ (Grp/Tran Dir) in the Option field next to the selected version on the Work with
Standards panel (EDIX100-FMT01) and then press Enter.
Press function key F18 (Grp/Tran Dir) on the Standards Transaction panel
(EDIX120-CTL01).
Version ID . . . . . . . . . . . . 004010
More...
F1=Help F4=Prompt F10=Update F12=Cancel F18=Grp/Tran Dir F24=More Keys
Version protected. No modifications allowed.
Version ID . . . . . . . . . . . . 004010
Agency . . . . . . . . . . . . . . X
Standard Name. . . . . . . . . . . ANSI VERSION 4 RELEASE 1 SUBRELEASE 0 ASC
You can create and maintain your own versions by either building them entirely from scratch
(which may be time consuming), or by copying an existing standards version into a new version
and making modifications.
This task is intended to illustrate how to create an entire new version by copying an existing
version. Do not attempt to create or revise the standards versions during this task unless you have
the data rights of ‘1.’ Only those users with strict authority should work with the standards.
Copy To
004010NEW
F3=Exit F12=Cancel
Type ‘3’ (Copy) in the Option next to the appropriate Version ID and press Enter. We will use
Version ID ‘004010’ as the original sample Version ID that will be copied.
A ‘Copy To’ window displays on this panel, asking you the new name of the Version ID you plan
to create. Type the new standards version in this window and press Enter. The system displays the
Standards Version panel (EDIX110-FMT01).
Version ID . . . . . . . . . . . . 004010NEW
Envelope Type. . . . . . . . . . . X
The Standards Version panel displays the new Version ID and a description. Type an appropriate
description for the version you are creating on the second line of the Description field. The Update
Allowed flag must be set to ‘Y’ before the new version can be created.
To confirm the create by copy task, press F10 (Update). The system copies all records associated
with the “copy from” version to the new version. The system creates the new version and returns
you to the Work with Standards panel (EDIX100-FMT01). A message displays to inform you if
the new version has been successfully created. You can cancel this copy command by pressing
F12 (Cancel), which will return you to the Work with Standards panel.
# NOTE
You can now make whatever modifications you wish to the new standards version at one or
more levels: Transaction, Segment, and Segment Data Element. Use the procedures
described in the foregoing tasks to modify and update the records.
The creation of special versions requires both online and batch interaction. After you have made
all the changes and updated the records, inform your System Administrator/EDI Coordinator to
run the Standards File Extract program to download the specific information from the online tables
to the batch tables.
In this task, you are asked to print the ‘850’ transaction for Version ID ‘004010.’
You can print from this panel or at lower panel levels, such as the Standards Transactions panel
(EDIX120). Type ‘6’ (Print) in the Option field of the selected version and press Enter. The system
displays the Print Standards File (PRTSTD) panel.
Standards Selection:
Select a Version to Print . . > '004010' Version Id
Select Transaction for Version 850 *ALL, Transaction Id
Select Release for Transaction 0 Release Number
+ for more values
Characters per line . . . . . . 132 132 or 80
Print Segments Only? . . . . . . *NO *YES, *NO
Print Codes? . . . . . . . . . . *NO *YES, *NO
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
If the Print option was selected on the Standards panel (EDIX120), the transaction would have
been pre-loaded into the command.
To print all the transactions for this version, leave the default value of ‘*ALL’ in the Select
Transaction for Version field.
STOP
CAUTION
Using the default value of ‘*ALL’ will normally generate a very large report which will take
time to process your request. The above figure shows only the ‘850’ transaction to be
printed.
To see just a listing of the segments as they appear in the transaction, specify *YES in the Print
Segments Only parameter. Element information is omitted.
By default, the code lists for elements will not automatically print. To see the codes for all
elements, specify *YES for the Print Codes parameter.
In this task, you are asked to print all the standards on a tape for all versions. You will specify that
the report print the information at the version and transaction levels of detail.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
Type the name of the tape or CD drive where the standards media is located in the Device field.
Type ‘*ALL’ for the standards type to be printed in the Standard Type field.
Type ‘*TRAN’ in the Detail Level field to get a listing of all transactions for a specific version. To
obtain a list of all versions on the media, type ‘*VER’ in the Detail Level field.
# NOTE
If the value ‘*TRAN’ is entered for Detail Level, the field ‘Version IDs to Print’ is shown
along with the prompt ‘+ for more values’. Enter up to ten specific version IDs to print or
specify *ALL.
STOP
CAUTION
Selecting transactions for all version types normally generates a very large report, which
takes time to process.
In this task, you are asked to print all of the standard versions from the Batch Standards File. You
will specify that the report print the information at the transaction level of detail, and not to list
elements that affect the Audit Indicator.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
For the parameter Standards Library, enter either the name of the library that contains the
standards, or the value ‘*LIBL’, which searches your interactive library list for the Batch
Standards File (GT00TBP).
# NOTE
The ‘Version IDs to Print’ field and prompt ‘+ for more values’ display.
Type ‘*ALL’ in the Version IDs to Print field. To specify specific versions, enter up to ten versions
in the Version IDs to Print field.
Accept the default values (‘*NO’) for the Run Interactively, Schedule Job, and Print Audit
Indicators fields. To generate a list of elements for each version that affects the Doc Info field in
the Audit File, type ‘*YES’ in the Print Audit Indicators field.
In this task, you are asked to print all the standard versions selected through the ‘Transactions in
Use’ feature for inclusion in the Batch Standards File.
Step 2: Select Print Criteria for the Print Transactions in Use Report
The following figure shows the PRTSTDUSE panel that allows you to specify what information
you plan to print.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
For the parameter Standards Library, enter either the name of the library that contains the
standards, or the value ‘*LIBL’, which will search your interactive library list for the set of
Standards Files (STD*).
Type ‘*ALL’ for all versions in the Version IDs to Print field. To specify specific versions, enter up
to ten versions in the Version IDs to Print field.
This task is intended to be an illustration of how to copy a version. Do not attempt to copy the
standards versions during this task unless you have the data rights of ‘1.’ Only those users with
strict authority should work with the standards.
# NOTE
The Copy Standards command (STDCPY) can also be accessed by selecting option ‘30’
(Copy Transaction) on the Standards Transaction panel (EDIX120-CTL01).
Bottom
F3=Exit F4=Prompt F5=Refresh F10=Additional parameters F12=Cancel
F13=How to use this display F24=More keys
Field Descriptions
Version
The Version field will be filled in with the version selected in the previous step.
Transactions
If you want to copy one transaction from the version to the new library, enter the name in
the first Transaction field. To copy additional individual transactions, type ‘+’ to see more
entry fields. To copy all transactions from this version, type *ALL in the first Transaction
field.
From Library
Enter the name of the library where the source version resides.
To Library
Enter the name of the library where the version and its transactions are to be copied.
The version to be copied must exist in the source (copy from) files, and may exist in the
target (copy to) files. If the version exists in the target files, you must use the *REPLACE
option to replace the records in the target files with the records in the source files. If the
version does not exist in the target files, use the *ADD option.
Create Files?
Tells Gentran:Server if the standards files must be created in the target library before
copying the source version into the target files. If the files already exist in the target
library, type *NO in this field, otherwise type *YES.
Schedule Job?
This alphanumeric field is used to designate if you want to run this option by scheduling it
as a job. *NO is the default for this field.
If you want to run the job using the Job Scheduling feature, type *YES. The system
displays the Schedule Job panel used to further define the job run parameters. You can
queue and run the job on a periodic basis, or on a one-time only basis. The scheduling
feature also enables you to establish a master schedule (one-time) for the job to run on a
periodic basis.
Run Interactively?
This parameter allows you to perform the process interactively (immediately). If you
select to run the command in an interactive mode (*YES), you can monitor system
messages that occur during processing.You are, however, locked out of the system on the
terminal that you used to submit the job until the process is completed.
Additional Parameters
Bottom
F3=Exit F4=Prompt F5=Refresh F12=Cancel F13=How to use this display
F24=More keys
For the parameter Group or Trans, enter either ‘*GROUP’ to print it in functional group order or
‘*TRAN’ to print it in transaction order.
In addition, you can also access the Print Group/Transaction Directory panel (PRTGRPTRN) from
the Group/Transaction Directory panel (EDIX125-CTL01), and then press function key F21 (Prt
Grp/Tran).
Version ID . . . . . . . . . . . . 004010
Agency . . . . . . . . . . . . . . X
Standard Name. . . . . . . . . . . ANSI VERSION 4 RELEASE 1 SUBRELEASE 0 ASC
A ‘Print by’ window displays on this panel. To print the report sorted by the transaction code, enter
‘1’ next to the Transaction Code. Enter ‘1’ next to the Functional Group to print it in functional
group order. Press Enter to submit the print job to batch..
Version ID . . . . . . . . . . . . 004010
Agency . . . . . . . . . . . . . . X
Standard Name. . . . . . . . . . . ANSI VERSION 4 RELEASE 1 SUBRELEASE 0 ASC
# NOTE
The Work with Batch Standards panel (EDIX190) can also be accessed by typing ‘EXCPGM
EDIX190’ from an iSeries command line.
Position to Version ID . . . . . .
The system displays the Work with Batch Standards File (EDIX190-FMT01).
The following figure shows the Work with Batch Standards panel (EDIX190-FMT01) as it
displays the Version IDs along with applicable option codes.
Press Home and the arrow keys to move the cursor to the Position to Version ID field at the top of
the panel. Type the version that you want to position to and press Enter. This version is positioned
to the top of the list.
# NOTE
Your view will look different because it will only list those versions that are found in your
batch standards file.
Next, type ‘11’ (Transactions) in the Option field next to the selected version and press Enter. The
system displays the Batch Standards Transactions panel (EDIX191- CTL01)..
Version ID . . . . . . . . . . . . 004010
A list of all the transactions that were selected for the batch standards extract for that particular
version is displayed.
Version ID . . . . . . . . . . . . 004010
Transaction Code . . . . . . . . . 810
Release. . . . . . . . . . . . . . 0
Position to Segment Sequence . . . ___
Type option, press Enter.
11=Seg Elements
F1=Help F12=Cancel
Version ID . . . . . . . . . . . . 004010
Segment ID . . . . . . . . . . . . BIG
F1=Help F12=Cancel
# NOTE
The only items that have conditional codes are those that have a ‘Y’ in Cd column on the
Batch Standards Segment Element panel (EDIX193-CTL01).
Version ID . . . . . . . . . . . . 004010
Segment ID . . . . . . . . . . . . CUR
Sequence . . . . . . . . . . . . . 8
Description. . . . . . . . . . . . DATE
Mandatory Element. . . . . . . . . O
Data Element ID. . . . . . . . . . 0373
Audit Id Indicator . . . . . . . .
Conditional Area
Code 1 C Code 2 08 Code 3 07 Code 4 Code 5
Code 6 Code 7 Code 8 Code 9 Code 10
Code 11 Code 12 Code 13 Code 14 Code 15
F1=Help F12=Cancel
Version ID . . . . . . . . . . . . 004010
Transaction. . . . . . . . . . . . 810
Segment ID . . . . . . . . . . . . BIG
Position in Trans. . . . . . . . . 1
Position in Segment. . . . . . . . 1
Element ID . . . . . . . . . . . . 0373
Element Description. . . . . . . . DATE
Activity Description . . . . . . . SET COUNTERS TO ZERO
Action . . . . . . . . . . . . . . V V
Number . . . . . . . . . . . . . . 04 05
Constant . . . . . . . . . . . . .
Element Compare1 . . . . . . . . .
Element Compare2 . . . . . . . . .
Element Compare3 . . . . . . . . .
Store Element Req. . . . . . . . .
Version ID . . . . . . . . . . . . 004010
Opt ID Description
__ 0373 DATE
Type DT Minimum Length 8 Maximum Length 8
Cobol Name DATE Composite Code Def
More...
F1=Help F12=Cancel
A list of all the element definitions for the selected version found in the batch standards file will be
displayed.
Type ‘18’ (Grp/Tran Dir) in the Option field next to the selected version on the Work with
Standards panel (EDIX190-FMT01) and then press Enter.
Press function key F18 (Grp/Tran Dir) on the Standards Transaction panel (EDIX191-CTL01).
Version ID . . . . . . . . . . . . 004010
More...
F1=Help F12=Cancel F18=Grp/Tran Dir
Version ID . . . . . . . . . . . . 004010
Agency . . . . . . . . . . . . . . X
Standard Name. . . . . . . . . . . ANSI VERSION 4 RELEASE 1 SUBRELEASE 0 ASC
Reports
EBDI036 – Gentran Standards Report
Select option ‘6’ (Print) on the Work with Standards panel (EDIX100) and enter the
appropriate information on the Print Standards File (PRTSTD) panel.
Select option ‘6’ (Print) on the Standards Transaction panel (EDIX120) and enter the
appropriate information on the Print Standards File (PRTSTD120) panel.
Select F21 (Prt Std) on the Standards Segment panel (EDIX130) and enter the appropriate
information on the Print Standards File (PRTSTD) panel.
Prompt the command ‘PRTSTD’ or ‘PRTSTD120’ on the command line to access the
command panel.
When the Characters Per Line parameter is 132, the EBDI036 Standards report is printed. When it
is 80, the EBDI036B report is printed.
The following figure illustrates the EBDI036 report and the files that are accessed by the program.
Standard Standard
Version Transaction Standard
File File Segment
File
Standard Standard
Activity
File Element
File
EBDI036
Standard or
Standard
Dictionary EBDI036B Code
File File
Temporary
Reference
File Output
Report
File
EBDI036 RUN DATE 04/30/08 GENTRAN STANDARDS REPORT RUN TIME 10:04:48 PAGE 1
DOCUMENTS FOR VERSION: 004010
VERSION: 004010 ANSI VERSION 4 RELEASE 1 SUBRELEASE 0 ASC X12
FUNC NTE NO. OF
DOCUMENT GROUP RLSE DESCRIPTION FLOAT SEGMENTS
-------- ------ ---- ------------------------------------------------------------ ----- --------
850 PO 0 PURCHASE ORDER 00194
7 - 57
7 - 58
EBDI036 RUN DATE 04/30/08 GENTRAN STANDARDS REPORT RUN TIME 12:00:00 PAGE 7
ELEMENTS FOR SEGMENT
VERSION : 004010 RLSE: 0
Standards
EBDI036 RUN DATE 04/30/08 GENTRAN STANDARDS REPORT RUN TIME 10:04:48 PAGE 2
SEGMENTS FOR DOCUMENT: 850
VERSION : 004010 RLSE: 0
DOCUMENT : 850 PURCHASE ORDER
FUNC GRP : PO NO OF SEG: 00194
SEGMENT MAN. MAX MAX ELE LOOP LOOP ACT
SEQ ID TYPE REQ CODE USE LOOPS CNT ID B/E CNT DESCRIPTION
--- --- ---- --- ---- ------ ------ --- ---- ---- --- ---------------------------------------------------
001 BEG H M 000001 000000 012 001 BEGINNING SEGMENT FOR PURCHASE ORDER
002 CUR H O 000001 000000 021 000 CURRENCY
003 REF H O 999999 000000 009 000 REFERENCE IDENTIFICATION
004 PER H O 000003 000000 009 000 ADMINISTRATIVE COMMUNICATIONS CONTACT
005 TAX H O 999999 000000 013 000 TAX REFERENCE
006 FOB H O 999999 000000 009 000 F.O.B. RELATED INSTRUCTIONS
007 CTP H O 999999 000000 025 000 PRICING INFORMATION
008 PAM H O 000010 000000 029 000 PERIOD AMOUNT
009 CSH H O 000005 000000 010 000 SALES REQUIREMENTS
010 TC2 H O 999999 000000 002 000 COMMODITY
011 SAC H O 000001 000025 016 1000 B 000 SERVICE, PROMOTION, ALLOWANCE, OR CHARGE INFORMATIO
012 CUR H O 000001 000000 021 1000 E 000 CURRENCY
7 - 59
Standards Reports
Nte (Note) Float Indicates if the Note Segment is permitted to be outside of a defined
sequence in the transaction (to float). A BLANK means the Note
Segment is not in the transaction.
Type Indicates the area of the transaction the Segment resides in.
Max Loops Maximum number of times the loop is allowed to occur at that specific
location in the transaction.
Loop B/E Indicates if the Segment is the beginning or ending Segment in a loop.
Act(ivity) C(ou)nt Number of Element Activity records associated with the Segment.
Seg(ment) Displays the sequence number of the Element within the Segment.
Seq(uence)
Aud(it) Ind(icator) Displays the Audit Indicator which explains if detailed information
about the Segment Element is written to the Doc Info field in the Audit
file.
Ele(ment) ID Displays the dictionary reference number for the specific Data Element
record.
Cde (Code) Val(ue) Indicates whether or not Element Codes are on the Code file
Composite/Code Identifies the part of the defined Data Element Code (Composite),
followed by a space and then the alphanumeric field used to define the
Composite value (Code)
Select option ‘36’ (Prt Grp/Tran) on the Work with Standards panel (EDIX100) and enter the
appropriate information on the Print Group/Transaction Dir (PRTGRPTRN) panel.
Select option ‘33’ (Prt Grp/Tran) on the Work with Batch Standards File (EDIX190) and enter
the appropriate information on the Print Group/Transaction Dir (PRTGRPTRN) panel.
Press F21 (Prt Grp/Tran) on the Group/Transaction Directory panel (EDIX125) and select to
print by Transaction Code or by Functional Group.
Press F21 (Prt Grp/Tran) on the Group/Transaction Directory panel (EDIX198) and select to
print by Transaction Code or by Functional Group.
Enter the command ‘PRTGRPTRAN’ on the command line to access the command panel.
Common Questions
How do I add an Element Code?
The first step is to change the Update Allowed flag to ‘Y’ on the Standards Version panel
(EDIX110-FMT01). This will allow changes to be made to the Version ID. Next, access the
Standards Data Element Code Definition panel.
The Data Element Code Definition panel (EDIX170-CTL01), shown below, enables you to add,
display, delete and change the definition for the description of code values for individual data
elements.
Version ID . . . . . . . . . . . . 004010NEW
Data Element ID. . . . . . . . . . 0353
Minimum Length . . . . . . . . . . 2
Maximum Length . . . . . . . . . . 2
Composite/
Opt Code Description
70 NEW CODE
More...
F1=Help F4=Prompt F5=Refresh F10=Update F24=More Keys
In order to add a new code, position your cursor on a blank line or type all “9’s” in the Position To
field and press Enter. This takes you to the end of the list of Element Codes.
Type ‘70’ and ‘New Code’ in the Composite/Code and Description fields. Press F10 (Update) or
Enter to add the code.
STOP
CAUTION
After the Data Element Code is added, review the selected Transactions In Use and run the
‘EXTSTD’ command to rebuild the Batch Standards File.
The Inbound (EBDI001) and Outbound (EDBI002) Editor programs use activity records to add or
compare the current Element contents with the total of some prior Element contents. For example,
if processing an ‘850’ transaction, the number of line items (CTT01) is the accumulation of the
number of PO1 Segments. If the contents of (CTT01) from the EDI data you are processing do not
equal the value accumulated by the Editor, you get an error.
The example below uses the quick access method, where option ‘14’ is selected to retrieve the
Segment Activity.
Select option ‘14’ (Seg Activity) on the Work with Standards panel (EDIX100-FMT01) and press
Enter.
Type ‘5’ in the Option field for the version accessed and enter as much other key field information
that you know for the activity record you want to access. Press F17 (Next Rcd) to roll forward into
the first activity record found for the version, transaction, and segment entered. The system
displays the Element Activity panel (EDIX-FMT01) in view mode.
# NOTE
The activity records can also be accessed from the Standards Segment Element panel
(EDIX140-FMT01) by using option ‘12’ beside an element.
You can use F16 (Prev Rcd) and F17 (Next Rcd) to roll into the transactions that have
Segment Element Activity.
Version ID . . . . . . . . . . . . 004010
Transaction. . . . . . . . . . . . 850
Segment ID . . . . . . . . . . . . BEG
Position in Trans. . . . . . . . . 1
Position in Segment. . . . . . . . 1
Element ID . . . . . . . . . . . . 0353
Element Description. . . . . . . . TRANSACTION SET PURPOSE CODE
Activity Description . . . . . . . VERIFY COUNTERS (SET TO ZERO)
Action . . . . . . . . . . . . . . V V
Number . . . . . . . . . . . . . . 04 05
Constant . . . . . . . . . . . . .
Element Compare1 . . . . . . . . .
Element Compare2 . . . . . . . . .
Element Compare3 . . . . . . . . .
Store Element Req. . . . . . . . .
Last Update Date . . . . . . . . . 04/30/08
Last Update User . . . . . . . . . EDI
The Accumulation Activity has already been defined for each version of each standard.
The versions are based upon the syntax version specified in the incoming EDIFACT interchange
received. When a version already exists in the standards file for a different envelope type, such as
X12, a custom version is used. In this case, version conversion is not necessary, as Gentran will
automatically override the version to the UN/EDIFACT version. Use the following table as a
guideline.
1 002001 002001UN
2 002002 002002UN
3 and higher D3 D3
Glossary
Definition of Terms
Acknowledgment
An acknowledgment is a special Transaction set (997, 999, or CONTRL) that is transmitted to the
original sender to indicate the status of the transmission with respect to standards adherence. It
does not imply acceptance of the contents of the associated Transaction sets.
Acknowledgments are also known as Functional Acknowledgments (the 997 Transaction set),
Accept/Reject Advices (the 999 Transaction set), and Syntax and Service Report Messages (the
CONTRL message).
Acknowledgment Reconciliation
The primary purpose for using the Audit file is to verify the documents you sent have been
received by your Trading Partner. The Functional Acknowledgment is sent by your Partner to
indicate it had been received and if there were any compliance errors. When you receive the
Acknowledgment, it must be processed INBOUND (PRCTRNIN). The acknowledgments do not
have to be mapped, though. The reconciliation is performed by the Inbound Editor by posting a
status flag on the original EDI document sent and the date of the acknowledgment.
Addressing Methods
Addressing methods are means of identifying the sender and intended receiver of incoming EDI
messages. The Gentran:Server support of several addressing methods allow you to configure the
system to your current technique or your industry’s preferences.
Application
An in-house program designed to process specific jobs. This program is formatted by the customer
for their business needs. (Example, payroll.)
Application Definition
The definition of the application interface file used during the mapping process.
Application File
A file, or set of files, containing application data destined to be sent out through EDI to specific
Trading Partners or that has been received through EDI and translated to the application format
from specific Trading Partners.
An internal file to Gentran is a “flat file” that contains multiple record types and is typically
defined within each program that it is used in. It has a field that contains the record format in
each record of the file.
A logical file to be used in Gentran must be a multi-format logical file. Logical files are
typically used for outbound documents. By using logical files for outbound documents, you
can select specific records based on some indicator field in the file if only certain records are
to be processed through EDI. Only one logical file can be defined to an application definition.
A physical file is a file that has been created external to Gentran using DDS. Multiple physical
files can be used within an application definition. An example application definition might
have four physical files: a header file, a comments file, a detail file, and a summary file.
Another application may only contain a header file and a detail file. For outbound
applications, physical files must be keyed or your fields need to be identified to Gentran as the
fields that should be used by Gentran for key fields for the logical file that Gentran builds over
your physical files during outbound processing. There is no requirement for key fields for
Inbound Processing.
Application ID
A user-defined identifier indicating the source or destination of documents, typically used in
reporting and routing of inbound documents.
Archive
A permanent record of messages transmitted or received.
Audit Indicator
Field on the Standards Segment Element panel (EDIX140-CTl01). An Audit Indicator of ‘Y’
means that detailed information (e.g., invoice number or purchase order number) about the
segment element is passed (i.e., written) to the Doc Info field in the Audit File to relate the actual
Document Number with the Control Number used in the EDI Envelope. A BLANK in this field
means that detailed information is not passed or written to the Doc Info field in the Audit File.
Batch Processing
A type of data processing operation and data communications transmission where related
transactions are grouped together and transmitted for processing. Usually by the same computer
and under the same application; generally regarded as non-real time data traffic consisting of large
files; type of data traffic where network response time is not critical; compare with interactive
(processing).
Captive
A captive panel automatically displays based on the values you entered on a previous panel. You
can tell whether a new panel has displayed by checking the program name and format name, which
are unique identifiers located on the upper left corner of the panel.
Comm Profile ID
The identifier under which communications information is stored. All protocol information about
how communication sessions will be performed with this entity, whether it be a Third Party
Network or a Direct-connect, is also stored under this identifier. The inbound and outbound EDI
data is stored in Queue files under the Comm Profile ID so that when a communication session is
established with this entity, all data under this identifier will be picked up and sent to them and any
data received will be stored under this identifier.
COMMERCE:Network
Sterling Commerce’s Value-Added-Network (VAN).
Compliance Errors
These are errors encountered while editing the EDI data against the Standards. They are syntax
errors that relate specifically to the Standards, such as 'Missing Mandatory Segment'. These
compliance errors are reported on the Editor Error Report for Inbound and Outbound Processing.
Compression
An automated process where data is compressed and wrapped by removing trailing blanks and
spaces from segments, groups, and/or transactions. Data compression reduces data field
information to its minimum (for cost effectiveness). This is controlled by Gentran global
parameters.
Concurrent Processing
In Gentran:Server for iSeries Release 3.5, concurrent processing enables you to run multiple
processes at the same time over a single Gentran data library. For example, you can run an inbound
processing job and an outbound processing job at the same time, or run two separate inbound
processes at once.
Control Numbers
These are assigned by the sender for the purpose of identifying documents and transmissions, and
to facilitate sequence checking by the receiver. Control numbers are maintained at three levels: the
Transmission or Interchange, the Functional Group, and the Transaction Set.
Data Dictionary
A document that describes the attributes of all data elements within a standard.
Data Element
The smallest named item in a segment that can convey data. For example, “Bill To City” is one
data element within a segment.
Data Separation
This is commonly referred to as Splitting. It is the process during Inbound Translation that occurs
to separate the edited EDI data by Application types prior to the mapping process. EDI data that is
received may be from many different Partners and may contain several different types of
documents. It is much more efficient to sort the data by Application type before mapping the EDI
data into the Application formats.
Decompression
An automated process to decompress or “unwrap” data received by re-inserting trailing blanks and
spaces. This occurs during the inbound editing process.
Delimiters
Delimiters are special characters used to separate and mark the end of segments and the beginning
of data elements. Two characters are required (one is used to separate data elements, the other to
separate segments) and, when used as delimiters, the characters may not be used within the data
itself. A third delimiter is used in EDIFACT messages to separate subelements. Delimiters are
dynamically defined by the Interchange Envelope.
Doc Info
The Doc Info field on the Work with Audit Transaction Status panel (EDIX253-FMT01) contains
the actual data from the transaction that identifies the document reference number. (SEE also
‘Audit Indicator.’)
Dummy Record
This record is used for the purpose of mapping, but it is not actually written out. Records defined
for inbound processing that have the Write Flag set to 'N', will not be written and are, therefore,
called Dummy Records.
Dummy Segment
This segment is used for the purpose of mapping, but is not actually written out. Segments defined
for Outbound processing that have the Write Flag set to 'N', will not be written and are, therefore,
called Dummy Segments.
EDI Coordinator
A person assigned to coordinate EDI functions for an organization. As EDI and EC (Electronic
Commerce) continue to grow at a rapid pace, the role of the Coordinator is dynamically changing.
Many Coordinators are asked to fill a complex role of being a business analyst, technical wizard,
and liaison to the trading partner, while performing daily audits and controls.
The EDI Coordinator is responsible for the setup of partners, maps, daily processing,
communications, and acknowledgment reconciliation.
Editor
The Inbound Editor uses pre-determined instructions to verify, check, and possibly reject the EDI
standard data you have received from a Trading Partner, and moves the edited data to split files
and then to the appropriate inbound application files via Mapping.
The Outbound Editor prepares your data for transmission to your Trading Partners. Outbound
processing translates your application data to the chosen EDI standard being used, and checks all
data to ensure compliance with the selected public standard.
Element
A unit of information with specific edit and length characteristics. This represents the smallest unit
of information in the Standard. Also called a data element.
Element Separator
A syntax character used to separate data elements within a segment. Also referred to as a
“delimiter.”
Envelope
The transmission header and trailer enclosing an EDI message. This is automatically generated by
Gentran:Server using the information on the Partner file.
Environment Profile
The environment profile is a subset of the Gentran:Server user's profile that contains parameters
specific to the environment in which the user runs Gentran:Server. These parameters include the
data formats, language ID, and division code used for the online file maintenance panels as well
as the following batch processing options: job description, job queue, message queue, output
queue, print device, and print file.
The program and data libraries are used only when files are requested to be created without a target
library. They are defaulted from the libraries defined during installation of Gentran:Server.
EOT
End of Transmission
Error Rejection
During the Compliance Checking process performed by the Editors, if an error is encountered that
identifies that the data does not conform to the Standards, a message is printed on the Editor report.
In addition, if Rejection has been established for this particular error number, for the Partner, for
the Document, and for the Direction, the data is marked as rejected. If inbound, the rejected data is
placed in the Reject file by the Splitter program. If outbound, the rejected data is placed in the
Outbound Queue under the Comm Profile ID for the Partner with a status of ‘QE’ for Queued with
Errors.
Error Processing
The process of reporting error messages on the Mapper and Editor reports during Translation
Processing.
Field
The smallest item of information in a record.
Function
In Gentran:Server, a function refers to a program or command under a subsystem that can be
secured individually in the Environment Control subsystem.
Functional Acknowledgment
A special transaction set transmitted by a receiver as an affirmative response to the sender. This is
automatically generated and reconciled by Gentran:Server based upon the Trading Partner
configuration.
Gentran:Server
Gentran:Server is EDI translation and communications software for the IBM iSeries. It acts as an
interface between your in-house applications and the EDI standards.
Gentran:Viewpoint
Gentran:Viewpoint allows you to selectively track business documents: for example, an individual
purchase order, invoice, or acknowledgment. It gives you the ability to see where your business
documents are within the EDI system.
Gentran:Viewpoint is an “add on” system for Gentran:Server for iSeries Release 3.5; that is, you
must be using Gentran:Server to use this product.
Global Parameters
The switches that affect the Editing function during Translation. Typically they identify whether a
feature should be performed for all Partners in the same manner or whether it should be performed
on a partner-by-partner basis by looking at the Partner parameters. One feature in the Global
Parameters is whether acknowledgments should be created for all Partners or on a
partner-by-partner basis.
Header
The portion of the message that precedes the actual body and trailer of the business transaction.
In-house Interface
Routine(s) developed by application personnel that connect Application systems to
Gentran:Server. These routines either create Application Interface files for outbound transactions
or process an Application Interface file containing inbound transactions.
Job Description
A set of characteristics that are used by the iSeries to process a job. Attributes specified in the job
description instruct the system to run the job the way you want. All jobs started on the iSeries must
have an associated job description. Gentran:Server uses the job description defined in the
Environment Control subsystem for each user.
Job Log
A log or record of requests (such as commands) submitted to the system by a job. This is specific
to the iSeries. Messages related to the requests and the actions performed by the system for the job
are also recorded in this log. All jobs have a job log associated with them. Batch jobs produce job
logs in a spool file. Interactive jobs have job logs that can be seen by using the System Request
function. To generate a job log from an interactive session, sign off the iSeries with the option,
*LIST. This is an important report that can be used in conjunction with the Gentran:Server reports
to manage your EDI processing.
Job Queue
A staging area for jobs that have been grouped together and are waiting their turn to run. This is
specific to the iSeries. When a job is submitted to run, it is submitted to a job queue. Typically, job
queues have a FIFO (first in, first out) method of processing. However, there is a priority assigned
to the job that ranks the jobs in the queue to determine which job will run next. If jobs have the
same priority level, the first job in the queue will run first. Job queues are holding areas for the
jobs until there is room in the iSeries subsystem to actually run the job. The job queue is
designated in the Job Description, which is defined in the Environment Control subsystem.
Loop
Loops are used in situations where multiple EDI segments (more than one) exist that occur
together more than one time. In order to evaluate the information, all the segments need to be
evaluated together. It is the group of multiple segments that occur repeatedly. A common loop is
the N1 loop that contains Name and Address information.
Loop ID
This is the identifier used in Gentran:Server to tie all the segments together to produce a Loop.
This loop ID can also exist on the Application records to identify a single record or group of
records that is associated with the loop on the EDI side.
Mandatory
A statement that a segment, data element or component data element must be used.
Map
A set of instructions detailing the correspondence between the EDI message standard and your
Application Transaction. The Data Map is also used to document your applications’ use of EDI
and document your data requirements for your Partners.
Mapping
Map processing uses user-defined maps to translate business documents from the in-house data
format to the selected EDI standard or from EDI standard to internal format. Maps are defined
using the online Mapping Integration system. When data is created by the user’s application
program and processing is initiated, the system selects the proper map, based on partner
definitions, and translates the data into the EDI standard format.
Mapper
The Inbound Mapper translates EDI data received from your Partner into your Application format
based on instructions you created. The instructions are stored in the Transaction Definition in the
mapping subsystem.
The Outbound Mapper translates your Application data into the specified EDI format based on
instructions you created. The instructions are stored in the Transaction Definition in the mapping
subsystem.
Map
The “map” is the definition of instructions for moving data between the EDI format and the
Application format. It is also known as the Transaction Definition. To perform the “task of
mapping” means to create the definition of how to move the data between elements and fields.
Max Loop
This is the number of times a Loop can occur on the EDI side. If the N1 loop contains Name and
Address information, the Max Loop value would identify how many different Name and Address
loops can occur.
Max Use
The number of times a segment or record can occur. If this value is more than one, the segment or
record would be read or written multiple times before the next segment or record.
Message
An identified and structured set of data elements and segments covering the requirements for a
specific transaction. Also known as a “document” or transaction set.
Network
A network is a Third Party EDI Network (EDI mailbox). Networks are defined to Gentran:Server
for the purposes of collecting and routing messages. These are commonly referred to as VANs
(Value Added Networks).
No-Write Flag
The name given to the Write Flag when it is set to ‘N’. See “Write Flag.”
Parm
This term is another name for a parameter. There are several places where parameters exist: there
are Partner parameters that are used by the entire system for a particular Trading Partner. There are
Global Parameters that are used by the entire system for ALL Trading Partners. Command
Parameters are specific to a process such as Inbound Translation (PRCTRNIN).
Partner
The Partner is commonly known as the Trading Partner and is someone with whom you are trading
EDI documents.
Partner ID
The Partner ID is the identifier used in the Partner file under which information is stored that is
necessary to trade EDI documents via Gentran:Server. This identifier can be an internal identifier
for how you know them in your Applications such as a customer or vendor number, or it can be a
descriptive identifier such as a company name, or it can be an EDI-specific identifier such as a
DUNS number or communications phone number.
Partner Profile
The Partner Profile refers to all of the information that is stored under the Partner ID. This
information includes what EDI documents are being traded, what values should be loaded into the
envelopes when sending data outbound, error rejection rules, and FYI comments.
Rejection
See “Error Rejection.”
Security Officer
A person assigned to control all of the security authorizations provided with an iSeries system. The
Security Officer (QSECOFR) can create iSeries user profiles, grant and revoke authorities for any
system object, and execute any command with full authority.
The Gentran:Server Environment Control subsystem supplies the User ID, QSECOFR, which can
be accessed by the Security Officer to create and maintain additional user profiles for Gentran.
Security Profile
The security profile is a subset of the Gentran:Server user's profile that contains authority codes
defining the subsystems and functions the user can access as well as the level of access allowed to
that user.
If the user has full or partial access to a subsystem, the level of access is determined by the data
rights.
Segment
Each record in a transaction set or a string of associated data elements. A segment is like a
sentence: composed of data elements that are in a specific order to convey its meaning. Envelope
segments come in pairs, for example, GS/GE group parts, and ST/SE transaction set pairs.
Segment Terminator
The syntax character that is used to identify the end of a segment. One of the most common
terminators used in EDI is HEX ‘15’ (new line character).
Selection Criteria
Gentran:Server allows document processing and reporting functions to be controlled by selection
criteria. Examples of just some of the fields available as selection criteria are: User Document
Reference (P.O. Number, Invoice Number), User, Partner, Network, Application, Transaction
Type, Date, Time, Document Status, Document Acknowledgment Status, Document Validation
Status, Duplicate Status, Test/Production Status, Interchange Control Numbers, and other EDI
envelope information.
Separation
See “Data Separation.”
Slide File
The Slide file is the default Split file used during Inbound Processing by the Splitter program when
the Split file cannot be determined. If no Splitting instructions were set up or they cannot be found
for a Partner, all the data from that Partner will be placed in the Slide file. The Slide file can still be
used as input to the Mapper by leaving the Split file number blank on the Application Data ID or
by indicating the Slide file as the Split file on the Application Data ID.
Split File
The Split file is one of the work files used during the Inbound Processing by the Splitter program
to separate or sort the EDI data by the Application type in preparation for Mapping. There are 80
Split files available (identified as numbers 01-80).
Splitting
This is the process during Inbound Translation that occurs to separate the edited EDI data by
Application types prior to the Mapping process. EDI data that is received may be from many
different Partners and may contain several different types of documents. It is much more efficient
to sort the data by Application type before mapping the EDI data into the Application formats.
Sub-Split File
This file is a further separation of the data within each of the 80 Split files that can be used to break
the data apart more than just by the Application type by using an element in the EDI data to
determine where the data should be placed. There are 80 sub-split files available per Split file.
Subsystem
This is a collection of functions categorized together to perform certain tasks in Gentran. The
Partner subsystem is a group of functions that collectively allow you to define the Trading Partner.
Summary Area
The portion of the message that follows the body of the message and contains summary
information relating to the entire message.
Suspension
When Gentran:Server cannot determine key information necessary in order to continue
processing, the data is placed in the Suspense File. Suspended data is in error and the Editor and/or
Mapping Reports can be evaluated to determine the cause of the suspension. Typically, suspension
occurs when the Partner ID cannot be found in the Partner file for whom the data is destined or the
Transaction ID cannot be found to instruct the Mapper how to move the data between formats.
System Administrator
A person assigned to perform administrative functions with the system. This may be the Security
Officer or some else responsible for a specific application system.
With regard to Gentran, the System Administrator refers to the person responsible for authorizing
users to access Gentran and possibly controlling operations with Gentran.
TA1 Acknowledgment
This acknowledgment is an interchange acknowledgment for the ISA interchange. It is a single
segment that is surrounded only by the ISA/IEA envelope and acknowledges an ISA interchange
that was received. This level of acknowledgment is not typically used since it only indicates that
an interchange was received, not what was contained within the interchange nor how the contents
were disposed of.
Trading Partner
A Trading Partner is any organization with whom you do business. Typically, Trading Partners are
customers, suppliers, and intra-company divisions.
Transaction ID
Within Gentran:Server, the mapping definition that identifies how data is moved between the EDI
format and the Application format is stored under an identifier, known as the Transaction ID.
Transaction Set
The Transaction set is the EDI equivalent of an Application document. Common documents
include Purchase Orders and Invoices. The X12 Transaction sets for these are 850 and 810. The
UCS Transaction sets for these same documents are 875 and 880. The Transaction set is the EDI
format of Segments and Elements that compose the related information for the document. These
Transaction set numbers vary between Standards.
Translation
Transaction is the process of moving the data between EDI and Application formats using the
mapping definition. Translation occurs in Gentran:Server by the Inbound and Outbound Mappers
during PRCTRNIN and PRCTRNOUT.
User ID
The User ID refers to an individual defined in the Environment Control subsystem as someone
who can access Gentran:Server. The Gentran:Server User ID is set up using the iSeries User ID.
User Exit
The point during Translation mapping that an API (Application Program Interface) can be invoked
to perform some special processing. Gentran:Server mapping temporarily suspends while this API
is invoked. Data from the Mapping can be passed to the API through the User Exit Call Block.
User Exits can be invoked at the Element level, the Segment level, and the Mapping Run level (at
the Start of and End of Mapping).
User Profile
The user profile refers to the combination of the environment profile and the security profile that
is defined for each user in Gentran:Server. This profile identifies what systems and functions the
user is permitted to access as well as the data rights for each subsystem.
This profile is specific to Gentran:Server, however, it cannot be created without first having an
iSeries User ID and does not supersede any of the user's iSeries authority.
For example, if a user's iSeries profile has the option “Limit Capabilities” set to '*YES', then the
user cannot execute any commands from the command line, including Gentran-specific
commands. Command line authority is maintained within Gentran's “Work with” panels.
Write Flag
The Write Flag refers to the segment or record that is being written during the Translation
processing by the Mapper. If processing inbound, the Write Flag would exist on the Application
records to determine if the record should actually be written. If processing outbound, the write flag
would exist on the Transaction segments to determine if the segment should be written. In most
cases, you would want to write the record or segment. It is only in special situations where you
want to save some information in Constants that you may not want to write the segment or record.
In order to save data in constants, you must move it into a field or element. However, if you move
the data, the record or segment would be written. The Write Flag can prevent the record or
segment from being written by setting it to 'N' for No.
1. Loading common data into each application record during an inbound map (e.g., a sort
key).
The following descriptions discuss unique characteristics about the constant field ranges:
The following descriptions discuss unique characteristics about the hash total field ranges:
The following descriptions discuss unique characteristics about the accumulator field ranges:
CURRENT-TIME
The current time according to the system. The value generated is based on the length and
type of the target field.
TOTAL-SEGMENTS
This constant contains either the number of segments read (inbound) or the number of
segments written (outbound). It is available to be moved into a numeric application field
(inbound) or a numeric EDI element (outbound).
STOP
CAUTION
On Inbound maps only, segments defined to the map are counted and the count will only be
valid after all segments have been read. For this reason, this constant should only load an
application field defined in the summary section of the application. On outbound maps this
constant will not contain a valid value if more than one (1) segment is generated in the
summary section of the EDI document. Envelopes are not counted in either direction.
TOTAL-ITEMS
This constant contains the number of line items generated for an application (inbound) or
an EDI document (outbound). A line item is defined as the segments or records in the
detail section of the application or EDI document. It is available to be moved into a
numeric application field (inbound) or a numeric EDI element (outbound). This constant
should only be used in the summary section of the EDI document or application.
Inbound Only
The following reserved word constants are all preset by the inbound mapping program. They are
available to be moved into an appropriate application field.
SENDER-ID
This constant contains the resolved sender ID (partner cross-reference is used) as
determined by the inbound editor.
SENDER-ID-Q
This constant contains the resolved sender ID qualifier, if used, (cross-reference is used) as
determined by the inbound editor.
RECEIVER-ID
This constant contains the resolved receiver ID (partner cross-reference is used) as
determined by the inbound editor.
RECEIVER-ID-Q
This constant contains the resolved receiver ID qualifier, if used, (cross-reference is used)
as determined by the inbound editor.
PART-TEST-FLAG
This constant contains a ‘P’ if the transaction record on the partner file for the sender has a
Production status. If the Trading Partner is not on file or the transaction record found is not
set to production status, this constant contains a value of ‘T’.
PROD-TEST-FLAG
This constant contains a “P” if the transaction status (in Mapping) is set to Production.
This constant contains a “T” if the transaction status (in Mapping) is set to Test or
Development.
If data is moved from a numeric EDI element to an alphanumeric field during an inbound map
process, the numeric EDI element will be moved to the application field starting with the first
significant digit of the number. Any real or implied decimal points will be shown in the data as a
real decimal point.
For example:
AB CORPORATION - BIL
1234.56<space><space>
AN (Alphanumeric)
This is the data type used to describe 99.9 percent of the alphanumeric fields in
applications.
For “AN” data types, the length of the field is the number of characters to be written in the
field.
ID (Identification)
This data type describes a field with the same data characteristics as “AN.” There is no
reason at this time to use this data type in application definitions.
R (Real)
This data type is similar to the EDI “R” data type except that the entire length of the field
must be filled with numeric values. Its length is defined as the number of digits in the
number. Negative numbers have an explicit minus sign (-) in the first byte. Decimal
positions are indicated with a real decimal point. It is recommended that this data type be
used only when absolutely necessary because there is a considerable amount of
programming required to generate or interpret this data type compared to the other types.
A 6-position number with two positions after the decimal displays as “1234.56.” For
inbound, the field is padded on the right with trailing zeros. As a result, the number one
(“1”) displays in a 6-position application field as “1.0000.”
1. $120.00=====>120
2. $******1.00=====>1
3. 1.2=====>-1.2
4. 1.2 CR=====>-1.2
Remember, this data type can only be used in outbound application definitions.
B (Binary)
This data type supports full word, positive, binary numbers for outbound applications
only. The field lengths specified must be in full-word increments (e.g., 2 bytes, 4 bytes, 6
bytes, and 8 bytes). These data types are represented in COBOL as PIC 9(#) COMP, where
# is a multiple of 4.
# NOTE
You cannot save the E0 and F0 data types in the hash totals. If you did, unpredictable results
would occur.
Packed? Y(es)
Date Format Format Length
or N(o)
YY YYMMDD N 6 bytes
MM MMDDYY N 6 bytes
DD DDMMYY N 6 bytes
CY YYYYMMDD N 8 bytes
CM MMDDYYYY N 8 bytes
CD DDMMYYYY N 8 bytes
PY YYMMDD Y 4 bytes
PM MMDDYY Y 4 bytes
PD DDMMYY Y 4 bytes
ZY YYYYMMDD Y 5 bytes
ZM MMDDYYYY Y 5 bytes
ZD DDMMYYYY Y 5 bytes
LE DD.MM.YYYY(*EUR) N 10 bytes
“L” data type
Default format is 01.01.0001
Packed? Y(es)
Date Format Format Length
or N(o)
1P CYYMMDD Y 4 bytes
Where:
C = “0” for years 1900 through 1999
C = “1” for years 2000 and higher
1Y CYYMMDD N 7 bytes
Where:
C = “0” for years 1900 through 1999
C = “1” for years 2000 and higher
Packed? Y(es)
Time Format Format Length
or N(o)
TM HHMM N 4 bytes
T6 HHMMSS N 6 bytes
T8 HHMMSSuu N 8 bytes
Z4 HHMM Y 3 bytes
Z6 HHMMSS Y 4 bytes
Z8 HHMMSSuu Y 5 bytes
TS HH.MM.SS.uuuuuu N 16 bytes
Time portion (last 16 Default format is
bytes) of the iSeries -00.00.00.000000
Date/Time stamp
(Z).
TI HH:MM:SS N 8 bytes
Default format is 00:00:00
Packed? Y(es)
Time Format Format Length
or N(o)
TE HH.MM.SS N 8 bytes
Default format is 00.00.00
TB HH MM SS N 8 bytes
Default format is 00 00 00
ID Identification
The Identification data type describes a data field that is alphanumeric, but may contain
only specified code values. If the number of these code values has a realistic, finite limit
(e.g., unit of measure), then the values in the fields are validated during compliance
checking. If the number of valid values has no real defined limit (e.g., DUNS number),
then the value is not validated.
R Real
This data type is defined as having a real decimal point and an explicit minus (-) sign, if
the value is negative. The value of 1.23 in an “R” element, with a minimum length of one,
is 1.23.
Packed?
Date Format Format Length
Y(es) or N(o)
CD DDMMYYYY N 8 bytes
D8 CCYYMMDD N 8 bytes
Packed?
Time Format Format Length
Y(es) or N(o)
TM HHMM N 4 bytes
T6 HHMMSS N 6 bytes
T8 HHMMSSuu N 8 bytes
Record Type Start Position 5-38 Application Records/Files panel Field Descriptions
Record Type Start Position, Length 5-60 Area 5-15, 5-41, 5-63
Record Type Start Position, Length, Application File Description 5-15, 5-41, 5-63
5-12 Loop ID 5-15, 5-41, 5-63
Update Allowed 5-12, 5-38, 5-60 Mandatory Code 5-15, 5-41, 5-63
Application Envelope Definition panel Max Use 5-15, 5-41, 5-63
(EDIX560-FMT01) 5-29, 5-51, 5-72 Record/File 5-15, 5-41, 5-63
Sequence Number 5-15, 5-41, 5-63
Application Field Write Flag 5-15, 5-41, 5-63
Map an application field to an element 6-86
Application Select, defined 5-110
Application Fields panel (EDIX554-CTL01) 5-16,
5-42, 5-65, 5-68
APPRENBR command 5-79
Application Fields panel Field Descriptions Areas 4-19
Description 5-19, 5-46, 5-67 Audit File Report
Field Name 5-18, 5-46, 5-66 Partner set up 3-38, 3-51
Field Value 5-19, 5-47, 5-67 Audit Indicator 7-14, 7-34, 7-36, 7-61, G-2, G-4
Length 5-18, 5-46, 5-66
Mandatory Code 5-18, 5-46, 5-67
AUDITPURGE command 3-22
Sequence Number 5-18, 5-46, 5-66 Authority Codes 2-9
Start 5-18, 5-46 Data Level 2-12
Type 5-18, 5-46, 5-66 Define 2-10
Application File Type 4-4 Function Level 2-11
Quick Reference 2-12
Flat File 4-4
Subsystem Level 2-11
Logical File 4-4
Physical File 4-4
B
Application Format
Master Files 4-3 Batch Application Definition Renumber Report
Paper and EDI Invoice 4-8 (EBDI590) 5-99
Temporary Work Files 4-3 Batch Standards file, build 7-25
Application Format for Paper Invoice to be moved BG Partner global parameter 3-23
into EDI Invoice 5-8 Bicycle Wheel Concept
Application ID 5-2 “1-to-Many Relationship” 4-6
Application Key Structure panel (EDIX556-CTL01) Build maps 4-18
5-20 Build the Batch Standards file 7-25
Application Key Structure panel
(EDIX556-FMT01) 5-20 C
Application Partner Reference panel CD data type G-21, G-25
(EDIX559-FMT01) 5-26, 5-27, 5-48, 5-69 CEDCPY command 6-151
Application Partner Reference panel Field CM data type G-21
Descriptions 5-50
Application Partner Reference 5-28, 5-50, 5-70
Code Translation panel (EDIX583-CTL01) 6-133
Application Select 5-28, 5-50, 5-71 Code Translation Table 6-127
Qualifier Field Name 5-28, 5-50, 5-71 Code Validation
Application Partner Reference, defined 5-106 Partner set up 3-50
Application Records Comm Profile ID 3-23
Aligning segments in a map with application records see System Operator Guide
6-24 Command Line
Application Records/Files panel (EDIX553-CTL01) Access panels from 1-26
5-13, 5-40, 5-62 Common Questions
Can I copy a map from one version to another? 6-205 Control Totals 6-64
How can I create a uniform running environment for Convert a map to new version 6-164
multiple users? 2-17
How can I map the SDQ loop in the purchase order Copy
transaction? 6-207 Partner profiles 3-80
How do I add an element code? 7-66 Partners between libraries 3-85
How do I re-retrieve the DDS for an application file? Transaction Map 6-160
5-107, 5-116 Transaction map between libraries 6-162
How would a partner be set up with multiple Translation Table 6-149
divisions? 3-110 Translation Table Between Libraries 6-150
My partner is upgrading to a new version of the Copy Application Definition 5-76
standards; can I just change the version on my Copy Application Definition Between Libraries
map? 6-205
command, see APPCPY
Sectioning rules and guidelines 6-213
What are segment activity records? 7-67 Copy Code and Data command
What are the Max Use and Loop ID fields used for? see CEDCPY
5-106 Copy Partner ID command (PTRCPY) 3-87
What happens if my application needs to be changed?
Copy Segments from Standard panel
5-107
What if a single partner trades with more than one
(EDIX502-CTL01) 6-17, 6-23, 6-77, 6-78,
type of interchange? 3-111 6-83
What if I want two User IDs? 2-17 Copy Standards from One Library to Another
What if partner cannot be found during processing? (STDCPY) 7-38
3-112 Copy Transactions between libraries command
What information is stored in the partner profile?
see TRNCPY
3-109
What is Sectioning and how does it work? 6-209 Counting line items
What is the Application Partner Reference used for? see ACCUMULATOR-01
5-106 Create maps 4-18
What is the Application Select feature? 5-110 Cross Reference
What is the difference between Max Use and Max
Cross Reference Report (EBDI006G) 3-94
Loop on the Transaction Definition? 6-207
What is the partner profile and what is it used for? Cross Reference Report (EBDI006G) 3-94
3-109 Cross Reference, Partner set up 3-68
What rules should be followed when setting up a CTT Segment 6-122
map? 6-206
What types of files can be used to interface with CY data type G-21
Gentran:Server for processing? 6-205
Concepts in Gentran:Server 1-15 D
Conditional Mapping 6-36, 6-113 D8 data type G-25
Conditional mapping 6-36 Data By Partner Translation panel
(EDIX584-CTL01) 6-140
CONSTANT 6-65, 6-91
Data Description Specification (DDS) 5-7
Control Number
Group, Partner set up 3-41 Data Element Code Definition panel
Partner set up 3-29, 3-38 (EDIX170-CTL01) 7-16, 7-18, 7-20
Transaction, Partner set up 3-54 Data Separation
Control Number (GS06) 3-41 Directed Output global parameter 3-77
Identify the Split Files 3-78
Control Numbers Partner Data Separation panel (EDIX050-FMT01)
CTT Segment 6-122 3-78
Control Segments Partner set up 3-73
CTT segment 6-122 see Splitting 3-5, 3-73
Shortcuts for using the system 1-23 How Gentran:Server panels are structured 1-11
Subsystems 1-7 Hypertext 1-34
System Essentials 1-1
Taking a Closer Look 1-5
Terms and Concepts 1-15
I
Use panels 1-9 IF-Conditions 6-113
User’s Initials 1-14 IF-Statements in mapping 6-36
What does Gentran:Server do? 1-3
What is Gentran:Server? 1-2
Inbound Mapping
Work With concept 1-10 Application field select 6-86
Copy Extended Maps 6-118
Gentran:Server commands Copy Segments from Standard into the Map 6-78
EXTSTD 7-25 Copy segments from Standards 6-77
PRTSTD 7-30 CTT segment 6-122
PRTSTDBAT 7-34 Define the Transaction Map 6-74
PRTSTDTAP 7-32 Design Transaction Map – Element Level 6-67
PRTSTDUSE 7-36 Design Transaction Map – Field Level 6-65
STDCPY 7-38 Design Transaction Map – Segment Level 6-71
Get Help 1-30 Determine a New Transaction ID or Map 6-73
Get Help within Gentran:Server system 1-30 Element detailed information 6-90
Element Mapping 6-84
Getting Help Extended Mapping 6-88, 6-96, 6-109
Sterling Software Support (SSS) 1-41 Extended Mapping, Copy Extended Maps 6-118
Global Conditions Extended Mapping, IF-condition 6-115
Apply to a specific map number 6-93 Extended Mapping, PO1 Segment 6-113
Inbound map 6-98, 6-99, 6-105, 6-107 Extended Mapping, Revise 6-120
Group Extended Mapping, Revise after Copy 6-119
Extended Maps, select 6-97
Defining by Partner 3-34
Global Condition 6-95
Outbound, Partner set up 3-40
Global Conditions 6-98, 6-99, 6-105, 6-107
Group ID (GS01) 3-33 Global Conditions, define 6-92
Group Version global parameter 3-36 IF-condition 6-115
GS Receiver ID (GS03) 3-41 Map a BEG Segment 6-85
Map a N4 Segment 6-102
GS Sender ID (GS02) 3-41 Map a PO1 Segment 6-110
GS01 (Group ID) 3-33 Map an application field to an element 6-86
GS02 (GS Sender ID) 3-41 Map Numbering 6-93
Mapping Segment Level Worksheet - PO File 6-72
GS03 (GS Receiver ID) 3-41 Off-line Preparation 6-65
GS04 (Date) 3-41 Review segments copied into map from Standards
GS05 (Time) 3-41 6-82
Save data into a CONSTANT 6-88, 6-91
GS06 (Control Number) 3-41 Sectioning 6-209
GS07 (Responsible Agency Code) 3-42 Sectioning rules and guidelines 6-213
GS08 (Version) 3-42 Subelements 6-102
Subfield Mapping 6-102, 6-103, 6-104
H Interchange
Acknowledgment, Partner set up 3-20
HASH-TOTAL 6-55, 6-60, 6-64 Partner Header Option 3-18
Help Function in Gentran:Server 1-30 Interface Between Gentran:Server and Application
Help Key defined 1-18 Systems 4-3
Home Key defined 1-18 Interface To Application Systems 4-3
How Gentran:Server is organized 1-10 Internally-Described Physical File 4-5
Invoice example showing EDI and paper invoices Max Use and Max Loop, explanation of difference
4-8 6-207
Modifying a map 6-18
J Print a map 6-168
Reports 6-174
J command 1-23 Rules to follow when setting up a map 6-206
J8 data type G-21 SDQ Segment Loop 6-207
JUMP command 1-23 Steps for mapping 4-18
Sub-splitting 6-155
Synchronize a map with an application definition
K
6-166
Key Entry Line 1-14 The ezMap command 6-171
Translate application code values to EDI standard
L code values 6-127
Learning about the Gentran:Server system 1-1 Translate application data values to partner’s data
values 6-134
Line item totals,see HASH-TOTAL What is Mapping? 4-2
Logical File 4-4 Mapping – Getting Started 4-1
Logical Groups in EDI documents Interface To Application Systems 4-3
SEE Areas Mapping Features 4-2
Loop ID field 6-24, 6-25, 6-71 Mapping Report - Application Sequence (EBDI053)
6-180
M
Mapping Report - Extended Mapping Notes
Maintenance, Remote 1-41 (EBDI083) 6-195
Map Mapping Report - Validation Sequence (EBDI082)
Convert to new Version 6-164 6-191
Copy 6-160
Copy between libraries 6-162 Mapping Report- Standard Sequence (EBDI052)
General 6-15 6-174
Partner specific 3-49 Mapping Synchronization command(
Print 6-168 MAPSYNCH) 6-166
see Transaction Map Definition panel
(EDIX503-FMT01)
Mapping Theory in Gentran:Server 4-6
Specific 6-15 Bicycle Wheel Concept 4-6
Synchronize a map with an application definition One-to-Many Concept 4-6
6-166 Spokes of the Wheel 4-6
Use Code 6-15 MAPSYNCH command 6-166
Mapping Max Loop 6-207
also see Inbound Mapping Max Use 6-207
also see Outbound Mapping
Convert a map to new version 6-164
Max Use field 6-24, 6-71
Copy a map 6-160 Message Line 1-14
Copying a map between libraries 6-162 Messages 1-14
Copying a map from one version to another 6-205
Data validation tables 6-142
MM data type G-21
Features of mapping 4-2 Mouse usage defined 1-18
How Gentran:Server breaks down documents Multi-Format Logical File 4-4
Illustration of "One-to-Many Relationship" 4-6
Illustration of comparison between paper and
Multi-Format Logical File (GENMFLF) 5-21
electronic invoices 4-8
Mapping Theory in Gentran:Server 4-6 O
Online Help 1-30, 1-33