Gentran:Server® for Windows® User’s Guide Version 5.
Copyright Notice Gentran:Server for Windows © Copyright 1995–2005 Sterling Commerce, Inc. ALL RIGHTS RESERVED Sterling Commerce Software Trade Secret Notice THE GENTRAN:SERVER FOR WINDOWS SOFTWARE ("STERLING COMMERCE SOFTWARE") IS THE CONFIDENTIAL AND TRADE SECRET PROPERTY OF STERLING COMMERCE, INC., ITS AFFILIATED COMPANIES OR ITS OR THEIR LICENSORS, AND IS PROVIDED UNDER THE TERMS OF A LICENSE AGREEMENT. NO DUPLICATION OR DISCLOSURE WITHOUT PRIOR WRITTEN PERMISSION. RESTRICTED RIGHTS.
Table of Contents Preface About this Guide ◗ ◗ ◗ Chapter 1 ◗ ◗ ◗ ◗ Chapter 2 ◗ ◗ ◗ ◗ ◗ Chapter 3 ◗ Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . viii What’s in this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Getting Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ii ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ Outbound Group Select Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-44 Outbound Group Entry Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45 Outbound Interchange Select Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-50 Outbound Interchange Entry Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-52 Creating a Partner Definition . . . . . .
iii Chapter 4 ◗ Using Documents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3 Document Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4 ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ Accessing the Document Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-4 In Documents Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
iv ◗ ◗ Chapter 5 ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ Chapter 6 ◗ ◗ ◗ ◗ ◗ Chapter 7 ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ Chapter 8 ◗ ◗ ◗ ◗ Importing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-57 Exporting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-59 Using Communications Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
v ◗ ◗ Chapter 9 ◗ ◗ ◗ ◗ ◗ Special Considerations for EDIFACT Acknowledgements . . . . . . . . . . . . . . . . . . . . 8-11 Checking for Overdue Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8-12 Using Tracking Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9-2 Tracking Inbound Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
vi ◗ ◗ Reprocessing Restored Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-57 Resending Restored Interchanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10-58 Chapter 11 Using Process Control ◗ Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11-2 Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
-vii PREFACE About this Guide Contents ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .viii What’s in this Manual . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix Getting Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
viii Introduction Welcome Welcome to Gentran:Server® for Windows®, the Sterling Commerce Electronic Data Interchange (EDI) software for the Windows operating system. Gentran:Server provides you with the easy-to-use tools you need to electronically exchange data with your trading partners, including: ◗ Data translation ◗ Process control ◗ Communications system We believe that you will find this software and the supporting materials easy to use and directly beneficial to your business.
ix What’s in this Manual Introduction Intended audience Prerequisite knowledge Description of contents This manual is intended to support the online Help by assisting you in performing various tasks in Gentran:Server. This task-oriented approach is intended to answer any questions you may have about Gentran:Server with step-by-step instructions.
x Description of contents (contd) Online Help ◗ Chapter 8, Using Acknowledgements, explains how to manually set a document, group, or interchange to acknowledged, how to define inbound and outbound acknowledgement criteria for document reconciliation, and how to check for overdue acknowledgements. ◗ Chapter 9, Using Tracking, explains how to view and print tracking information. ◗ Chapter 10, Using Archive and Restore, explains how to archive data and restore archived data to the system.
xi Getting Support Introduction The Sterling Commerce Gentran:Server software is supported by trained product support personnel who are available to help you with product questions or concerns. Note Gentran:Server Customer Support does not support non-Sterling Commerce products (such as SQL Server and Oracle), but can assist you in configuring non-Sterling Commerce products to work with Gentran:Server.
xii Information Accessing the Sterling Commerce Support Web Site Description Error Messages Record the exact wording of any error messages you receive and the point in the software where the error occurred, as well as any log files. Attempted Solutions Record any steps that you took attempting to resolve the problem and note all the outcomes. Provide an estimate on how many times the problem occurred and whether it can be reproduced.
1 - 1 -1 CHAPTER 1 Getting Started Contents ◗ ◗ ◗ ◗ Introducing Gentran:Server for Windows . . . . . . . . . . . . . . . . . . .1 - 2 Navigating in Gentran:Server . . . . . . . . . . . . . . . . . . . . . . . . . . . .1 - 6 Gentran:Server Data Translation Process . . . . . . . . . . . . . . . . . . .1 - 9 Changing your Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
1-2 Introducing Gentran:Server for Windows Getting Started Introducing Gentran:Server for Windows Overview Gentran:Server for Windows is a combined data translation, process control, and communication system that operates within the Microsoft Windows environment. This product is primarily designed for the translation and communication of EDI and other similar types of data.
Getting Started Process Controllers Primary system controller Secondary controllers Introducing Gentran:Server for Windows 1-3 There are two types of controllers in the Gentran:Server system: ◗ A single primary system controller ◗ One or more secondary controllers (if required) The primary system controller controls the management and dispatching of processing requests within the system, manages the audit functionality, and controls all other system components.
1-4 Introducing Gentran:Server for Windows User interface client components Logical components Getting Started The five main components of the Gentran:Server user interface client are the following: ◗ The Electronic Commerce (EC) Manager window is a data management component that serves as a high-level navigation tool, as well as a document management tool. The EC Manager also provides access to the Partner Editor, the Document Editor, Application Integration, and Forms Integration.
Getting Started Introducing Gentran:Server for Windows Logical components (contd) 1-5 System component interaction diagram The following diagram illustrated the interaction of the logical components of the Gentran:Server system: Multiple Controllers Installed Components: ■ Process Controller (default) ■ Client Access Components ■ Integration Components Primary Gentran System Controller System Data Store Database Gentran: Server Windows 2003, Enterprise Edition Secondary Controller 1 Gentran: Serv
1-6 Navigating in Gentran:Server Getting Started Navigating in Gentran:Server Overview The Gentran:Server Electronic Commerce (EC) Manager window allows you to access its functionality in the following ways: ◗ Select the menu option from the Main Menu Bar. ◗ Click the appropriate button on the Main Toolbar. ◗ Click the appropriate button on the Browser Toolbar. ◗ Click the appropriate part of The Desk. ◗ Click the appropriate button within a chosen browser window.
Getting Started Navigating in Gentran:Server Components 1-7 The following are the components of the main Gentran:Server window: Control menu The Control Menu contains the following commands: Restore, Move, Size, Minimize, Maximize, and Close. Title Bar The Title Bar contains the name of the application and, on the Gentran:Server desktop, it displays the name of the system you are logged in to. You can use this to move the position of the Gentran:Server EC Manager window on your desktop.
1-8 Navigating in Gentran:Server Getting Started Browser toolbar The Browser Toolbar gives you access to the functions that are available from browsers in Gentran:Server. Unavailable items are dimmed. The Browser Toolbar is a dockable toolbar, so you can affix it to any edge of the EC Manager window.
Getting Started Gentran:Server Data Translation Process 1-9 Gentran:Server Data Translation Process Translating inbound data diagram The following illustrates the inbound translation process: Communicator Receives interchanges from network and passes .to translator Unwraps interchange envelopes and separates groups. Temporary Storage Unwraps groups envelopes and separates transaction sets. Temporary Storage Unwraps transaction envelopes and separates documents.
1 - 10 Gentran:Server Data Translation Process Translating inbound data process Getting Started The system uses the following process to translate inbound data:. Stage Description 1 The Communicator receives interchanges from your trading partners via a network. 2 The Communicator passes the interchanges to the translator. 3 The translator uses a system interchange break translation object to unwrap the interchange envelopes and separate each group into temporary storage.
Getting Started Gentran:Server Data Translation Process Stage 8 1 - 11 Description In the trading relationship, if you specify that the system needs to generate a functional acknowledgement for a document, the translator uses the system acknowledgement translation object to generate the acknowledgement. ◗ Compliant acknowledgements are moved to the Out Documents to be sent. ◗ Non-compliant acknowledgements are moved to the ?Out Documents.
1 - 12 Gentran:Server Data Translation Process Translating outbound data diagram Getting Started The following illustrates the outbound translation process: Import Application Document Editor System Locates system importConfiguration translation object. Translator System Import Translation Determines trading Object relationship. Partner Database Use trading relationship to determine Import Translation Object. Import Translation Object Compliance checks documents and formats to EDI.
Getting Started Translating outbound data process Gentran:Server Data Translation Process 1 - 13 The system uses the following process to translate outbound data: Stage 1 Description Use one of the following processes to initiate outbound translation: ◗ Import a file through the process control system using a timed or polled session. This writes all valid documents to the database with a compliant status and locates the documents in the Out Documents.
1 - 14 Changing your Password Getting Started Changing your Password Introduction Your Gentran:Server password is stored in your User Access profile. Notes ◗ You must know your old password to change it. If you have forgotten your password, please contact your system administrator. ◗ If you are using Integrated security, you may also need to change your Gentran:Server and database passwords if you change your Windows password.
2 - 1 -1 CHAPTER 2 Using Translation Objects Contents ◗ ◗ ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2 - 2 EDI Translation Object Browser . . . . . . . . . . . . . . . . . . . . . . . . . .2 - 3 Register Translation Object Dialog Box . . . . . . . . . . . . . . . . . . . .2 - 6 Registering New Translation Objects . . . . . . . . . . . . . . . . . . . . . .2 - 7 Deleting Translation Objects . . . . . . .
2-2 Overview Using Translation Objects Overview In this chapter Translation object definition Creating translation objects This chapter describes how to use translation objects with Gentran:Server. A translation object is a set of definitions, links, and rules that combine to provide the translator with all the information necessary to convert data from one format to another. Translation objects are used in Gentran:Server to control the processing of the translator subsystem.
Using Translation Objects EDI Translation Object Browser 2-3 EDI Translation Object Browser Introduction The following lists the system components that comprise the EDI Translation Object feature. Browser or Dialog box EDI Translation Object browser diagram Parts and functions Function EDI Translation Object Allows you to view, print, delete, or register translation objects. Register Translation Object Allows you to select translation objects to be registered with the system.
2-4 EDI Translation Object Browser Part Used Using Translation Objects Function Indicates whether the translation object is currently associated with an Inbound or Outbound Partner Relationship. Valid values are: ◗ Yes—Indicates the translation object is in use. ◗ No—Indicates the translation object is not in use. ◗ SYS*—Indicates a system translation object that is in use.
Using Translation Objects EDI Translation Object Browser Part Function Close Exits the EDI Translation Object browser. Help Accesses Online Help.
2-6 Register Translation Object Dialog Box Using Translation Objects Register Translation Object Dialog Box Introduction Diagram Parts and functions The Register Translation Object dialog box enables you to register a selected translation object file with Gentran:Server (identify the translation object to the system).
Using Translation Objects Registering New Translation Objects 2-7 Registering New Translation Objects Introduction The Register Translation Object function enables you to register your translation object file with Gentran:Server so the system can identify the translation object. Automatic registration You can set the auto-register feature to automatically register translation objects when they are compiled.
2-8 Deleting Translation Objects Using Translation Objects Deleting Translation Objects Introduction You can delete old or unused translation objects from the system only if they are not currently associated with an Inbound or Outbound Partner Relationship (“No” in the Used column on the EDI Translation Object browser). The system prevents you from deleting translation objects that are designated as “system translation objects” (SYS” or SYS).
3 - 1 -1 CHAPTER 3 Using Partners Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 3 Using Partner Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 4 ◗ Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 4 ◗ Partner Editor Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 6 ◗ Partner Definition (New/Edit) Dialog Box . . . .
Using Partners 3-2 Partner Tables Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 93 ◗ New Table Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 94 ◗ CrossRef Select Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 95 ◗ CrossRef Entry Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 96 ◗ Lookup Select Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3 - 97 ◗ Lookup Entry Dialog Box . . .
Using Partners Introduction 3-3 Introduction In this chapter Partner Editor This chapter explains how to use the Gentran:Server Partner Editor, including: ◗ Using partner profiles ◗ Routing partner profiles ◗ Using partner tables ◗ Using partner locations The Partner Editor allows you to define, edit, and delete all partner relationship information for your company and all of your trading partners. Partner relationships allow you to send and receive data to and from your trading partners.
3-4 Overview Using Partners Using Partner Profiles 0 Overview Introduction You can set up your partner profiles using any of three methods: importing, copying, and creating them yourself.
Using Partners Partner profile Overview 3-5 To complete the partner profile, you need to define an inbound or outbound relationship or both: ◗ If you are receiving and processing information from this trading partner, you need to define an appropriate inbound relationship. ◗ If you are sending information to this trading partner, you need to define an outbound relationship. You need to create a partner profile for each partner with whom you are going to exchange data.
3-6 Partner Editor Dialog Box Using Partners Partner Editor Dialog Box Introduction Diagram Parts and functions The Partner Editor enables you to define, edit, and delete all partner information for your company and all of your trading partners. The following illustrates the Partner Editor dialog box: The following lists the parts of the Partner Editor dialog box and their functions: Part Function Select a Partner Displays the list of partner profiles to select from.
Using Partners Partner Editor Dialog Box Part 3-7 Function Export Displays the Export File Build Dialog Box, which allows you to export a partner profile. Exit Exits the Partner Editor dialog box. Edit Displays the Partner Definition (New/Edit) Dialog Box, which allows you to change information about the selected partner. New Displays the Partner Definition (New/Edit) Dialog Box, which allows you to create a partner definition. Delete Removes the selected partner profile from the system.
3-8 Partner Definition (New/Edit) Dialog Box Using Partners Partner Definition (New/Edit) Dialog Box Introduction Diagram Parts and functions The Partner Definition dialog box enables you to create a new partner definition or, if you select a previously defined partner definition, it allows you to edit it.
Using Partners Partner Definition (New/Edit) Dialog Box Part Default Mailbox 3-9 Function Select a default mailbox to use to identify this partner for non-RosettaNet EDI relationships. Reference See the Communications User’s Guide for more information. Default E-mail Address Specify a default e-mail address to use to identify this partner for non-RosettaNet EDI relationships. Reference See the Communications User’s Guide for more information. Save Saves the modified information.
3 - 10 Inbound Relationship Dialog Box Using Partners Inbound Relationship Dialog Box Introduction Inbound relationships define the parameters the system needs to receive an EDI document from a trading partner. The Inbound Relationship dialog box controls other subordinate dialogs that allow you to define everything that is necessary to establish the relationship. You are required to specify exactly which document is to be received.
Using Partners Parts and functions Inbound Relationship Dialog Box 3 - 11 The following lists the parts of the Inbound Relationship dialog box and their functions: Part Function Relationship Description Select the existing inbound relationship. Standard Specifies the EDI standard to be used in this relationship. Note Only standards for which you have existing translation objects are displayed. This box cannot be changed for an existing relationship. Selection of this box is mandatory.
3 - 12 Inbound Relationship Dialog Box Using Partners Part Release Function Select the release number to be used in this relationship. Note Only releases for the selected transaction set for which you have existing translation objects are displayed. This box is currently only used for messages defined in the TRADACOMS standard. Selection of this box is mandatory for all TRADACOMS messages.
Using Partners Inbound Relationship Dialog Box Part Duplicate Documents 3 - 13 Function Specify if the system will check for duplicate document names. Notes ◗ If the system detects duplicate document name it will locate those documents in ?In Documents. ◗ If duplicate document checking is activated for a relationship the translation object used in this relationship must update the document name via a standard or extended rule.
3 - 14 Inbound Relationship Dialog Box Using Partners Part Function New Accesses the New Inbound Relationship dialog box, which allows you to create a new relationship. Delete Removes the specified inbound relationship from the system. Translation Accesses the Inbound Translation Object Dialog Box. Advanced Toggles the display of the advanced options. Help Displays Online Help.
Using Partners Inbound Translation Object Dialog Box 3 - 15 Inbound Translation Object Dialog Box Introduction The Inbound Translation Objects dialog box is used to specify which translation objects will be used to process the data defined by this relationship.
3 - 16 Inbound Translation Object Dialog Box Diagram Using Partners The following illustrates the Inbound Translation Object dialog box with the Advanced options displayed: Gentran:Server for Windows – November 2005 Gentran:Server for Windows User’s Guide
Using Partners Parts and functions Inbound Translation Object Dialog Box 3 - 17 The following lists the parts of the Inbound Translation Object dialog box and their functions: Part Turn Around/ Auto Function Displays all turnaround document options. When a document is received, the turnaround document created is the natural response document that contains as many elements from the received document as possible. Note Select the Auto check box if you want the defined turnaround process to be automatic.
3 - 18 Inbound Translation Object Dialog Box Part Export File Name Using Partners Function Specify the name of the file to be created or appended to as a result of performing an export operation. This file name can contain a mix of alphanumeric characters and formatting characters, which are replaced by the translator with the runtime value they represent.
Using Partners Inbound Translation Object Dialog Box Part Export to Mailbox 3 - 19 Function Invokes the "Export to Mailbox" function, which delivers the output of an inbound translation to the Mailbox Server Manager. This allows the Mailbox Server Manager to act as a message broker responsible for delivering the data to its final destination. Note If you specified the Export File Name, it is still valid and will become the Attachment Filename.
3 - 20 Inbound Translation Object Dialog Box Part Recipient E-mail Address/ Edit Mailbox Using Partners Function Specify the e-mail address to which the output of an inbound translation is delivered. Or, click Edit Mailbox to display the Create New Mailbox wizard, which allows you to edit the mailbox. Reference See the Communications User's Guide for more information. Content Type/ SubType Specify the content type/sub type of the message containing the output of the inbound translation.
Using Partners Inbound Translation Object Dialog Box Part Import 3 - 21 Function Select other translation objects associated with the relationship, which gives you the capability to change the system behavior at the transaction and document translation level. This allows you to use translation objects that are as partner-specific as required and/or perform as many functions as required.
3 - 22 Inbound Translation Object Dialog Box Part Acknowledge Using Partners Function Select other translation objects associated with the relationship, which gives you the capability to change the system behavior at the transaction and document translation level. This allows you to use translation objects that are as partner-specific as required and/or perform as many functions as required.
Using Partners Inbound Group Select Dialog Box 3 - 23 Inbound Group Select Dialog Box Introduction The Inbound Group Select dialog box is used to select an existing functional group definition to be associated with this relationship. It can also be used to initiate the definition of a new functional group or to modify or delete an existing definition. The groups available to you are determined by the version you selected on the Inbound Relationship dialog.
3 - 24 Inbound Group Select Dialog Box Using Partners Part Function Edit Displays the Inbound Group Entry Dialog Box, which allows you to edit the selected group. Delete Removes the selected group from the system. Help Displays Online Help.
Using Partners Inbound Group Entry Dialog Box 3 - 25 Inbound Group Entry Dialog Box Introduction Diagram Parts and functions The Inbound Group Entry dialog box is used to specify a functional group definition. The following illustrates the Inbound Group Entry dialog box with the Advanced options displayed: The following lists the parts of the Inbound Group Entry dialog box and their functions: Part Function Description Specify the name of the functional group description.
3 - 26 Inbound Group Entry Dialog Box Using Partners Part Function Functional Group ID Specify the functional group. These identification boxes are defined by each appropriate standards group to group like documents. The standard defines which functional group ID should be used with each document type. This is a mandatory box. Examples IN 810 X12 Invoice PO 850 X12 Purchase Order IG 830 UCS Invoice OG 875 UCS P. O.
Using Partners Inbound Group Entry Dialog Box Part Acknowledge Group 3 - 27 Function Instructs the system to send a functional acknowledgement to this trading partner when you receive the group defined in this relationship. The default value for this box is not checked (do not expect an acknowledgement). Note This check box is dimmed (inactive) if the transaction set is an acknowledgement. Ack Translation Set ID Select the acknowledgement you want generated for this group.
3 - 28 Inbound Group Entry Dialog Box Using Partners Part Acknowledge Transl. Obj. Function Select an Acknowledgement Break Map if one exists on the system. Note You must select a translation object from the Acknowledge Transl. Obj. list if you have created a specific translation object for this relationship and if you want to change the way the system behaves for this partner group. When the system reconciles an acknowledgement, it maps the acknowledgement to an internal file and then processes it.
Using Partners Inbound Interchange Select Dialog Box 3 - 29 Inbound Interchange Select Dialog Box Introduction Diagram Parts and functions The Inbound Interchanges Select dialog box is used to select an existing interchange definition to be associated with this relationship. You can also use it to initiate the definition of a new interchange or to modify or delete an existing definition. The interchanges available to you are determined by the version you selected on the Inbound Relationships dialog.
3 - 30 Inbound Interchange Select Dialog Box Using Partners Part Function Edit Displays the Inbound Interchange Entry Dialog Box, which allows you to edit the selected interchange. Delete Removes the selected interchange from the system. Help Displays Online Help.
Using Partners Inbound Interchange Entry Dialog Box 3 - 31 Inbound Interchange Entry Dialog Box Introduction The Inbound Interchange Entry dialog box is used to specify a new interchange definition. Note EDIFACT version 4 defines the infrastructure necessary to support the creation (and processing) of interchanges that have been encoded using a character set other than 8-bit ASCII.
3 - 32 Inbound Interchange Entry Dialog Box Parts and functions Using Partners The following lists the parts of the Inbound Interchange Entry dialog box and their functions: Part Function Description Contains the name of the interchange description. Standard Displays the EDI standard the system is using for this relationship definition. Version Displays the version of the EDI standard the system is using for this relationship. Interchange ID Select the type of interchange.
Using Partners Inbound Interchange Entry Dialog Box Part Last Used Control Number 3 - 33 Function Specifies a value that will be used to sequence check the next interchange control number. The number will be replaced by the control number on the last interchange received. This box will initially be set to zero. Note This box is disabled if Sequence Checking is None.
3 - 34 Inbound Interchange Entry Dialog Box Using Partners Part Acknowledge Transl. Obj. Function Select an Acknowledgement Break Map if one exists on the system. You must select a translation object from the Acknowledge Transl. Obj. list if you have created a specific translation object for this relationship and if you want to change the way the system behaves for this partner interchange.
Using Partners Outbound Relationship Dialog Box 3 - 35 Outbound Relationship Dialog Box Introduction Outbound relationships define the parameters needed to send an EDI document to a trading partner. The Outbound Relationship dialog box controls other subordinate dialogs that allow you to define everything that is necessary to establish the relationship. You are required to specify exactly which document the system sends.
3 - 36 Outbound Relationship Dialog Box Parts and functions Using Partners The following lists the parts of the Outbound Relationship dialog box and their functions: Part Function Relationship Description Select the relationship description. Standard Specifies the EDI standard to be used in this relationship. Note Only standards for which you have existing translation objects are displayed. This box cannot be changed for an existing relationship. Selection of this box is mandatory.
Using Partners Outbound Relationship Dialog Box Part Release 3 - 37 Function Select the release number to be used in this relationship. Note Only releases for the selected transaction set for which you have existing translation objects will be displayed. This box is currently only used for messages defined in the TRADACOMS standard. Selection of this box is mandatory for all TRADACOMS messages. Groups Accesses the Outbound Group Select Dialog Box.
3 - 38 Outbound Relationship Dialog Box Using Partners Part Duplicate Documents Function Instructs the system to check for duplicate document names. Notes ◗ If you manually import documents into the Workspace, this function checks for duplicate documents. Duplicate documents remain in the Workspace until they are deleted. If you try to move or post a duplicate document, a warning message is displayed.
Using Partners Outbound Relationship Dialog Box Part Function Advanced Toggles the display of the advanced options. Help Displays Online Help.
3 - 40 Outbound Translation Object Dialog Box Using Partners Outbound Translation Object Dialog Box Introduction The Outbound Translation Objects dialog box is used to specify which translation objects are used to process the data defined by this relationship. The following lists the outbound translation levels (from the lowest level up): Translation Level Diagram Description Document Translate from import format or data entry to EDI.
Using Partners Parts and functions Outbound Translation Object Dialog Box 3 - 41 The following lists the parts of the Outbound Translation Object dialog box and their functions: Part Function Import Displays all import translation objects in the system for the Standard, Version, Transaction Set, and Release defined by the relationship. Print Displays all print translation objects in the system for the Standard, Version, Transaction Set, and Release defined by the relationship.
3 - 42 Outbound Translation Object Dialog Box Part TurnAround Using Partners Function Select other translation objects associated with the relationship, which gives you the capability to change the system behavior at the transaction and document translation level. This allows you to use translation objects that are as partner-specific as required and/or perform as many functions as required.
Using Partners Outbound Translation Object Dialog Box Part Acknowledge 3 - 43 Function Select other translation objects associated with the relationship, which gives you the capability to change the system behavior at the transaction and document translation level. This allows you to use translation objects that are as partner-specific as required and/or perform as many functions as required.
3 - 44 Outbound Group Select Dialog Box Using Partners Outbound Group Select Dialog Box Introduction The Outbound Group Select dialog box is used to select an existing functional group definition to be associated with this relationship. You can also use it to initiate the definition of a new functional group or to modify or delete an existing definition. The groups that are available to you are determined by the version you selected on the Outbound Relationship dialog box.
Using Partners Outbound Group Entry Dialog Box 3 - 45 Outbound Group Entry Dialog Box Introduction Diagram Parts and functions The Outbound Group Entry dialog box is used to specify a new functional group definition. The following illustrates the Outbound Group Entry dialog box with the Advanced options displayed: The following lists the parts of the Outbound Group Entry dialog box and their functions: Part Function Description Specify the name of the functional group description.
3 - 46 Outbound Group Entry Dialog Box Using Partners Part Function Version Displays the version of the EDI standard the system is using for this relationship. Functional Group ID Specifies the functional group. These identification boxes are defined by each appropriate standards group to group like documents. The standard defines which functional group ID should be used with each document type. This is a mandatory box.
Using Partners Outbound Group Entry Dialog Box Part Hours Overdue 3 - 47 Function Specify how many hours must elapse before an expected functional acknowledgement is considered overdue. This box is only valid if the Expect Acknowledgement box is checked. The default value for this box is “48,” indicating that the acknowledgement will be considered overdue in two days. If you enter a value of “0” (zero) in this box, the acknowledgement will be immediately considered overdue.
3 - 48 Outbound Group Entry Dialog Box Using Partners Part Format Function Select the format of the transaction set control number that will be generated: Normal The number will be generated by incrementing the last used control number. The length of the number will be defined by the standard. 6/3 The number will be a composite of two numbers. The first six digits are the last six digits of the functional group control number.
Using Partners Outbound Group Entry Dialog Box Part Acknowledge Transl. Obj. 3 - 49 Function Select an Acknowledgement Build Map if one exists on the system. You must select a translation object from the Acknowledge Transl. Obj. list if you have created a specific translation object for this relationship and if you want to change the way the system behaves for this partner group. When the system reconciles an acknowledgement, it maps the acknowledgement to an internal file and then processes it.
3 - 50 Outbound Interchange Select Dialog Box Using Partners Outbound Interchange Select Dialog Box Introduction Diagram Parts and functions The Outbound Interchange Select dialog box is used to select an existing interchange definition to be associated with this relationship. It can also be used to initiate the definition of a new interchange, or to modify or delete an existing definition.
Using Partners Outbound Interchange Select Dialog Box Part 3 - 51 Function Edit Displays the Outbound Interchange Entry Dialog Box, which allows you to edit the selected interchange. Delete Removes the selected interchange from the system. Help Displays Online Help.
3 - 52 Outbound Interchange Entry Dialog Box Using Partners Outbound Interchange Entry Dialog Box Introduction The Outbound Interchange Entry dialog box is used to specify a new interchange definition. Note EDIFACT version 4 defines the infrastructure necessary to support the creation (and processing) of interchanges that have been encoded using a character set other than 8-bit ASCII.
Using Partners Parts and functions Outbound Interchange Entry Dialog Box 3 - 53 The following lists the parts of the Outbound Interchange Entry dialog box and their functions: Part Function Description Displays the name of the interchange description. Standard Displays the EDI standard the system is using for this relationship definition. Version Displays the version of the EDI standard the system is using for this relationship. Interchange ID Displays the type of interchange you specified.
3 - 54 Outbound Interchange Entry Dialog Box Using Partners Part Function Set Max Number of Documents per Interchange Instruct the system to only allow the specified maximum number of documents per interchange for this relationship. Max Number of Documents per Interchange Specify the maximum number of documents allowed per interchange for this relationship. Last Used Control Number Specify a value that will be used to generate the next interchange control number.
Using Partners Outbound Interchange Entry Dialog Box Part Acknowledge Transl. Obj. 3 - 55 Function Select an Acknowledgement Build Map if one exists on the system. You must select a translation object from the Acknowledge Transl. Obj. list if you have created a specific translation object for this relationship and if you want to change the way the system behaves for this partner interchange.
3 - 56 Creating a Partner Definition Using Partners Creating a Partner Definition Introduction The partner definition contains the basic information about the trading partner that the system needs before you define the rest of the partner profile.
Using Partners Creating a Partner Definition 3 - 57 Step Action 6 If necessary, in the Application Code box, type an application code to identify this partner. Note The system uses this identifier during outbound import processing, to select the correct partner. 7 ◗ Select the appropriate mailbox from the Default Mailbox list. ◗ OR Click New Mailbox to create a new mailbox. Note See the Communications User’s Guide for more information about creating mailboxes.
3 - 58 Creating an Inbound Relationship Using Partners Creating an Inbound Relationship Introduction To correctly receive and process information from a trading partner, you must have an appropriate inbound relationship established that defines the parameters needed to receive data files from that partner. Each inbound relationship defines which business documents are received from a partner. Necessary parameters You must set up several parameters that are used to create an inbound relationship.
Using Partners Inbound groups and interchanges (contd) Creating an Inbound Relationship 3 - 59 ◗ For UCS, the interchange is required and the functional group is also required. ◗ For EDIFACT, the interchange is required and the functional group is optional. ◗ For ODETTE, the interchange is required and the functional group is optional. ◗ For TRADACOMS, the Interchange is required and there is no functional group.
3 - 60 Creating an Inbound Relationship Stage Using Partners Description 3 Select at least one inbound translation object. 4 Create and select at least one inbound group to define how the document is received from this partner. Note Depending on the standards you are using, either the functional group or interchange may be optional. (See Inbound groups and interchanges on page 3 - 58 to determine what is optional for the standard you are using.
Using Partners Procedure Creating an Inbound Relationship 3 - 61 To create an inbound relationship, complete the following steps: Step Action Creating a new inbound relationship 1 From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile for which you want to create an inbound relationship. Click Inbound. System response The system displays the Inbound Relationship Dialog Box.
3 - 62 Creating an Inbound Relationship Using Partners Step 6 Action From the appropriate drop-down lists on the Inbound Relationship dialog box, select the following: ◗ ◗ ◗ ◗ Standard Version Transaction Set Release (for TRADACOMS only) Notes ◗ The contents of these lists are displayed from the translation objects registered in Gentran:Server.
Using Partners Creating an Inbound Relationship 3 - 63 Step Action 3 If you selected an Export File translation object and you want to export to a specific file, type the universal naming convention (UNC) name of that file in the Export File Name box.
3 - 64 Creating an Inbound Relationship Using Partners Step 5 Action In the Functional Group ID box, type the identification of the functional group you are specifying. Note The EDI standards define which functional group ID should be used for each type of document. 6 If you have more complex requirements for processing the functional group, click Advanced to display the full list of functional group setup options.
Using Partners Creating an Inbound Relationship Step 3 3 - 65 Action On the Inbound Interchange Select dialog box, click New. System response The system displays the Inbound Interchange Entry Dialog Box. 4 In the Description box, type the interchange description. 5 In the Interchange ID box, type the identification of the interchange you are specifying. Note The EDI standards define which interchange ID should be used for each type of document.
3 - 66 Creating an Outbound Relationship Using Partners Creating an Outbound Relationship Introduction Necessary parameters Translation objects To correctly send information to a trading partner, you need to define an outbound relationship. Outbound relationships define the parameters needed to send a data file to a trading partner. Each outbound relationship defines the format of a single business document, and how that business document is formatted and sent to the specified trading partner.
Using Partners Outbound groups and interchanges (contd) Creating an Outbound Relationship 3 - 67 ◗ For TDCC, the interchange is optional and the functional group is required. ◗ For UCS, the interchange is required and the functional group is also required. ◗ For EDIFACT, the interchange is required and the functional group is optional. ◗ For ODETTE, the interchange is required and the functional group is optional. ◗ For TRADACOMS, the Interchange is required and there is no functional group.
3 - 68 Creating an Outbound Relationship Using Partners Stage Description 3 Create and register the inbound translation object to be used with this relationship. Reference See the Application Integration User’s Guide for more information about creating a translation object. Also see Registering New Translation Objects on page 2 - 7 for more information. 4 Select at least one outbound translation object.
Using Partners Procedure Creating an Outbound Relationship 3 - 69 To create an outbound relationship, complete the following steps: Step Action Creating a new outbound relationship 1 From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile for which you want to create an outbound relationship. Click Outbound. System response The system displays the Outbound Relationship Dialog Box.
3 - 70 Creating an Outbound Relationship Using Partners Step Action 6 From the appropriate drop-down lists on the Outbound Relationship dialog box, select the following: ◗ ◗ ◗ ◗ Standard Version Transaction Set Release (for TRADACOMS only) Notes ◗ The contents of these lists are displayed from the translation objects registered in Gentran:Server.
Using Partners Creating an Outbound Relationship Step 2 3 - 71 Action Enter the appropriate information and click Save. System response Saves the information and returns to the Outbound Relationship dialog box. Selecting an outbound translation object 1 On the Outbound Relationship dialog box, click Translation. System response The system displays the Outbound Translation Object Dialog Box. 2 From the drop-down lists, select the translation objects required for this outbound relationship.
3 - 72 Creating an Outbound Relationship Step 2 Using Partners Action Is the required group in the Groups list? ◗ If yes, select the group. Or if you are not using groups, select . Then, click Select. Continue with Selecting an outbound interchange on page 3 - 73. System response This action selects the highlighted group and returns you to the Outbound Relationship dialog box. ◗ 3 If no, continue with the next step to create the group. On the Outbound Group Select dialog box, click New.
Using Partners Creating an Outbound Relationship Step 7 3 - 73 Action Click Envelope to set up the parameters for the generation of the Functional Group segment.
3 - 74 Creating an Outbound Relationship Step 3 Using Partners Action On the Outbound Interchange Select dialog box, click New. System response The system displays the Outbound Interchange Entry Dialog Box. 4 In the Description box, type the interchange description. 5 In the Interchange ID box, type the identification of the interchange. Note The EDI standards define which interchange ID should be used for each type of document.
Using Partners Creating an Outbound Relationship Step 9 3 - 75 Action Click Envelope to set up the parameters for the generation of the interchange segment.
3 - 76 Editing and Deleting Partner Definitions Using Partners Editing and Deleting Partner Definitions Introduction Editing a partner profile The partner definition contains the basic partner profile information to which the system associates the rest of that partner’s records. You can edit nd delete the partner definition from the Partner Editor dialog box. To edit a partner profile, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor.
Using Partners Deleting a partner profile Editing and Deleting Partner Definitions 3 - 77 To delete a partner profile, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the appropriate partner from the Select a Partner list. Click Delete. System response You are prompted to confirm the deletion.
3 - 78 Import File Select Dialog Box Using Partners Routing Partner Profiles 0 Import File Select Dialog Box Introduction Diagram Parts and functions The Import File Select dialog box enables you import a partner into the system. The following illustrates the Import File Select dialog box: The following lists the parts of the Import File Select dialog box and their functions: Part Function Look in Select the folder where the system should look for the file. Displays the current folder.
Using Partners Export File Build Dialog Box 3 - 79 Export File Build Dialog Box Introduction Diagram Parts and functions The Export File Build dialog box enables you to specify the name of a partner export file and begins the export process. The following illustrates the Export File Build dialog box: The following lists the parts of the Export File Build dialog box and their functions: Part Function Save in Select the folder where you want to save the file. Displays the current folder.
3 - 80 Export File Build Dialog Box Using Partners Part Save type Function Select the type of file. Note The default file extension for partners is .par. Save Begins the export process. Cancel Exits the dialog box without making a selection. Help Displays Online Help.
Using Partners Partner Copy Dialog Box 3 - 81 Partner Copy Dialog Box Introduction The partner copy feature allows you to copy partner information. Once you copy the partner, this dialog enables you to change the partner definition and other identifying boxes for the copied partner. Note You must export the partner profile before you copy it. See Exporting Partner Profiles on page 3 - 87 for more information.
3 - 82 Partner Copy Dialog Box Parts and functions Using Partners The following lists the parts of the Partner Copy dialog box and their functions: Part Function Profile ID Specify a unique identifier for the selected partner. Select Partner Accesses the Import File Select Dialog Box, which allows you to select a partner profile to copy. Name Specify a unique name for the partner. Note Make this name as descriptive as possible because this is the name displayed in the partner selection list.
Using Partners Partner Copy Dialog Box Part Interchange Receiver Qualifier 3 - 83 Function Specify your partner's Qualifier as it will appear on the interchange header. Qualifiers are predefined by the EDI standards. The value can be up to four characters. Note If the partner profile uses the ANSI, EDIFACT, ODETTE, UCS, or TDCC standard, you must complete this box. If you do not complete this box, the system uses the value from the copied partner profile's envelope information.
3 - 84 Partner Copy Dialog Box Using Partners Part Recipient Name Function Specify your partner's name. Notes ◗ If the partner profile uses the TRADACOMS standard, you must complete this box. If you do not complete this box, the system uses the value from the copied partner profile's envelope information. ◗ The Recipient Name is mandatory if you do not complete the Recipient Code box. Receiver DUNS+4 Specify the DUNS number of your partner. Save Saves the modified information.
Using Partners Importing Partner Profiles 3 - 85 Importing Partner Profiles Introduction The partner profile defines the parameters that control the processing and structure of inbound and outbound data. As a result, the partner profiles may become complex and may require you to define a significant number of parameters. To simplify this process, Gentran:Server includes the import partner feature, which enables you to import partner details from a file.
3 - 86 Importing Partner Profiles Using Partners Step 4 Action Click Open. System response The system displays the Import dialog box. Note This dialog box allows you verify this partner is the correct one. 5 Click Save to continue. 6 If you are prompted to enter additional partner information, enter that information and click Save. System response The system imports the partner details (if they do not already exist on the system) and any relationships for which there are translation objects.
Using Partners Exporting Partner Profiles 3 - 87 Exporting Partner Profiles Introduction Gentran:Server includes a feature that enables you to export existing partner details to a file. You can also export your partners to disk to use as a backup of your partner system. Note Any tables (cross-reference, lookup, or location) attached to the partner profile are also exported. Reference See the Partner File Layouts appendix in the Administration Guide for more information.
3 - 88 Copying Partner Profiles Using Partners Copying Partner Profiles Introduction The partner copy function enables you to copy partner information so you do not have to type in similar partner profiles from scratch. Instead, you can copy from an existing profile and enter unique partner definition and key enveloping information for the copied partner. The partner copy function provides a quick method for establishing partners that have similar or identical trading relationships.
Using Partners Copying Partner Profiles 3 - 89 Step Action 6 On the Partner Copy dialog box, type a unique profile identifier in the Profile ID box. 7 In the Name box, type the partner name. 8 In the EDI Code box, type the EDI identifier for this partner. Note The system uses this identifier during inbound processing to select the correct partner. 9 If necessary, in the Application Code box, type an application code to identify this partner.
3 - 90 Copying Partner Profiles Using Partners Step Action 6 On the Partner Copy dialog box, type a unique profile identifier in the Profile ID box. 7 In the Name box, type the partner name. 8 In the EDI Code box, type the EDI identifier for this partner. Note The system uses this identifier during inbound processing to select the correct partner. 9 If necessary, in the Application Code box, type an application code to identify this partner.
Using Partners Copying Partner Profiles Step 13 3 - 91 Action Do you need to change the default mailbox? ◗ If yes, select the appropriate mailbox from the Default Mailbox list. Or click New Mailbox to create a new mailbox Then, click Save. ◗ If no, click Save. System response The system completes the partner copy operation, displays a completion message. 14 Click OK. System Response The system returns to the Partner Copy dialog box.
3 - 92 Overview Using Partners Using Partner Tables 0 Overview Introduction Table use Using tables The translation process allows you to set up tables to use information in the Partner database when a document is entered into the system, either from a file or from the Document Editor facility. The Partner Editor allows you to use an internal system partner (Internal System User) to define your company to the system.
Using Partners Partner Tables Dialog Box 3 - 93 Partner Tables Dialog Box Introduction Diagram Parts and functions The Partner Tables dialog box enables you to create, edit, or delete cross-reference or lookup tables. Tables are only used with translation objects that are designed to incorporate that data. When you receive a translation object from Sterling Commerce, you will be informed if you need to create tables to be used with that translation object.
3 - 94 New Table Dialog Box Using Partners New Table Dialog Box Introduction Diagram Parts and functions The New Table dialog box enables you to create a cross-reference or lookup table. The following illustrates the New Table dialog box: The following lists the parts of the New Tables dialog box and their functions: Part Function Table Name Specify the name of the table. Note The table name must be the same as the name used in the translation object that requires the table.
Using Partners CrossRef Select Dialog Box 3 - 95 CrossRef Select Dialog Box Introduction Diagram Parts and functions The CrossRef Select dialog box contains all cross-reference partner tables. The following illustrates the CrossRef Select dialog box: The following lists the parts of the CrossRef Select dialog box and their functions: Part Function Items Displays a list of table items. Exit Exits the CrossRef Select dialog box.
3 - 96 CrossRef Entry Dialog Box Using Partners CrossRef Entry Dialog Box Introduction Diagram Parts and functions The CrossRef Entry dialog box enables you to create a new table item. The following illustrates the CrossRef Entry dialog box: The following lists the parts of the CrossRef Entry dialog box and their functions: Part Function My Value Specify your data value that corresponds to your partner's data value.
Using Partners Lookup Select Dialog Box 3 - 97 Lookup Select Dialog Box Introduction Diagram Parts and functions The Lookup Select dialog box contains all lookup partner tables. The following illustrates the Lookup Select dialog box. The following lists the parts of the Lookup Select dialog box and their functions: Part Function Items Displays a list of table items. Exit Exits the Lookup Select dialog box. New Accesses the Lookup Entry Dialog Box, which allows you to create a new table item.
3 - 98 Lookup Entry Dialog Box Using Partners Lookup Entry Dialog Box Introduction Diagram Parts and functions The Lookup Entry dialog box enables you to create a new table item. The following illustrates the Lookup Entry dialog box: The following lists the parts of the Lookup Entry dialog box and their functions: Part Function Lookup Value Specify the value that will be looked up in the data during inbound or outbound processing. Description Specify a description of the code.
Using Partners Table Export File Build Dialog Box 3 - 99 Table Export File Build Dialog Box Introduction The Table Export function allows you to export partner cross-reference and lookup tables to a sequential file. This allows you to define a table for one trading partner and copy that table to another partner profile. Notes ◗ You can only export Gentran:Server partner tables. ◗ Diagram Parts and functions The default file extension for cross-reference tables is .xrf.
3 - 100 Table Export File Build Dialog Box Using Partners Part Function Save Begins the table export process. Cancel Exits the dialog box without making a selection. Help Displays Online Help.
Using Partners Table Import File Select Dialog Box 3 - 101 Table Import File Select Dialog Box Introduction The Table Import function allows you to import partner cross-reference and lookup tables from a sequential file. This allows you to import tables created for another partner profile, share tables with other users of Gentran:Server, and build tables outside of Gentran:Server by formatting your data in the export file layout. Notes ◗ You can only import Gentran:Server partner tables.
3 - 102 Table Import File Select Dialog Box Using Partners Part Function Open Begins the import process for the selected partner table file. Cancel Cancels the action and exits the dialog box. Help Displays Online Help.
Using Partners Creating Partner Tables 3 - 103 Creating Partner Tables Procedure To create a partner table, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile or the system partner (Internal System User) for which you want to create a Cross-reference or Lookup table. Click Tables. System Response The system displays the Partner Tables Dialog Box. 3 Click New.
3 - 104 Creating Partner Tables Using Partners Step 7 Action Click New. System response Displays either the CrossRef Entry Dialog Box or Lookup Entry Dialog Box depending on which type of table you selected in Step 5. 8 Type the following table values: ◗ Two values for a cross-reference and one value for a lookup table ◗ A description Note How your data is used depends on how the translation object is defined. Consult with the translation object designer if you are unclear about what is required.
Using Partners Editing Partner Tables 3 - 105 Editing Partner Tables Procedure To edit a partner table, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile or the system partner (Internal System User) for which you want to modify a Cross-reference or Lookup table. Click Tables. System Response The system displays the Partner Tables Dialog Box.
3 - 106 Deleting Entries in a Partner Table Using Partners Deleting Entries in a Partner Table Procedure To delete entries in a partner table, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile or the system partner (Internal System User) for which you want to delete a table entry. Click Tables. System Response The system displays the Partner Tables Dialog Box.
Using Partners Deleting Partner Tables 3 - 107 Deleting Partner Tables Procedure To delete a partner table, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile for which you want to delete a table. Click Tables. System Response The system displays the Partner Tables Dialog Box 3 ◗ ◗ Select the table you want to delete. Click Delete.
3 - 108 Exporting Partner Tables Using Partners Exporting Partner Tables Introduction The Table Export function allows you to export partner cross-reference and lookup tables to a sequential file. This allows you to define a table for one trading partner and copy that table to another partner profile. Reference See the Partner File Layouts appendix in the Administration Guide for more information. Export file layout Typically, you export and then import tables created for another partner profile.
Using Partners Export file layout (contd) Exporting Partner Tables 3 - 109 Cross-reference table fields The following table identifies the fields in cross-reference tables. Mandatory fields are designated with an asterisk (*). Field Description PartnerKEY* Unique identifier for the partner TableCode For cross-reference, this value is “C”. TableName* Descriptive name for the table This value is displayed in the table selection list.
3 - 110 Exporting Partner Tables Using Partners Step 4 Action From the Save in drop-down list, select the location of the exported table file. Note You can only export Gentran:Server partner tables. 5 ◗ Type the export file name in the File name box. ◗ OR Select it from the list. Note The default file extension for cross-reference tables is .xrf. The default file extension for lookup tables is .lkp. 6 Click Save to begin the export process.
Using Partners Importing Partner Tables 3 - 111 Importing Partner Tables Introduction The Table Import function allows you to import partner cross-reference and lookup tables from a sequential file. This allows you to import tables created for another partner profile and build tables outside of Gentran:Server by formatting your data in the export file layout. Reference See the Partner File Layouts appendix in the Administration Guide for more information.
3 - 112 Importing Partner Tables Using Partners Step 6 Action Click Open to begin the import process. Note When the export process is complete the system displays an informational dialog box. 7 Click OK. System Response The system returns to the Partner Tables dialog box. 8 Click Exit. System Response The system returns to the Partner Editor dialog box.
Using Partners Overview 3 - 113 Using Partner Locations 0 Overview Introduction Each partner profile may have many associated location tables. The location tables may contain address- and contact-related information about the partner. You can use location tables in many different ways. Locations are referenced in translation objects through one of the location keys (reference codes). Locations are used only if you use a translation object that specifically accesses those locations.
3 - 114 Location Select Dialog Box Using Partners Location Select Dialog Box Introduction Diagram Parts and functions The Location Select dialog box allows you to add, edit, and delete partner-specific name and address information. Locations are only used with translation objects that are designed to incorporate that data.
Using Partners Location Entry Dialog Box 3 - 115 Location Entry Dialog Box Introduction Diagram Parts and functions The Location Entry dialog box enables you to create and edit location information. The following illustrates the Location Entry dialog box: The following lists the parts of the Location Entry dialog box and their functions: Part Name Function Specify the name of this trading partner location.
3 - 116 Location Entry Dialog Box Using Partners Part Function Reference Code2 Specify a reference code to identify the location being defined (such as a DUNS number). Contact Specify the name of a personal contact. Address1 Address2 Address3 Specify the partner’s business address. City Specify the partner’s city. State Specify the partner’s state. Zip Code Specify the partner’s zip or postal code. Country Specify the partner’s country. Phone Specify the partner’s phone number.
Using Partners Creating Partner Locations 3 - 117 Creating Partner Locations Procedure To create partner locations, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile or the system partner (Internal System User) for which you want to create a location. Click Locations. System Response The system displays the Location Select Dialog Box. 3 Click New.
3 - 118 Editing Partner Locations Using Partners Editing Partner Locations Procedure To edit a partner location, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile or the system partner (Internal System User) for which you want to create a location. Click Locations. System Response The system displays the Location Select Dialog Box.
Using Partners Delete Partner Locations 3 - 119 Delete Partner Locations Procedure To delete a partner location and all associated records, complete the following steps: Step 1 Action From the Tools menu, select Partner Editor. System Response The system displays the Partner Editor Dialog Box. 2 ◗ ◗ Select the partner profile or the system partner (Internal System User) for which you want to create a location. Click Locations. System Response The system displays the Location Select Dialog Box.
3 - 120 Delete Partner Locations Gentran:Server for Windows – November 2005 Using Partners Gentran:Server for Windows User’s Guide
4 - 1 -1 CHAPTER 4 Using Documents Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 - 3 Document Browsers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 - 4 ◗ Accessing the Document Browsers . . . . . . . . . . . . . . . . . . . . . . . .4 - 4 ◗ In Documents Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 - 6 ◗ ?In Documents Browser . . . . . . . . . . . . . . . . . . . . . . .
Using Documents 4-2 Deleting Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 - 48 ◗ Printing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 - 49 Routing Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .4 - 51 ◗ Moving Documents to the In Drawer . . . . . . . . . . . . . . . . . . . . .4 - 51 ◗ Copying a Document (to Reprocess and Resend) . . . . . . . . . . . .4 - 52 ◗ Posting Documents . . . .
Using Documents Introduction 4-3 Introduction In this chapter EDI documents This chapter explains how to use the Gentran:Server document functions, including: ◗ creating and editing documents ◗ managing documents ◗ routing documents Gentran:Server tracks the relationship between an EDI document and the corresponding application data. For import processing, the system makes a persistent copy of the application data at the start of processing.
4-4 Accessing the Document Browsers Using Documents Document Browsers 0 Accessing the Document Browsers Introduction Summary dialog boxes You can access document browsers in Gentran:Server in one of three ways: ◗ The Desk gives you access to the In Documents, ?In Documents, Workspace, Out Documents, ?Out Documents, Interchanges, In Drawer, and Out Drawer.
Using Documents Accessing the Document Browsers Part RefData 4-5 Function Displays the reference data assigned by the translation object designer to identify this document: ◗ Segment/element positional value (such as a PO Number for a purchase order) ◗ Blank (no reference data is assigned) Note In the browsers, you can click a column heading to sort the display by that values in that column.
4-6 In Documents Browser Using Documents In Documents Browser Introduction Diagram Parts and functions The In Documents browser contains a list of documents that the system received but that have not yet been processed by the user. After the documents are processed (printed or exported) the documents are transferred to the In Drawer.
Using Documents In Documents Browser Part 4-7 Function Export Accesses the Select Export Method Dialog Box, which allows you to export the selected document Move Moves the selected document to the In Drawer. Receive Accesses the Communication Session dialog, which allows you to begin a receive-only session. Refresh Refreshes the display of the browser. Close Closes the browser. Help Displays Online Help.
4-8 ?In Documents Browser Using Documents ?In Documents Browser Introduction Diagram Parts and functions The ?In Documents browser contains a list of documents that the system received but failed compliance checking or do not have an identifiable partner or transaction set.
Using Documents ?In Documents Browser Part 4-9 Function Export Accesses the Select Export Method Dialog Box, which allows you to export the selected document Move Moves the selected document to the In Drawer. Refresh Refreshes the display of the browser. Close Closes the browser. Help Displays Online Help.
4 - 10 In Drawer Browser Using Documents In Drawer Browser Introduction Diagram Parts and functions The In Drawer browser contains a list of documents that the system received and processed. The following illustrates the In Drawer browser: The following lists the parts of the In Drawer browser and their functions: Part Function View Accesses the View Choice Dialog Box, which allows you view the selected document.
Using Documents In Drawer Browser Part Respond 4 - 11 Function Creates a turnaround document in response to the selected document or documents. Note The Respond function is only valid when one or more documents are selected and Turn Around translation objects exist for the selected documents. Reference See Inbound Translation Object Dialog Box on page 3 - 15 for more information. Refresh Refreshes the display of the browser. Close Closes the browser. Help Displays Online Help.
4 - 12 Workspace Browser Using Documents Workspace Browser Introduction Diagram Parts and functions The Workspace browser contains a list of documents that the system received but that have not yet been processed by the user. After the documents are processed (printed or exported) the documents are transferred to the In Drawer.
Using Documents Workspace Browser Part Post 4 - 13 Function Moves the selected compliant document to the Out Documents Browser. Note Post documents to the Out Documents before sending them. New Accesses the Create New Document dialog box, which allows you to select a partner/transaction set combination for which you want to enter a new document using the Document Editor facility.
4 - 14 Out Documents Browser Using Documents Out Documents Browser Introduction Diagram Parts and functions The Out Documents browser contains a list of documents that are ready to be sent. After the documents are successfully sent, they are automatically transferred to the Out Drawer.
Using Documents Out Documents Browser Part Send 4 - 15 Function Accesses the Send/Receive dialog box, which enables you to manually start a communications session to send data. Notes ◗ Only selected documents will be enveloped and sent. If no documents are selected then all documents will be sent. Successfully sent documents will be moved to the Out Drawer. ◗ Initiating a Send session also prompts the system to receive any documents that are waiting to be received.
4 - 16 ?Out Documents Browser Using Documents ?Out Documents Browser Introduction Diagram Parts and functions The ?Out Documents browser contains a list of documents that were imported into the system but are invalid. The following illustrates the ?Out Documents browser: The following lists the parts of the ?Out Documents browser and their functions: Part Function View Accesses the View Choice Dialog Box, which allows you view the selected document.
Using Documents Out Drawer Browser 4 - 17 Out Drawer Browser Introduction Diagram Parts and functions The Out Drawer browser contains a list of documents that the system successfully sent. The following illustrates the Out Drawer browser: The following lists the parts of the Out Drawer browser and their functions: Part Function View Accesses the View Choice Dialog Box, which allows you view the selected document.
4 - 18 Out Drawer Browser Using Documents Part Function Ack Changes the status of the selected documents to Acknowledged. Refresh Refreshes the browser display. Close Closes the browser. Help Displays Online Help.
Using Documents Processing Browser 4 - 19 Processing Browser Introduction The Processing browser contains a list of documents that the system is currently processing. Note The Processing browser displays the current status of the processing document. If the document is processing, the status code is set to 1. If the document or acknowledgement is deferred, the status code is set to 2.
4 - 20 View Choice Dialog Box Using Documents Related Dialog Boxes 0 View Choice Dialog Box Introduction Diagram Parts and functions The View Choice dialog box enables you to specify how you want to view the selected document. The following illustrates the View Choice dialog box: The following lists the parts of the View Choice dialog box and their functions. You can select only one of these options. Part Function Gentran Data Displays the raw EDI data.
Using Documents View Choice Dialog Box Part Translator Report 4 - 21 Function Displays a report of the actions the translator took on this document and lists any EDI- or translation object-based compliance errors. Reference See Error Messages in the Administration Guide for more information about translator reports. Data Audit Displays the document tracking information that is available for a single document. Note This function is not available if document level auditing is disabled.
4 - 22 Print Choice Dialog Box Using Documents Print Choice Dialog Box Introduction Diagram Parts and functions The Print Choice dialog box enables you to specify whether you want to print the selected item (document or translation object) or a summary list of all items in the browser.
Using Documents Select Export Method Dialog Box 4 - 23 Select Export Method Dialog Box Introduction The Select Export Method dialog box enables you to write documents to an external file for processing by another application. Notes ◗ There must be a system export translation object for the document or a partner-specific export translation object for the document.
4 - 24 Select Export Method Dialog Box Using Documents Part Function Cancel Exits the dialog box. Help Accesses Online Help.
Using Documents Choose File to Export Document Dialog Box 4 - 25 Choose File to Export Document Dialog Box Introduction The Choose File to Export Document dialog box enables you to specify the name of the file to which the system exports the selected document. Notes ◗ There must be a system export translation object for the document or a partner-specific export translation object for the document.
4 - 26 Application Files to Import Dialog Box Using Documents Application Files to Import Dialog Box Introduction The Application Files to Import dialog box enables you to import data from an external application file. Note Depending on the content of the file, the system may prompt you for partner, transaction, or translation object information. The Import function does not affect any documents that may be selected.
Using Documents Document Search Dialog Box 4 - 27 Document Search Dialog Box Introduction Diagram Parts and functions The Document Search dialog box enables you to specify criteria for which Gentran:Server performs a system-wide search. This enables you to quickly access a subset of documents without searching each browser manually.
4 - 28 Document Search Dialog Box Criteria Document Type Using Documents Description Searches for documents of the specified EDI type. Example 810 identifies an invoice. Application Field 1 Searches for documents with the specified value in Application Field 1. Application Field 2 Searches for documents with the specified value in Application Field 2. Application Field 3 Searches for documents with the specified value in Application Field 3.
Using Documents Filter Dialog Box 4 - 29 Filter Dialog Box Introduction The Filter function can be used when the Out Drawer is active to filter the display of documents by status. If you want to filter the display of documents in the Out Drawer by the document status you can choose not to display documents with a certain status by selecting the check box next to each status that you do not want displayed. Note When you clear a check box, the display of that status is turned “off.
4 - 30 Filter Dialog Box Using Documents Part Function Error from Network Filters for documents that were delivered to a VAN, which detected critical errors in the data. Picked up by Trading Partner Filters for documents that were successfully delivered to a trading partner through a VAN. Acknowledged with No Errors Filters for documents that were acknowledged by your partner with no errors.
Using Documents Creating Documents 4 - 31 Creating and Editing Documents 0 Creating Documents Introduction To create a document using the Document Editor, the system must be set up to support screen entry for the partner/transaction set combination you want to enter. Note The appropriate Screen Entry translation object must be registered and a corresponding Outbound relationship must be set up for the partner.
4 - 32 Creating Documents Using Documents Step 3 Action Select the appropriate partner/transaction set combination from the list and click OK.
Using Documents Creating Documents Step 4 4 - 33 Action Type all the required data items into the boxes on the document translation object. Note If the document contains a looping structure (lower-level detail records such as line items), the input translation object contains a list, as shown below: 5 To access items in a list, highlight the first entry and click New. System response The system displays the list box, as shown below: 6 Enter the data for the item.
4 - 34 Creating Documents Using Documents Step 7 Action If the document contains calculated fields, select Recalculate from the File menu before saving the document. System response The system updates the totals and checks the document for errors. 8 When you are finished entering data, select Save from the File menu. System response The system saves the information and automatically recalculates and check for errors. If errors are found, you are prompted to view the errors.
Using Documents Opening and Editing Documents 4 - 35 Opening and Editing Documents Introduction To edit a document using the Document Editor, you need to set up the system to support screen entry for the partner/transaction set combination you want to edit. Note The appropriate Screen Entry translation object must be loaded and a corresponding outbound relationship must be set up for the partner.
4 - 36 Opening and Editing Documents Step 3 Using Documents Action Click Open. System response The system displays the document in the Document Editor facility, as shown below: 4 Modify the data as required.
Using Documents Opening and Editing Documents Step 5 4 - 37 Action ◗ To add a new line item, highlight the first entry and click New. ◗ To access items in the list, highlight the entry to be changed and click Open (or double-click the item). System response The system displays the list item details, as shown below: 6 You can now change or enter the data for the item. Notes ◗ To move through the entries, use Next and Prev. 7 ◗ To enter a second or subsequent item, click Next or press ALT + T.
4 - 38 Viewing Documents Using Documents Managing Documents 0 Viewing Documents View function The View function enables you to view various types of information, depending on the format selected in the View Choice Dialog Box. The view types include: ◗ Raw input data ◗ External data ◗ EDI-formatted data ◗ Translator report ◗ Data audit ◗ Tracking information Notes ◗ The formatted view option is only active if a Screen Entry translation object is available in the Partner Relationship record.
Using Documents Viewing Documents Step 2 4 - 39 Action Select the type of document for the appropriate partner and click View. System Response The system displays the browser containing those documents. 3 Select a single document from the appropriate browser. 4 Click View. System Response The system displays the View Choice Dialog Box. 5 Select an option to display the input data: ◗ To display raw EDI data, select Gentran Data.
4 - 40 Viewing Documents Viewing a Document from the Interchange Browser Using Documents To view a document from the Interchanges or Restored Interchanges browser, complete the following steps: Step Action 1 From the appropriate area of The Desk, select the Interchanges browser. 2 Select a single document. 3 Click the Data icon on the Toolbar.
Using Documents Viewing Currently Processing Documents 4 - 41 Viewing Currently Processing Documents Processing browser The Processing Browser displays any document that is currently being processed in the Gentran:Server system. This browser enables you to ascertain which documents are currently being processed by you or other users in the Gentran:Server system.
4 - 42 Finding Specific Text in a Document Using Documents Finding Specific Text in a Document Find function Using the Find function Procedure This function enables you to find specified text in the active data-view window. The Find function is available when a data-view is the active window. The following are the data-view windows.
Using Documents Finding Specific Text in a Document Step 1 (contd) 4 - 43 Action To display this window... Do the following: Raw Data View of 1. Select Interchanges from the appropriate area of the The Desk. an Interchange 2. Select an interchange from the Interchanges browser. 3. Selecting Interchanges from the View menu. 4. Selecting Data from the Interchanges cascading menu. Raw Data View of 1. Select a document in the Interchanges browser. a Document 2. Select View from the Commands menu. 3.
4 - 44 Finding Specific Text in a Document Step 7 Using Documents Action Click Find Next to find the first occurrence of the specified text. Notes ◗ If the system locates that text, it is highlighted in the data-view window. ◗ If the system does not find the specified text, the system beeps. If this is the case, skip to step 7. 8 Continue clicking Find Next to find each subsequent occurrence of that text. 9 Click Cancel. System response The system returns to the data-view window.
Using Documents Searching for Documents 4 - 45 Searching for Documents Introduction Procedure The Document Search facility enables you to quickly and easily locate specific documents in the system. This facility returns the available tracking information for each matching document. To search for documents, complete the following steps: Step 1 Action From the Commands menu, select Document Search. System response The system displays the Document Search Dialog Box. 2 Enter the appropriate criteria.
4 - 46 Sorting Documents Using Documents Sorting Documents Procedure To sort documents in any document browser or the Send Queue browser, click the appropriate column heading to sort by that values in that column.
Using Documents Filtering Out Drawer Documents by Status 4 - 47 Filtering Out Drawer Documents by Status Introduction Sorting with Out Drawer browser When the Out Drawer Browser is active, you can use the Filter function to filter the display of documents by status. To filter the document display in the Out Drawer browser, complete the following steps: Step 1 Action From the appropriate area of The Desk, select the Out Drawer. System response The system displays the Out Drawer Summary dialog box.
4 - 48 Deleting Documents Using Documents Deleting Documents Introduction The Delete function is used to remove a document or group of documents from the system. Notes ◗ When a document is deleted, all the associated document information, tracking information, and translation report information is also deleted. When the last document in an interchange is deleted, the interchange entry is also deleted. ◗ Procedure Documents in the Send Queue can only be deleted from the Interchanges Browser.
Using Documents Printing Documents 4 - 49 Printing Documents Introduction Procedure If no documents are selected, the Print function prints a summary list of all documents in the browser.
4 - 50 Printing Documents Using Documents Step Action 5 On the Print Choice Dialog Box, select one of the following options and click OK: ◗ To print selected unformatted documents, select the Selected Items option. ◗ If you want the selected documents printed as formatted (a print translation object must exist for the documents to be printed as formatted), select the Selected Items option and the Formatted check box.
Using Documents Moving Documents to the In Drawer 4 - 51 Routing Documents 0 Moving Documents to the In Drawer Introduction Procedure This function moves a selected document or group of documents to the In Drawer Browser. Documents are automatically moved from the In Documents Browser or ?In Documents Browser to the In Drawer Browser by the system at the completion of a successful export or print.
4 - 52 Copying a Document (to Reprocess and Resend) Using Documents Copying a Document (to Reprocess and Resend) Introduction The Copy function copies a document (that was already sent successfully) to the Workspace Browser so you can modify the document and resend it. The Copy function can only be used when Out Drawer is active. Note This function can result in sending duplicate documents to a trading partner. Reference After you modify the documents, you may want to resend them.
Using Documents Posting Documents 4 - 53 Posting Documents Introduction The Post function moves a selected compliant document or group of compliant documents to the Out Documents Browser. A document is compliant if it conforms to the validation rules as defined by the translation object. A document is designated compliant if the Status column contains OK. If the Status column contains NotOk, the document is not compliant and is not posted.
4 - 54 UnPosting Documents Using Documents UnPosting Documents Introduction The UnPost function moves a selected document or group of documents to the Workspace Browser. You can use UnPost to prevent a document from being sent to a trading partner or to allow the document to be modified before it is sent. The UnPost function can only be used when the Out Documents Browser is the active browser. Note If you modify the document, you must repost it before the system sends it.
Using Documents Responding to Documents 4 - 55 Responding to Documents Introduction The Respond function automatically generates a response document by transferring data from an inbound source document. The Respond function is only available when all of the following are true: ◗ The In Drawer is the currently selected browser. ◗ One or more documents are selected. ◗ Turn Around translation objects exist for the selected documents.
4 - 56 Responding to Documents Using Documents Step 3 Action Select the document or documents for which you want to create a turnaround (response) document and click Respond. System response ◗ The system automatically creates a turnaround document in response to each document you selected by using the Turn Around translation object that you specified in the Partner relationship.
Using Documents Importing Documents 4 - 57 Importing Documents Introduction Gentran:Server allows you to import data from data files as an alternative to using the Document Editor to enter data directly into the system. To import a document, you must have a system import and/or import translation object for the transaction set that is imported, registered with the system. Reference See Registering New Translation Objects on page 2 - 7 for more information.
4 - 58 Importing Documents Using Documents Step 3 Action Select the file or files to be imported and click Open. System response The system imports the documents into the Workspace Browser. The documents either have an OK status (the documents were successfully read and compliance checked) or a NotOK status (the documents failed compliance checking).
Using Documents Exporting Documents 4 - 59 Exporting Documents Introduction To export a document to a data file, an export translation object for the transaction set must be: ◗ Loaded into the system and registered ◗ Set up as the Export translation object in the inbound relationship record for the partner Notes ◗ After performing an export command, any subsequent exports to the same export file increases the size of the file by appending the new external data to this file.
4 - 60 Exporting Documents Using Documents Step 4 Action Select one of the following options and click OK: ◗ To convert all selected documents to data and write them to a single file, select the Export to Single File option. System response The system displays the Choose File to Export Document Dialog Box. ◗ To write selected documents to the files set up in the partner inbound relationship, select the Export to Default Files option.
5 - 1 -1 CHAPTER 5 Using Communications Contents ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 - 2 Send Queue Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 - 3 Communications Session Dialog Box . . . . . . . . . . . . . . . . . . . . . .5 - 4 Process File Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .5 - 5 Sending Document. . . . .
5-2 Overview Using Communications Overview In this chapter Communications feature Send process This chapter explains how to use communications with Gentran:Server. The Communications feature enables you to send and receive data from your trading partners. Gentran:Server uses the Communicator to handle your communication needs.
Using Communications Send Queue Browser 5-3 Send Queue Browser Introduction The Send Queue browser contains a list of documents that are currently queued for the system to send. Note To delete a document that is in the Send Queue, you must open the Interchanges Browser and delete the document from there.
5-4 Communications Session Dialog Box Using Communications Communications Session Dialog Box Introduction Diagram Parts and functions The Communications Session dialog box enables you to select mailboxes and initiate a communications session to send and receive data.
Using Communications Process File Dialog Box 5-5 Process File Dialog Box Introduction Diagram Parts and functions The Process File feature allows you to invoke the post-communications process with any EDI file, as if the file was received via a communications session. The following illustrates the Process File dialog box: The following lists the parts of the Process File dialog box and their functions: Part Function Look in Select the folder where the system should look for the file.
5-6 Sending Document Using Communications Sending Document Procedure To send a selected document or set of documents, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Out Documents. System response The system displays the Out Documents Summary dialog box. Note If the documents to be sent are not in the Out Documents Browser, you must post the documents from the Workspace Browser to the Out Documents Browser.
Using Communications Sending All Documents 5-7 Sending All Documents Introduction Procedure: Method 1 You can send all documents in the Out Documents by two different methods: ◗ Select the Transmit icon on The Desk. ◗ Access the Out Drawer browser and click Send. To send all documents, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Transmit. System response The system displays the Gentran:Server for Windows dialog box.
5-8 Sending All Documents Procedure: Method 2 Using Communications To send all documents, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Out Documents. System response The system displays the Out Documents Summary dialog box. Note If the documents to be sent are not in the Out Documents, you must post the documents from the Workspace to the Out Documents. Reference See Posting Documents on page 4 - 53 for more information.
Using Communications Resending Documents 5-9 Resending Documents Introduction Procedure After a document is successfully enveloped and sent, it is stored in the Out Drawer. If you need to resend the document, you must make a copy of the document and execute the Send process again using the copy. To resend a document, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Out Drawer. System response The system displays the Out Drawer Summary dialog box.
5 - 10 Resending Documents Using Communications Step 8 Action From the appropriate area of The Desk, select Out Documents. System response The system displays the Out Documents Summary dialog box. 9 Select the type of document for the appropriate partner and click View. System response The system displays the Out Documents Browser. 10 Select the documents and click Send. System response The system displays the Gentran:Server for Windows dialog box. 11 Click Yes to start the transmission session.
Using Communications Receiving Documents 5 - 11 Receiving Documents Introduction Any time a Send session is executed, the system automatically checks your Mailbox for any information waiting to be received by your system. If any data is in the Mailbox, it is received without any action from you. If you need to receive information without first sending anything, you must initiate a receive-only session using one of two methods: Procedure: method 1 ◗ From the Commands menu, select the Receive command.
5 - 12 Receiving Documents Using Communications Step 3 Action Click Receive. System response The system displays the Communications Session Dialog Box. 4 ◗ Select one or more mailboxes for which you want to send data. ◗ Click OK to start a communication session to send data. Note This action initiates a communications session and updates the In Documents Browser and ?In Documents Browser with any data received as a result of that session.
Using Communications Viewing the Send Queue 5 - 13 Viewing the Send Queue Introduction The Send Queue browser displays a list of the documents that are currently queued to be sent and enables you to perform document-based tasks similar to those available in the main system browsers. Note The Send Queue contains documents only if a transmission session failed. The documents remain in the Send Queue until a successful transmission session occurs; no user intervention is required.
5 - 14 Processing Data Files Using Communications Processing Data Files Introduction Procedure The Process File feature invokes the post-communications process with any data file, as if the file was received via a communications session. This enables you to process a data file from a disk or anywhere on your system. To send a data file to the Communicator, complete the following steps: Step 1 Action From the Commands menu, select Process File.
6 - 1 -1 CHAPTER 6 Using External Data Contents ◗ ◗ ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 - 2 External Data Summary Viewer . . . . . . . . . . . . . . . . . . . . . . . . . .6 - 3 External Data Filter Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . .6 - 6 Viewing External Data Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . .6 - 8 Filtering External Data Files . . . . .
6-2 Overview Using External Data Overview In this chapter This chapter explains how to use external data with Gentran:Server. References See the following for more information: External data ◗ Restoring Archived Data on page 10 - 44 ◗ Interchanges Browser on page 7 - 3 Gentran:Server can track the relationship between an EDI document or interchange and the corresponding external (application) data.
Using External Data External Data Summary Viewer 6-3 External Data Summary Viewer Introduction The External Data Summary Viewer enables you to view a list of all external data files associated with documents or interchanges that were sent or received. The External Data Summary Viewer can always be accessed.
6-4 External Data Summary Viewer Diagram Parts and functions Using External Data The following illustrates the External Data Summary Viewer with external data, EDI data, and translator report options turned on: The following lists the parts of the External Data Summary Viewer and their functions: Part Function Status bar Displays the filer specifications from the External Data Filter Dialog Box.
Using External Data External Data Summary Viewer Part Icons 6-5 Function middle right pane—Gentran Data Displays the associated document in EDI format (if this option is selected from the View\External Data menu). (lower right pane—Export Document Summary Translator Report Displays a report of the external actions the translator took on this document and lists any EDI- or translation objectbased compliance errors (if this option is selected from the View\External Data menu).
6-6 External Data Filter Dialog Box Using External Data External Data Filter Dialog Box Introduction The External Data Filter dialog box allows you to filter the display of external data files by date and system action (process file, mailbox process file, import, mailbox import, send, and export). To access When the External Data Browser is active, select Filter from the Commands menu. Or, from the Options menu, select Preferences and click on the External Data Filter tab.
Using External Data External Data Filter Dialog Box Part Date To 6-7 Function Select the end date and time of a date/time range, to which the system filters the display of external data files. Note The Date To box is not active if either the No Date/Time Checking check box is selected or the Always Current check box is selected. Always Current Indicate that the end date for the date range is always the current system date and time.
6-8 Viewing External Data Files Using External Data Viewing External Data Files Procedure To view external data files, complete the following steps: Step 1 Action From the View menu, select External Data\Browser. System response The system displays the External Data Summary Viewer. 2 Do you want to filter the display of external data files by action or date? ◗ If yes, see Filtering External Data Files on page 6 - 9. ◗ If no, continue with step 3. 3 Select an external data file.
Using External Data Filtering External Data Files 6-9 Filtering External Data Files Introduction Procedure When the External Data Summary viewer is active, the Filter function enables you to filter the display of external data files by date and action. To sort external data files by date and/or action, complete the following steps: Step 1 Action From the View menu, select External Data\Browser. System response The system displays the External Data Summary Viewer.
6 - 10 Filtering External Data Files Using External Data Step 6 Action Do you want to filter the display of external data files by action? ◗ If yes, from the Action list, select the actions that you want displayed. Note The default display is all actions, but you can click actions to clear them and change the display. Alternately, you can click Unselect All Actions to clear all actions, so you can then click the one or more actions to select them. At least one action must be selected.
7 - 1 -1 CHAPTER 7 Using Interchanges Contents ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 - 2 Interchanges Browser . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 - 3 Interchange Filter Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . .7 - 8 Viewing Interchanges . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
7-2 Overview Using Interchanges Overview In this chapter This chapter explains how to use interchanges with Gentran:Server. Reference See Restoring Archived Data on page 10 - 44 for more information about the Restored Interchanges browser. Interchanges browser The Interchanges browser enables you to do any of the following: ◗ View a hierarchical list of all the interchanges, group, and documents that were sent or received.
Using Interchanges Interchanges Browser 7-3 Interchanges Browser Introduction The Interchanges browser enables you to view a list of all the interchanges, groups, and documents that were sent or received. The Interchanges browser can always be accessed. This browser contains status information about the interchanges (such as whether or not a functional acknowledgement was received and the status of that acknowledgement).
7-4 Interchanges Browser Using Interchanges Level Document Information displayed (in middle pane How to access Double-click a group. ◗ Document compliant status ◗ Document control number ◗ Document type ◗ Document name ◗ Reference data ◗ Document compliant status ◗ Transaction acknowledgement status Note If any of these components are missing or not appropriate for a particular document, they are not displayed. document data Double-click a document.
Using Interchanges Diagram Parts and functions Interchanges Browser 7-5 The following illustrates the Interchanges browser with external data, EDI data, and translator report options turned on: The following lists the parts of the Interchanges browser and their functions. Part Status bar Function Reflects the filer specifications from the Interchange Filter Dialog Box. Note The Electronic Commerce Manager status bar is updated when you select a single item from the middle pane.
7-6 Interchanges Browser Using Interchanges Part middle pane— detailed list Function Displays a detailed list of the selected interchange, group, or document. The information displayed depends on the level. Notes ◗ To select multiple items, press and hold the CTRL key while selecting the items. ◗ upper right pane—External Data middle right pane—Gentran Data Displays the data file used in translation (if this option is selected from the View\Interchanges menu).
Using Interchanges Document level status icons Interchanges Browser 7-7 The following lists the status icons that the system may use at the document level on the Interchanges browser: Status Icon Description OK (green) — Indicates that the documents are fully compliant with the EDI standard and are eligible for further processing. NotOK (red) — Indicates one of the following: Duplicate Gentran:Server for Windows User’s Guide ◗ The document failed to comply with the EDI standard.
7-8 Interchange Filter Dialog Box Using Interchanges Interchange Filter Dialog Box Introduction The Interchange Filter dialog box allows you to filter the display of interchanges by date, partner, and direction (inbound and outbound). Note You can set global Interchange Filter preferences in the Gentran:Server Preferences dialog box on Interchange Filter tab. Access the Preferences dialog box by selecting Preferences from the Options menu.
Using Interchanges Interchange Filter Dialog Box Part Date To 7-9 Function Select the end date of a date range, from which the system should filter the display of interchanges. Note The Date To box is not active if either the No Date/Time Checking check box is selected or if the Always Current check box is selected. Always Current Indicate that the end date for the date range is always the current system date and time.
7 - 10 Viewing Interchanges Using Interchanges Viewing Interchanges Procedure To view interchanges, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Interchanges. System response The system displays the Interchanges Browser. Note To refresh the display of the Interchanges browser, right-click the middle pane and select Refresh from the shortcut menu (or press F5).
Using Interchanges Viewing Interchanges Step 4 (contd) Action To view the translator report for a single selected interchange, Select View > Interchanges > Translator Report. To print a selected interchange or a summary of interchanges, Print from the File menu. To delete a selected interchange and all associated documents, Select Document > Delete.
7 - 12 Filtering the Display of Interchanges Using Interchanges Filtering the Display of Interchanges Introduction Procedure When the Interchanges browser is active, the Filter function enables you to filter the display of interchanges by date, partner, and direction (inbound and outbound). To filter interchanges by partner and/or date, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Interchanges. System response The system displays the Interchanges Browser.
Using Interchanges Filtering the Display of Interchanges Step 6 7 - 13 Action Do you want to filter the display of interchanges by partner? ◗ If yes, select the partners that you want displayed from the Partner list (lists all partner profiles on your system). Note The default display is all partners, but you can click partner profiles to clear them and change the display. Alternately, you can click Unselect All Partners to deselect all partner profiles.
7 - 14 Viewing Documents within Interchanges Using Interchanges Viewing Documents within Interchanges Introduction Procedure You can view the individual documents in an interchange as long as a screen entry translation object for each document is available on your system. Use this procedure to view the documents within an interchange. Step 1 Action From the appropriate area of The Desk, select Interchanges. System response The system displays the Interchanges Browser.
Using Interchanges Viewing Documents within Interchanges 7 - 15 Step Action 3 With a document selected, use the following table to determine your next step: Gentran:Server for Windows User’s Guide To view a translator report of the actions the translator took on this document, Select View > Interchanges > Translator Report. To view the content of a single selected interchange in raw EDI data format, Select View > Interchanges > Gentran Data.
7 - 16 Attaching Interchanges to a Partner Using Interchanges Attaching Interchanges to a Partner Introduction The Attach to Partner dialog box can be accessed when the Interchanges browser is active and one interchange is selected. The Attach function enables you to link the interchanges to a partner. Use this function if you received documents that did not have an identifiable partner and are now listed without a partner in the ?In Documents browser.
Using Interchanges Attaching Interchanges to a Partner 7 - 17 Step Action 7 Use the following table to determine what to select on the dialog box: If your partner has more than one interchange definition, 1. Select the appropriate interchange definition. If your partner has more than one group definition, 1. Select the appropriate group definition. 2. Click OK. 2. click OK. 1. Select the appropriate relationship If your partner has more definition.
7 - 18 Resending Interchanges Using Interchanges Resending Interchanges Introduction There are two ways to resend interchanges: ◗ To automatically resend all outbound interchanges, you can set the Send Options preference. ◗ To resend specific outbound interchanges, you can use the Resend command from the Interchanges browser. Note You can only resend interchanges that were previously sent or that have a status of Ready to send.
Using Interchanges Resending a specific interchange Resending Interchanges 7 - 19 To resend a specific outbound interchange, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Interchanges. System response The system displays the Interchanges Browser. 2 Select the outbound interchange that needs to be resent. 3 From the Document menu, select Resend. System response The system displays the Gentran:Server for Windows dialog box.
7 - 20 Manually Acknowledging an Interchange, Group, or Document Using Interchanges Manually Acknowledging an Interchange, Group, or Document Introduction The Acknowledge function does not generate an acknowledgement; it merely changes the status of the outbound document.The status of an interchange, group, or document in the Interchanges browser may need to be manually set to acknowledged for many reasons.
8 - 1 -1 CHAPTER 8 Using Acknowledgements Contents ◗ ◗ ◗ ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .8 - 2 Defining Inbound Acknowledgement Criteria . . . . . . . . . . . . . . .8 - 3 Defining Outbound Acknowledgement Criteria . . . . . . . . . . . . . .8 - 6 Manually Acknowledging Documents . . . . . . . . . . . . . . . . . . . .8 - 10 Special Considerations for EDIFACT Acknowledgements . . . .
8-2 Overview Using Acknowledgements Overview In this chapter Acknowledgement This chapter explains how to use Gentran:Server acknowledgements, including the following topics: ◗ Defining acknowledgement criteria (inbound) ◗ Defining acknowledgement criteria (outbound) ◗ Manually acknowledging a document, group, or interchange ◗ Checking for overdue acknowledgements Acknowledgements are sent to a trading partner to inform them that you received a transmission they sent and to inform them of any e
Using Acknowledgements Defining Inbound Acknowledgement Criteria 8-3 Defining Inbound Acknowledgement Criteria Introduction The criteria that the system uses to acknowledge inbound documents, functional groups, and interchanges is defined at the partner level on the Partner Editor Inbound Relationship dialog boxes. The translation objects used by the system to generate functional acknowledgements are included as system translation objects and are registered automatically when you install Gentran:Server.
8-4 Defining Inbound Acknowledgement Criteria Procedure Using Acknowledgements To define criteria to generate acknowledgements, complete the following steps: Step Action 1 Document acknowledgement criteria is defined when you set up the partner relationship using the Advanced options on the Inbound Relationship Dialog Box, which are illustrated below. Note If you select Immediate acknowledgement processing, acknowledgement reconciliation occurs during the inbound break session.
Using Acknowledgements Defining Inbound Acknowledgement Criteria 8-5 Step Action 2 Functional Group acknowledgement criteria is defined when you set up the Inbound Group Entry using the Advanced options on the Inbound Group Entry Dialog Box, as illustrated below. Reference See Selecting an inbound functional group for more information about setting parameters on the Inbound Group Entry dialog box.
8-6 Defining Outbound Acknowledgement Criteria Using Acknowledgements Defining Outbound Acknowledgement Criteria Introduction Reconciling documents and their acknowledgements is a function that the system automatically performs for you. The translation objects that are necessary to process the acknowledgements you receive are included as system translation objects and are registered when you install Gentran:Server.
Using Acknowledgements Procedure Defining Outbound Acknowledgement Criteria 8-7 To set up the level of acknowledgements that you expect to receive from your partners, complete the following steps: Step 1 Action The requirement for receiving interchange acknowledgements is set in the Advanced section of the Outbound Interchange Entry Dialog Box, as illustrated below.
8-8 Defining Outbound Acknowledgement Criteria Using Acknowledgements Step Action 2 The requirement for receiving functional group acknowledgements is set in the Advanced section of the Outbound Group Entry Dialog Box, as illustrated below. Recommendation Do not change the translation objects in the Group Transl. Obj. and Acknowledge Transl. Obj. lists, unless you are certain of the result.
Using Acknowledgements Defining Outbound Acknowledgement Criteria Step 3 8-9 Action The requirement for receiving transaction set acknowledgements is set in the Advanced section of the Outbound Relationship Dialog Box, as illustrated below. Reference See Finalizing the outbound relationship on page 3 - 75 for more information about setting parameters on the Outbound Relationship dialog box.
8 - 10 Manually Acknowledging Documents Using Acknowledgements Manually Acknowledging Documents Introduction The Acknowledge function does not generate an acknowledgement; it merely changes the status of the outbound document.The status of a document in the Out Drawer browser may need to be manually set to Acknowledged for many reasons. Example You have contacted a partner about an overdue document, and that partner verified that it was received but they are not sending you an acknowledgement.
Using Acknowledgements Special Considerations for EDIFACT Acknowledgements 8 - 11 Special Considerations for EDIFACT Acknowledgements Introduction When creating an outbound EDIFACT Control document, the default system behavior is to extract the Sender ID and Receiver ID from the Internal System User partner. According to the EDIFACT standard, the Sender ID and Receiver ID in the UCI and UCF record of the Control document should contain the values from the Inbound UNB and UNG segment, respectively.
8 - 12 Checking for Overdue Acknowledgements Using Acknowledgements Checking for Overdue Acknowledgements Introduction You can manually check for overdue acknowledgements by using the Overdue Check feature. Note You can specify the frequency at which the system will check for overdue acknowledgements (in whole minutes) in the System Configuration program. This allows you to disable or reduce the frequency of overdue acknowledgement checking.
9 - 1 -1 CHAPTER 9 Using Tracking Contents ◗ ◗ ◗ ◗ ◗ Gentran:Server for Windows User’s Guide Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9 - 2 Tracking Inbound Information . . . . . . . . . . . . . . . . . . . . . . . . . . .9 - 3 Tracking Outbound Information . . . . . . . . . . . . . . . . . . . . . . . . . .9 - 6 Viewing and Printing Data Audit Information . . . . . . . . . . . . . . .9 - 9 Viewing and Printing Tracking Information . . . . . . . .
9-2 Overview Using Tracking Overview In this chapter Tracking feature This chapter describes how to use the Gentran:Server tracking systems. The system writes a Document Tracking record for every significant event that occurs for a document. For example, a Document Tracking record is written when the document is created, when it is modified, and when it is exported.
Using Tracking Tracking Inbound Information 9-3 Tracking Inbound Information Introduction Process file process For inbound processing, the system may receive an inbound transmission file (such as external data) through the Process File command within Gentran:Server or through a Mailbox message (when the ContentType is configured to Application/EDI). After the file is received by the system, you may either export the file or configure the system to export it automatically.
9-4 Tracking Inbound Information Mailbox process file process Using Tracking When data enters the system through a mailbox, all associated message identifiers are tracked using the following process: Stage Description 1 Your trading partner creates a data file (in which ContentType is set to Application/EDI. An associated message ID is created in the Outbox. 2 Your partner sends it to your Gentran Application Inbox, which creates a new target message ID.
Using Tracking Export process Tracking Inbound Information 9-5 Data that is exported is already in the system, so the external data that creates the export file is the Translator. Therefore, the Translator stores the tracking information in the database. Stage Description 1 The Translator uses the document or documents as input to the export translation object. 2 Depending on the specifications of the translation object, the system generates an export file.
9-6 Tracking Outbound Information Using Tracking Tracking Outbound Information Introduction Import process For outbound processing, the system can import external data through the Import command within Gentran:Server or through a Mailbox message (when the ContentType is configured to Application/Import). After the file is imported into the system, you can send the file or configure Process Control to send the file automatically.
Using Tracking Mailbox import process Tracking Outbound Information 9-7 When an external data file is imported using a Collection Mailbox, all the associated message identifiers are tracked by the system according to the following process: Stage Description 1 When outbound data flows through the system, the Collection Mailbox creates a data file and an associated message ID in its Outbox (with ContentType set to Application/Import).
9-8 Tracking Outbound Information Send process Using Tracking After a file has been imported, the Gentran:Server documents that are created can be sent to a Mailbox according to the following process: Stage Description 1 The system creates an associated Mailbox message in the Gentran Application mailbox. 2 It sends the message to the partner’s mailbox. Like the process file and import actions, the send action has a source and target message ID associated with the external data.
Using Tracking Viewing and Printing Data Audit Information 9-9 Viewing and Printing Data Audit Information Introduction Procedure Typically, you view data audit (document tracking information that is available for a single document) to get information to help resolve a problem with a document. These records can be viewed from any of the document browsers.
9 - 10 Viewing and Printing Tracking Information Using Tracking Viewing and Printing Tracking Information Introduction Procedure This function displays information that tracks an external data file. These records can be viewed from any of the document browsers. To view or print tracking information, complete the following steps: Step 1 Action From the appropriate area of The Desk, select the desired browser.
10 - 1 -1 CHAPTER 10 Using Archive and Restore Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 - 2 Archiving Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 - 3 ◗ Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10 - 3 ◗ Archive Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
10 - 2 Introduction Using Archive and Restore Introduction In this chapter Archive feature This chapter explains how to use the interactive archive and restore feature of Gentran:Server. The Archive feature provides a record of past interchanges (inbound and outbound), application data, and mailbox messages. This enables you to produce an offline archive data file of interchanges, external data, or mailbox messages with stored parameters (archive definitions) that you define.
Using Archive and Restore Overview 10 - 3 Archiving Data 0 Overview Types of data that can be archived The Archive feature enables you to archive the following types of data: ◗ Inbound and outbound interchanges (Gentran EDI) ◗ Mailbox messages (and any corresponding attachments) ◗ External data Note If a document is waiting for acknowledgement processing (acknowledgement generation or reconciliation), you will not be able to archive it until this processing is complete.
10 - 4 Overview The archive process Using Archive and Restore The following table describes the archive process: Stage 1 Description Define the archiving parameters (*.ARD file). The archive parameters available depend on the type of data you are archiving. IF you archive... THEN the available archive parameters are...
Using Archive and Restore Archive Manager 10 - 5 Archive Manager Introduction The Archive Manager is the facility through which you archive and restore data. The Archive Manager enables you to view the following.
10 - 6 Archive Manager Using Archive and Restore IF you select the... THEN you can view...
Using Archive and Restore Archive Manager 10 - 7 IF you select the... THEN you can view... attachment summary information, including the following: ◗ attachment ID ◗ content type ◗ filename data audits file, which is viewed either in an external viewer (the default viewer is Notepad) or on screen in the Archive Manager. Note When viewing raw-EDI or external data, you can switch from Text to Hex format by selecting the appropriate command from the View menu.
10 - 8 Archive Manager Diagram Parts and functions Using Archive and Restore The following illustrates the Archive Manager, shown with the Archive tree expanded and a Mailbox message selected: The following lists the parts of the Archive Manager and their functions: Part File menu Gentran:Server for Windows – November 2005 Function Exit Archive Manager.
Using Archive and Restore Archive Manager Part Archives menu Definitions menu Help menu 10 - 9 Function Contains the following options: ◗ Restore data. ◗ Mark data for restoration (single item or all items). ◗ Unmark data (single item or all items). ◗ Refresh (archive-level). ◗ View data audits at the interchange, document message, or external data level. ◗ View data audits and data at the interchange, document, attachment, or external data level. ◗ Delete archive files.
10 - 10 Archive Manager Using Archive and Restore Part Upper right pane Lower right pane Gentran:Server for Windows – November 2005 Function The display depends on the level and type of the selection, but may contain any one of the following: ◗ file information (start, end, number of items archived, and if any items were deleted) ◗ interchange information ◗ group information ◗ document information ◗ message information ◗ attachment information ◗ external data information ◗ data audit in
Using Archive and Restore Gentran EDI Archive Definition Dialog Box 10 - 11 Gentran EDI Archive Definition Dialog Box Diagram Parts and functions The following illustrates the Gentran EDI Archive Definition dialog box: The following lists the parts of the Gentran EDI Archive Definition dialog box and their functions: Part Name Function Specify the name of the archive definition file. Note This name must be unique.
10 - 12 Gentran EDI Archive Definition Dialog Box Part Delete Using Archive and Restore Function Deletes the selected Gentran EDI criteria from the system. Warning The system removes the criteria without prompting you to confirm the deletion. Partner Displays the partner profile ID. Direction Displays the direction of the interchanges. Days Old Displays the age of the interchanges. Processed Status Displays the processed status of the interchanges. The default is All.
Using Archive and Restore Interchange Selection Criteria Dialog Box 10 - 13 Interchange Selection Criteria Dialog Box Diagram Parts and functions The following illustrates the Interchange Selection Criteria dialog box: The following lists the parts of the Interchange Selection Criteria dialog box and their functions: Part Function Partner Select a partner profile ID (default is All). Direction Choose Both (inbound and outbound), Inbound, or Outbound.
10 - 14 Interchange Selection Criteria Dialog Box Using Archive and Restore Part Processed Status Network Status Ack Status Function Select the processed status of the interchanges that are to be archived. Valid values: ◗ All (default) ◗ Received ◗ Sent ◗ ReadyToSend ◗ Queued ◗ Held ◗ SendFailed Select the network status of the interchanges that are to be archived.
Using Archive and Restore Interchange Search Dialog Box 10 - 15 Interchange Search Dialog Box Diagram Parts and functions The following illustrates the Interchange Search dialog box: The following lists the parts of the Interchange Search dialog box and their functions: Part Function Partner Select a partner profile ID (default is All). Direction Choose Both (inbound and outbound), Inbound, or Outbound. Control No. Specify a control number.
10 - 16 Interchange Search Dialog Box Using Archive and Restore Part Processed Status Network Status Ack Status Sent Between Function Select the processed status of the interchanges to search for. Valid values: ◗ All (default) ◗ Received ◗ Sent ◗ ReadyToSend ◗ Queued ◗ Held ◗ SendFailed Select the network status of the interchanges to search for.
Using Archive and Restore Interchange Search Dialog Box Part 10 - 17 Function Find Finds the appropriate interchanges based on the criteria you selected and displays them in the Search Results Dialog Box. Cancel Exits the dialog box. Help Accesses Online Help.
10 - 18 Group Search Dialog Box Using Archive and Restore Group Search Dialog Box Diagram Parts and functions The following illustrates the Group Search dialog box: The following lists the parts of the Group Search dialog box and their functions: Part Function Partner Select a partner profile ID (default is All). Direction Choose Both (inbound and outbound), Inbound, or Outbound. Control No. Specify control number. Group ID Specify group identifier.
Using Archive and Restore Group Search Dialog Box Part 10 - 19 Function Find Finds the appropriate groups based on the criteria you selected and displays them in the Search Results Dialog Box. Cancel Exits the dialog box. Help Accesses Online Help.
10 - 20 Document Search Dialog Box Using Archive and Restore Document Search Dialog Box Diagram Parts and functions The following illustrates the Document Search dialog box: The following lists the parts of the Document Search dialog box and their functions: Part Function Partner Select a partner profile ID (default is All). Direction Choose Both (inbound and outbound), Inbound, or Outbound. Control No. Specify a control number. Trans ID Specify a transaction identifier.
Using Archive and Restore Document Search Dialog Box Part Ack Status 10 - 21 Function Select the acknowledgement status of the documents to search for. Valid values: ◗ All (default) ◗ Received ◗ ReconcileWaiting ◗ ReconciledOK ◗ ReconciledErrors ◗ ReconciledPartial ◗ ReconciledReject ◗ ReconcileOverdue Find Finds the appropriate documents based on the criteria you selected and displays them in the Search Results Dialog Box. Cancel Exits the dialog box. Help Accesses Online Help.
10 - 22 Mailbox Archive Definition Dialog Box Using Archive and Restore Mailbox Archive Definition Dialog Box Diagram Parts and functions The following illustrates the Mailbox Archive Definition dialog box: The following lists the parts of the Mailbox Archive Definition dialog box and their functions: Part Name Function Specify the name of the archive definition file. Note This name must be unique. Delete Data After Archive Tell the system to remove the message data after archiving it.
Using Archive and Restore Mailbox Archive Definition Dialog Box Part Delete 10 - 23 Function Deletes the selected mailbox criteria from the system. Warning The system removes the criteria without prompting you to confirm the deletion. Mailbox Displays the mailbox name. Location Displays the location of the messages. Days Old Displays the age (in days) of the messages to be archived. Status Displays the status of the messages that are to be archived. The default is All.
10 - 24 Mailbox Selection Criteria Dialog Box Using Archive and Restore Mailbox Selection Criteria Dialog Box Diagram Parts and functions The following illustrates the Mailbox Selection Criteria dialog box: The following lists the parts of the Mailbox Selection Criteria dialog box and their functions: Part Function Mailbox Select a mailbox (default All). Location Choose Both (Inbox and Outbox), Inbox, or Outbox. Days old Specify the age (in days) of the messages to be archived.
Using Archive and Restore Mailbox Selection Criteria Dialog Box Part Content type 10 - 25 Function Select the content type of the messages. Valid values: ◗ Any (default) ◗ Application/EDI ◗ Application/Document-EDI ◗ Application/Import ◗ Application/rosettanet-agent (only if Gentran:Server for RosettaNet is installed) Note This edit box allows you to enter any content type you created. Save Saves the selection criteria and exits the Mailbox Selection Criteria dialog box.
10 - 26 Mailbox Search Dialog Box Using Archive and Restore Mailbox Search Dialog Box Diagram Parts and functions The following illustrates the Mailbox Search dialog box: The following lists the parts of the Mailbox Search dialog box and their functions: Part Function Mailbox Select a mailbox (default is All). Location Choose Both (Inbox and Outbox), Inbox, or Outbox Status Select the status of the messages to be archived.
Using Archive and Restore Mailbox Search Dialog Box Part Created Between 10 - 27 Function Define a created between range of dates and times to search (in YYYY/MM/DD and HH:MM:SS format). Note Click the arrow to access the calendar control. Sent Between Define a sent between range of dates and times to search (in YYYY/MM/DD and HH:MM:SS format). Note Click the arrow to access the calendar control.
10 - 28 External Data Archive Definition Dialog Box Using Archive and Restore External Data Archive Definition Dialog Box Diagram Parts and functions The following illustrates the External Data Archive Definition dialog box: The following lists the parts of the External Data Archive Definition dialog box and their functions: Part Name Function Specify the name of the archive definition file. Note This name must be unique.
Using Archive and Restore External Data Archive Definition Dialog Box Part Delete 10 - 29 Function Deletes the selected external data criteria from the system. Warning The system removes the criteria without prompting you to confirm the deletion. Action Taken Displays the action taken on the external data file.
10 - 30 External Data Selection Criteria Dialog Box Using Archive and Restore External Data Selection Criteria Dialog Box Diagram Parts and functions The following illustrates the External Data Selection Criteria dialog box: The following lists the parts of the External Data Selection Criteria dialog box and their functions: Part Action Taken Function Select the action to be taken on the external data file.
Using Archive and Restore External Data Search Dialog Box 10 - 31 External Data Search Dialog Box Diagram Parts and functions The following illustrates the External Data Search dialog box: The following lists the parts of the External Data Search dialog box and their functions: Part Action Taken Action Performed Between Function Select the action to be taken on the external data file for which to search.
10 - 32 External Data Search Dialog Box Part Using Archive and Restore Function External Data Key Specify the external data key for which to search. Find Finds the appropriate messages based on the criteria you selected and displays them in the Search Results Dialog Box. Cancel Exits the External Data Search dialog box. Help Accesses Online Help.
Using Archive and Restore Search Results Dialog Box 10 - 33 Search Results Dialog Box Diagram The following illustrates the Search Results dialog box, illustrating the result of a search performed on archived mailbox messages: Parts and functions The following lists the parts of the Search Results dialog box and their functions: Part Function (list) Displays context-specific information, depending on whether you searched for interchanges, groups, documents, messages, or external data.
10 - 34 Search Results Dialog Box Using Archive and Restore Part Previous Function Selects the previous item in the list. Note This button is only enabled if you select an archive file. Next Selects the next item in the list. Note This button is only enabled if you select an archive file. Mark/Unmark Flags the selected item to be restored (or deselect a previously selected item). Note This toggle button is only enabled if you select an archive file. Help Accesses Online Help.
Using Archive and Restore Sort Preferences Dialog Box 10 - 35 Sort Preferences Dialog Box Diagram How to access Parts and functions The following illustrates the Sort Preferences dialog box, which enables you to select how you want the archive data sorted in the Archive tree view: Select Preferences from the Archive menu.
10 - 36 Creating an Archive Definition Using Archive and Restore Creating an Archive Definition Procedure To create an archive definition file, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Archive. System response The system displays the Archive Manager. 2 Expand the Archive tree. Note This is necessary to create a new archive definition.
Using Archive and Restore Creating an Archive Definition Step 7 10 - 37 Action Complete the appropriate parameters. References See the following for more information: ◗ Interchange Selection Criteria Dialog Box on page 10 - 13 ◗ Mailbox Selection Criteria Dialog Box on page 10 - 24 ◗ External Data Selection Criteria Dialog Box on page 10 - 30 Note All elements on the Selection Criteria dialog boxes are automatically set to the defaults, which results in the archival of all data. 8 Click Save.
10 - 38 Archiving Data Using Archive and Restore Archiving Data Before you begin Before archiving data, you must create an archive definition file that contains your selection criteria. Reference See Creating an Archive Definition on page 10 - 36 for more information. Procedure To archive data, complete the following steps: Step Action 1 Use your company’s computer backup process to back up the Gentran:Server system before executing the archive process.
Using Archive and Restore Viewing Archived Data 10 - 39 Viewing Archived Data Procedure To view archived information, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Archive. System response The system displays the Archive Manager. 2 Expand the archive tree and open the appropriate Archives folder.
10 - 40 Viewing Archived Data Using Archive and Restore Step 5 (contd) Action interchange data audit (displayed in the Archive Manager, upper-right pane) ◗ right-click the interchange and ◗ select View\Data Audits from the shortcut menu. interchange tracking information (displayed in the Archive Manager, upper-right pane) ◗ right-click the interchange and ◗ select View\Tracking Info from the shortcut menu.
Using Archive and Restore Viewing Archived Data Step 5 (contd) 10 - 41 Action message information (displayed in the Archive Manager, upper-right pane) select the message. message data audit (displayed in the Archive Manager, upper-right pane) ◗ right-click the message and ◗ select View\Data Audits from the shortcut menu. attachment information (displayed in the Archive Manager, upper-right pane) select the attachment.
10 - 42 Viewing Archived Data Using Archive and Restore Step 5 (contd) Action external data file (displayed in the Archive Manager, lowerright pane) ◗ right-click the external data file and ◗ select View\Data\Screen from the shortcut menu. System response The system displays the information you requested.
Using Archive and Restore Searching Archived Data 10 - 43 Searching Archived Data Introduction Procedure The Archive Manager Search facility enables you to quickly define parameters that are used to search all archive files or one archive file and find a specific piece of information. You can then select the desired information, and the system highlights it in the Archive Manager tree view.
10 - 44 Overview Using Archive and Restore Restoring Archived Data 0 Overview Restore feature The Restore feature enables you to view and reprocess data via the Restored Interchanges browser. When data is restored, the archive data file (*.ARV file) is not altered.You can restore data from the same archive file again, if you wish. Restore caveats To restore data to your system, the following must be true: ◗ The item must have been deleted after it was archived.
Using Archive and Restore Procedure Overview 10 - 45 To restore archived data, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Archive. System response The system displays the Archive Manager. 2 Expand the archive tree and locate the item that you want to restore. 3 Right-click the item and select Mark\Unmark from the shortcut menu. System response The system flags that item for restoration. 4 Click Restore Data.
10 - 46 Restored Interchanges Browser Using Archive and Restore Restored Interchanges Browser Introduction The Restored Interchanges browser enables you to view a list of all interchanges, groups, and documents that were restored from an archive file. This browser contains status information about the interchanges, such as whether a functional acknowledgement was received and the status of that acknowledgement.
Using Archive and Restore Restored Interchanges Browser Level Document 10 - 47 Information displayed (in middle pane) (all information may not appear) How to access Double-click a group ◗ document compliant status ◗ document control number ◗ document type ◗ document name ◗ reference data ◗ document compliant status ◗ transaction acknowledgement status Note If any of these components are missing or not appropriate for a particular document, they are not displayed.
10 - 48 Restored Interchanges Browser Diagram Parts and functions Using Archive and Restore The following illustrates the Restored Interchanges browser: The following lists the parts of the Restored Interchanges browser and their functions: Part Status bar Function Reflects the filer specifications from the Interchange Filter Dialog Box on page 7 - 8. Note The Electronic Commerce Manager status bar is updated when you select a single item from the middle pane.
Using Archive and Restore Restored Interchanges Browser Part middle pane— detailed list 10 - 49 Function Displays detailed information about the document, group, or interchange selected. The information displayed depends on the level. Note ◗ To select multiple items, press and hold the CTRL key while selecting the items. ◗ upper right pane—External Data middle right pane—Gentran Data Displays the data file used in translation (if this option is selected from the View\Restored Interchanges menu).
10 - 50 Restored Interchanges Browser Document level status icons Using Archive and Restore The following lists the status icons that the system may use at the document level on the Restored Interchanges browser: Status Icon Description OK (green) — Indicates that the documents are fully compliant with the EDI standard and are eligible for further processing.
Using Archive and Restore Viewing Restored Interchanges 10 - 51 Viewing Restored Interchanges Procedure To view restored interchanges, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Restored Interchanges. System response The system displays the Restored Interchanges Browser. Note To refresh the display of the Interchanges browser, right-click the middle pane and select Refresh from the shortcut menu (or press F5).
10 - 52 Viewing Restored Interchanges Using Archive and Restore Step 4 (contd.) Action view the corresponding external data file, ◗ Restored Interchanges from the View menu, and then ◗ select External Data from the submenu. Note When viewing raw-EDI or external data, you can switch from Text to Hex format by selecting the appropriate command from the View menu.
Using Archive and Restore Filtering the Display of Restored Interchanges 10 - 53 Filtering the Display of Restored Interchanges Procedure To filter restored interchanges by partner and/or date, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Restored Interchanges. System response The system displays the Restored Interchanges Browser. 2 From the Commands menu, select Filter. System response The system displays the Interchange Filter Dialog Box.
10 - 54 Filtering the Display of Restored Interchanges Step 7 Using Archive and Restore Action Which direction do you want to filter the interchange? Default The default display is both inbound and outbound interchanges. Click the Inbound or Outbound check box to clear the direction. Note At least one of the Direction check boxes must be selected. 8 Click OK. System response The system filters the restored interchange display based on the criteria you selected.
Using Archive and Restore Viewing Restored Documents 10 - 55 Viewing Restored Documents Introduction Procedure You can view the individual documents in an interchange as long as a screen entry translation object for each document is available on your system. To view the documents within a restored interchange, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Restored Interchanges. System response The system displays the Restored Interchanges Browser.
10 - 56 Viewing Restored Documents Using Archive and Restore Step Action 3 With a document selected, use this table to determine your next step. IF you want to... THEN select... view a translator report of the actions the translator took on this document, ◗ Interchanges from the View menu, and then ◗ select Translator Report. view the content of a single selected interchange in raw EDI data format, ◗ Interchanges from the View menu, and then ◗ select Gentran Data from the submenu.
Using Archive and Restore Reprocessing Restored Documents 10 - 57 Reprocessing Restored Documents Introduction Procedure To reprocess data from the Restored Interchanges browser, you must use the Copy command to move the selected outbound documents to the Workspace and the compliant inbound documents to the In Documents or ?In Documents browsers. To reprocess data, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Restored Interchanges.
10 - 58 Resending Restored Interchanges Using Archive and Restore Resending Restored Interchanges Introduction To resend outbound interchanges from the Restored Interchanges browser, you must use the Resend command. Note You can only resend interchanges that were previously sent or that have a status of Ready to send. Resend process The following table describes the process that occurs when you resend a selected interchange.
Using Archive and Restore Procedure Resending Restored Interchanges 10 - 59 To resend restored outbound interchanges, complete the following steps: Step 1 Action From the appropriate area of The Desk, select Restored Interchanges. System response The system displays the Restored Interchanges Browser. 2 Select the outbound interchange that needs to be resent. 3 From the Document menu, select Resend. System response The system displays the Gentran:Server for Windows dialog box.
10 - 60 Resending Restored Interchanges Gentran:Server for Windows – November 2005 Using Archive and Restore Gentran:Server for Windows User’s Guide
11 - 1 -1 CHAPTER 11 Using Process Control Contents Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 - 2 Sessions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 - 3 ◗ Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 - 3 ◗ Creating Sessions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .11 - 9 ◗ Editing Sessions. . . . . .
11 - 2 Introduction Using Process Control Introduction In this chapter This chapter explains how to use the Gentran:Server process control. Process control feature Process control feature enables you to automate your message processing. Essentially, you need to tell the system what you want done and when, and process control takes care of it for you automatically. With process control, you can build customized events to initiate the processing functions of Gentran:Server.
Using Process Control Overview 11 - 3 Sessions 0 Overview Introduction A session definition is an integral part of a process control event. The session setup process enables you to configure and edit process control session scripts. Sessions are defined independently from the event, so the same session definition can be scheduled multiple times. What is a session script? A session script consists of a list of commands (Gentran:Server functions) that the system executes in the sequence listed.
11 - 4 Overview Sessions tab parts and functions Using Process Control The following lists the parts of the Process Control dialog box Session tab and their functions: Part Function (list) Displays all currently defined session scripts. Session Displays the script of the currently-selected session. Ins Accesses the Action Setup dialog box so you can insert a script command above the current line. Edit Accesses the Action Setup dialog box so you can modify the selected script command.
Using Process Control Action Setup dialog box Action Setup dialog box parts and functions Overview 11 - 5 The following illustrates the Action Setup dialog box: The following lists the parts of the Action Setup dialog box and their functions: Part Function Command Specification Select which command you want to add to the script.
11 - 6 Overview Commands Using Process Control The following lists the script commands and their actions: Note See the Gentran:Server online Help for detailed information about these commands. Command Exec_Program Action Indicates a program for the system to run. Note When this command is executed, the system writes an informational message to the Audit Log indicating which program (command line in working directory) was run.
Using Process Control Overview Command GDW_Audit_Purge 11 - 7 Action Deletes all audit records in the system. Note The purged Audit Log entries are removed from the database and appended to a text file. To ensure that the text file does not grow unchecked, you may want to use a File_Delete command prior to this command. GDW_Audit_Write Writes a processing user audit message to the Audit Log, based on the specified parameters.
11 - 8 Overview Using Process Control Command GDW_Print Action Performs the Print function. Note You must have a print translation object registered with the system. GDW_Process_File Invokes the post-communications process with any EDI file as if the file was received via a communication session. Note You must have an export translation object registered with the system. Conditions GDW_Receive Performs the Receive Only function.
Using Process Control Creating Sessions 11 - 9 Creating Sessions Procedure To create a process control session, complete the following steps Step Action Creating a session 1 Click Process Control on The Desk. System response The system displays the Gentran:Server Process Control dialog box. 2 Click the Sessions tab to access the sessions options. System response The system displays the Process Control dialog box (Sessions tab). 3 Click New.
11 - 10 Creating Sessions Using Process Control Step 3 Action Complete the boxes in the Command Specification section of the dialog box with the appropriate values. Reference See Commands on page 11 - 6 for more information. 4 5 Do you want to specify a limit (in minutes) on how long this command should process before the system writes a message to the Audit Log? ◗ If yes, select the check box and type the number of minutes in the box. ◗ If no, continue with the next step.
Using Process Control Creating Sessions Step 8 11 - 11 Action Click OK. System response The command is saved and you return to the Gentran:Server Process Control dialog box. 9 Repeat Steps 1 through 8 until you finish adding commands to the session script. Notes ◗ If you need to resequence the commands in the script, use Up and Down. ◗ If you need to edit a command in the script, select that command and click Edit.
11 - 12 Editing Sessions Using Process Control Editing Sessions Introduction If an event calls a session that is currently processing or is activated, you are unable to edit and save the session until the event has either finished processing or you suspend the event. However, you can edit the session and use the Save As function to save it under another name. Reference See Procedure: suspending an event on page 11 - 37 for more information.
Using Process Control Editing Sessions Step 6 11 - 13 Action Do you want to specify a limit (in minutes) on how long this command should process before the system writes a message to the Audit Log? ◗ If yes, select the check box and type the number of minutes in the box. ◗ If no, continue with the next step. 7 After you choose a command, additional boxes may be displayed in the Command Specification section of the dialog box. Complete these boxes with the appropriate values.
11 - 14 Editing Sessions Using Process Control Step 12 Action Repeat Steps 4 through 11 until you finish adding commands to the session script. Use Up and Down if you need to resequence the commands in the script. Note ◗ If you need to edit a command in a script, select that command and click Edit. ◗ 13 If you need to delete a command from a script, select that command and click Delete. Click Save to save the new session script.
Using Process Control Deleting Sessions 11 - 15 Deleting Sessions Introduction If an event calls a session that is currently processing or is activated, you are unable to delete the session until the event has either finished processing or you suspend the event. Reference See Procedure: suspending an event on page 11 - 37 for more information. Procedure To delete a session, complete the following steps: Step 1 Action Click Process Control on The Desk.
11 - 16 Overview Using Process Control Events 0 Overview Introduction Events are a combination of the following: ◗ A time or day to execute or a file name for which the system checks ◗ The controller on which the event is processed ◗ A session definition The Process Control runs events based on whether they are timed or polled. You define the events in a session definition. The Process Control enables you to process an event at a specified time, every day.
Using Process Control Overview 11 - 17 Process Control dialog box (Events tab) The following illustrates the Events tab of the Process Control dialog box: Events tab parts and functions The following lists the parts of the Process Control dialog box Events tab and their functions: Part Function (list) Displays all scheduled events. Controller Select the controller whose events you want filtered. Sort Select how you want the list of events sorted. IF you sort by... THEN the events are listed...
11 - 18 Overview Using Process Control Part Function Seconds Specify the interval (in seconds) at which you want the system to refresh the dialog box (default is 20 seconds). Auto Refresh Indicate whether you want the Process Control dialog box to automatically refresh (so you do not have to click Refresh). New Accesses the Event Setup dialog box so you can create a new event entry. Edit Accesses the Event Setup dialog box so you can modify the selected event entry.
Using Process Control Event Setup dialog box Event Setup dialog box parts and functions Overview 11 - 19 The following illustrates the Event Setup dialog box: The following lists the parts of the Event Setup dialog box and their functions: Part Function Description Enter a description of the event. Session Select one of the sessions you defined on the Sessions tab. Controller Specify the name of the controller on which the event is run.
11 - 20 Overview Using Process Control Part Until Function Specify a stop time for the event. Note You can either use 24-hour HH:MM format or 12-hour HH:MM or H:MM format with the designator "a" (am) or "p" (pm). Note An event will always execute on its end time regardless of the interval that is set. To have an event execute once, do not enter an end time or interval. Minutes Specify an interval of time after which the event is to be executed.
Using Process Control Overview Part 11 - 21 Function Polled tab File name Specify the name of the file for which the system checks. Note You can use a wildcard (*) to specify the name of the file. Browse Accesses the Choose Network Server dialog box so you can browse for the file for which you want the system to check. Result Indicate whether the event should be executed if the result is True or False.
11 - 22 Overview Active Events tab parts and functions Using Process Control The following lists the parts of the Process Control dialog box Active Events tab and their functions: Part Function (Event list) Displays the events that are currently processing. (Session list) Lists each command and the associated parameters for the session script for the event that is currently processing. Note A green arrow indicates which command the system is currently processing.
Using Process Control Creating New Events 11 - 23 Creating New Events Introduction You can specify that the event runs as timed or as polled. If the event is running as “timed,” you must specify a time, a pre-defined calendar and/or days of the week to run, or a date to run one time only. When it is time for the event to be run, the Gentran Scheduler service initiates the processing of the event.
11 - 24 Creating New Events Using Process Control Step 7 Action Do you want to designate this event as a notification type? ◗ If yes, select the check box and continue with Step 2 in Saving the event on page 11 - 26. ◗ If no, continue with the next step. Complete this section if the event is timed 1 In the Time Start box (on the Timed tab), you must fill in a time. Note You must use 24-hour HH:MM format.
Using Process Control Creating New Events Step 5 11 - 25 Action Do you want to select a day or days of the week on which you want this session to be scheduled? ◗ If yes, click the check box next to the days on which the event should be run and continue with Step 6. ◗ If no, continue with Step 6. Note By default, every day of the week is selected. If any days are selected in this section, then the schedule is executed only on those days.
11 - 26 Creating New Events Using Process Control Step 3 Action From the Result list, select True or False. Note ◗ If you select True, you are indicating that the event should only be executed when the specified file is present. ◗ If you select False, you are indicating that the event should be executed only when the specified file does not exist. Saving the event 1 Click OK. System response The event is saved and you exit the Event Setup dialog box. 2 Click OK.
Using Process Control Editing Events 11 - 27 Editing Events Introduction You are not able to edit an event unless the event is suspended. Reference See Procedure: suspending an event on page 11 - 37 for more information. Procedure To edit an existing event, complete the following steps: Step Action Editing an event 1 Click Process Control on The Desk. System response The system displays the Gentran:Server Process Control dialog box. 2 Click the Events tab to display the event options.
11 - 28 Editing Events Using Process Control Step Action Complete this section if the event is timed 1 In the Time Start box (on the Timed tab), type a time. Note You can either use 24-hour HH:MM format or 12-hour HH:MM format with the designator “a” (am) or “p” (pm). 2 If you want to specify a stop time for the event, type that time in the Until box (on the Timed tab). Note You can either use 24-hour HH:MM format or 12-hour HH:MM or H:MM format with the designator “a” (am) or “p” (pm).
Using Process Control Editing Events Step 5 11 - 29 Action Do you want to select a day or days of the week on which you want this session to be scheduled? ◗ If yes, click the check box next to those days and continue with Step 6. ◗ If no, continue with Step 6. Note By default, every day of the week is selected. If any days are selected in this section, then the schedule is executed only on those days. If you select days from this section, you cannot use the Date box.
11 - 30 Editing Events Using Process Control Step 3 Action From the Result list, select True or False. Note ◗ If you select True, you are indicating that the event should only be executed when the specified file is present. ◗ If you select False, you are indicating that the event should be executed only when the specified file does not exist. Saving the event 1 Click OK. System response The event is saved and you exit the Event Setup dialog box. 2 Click OK.
Using Process Control Deleting Events 11 - 31 Deleting Events Introduction You are not able to delete an event unless the event is suspended. Reference See Procedure: suspending an event on page 11 - 37 for more information. Procedure To delete an event, complete the following steps: Step 1 Action Click Process Control on The Desk. System response The system displays the Gentran:Server Process Control dialog box. 2 Click the Events tab to display the event options.
11 - 32 Viewing Events Using Process Control Viewing Events Events tab The Gentran:Server Process Control dialog enables you to view all the events defined in your system.
Using Process Control Procedure: viewing all events Viewing Events 11 - 33 To view all events, complete the following steps: Step 1 Action Click Process Control on The Desk. System response The system displays the Gentran:Server Process Control dialog box. 2 Click the Events tab to display the event options. System response The system displays the Process Control dialog box (Events tab).
11 - 34 Viewing Events Using Process Control Step 5 Action If necessary, change the Refresh options: ◗ If you want to change the interval in which the dialog box is automatically refreshed, type the interval (in seconds) at which you want the system to refresh the dialog box (the default is 20 seconds) in the Seconds box. Valid values are 2 – 300 seconds. Note This value is saved when you change focus on the dialog box (click another box).
Using Process Control Viewing Events Step 3 11 - 35 Action If necessary, change the Refresh options: ◗ If you want to change the interval in which the dialog box is automatically refreshed, type the interval (in seconds) at which you want the system to refresh the dialog box (the default is 20 seconds) in the Seconds box. Valid values are 2 – 300 seconds. Note This value is saved when you change focus on the dialog box (click another box).
11 - 36 Activating and Suspending Events Using Process Control Activating and Suspending Events Introduction The Events tab of the Gentran:Server Process Control dialog enables you to change the status of an event by activating or suspending the event. The indicator in the far left column of the list on the Events tab registers the status of the event.
Using Process Control Procedure: suspending an event Activating and Suspending Events 11 - 37 To suspend an event, complete the following steps: Step 1 Action Click Process Control on The Desk. System response The system displays the Process Control dialog box (Active Events tab). 2 Click the Events tab to display the event options. System response The system displays the Process Control dialog box (Events tab). 3 Select the activated event that you want to suspend and click Suspend.
11 - 38 Executing an Event Immediately Using Process Control Executing an Event Immediately Introduction Procedure The Events tab of the Gentran:Server Process Control dialog enables you to execute the selected event immediately. This function allows you to manually invoke an unattended session and also enables you to test a new event or an event that failed. To execute an event immediately, complete the following steps: Step 1 Action Click Process Control on The Desk.
Using Process Control Overview 11 - 39 Calendars 0 Overview Introduction The process control Calendar feature enables you to configure system calendars that excludes specific dates (such as holidays) or days of the week from processing. Like session definitions, these calendars are defined independently from the event, so that they can be “attached” to multiple event entries. The calendar begins with the current month and year.
11 - 40 Overview Using Process Control Part Previous Function Displays the previous month in the calendar. Note This button is only activated if a calendar is selected and a previous month exists for the calendar. Next Displays the next month in the calendar. Note This button is only activated if a calendar is selected. Exclude Select which days of the week to exclude from processing. These are displayed with red Xs through them.
Using Process Control Creating and Editing Calendars 11 - 41 Creating and Editing Calendars Procedure To create or edit a calendar, complete the following steps: Step 1 Action Click Process Control on The Desk. System response The system displays the Gentran:Server Process Control dialog box. 2 Click the Calendars tab. System response The system displays the Process Control dialog box (Calendars tab). 3 Do you want to create a new calendar? ◗ If yes, click New.
11 - 42 Creating and Editing Calendars Using Process Control Step 7 Action Do you want to exclude a specific day or days of the week? ◗ If yes, select the check box in the Exclude section for each day of the week that you want to exclude from processing and continue with Step 8. ◗ If no, continue with Step 8. Notes ◗ You can select one or more days of the week on which you never want processing to occur. ◗ The system allows you to exclude all seven days of the week, if that is your intention.
Using Process Control Deleting Calendars 11 - 43 Deleting Calendars Procedure To delete a calendar, complete the following steps: Step 1 Action Click Process Control on The Desk. System response The system displays the Gentran:Server Process Control dialog box. 2 Click the Calendars tab. System response The system displays the Process Control dialog box (Calendars tab). 3 Select a calendar and click Delete to delete the current selection.
11 - 44 Deleting Calendars Gentran:Server for Windows – November 2005 Using Process Control Gentran:Server for Windows User’s Guide
GL - 1-1 GLOSSARY Glossary ?In Documents This browser contains a list of documents that were received by the system but failed compliance checking or that do not have an identifiable partner or transaction set. ?Out Documents This browser contains a list of documents that were imported into the system but are invalid. acknowledgement Indicates the ANSI 997 functional acknowledgement, the EDIA 999 acceptance/ rejection advice, and the EDIFACT CNTRL.
GL - 2 authorization Permission to access a protected resource, service, or sensitive information. browser A window that displays a list of items, such as documents (transaction sets), interchanges, or translation objects. A document browser displays only documents. click Indicates that you should position your cursor on top of the designated item and press and release your primary mouse button.
GL - 3 composite data element A data element that is made up of multiple component elements. cryptographic keys Cryptographic keys are central to cryptographic operations and must be kept secret because whoever possesses a particular key has access to any data with which the key is associated. For example, if a key is used to encrypt a file, anyone with a copy of that key can decrypt the file. Furthermore, anyone possessing a key used to sign messages can forge that message signature.
GL - 4 Each browser icon displays a graphic representation of paper if the document location contains documents. The Desk also allows you to access the Partner Editor subsystem, the Help system, the Process Control function (clock icon), and the Send/Receive functions (phone icon), and allows you to quit Gentran:Server (EXIT/door icon). You can turn the display of The Desk off by clicking The Desk on the View menu. This toggles the display of The Desk “on” and “off.
GL - 5 document One transaction set containing data and treated as a single entity. The amount of data does not affect whether something is a document or not, only the fact that it is treated as a single entity. For example, regardless of whether a purchase order contains one item or ten thousand items, if it is one purchase order, it is one document. If a trading partner sends you a communication containing 10 purchase orders, you have received 10 documents.
GL - 6 There are three types of data elements, as illustrated in the table below: Data Element envelope Definition Simple data element A single piece of information defined by the standards. Composite data element A data element that is made up of multiple component elements. Component data element A simple data element that belongs to a composite data element. Component data elements are also called sub-elements. A way of separating information in transmissions for ease of processing.
GL - 7 fail over A failover system is a backup operation that automatically switches to a standby database, server, or network if the primary system fails or is temporarily shut down for servicing. Fail over is an important fault tolerance function of missioncritical systems that rely on constant accessibility. Fail over automatically (and, to the user, transparently) redirects requests from the failed or down system to the backup system that mimics the operations of the primary system.
GL - 8 menu menu bar A list of actions from which you can choose. Unavailable items on a menu are dimmed to inform you they are disabled. Displays the list of menus for the application. move This functions enables you to move a document or group of documents either from In Documents or ?In Documents to the In Drawer or from ?Out Documents to the Workspace. network Also known as a Third Party Network or Value-Added Network (VAN).
GL - 9 post predefined print printout receive respond responsible agency This function enables you to move compliant documents from the Workspace to Out Documents. On a data entry translation object, a default value for a particular element. You can change the value as necessary. This command enables you to print a formatted or unformatted version of the selected documents using the print translation object set up in the partner relationship for those documents.
GL - 10 Send Queue set sort status This function enables you to display a list of documents currently queued to be sent. See Transaction Set. This function enables you to sort the list of documents in a document browser into one of the following sequences: ◗ partner/type/name ◗ partner/name/type ◗ type/partner/name The processing stage of a document or interchange, indicated in the “Status” box. ?In Documents NotOK All documents in the ?In Documents have this status.
GL - 11 ?Out Documents NotOK This code indicates that the document does not comply with the EDI standard definition. The errors that are causing the compliance failure can be determined by viewing the translator report for the document. In Documents OK All documents in the In Documents have a status of “OK.” These documents are fully compliant and are eligible for further processing.
GL - 12 Interchange Process Status Received (green) Indicates that the interchange was received by the system. Sent (green) Indicates that the interchange was successfully transmitted to the appropriate partner. Ready to Send (blue) Indicates that an attempt was made to send this interchange, but the communication session was not successful. This interchange will be sent during the next appropriate communication session. Queued Indicates that the document is queued to be sent.
GL - 13 Interchange, Group, and Document Acknowledgement Status Waiting Indicates that the interchange is waiting to be reconciled with an inbound functional acknowledgement. Overdue Indicates that the interchange is waiting to be reconciled with an inbound functional acknowledgement but has exceeded the number of hours by which that acknowledgement is deemed late. Rejected Indicates that the interchange was acknowledged by your partner and there were errors.
GL - 14 ◗ Duplicate A major error occurred while processing the interchange, functional group, or transaction level enveloping structures. This error may include header and trailer control numbers that do not match, an invalid trailer control count, or a control number sequence checking error. If any of these errors occur, they are listed on the translator report for the interchange containing the document. The document has the same name as another document on the system.
GL - 15 PickedUp This code indicates that the document was successfully delivered to a trading partner through a VAN. (To obtain this status using Sterling Information Broker, you must have your mailbox configured to receive the 70 report in data format). NetWarn This code indicates that the document was delivered to a VAN, which detected non-critical errors in the data. The data is available to be picked up by the designated trading partner.
GL - 16 synchronous TDCC translation object A mode of coordination of communication among distributed processes that requires request-reply pairs to occur within the bounds of a specified time interval in which the communication session is “live.” See EDIA. A predesigned layout set up to ensure that input or output for a particular transaction set exists and is presented in a usable fashion. You must specify which translation objects are used by each partner relationship.
GL - 17 trading partner Another company with which your company trades documents. Also referred to as a partner. transaction set (document) A business form as defined by the standards. Examples include an ANSI 850 purchase order or an UCS 880 invoice. The standards define each transaction set in terms of the segments and elements that make up the form, the order in which they appear, and the relationships among them. This is also known as a “message” in Europe.
GL - 18 Gentran:Server for Windows – November 2005 Gentran:Server for Windows User’s Guide
IX - 1 -1 Index Symbols ?In Documents 1-1 ?Out Documents 1-1 A ack 1-1 acknowledgements 1-1 criteria defining 8-3 defining acknowledgement criteria 8-3 reconciling documents and 8-6 using 8-1 AIAG 1-1 ANA 1-1 ANSI 1-1 application system 1-1 asynchronous 1-1 attaching interchanges to a partner 7-16 audit log 1-1 using 9-1 authorization 1-2 B BAT functional group 3-73 BG envelope 3-75 browser 1-2 Browser Toolbar 1-8 C click 1-2 cluster 1-2 communications using 5-1, 10-1 viewing Send Queue 5-13 communic
IX - 2 EDIFACT 1-5 editing calendar 11-43 partner locations 3-118 partners 3-76 process control session 11-12 element 1-5 component 1-2 composite 1-3 envelope 1-6 BAT 3-73 BG 3-75 GS 3-73 ICS 3-75 ISA 3-75 MHD 3-70 ST 3-70 STX 3-75 UNA 3-75 UNB 3-75 UNG 3-73 UNH 3-70 export 1-6 External Data External Data Filter Dialog Box 6-6 External Data Summary Viewer 6-3 sorting 6-9 viewing 6-8 External Data Filter Dialog Box 6-6 External Data Summary Viewer 6-3 F fail over 1-7 finding 1-7 functional group 1-7 BA
IX - 3 Partner Editor 1-4, 1-8 partner profile 3-4 importing 3-56 partners attaching interchanges to 7-16 creating partner definition 3-56 editing 3-76 importing profiles 3-56 inbound relationship 3-58 advanced features 3-62, 3-70 locations deleting 3-119 editing 3-118 tables deleting 3-107 deleting entries 3-106 using 3-1 posting 1-9 predefined 1-9 printing 1-9 data audit information 9-9 tracking information 9-10 printout 1-9 process control creating an event 11-23 deleting a calendar 11-43 deleting a s
IX - 4 interchanges 6-8, 7-10 Send Queue 5-13 tracking information 9-10 using the audit log 9-1 using tracking 9-1 V version 1-17 VICS 1-17 viewing 1-17 data audit information 9-9 documents 4-51 documents within interchanges 6-10, 7-14 Gentran:Server for Windows – November 2005 W WorkSpace 1-17 X X12 1-17 Gentran:Server for Windows User’s Guide
