You are on page 1of 352

Sterling Commerce Educational Services

Gentran Integration Suite: Fundamentals

Course 915 Version 4.2, 2007 Participant Guide

July 2004 Copyright 2003, 2004 Sterling Commerce, Inc. ALL RIGHTS RESERVED

Educational Services

WARNING: ANY UNAUTHORIZED DUPLICATION OF THIS DOCUMENTATION SHALL BE AN INFRINGEMENT OF COPYRIGHT


Trade Secret Notice

This documentation, the software it describes, and the information and know-how they contain constitute the proprietary, confidential and valuable trade secret information of Sterling Commerce, Inc., its affiliated companies or its or their licensors, and may not be used for any unauthorized purpose, or disclosed to others without the prior written permission of the applicable Sterling Commerce entity. This documentation and the software that it describes have been provided pursuant to a license agreement that contains prohibitions against and/or restrictions on their copying, modification and use. Duplication, in whole or in part, if and when permitted, shall bear this notice and the Sterling Commerce, Inc. copyright notice. As and when provided to any governmental entity, government contractor or subcontractor subject to the FARs, this documentation is provided with RESTRICTED RIGHTS under Title 48 CFR 52.227-19. Further, as and when provided to any governmental entity, government contractor or subcontractor subject to DFARs, this documentation and the software it describes are provided pursuant to the customary Sterling Commerce license, as described in Title 48 CFR 227-7202 with respect to commercial software and commercial software documentation. This documentation and the software which it describes are licensed either "AS IS" or with a limited warranty, as set forth in the applicable license agreement. Other than any limited warranties provided, NO OTHER WARRANTY IS EXPRESSED AND NONE SHALL BE IMPLIED, INCLUDING THE WARRANTIES OF MERCHANTABILITY AND FITNESS FOR USE OR FOR A PARTICULAR PURPOSE. The applicable Sterling Commerce entity reserves the right to revise this publication from time to time and to make changes in the content hereof without the obligation to notify any person or entity of such revisions or changes. --Confidential Trade Secret Material--

Contents - Participant Guide

Course Overview
Course Introduction . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . How to Use the Training Materials. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

1
2 6 7

Lesson 1 About Gentran Integration Suite


Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . User Interfaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Administration Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

9
10 12 16 23 24

Lesson 2 Graphical Process Modeler (GPM)


Downloading and Installing the Graphical Process Modeler . . . . . . . . . . . . . . . . . . . Graphical Process Modeler . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Overview of Menus and Navigation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Element Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Navigation Pane . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Stencils . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

25
26 28 29 35 38 39 42

Lesson 3 Basic BPML Concepts


What is BPML? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Gentran Integration Suite BPML Activities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Process Rules . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Element Editors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

43
44 45 57 61 63

Course 915: Gentran Integration Suite: Fundamentals

Contents

Lesson 4 XPath Basics


What is XPATH? . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XPath Visualizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . XPath Syntax and Expressions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Gentran Integration Suite XPath Expression Builder. . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

65
66 67 68 74 77

Lesson 5 Creating and Maintaining a Business Process Using the GPM


What is a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Life Cycle of a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Implementing a Business Process Using the GPM . . . . . . . . . . . . . . . . . . . . . . . . . . Assigning Rules and Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Implementing a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Check in the Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Manually Running a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Modifying a Business Process. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Checking Out a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Editing a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Version Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

79
80 80 86 86 91 97 107 110 113 113 114 118 122

Lesson 6 Troubleshooting a Business Process


Viewing Active and Recent Business Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . Searching for Business Processes and Other Information . . . . . . . . . . . . . . . . . . . . Restarting or Resuming a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Viewing Execution Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Terminating Business Processes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

123
124 129 133 136 136 140

Lesson 7 Introduction to Service Management


Difference Between Services and Adapters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . File System Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Bootstrapping . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . SMTP Send Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Command Line2 Adapter. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lightweight JDBC Adapter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Invoke Business Process Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Wait Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

141
142 145 152 157 165 171 174 183 188 192

ii

Course 915: Gentran Integration Suite: Fundamentals

Contents

Lesson 8 Case Study


Our Business Problem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Invoke Business Process Service / Per Customer . . . . . . . . . . . . . . . . . . . . . . . The File System Adapter Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . The Command Line Adapter Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

193
194 198 200 202 204

Lesson 9 Gentran Integration Suite Mapping

205

The Gentran Integration Suite Map Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206 XML Encoder Object Mapping Function . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211 Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Lesson 10 Tracking System Health


Troubleshooting and Reconciling Business Processes . . . . . . . . . . . . . . . . . . . . . . . Archiving and Restoring Business Process Data . . . . . . . . . . . . . . . . . . . . . . . . . . . Restoring Archived Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Resources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Deleting a Business Process . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

227
228 235 240 243 248 250

Lesson 11 Case Study

251

Case Study Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252 Our Business Problem. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 253 Completed Objectives . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 258

Course Wrap Up
Sterling Commerce Educational Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Gentran Integration Suite Training Tracks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Support on Demand . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Course Evaluation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Recap . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Additional Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

259
260 261 264 265 265 266

Appendix A Process Generation

269

Appendix B GIS Trading Partner Set Up

271

About Trading Partner Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 272 About Trading Partner Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276 Digital Certificates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Course 915: Gentran Integration Suite: Fundamentals

iii

Contents

Converting Trading Partner Envelope Information . . . . . . . . . . . . . . . . . . . . . . . . . . Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Setting Up a Trading Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Creating a Contract . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Trading Partner Records . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Managing Document Envelopes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Lesson Review . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

280 281 281 306 310 314 327

Appendix C Digital Certificates

329

About the Certificate Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 335

Appendix D Case Study Hints

345

Case Study Hints . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 346

iv

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

This lesson provides an overview of the objectives and lessons that make up this course.

Introduction
Lesson Objectives
After completing this lesson you should be able to: Explain the structure of this course Explain the training material we will use

Course Objectives
After completing this course you should be able to: Run a business process Create a business process using the Graphical Process Modeler Explain how to create a service configuration Explain how to track an executable business process Discuss the basics of Gentran Integration Suite

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

Course Introduction
Overview
In this lesson we discuss the:

Student introductions Facilities Course agenda Method for asking questions during class

Student Introductions
Let us take a moment to introduce ourselves, starting with the instructor. When you introduce yourself, please share the following information:

Your motivation for taking this course Your role in your company with regard to Gentran Integration Suite

Facilities
The following amenities are available for you during training:

Food Drinks Coffee Phones Rest Rooms Smoking Area Messages

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

Course Agenda
You will complete the following lessons in this course:

Course Overview Course introduction How to use the training materials Lesson review Lesson 1 About Gentran Integration Suite User interfaces Overview of menus and navigation The Administration Interface Components The Life Cycle of a Business Process Lesson review Lesson 2 Graphical Process Modeler (GPM) Installing the Graphical Process Modeler (GPM) Overview of Menus and Navigation Element editors Navigation Pane Stencils Lesson review Lesson 3 Basic BPML Concepts What is BPML? Gentran Integration Suite BPML activities Process rules Element editors Lesson review Lesson 4 XPath Basics What is XPath XPath Visualizer Basic XPath features

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

XPath Expression Builder Lesson Review Lesson 5 Creating and Maintaining a Business Process Using the GPM Creating a business process Implementing a business process using the GPM Assigning Rules and Conditions Implementing a Business Process Check in the Business Process Manually Running a Business Process Modifying a Business Process Check out a Business Process Version Control Editing a Business Process Disabling a Business Process Lesson review Lesson 6 Troubleshooting Maintaining a Business Process Viewing Active and Recent Business Processes Searching for Business Processes and Other Information Restarting or Resuming a Business Process Viewing Execution Information Terminating a Business Process Lesson review Lesson 7 Introduction to Service Management List and explain the four basic service types Explain how to create a service configuration Explain Bootstrapping Describe how the File System adapter works Describe how OnFault Processing works Explain how the Command Line adapter functions Describe and demonstrate the use of a Lightweight JDBC adapter Describe how the Invoke Business Process service works

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

Course Wrap Up Objectives Getting Additional Help Additional Training Course Evaluation

Questions
Please ask questions at any time! The instructor will place questions that cannot be answered immediately on the White Board for further investigation. The instructor will get the answer to these questions as soon as possible.

How to Use the Training Materials


Overview
In this section we discuss the training material you use in this course.

Training Guide
Your instructor displays slides on an overhead to guide you through the information in your training guide. The overhead may also display the instructors computer screen during hands-on portions of the course where you use the computer.

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

Lesson Review
Completed Objectives
You should now be able to: Explain the structure of this course Explain the training material that we will use

Congratulations! You have completed the Course Overview. Now lets learn about the Gentran Integration Suite product.

Course 915: Gentran Integration Suite: Fundamentals

Course Overview

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1

About Gentran Integration Suite

Introduction
Lesson Objectives
After completing this lesson you should be able to: List typical business process problems Explain the basics of Gentran Integration Suite List the benefits of Gentran Integration Suite Identify Gentran Integration Suite user interfaces Understand Perimeter Servers and how they are used in Gentran Integration Suite

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

Overview
What Is Gentran Integration Suite?
Gentran Integration Suite is the Sterling Commerce next generation end-to-end enterprise integration server for dynamic real-time and near-real time business collaboration and commerce automation. It is a business process-centric transaction engine for modeling and managing processes. It handles complex routing, translation, flexible integration, and real-time interaction with multiple internal systems and external trading partners. Major highlights include:

New integrated ground-up architecture for end-to-end business to business


integration (B2Bi) and enterprise application integration (EAI).

Powerful, advanced translation and routing capabilities for high performance EDI
translation and complex XML transformations and filtering.

Process engine optimized for high-speed synchronous and asynchronous complex


multi-step message exchanges (XML-based, real-time EDI, B2B standards such as ebXML, and user-defined private processes)

Component-based Java 2 Enterprise Edition (J2EE) architecture for distributed


enterprise scaling, reliability, transaction management, and plug-in extensibility for emerging B2B standards and integration adapters.

Layered business-process-centric architecture employs industry standard BPML


meta-language; insulates (preserves) business process specifications from potential fluid low-level technologies.

Typical Business Process Problems


Business managers are under tremendous stress to reduce costs and increase efficiency in communication/information transfer between their companies and clients, as well as internally from department to department. The lack of application integration, both internally and externally, results in many problems:

Slow response time, leaving customers dissatisfied Reliance on excessive manual processing, increasing costs and human error Inability to adopt new standards, causing missed opportunities
Notes:

10

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

Restrictive architecture of systems, limiting expansion


While business managers struggle with these issues, IT Managers/Directors are also trying to streamline and improve business processes without incurring high expenses. In many cases, they are using legacy systems that they have invested in highly and do not want to abandon for a new system. However, they lack the time and staff to overhaul the existing system and need to have fast, dependable service from a trustworthy provider.

Benefits of Gentran Integration Suite


Because Gentran Integration Suite was built from the ground up to meet B2Bi needs, it provides:

Simplified management Consistent integration deployment methodology Capability to model and deploy complex end-to-end processes
Every company wants application integration so they can meet their business goals. Some of these goals could be:

Reduce operational costs Increase operational efficiencies Improve customer satisfaction Increase revenues Retain or increase competitive position Improve responsiveness

Notes:

Course 915: Gentran Integration Suite: Fundamentals

11

Lesson 1 About Gentran Integration Suite

User Interfaces
Overview
The three main user interfaces used with Gentran Integration Suite are:

The Administration Interface The Gentran Integration Suite Map Editor The Graphical Process Modeler

Notes:

12

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

The Administration Interface


The Administration Interface shown below is a Web-based interface for System Administration.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

13

Lesson 1 About Gentran Integration Suite

The Gentran Integration Suite Map Editor


The Gentran Integration Suite Map Editor is shown below. It is used to represent the translation of one type of input data to a different type of output data.

Notes:

14

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

The Graphical Process Modeler


The Graphical Process Modeler is shown below. It is used to represent a business process as a graphical model.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

15

Lesson 1 About Gentran Integration Suite

The Administration Interface


The Gentran Integration Suite administration interface allows you to set up, configure, and maintain the system. There are five main areas in the Gentran Integration Suite Administration Interface:

Business Process Trading Partners Deployment Operations Accounts

Note: When using browser buttons within GIS, do not use the back arrow.

Notes:

16

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

Business Processes
The Business Process menu of Gentran Integration Suite allows you to manage and monitor business processes.

Business Process Manager The Business Process Manager screen provides the options you need to create and locate business process definitions. This screen is used to:

Download Java WebStart Run the Graphical Process Modeler Create new process definitions Search for process definitions List process definitions

Notes:

Course 915: Gentran Integration Suite: Fundamentals

17

Lesson 1 About Gentran Integration Suite

Business Process Monitor - Current Processes


The Business Process Monitor -Current Processes screen displays a summary of the processes in Gentran Integration Suite. Statuses are indicated by color:

Green - No errors or warnings during processing Red - Errors or warnings encountered during processing
From this screen you can:

Review detailed processing information View business process definitions Obtain document information
Note: If you are using Internet Explorer, this screen automatically refreshes every minute. If using Netscape, you must manually refresh the screen. You can stop the automatic refresh activity by clearing the automatic refresh Check Box.

Business Process Monitor Central Search screen The Business Process Monitor Central Search screen provides you the ability to locate and view business processes based on specific search criteria:

Business Process name Status Start Date from Start Date to


Business Process Monitor Advanced Search screen The Business Process Monitor Advanced Search screen provides you the ability to locate and view business processes based on specific search criteria:

Location (Live tables, Archive tables, Restore tables) Business Process ID Business Process name System Business Process name State Status
Notes:

18

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

Start Date from Start Date to


Business Process Monitor Current Activities Search screen The Business Process Monitor Current Activities Search screen takes you to the Service Activity page. This page is used primarily to look at adapters and the status of large file transfers and provides you the ability to search for service activity based on the following criteria:

Service type Service name Service Activity type Not Updated Since: Date/Time Started Before: Date/Time
Business Process Monitor Advanced Search - Documents Screen The Business Process Monitor Advanced Search - Documents screen allows you to see the most recent documents processed without specifying any search options. Current documents gives you the ability to monitor current document processing at a glance from ine page in Gentran Integration Suite. The Documents page provides you the ability to search for documents based on the following criteria:

Start Date From Sender ID Type Receiver ID Status Tracking ID

Notes:

Course 915: Gentran Integration Suite: Fundamentals

19

Lesson 1 About Gentran Integration Suite

Deployment
The Deployment menu allows you to configure services and maps. Details of the Trading Partner, Operations, and Accounts menus will be discussed in detail later in this class.

Services The Services menu and screens enable you to install/setup and configure services to be used by Gentran Integration Suite. Schedules

The Schedules option enables you to locate and configure certain services and adapters to invoke business processes to run at a specified time
Maps The Maps option enables you to download/install the Map Editor, EDI Standards, check in/out maps, and find maps.
Notes:

20

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

XSLT The XSLT option enables you to create and manipulate extensible style sheets. Mailboxes The Mailboxes option enables you to organize, store, and manage trading partner documents and transactions. EBXML The EBXML option allows you to manage and locate Business Process Specification Schemas (BPSS) and Collaboration Protocol Agreements (CPA). Web Extensions Web Extensions enable you to download and install the Web Template Translator application; create, edit, check in and out Web templates; and download and install Web designer extensions to create XForms. Schemas The Schema screen allows you to load an XML Schema or DTD into the system. Resource Manager The Resource Manager allows you to create and locate resource tags, and import or export resources. Adapter Utilities The Adapter Utilities screen enables you to create DTDs and locate existing DTDs for Siebel Systems. This menu option only appears in the Deployment menu if the respective service has been installed. Additionally, a Service Development Kit is available from this menu item. PGP Profile Manager The PGP Profile Manager enables you to add, edit, and delete PGP profiles. A PGP profile is a record stored in Gentran Integration Suite that contains information about the PGP server. The PGP Profile Manager works with the PGP Package service and PGP Unpackage service.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

21

Lesson 1 About Gentran Integration Suite

SSH Host Identity Key The SSH Host Identity Key enables you to create the encessary keys for SSh and SCP protocols. Web Services A Web Service Configuration enables you to locate and configure certain services and business processes to be exposed as web services. Help The Help screen provides details for all of the screens in the Deployment menu.

Notes:

22

Course 915: Gentran Integration Suite: Fundamentals

Lesson 1 About Gentran Integration Suite

Components
The diagram below illustrates the main components and communication paths between them.
External Marketplaces & Trading Partners

Internal Systems

System Framework
Services

Integration Adapters

Translation Service

Rules Service

Custom Adapters

Legacy Applications

Marketplaces Registry Service Firewall Internet Communication & Firewall Navigation Firewall Internal Comms Service Envelope Service Technology Adapters Security Service Application Adapters

Package Apps (ERP, CRM. SCM)

Messaging & Databases

Trading Partners

Mailbox Service

Custom Service

Sterling STERLING Adapters Adapters

GENTRAN Gentran && CONNECT Connect

Internet

J2EE Infrastructure
Enterprise DMZ Enterprise LAN

Browser-based Administration Interface

Notes:

Course 915: Gentran Integration Suite: Fundamentals

23

Lesson 1 About Gentran Integration Suite

Lesson Review
Completed Objectives
You should now be able to: List typical business process problems Explain the basics of Gentran Integration Suite List the benefits of Gentran Integration Suite Identify Gentran Integration Suite user interfaces Understand Perimeter Servers and how they are used in Gentran Integration Suite

Congratulations! You have completed Lesson 1, About Gentran Integration Suite.

Notes:

24

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2

Graphical Process Modeler (GPM)

This lesson describes the elements that make up the Graphical Process Modeler (GPM).

Introduction
Lesson Objectives
By the end of this lesson, you should be able to:

Install the Graphical Process Modeler Navigate the Graphical Process Modeler Understand Stencil Elements Understand Element Editors Understand Basic BPML Operations

Course 915: Gentran Integration Suite: Fundamentals

25

Lesson 2 Graphical Process Modeler (GPM)

What is the Graphical Process Modeler?


To help you build process models that accurately define your business processes, Gentran Integration Suite offers the Graphical Process Modeler (GPM). The GPM is a stand-alone graphical interface tool used in Gentran Integration Suite to create and modify business processes. The GPM converts the graphical representation of business processes to well-formed BPML (source code) and saves you the effort of writing code.
Note: The GPM recognizes BPML coded in a text editor. Therefore, you can open in the GPM a .bpml file created in a text editor and view its graphical representation.

Downloading and Installing the Graphical Process Modeler


Java Web Start
The Graphical Process Modeler uses a Java Web Start editor. It must be downloaded from your server before you use the GPM for the first time.

System Requirements
Java Web Start requires approximately 5.5 MB of disk space on the client computer. The minimum recommended available disk space for Java Web Start and the GPM is 100 MB.

Notes:

26

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Notes:

Course 915: Gentran Integration Suite: Fundamentals

27

Lesson 2 Graphical Process Modeler (GPM)

Graphical Process Modeler


This section provides an overview of the major elements of the Graphical Process Modeler (GPM), such as menus, stencils, and workspace. The following figure shows a standard GPM interface. A new business process model document is open, and the BPML and All Services stencils are visible.
Stencil Title Bar Menu Bar Toolbar

Stencil Elements

Workspace

Notes:

28

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Overview of Menus and Navigation


Anatomy of the Graphical Process Modeler
The Menu Bar enables access to the following Menus: File, Edit, View, Build, Options, Tools, and Help. The Tool Bar contains shortcuts to the following functions: New, Open, Save, Print, Open Stencil, Cut, Copy, Paste, Source Manager, Previous, Next, Zoom, Properties, and Help. The Stencils Pane displays available stencils. To access different stencils, click on the BPML Operations or All Services buttons. The Workspace displays the business process currently being built or edited. The Navigation Pane displays a high-level organizational view of sub flows, activities, and services used by the business process. The Output window displays BPML validation or error messages. The Editor window displays the element editors, which are used to configure BPML activities and services.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

29

Lesson 2 Graphical Process Modeler (GPM)

Menu Bar
The menu bar in the GPM is simple and complies with most Windows menu conventions. The following table describes the menu commands available in the GPM:
Menu File Description The File menu enables you to:


Edit

Create a new business process model. Open an existing business process model. Close, save, and print a business process model. Exit the GPM.

The Edit menu enables you to cut, copy, paste, delete, clear all, and select all elements from the workspace. The Edit menu also enables you to:

Add an annotation to an element. To add an annotation, you must first select an element icon. Access element editors that contain configurable or non configurable parameters. To view parameters, you must first select an element icon from the workspace. For more information, see Element Editors on page 35.

Notes:

30

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Menu View

Description The View menu enables you to customize the GPM interface. In the View menu, click the option you want to display or hide. When the option has a check mark next to it, it is displayed. Options to display or hide are:

Source Enables you to switch between the graphical representation and the BPML source code of a business process model on the workspace. The GPM does not enable you to edit or copy BPML source code. Toolbar

Displays the tool bar containing shortcut command buttons.

Status Bar Displays the status bar at the bottom of the page. When you point to a menu option or tool bar button, the status bar displays a description of what that option does. Output Opens and closes the Output pane, which displays error, validation, and system messages. This pane opens automatically when the GPM encounters an error during validation. Navigation Opens and closes the Navigation pane, which contains two tabs: Layers and Nodes. Layers provides a navigation structure in which you can determine the layer that you are currently working with. Nodes displays all the nodes that exist on the layer that is currently displayed on the workspace. For more information, see Navigation Pane on page 38. Refresh Services Updates the GPM to display services and adapters that you have recently configured. Stencil Displays the menu that lists stencils. Stencils contain labeled elements icons that represent BPML activities and services that you use to create business process models. From the Stencil menu, you can also close stencils as needed. For more information, see Stencils on page 39. Go To Enables you to return to the previous flow view or move to the next flow view. Auto Layout


Build

Automatically aligns elements on the workspace.

Zoom Enables you to change the magnification of a business process model. Zoom sets the magnification to 50%, 75%, 100%, 150%, or 200% Grid Displays grid markers or a ruler. The grid points enable you to align elements on the workspace.

The Build menu command instructs Gentran Integration Suite to validate a business process model against BPML syntax. After you complete the business process model, you must validate the business process before you can run it in Gentran Integration Suite. The GPM may prompt you to perform a validation when you save the business process model. To disable or enable this prompt, select Preferences from the Options menu. Gentran Integration Suite prompts you to validate a business process model during check in; you can choose to delay the validation process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

31

Lesson 2 Graphical Process Modeler (GPM)

Menu Options

Description The Options menu enables you to specify GPM preferences. Options are:

General Enables you to specify whether the GPM should always validate on save or show the Validate on Save dialog box. Source Manager Enables you to specify whether Expert Mode displays when using Source Manager. When you select Expert Mode, one dialog box displays and contains all the parameters you need to add a business process model to Gentran Integration Suite. When you do not select Expert Mode, a series of dialog boxes display for the parameters. File Location Enables you to specify a default directory to which to save all business process documents (.bp files) on your client computer. Locale Enables you to specify your location. Service Editor Enables you to choose to override default service configuration values. This makes values that are defined in the Administrator UI editable in the GPM.

To specify your preferences, select Options > Preferences, and then select the appropriate tabs. Tools The Tools menu provides extended capabilities for building a business process model. Options are:

Rule Manager Display a dialog box that enables you to build and add XPath syntax to define business process rules and conditions. Source Manager Open Source Manager. Source Manager displays the business processes and versions of business processes that are available in Gentran Integration Suite. Source Manager enables you to check business processes in to and out of Gentran Integration Suite. Add Sub Flow Add a sub flow to a business process model. When adding a sub flow, the sub layers display in the Navigation pane. For more information, see Navigation Pane on page 38.

Help

The Help menu provides:

Connection to the Sterling Commerce Web site Help topics for using the GPM Product version release and copyright information

Notes:

32

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Stencils
The icons contained within the stencils enable you to build a business process model. Icons represent services that, when configured, can invoke automatic tasksfor example, services supporting the general run-time environment for Gentran Integration Suite and services enabling Gentran Integration Suite to access hardware and software resources. Using the labeled icons that represent services, you can indicate integration points and activities, such as: BPML activities that enable business processes to perform an operation (for example, invoking a service) Adapters that control the transmission of business processes between Gentran Integration Suite and external applications Services that carry out a specific activity (for example, translating file formats) Customized services that have been created and configured to meet a specific business need within your organization

Exercise: Opening Stencils

1. Open the Graphical Process Modeler. 2. Click File > New. 3. Click View > Stencil > All Services to display the All Services Stencil. 4. Click View > Stencil > BPML to display the BPML Stencil. 5. Click All Services to display Stencil elements.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

33

Lesson 2 Graphical Process Modeler (GPM)

Closing a stencil
To close a stencil: 1. From the View menu, select Stencil. 2. Complete one of the following steps:

To close the current stencil (topmost), click Close Current Stencil. To close all stencils, click Close All Stencils. Services and adapters
In the GPM, services and adapters are represented by labeled icons within stencils. For example, when you install the MQSeries v1.0 adapter, the MQ Series Adapter icon displays in the Messaging stencil. To add a service to a business process model, click and hold the mouse button on the service, and then drag it onto the workspace. For more information about services, see Stencils on page 39.

Title Bar
The title bar displays the file name of the business process model document currently open in the GPM.

Toolbar
The tool bar displays buttons that provide quick access to commonly used commands. Unavailable buttons become available after you have selected a service on the workspace.

Workspace
The workspace is the area on the GPM interface to which you can drag icons to build a business process model. You can also view the BPML source code of a business process model in the workspace. To view BPML source code, from the View menu, select Source.

Notes:

34

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Element Editors
BPML activities and a small number of services are pre configured when you install Gentran Integration Suite. However, some BPML activities and services require you to perform additional configuration in the GPM, depending on the task your business process model must accomplish. You specify these configuration parameters in one of five different element editor types: Property, Service, Edge, Produce, and Consume. Each element editor provides configuration parameters specific to an activity or a service. The following figure shows the location of the element editors. The End icon is selected and the Property editor is visible and indicates that no configurable parameters exist for the End icon.

Element Editors

Notes:

Course 915: Gentran Integration Suite: Fundamentals

35

Lesson 2 Graphical Process Modeler (GPM)

Property Editor
The Property editor displays BPML icons that require additional information, such as choice start, assign, and consume icons. Using the Property editor, you can also define values to indicate errors. If you define values that indicate errors and the business processes encounters these values while running, Gentran Integration Suite generates a report that describes the error.

Service Editor
The Service editor displays service parameters for each service and adapter. You can use the Service editor to: Perform additional configuration for services and adapters with active parameters. Apply values using the preset values in the GPM to define conditions for configuration parameters. Create your own name-value pairs, adding XPath expressions when needed, to define the path to name-value pairs that appear in business process data. If your business process requires a service that is not available, contact your system administrator. The following tah ng tour business

Notes:

36

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Field Output Msg

Description (Message to service) Sends one of the following types of information:

Message Only Send only service configuration information to a service. Obtain message First, then Process Data Send service configuration information, name-value pair in the Service editor, and business process data. If duplicate information exists between the service configuration and business process data, the business process data overrides the service configuration information. Obtain Process Data First, then Message Send service configuration information, name-value pair in the Service editor, and business process data. If duplicate information exists between the service configuration and business process data, the service configuration information overrides the business process data.

Note: When sending name-value pairs, you must indicate in the Service editor the name and value that describes the path for sending the name-value pairs. Input Msg (Message from a service) When a service sets variables in business process data:

Allow message to write Do not save the variables. Allow process data to write Save the variables.

Edge Editor
The Edge editor lists rules that you have previously created using the Rule Manager. You can assign these rules to links that run from a Choice Start icon to the next icons in the business process model.

Produce Editor
A Produce editor displays configuration parameters that enable you to indicate the message and name of the receiving participant or activity.

Consume Editor
The Consume editor enables you to indicate the message a business process should expect and the name of the participant sending that message.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

37

Lesson 2 Graphical Process Modeler (GPM)

Navigation Pane
The Navigation pane contains two tabs: Layers and Nodes. When used together, the Layers and Nodes tabs enable you to quickly navigate through a business process model. The following figure shows the location of the Navigation pane:

Navigation Pane

Layers
The Layers tab provides a relationship structure that shows each layer of a business process, including sub flows (nested layers). To expand the structure, click the root of the layer. When you expand the view, all the activities in the layer display on the workspace. A layer view is especially helpful when adding activities that handle processing errors within a business process.

Notes:

38

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

Nodes
The Nodes tab provides an alphabetical structure displaying nodes (activities) that make up each layer in a business process. Select a layer from the Layers tab and then click the Node tab to view icons that make up the node in the Node tab and on the workspace. When you select an icon on the Node tab and have Properties selected, configurable parameters for the node display in the applicable element editor.

Stencils
The categorized stencils provide access to icons for services and adapters available in the GPM that you can use to create business processes.

Applications Stencil
The Applications stencil enables you to display stencil types that contain adapters that have been installed to connect to external applications. You can display the following types of applications stencils: ERP (Enterprise Resource Planning applications) Some examples of ERP applications adapters are:

SAP Suite adapter Oracle Ebusiness Suite adapter configuration service Oracle EBusiness Suite Message service
Sterling Commerce (Sterling Commerce applications) Some examples of Sterling Commerce applications adapters are:

Connect:Direct Server adapter Connect:Enterprise UNIX Server adapter Sterling Information Broker

Notes:

Course 915: Gentran Integration Suite: Fundamentals

39

Lesson 2 Graphical Process Modeler (GPM)

BPML Stencil
Some BPML activities bracket other activities. That is, you must use these activities in pairs, at the beginning and end of the activities they enclose. The following table describes the BPML icons representing activities that bracket other activities:
Icon Description The Start activity indicates the beginning of a business process. Every business process model must begin with Start. The End activity indicates the end of a business process. Every business process model must finish with End. The All Start activity is a parent activity in a business process. All Start indicates that a business process is simultaneously executing all the child activities contained within the parent activity. The All End activity indicates that all child activities within the parent activity are completed. Use All End to finish All Start. The Choice Start activity is a parent activity in a business process. Choice Start indicates a decision and runs one child activity as a result of that decision. You must assign a name to Choice Start using the Property editor and assign rules using the Rule Manager. The Choice End activity indicates that the child activity that ran as a result of the parent activity is completed. Use Choice End to finish Choice Start. The Sequence Start activity is a parent activity in a business process. Sequence Start runs a series of child activities in the order in which they are listed within the parent activity. When using Sequence Start, you must assign a name using the Property editor. The Sequence End activity indicates that the last child activity in a series of child activities in the parent activity is finished. Use Sequence End to finish Sequence Start.

Notes:

40

Course 915: Gentran Integration Suite: Fundamentals

Lesson 2 Graphical Process Modeler (GPM)

The following table describes the BPML icons representing activities that enable more extensive operations within a business process:
Icon Description The Assign activity sets a value in the business process data that is equal to a fixed value. Inside an input or output element, the activity identifies a message it should receive from a participant or identifies the contents of a message it should send to a participant. Configuration parameters enable you to indicate a fixed value or input/output message. The Consume activity reads a specific input message and stores that message in the business process data. Configuration parameters enable you to indicate a name for an instance of the Consume activity and the name of the message this activity should read. The Produce activity generates a message from the business process data and delivers it to a designated participant or activity. Configuration parameters enable you to indicate the message and name of the receiving participant or activity. The Spawn activity runs a nested business process. Configuration parameters enable you to indicate a name for an instance of the Spawn activity and the name of the activity the Spawn activity should run. The Join activity merges the results of a completed nested business process into the business process data. Configuration parameters enable you to indicate a name for the business process for which the Join activity is waiting. The Repeat activity runs a BPML operation one or more additional times. Configuration parameters enable you to indicate a name for an instance of the Repeat activity and the name of the activity the Repeat activity should run again.

For more information about activities, see Lesson 3, Basic BPML Concepts.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

41

Lesson 2 Graphical Process Modeler (GPM)

Lesson Review
Completed Objective
You should now be able to:

Install the Graphical Process Modeler Navigate the Graphical Process Modeler Stencil elements Element editors BPML operations

Congratulations! You have completed Lesson 2: Graphical Process Modeler.

Notes:

42

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3

Basic BPML Concepts

This lesson provides an overview of the components that make up the Business Process Modeling Language (BPML).

Introduction
Lesson Objectives:
After completing this lesson you should be able to: Discuss the activities that perform BPML functions Differentiate between services and adapters as they relate to Gentran Integration Suite Explain how Gentran Integration Suite uses BPML

Course 915: Gentran Integration Suite: Fundamentals

43

Lesson 3 Basic BPML Concepts

What is BPML?
BPML is short for Business Process Modeling Language. It is an XML-based language for describing a business process. How much XML knowledge is required to comprehend BPML? You will need to know the basics of XML. For example, youll need to know about elements and attributes, usage of start, end, and empty tags, and other basic XML concepts. An understanding of XPath is necessary to access document content. Advanced features such as DTD structure or various entity references are not needed.
Note: For more information about XPath, see Lesson 4, XPath Basics.

Services and Adapters


Services and adapters are software components that do work. Business processes make calls to services and adapters to do this work. In order for a business process to interact with these components, you will need to include services as steps in your business process. A service is a component of Gentran Integration Suite, such as a translator. Services that access disk or other applications (outside of Gentran Integration Suite) are known as adapters.

Messages
Message exchange Message exchange is a key ingredient in collaborative e-Business protocols. BPML engages a message-based business process in which everything that interacts with a process does so through the exchange of messages. In Gentran Integration Suite, business processes interact with services/adapters and other business processes. Exchanging messages with services and adapters In Gentran Integration Suite, whenever a business process runs an adapter or service, there in an exchange of two messages. First, the business process sends a message to the service/adapter that contains the parameters the service needs to run. The values of these parameters can either be constants, or they may come from process data. After a service has completed successfully, it sends its results back to the business process in a second message. The business process can select some of the contents of the message and place them into process data. Note that this message exchange occurs synchronously (the process must wait for the response message before continuing).
Notes:

44

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Exchanging messages between business processes In Gentran Integration Suite, messages are exchanged with business processes by way of the produce and consume BPML activities. The produce activity sends a message and the consume activity receives a message from a process. When the produce activity runs, it sends a message to the specified consuming processes; the produce does not wait for the message to actually be consumed. If the receiving process for the message is not correctly running a consume activity, then the message is queued until a matching consume activity runs. The message exchange is thus considered asynchronous.

Gentran Integration Suite BPML Activities


Activities perform BPML functions. BPML functions include operations that allow for the control of the flow of data through a business process. For example, the choice activity allows data to flow through the system based on the result of a decision. BPML supports three main types of activities:

Simple Complex Process


Note: Gentran Integration Suite views Process activities as a kind of Simple activity.

See Activities supported by BPML on page 50 for an alphabetical list of activities that Gentran Integration Suite recognizes.

Simple activities:
Use simple activities such as produce, consume, and assign to perform only one function. For example, the produce activity only sends a message to another process. The assign activity is used only for setting a value. Example:
<assign to=X>7</assign>

This assign merely sets a value named X to 7.


Notes:

Course 915: Gentran Integration Suite: Fundamentals

45

Lesson 3 Basic BPML Concepts

Complex activities:
Use complex activities, such as sequence, all, and choice to model the flow of control. Complex activities can consist of one or more simple activities or another complex activity. These types of activities can be sequential, parallel, or conditional. What is a sequence activity in BPML? A sequence activity runs all of the activities contained in it when a process is run. The activities are run in the order they are listed in the sequence. Example BPML:
<process name=default> <sequence> <assign to=Recipient>joe@acme.com</assign> <spawn name=Send_Email/> </sequence> </process>

In this case we have a sequence that has two activities, Assign and Send E-mail. When the process is run, the system first runs Assign then runs Send E-mail because that is the order the activities are listed in the sequence. The All activity The All activity is a complex activity that does not complete until all its sub, or child, activities are run. In Gentran Integration Suite, All runs all of its child activities simultaneously.

Use the All activity any place where an activity can appear. You must specify two or more sub activities.

Notes:

46

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Example Model

Example BPML:
<all> <sequence name=Seq_l> <operation name=A> ... </operation> <operation name=B> ... </operation> </sequence> <sequence name=Seq_2> <operation name=C> ... </operation> <operation name=D> ... </operation> </sequence> <sequence name=Seq_3> <operation name=E> ... </operation> <operation name=F> ... </operation> <operation name=G> ... </operation> </sequence> </all>

This All activity has three child activities: Seq_1, Seq_2, and Seq_3. Gentran Integration Suite attempts to run all three simultaneously. Since running a sequence corresponds to running children of the sequence, Gentran Integration Suite does operations A, C, and E simultaneously. These operations will probably take different amounts of time to complete, so the next operation to run may vary. For example, operation C may complete long before A and E. As soon as C finishes, D starts. There is no requirement that the operations along the children of All move together in lockstep. However, nothing runs after the All until every activity in the All has run to completion.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

47

Lesson 3 Basic BPML Concepts

The Choice activity The Choice activity is one of three types of complex activities. (The others are Sequence and All) A Choice activity is used to make decisions in the business process model and runs only one of the child activities it contains. The Choice activity makes it possible to model branch processing.

Use the Choice activity any place where an activity can appear. Use a choice to model process branching.
Example Model:

Process branching depends on a decision taken by the process and specifying which activity to run. One or more rules must be evaluated in order to make the decision. The select element is required and includes one or more case elements. Each case links the outcome of a rule to an activity. If the rule evaluates to true, or if the rule evaluates to false when the negative attribute is true, that activity is a candidate for execution. Multiple cases can reference the same activity. However, the activity will run exactly once. If an activity is not referenced, it will never run. If it is determined that no activity is candidate for running, the choice completes immediately. Use a choice with a single activity to model a deferred activity. If two or more activities are candidates for running, only one is run. In Gentran Integration Suite, the order in which the case elements appear is the order in which they are evaluated. The first case which evaluates to true determines the child activity to run.

Notes:

48

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Example BPML:
<process name=ProcessCustomerOrder> <rule name=BookInStock> <condition>foundBook = true </condition> </rule> <sequence> <operation name=Check Inventory> <participant name=InventoryService> <output message=checkStockRequest> <assign to=ISBN>1-56592-488-6</assign> </output> <input message name=checkStockResponse> <assign to=foundBook from=InStock /> </input> </operation> <choice> <select> <case ref=BookInStock activity=proceed/> <case ref=BookInStock negative=true activity=stop/> </select> <sequence name=proceed> <operation name=Verify Credit Card> </operation> </sequence> <sequence name=stop> <operation name=Apologize> ... </operation> </sequence> </choice> <operation name=Update customer> ... </operation> </sequence> </process>

Focusing on the choice activity, we see it contains multiple edges, each of which has a rule. For now, think of a rule as something that is either true or false. In this case, before the process continues it checks to see if the required book is in stock. The BookInStock rule will be true if the book is in stock, otherwise it is false.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

49

Lesson 3 Basic BPML Concepts

Example BPML:
<rule name=BookInStock> <condition>foundBook = true </condition> </rule>

When the choice is run, Gentran Integration Suite checks off each of the edges of the choice element and runs the path of the first rule it finds to be true. Once Gentran Integration Suite completes that activity, the choice itself is complete, and it runs no other activities in the choice after that point. In this particular case, one of the choices results in an activity being run. It is possible, however to have choices where no activity is run because no rule was found to be true. An edge of a choice may have multiple rules; the process continues in a path if any of the rules in that path are found to be true. In summary, the choice activity is used to make decisions in the business process. Rules associated with a choice conduct this decision making.

Activities supported by BPML


This section provides a reference of the BPML activities that Gentran Integration Suite recognizes. The activities are listed in alphabetical order for ease of reference.

All
The All activity is a complex activity that does not complete until all its sub activities have completed. Sub activities run in parallel. For more information about the All activity, see The All activity on page 46.

Assign
The assign activity is a process activity that performs an assignment. You can use this activity any place where an activity can appear. For more information about the Assign activity, see Using the Assign activity on page 58.

Notes:

50

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Choice
The choice activity is a complex activity that completes after one, or none of its sub activities completes. At most, one sub activity runs. For more information about the Choice activity, see The Choice activity on page 48.

Input
The input element accepts a message delivered to the process.

Use the input element in the operation activity to accept a message delivered from
a participant to the process (process input).

Use the message attribute to reference the relevant message definition. Use the assign element to perform assignment from the message contents to the
process data. You can use multiple assignments for multi-part messages. Example:
<input message> <assign/>* </input>

Join
Use the join activity to make a process wait for the completion of the processes referred to by the ref attribute (an XPath expression for referencing an element in process data that holds process instance information). Example:
<join ref>

OnFault
The onFault activity associates a fault handling the activity with a complex activity. Use it to recover from faults and allow process to continue. For more information about the onFault activity, see Using the onFault activity on page 59.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

51

Lesson 3 Basic BPML Concepts

Operation
In Gentran Integration Suite, the operation activity is used to call a service. Use it any place where an activity can appear.

An operation involves a synchronous request/response message exchange with a


possible fault message.

When an operation is invoked, it delivers a request message and waits for a


response message. If a fault is communicated, the operation faults.

Use the operation activity to invoke an operation on a service.


The operation activity produces the outgoing message through assignment and waits for the incoming message in order for the activity to complete. The participant element (or service) is mandatory. The output element must precede the input element. Example:
<operation name=this is optional> <participant name=service name/> <output message=what to send out> <assign /> </output> <input message=what comes back> <assign /> </input> </operation>

Output
The output element constructs a message delivered by the process to a participant. The message attribute references the relevant message definition.

Use the assign element to construct the contents of the message by assignment
from the process data.

Use multiple assignments for multi-part messages, no assignments are required


for empty messages. Example:
<output message> <assign/> </output>

Notes:

52

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Participant
The participant element defines or references a participant of the process. Gentran Integration Suite recognizes this element only when it is used in the operation activity.

Use the participant element to reference a participant within an activity. You must use the name attribute when defining the participant as a simple activity.
Defining the participant as a simple activity defines a static participant. Example:
<participant name> </participant>

Process
Use the process element to define a top-level process. The top-level activity relates to Start and End activities. Example:
<process name> <rule name/>* <activity name/> / (simpleActivity | complexActivity) </process>

Produce
Use the produce activity to send a message to a business process instance. The name attribute in the participant element must refer to an element in process data that provides the necessary information to contact a process instance. Example:
<produce name?> <participant name /> (output message > <assign />* </output> </produce>

Notes:

Course 915: Gentran Integration Suite: Fundamentals

53

Lesson 3 Basic BPML Concepts

Release Service
The Release Service is a system service that is used to remove extraneous data from the process data. This service comes with no predefined parameters, therefore you must use the Advanced Service Editor to create a parameter called TARGET and assign a value to it. The value identifies the process data which is no longer needed. TARGET is the name of the parameter the Release service expects in the Message TO Service. The value assigned to the parameter is an XPath expression which selects the nodes from the Process Data to be released. Even though it is an XPath expression you do not need to check the Use XPATH checkbox.

Example
If you put the following input message into the Release service, it will remove all the DOC-SPLIT tags from process Data.
<input> <assign to=TARGET//*[ReceiverID]</assign> </input>

Repeat
Use the repeat activity to run a portion of the business process multiple times. The ref attribute is the name of the activity to be run again. The referenced activity must be an ancestor of the repeat activity. Example:
<repeat ref />

Rule
The rule element defines a rule, the conditions by which the rule is met and the dependency on other rules.

The condition element formulates an expression. The condition is met if the


expression evaluated to true; or when the negative attribute is true, if the expression evaluates to false.

Notes:

54

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Multiple conditions appearing inside a rule imply logical order. This notation is
for convenience in reading. Other forms of logical composition are fully supported in the XPath language.

The select element in a choice determines which line activity will run based on a
number of cases. See the choice activity for more information. Example:
<rule name?> <condition/>+ </rule> <condition> expression </condition> <select> <case activity ref negative?/>* </select>

Sequence
The sequence activity is a complex activity that completes after all its sub activities have completed. All sub activities are expected in sequence. Use it any place where an activity can appear. A sequence models a compound state that transitions through a series of sub states, one for each sub activity. A transition is triggered upon the completion of a previous activity. This activity completes once the last sub activity has completed. Example:
<sequence> activity+ </sequence>

Notes:

Course 915: Gentran Integration Suite: Fundamentals

55

Lesson 3 Basic BPML Concepts

Spawn
Use the spawn activity to create a new instance of a business process. The ref attribute must contain the name of a valid business process within the Gentran Integration Suite system. The new business process instance process data is a copy of the parent process data when the spawn activity ran. The child process and parent process are completed independent of each other; if one process completes (either normally or due to a fault), it has no effect on the other. After the spawn activity completes, an element in process data with the same name as the spawned process contains the instance information. Example:
<spawn ref />

Notes:

56

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Process Rules
A rule is an expression that evaluates single or multiple conditions that are based on information known to the process or information communicated to the process. The conditional expressions allow for diverse business process decisions both internal to the process and external to the environment. Complex activities often require that a process select one of several alternative activities or even, on occasion, discriminate the information upon which it acts. Rules can be built into activities that affect activity selection through branching and repeating actions and message consumption. In addition, rules can contain multiple conditions. As the process acts upon rules, process branching may occur. Process branching is a result of a decision made by the process itself. This models the manner in which information created and collected through a process instance drives process running. Rules express single or multiple conditions that are based on information known to the process or information communicated to the process. The contents of the condition activity must correspond to an expression that can be evaluated as either true or false. BPML mandates that these expressions be XPath expressions.

Using Rules
Rules for Choice activities Complex activities often require that a process select one of several alternate activities or even, on occasion, discriminate the information upon which it acts. Rules can effect activity selection using the choice activity.

Process Data
Process data is a context that exists for each process instance and can be used to hold or reference information that is accumulated during the life of the process. Process data is a private area that the process definition writer uses to store data that can be accessed by the running business process. Data entering the system can be of many types, including a document and/or a set of name/value pairs and may be as complex and rich as XML itself. For example, when you run a business process from the User Interface, you can select an input file to use as a
Notes:

Course 915: Gentran Integration Suite: Fundamentals

57

Lesson 3 Basic BPML Concepts

document. When a business process is started, it has data it puts into the document, and it can also set name/value pairs in the process data.
Note: Services often use Process Data to store those name/value pairs that services down the line in the business might need.

Assignments
Using the Assign element As a process runs, it obtains information from participants and communicates it to other participants. In Gentran Integration Suite, participants can be services, adapters, or other processes. An incoming document may contain a great deal of data, but the process participants may only need a small portion of that data. Therefore, the process needs to be selective about what it actually shares with different participants. The process decides what information is relevant and uses the Assign element to share that subset. This takes a known value and includes it in an output message. In a similar manner, it can take a value from an input message and make it available for the process. The direction in which an assignment is done depends on the context in which the Assign element appears; if it is part of the input, the assignment is from message to process; if it is part of the output, the assignment is from process to message. Using the Assign activity The Assign activity sets something in the process data equal to a fixed value, either a number or a string; additionally, it can incorporate XPath expressions. When using the assign element in an operation, you must know the parameters for the service. An example of this is the map name that the translator needs.

The assignment source and target contexts depend on the manner in which the
assign element is used.

When the assign element appears within the output element, it performs
assignment from the process data to the outgoing message. The to attribute corresponds to the path within the message and is used to construct the message contents.

When the assign element appears within the input element, it performs
assignments from the incoming message to the process data. The to attribute corresponds to a value within the process data.
Notes:

58

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

When the assign activity appears as an activity, it performs assignment from a


constant to the process data. The to attribute corresponds to a path within the process data. The from attribute can bep0'u1 @

Notes:

Course 915: Gentran Integration Suite: Fundamentals

59

Lesson 3 Basic BPML Concepts

The fault handling activity runs if the activity faults before completing. If the fault
handling activity completes successfully, so does the faulting activity.

Use multiple onFault activities to handle fault codes. A set of onFault activities
must use unique fault codes and at most one activity may omit the code attribute.

The onFault activity without a code runs only if no fault with a matching code is
found in the correct complex activity. Example:
<onFault code?> activity+ </onFault>

Exceptions
An exception indicates a possible failure condition. A service may need to generate a workflow exception when a required input parameter is: Missing. Invalid. Disabled. For example, a map or a workflow definition is disabled. Use the following syntax to construct an exception:
new WorkFlowException (String errorText, int reasonCode)

Workflow exception reason codes are: public final static int GENERAL_PARM_ERROR = 0; (Default) Use this in situations that require, for example, missing properties files. public final static int MANDATORY_PARM_MISSING = 1; public final static int INVALID_VALUE_FOR_PARM = 2; public final static int RESOURCE_DISABLED = 3; public final static int NO_DOCUMENT = 4 The workflow engine places the error text string for the workflow exception into the status report.

Notes:

60

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Element Editors
BPML activities are installed and configured automatically when you install the GPM. However, some BPML activities, services, and service types may require you to perform additional configuration in the GPM, depending on the task your process model needs to accomplish. You can locate these configuration parameters in one of five different element editor types: Property, Service, Edge, Produce, and Consume. Each element editor provides configuration parameters specific to an activity or a service.
Use this editor: Property Service Edge Produce Consume To configure: Activities that require additional information such as Choice, Assign, and Sequence. Services that require additional information before they can function. Rules for the connections that run from a Choice Start activity to the next activity in the process model. The message and name of the receiving participant or activity. The message a business process should expect and the name of the participant sending that message.

Element editor allows for the configuration of the BPML operations and services that are placed in the business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

61

Lesson 3 Basic BPML Concepts

Notes:

62

Course 915: Gentran Integration Suite: Fundamentals

Lesson 3 Basic BPML Concepts

Lesson Review
Completed Objectives
You should now: Be familiar with the activities that perform BPML functions Be able to differentiate between Services and Adapters as they relate to Gentran Integration Suite Be able to explain how Gentran Integration Suite uses BPML

Congratulations! You have completed Lesson 3, Basic BPML Concepts.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

63

Lesson 3 Basic BPML Concepts

Notes:

64

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4

XPath Basics

This lesson provides an overview of the features that make up the XML Path Language (XPath).

Introduction
Lesson Objectives:
After completing this lesson you should become familiar with: Basic XPath features used to access document content XPath Syntax and Expressions XPath Visualizer XPath Expression Builder

Course 915: Gentran Integration Suite: Fundamentals

65

Lesson 4 XPath Basics

What is XPATH?
XML Path Language (XPath) is a common syntax and semantics for functionality shared between XSL Transformations and XPointer. The primary purpose of XPath is to address parts of an XML document. In support of this primary purpose, it also provides basic facilities for manipulation of strings, numbers, and booleans. XPath uses a compact, non-XML syntax to facilitate use of XPath within URIs and XML attribute values. XPath operates on the abstract, logical structure of an XML document, rather than its surface syntax. XPath expressions can also represent numbers, strings, or Booleans, so XSLT stylesheets carry out simple arithmetic for numbering and cross-referencing figures, tables, and equations. String manipulation in XPath lets XSLT perform tasks like making the title of a chapter uppercase in a headline, but mixed case in a reference in the body text.

The Structure of an XML Document


An XML document is a tree made up of nodes. Some nodes contain other nodes. One root node ultimately contains all other nodes. XPath is a language for picking nodes and sets of nodes out of this tree. From the perspective of XPath, there are seven kinds of nodes:

The root node Element nodes Text nodes Attribute nodes Comment nodes Processing instruction nodes Namespace nodes

Notes:

66

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4 XPath Basics

XPath Visualizer
XPath Visualizer is a full blown Visual XPath Interpreter for the evaluation of any XPath expression and visual presentation of the resulting nodeset or scalar value. The XPath Visualizer's value as an XSLT and XPath learning and authoring tool results from its ability to present the results of any XPath expression in an immediate, appealing and straightforward visualization. It allows the user to define their own dynamic xsl:variable and xsl:key elements and to use variable references and the key() functions in their XPath expressions.
Note: XPath Visualizer is a third party software, and it is NOT supported by Gentran Integration Suite Customer Support

Exercise: Testing XPath Expressions Using XPath Visualizer

To test XPath expressions using XPath Visualizer: 1. Create a new folder called VBXML on the C:\ drive. 2. Open Internet Explorer. 3. In the address line, type http://www.topxml.com/xpathvisualizer 4. Scroll to the bottom of the page and click on the link download the XPath Visualizer for the Standard release of MSXML 3.0 5. Extract the contents of the folder to C:\VBXML 6. From the C:\VBXML folder. Locate and click on xpathmain.html 7. Browse to C:\915 Fundamentals\ClassLabfiles\Cookbook.xml 8. Click the Select Node button to open the document. 9. Locate the XPath Syntax and Expressions section on the following page. 10. Type each XPath expression to find the results highlighted in yellow.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

67

Lesson 4 XPath Basics

XPath Syntax and Expressions


Introduction
XML Path, or XPath, is a language designed to operate on XML data. It is a powerful, if easy language to learn. To explain XPath syntax and expressions, let us use the following XML document:
<?xml version="1.0" encoding="UTF-8"?> <cookbook title="Easy Dinners My Kids Will Actually Eat"> <notes>These are real recipes</notes> <recipe name="Shrimp Scampi"> <ingredient>1 lb. peeled, deveined shrimp</ingredient> <ingredient>.5 cups melted butter</ingredient> <ingredient>.5 cups vegetable oil</ingredient> <ingredient>1 clove garlic, minced</ingredient> <ingredient>1 tblsp lemon juice</ingredient> <ingredient>dash cayenne pepper</ingredient> <notes info="cooking">Toss ingredients together and broil for 10 minutes or until shrimp are cooked, stirring often.</notes> <sides>Rice or buttered noodles</sides> </recipe> <recipe name="Taco Pie"> <ingredient>1 lb. Lean ground beef</ingredient> <ingredient>1 pkg. Corn bread or corn muffin mix</ingredient> <notes>Prepare as indicated on package</notes> <ingredient>1 pkt taco seasoning</ingredient> <notes>Following instructions on seasoning pkt to prepare taco beef.</notes> <ingredient>2 cups shredded cheddar cheese</ingredient> <notes info="cooking">Spread prepared beef in casserole dish. Blanket with cheese. Cover with corn bread batter. Bake at 350 for 30 minutes, or until cornbread is done.</notes> <sides>salad, fruit cocktail, etc.</sides> </recipe> <ingredient>Sprig of parsley for garnish.</ingredient> <ingredient reason="just to make their eyes water">dash cayenne pepper</ingredient> </cookbook>

Notes:

68

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4 XPath Basics

Locating Nodes
Example 1: /cookbook/recipe/ingredient

This statement selects all "ingredient" elements within all "recipe" elements in the "cookbook" document. When a statement begins with a single "/", view the expression as searching an absolute path within the document. Example 2: //notes

This statement selects all "notes" elements in the document, regardless of their level. When an expression starts with "//", all nodes matching the criteria are selected throughout the document.

Using Wildcards
Example 1: /cookbook/recipe/*

This statement selects all child elements of the "recipe" element within the "cookbook" document. Example 2: /cookbook/*/notes

This statement selects all "notes" elements that are grandchildren of the "cookbook" element. Hence, the first "notes" element would not be selected. Example 3: /*/*/notes

This statement selects all "notes" elements that have 2 ancestors. Example 4: //*

This statement selects all elements in the document, regardless of level.

Selective Searching
Square brackets are used to specify an occurrence of a node within a document. Use parentheses when the argument is specified using string characters instead of a number. Example 1: /cookbook/recipe[2]

This statement selects the second "recipe" element within the "cookbook" element. Example 2:
Notes:

/cookbook/notes[last()]

This statement selects the last "notes" element within the "cookbook".

Course 915: Gentran Integration Suite: Fundamentals

69

Lesson 4 XPath Basics

Example 3:

/cookbook/recipe[notes]

This statement selects all "recipe" elements in the cookbook that have a "notes" element within them. Example 4: /cookbook/recipe[ingredient='dash cayenne pepper']

This statement selects all "recipe" elements in the cookbook that include an "ingredient" element whose value is "dash cayenne pepper". Example 5: /cookbook/recipe[ingredient='dash cayenne pepper']/notes This statement selects all "notes" elements of all "recipe" elements within the cookbook, that have an "ingredient" element whose value is "dash of cayenne pepper". Hence, the final "notes" node is not selected, as it is not part of a "recipe".

Using the "And" Operator In Searches


Example 1: /cookbook/recipe/ingredient|/cookbook/recipe/notes

This statement selects all "ingredient" and all "notes" nodes of the "recipe" element within the cookbook. Example 2: //ingredient|//notes This statement selects all "ingredient" and all "notes" elements in the cookbook. Example 3: //ingredient |//notes|//sides

This statement selects all "ingredient", all "notes", and all "sides" elements in the cookbook. Example 4: /cookbook/recipe/notes|//ingredient

This statement selects all "notes" elements within "recipe" nodes in the cookbook, as well as all "ingredient" elements in the entire document.

Searching Attributes
You may search the attributes contained in a node by using the reserved character "@" as a prefix to the search argument. Example 1: //@cooking

This statement selects all attributes named "cooking".

Notes:

70

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4 XPath Basics

Example 2:

//recipe[@cooking]

This statement selects all "recipe" elements that have an attribute named "cooking". Example 3: //recipe[@*]

This statement selects all "recipe" elements that have an attribute of any name. Example 4: //recipe[@name='Taco Pie']

This statement selects all "recipe" elements that have an attribute named "name" that have a value of "Taco Pie".

Searching for Content


You may search a business process for a specific occurrence of a string within the data. Example: /cookbook/recipe [1]/ingredient [1]/text( )

This statement selects the string in the first ingredient in the first recipe. In this example, it returns the following string:
1 lb. peeled, deveined shrimp

Numeric Expressions
XPath also support mathematical and numeric relational expressions, including equality and Boolean. Operators are as follows: Parameters shown in the previous example are:
Operator + * div mod = != < <= Notes: Description Addition Subtraction Multiplication Division Modulus Like or Equal Not Equal Less Than Less Than or Equal To Example 2+4 5-3 2*3 12 div 6 7 mod 3 (remainder is the modulus) Cost = 10.00 Cost != 50.00 Cost < 50.00 Cost <=49.00

Course 915: Gentran Integration Suite: Fundamentals

71

Lesson 4 XPath Basics

Operator > >= or and sum count

Description Greater Than Greater Than or Equal To Or And Sums numeric values in elements Counts occurrences of specific nodes in data

Example Cost > 10.00 Cost >=11.00 Cost >=11.00 or Cost <=49.00 Cost > 10.00 and Cost < 50.00 Sum Order/Cost Count Order/LineItem

Substring
Substring allows you to locate and extract part of the content of an element without having to make use of the entire element.

String-length
String-length returns an integer value counting the number of bytes of data exist within an element.

Notes:

72

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4 XPath Basics

Notes:

Course 915: Gentran Integration Suite: Fundamentals

73

Lesson 4 XPath Basics

Gentran Integration Suite XPath Expression Builder


The XPath Expression Builder enables you to: Easily create complex rules within a business processfor example, a rule to locate a a specific node or source content within an XML document. Create and define your own name and value for sending the name-value pairs through business process data. Describe the path for sending name-value pairs. The XPath Expression Builder supports: Four expression types: Node-Set, String, Boolean, and Number Three token sets: Axis, Node Test, and Predicate The following figure shows the XPath Expression Builder. The functions for the Node-Set expression type and the Axis token set are visible.

Notes:

74

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4 XPath Basics

The following table describes the functions of the four expression types:
Expression Type Node-Set Function

Defines a set of sequential context-nodes that form a complete location path. Specifies what information to process or return for the set of context-nodes. Performs basic string operations, such as finding the length of a string, comparing a string, or changing letters from upper- to lowercase. Modifies the text content of XML elements or attributes. Converts an argument of any type.

String

Boolean Number

Specifies a Boolean argument (using either the true or false state) that can include predicates and return the result.

Specifies a numeric function for summing groups of numbers. Finds the nearest integer to a number. Performs basic arithmetic operations.

The following table describes the three token sets:


Token Set Axis Function Defines the direction of your search by using keywords, including:


Node Test

Attributes Child elements (default) Descendants of the child elements Parent elements Ancestor elements

Indicates the name of the node for which to search. Insert the name of the node test after the resolution operator (::) that follows the axis.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

75

Lesson 4 XPath Basics

Token Set Predicate

Function Inserts a relational operator to test each node in the set of context-nodes of a location path. Predicates can employ Boolean operators.

Displaying XPath Expression Builder


After starting the GPM, you can display the XPath Expression Builder using either of the following features: Rule Manager Assign rules and conditions. Service editor Assign name-value pairs that represent source content and location in business process data.

Notes:

76

Course 915: Gentran Integration Suite: Fundamentals

Lesson 4 XPath Basics

Lesson Review
Completed Objectives
You should now be familiar with basic XPath features used to access document content.

References
All XML and examples: Sterling Commerce Xpath Expressions: http://www.w3schools.com/xpath/xpath_expressions.asp Xpath Syntax: http://www.w3schools.com/xpath/xpath_syntax.asp

Congratulations! You have completed Lesson 4, XPath Basics.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

77

Lesson 4 XPath Basics

Notes:

78

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5

Creating and Maintaining a Business Process Using the GPM

This lesson provides instructions for using the Graphical Process Modeler (GPM) to create an executable business process.

Introduction
Lesson Objectives
By the end of this lesson, you should be able to use the Graphical Process Modeler to: Create a business process Implement a business process Check in a business process model Enable a business process model Manually run a business process model Check out a business process Modify a business process Check in a modified business process Disable a business process

Course 915: Gentran Integration Suite: Fundamentals

79

Lesson 5 Creating and Maintaining a Business Process Using the GPM

What is a Business Process


Business processes are like road maps. Just as you use a road map to determine the best route through the countryside, Gentran Integration Suite uses business processes to find the best route through critical business systems, such as purchasing, inventory status , and invoicing. By analyzing and documenting your business and technical needs, you can determine you business processes. You can then reword those business processes to fit your business needs.

The Life Cycle of a Business Process


This section provides an overview of how Gentran Integration Suite works. It will follow Gentran Integration Suite through:

Defining a business process with services Compiling a business process Check In a business process Starting a business process Archiving a business process Restoring a business process Deleting a business process

Notes:

80

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Defining a Business Process


Gentran Integration Suite is a framework that runs customer-specific business processes. All operations that are carried out on documents and the order in which they are to be carried out are set by an XML-based business process model. Defining a business process might look like the following diagram. The circles represent activities and the diamond represents a decision point.

Translate Document

Total > Max

Yes

Report Error

No

Process Request

Since Gentran Integration Suite stores business process definitions in XML, there are a couple of ways for a business process analyst to define them:

Graphical Business Process Modeler included with Gentran Integration Suite Simple text editor
Nodes in a business process model Nodes in a business process model are the graphical representation of the steps the business process goes through as it runs and processes the data involved. A simple example is shown below.

Start

Node 1
Receive Transmission

Node 2
Translate Data

Node 3
Write XML data to file

End

Notes:

Course 915: Gentran Integration Suite: Fundamentals

81

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Services Flexibility is key to the business analysts working with the IT staff to determine how business processes should be written. Gentran Integration Suite allows you to write subprocesses with multiple reusable components or as one large service that does a complete process on its own. One way to look at services is to look at where they get the information they process and where they pass it to once processing is complete:

Internal services are located inside Gentran Integration Suite; they accept
parameters and produce results, but they do not interact with any system outside Gentran Integration Suite.

Input services receive data from an outside system. Output services send data to an outside system.
Adapters Input and output services are known collectively as adapters. Adapters interact with the world outside Gentran Integration Suite. Business Process Context The service accepts a business process state and produces a modified business process state, or business process context (BPC). BPC may also be referred to as WFC, or Workflow Context.

Compiling a Business Process


After you create a business process model, you must validate and compile the process before you can run it. Validating ensures all activities in the business process model are properly configured. Compiling the business process allows Gentran Integration Suite to determine the Start node ahead of time so business processes are more easily instantiated and run. Since the start pointer for the next activity (node) is stored in the current activity (node) information, compiling the business process also eliminates repeated parsing of XML and reduces the number of queries to the database.

Notes:

82

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Checking In a Business Process


Before you can use a business process within Gentran Integration Suite, you must first check it into the system. You can check in a business process model from within the

GPM interface or through the Gentran Integration Suite interface.


Both the Gentran Integration Suite interface and the GPM provide a Source Manager feature you use to check in a business process. The two Source Managers differ slightly, but both enable you check in new business process definitions and new versions of previously checked-in process models. Both display the current list of business process models and versions. Each time you check in a business process, you create a version of the business process, either the first version of a new process model, or a new version of a previously checked-in business process model. Gentran Integration Suite saves each checked in version so that you retain a copy of every iteration of a process model that you check in. You cannot check in a version of a business process that is checked out and locked (protected) by another user.

Starting a Business Process


Gentran Integration Suite supports bootstrapping - dynamic selection of the appropriate business process to run when data enters. Input data must enter Gentran Integration Suite by way of an input adapter. This adapter takes the received data, puts the data and any metadata it finds into an Initial Business Process Context (IBPC), and begins bootstrapping. A business process definition will be selected based on the data and/or metadata and instantiated as needed.

Archiving a Business Process


Archiving your business process data not only protects your critical data but also conserves database storage, improving the efficiency of Gentran Integration Suite.

Restoring a Business Process


After you have archived business process data to an offline location, you can restore that data and view it in Gentran Integration Suite.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

83

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Deleting a Business Process


In Gentran Integration Suite, you can delete individual business processes (except business processes used by Gentran Integration Suite). Some reasons you might delete a business process are: Business activities have changed and, as a result, a business process can no longer accomplish the activities. You need to remove versions of a business process to reduce the database size.

Notes:

84

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Test Your Knowledge

1. What are some of the typical business process problems that companies have to deal with using their current systems?

2. List three benefits using Gentran Integration Suite:

3. List the three main interfaces used with Gentran Integration Suite:

Notes:

Course 915: Gentran Integration Suite: Fundamentals

85

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Creating a Business Process


After analyzing your business needs, determining your business processes, and documenting the results, you must create business process models that represent those business processes. You can then implement and run the business processes with Gentran Integration Suite.

Before You Begin


Because a business process must be validated to run successfully in Gentran Integration Suite, you must ensure that you validate the BPML code in each business process before you add the process to Gentran Integration Suite. The sections in this lesson include steps to validate a business process; however, before you can complete these steps, you must have the BPML Compiler feature installed and unlocked using a license.

Implementing a Business Process Using the GPM


To implement a business process in Gentran Integration Suite using the Graphical Process Modeler (GPM), complete the following steps as appropriate: 1. Create a business process model, including:

Configuring additional parameters Adding sub flows Assigning rules and conditions Assigning name-value pairs that represent data to locate in process data Configuring the Correlation service to generate correlations for business processes and document exchange

2. Validate and save the business process model document. 3. Add the business process to Gentran Integration Suite.

Notes:

86

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Moving Activities to the Workspace

1. Open the Graphical Process Modeler. 2. Click New. 3. Bring up the Stencils if not already showing. 4. Move the following operations and services to your workspace by dragging the icons from the Stencil to the Workspace: (1) Start (1) End (3) Sequence Start (3) Sequence End (3) Assign (1) Choice Start (1) Choice End (1) XML Encoder

Notes:

Course 915: Gentran Integration Suite: Fundamentals

87

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Connecting Activities

Connecting activities determine the order in which the activities are run within the Business Process. 1. Click on the triangle at the right of the Start node and keep the mouse button down. 2. Drag the mouse to the left triangle of the Sequence Start node and release the mouse button. This creates a link between the nodes. 3. In the same manner, connect the activities from the previous exercise as shown below.

4. To visually align the business process model, select View > Autolayout. 5. From the File menu, select Save and save the business process model document (.bp file) to your client computer. You do not need to validate this business process model because you have not configured any parameters yet.
Note: Give the business process model a name that helps identify the business process.

6. In the Save dialog box, select a directory on your client computer, name your file BasicInventoryProcess, and click Save. You are now ready to configure parameters, add sub flows as necessary, and assign rules and conditions for your business process model.

Configuring parameters
Some activities and services require configuration within the GPM. You perform the configuration using the five element editors in the GPM: Property, Service, Edge, Produce, and Consume.
Notes:

88

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Hands-on: Viewing the Element Editor and Configuring Additional Parameters

To view an element editor and configure additional parameters: 1. Select an icon on the workspace and click Properties to display the applicable element editor. For example, when you select the Assign icon, the Property editor opens and provides parameters to configure for the Assign activity. 2. Configure the parameters in the element editor. 3. For each remaining icon on the workspace, configure the parameters in the applicable element editor as necessary. 4. Right-click the Editor tab and select Close Editor Tab. 5. Validate and save the business process model.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

89

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Adding Sub Flows

Sub flows
A sub flow creates a layer in a business process model where you can define more details about an activity in a business process. As you design the business process model, identify where sub flows are possible and design them accordingly. To add a sub flow: 1. From the Tools menu, select Add Sub Flow. In the Navigation pane, the business process model expands to list the sub flow. 2. Delete the XML Encoder and first Assign service from the business process by clicking on the icon and pressing the delete key. 3. Insert the sub flow icon between the Sequence Start and the Choice Start icons within the business process model. 4. Link the icons accordingly. 5. To rename the sub flow, select the sub flow icon, right-click, and select Properties to display the Property editor. Type SubFlow1 in the Value field. When you click out of the Property editor, the sub flow icon displays the new name. 6. In the Navigation pane, click the sub flow to display a new workspace that includes unlinked Start and End icons. 7. Create a business process model for the sub flow. a. Add the XML Encoder and Assign icons within the sub-flow. b. Arrange the icons. c. Link each icon, including the Start and End icons. d. Align the business process model. 8. In the Navigation pane, click the parent business process (the one that the sub flow is part of) to return to the main process. 9. Save the business process model.

Notes:

90

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Assigning Rules and Conditions


To indicate a decision point in a business process model, you must: Assign a rule that describes the decision. Provide the conditions under which the decision is true or false. When running a business process that processes XML documents, you must use XPath to describe rules and conditions for processing the XML document. Specifically, you must create XPath expressions that: Identify particular elements (or nodes) and their positions in both the input and output documents. Identify particular elements in the input document for copying into an output document or for further processing. Define any constraints of name-value pairs for elements. Calculate values that depend on other values. You can then assign rules that represent the decision to complete activities in the business process. The following table shows sample names and rules using simple syntax:
Name rule1 rule2 rule3 Rule X>10 X<=10 X<10

Notes:

Course 915: Gentran Integration Suite: Fundamentals

91

Lesson 5 Creating and Maintaining a Business Process Using the GPM

The following figure shows the part of a sample business process model where a decision must occur in a business process. The Choice Start and Choice End icons are included and rule names display midway through edges (links) in the business process model.

Edge Assigned Rule

Creating a Rule
1. Create a rule defined by simple syntax. a. From the Tools menu, select Rule Manager. b. Click Add and type a name that describes the rule. c. In the Expression field, type the syntax, and then click OK. d. Repeat steps 1a - 1c until you finish creating rules defined by simple syntax. 2. Create a rule defined by complex syntax using XPath: a. From the Tools menu, select Rule Manager. b. Click Add and type a name that describes the rule. c. Click the button to the right of the Expression field to display the XPath Expression Builder. d. Display the expression type you want to perform, double-click the function to add it to the Expression field, and then type values to complete the expression type as needed.
Notes:

92

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

e. Display the token set attribute to complete the function of the expression type and double-click the attribute to add it to the Expression field. f. Repeat steps 2a - 2e until you finish defining this XPath expression and click OK. g. Repeat steps 2c - 2f until you finish creating rules defined by complex XPath.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

93

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Assigning a Rule

Assign rules and define conditions: 1. Right-click the edge (link) between Choice Start and the icon instance on the top and click Properties to display the Edge editor. 2. In the Edge editor, click Add to display the name and value columns. 3. Under the Name column, click in the field and select Inventory Rule. 4. Under the Value column, select True for the selected rule. When you click out of the Edge editor, you see the rule name on the edge. 5. Right-click the edge (link) between Choice Start and the icon instance on the bottom and click Properties to display the Edge editor. 6. In the Edge editor, click Add to display the name and value columns. 7. Under the Name column, click in the field and select Inventory Rule. 8. Under the Value column, select Not true for the selected rule. When you click out of the Edge editor, you see the rule name on the edge. 9. Save the business process model. Do not Validate during the Save.

Notes:

94

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Viewing and Configuring the Different Element

Notes:

Course 915: Gentran Integration Suite: Fundamentals

95

Lesson 5 Creating and Maintaining a Business Process Using the GPM

8. Click the Assign activity in Greater than 10 and enter the following information:
Name Constant To Value Do Not Order More Items Result

9. Click the Assign activity in Not Greater than 10 and enter the following information:
Name Constant To Value Order More Items Result

Exercise: Saving and Validating a Business Process

Validating a Business Process ensures all activities have been completed properly and the BPML generated from the graphic is syntactically correct. The output window at the bottom of the Graphical Process Modeler shows any error messages. Saving without validating saves the current graph so that you can open it in the GPM later. Without validation, you cannot execute the Business Process. 1. Select File > Save. 2. Click Yes when asked to validate the process model upon saving. 3. Complete the Save dialog: a. Select the folder location. b. In the FileName field, enter BasicInventoryProcess. c. Select OK. 4. If the process model is not valid the output window will appear at the bottom of the Graphical Process Modeler with a display of the error messages. Correct the errors and try saving the Business Process again.

Notes:

96

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Implementing a Business Process


After creating or modifying a business process model, you must validate, check in, and test it before running it in Gentran Integration Suite. Use a test environment for checking in and testing your processes before you run them in your production environment. The first time you check in a business process, you create a business process definition-a uniquely named copy of the process model to be stored in Gentran Integration Suite. The business process model stored in Gentran Integration Suite is independent of any .bp file of the process that you may have saved in a local directory.

At any time, you can modify an existing process model and check in a new version to Gentran Integration Suite, or save the modified copy of the process in Gentran Integration Suite as a new process altogether. Version management is an important part of business process maintenance.

Checking in a Business Process


You can check in a business process model from within the GPM interface or through the Gentran Integration Suite interface. Both the Gentran Integration Suite interface and the GPM provide a Source Manager feature you use to check in a business process. The two Source Managers differ slightly, but both enable you check in new business process definitions and new versions of previously checked-in process models. Both display the current list of business process models and versions. Each time you check in a business process, you create a version of the business process, either the first version of a new process model, or a new version of a previously checked-in business process model. Gentran Integration Suite saves each checked in version so that you retain a copy of every iteration of a process model that you check in. You cannot check in a version of a business process that is checked out and locked (protected) by another user.

The check in procedure differs depending on your goal and the application you are using.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

97

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Determining Processing Options During Check-in


During the check-in procedure, Gentran Integration Suite prompts you to select a variety of processing options for a business process model. These options are related to archiving, document storage and tracking, persistence levels and other instructions related to your business needs. The settings you choose may affect system performance. Before you check in a business process model, have an idea of what the appropriate selections are for your installation.

The following table describes the options:


Field Process Name Description Type a name that identifies the business process model. This is the business process definition name that will be stored in Gentran Integration Suite. Type a description that helps identify the business process you are creating. This is stored in Gentran Integration Suite with the business process definition you are checking in. If the process model is an updated version of a business process, you may want to use a meaningful version number or some other content to identify the version. Enable or disable this selection. Select this option if you want documents involved in this process model to be trackable according to the document tracking settings you have configured. Document tracking at the business process level is disabled by default, and this setting overrides the global document tracking setting. If you are not using Application document tracking features, leave the option disabled, to reserve system resources for other tasks. Set OnFault Processing Enable or disable this selection. Select this option to enable the on-fault activity specified in the process to immediately execute in the event of a system error. Gentran Integration Suite enables you to set performance optimizations by queue, defining queue levels to allocate resources. Select the previously allocated queue level that you want for this business process model for processing.

Description

Document Tracking

Set Queue

Notes:

98

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Field Enable Async Start Mode

Description Asynchronous initiation is selected by default. Starting business processes asynchronously is recommended. Asynchronous mode is standard Application processing, wherein the business process is placed in queue and processed. Note: Always use asynchronous mode, with one possible exception. If you are running this process in Sync mode, you must use synchronous start. You may be using Sync mode if, for example, you are using the MSMQ adapter, set to Embedded mode. Clear this check box to use synchronous mode. Sync mode functionality is limited in that your Persistence Level is Zero by default, and you cannot, therefore, manually restart or resume the process.

Enable Transaction

Select this option to instruct Application to treat the entire process as a single transaction so that either all of the steps complete, or, in the event of an error, none of them do. When an error occurs, no data is committed; data returns to its pre-process state. Note: Enabling transactions applies only to services that support transaction mode. See the reference information for specific services to determine whether this option is supported. By default, this transaction mode is not enabled. Note: If transaction management is already built into the process model (the model includes Start and End Transaction services), do not select this option or the process will fail.

Category

You can optionally enter a category name to which this process model belongs, creating the category. The category does not affect processing; categories are for future product enhancements.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

99

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Field Persistence Level

Description Select the level of data to retain for generating a status report that describes each step that the business process completes. The levels are:

Full - Retain all data for this business process, including associated documents, activities, and all process data. Step Status (Engine May Override) - This is the recommended persistence level for most process models because it helps optimize performance while providing a level of recovery suitable for most business needs. * Persists process data and documents for service steps according to the persistence level supported by the service in the step.

BP Start Stop (Engine May Override) - Choose this level if you know you do not need persisted status data for successful processing. Because service level settings override the selection, you may have additional data in a recovery scenario. * Persists process data and documents for service steps according to the persistence level supported by the service in the step.

System Default - Assume that for the data, configuration is already defined in Gentran Integration Suite to retain data. * Persists data according to the global persistence setting configured in the properties file.

Step Status Only - Choose this level if you need only status information for each step and your recovery needs do not depend on additional data being saved. BP Start Stop Only - Choose this level if your recovery needs do not depend on data being saved for the processing steps. Zero - This level does not persist any business process data you for recovery or process tracking. Choose this level only if you are certain you will not need the data.

Note: Zero persistence is available only if the process is running in Synchronous start mode.

Error Only - Choose this level if you do not need tracking data for your process when it is successful and your recovery does not depend on process step data being saved.

Notes:

100

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Field Event Reporting Level

Description Select the level of event reporting that you would like to retrieve for this business process when it runs. The levels are:

Full - Generate events for the business process, including the business process start and end time, start and end times for all services or adapters running as a result of this business processes, and any resulting errors and exceptions. Minimal - Generate events for the business process, including the business process start and end time and any resulting errors and exceptions. None - Do not generate any event reporting.


Recovery Level

Select the level of recovery for this business process if the business process should halt during execution. The levels are:


Document Storage

Auto Resume - Resume the business process at the point at which the business process halts. Auto Restart - Restart the business process from the beginning. Terminate - Terminate the business process. Manual - Require you to resume or restart the business process manually.

Select the level of document storage for documents that process when the business process runs. The levels are:

Database - Store documents in the database. File System - Store documents in the file system. Archiving and purging from the file system may require special handling. System Default - Store documents in the file system or database, according to how you configured archiving and purging in Gentran Integration Suite. Inherited - If this is a subprocess, use the same storage type indicated for the parent business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

101

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Field Enable BP Execution Settings

Description This option displays only when you are using a clustered Application environment. Select this option to display the available choices for specifying the node to run the process on. If you do not specify a node, the system uses any available node. To select a node: 1 In the Select Node field, select the node on which you want the process to run. 2 In the Execution Node Specific field, specify whether the process must run on the selected node or can use others. Options are:

Preferred Node - Run the process on the selected node unless the node is unavailable (inactive for some reason). Mandatory Node - Always run the process on the selected node (if the node is unavailable for some reason, the process will fail).

Note: The Execution Role Specific field is reserved for future use. Deadline Setting Deadline setting indicate how much time the process may take to complete. Select the appropriate setting. Settings are:

Do not set deadline - Enables you to run the business process without a deadline. Complete by Deadline - Enables you to specify a deadline time, in hours and minutes, by which the business process must complete process once it starts. First Notification: Hours and Minutes - Enables you to specify whether to receive notification before a business process deadline. Second Notification: Hours and Minutes - Enables you to specify whether to receive another notification before a business process deadline.

Notes:

102

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Field Life Span

Description Use these options to: Indicate the length of time that data pertaining to each instance of this business process model will remain in the system after the process has completed, to be available for monitoring, tracking and reporting activities. Specify whether to archive or purge the process-related data when the life span expires.

Process Specific - Enter the number of days or hours, or days and hours combined, that data for each instance of this business process model are permitted to remain in the system. Expired Business Processes should be - Select either Archived or Purged for expired data. Archived data is stored in your file system. System Default - Select this option if you want the data for instances of this business process model to expire and be archived after two days. This option is configurable.

Enabling Document Tracking


Enabling Document Tracking makes the document activity for this business process available from the Advanced Search menu. Access Document Tracking from Business Process > Monitor > Advanced Search > Documents.

Setting onFault Processing


The onFault element is used to handle errors. You can include onFault elements in any complex activity for which it may be necessary to recover from faults so that the process can continue. The onFault element contains a fault handling activity.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

103

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Setting the Persistence Level


The persistence level options enable you to specify, at the business process level, the types of data to retain in the database for the process whenever it runs. Persisted data can be crucial to process recovery in the event of errors and is useful for monitoring and tracking activities, including generating status reports. Persisted data may include any of the following types of data: Status information for the steps in the process, which is comprised of:

General status information for the steps (start and stop time, step name) Error information for failed steps Data describing the start and stop conditions of the process
Process data Documents associated with the process The types of data persisted for a process depends on the activities the process involves (such as whether the process has documents associated with it) and your persistence level settings. Persistence can also be set globally (at the system level) for all processes; by default this is set to FULL persistence, although it may have been customized for your installation. If your installation uses the default FULL setting for the system, you generally do not need to change persistence at the business process level unless you are seeking performance improvements. For the process model you are checking in, your selection here overrides the global persistence level set in the properties file.
Note: Two exceptions may affect your persistence selection. First, remember that some services support only a limited selection of persistence settings, regardless of the level of persistence you assign to the process model. Second, any persistence overrides configured in the BPML for steps in the process model override the setting you make here for the specified step or steps.

Choose the option that provides the type of data you need for monitoring, tracking, and recovery in the event of a failure. Remember that persisting data can slow system processing by filling up the database. Consider your archive and purge settings in addition to the amount and type of data you intend to persist.

Notes:

104

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Choosing document storage


Document storage type is the storage type you want for documents that process when the business process runs. The levels are: Database - Store documents in the database. File System - Store documents in the file system. This option may be best for large documents. Using this method, you must handle archiving and purging the documents from your file system. System Default - Store documents in the file system or database, according to how you configured archiving and purging in Gentran Integration Suite. Inherited - If this is a subprocess, use the same storage type indicated for the parent business process. When you check in a business process, Gentran Integration Suite gives you the opportunity to select the location for storing the business process.

Setting the process instance life span


When you check in a business process, Gentran Integration Suite gives you the opportunity to set the Life Span of specific instances generated by that business process. The Life Span setting tells Gentran Integration Suite how long the instance should remain in the active system. In addition, when the business process instances expire, you can set them to either automatically archive or purge themselves from the system.

Setting the expired characteristics of a process instance


When you check in a business process, Gentran Integration Suite gives you the opportunity to determine if the specific instances of the business process is to be Archived or Purged. This must be set up in the business process. Archive moves instances of business processes that have been run and any associated data from the live system to a storage area. Once in the storage area the business process instance (and data) is available to be moved to offline media for storage. Purge permanently removes business process instances that have run and any associated data. Archive and purge help to limit the amount of information kept in the live system. It is important to note, data that must be kept long-term should be archived and stored in a safe media.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

105

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Enabling a business process


You must enable a business process that is checked in to the system before it can be available to run. Enabling a process model tells the system that this process is available to run. You cannot enable a business process unless it was validated at check in. Business processes checked in through the Administration UI are automatically validated.

Creating Permissions
Select this option to have a permission selection created for this business process model automatically. The permission can be assigned to user accounts to enable or restrict user access to running the process. Permissions are optional. If none are assigned, the process is available for all users.

Setting the default version of a business process


When you check a process model into the system, you may also set it as the default process. The default process is the process version that Gentran Integration Suite uses when running a request of a new process instance that does not have explicit version information. Well discuss versions of business processes later in this lesson.

Disabling a business process


Only business processes set as the default version can run. A business process that has been checked in to the system can be disabled, or made not available for run if it is not set as the default version. When a business process version is disabled, the system will not start new instances of the process.

Notes:

106

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Check in the Business Process


You can check in a business process model from within the GPM interface or through the Gentran Integration Suite interface. Both the Administration Interface or User Interface and the GPM provide a Source Manager feature you use to check in a business process. The two Source Managers differ slightly, but both enable you check in new business process definitions and new versions of previously checked-in process models. Both display the current list of business process models and versions. Each time you check in a business process, you create a version of the business process, either the first version of a new process model, or a new version of a previously checked-in business process model. Gentran Integration Suite saves each checked in version so that you retain a copy of every iteration of a process model that you check in. You cannot check in a version of a business process that is checked out and locked (protected) by another user. There are three ways to check in a business process. The Business Process Manager provides two different methods.You can check in a business process by using either the: Graphical Process Modeler Business Process Manager

Notes:

Course 915: Gentran Integration Suite: Fundamentals

107

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Checking in a Business Process by way of the GPM

If you are not already in the Graphical Process Modeler, complete steps 1 and 2. Otherwise, skip to step 3. 1. On the Gentran Integration Suite Administration menu bar click Business Process > Manager. 2. On the Gentran Integration Suite Business Process Manager page, click Go! next to Graphical Modeling: Run Graphical Process Modeler. 3. In the Graphical Process Modeler, click Tools>Source Manager. 4. Log on to the Source Manager using your GIS login and password. 5. Click Process > Add. 6. Type the Process Name BasicInventoryProcess and click Next. 7. Browse out and select your BP file using the Browse Button. 8. Type Basic Inventory BP as the description. Click Next.
Note: For the following fields, your view may differ, depending on whether you specified Expert Mode for the Source Manager through the GPM. If you did not specify Expert Mode, click Next to display the following fields

9. Set the Priority Level to 4, the Persistence Level to System Default, the Event Reporting Level to None and the Recovery Level to Manual. Set the Document Storage to System Default. Click Do not set deadline and click Next. 10. Accept the System Defaults for Archive on the next two screens by Clicking Next. 11. Check Validate. 12. Check Enable Process. 13. Do not check Enable Document Tracking and Set onFault Processing. 14. Click Finish. 15. Click OK.

Notes:

108

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Checking in a Business Process by way of the

Notes:

Course 915: Gentran Integration Suite: Fundamentals

109

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Manually Running a Business Process


Gentran Integration Suite runs most business processes automatically. There are times however, when it is necessary to run a business process manually. This topic describes the procedure for manually running a business process. When you build a new business process, it is important to test it prior to moving it into production. You can do this by manually running the business process.

Exercise: Manually Running a Business Process

1. Click Business Process > Manager. The Business Process Manager screen will be displayed.

Notes:

110

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

2. Type BasicInventoryProcess in the Search text box and click Go! 3. Click the Execution Manager icon for BasicInventoryProcess. 4. Click the execute icon. 5. Click Browse and navigate to C:\915 Fundamentals\Class Labfiles to locate the test data. 6. Locate the file InventoryOf3.xml, and click Open. 7. Click Go! 8. Observe the separate Execute Business Process window while the business process runs. 9. Close the Execute Business Process window when the Business Process has completed running. 10. Repeat steps 4-10 using InventoryOf11.xml as the input document. 11. Click Return.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

111

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Notes:

112

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Modifying a Business Process


To modify or reuse a business process that is currently checked in to Gentran Integration Suite: 1. Check out the business process. The check-out process enables you to save the business process to your client computer. You can then open the checked-out .bp file in the GPM and modify the business process model. 2. Modify or Edit the business process as needed. 3. When finished, check the new version in to Gentran Integration Suite.

Checking Out a Business Process


When you need to modify or reuse a business process that is currently checked in to Gentran Integration Suite and enabled for modification, you can check out the business process from Gentran Integration Suite. The check-out process enables you to save the business process to your client computer. You can then modify the business process document to create new versions of a business process or a new business process. If you have logged in to Gentran Integration Suite using Source Manager in the GPM, you can check out a business process using Source Manager. Source Manager also enables you to check out one or many business processes at the same time. You may want to check out a business process when:

A business analyst creates or modifies the business processes and has limited
access to the host.

An employee modifies the business processes from a remote location. A business process exists on a test environment and is ready for use in the
production environment.

Gentran Integration Suite checks out a copy of the selected process version, not
the original version. If the selected business process is enabled, it remains enabled until it is replaced by a newer version.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

113

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Editing a Business Process


Making Changes to an Existing Business Process Model
To make changes to a process model that has been checked into Gentran Integration Suite, you first need to check out the process. This locks the process so that no other users will make simultaneous changes. The checked out version of a process model remains locked to other users until that user checks in the process. The GPM is the preferred method of making changes to a business process model, although advanced users may prefer to make changes using BPML. When you choose to work in the BPML, and then reopen the process model in the GPM, it will open the process using the default layout options. Since the default layout may appear differently than your specified layout, we recommend that you work in the process modeler.

Exercise: Editing a Business Process Using the GPM

Use the following procedure to edit the particular business process. 1. In the Gentran Integration Suite Graphical Process Modeler, click Tools > Source Manager. 2. Log on to the Source Manager with your GIS login and password. 3. Scroll through the list of business processes until you find BasicInventoryProcess. 4. Select BasicInventoryProcess process and click the Check out a Process icon. 5. Click OK to accept the location for where BasicInventoryProcess.bp will be saved.
Note: The Lock checkbox indicates that a user is operating on the business process.

6. In the Gentran Integration Suite Graphical Process Modeler, click Open file icon and select the location of where BasicInventoryProcess.bp was saved. 7. Modify the business process model by adding Assign BPML activity.
Notes:

114

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

From the BPML Operations stencil, click and drag Assign to the workspace. Break the link after Choice End and before Sequence end. Connect the new Assign to Choice End and the Sequence End respectively.

8. Right-click the Assign activity, then click Properties. 9. In the Property Editor:

In the from field, type count(INVENTORY/PRODUCT) In the to field, type TotalCount


Note: The to field cannot have any spaces.

10. Click File > Save. 11. Click Yes on the Validate on save window. 12. Check in the process model.
Note: Be certain to validate again and enable during check-in, otherwise you cannot run the process.

13. Run the process model with either Inventory documents. 14. Observe Info icon of the Instance Data column of step 4.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

115

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Notes:

116

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Checking Out the Business Process with the Edited BPML

1. In Source Manager, select the BasicInventoryProcess, and select Process > Check out. 2. When prompted to save the process to your client computer, navigate to c:\915 Fundamentals and click Save. 3. When the save is complete, return to the GPM, and select File > Open. 4. Navigate to c:\ 915 Fundamentals, and choose BasicInventoryProcess.bp. Click Open. 5. Notice the changes to the names of the Sequence Starts. 6. Click Tools > Rule Manager. 7. Click your rule, and select Edit. Note that your rule now test for 15 instead of 10.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

117

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Version Control
Versioning
Gentran Integration Suite maintains a record of each business process, when it is checked in, when it is checked out, and when it is modified. This simple process keeps two users from inadvertently overwriting each others modified processes. As each business process definition is checked into the system, a versioning record begins. Furthermore, as a different version of a process is checked in, you specify the default version of that process. This is how Gentran Integration Suite knows which version of a process to run when new data enters the system or when a specific version is not explicitly requested.
Note: You must also validate and enable the business process upon check-in for that version to become the default.

The Execution Manager allows you to manually select which version of a business process to execute. This is useful when you are building a new version of business process and want to compare results. In addition, Gentran Integration Suite can then keep track of which version of a process was running for a particular business process instance.
Note: It is recommended that you use the description for setting the versions.

Notes:

118

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Viewing a Business Process Definition Version from within the GPM Source Manager

Use the following procedure to examine the version information for a particular business process. 1. In the Gentran Integration Suite Graphical Process Modeler, click Tools > Source Manager. 2. Log on to the Source Manager. 3. Scroll through the list of business processes until you find BasicInventoryProcess. 4. Expand the view of BasicInventoryProcess to see the list of versions for this business process definition. 5. Close the Source Manager.

Exercise: Viewing a Business Process Definition Version from within Gentran Integration Suite

Use the following procedure to examine the version information for a particular business process. 1. On the Gentran Integration Suite Administration Home page, click Business Process > Manager. 2. In the Search Process Name: field type BasicInventoryProcess. 3. Click Go! 4. For the BasicInventoryProcess business process definition, click the Source Manager icon. 5. Observe the version information in the Source Manager, specifically the Date and Change History columns.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

119

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Exercise: Completing the Process

In this exercise, we will need to add an XPath expression to the sub flow within the BasicInventoryProcess bp. 1. Open the GPM, if not already open. 2. In the Gentran Integration Suite Graphical Process Modeler, click Tools > Source Manager. 3. Log on to the Source Manager with your GIS login and password. 4. Scroll through the list of business processes until you find BasicInventoryProcess. 5. Select BasicInventoryProcess process and click the Check out a Process icon. 6. Click OK to accept the location for where BasicInventoryProcess.bp will be saved. 7. In the GPM, click Open file icon and select the location of where BasicInventoryProcess.bp was saved. 8. Click on the Sub Flow in the Navigation Pane. 9. Click on the Assign activity in the model to bring up the Property Editor for the operation. 10. Remove the text in the Value column for the Constant field. 11. Type the following XPath expression text in the Value column for the From field: sum
(INVENTORY/PRODUCT/PRICE)

12. Click File > Save. 13. Click Yes on the Validate on save window.

Notes:

120

Course 915: Gentran Integration Suite: Fundamentals

Lesson 5 Creating and Maintaining a Business Process Using the GPM

14. Check in the process model.


Note: Be certain to validate again and enable during check-in, otherwise you cannot run the process.

15. Run the process model with either Inventory documents. 16. Obtain the results from running the business process. If you encounter any errors or have questions regarding this exercise, please see your instructor.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

121

Lesson 5 Creating and Maintaining a Business Process Using the GPM

Lesson Review
Completed Objective
You should now be able to use the Graphical Process Modeler to create, implement, maintain and run a business process using the following steps: Create a business process Implement a business process Check in a business process model Enable a business process model Manually run a business process model Modify a business process Check in a modified business process Disable a business process model

Notes:

122

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6

Troubleshooting a Business Process

This lesson explains how to locate and correct potential problems in a business process.

Introduction
A business process instance is a unique copy of a business process created when the business process is run within Gentran Integration Suite. By monitoring business process instances, you can confirm whether they carry out their intended purposes.

Lesson Objectives
By the end of this lesson, you should be able to: Check the status of a business process Search a business process View business process details Restart and resume a business process View execution information Terminating a business process

Course 915: Gentran Integration Suite: Fundamentals

123

Lesson 6 Troubleshooting a Business Process

Viewing Active and Recent Business Processes


Gentran Integration Suite provides general and detailed processing information. You can view processing information to monitor active and recent business processes instances to determine if any further action is required.

Viewing General Processing Information


The Monitor page refreshes automatically and displays the 10 most recent instances of business processes to run and their processing information. When monitoring active and recent instances, Gentran Integration Suite shows two status indicators to indicate further action is required:
Status Indicator Active Business Process Encountering no errors or warnings at this point of the execution. Recent Business Process Encountered no errors during execution. Encountered errors or warnings during execution.

Waiting for other activities to complete before continuing execution. Encountering errors or warnings during execution.

Notes:

124

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Notes:

Course 915: Gentran Integration Suite: Fundamentals

125

Lesson 6 Troubleshooting a Business Process

Field/Column Expires

Description Information about when an instance expires. Click Info to display the expiration information, including whether the data for the instance is archived after it expires. Parent or child business process that is referenced when running an instance. Click the up arrow to view a parent business process. Click the down arrow to view a child business process.

Parent/Child

Viewing Detailed Processing Information


The Business Process Detail page provides you with a step-by-step progress report on a specific business process instance. From the Business Process Detail page, you can also perform activities, such as stopping or restarting an instance.

Notes:

126

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Exercise: Viewing Detailed Processing Information

To view detailed processing information: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Current Processes. 2. In the Monitor page, click the number identifying the instance in the ID column. 3. In the Business Process Detail page, use the following fields to review detailed processing information and perform activities, as appropriate:
Field/Column Name Instance ID Status Description Name of the instance for which you are viewing details. Click the name to view the BPML code that makes up the instance. Number assigned by Gentran Integration Suite to identify this instance. Current status of this instance. Possible status levels are:


State

Success Error

Current state of this instance. The following list shows possible states in the order of precedence during branch processing:


User

Active/Running Completed Terminated Waiting Interrupted Halting/Halted

Identification of the user who ran the process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

127

Lesson 6 Troubleshooting a Business Process

Field/Column Action

Description List of actions to complete for this instance, including an activity to generate an XML report. The actions available in this field are determined by whether the instance is currently active or stopped. Possible activities are:

Restart Continues running an instance. Stop Stops running an instance. Terminate Cancels an instance and all remaining active and waiting subprocesses. XML report Generates an XML report that describes the instance.

If you terminate an active instance, the State field may indicate messages in the following order: Halting > Halted > Terminated. Step Service Status Current step of this instance. Name of the service running for a current step. Click the service name to view settings for a service in this instance. Current status of the steps in this instance. Possible status levels are:


Advanced Status

Success Error

Service-specific details about any errors that occurred for a step in this instance, when applicable. Click the message to display information. Date and time the step of the instance started. Date and time the step of the instance ended. Status report that provides the results of the step. To view the status report, click info. Business process document that this service is processing (that is, the primary document). To view the document, click info. Contents of the process data generated after a specific step in this instance. In addition, this field links to any messages going to or coming from a service. To view the information, click info.

Started Ended Status Report Document Instance Data

Notes:

128

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Searching for Business Processes and Other Information


In Gentran Integration Suite, you can use the Central Search page to search for information about: Additional live (active) business process instances that do not display in the Monitor page EDI Correlation matches In the Central Search page, you can specify the search criteria to locate business process instances by business process name, status, or by date and time.

Searching for Business Process Instances (Central Search)


To perform a basic search for business process instances: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Central Search. 2. In the Start Date From: dialog box, enter yesterdays date in the form MM/DD/YYYY and enter the time 01:00:00 (HH:MM:SS) Click Go! 3. In the Central Search Results page, click the number link that indicates the number of matches in Gentran Integration Suite. The Monitor page opens, listing the business process instances that match your search criteria.

Searching for Business Process Instances (Advanced)


You can perform an advanced search for the following information: BPSS business flow transactions Active, archived, and restored business processes Document Tracking EDI records for business process instances that included EDI interchange processing Correlation name-value pairs that you defined using the Correlation service in a business process or services, such as EDI and CII services, where Gentran Integration Suite generates correlations EDIINT transactions
Notes:

Course 915: Gentran Integration Suite: Fundamentals

129

Lesson 6 Troubleshooting a Business Process

Gentran Integration Suite also enables you to search for business process instances by: Location of business process Business process ID Business process name To perform an advanced search for business process instances: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Advanced Search > Business Processes. 2. In the Business Process Monitor Advanced Search page, specify any combination of the following search criteria, as appropriate:
Field Search Location Select the area to search from Instances maintained in a specific location. Select one of the following options: Description Action

Live Tables Display live (active) instances. Archive Tables Display data for instances that you have archived in Gentran Integration Suite. Restored Tables Display data for instances that you have restored from an offline location.

Search Using Business Process ID Process ID ID assigned by Gentran Integration Suite to identify an instance. Type the ID for an instance.

Search Using Business Process Name Business Processes System Business Processes List of instances currently maintained in Gentran Integration Suite. Gentran Integration Suite system business processes (that is, business processes that complete or have completed system operations). Select an instance from the list.

Select a system business process from the list.

Notes:

130

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Field State

Description Current or final state of an instance.

Action The default value is ALL (displays all instances). Maintain the default value or select one of the following options:


Status Current or final status of an instance.

Completed Waiting Active Halted Halting Interrupted Terminated

The default value is ALL (displays all instances). Maintain the default value or select one of the following options:


Start date/time range Instances running or completed within the specified start dates and times.

Success Error

Type a starting date and time range and select A.M. or P.M.

3. Click Go! The Monitor page opens, listing the business process instances that match your search criteria. Other available Advanced Search options include the following:
Advanced Search Option BPSS Correlation Correlation Documents (Document Activity search) EDI Correlation EDIINT Search by: Location, Transaction Type, Trading Partner, Status, or Date/Time Type, Location, and Name/Value pairs Location, Sender, Receiver, Type, Status, Tracking ID, Correlations, or Document ID Location, Test Mode, Interchange, Group, or Transaction level specifics Contracts, Status, Type, or dates

Notes:

Course 915: Gentran Integration Suite: Fundamentals

131

Lesson 6 Troubleshooting a Business Process

Searching for Current Service Activities


This page enables you to search for service activity by service type, service name, activity type, Not Updated Since date, or Started Before date. To perform a search of service activity: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Current Activities. 2. In the Not Updated Since: dialog box, enter yesterdays date in the form MM/DD/YYYY and enter the time 01:00 (HH:MM) Click Go! 3. In the Service Activity Search Results page, view the list of the business process instances that match your search criteria.

Notes:

132

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Restarting or Resuming a Business Process


The Restart Business Process page opens after you select Resume or Restart in the Action field from the Business Process Detail page. This page has three options that enable you to determine how to run a business process again if it should stop running: Resume, Simple Restart, and Advanced Restart.
Note: Resume only appears if the instance stopped in mid-execution.

The Troubleshooter page enables you to start running multiple business processes at the same time.

Resume
The Resume function restarts a business process from the last error step. The business process retains its original ID. Use this function when the error is related to services. For example, if a service is disabled unexpectedly, a business process using that service stops at that point. After the service is restored and active, you can resume the business process.

Simple Restart
The Simple Restart function starts a new instance of a business process from the beginning. The new business process receives a new ID. Use this function when the error is related to an unplanned interruption of the business process. For example, if you have interrupted a business process while bringing down a server for nonroutine maintenance, you can restart the business process after the server is restored by using the Simple Restart function. This ensures a complete execution of the transaction.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

133

Lesson 6 Troubleshooting a Business Process

Exercise: Resuming a Business Process or Performing a Simple Restart

To resume a business process or to perform a simple restart: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Current Processes. 2. In the Monitor page, click the number identifying the instance in the ID column. 3. In the Business Process Detail page, select Restart in the Activities field then click Go! The Restart Business Process screen will be displayed. 4. Click Go! for the Simple Restart.

To resume the business process from the point at which it stopped, in the Resume
area, click Go! The instance retains its original business process instance ID.

To restart the business process from the beginning, in the Simple Restart area,
click Go! The new business process receives a new instance ID. A new page opens for the selected activity. If the business process runs to completion, you are finished. If the resumed or restarted business process fails, you must find and correct those errors before the business process can run to completion.

Notes:

134

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Advanced Restart
The Advanced Restart function runs the original document using a different version of the business process or another business process. The new instance receives a new ID. Use this function when the error is related to the business process BPML code. For example, if a business process has incorrectly routed a document through sequential services, you can modify the business process and enable a new version to correct the error. You then use the new version of the business process to run the original document.

Exercise: Performing an Advanced Restart

To perform an advanced restart: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Current Processes. 2. In the Monitor page, click the number identifying the instance in the ID column. 3. In the Business Process Detail page, select Restart in the Action field list, and click Go! 4. In the Advanced Restart area, select the business process you want to use for this instance. 5. In the Advanced restart area, click Go! The business process restarts in a new window, using the selected business process. The new business process receives a new instance ID. 6. View any system information or reports provided as the business process runs. If the business process runs to completion, you are finished. If the restarted business process fails, use the reports and system information to identify the problem.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

135

Lesson 6 Troubleshooting a Business Process

Viewing Execution Information


When you restart or resume a business process, Gentran Integration Suite opens the Execute Business Process page. This page lists the service, status, advanced status, start and end times, troubleshooting reports, and documents for each step completed within a recently run business process.
Note: The information icon ( i ) indicates that a troubleshooting report or document is available.

Terminating Business Processes


If a business process stops running, you can also use the System Troubleshooter page to review the business process and terminate it when you see a status of waiting, interrupted, or halted. The System Troubleshooter page enables you to terminate processing for multiple business processes.

Notes:

136

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Notes:

Course 915: Gentran Integration Suite: Fundamentals

137

Lesson 6 Troubleshooting a Business Process

Exercise: Terminating a Halted Business Process via Operations, System, Troubleshooter

In this exercise, we will run the BasicInventory business process without an input file which will create a Halted business process and terminate that process via the Operations > System > Troubleshooter screen. 1. From the Business Process Manager screen. 2. Type BasicInventoryProcess in the Search text box and click Go! 3. Click the Execution Manager icon for BasicInventoryProcess. 4. Click the execute icon. 5. DO NOT specify an input filename and Click Go! 6. Observe the separate Execute Business Process window while the business process runs. 7. Close the Execute Business Process window when the Business Process has completed running. 8. From Operations > System > Troubleshooter, click on the Business Process Usage link. 9. Link on the link that is to the right of the Halted status.
Note: Gentran Integration Suite only allows for a specified number of non-indexed business processes. If the specified number has been reached, Gentan Integration Suite will halt. The setting can be found in C:\SterlingCommerce\SI\properties, in the ui.properties file. Default setting example: #Maximum number of non-index Business Process in the system to display results MaxNonIndexBPs=5000

10. Select or check the box next to BasicInventoryProcess. 11. From the Activities drop-down list, select Terminate and click Go! 12. Click OK to confirm that you want to terminate the business process. 13. The GIS system will return a message, Request to terminate the business process

has been successfully submitted.


14. Close the Terminating Business Processes Report and the Business Process Usage windows.
Notes:

138

Course 915: Gentran Integration Suite: Fundamentals

Lesson 6 Troubleshooting a Business Process

Optional Exercise: Terminating a Halted Business Process via Business Process Monitor, Current Processes

In this exercise, we will run the BasicInventory business process without an input file which will create a Halted business process and terminate that process via the Business Process Monitor > Current Processes screen. 1. From the Business Process Manager screen. 2. Type BasicInventoryProcess in the Search text box and click Go! 3. Click the Execution Manager icon for BasicInventoryProcess. 4. Click the execute icon. 5. DO NOT specify an input filename and Click Go! 6. Observe the separate Execute Business Process window while the business process runs. 7. Close the Execute Business Process window when the Business Process has completed running. 8. From Business Process Monitor > Current Processes 9. Locate the Halted BasicInventoryProcess bp and click on the business process ID link. 10. From the Business Process Detail screen, select Terminate from the Action drop-down list and Click Go! 11. Click OK to confirm that you want to terminate the business process. 12. The GIS system will return a message, Request to terminate the business process

has been successfully submitted.


13. Click Return to return to the Business Process Monitor page. Notice that the state of BasicInventoryProcess is now Terminated.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

139

Lesson 6 Troubleshooting a Business Process

Lesson Review
Completed Objective
You should now be able to: Check the status of a business process Search a business process View business process details Restart and resume a business process View execution information Terminating a business process

Congratulations! You have completed Lesson 6: Troubleshooting a Business Process.

Notes:

140

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7

Introduction to Service Management

This lesson provides an overview of service management parameters.

Introduction
Lesson Objectives
By the end of this lesson, you should be able to: List and explain the four basic service types Explain how to create a service configuration Explain Bootstrapping Describe how the File System adapter works Describe how OnFault Processing works Explain how the Command Line adapter functions Describe and demonstrate the use of a Lightweight JDBC adapter Describe how the Invoke Business Process service works

Course 915: Gentran Integration Suite: Fundamentals

141

Lesson 7 Introduction to Service Management

Difference Between Services and Adapters


Services (Reach Inside Gentran Integration Suite)
GIS views every activity in a business process as a service. A service can initiate:

Legacy programs ERP systems Perl scripts Java code Decision engines Any computer program
A service in a business process can also invoke another business process, making that business process a sub process. Services which communicate with external systems are called adapters. Input Services and Output Services are adapters.

Lets say a business process involves determining how many open orders a specific customer might have. The activities might include:

Looking up the customer number Retrieving all orders for that number from an orders database Removing all but pending orders from that table Reporting the information in printed form
Each of these activities may be considered a service.

Notes:

142

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Adapters (Reach Outside Gentran Integration Suite)


Adapters may appear at any point of a business process and are often used to initiate business processes. For example, a File System Adapter could poll a directory to detect any new files (purchase orders) and initiate a business process that processes the input. If the adapter is set up to perform only one particular task, its usage is limited. When we look at setting up adapters for use, we will create instances of adapters to define their properties.

Architectural Review
Gentran Integration Suite views every activity in a business process as a service. What is a service in this context? Gentran Integration Suite puts no limitation on what defines a service. However, the high-level purpose of a service is to achieve some pre-defined type of integration activity, such as:

Communicating with external applications or middleware (by way of special


services called adapters)

Performing data manipulations, such as translation, transformation, splitting, and


joining

Routing data based on payload, content, or meta data

Notes:

Course 915: Gentran Integration Suite: Fundamentals

143

Lesson 7 Introduction to Service Management

Service Types
There are four basic service types in Gentran Integration Suite:

Internal Services that are totally inside Gentran Integration Suite. While internal
services accept parameters and produce results, they do not directly interact with outside systems.

Input Services that receive data from outside systems. Output Services that send data to outside systems. Human Interaction Services that enable human interaction with business
processes. Human interaction services allow a human being using a Web browser to take an action on a business process through Web Extensions mechanism as it is being run in Gentran Integration Suite. Input and output services are collectively known as adapters. Adapters interact with the world outside of the Gentran Integration Suite J2EE environment. The B2B Services Option (see B2B Services Training module for more information) is a pre-packaged set of adapters designed specifically to interact with B2B trading partners. Adapters may appear in the middle of business process definitions or at the end. For a complex application adapter, for example the SOAP adapter, calls to the adapter are actually calls to an underlying Gentran Integration Suite-defined SOAP business process. As you can see, services themselves can be implemented as business processes.

Notes:

144

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

File System Adapter


The file system adapter is functionally the simplest of all the Gentran Integration Suite adapters. It collects files from a disk and can initiate business processes. It also extracts files from Gentran Integration Suite back to a disk. It can retrieve and send any type of file, but it does not actually read the file.

How the File System Adapter Works


You can set a file system adapter instance to collect, extract, or both. For this reason, collection and extraction codes are in the same class, regardless of how they are configured. Normally, you should use only the extraction side of the File System adapter in a business process. Collection You can schedule the file system adapter in the Gentran Integration Suite scheduler. When it reaches the appropriate time to run, the scheduler tells the service controller to begin collection for the given adapter instance. The service controller finds the adapter in the cluster to pass the request. The adapter handles collection requests in a parallel, asynchronous manner. When the service controller calls the adapter with the instance identifier, the file system adapter creates a new thread and checks the list of instances to see if the instance is enabled for collection.

If disabled, an audit entry is made and nothing further is done. If enabled, it starts a business process.
Extraction The activity engine calls the extraction portion of the file system adapter when the file system adapter is placed in a business process. When called, the adapter handles extraction requests in a parallel, asynchronous manner. When the adapter is called in a workflow context, it: 1. Creates a thread. 2. Checks to see if the instance is enabled for extraction.

If disabled, it creates an audit entry and nothing further is done. If enabled, it:
Notes:

Course 915: Gentran Integration Suite: Fundamentals

145

Lesson 7 Introduction to Service Management

Queries the service controller for the properties defined in the activity information portion of the workflow. Extracts the data to the specified folder. The file created is given the specified name. Tries to shut down the RMI server.

Configuring the File System Adapter


After you install the adapter, you need to create an instance configuration in Gentran Integration Suite before you can use the adapter. To Configure the File System Adapter 1. From the Gentran Integration Suite interface, select Deployment > Services > Configuration. 2. On the Services Configuration screen, find the Create section. Click Go! for New Service. 3. On the Select Service Type screen, click the List view icon .

4. Scroll through the list and select File System Adapter as the type of service you want to configure and click Save. 5. Click Next to proceed. 6. Provide a unique and meaningful name to the service configuration. 7. Provide a meaningful description for reference value. 8. Select None in the Select a group area. 9. Click Next to proceed. 10. For collection, it is safer to enter the folder or subfolder on the SAME computer as the installation of Gentran Integration Suite. However, the folders or subfolders can exist on a different machine as long as the Gentran Integration Suite machine can access it, including all necessary permissions.
Caution: Do not specify a folder containing programs or any files you do not want to lose. The file system adapter does not copy the files it collects for processing.

If you wish to collect only files with a specific file extension within the specified folder, use the Filename filter field. You can also use this field to specify a single file to be

Notes:

146

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

collected (that is, MyFile.txt). Additionally, you can use the Filename filter field with wildcards to collect a subset of files with in a folder (that is, *.txt). a. Do you want to collect only from the folder or also from subfolders? Yes - collects files from the folder and all subfolders No - collects files only from the folder specified Yes - keep the absolute file path name of the files collected when assigning the document name No - default Yes - the business process will be specified on the next screen No - go to step 11

b. Do you want to use absolute filename for the document name?

c. Do you want this adapter to start a business process?

d. Click Next to proceed. 11. If you specified that the file system adapter collection should begin a business process, you must select the business process for it to initiate. a. Select the proper business process. b. Select the type of document storage you wish to use. System Default Database File System

12. Specify whether to obscure the file contents when collecting. Does not work with "attachFile" or "importFile". Yes - File contents will be obscured No - File contents will not be obscured

Note: This field only displays as an option if Start a business process once files are collected is set to Yes. Additionally, if you specify this parameter using the configuration, you cannot override this value using the GPM Obscure option. However, you can override this parameter using BPML.
Will the file contain Obscure File Contents? c. Specify a User Parameter 1: A user parameter that is passed to the

bootstrapped workflow and placed in process data as UserParm1.


d. Specify a User Parameter 2: A user parameter that is passed to the

bootstrapped workflow and placed in process data as UserParm2


Notes:

Course 915: Gentran Integration Suite: Fundamentals

147

Lesson 7 Introduction to Service Management

e. Specify a User Parameter 3: A user parameter that is passed to the

bootstrapped workflow and placed in process data as UserParm3


f. Specify a User Parameter 4: A user parameter that is passed to the

bootstrapped workflow and placed in process data as UserParm4


g. Specify a User Parameter 5: A user parameter that is passed to the

bootstrapped workflow and placed in process data as UserParm5 Note: These fields only display as an option if Start a business process once files are collected is set to Yes. Additionally, if you specify this parameter using the configuration, you cannot override this value using the GPM userParmX option. However, you can override this parameter using BPML.
h. Click Next to proceed. 13. This screen allows you to select who will run it and how it will be invoked. a. Choose a login ID for the Run As User: dialog box. b. Use 24 Hour Clock Display? - If selected, the adapter will use the 24-hour

clock instead of the default 12-hour clock.


c. Under Schedule: you can choose: Do not use schedule - This is for adapter instances that will be used in business processes Run based on timer - Schedule the adapter to collect data based on a specific time period and at startup. Run daily - Schedule the adapter to run at the same time every day Run based on day(s) of the week - Schedule the adapter to run on specific day (s) of the week. You can specify any date exclusions. Run based on day(s) of the month - Schedule the adapter to run on a specified day(s) of the month at a certain time.

d. Click Next. 14. For Extraction, enter the folder for the file system adapter to write files to as part of a business process. It is safer that it be on the SAME computer as the installation of Gentran Integration Suite. However, it can exist on a different machine as long as the Gentran Integration Suite machine can access it, including all necessary permissions. a. Assign a File name to be given to the extracted files. b. Specify whether to Unobscure the file contents when extracting. Does not

work with "exportFile".


Notes:

148

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Yes - File contents will be unobscured No - File contents will not be unobscured

Note: This parameter is read-only in the GPM. c. Select a file naming convention: Use the original file name as the extracted file name - keeps the names of the files. Go to step 12. Assign a specific name - Give the file the name specified on the following screen in step 11.

d. Click Next to proceed. 15. On the Confirm screen, make sure all the information entered is correct. If needed, use the Back button to return to previous screens to change information. Once all the entries are correct, click Finish.

In the Graphical Process Modeler


When the file system adapter is placed into a business process, you must select a configuration instance. Once that is selected, you must select an action - either Collection or Extraction.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

149

Lesson 7 Introduction to Service Management

Exercise: File System Adapter

Before you begin Add two new folders to your C drive called:

FSCOLL FSEXT
Create the Service Configuration 1. Log in to admin console. 2. On Admin console click Deployment > Services > Configuration. 3. Click Go! in the new service box. 4. Type File System Adapter in the Service Type: dialog box and click Next. 5. Use FS_Test for a name and Test file system adapter for a description. Do not create or select a group. Click Next. 6. Specify c:\FSCOLL for the collection folder. a. Leave the filename filter blank. b. Collect files from sub-folders within and including the collection folder: No c. Use the absolute file path name for the document name: No d. Start a business process once files are collected: No e. Click Next. 7. Specify c:\FSEXT for the extraction folder. a. Unobscure File Contents?: No b. File naming convention: Assign a specific name c. Click Next. 8. Enter %^output.txt for the output filename and click Next. 9. Ensure that the service is enabled for business processes and click Finish.

Notes:

150

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Create a Business Process 1. Open the GPM. If it is already open, click View > Refresh Services. 2. Click File > New. 3. Drag a Start, End, and two File System Adapter stencils into the work area, and connect them as shown below.

4. Open the Service editor for the first file system adapter and choose FS_Test for the

Notes:

Course 915: Gentran Integration Suite: Fundamentals

151

Lesson 7 Introduction to Service Management

7. From the Business Process Manager screen, search for your new business process, FS_Test. 8. Click on Execution Manager when you get the results screen. 9. Choose execute in the execution manager screen. There is no Input File. 10. Click Go! 11. Monitor the progress of the business process. Check c:\FSEXT for your output file.

Bootstrapping
As discussed before, business processes may be scheduled to run at a given date and time. However, the trigger for a business process may be the arrival of data from outside Gentran Integration Suite, such as a JMS queue. Bootstrapping is defined as the act of initiating a business process. If the GIS Scheduler bootstraps a business process, no outside activity is needed, although the business process may, and probably will, make use of external systems in the course of its operation. Some adapters may be configured to bootstrap a business process when they receive data. Here are some additional facts about bootstrapping: There may be a many-to-many relationship between bootstrapping adapters and business processes. That is, an adapter which bootstraps may initiate more than one business process. Many adapters may be configured to start the same business process. The business process bootstrapped may be selected dynamically. That is, the bootstrapping process may examine data, or use other criteria, to determine which business process to bootstrap. The bootstrapping adapter may be at the beginning of a business process or may occur in the middle of a business process. When creating a service to bootstrap, a system generated business process is built that uses the service by way of the Scheduler. The business process is normally called Schedule_<service_configuration_name>. Example Consider that a purchase order is being processed. 1. Someone needs to approve the purchase order. 2. The order is sent to the approver and the business process waits for the order to return.
Notes:

152

Course 915: Gentran Integration Suite: Fundamentals

C o m p le t h f w i n g a c
Lesson 7 Introduction to Service Management

3. The approver receives the order, approves or disapproves it, and sends it back to Gentran Integration Suite.

4. When it receives the order, Gentran Integration Suite is designed to be returned to the business process at the point where it was sent out so that it may continue on to the next step in the business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

Exercise: Modify the File System Adapter

153

Lesson 7 Introduction to Service Management

8. On the Schedule Settings screen, choose to run every 0 hours, 1 minute. a. Click Next. b. On the Extraction screen, type c:\FSEXT in the Extraction folder: box and select Assign a specific name from the Filenaming convention: radio buttons. Click Next. c. On the Extraction: User defined screen, type %^Myoutput.txt and click Next. 9. Review your selections on the Confirm screen and click Save and Finish. 10. Check your business process out of GIS and open it in the GPM. 11. Click View > Refresh Services to get an updated configuration for the FSA instance in the business process. 12. Remove the first File System Adapter: a. Open the business process b. Highlight the first File System Adapter c. Click Delete d. Link the other objects back together 13. Save the business process a. Select File > Save. b. Click Yes when asked to validate the process model upon saving. c. Select the folder location. d. In the FileName field, enter the business process name and select OK.
Note: If the process model is not valid the output window will appear at the bottom of the Graphical Process Modeler with a display of the error messages. Correct the errors and try saving the Business Process again.

14. Check the business process back into GIS a. Click Tools > Source Manager. b. Log on to the Source Manager. c. Click Process > Add. d. Type the business process name and click Next. e. Browse out and select your BP file using the Browse Button. f.
Notes:

Type a brief description. Click Next.

154

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

g. Set the Priority Level to 4, the Persistence Level to System Default, and the Recovery Level to Manual. Set the Document Storage to System Default. Click Next. h. Accept the System Defaults for Archive. Click Next. i. j. l. Check Validate. Check Enable Process. Click Finish.

k. Do not check Enable Document Tracking and Set onfault Processing. m. Click OK. 15. Return to the UI and re-enable the adapter configuration. 16. Navigate to Windows Explorer. If you do not have data in c:\FSCOLL, copy the file fsexer.txt from the lab files directory and paste it into c:\FSCOLL. 17. Allow one or two minutes for processing to run, then check the c:\FSEXT directory. You should have output. If you did steps 8a through 8c, you will see the date and time in place of the %^ as part of the file name.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

155

Lesson 7 Introduction to Service Management

OnFault Processing

The onFault element is used to handle errors. You can incluc72.18 8i42 4n4 1 T576.6 Tw[(fu2616.86 ref lf

Notes:

156

Course 915: Gentran Integration Suite: Fundamentals

n F

n h

o c

ce

l i

Lesson 7 Introduction to Service Management

SMTP Send Adapter


The SMTP Send adapter allows documents to be sent to any valid e-mail address using an accessible (SMTP-aware) mail server, usually the mail server of the trading partner that is running Gentran Integration Suite. It does this by enabling Gentran Integration Suite to mail (send) documents using SMTP, within Gentran Integration Suite, to the designated mail server. The back-end mail server system examines the document and does further processing, including the actual sending of the e-mail. This adapter can be used when messages and documents need to be sent during the execution of a business process.

How the SMTP Send Adapter Works


The SMTP Send adapter can mail (send) documents to the back-end mail server of trading partners. The document is then e-mailed to the recipient designated in the To field of the configuration. This adapter picks up the document sent from the primary document in the business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

157

Lesson 7 Introduction to Service Management

Exercise: Configuring an Outlook Express Email Account

To configure anOutlook Express Email Account: 1. Launch Outlook Express by clicking Start > Programs > Outlook Express. 2. In right hand panel under email, click on Set up Email Account. 3. Type your name for Display name and click Next. 4. Type in email address xx_Student@stercomm.com (where xx is your student number) and click Next. 5. Type in the IP address for the POP3 and SMTP server, 10.251.67.29 (scidaltrnmsg.sci.local), and click Next. 6. Type in Account name train\Studentxx and password Student0xx, then click Next. 7. Click Finish. 8. Click on Tools > Options > General > Make Default > Apply > Okay. 9. Test the email account by sending an email to yourself or your partner

Configuring the SMTP Send Adapter


1. On the Admin Consol, click Deployment > Services > Configuration. 2. Click "New Service Go!" 3. Type SMTP OnFault and click Next. 4. Enter the required information as shown below, and click Next. a. For Name, enter SMTP OnFault b. For Description, enter SMTP OnFault c. For Select a Group; click NONE 5. Select No for SMTP Authentication required and click Next. 6. Accept defaults on the remaining screens and click Next. 7. On the summary screen, click Finish. 8. Click Return and ensure that the service is enabled for business processes. 9. Click Return.
Notes:

158

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Configurable parms for SMTP Send Adapter


1. Click on the SMTP Send Adapter, select SMTP OnFault from the configuration drop-down menu. 2. Under value for xport-smtp-mailhost type; 10.251.67.29 (scidaltrnmsg.sci.local). 3. Under value for xport-smtp-mailto type; xx_Student@stercomm.com. (where xx is your student number)

Notes:

Course 915: Gentran Integration Suite: Fundamentals

159

Lesson 7 Introduction to Service Management

Exercise: OnFault Processing Using SMTP Send Adapter

The SMTP Send Adapter is designed to send a file as an email attachment. If an email notification of there being no files to collect was required, we would need to capture the Previous Not Success Advanced Status of No files to Collect that is issued from the SMTP adapter from process data and write into PrimaryDocument to give the SMTP Send Adapter the required input file. The DOMToDoc Xpath expression accomplishes this task.

Configuring Outlook Express Email Account:


1. Launch Outlook Express by clicking Start > Programs > Outlook Express 2. If display name does not pop up, In right hand panel under email, click on Set up Email Account. 3. Type your name for Display name and click Next. 4. Type in email address xx_Student@stercomm.com (where xx is your student number) and click Next 5. Type in IP address for POP3 and SMTP server, 10.251.67.29, then click Next 6. Type in Account name train\Studentxx and password Student0xx, then click Next 7. Click Finish 8. At the top of the screen, Click on Tools > Options > General, change Check for new Messages to every 1 minute, click Apply and click Okay. 9. Now, test the email account by sending an email to yourself. Click on Create a New Message, type in your address xx_Student@stercomm.com. Type Test in the subject and text box, Click Send. Wait a few minutes and check your Inbox. Log into Gentran Integration Suite

Configuring the SMTP Send Adapter


1. On the Admin console click Deployment > Services > Configuration. 2. In the Create "New Service, click Go! 3. Type SMTP SEND Adapter and click Save.

Notes:

160

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

4. Enter the required information as shown below, and click Next. a. For Name, enter SMTP OnFault b. For Description, enter SMTP OnFault c. For Select a Group; click NONE 5. Select No for SMTP Authentication required and click Next. 6. Accept defaults on the remaining screens and click Next. 7. On the summary screen click Finish. 8. Click Return and ensure that the service is enabled for business processes. Open the Graphical Process Modeler

Setting the OnFault Service


In order to use your updated configuration of the File System Adapter, inside the GPM click View > Refresh Services to get an updated configuration for the FSA instance in the business process. 1. Create a business process comprised of: (1) Start (1) End (1) Sequence Start (1) Sequence End (1) File System Adapter (1) OnFault Group (1) XML Validation Service 2. Arrange and connect the services as shown below.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

161

Lesson 7 Introduction to Service Management

3. Click the File System adapter and configure as follows: a. Select FS_Test from the Configuration drop-down menu b. Set the Action parm to Collection. 4. Click the XML Validation Service and select XML Validator_WellFormed from the Configuration drop-down menu. 5. Click the OnFault group a. Under the Error Value parm type No files to collect. b. Rename Default to First Fault. c. Select add to create a second fault. Under the name type Second Fault d. Under error value leave blank (this will be an error catch-all.) 6. In the Navigation pane, locate and click the First Fault. a. Between the OnFault Start and OnFault End, add (1) Assign (1) SMTP Send Adapter (1) Sequence Start/End 7. Arrange and connect the services as shown below.

a. Click on the Assign, under value for append type false. b. Under value for from type: DOMToDoc(Prev_NotSuccess_Adv_Status,PrimaryDocument) c. Under value for to type . (no quotes). Note: The SMTP Send Adapter is designed to send a file. Since there is no input file to send we must capture the Previous Not Success Advanced Status of No files to Collect from process data and write into PrimaryDocument to give the SMTP Send Adapter the required input file. Steps b and c above accomplish this task. d. Click on the SMTP Send Adapter, select SMTP OnFault from the configuration drop-down menu. e. Under value for xport-smtp-mailhost type 10.251.67.29

Notes:

162

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

f.

Under value for xport-smtp-mailto type xx_Student@stercomm.com (where xx is your student number)

8. In the Navigation pane, locate and click the Second Fault. a. Between the OnFault Start and OnFault End, add an SMTP Send Adapter. b. For the SMTP Send Adapter, select SMTP OnFault from the configuration drop-down menu. c. Under value for xport-smtp-mailhost type 10.251.67.29 d. Under value for xport-smtp-mailto type xx_Student@stercomm.com (where xx is your student number) 9. Save and Validate this BP (name the BP OnFault_test2). This Business Process will demonstrate how Gentran Integration Suite handles different errors.

Check in and test the business process


1. Open the Admin console and choose Business Process > Manager. 2. Click Go! next to Create Process Definition. 3. Enter OnfaultSMTP_test for the Process Name. a. Make sure that the radio button titled Check in Business Process created by the graphical modeling tool is selected. b. Click Next. 4. Click Browse and navigate to your saved business process. Select it and click Open. 5. Type Checkin1 for the description and click Next. 6. Use the default settings for the remaining parameters. Make sure the Business Process is enabled and click Finish.

Testing the business process


Run the business process three different times: 1. Receive No Email a. Copy the file inventoryof3. xml from c:\915Fundamental\Class Labfiles and paste into the collect folder (c:\FSCOLL). b. Execute the business process manually. From the Business Process Manager screen, search for your new business process, onfault_test. Click on Execution Manager and run the BP with No Input file, Click OK to execute.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

163

Lesson 7 Introduction to Service Management

The business process shouldcomplete with no errors and No Email sent. 2. Receive Email from Second Fault a. Copy the file file1.txt into the collection folder (c:\FSCOLL). b. Execute the business process using the same steps as above. c. You should receive an email containing ProcessData, check your Inbox. 3. Receive Email from First Fault a. Execute the business process with no input file, using the same steps as above. b. You should receive an email containing the message No files to collect, check your Inbox.

Notes:

164

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Command Line Adapter


The command line adapter enables Gentran Integration Suite to run a program from a command line. To use this adapter, you have to specify the command to run, such as an executable program, script, or operating system command external to Sterling Integrator or Gentran Integration Suite in the business process.
Caution: Use the Command Line adapter only for noninteractive programs that run from the command line. This adapter is not intended to work with browser-based or other Graphical UI-based programs. Such programs introduce an interactive element into a business process, which is typically set up to be automated.

Use the Command Line adapter to run programs that will, as part of a business process:

Encrypt and decrypt data you want to send or receive securely over the Internet Manipulate data, such as change every occurrence of one letter to another Page someone Initiate a business process Initiate a remote system
These are examples; you can include any program that can be run from a command line in your business process using the Command Line adapter.

How the Command Line Adapter Works


The following steps summarize how the Command Line adapter might be used in a business process. 1. Gentran Integration Suite processes a file and passes it to the Command Line adapter at run time. 2. The adapter writes the file to disk. 3. Gentran Integration Suite runs the customized executable program to pick up the file and send it to the legacy system. 4. The legacy system returns the file, which now includes the customer billing information, and the adapter retrieves it. 5. The adapter puts the file into the Gentran Integration Suite business process, which sends it to your accounting department.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

165

Lesson 7 Introduction to Service Management

6. Gentran Integration Suite performs the next operation in the business process. For example, your company communicates with a legacy database that is important to its daily business. You want to retrieve some customer billing information in the database and send it to your Accounting department within a business process in Sterling Integrator or Gentran Integration Suite. You can write your own executable program to communicate with your legacy system, and run it using the Command Line adapter.

Implementing the Command Line Adapter


To implement the Command Line adapter, complete the following tasks: 1. Activate a license for the Command Line adapter according to the instructions provided with your CD. In order to activate your license file, you need the following information:

CD key, located on the jewel case containing your product CD System administrator contact information, including first and last name, e-mail
address, telephone number, and fax number

IP address for the host server


2. Create a Command Line adapter configuration. 3. Create and enable a business process that includes the Command Line adapter. 4. Test the business process and the adapter. 5. Run the business process.

Creating a Command Line Adapter Configuration


After the adapter is installed, an instance configuration needs to be created in Gentran Integration Suite before it can be used. The following steps describe the process of creating an instance configuration of the Command Line Adapter. 1. From the Gentran Integration Suite interface, select Deployment > Services > Configuration. 2. Click Go! next to Create New Service in the Services Configuration screen. 3. Type in Command Line Adapter for the Service Type and click Next. 4. Provide a unique and meaningful name and description. Click Next. Do not select a group.

Notes:

166

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

5. Complete the requested information on the Properties page: a. At the URL RMI: prompt, enter the URL of the remote object registry in the form //host:port/name. b. At the Command Line: prompt, type the command line program in as you would type it from the command line.

If you want to use a command that redirects input or output (using >, <, or |), you
must do so with a script file. If executing a script, a full path to the script is required in addition to the working directory.
Note: The working directory must be the location of the script.

If you do not know the input or output file names, use the following parameters as
placeholders. You can use these parameters on the command line in any order and multiple times. At run time, they are replaced with the actual file names. $Input $Output

c. At the Working Directory: prompt specify the working directory to use during execution. d. Select Yes to log debug messages for this adapter instance. e. Specify whether the adapter should wait for the process to complete or not. f. Specify whether the adapter should bootstrap a workflow once the process completes.

6. Click Next. 7. Does the command line process require an input file? Select Yes or No and click Next. 8. Use the output generated by the command line process? Select Yes or No and click Next. 9. Check your selections on the Confirm page and click Finish.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

167

Lesson 7 Introduction to Service Management

In the Graphical Process Modeler


The BPML created by adding this adapter into a business process in the Graphical Process Modeler will appear like this:
<process name = "CmdLine"> <operation name="Command Line Adapter"> <participant name="CMD1"/> <output message="CmdLineInputMessage"> <assign to="." from="*"></assign> </output> <input message="inmsg"> <assign to="." from="*"></assign> </input> </operation> </process>

Notes:

168

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Exercise: Command Line Adapter

Create the Service Configuration 1. Copy the files copy.bat and file1.txt from the labfiles folder to the root drive of your machine. 2. Log in to admin console. 3. On Admin console click Deployment > Services > Configuration. 4. Click New Service Go! 5. Type in Command Line Adapter and click Next. 6. Enter the required information as shown below, and click Next. a. For Name, enter CL_Test b. For Description, enter Command Line Test c. For Select a group:, click None. 7. Enter C:\copy.bat for the command and C:\ for the working directory. a. Leave RMI URI blank. b. Select No for Turn on debugging messages. c. Wait on process to continue? Click Yes. d. This service does NOT invoke a business process. Click Next. 8. The command line process does NOT require an input file. Click Next. 9. Do NOT use the output generated by the command line process. Click Next. 10. Ensure that the service is enabled for business processes and click Finish. Create a Business Process 1. Open the GPM. If it is already open, click View > Refresh Services. 2. Click File > New.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

169

Lesson 7 Introduction to Service Management

3. Drag a Start, End, and Command Line Adapter into the workspace and connect them as shown.

4. Double click on the Command Line Adapter to bring up its properties editor. 5. From the config drop-down box, choose CL_Test. 6. Save and validate your business process. Name it CL_Test. Check in and Test the Business Process 1. Open the admin console and choose Business Process > Manager. 2. Click Go! next to Create Process Definition. 3. Name the process CL_Test. a. Make sure that the radio button entitled Check-in Business Process created by the graphical modeling tool is selected. b. Click Next. 4. Click Browse and navigate to your saved business process. Select it and click Open. 5. Give it a fitting description and click Next. 6. Use the default settings for the remaining parameters. Make sure the business process is enabled when you click Finish. 7. From the Business Process Manager screen, search for your new business process. 8. Click on Execution Manager when you get the results screen. 9. Choose execute in the execution manager screen. There is no input file. 10. Click Go! 11. Monitor the progress of the business process. Check c:\ on your machine for file2.txt.

Notes:

170

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Command Line2 Adapter


The Command Line2 adapter is a second generation adapter that enables Gentran Integration Suite to run a program from a command line in a business process. This includes executable programs, scripts, or operating system (OS) commands external to Gentran Integration Suite. The Command Line2 adapter operates in a remote implementation only. This does not necessarily mean that it has to run remotely. It runs in a separate JVM (Java Virtual Machine), which may be on the machine where Gentran Integration Suite is installed or on a remote machine. The Command Line2 adapter supports large files up to 12 GB and provides better memory allocation than the Command Line adapter. The Command Line2 adapter will eventually replace the Command Line adapter. You could use the Command Line2 adapter to invoke a program that: Encrypts and decrypts data you want to send or receive securely over the Internet Manipulates data, such as change every occurrence of one letter to another Pages someone Initiates a business process Initiates a remote system These are just a few examples out of many possible uses.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

171

Lesson 7 Introduction to Service Management

How the Command Line2 Adapter Works


The following steps summarize how the Command Line2 adapter is typically used in a business process: 1. The adapter writes the content of the current primary document to a file in the working directory specified as the value of the working directory parameter. The name of this file is specified by the value of the inputFile parameter. 2. Gentran Integration Suite runs an executable program that picks up the file and sends it to the legacy system. 3. The legacy system returns a file, which now includes the customer billing information, and the adapter retrieves it. The file returned is specified by the value of the outputName parameter. 4. The adapter reads the file contents into the primary document. 5. Gentran Integration Suite performs the next operation in the business process.

Implementing the Command Line2 Adapter


You can implement a Command Line2 adapter to do the following: Execute commands using the command line from within a business process. Invoke the Command Line2 adapter on a schedule and then start a new business process using the output from the adapter.
Note: This could be used if you wanted to schedule a command line program that accessed a legacy database on a regular schedule and then used the output in a business process.

Before You Begin


Before you begin to implement the Command Line2 adapter, complete the following tasks: 1. Create and test the command line program or command to make sure that it works. 2. Determine the working directory where you will be processing your commands.

Notes:

172

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Process Overview
To implement the Command Line2 adapter, complete the following tasks: 1. Create a Command Line2 adapter configuration. 2. Configure the Command Line2 adapter. 3. Create and enable a business process that includes the Command Line2 adapter.
Note: If you are configuring a Command Line2 adapter to start a business process, create the business process before configuring the adapter.

4. Test the business process and the adapter. 5. Run the business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

173

Lesson 7 Introduction to Service Management

Lightweight JDBC Adapter


The Lightweight Java Database Connectivity (JDBC) adapter enables you to retrieve data from a JDBC-compliant database or update a JDBC-compliant database as part of a business process within Gentran Integration Suite, using one of the following methods: XPath queries for dynamic SQL queries (where the definition of the SQL statement is not known when the business process is defined) Constants, when lookups are not necessary

How is the Lightweight JDBC Adapter Different?


Unlike the JDBC adapter, the Lightweight JDBC adapter does not use a map, where the SQL statements are fixed. The Lightweight JDBC adapter enables you to specify parameters in the SQL statement that are supplied at run time. The Lightweight JDBC adapter executes a query, and you receive an XML document that contains the results. Then you can either: Load the XML document into process data. Carry the XML document forward into another service in the business process. Use the Lightweight JDBC adapter if you simply want to get data, and need the flexibility of specifying various SQL queries. Use the JDBC adapter if you plan to always execute the same SQL statement, or if you have complex output and you want to manipulate the data from a database and control the structure of the output.
Note: The Lightweight JDBC adapter processes only one result set if you script multiple queries to run in stored procedures.

How the Lightweight JDBC Adapter Works


The Lightweight JDBC adapter can start a business process, or it can be used in the middle or at the end of a business process. This service can be scheduled to run at weekly or timed intervals. The following steps summarize how the Lightweight JDBC adapter might be used in a business process: 1. Using the parameters specified in the Graphical Process Modeler for the Lightweight JDBC adapter configuration, the adapter executes a query.
Notes:

174

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

2. The adapter receives the query results from an SQL database query. 3. The adapter generates a primary document that contains the query results in XML format. 4. The adapter sends the query results to the next step in the business process.

Setting Up the Lightweight JDBC Adapter


To use the Lightweight JDBC adapter, you must complete this process: 1. Set up a connection to an external database. 2. Activate the license file for the Lightweight JDBC adapter from the Self-Service Licensing Web site at www.productupdates.stercomm.com. 3. Create and enable a Lightweight JDBC adapter configuration. 4. Create a business process using the Lightweight JDBC adapter, and enable it.
Note: If you want to use XPath queries, you will first need to load the data these queries will reference into the process data using the XML Encoder service. You will need to add the XML Encoder service to your business process.

5. Double-click the Lightweight JDBC adapter icon in the Graphical Process Modeler, and in the Service Editor, specify the parameters or queries the adapter configuration will use. 6. Test the business process and the adapter.

Creating a Lightweight JDBC Adapter Configuration


To create a Lightweight JDBC adapter configuration: 1. From the Gentran Integration Suite Deployment menu, select Services > Configuration. 2. Under Create, next to New Service, click Go! 3. Type Lightweight JDBC Adapter in the Service Type dialog box and click Next. 4. Complete the fields specific to the adapter and click Finish. 5. Specify additional parameters using the Service Editor in the Graphical Process Modeler.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

175

Lesson 7 Introduction to Service Management

Gentran Integration Suite Configuration


The following table describes the fields used to configure the Lightweight JDBC adapter in Gentran Integration Suite:
Note: The field names in parentheses represent the corresponding field names in the Graphical Process Modeler. This information is provided for your reference.

Field Name Description Start a new business process (StartNewWorkFlow)

Description Unique and meaningful name for adapter configuration. Required. Meaningful description for the adapter configuration, for reference purposes. Required. Whether to start a new business process. Valid values are:


Run As User Do not use schedule Run service based on timer every

This Lightweight JDBC adapter configuration will start a new business process. This Lightweight JDBC adapter configuration will not start a new business process.

Specify the user that this schedule runs under. Click the icon next to the field for a list of users from which to select. If the field is selected, this service does not start a business process and does not run on a schedule. Valid values are the hour and minutes at which to run the service. Indicate whether you want the service to run at startup. Valid values are the hour and minutes at which to run the service, daily. Indicate whether you want the service to run at startup. Valid values are the day of the week, the hour, and the minutes at which to run the service. Indicate whether you want the service to run at startup. Select the business process that will be started by this service. Specify the database pool name. Optional.

Run service daily at

Run service weekly on

Business Process Pool Name

Notes:

176

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Field XML Result Root Tag (result_name) XML Result Row Tag (row_name)

Description Root tag element. The name of the tags in the XML document for query results that will be attached to the process data by the adapter. Required. Row tag element containing all the column tags. The column tag names are not configurable. The tag names are generated by the column name returned in the result set. Required. Result set or the number of rows affected by an action query returned by the SQL statement. Valid values are SELECT and ACTION. Required.

Query Type (query_type)


SQL Statement (sql) Business process (InitialWorkFlowId)

SELECT Returns results. The rows affected by the query, if available, are returned into the row tag itself, for example, <root><row>5</row></root>. ACTION Returns the number of rows affected. For example, if you are updating records in a database, the number of rows updated is returned. Stored procedure/function Required if value in paramtype1 field is Cursor.

Hard-coded SQL query that will query a database. It must be in valid SQL syntax. Optional. Business process you want the Lightweight JDBC adapter to start, if any. Required if you selected This Lightweight JDBC adapter configuration will start a new business process. Otherwise, optional.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

177

Lesson 7 Introduction to Service Management

Graphical Process Modeler Configuration


The following table describes the fields used to configure the Lightweight JDBC adapter in the Graphical Process Modeler:
Field Config param1 - param20 Description Name of the service configuration. XPath query that searches the process data tree for a match. If defined as XPath, you must also select the XPath check box in the Service Editor of the Graphical Process Modeler for the parameter. Optional. Parameter type that corresponds to the parameters number, for example, param1 and paramtype1. Every parameter specified must have a corresponding parameter type.Valid values are:

paramtype1 - paramtype20

Character Stream Cursor Date Double Float Integer Long String

Note: Cursor runs stored Oracle functions. If specified, this must be paramtype1. If you want to pass any other parameters to the Oracle stored function, those must start in the paramtype2 field.

Notes:

178

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Restrictions on submitting Oracle stored functions


The following restrictions and guidelines apply when submitting Oracle stored functions to a database using the JDBC adapter: If the stored procedure is a procedure and not a function, the first argument to the procedure must be an output parameter. Even if the procedure has no data to return, it must declare the first argument as an output Cursor. The output argument must be in the first position. The first parameter type must be Cursor type. You must provide a value for the first parameter, even though it is not used. The Query type must be declared as Stored Procedure/Function type. The SQL query must be defined as an anonymous block with a begin and end statement. When defining the Integer data type using the Graphical Process Modeler (GPM), selecting Integer will produce Double in the BPML. If you need an Integer type, edit the BPML through the Gentran Integration Suite interface and replace Double with Integer.
Note: If you edit the file at a later time using the GPM, this edit overwrites your earlier changes and sets the value back to Double.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

179

Lesson 7 Introduction to Service Management

Exercise: Lightweight JDBC Adapter

Create the Service configuration 1. Right click Start, then Run 2. Type cmd and click OK 3. At the command line, change directories to c:\sterlingcommerce\si\mysql\bin 4. Type the following command: mysql.exe -u si --password=woodstock --port=9003
Note: The port listed in this exercise is valid if you install GIS on listen port 9000. To locate the port listed in the command, go to the sandbox.cfg file located in the properties directory of your GIS install.

5. Press Enter 6. At the prompt, type use Woodstock and press Enter 7. Type create table UOFM(CUST_NUM char(100), INPUT_VALUE char(100), OUTPUT_VALUE char(100)); 8. Check that your table was successfully created by typing describe UOFM; 9. Add values to the table by typing insert into UOFM set CUST_NUM=MORTEL, INPUT_VALUE=EA, OUTPUT_VALUE=EACH; 10. Verify that your values are correct by typing select * from UOFM; 11. Log in to admin console. 12. On admin console, click Deployment > Services > Configuration. 13. Under New Service, click Go! 14. Click Lightweight JDBC Adapter, and click Next. 15. Use LWJDBC_Test for a name, and LWJDBC adapter for a description, and click Next. 16. Accept the defaults and make sure Will not start a new Business Process is selected. Click Next.
Notes:

180

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

17. Specify the following values in the Parameters screen:

Pool Name: mysqlPool XML Result Root Tag: Document XML Result Row Tag: Query Query Type: (Leave blank) SQL Statement: (Leave blank)

Note: Can also be called from the GPM.

18. Click Next. 19. Ensure that the service is enabled for business processes and click Finish. Create a business process 1. Open the GPM. If it is already open, click View > Refresh Services. 2. Select File > New. 3. Drag a Start, End, XML Encoder and Lightweight JDBC Adapter stencil into the work area, and connect them as shown.

4. Open the properties editor for the XML encoder, and choose XMLEncoder for the configuration. Enter the information below for the following properties:

Mode: Use existing XML document Output to Process Data: Yes


5. Open the properties editor for the lightweight JDBC adapter, and choose LWJDBC_Test for the configuration. Enter the following information for the properties:

Param1:
/ProcessData/root/header/customer/custnum/text()

Param2:
/ProcessData/root/detail/item/uom/text() Note: Check the box in the column titled Use XPath for Param1 and Param2 only.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

181

Lesson 7 Introduction to Service Management

Paramtype1: String Paramtype2: String Query_type: Select Sql: Type the following:
select OUTPUT_VALUE from UOFM where CUST_NUM=? and INPUT_VALUE=?

6. Click File > Save As, and save the business process as testLTWTJDBCAdapter. If you are asked to validate on save, please do so. Check in and test the business process 1. Open the admin console and choose Business Process > Manager. 2. Click Go! next to Create Process Definition. 3. Enter LTWT_JDBC_Test for the Process Name. a. Make sure that the radio button entitled Check-in Business Process created by the graphical modeling tool is selected. b. Click Next. 4. Click the Browse button and navigate to your saved business process. Select it and click Open. 5. Use Lightweight for a description. Click Next. 6. Use the default settings for the remaining parameters. Make sure the Business Process is enabled when you click Finish. 7. From the Business Process Manager screen, search for your new business process. 8. Click on Execution Manager when you get the results screen. 9. Choose execute in the execution manager screen. 10. In the filename dialog box, browse to the following: C:\915 Fundamentals\Class Labfiles\ltwtjdbc.xml 11. Click Go! 12. Monitor the progress of the business process. 13. Check your results (click output a tag with EACH. ) in the document column. You should see in your

Notes:

182

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

The Invoke Business Process Service


The Invoke Business Process Service is used to start an instance of a subprocess (child) from within the current instance of the business process (parent).

How the Invoke Business Process Service Works


The Invoke Business Process Service, when used, instantiates an instance of a subprocess, passing the current workflow context and the primary document to the new instance. When the Invoke Business Process Service is set to synchronous mode, the parent suspends processing until it receives data from the child. In synchronous mode, the parent is notified when the child encounters errors. When the Invoke Business Process Service is set to asynchronous mode, the parent and child process data simultaneously and independently of each other. Therefore, the parent does not receive notification when the child encounters errors.

Implementing the Invoke Business Process Service


To implement the Invoke Business Process Service, complete the following tasks: 1. Create an Invoke Business Process Service configuration. 2. Create and enable a business process that includes the Invoke Business Process Service. 3. Test the business process and the service. 4. Run the business process.

Creating an Invoke Business Process Service Configuration


To create an Invoke Business Process Service configuration: 1. From the Gentran Integration Suite Deployment menu, select Services > Configuration. The Services Configuration page opens. 2. Under Create, next to New Service, click Go! 3. Select Invoke Business Process Service and click Next. 4. Complete the fields specific to the service and click Finish.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

183

Lesson 7 Introduction to Service Management

5. Specify any additional parameters using the Service Editor in the Graphical Process Modeler. Gentran Integration Suite Configuration The following table describes the fields used to configure the Invoke Business Process Service in Gentran Integration Suite:
Note: The names in parentheses represent the corresponding field names in the Graphical Process Modeler. This information is provided for your reference.
Field Name Description Business Process Definition Name (WFD_NAME) Invoke Mode (1=Async, 2=Sync) (INVOKE_MODE) List of Parms to override (PARM_LIST) Type of Error On Which to Notify Parent Process (NOTIFY_PARENT_ ON_ERROR) Errors the subprocess reports to the parent business process (synchronous mode only). Valid values include: Parameters to override. Mode in which to run the subprocess. Valid modes are Asynchronous (default) and Synchronous. Description Unique and meaningful name for the service configuration. Required. Meaningful description for the service configuration, for reference purposes. Required. Business process used in the service configuration. Valid values include all the business processes installed.

Continue parent only if a service-generated error occurs in the subprocess. Continue parent only if a system-generated error occurs in the subprocess. Continue parent if any type of error occurs in the subprocess. Halt subprocess if any error occurs (for potential correction and resume). This option does not notify the parent of the error from the subprocess, and the subprocess is halted.

Notes:

184

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Graphical Process Modeler Configuration The following table describes the fields used to configure the Invoke Business Process Service in the Graphical Process Modeler:
Field Config COPY_SERVICE_ PARMS Description Name of the service configuration. Invoke Business Process Service parameters passed to the subprocess. Valid values are True (default) and False.

Exercise: Invoke Business Process Service

Create the Service Configuration 1. Log in to admin console. 2. On admin console, click Deployment > Services > Configuration. 3. Under New Service, click Go! 4. Enter Invoke Business Process Service in the Service Type field, and click Next. 5. Use INVOKE_Test for a name, and Invoke Business Process Service Test for a description. Set group to None, and click Next. 6. Complete the Service Configuration properties, and click Next. 7. Ensure that the service is enabled for business processes and click Finish.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

185

Lesson 7 Introduction to Service Management

Create a Business Process


1. Open the GPM. If it is already Open, click View > Refresh Services. 2. Click File> New. 3. Drag a Start, End, an XML Encoder Service and an Invoke Business Process Service into the workspace and connect them as shown.

4. Double click on the XML Encoder to bring up its properties editor. 5. From the config drop-down box, choose XMLEncoder. 6. Specify the following values in the Properties editor:

Mode: Use existing XML document Output_to_process_data: Yes


7. Double click on the Invoke business process service to bring up its properties editor. 8. From the config drop-down box, choose INVOKE_Test. 9. Specify the following values in the Properties Editor: a. Invoke_mode: Async b. Wfd_name: Select your Basic Inventory process. 10. Save as InvokeBuss and validate. Check in and test the business process 1. Open the admin console and choose Business Process > Manager. 2. Click Go! next to Create Process Definition. 3. Name the process invoke_Test. a. Make sure that the radio button entitled Check-in Business Process created by the graphical modeling tool is selected. b. Click Next. 4. Click Browse and navigate to your saved business process. Select it and click Open. 5. Give it a fitting description. Click Next.

Notes:

186

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

6. Use the default settings for the remaining parameters. Make sure the Business Process is enabled when you click Finish. 7. From the Business Process Manager screen, search for your new business process. 8. Click on Execution Manager when you get the results screen. 9. Choose execute in the execution manager screen. 10. Click Browse and choose the Inventoryof11.xml 11. Click Go! 12. Monitor the progress of the business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

187

Lesson 7 Introduction to Service Management

Wait Service
The Wait service allows a business process to wait for a period of time before moving on to the next step in the process. The Wait service does not hold its active thread during this wait time, which can reduce resource consumption.

How the Wait Service Works


The Wait service performs a function similar to the Sleep service: it allows you to pause a business process for a set length of time. However, unlike the Sleep service, the Wait service does not retain an active processing thread, which frees the thread for other processing jobs. Use the Wait service when you need to put a business process in a Wait state for at least one minute. If you need to put a business process in a wait state for less than a minute, use the Sleep service.

Implementating the Wait Service


Because a configuration of the Wait service is installed with Gentran Integration Suite, no configuration is necessary.

Notes:

188

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

Exercise: Wait Service

This exercise is designed to demonstrate: 1. The use of the All Start and how GIS handles business process contexts during processing. 2. The use of the Repeat activity, and how to properly construct a loop with an index. 3. The use of the Wait service to pause a process during execution. 4. The users ability to nest Choices and Alls inside one another for more advanced modeling.

To Create the BP:


1. Open the GPM, if its not already open. 2. Click New to start a new business process. 3. Move the following operations and services to your workspace by dragging the icons from the Stencil to the Workspace: (1) Start (1) End (4) Sequence Start (4) Sequence End (5) Assign (1) All Start (1) All End (1) Choice Start (1) Choice End (1) Repeat Activity (1) Wait

Notes:

Course 915: Gentran Integration Suite: Fundamentals

189

Lesson 7 Introduction to Service Management

4. Connect the activities in the order as shown below.

5. Rename the Sequence Starts as follows: a. c. First Sequence Start = Start Second Sequence Start in top branch of All Start = LoopStart b. First Sequence Start in top branch of All Start = Loop d. Sequence Start in bottom branch of All Start = NoLoop 6. Click the first Assign in the process, and set the values as follows: Constant = 0 To = LoopCount 7. Click the Assign in the bottom branch of the All Start, and set the values: Constant = The NoLoop Branch has executed To = NoLoop 8. Click the Wait, and set the WAIT_INTERVAL to 1. 9. On the toolbar, click Tools > Rule Manager. Add a new rule, and name it Loop Counter. In the Expression box, type: LoopCount < 10 Click OK twice to save your work and exit. 10. Click the edge line between Choice Start and the LoopStart Sequence Start. 11. In the Edge Editor, click Add. Select your rule from the drop down, and choose True for the value. 12. Click the Assign that follows the LoopStart Sequence Start, and set the values: From = LoopCount + 1 To = LoopCount
Notes:

190

Course 915: Gentran Integration Suite: Fundamentals

Lesson 7 Introduction to Service Management

13. Click the Repeat activity, and set the values: Name = CountingLoops Ref = Loop 14. Click the last Assign in the top branch of the All Start and set the values: Constant = Loop is done To = LoopStatus 15. Click the last Assign in the business process and set the values: Constant = Both branches have executed To = FinalContext 16. Save and validate your business process. 17. Check in your process, using the Process definition name of Looping_Test. Take all defaults during the check-in.

18. Execute your business process (no input file is needed).

Notes:

Course 915: Gentran Integration Suite: Fundamentals

191

Lesson 7 Introduction to Service Management

Lesson Review
Completed Objectives
You should now be able to: List and explain the four basic service types Explain how to create a service configuration Explain Bootstrapping Describe how the File System adapter works Describe how OnFault Processing works Explain how the Command Line adapter functions Describe and demonstrate the use of a Lightweight JDBC adapter Describe how the Invoke Business Process service works

Notes:

192

Course 915: Gentran Integration Suite: Fundamentals

Lesson 8

Case Study

This lesson provides an opportunity to analyze a business problem and create a business process based on that problem.

Introduction
Lesson Objectives:
After completing this lesson you should become familiar with: Analyzing a business problem Creating a business process to solve the business problem

Course 915: Gentran Integration Suite: Fundamentals

193

Lesson 8 Case Study

Our Business Problem


Our Company has agreed to perform a Vendor Managed Inventory service for two customers, My Little Store (MLS) and The Other Guy (TOG), both retailers of our merchandise. Our company auditor has requested we maintain a copy of the original data, so we must move a copy of the file to an archive directory. All processing is to be automated; no manual handling of the data should be required. Communications has already taken place and the data file(s) are now sitting in c:\fscoll. This exercise will help you understand more about bootstrapping, creating rules, Xpath statements and configuring different Services. There are a number of different solutions that you could use to solve this case study, this is just one solution. Note: When using bootstrapping, the business process that will be invoked should be built, saved and checked-in before we can reference (use) it. This affects the order that Processes may be built, as you will see in this exercise. In this solution we will create 5 different Business Processes: 1. The Main Business Process: Here you will build one business process to determine the Customer Id and take one of two paths, path for My Little Store or path for The Other Guy. This process will then invoke another Business Process that will determine if we need to order more items. After our BP runs we will need to write out the file into a directory called c:\fs_output. Suggested name: Main.BP. 2. The Invoke Business Process Service: Here you will build two different Customer business processes to determine if we need to order more items. One business process for the My Little Store and another for The Other Guy. The order level for My Little Store is less than 10, send more items. The order level for The Other Guy less than 20. Suggested names: LittleStore.BP and OtherGuy.BP 3. The Command Line Adapter Process: Here we will build a process to copy data into the correct folders, by calling a script called, copytest.bat. This script will look for files in c:\fscoll with a name of *.xml. Then move one copy of the files to c:\fsprocess and one copy to c:\fsarchive. 4. The File System Adapter Process: Here we will build a process to PICK UP the files from c:\fsprocess and cause our Main.BP process to start running by using bootstrapping.
Notes:

194

Course 915: Gentran Integration Suite: Fundamentals

Lesson 8 Case Study

Exercise: Your Assignment

Set up Steps
1. Create the following folders: c:\fscoll, c:\fsarchive, c:\fsprocess and c:\fs_output 2. Go to c:\915 Fundatmentals\Case Study labfiles and then make a COPY of copytest.bat and paste on to the C:\ drive.

The Main Business Process


This process will determine the Customer ID and then take a path for My Little Store or The Other Guy. We will then invoke a Business Process Service that will determine if we need to order more items. At the end of the process we will write file(s) into a directory called c:\fs_output. Suggestion: Build LittleStore.BP and OtherGuy.BP first (go to Invoke Business Process Service / Per Customer), then come back and build this process. In this process you will need the following stencils: Start (1) End (1) Sequence Start (3) Sequence End (3) Choice Start (1) Choice End (1) XML Encoder Service (1) File System Adapter (1)

Invoke Business Process (2) On the following page you will find an example of the process, then instructions after:

Notes:

Course 915: Gentran Integration Suite: Fundamentals

195

Lesson 8 Case Study

Step 1 for Main Process


1. Pull and Connect your Stencils. 2. Changing the name of the 3 sequence starts. a. Double click the first sequence start and type in Main Sequence under the value column. b. Double click the top sequence start and type in My Little Store under the value column. c. Double click the bottom sequence start and type in The Other Guy under the value column. 3. Configure the XML Encoder. a. Mode = Use existing XML document. b. Output to process data = Yes.
Notes:

196

Course 915: Gentran Integration Suite: Fundamentals

Lesson 8 Case Study

4. Click Tools > Rules Manager. Click Add to bring up the Rule Editor. Populate the name box with Check for MLS. In the expression box, type the following Xpath string: a. //INVENTORY/CUST_ID/text()=My Little Store 5. Click Tools > Rules Manager. Click Add to bring up the Rule Editor. Populate the name box with Check for TOG. In the expression box, type the following Xpath string: a. //INVENTORY/CUST_ID/text()=The Other Guy 6. In the top Edge Editor, click Add to display the name and value columns. Select My Little Store for the name and true under the value column. 7. The Invoke Business Process Service. a. Invoke_mode = Sync b. WFD_Name = LittleStore.BP or (whatever you named the business from the below exercise). 8. In the bottom Edge Editor, click Add to display the name and value columns. Select The Other Guy for the name and true under the value column. 9. The Invoke Business Process Service. a. Invoke_mode = Sync b. WFD_Name = OtherGuy.BP or (whatever you named the business from the below exercise). 10. The File System Adapter Service. a. Action = Extraction. b. AssignFilename = Use the original filename c. Bootstrap = No d. ExtractionFolder = c:\fs_output 11. Save as Main.BP, validate and check in the business process. 12. Congratulations you may now add BP Building to your Resume, but you are not done yet. Please go to the File System Adapter Process and continue.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

197

Lesson 8 Case Study

The Invoke Business Process Service / Per Customer


These two Customer business processes, My Little Store (MLS) and The Other Guy (TOG), will be invoked out of the Main business process. We will need two copies of this process, one for My Little Store and another for The Other Guy. Build one, save and validate, then do a Save As to create the second one with the other name. In this process you will need the following stencils: Start (1) End (1) Sequence Start (3) Sequence End (3) Below you will find an example of the process, then instructions: Choice Start (1) Choice End (1) Assign (2)

Notes:

198

Course 915: Gentran Integration Suite: Fundamentals

Lesson 8 Case Study

Step 1 for Customer Process


1. Pull and Connect your Stencils. 2. Changing the name of the 3 sequence starts. a. Double click the first sequence start and type in Check QTY for My Little Store in the value column. b. Double click the top sequence start and type in Order More under the value column. c. Double click the bottom sequence start and type in Do Not Order More under the value column. 3. Click Tools > Rules Manager. Click Add to bring up the Rule Editor. Populate the name box with Check QTY. In the expression box, type the following Xpath string: a. sum(INVENTORY/PRODUCT/QTY) > 10 4. In the top Edge Editor, click Add to display the name and value columns. Select Check QTY for the name and not true under the value column. 5. Click the Assign activity in Order More sequence and enter the following information. This will create this TAG in your output file: <results>Order more items</results>
Name Constant To Value Order More Items Results

6. In the bottom Edge Editor, click Add to display the name and value columns. Select Check QTY for the name and true under the value column. 7. Click the Assign activity in Do Not Order More sequence and enter the following information. This will create this TAG in your output file: <results>Do not order more items</results>
Name Constant To Value Do not order more items Results

8. Save as LittleStore.BP, validate and check in the business process.


Notes:

Course 915: Gentran Integration Suite: Fundamentals

199

Lesson 8 Case Study

9. Perform a Save As to create a second business process for The Other Guy. Remember that the Check QTY is different for this customer, (20) and the starting sequence should be named Check QTY for The Other Guy. 10. Save as OtherGuy.BP, validate an

Notes:

200

Course 915: Gentran Integration Suite: Fundamentals

Lesson 8 Case Study

2. Open the Service Editor for the File System Adapter Service. a. Action = Collection b. Assign Filename = Use the original filename. c. Bootstrap = Yes d. CollectionFolder = c:\fsprocess e. DeleteAfterCollect = Yes f. InitialWorkFlowid = main.bp 3. Save as KICKOFF.BP, validate and check in the business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

201

Lesson 8 Case Study

The Command Line Adapter Process


This process will start the business flow by calling a script called, copytest.bat. This script has been set up and will look for files in c:\fscoll with a name of inventoryof3a.xml. After picking up the files, the script will make two copies of the file. Depositing one file in c:\fsachive and the other in c:\fsprocess and then starting our File System Adaptor business process. (the previous process) In this process you will need the following stencils Start (1) End (1) Command Line Adapter (1) Below you will find an example of the process:

1. Pull and Connect your Stencils. 2. Open the Service Editor for the Command Line Adapter Service. a. Bootstrap = No b. CmdLine = c:\copytest.bat c. WorkingDirectory = c:\ d. InputDelete = Yes
Notes:

202

Course 915: Gentran Integration Suite: Fundamentals

Lesson 8 Case Study

e. OutputDelete = No f. WaitOnProcess = Yes 3. Add an Invoke Business Process stencil. a. WFD_NAME = Kickoff.bp ( the bp from the previous step ) b. INVOKE_MODE = Asynchronous 4. Save as START.bp, validate and check in the business process. 5. You may modify existing Service Configurations, or create new Service Configurations for use in this case study, testing your knowledge here. 6. Now locate the data files in the Case Study Labfiles folder under the 915 Fundamentals Folder and copy/paste all of the MLS and TOG files into C:\fscoll. When you cause START to run manually, copytest.bat (cmd /c "copy c:\fscoll\*.xml c:\fsarchive\*.xml" cmd /c "copy c:\fscoll\*.xml c:\fsprocess\*.xml" ) will copy the XML files to the archive folder and the fsprocess folder, then it will use the Invoke Business Process to begin Kickoff. Kickoff pulls in the files from fsprocess and begins Main. Good Luck! If data is placed in the c:\fs_output folder, the c:\fsarchive, and the correct constant is in Process Data, then your process was successful. If not, go back and correct any issues.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

203

Lesson 8 Case Study

Lesson Review
Completed Objectives
You should now be familiar with: Analyzing a business problem Creating a business process to solve the business problem

Congratulations! You have completed Lesson 8, Case Study.

Notes:

204

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9

Gentran Integration Suite Mapping

Introduction
Lesson Objectives
After completing this lesson you should be able to: Basic understanding of the Map Editor Download and Install the Map Editor Understand the XML Encoder Object Map Function

Course 915: Gentran Integration Suite: Fundamentals

205

Lesson 9 Gentran Integration Suite Mapping

The Gentran Integration Suite Map Editor


Mapping Overview
To translate data from one format to another, you must specify how the data in one format relates to data in another format. To relate one format to another for the translator, you must define a set of instructions in the Map Editor. These instructions indicate the relationship between the two formats.

GIS Map Editor Overview


The Map Editor is a stand-alone Windows program that you download from Gentran Integration Suite. The Map Editor enables you to create maps (.mxl or .map) and compile them into either translation objects (.txo.) or XML encoder objects (.ltx). After you have created and compiled maps, you check them in to Gentran Integration Suite. The Gentran Integration Suite Map Editor is shown below. It is used to represent the translation of one type of input data to a different type of output data.

Notes:

206

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

Navigating the Map Editor


The Map Editor window enables you to navigate in four ways: Select the command from the Main Menu bar. Click the appropriate button on the Main toolbar. Click the appropriate part of the map. Right-click a map component to access a shortcut menu that contains all the available functions for that map component. The shortcut menus enable you to quickly and easily access available functions. The content of the shortcut menus varies, depending on the type and level of the selected map component. When you start the Map Editor, the Main Menu bar contains a subset of commands. The full set of commands opens after you create a new map or open (load) an existing map. The following table lists the parts of the Map Editor window:
Part Main Menu Bar Main Toolbar Function Contains drop-down menus. Unavailable items are shaded. Enables you to access some of the most common functions in the Map Editor. Unavailable items are shaded. The Main toolbar is dockable, so you can affix it to any edge of the client window. Displays status information about a selection, command, or process; defines commands as you select each item in the menu; indicates any current keyboard-started modes for typing.

Status Display

Notes:

Course 915: Gentran Integration Suite: Fundamentals

207

Lesson 9 Gentran Integration Suite Mapping

EDI Map Components


This table describes the map object icons that Gentran Integration Suite uses to visually represent the EDI map components.
Component EDI Root Element Icon Description The EDI root element represents the EDI document that Gentran Integration Suite is mapping. At the EDI file root element, you define delimiters and syntax records. It is a group and can contain groups and segments. A group is a looping structure that contains related segments and groups that repeat in sequence until either the group data ends, or the maximum number of times that the loop is permitted to repeat is exhausted. Groups are defined by the EDI standards. A group that is subordinate to another group is a subgroup (and corresponds to a nested looping structure, a loop within a loop). Segment A segment contains a group of related elements or composite data elements that combine to communicate useful data. Segments are defined by the EDI standards. A segment can occur once or can repeat multiple times. Note: If a segment occurs more than once in a map, it is identified by its name <ID>. The second and subsequent occurrences are identified by <ID>:n, where n is the number of the occurrence in the map. Composite A composite is a data element that contains two or more component data elements or subelements. Composites are defined by the EDI standards that use them (EDIFACT and certain ANSI X12 standards). A composite can occur once or repeat multiple times. Note: If a composite occurs more than once in a map, it is identified by its name <ID>. The second and subsequent occurrences are identified by <ID>:n, where n is the number of the occurrence in the map. A repeating composite is a related group of EDI subelements that have the ability to loop as a whole (occur more than once) within a particular EDI segment. To enable a composite to repeat multiple times within a segment, each occurrence of the composite must be separated by a special delimiter, known as the repeating element delimiter.

Group

Notes:

208

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

Component Element

Icon

Description An element is the smallest piece of information defined by the EDI standards. An element can have different meanings depending on the context. Elements are typically not considered to have useful meaning until they are combined into segments. An element is the EDI map component that corresponds to a field in other data formats. Note: If an element occurs more than once in a map it is identified by its name <ID>. The second and subsequent occurrences are identified by <ID>:n, where n is the number of the occurrence in the map. A repeating element is an EDI element with the ability to loop (occur more than once) within a particular EDI segment. To enable a single element to repeat multiple times within a segment, each element must be separated by a special delimiter, known as the repeating element delimiter. The use of this delimiter prevents the translator from mistaking the repeating elements for typical elements. When an element has a link or standard rule performed against it, a red check mark appears over the element icon. When an element contains an extended rule or a standard rule, a black asterisk appears to the right of the element icon.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

209

Lesson 9 Gentran Integration Suite Mapping

Exercise: Downloading and Installing the Map Editor

Download and install the map editor 1. On the Admin console, click Deployment > Maps. 2. In the Download and Install section, next to Download Map Editor (EN), click Go! The system displays the File Download dialog box. 3. Select Open. If you choose to Open, the system downloads and installs the files and steps you through the installation process immediately. 4. You may see a security warning, asking if you want to install MapEditorInstall... Click Yes. 5. In the Map Editor Setup Welcome screen, click Next. 6. In the Choose Destination Location screen, click Next.
Note: If you specify a folder name that does not exist, you get a message asking you if you want to create that folder.

7. In the Select Program Folder option, accept the default folder and click Next. If you want to specify a different folder: a. Type a new name and click Next. b. In the Existing Folders list, select a folder and click Next. Result: The Map Editor setup wizard installs the Map Editor. 8. In the Setup Complete screen, click Finish.

Notes:

210

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

XML Encoder Object Mapping Function


The XML encoder object is a compiled map that translates positional, variable-length-delimited, CII, and EDI data formats into XML. It has the extension .ltx. To create an XML encoder object, you select Compile XML Encoder from either the input or output side of an EDI or positional file. Use the XML Encoder Object Mapping Function with the XML Encoder Service to allow the software to write non-xml data into process data. Once in process data we can then write XPath expressions. Because we need to convert non-xml data into xml we need to create a map to perform this task.

Exercise: Create the XML Encoder Object Map

1. Open the map editor Click Start > Programs > Sterling Commerce > Map Editor. 2. Create a new map with the name app2xml. 3. Select Sterling Integrator for type of map. 4. Select Positional (VDA, GENCOD, Application files etc) for the input format. 5. Select XML (Extensible Markup Language) for the output format. 6. Put the cursor on INPUT on the source side of the map, right click, and select Create Sub > Record. 7. On the Positional Record Properties page, type the following responses at the prompts on the Name and Tag tabs and select OK. a. Enter the name: Header b. Tag: NAM 8. Put the cursor on Header, right click, and select Insert > Record.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

211

Lesson 9 Gentran Integration Suite Mapping

9. On the Positional Record Properties page, type the following responses at the prompts on the Name and Tag tabs and select OK. a. Enter the name: Address b. Tag: ADR 10. Put the cursor on Header, right click, and select Edit Fields. 11. Click New. Use the table below to populate the corresponding Field Details. a. Click New to start each new row b. Select Auto Position before exiting this screen. c. Click Close to exit the screen.
Name Space Widget Data Type String String Max Length 1 20

12. Put the cursor on Address, right click, and select Edit Fields. 13. Click New. Use the table below to populate the corresponding Field Details. a. Click New to start each new row b. Select Auto Position before exiting this screen. c. Click Close to exit the screen.
Name Space:2 Location Data Type String String Max Length 1 20

14. Put the cursor on Address, right click, and select Insert > Group. 15. Type the following responses at the prompts on the Name and Looping tabs, and click OK: a. Enter the name: Line_Grp b. Maximum Usage: 3 16. Put the cursor on Line_Grp, right click, and select Create Sub > Record.
Notes:

212

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

17. Type the following responses at the prompts on the Name and Tag tabs, and click OK. a. Enter the name: Line_Items b. Tag: LI 18. Put the cursor on Line_Items, right click, and select Edit Fields. 19. Click New. Use the table below to populate the corresponding Field Details. a. Click New to start each new row b. Select Auto Position before exiting this screen. c. Click Close to exit the screen.
Name Space:3 Part_number Price Data Type String String String Max Length 2 11 6

Your map should look like this:

Notes:

Course 915: Gentran Integration Suite: Fundamentals

213

Lesson 9 Gentran Integration Suite Mapping

20. Save the map by selecting File > Save. 21. If asked if you want to increment the version of the map, click Yes. 22. Compile the map by putting the cursor on the INPUT icon and right clicking. Select Compile XML Encoder Object..., and then click Save.

Check in the map


1. From the Administration UI, select Deployment > Maps. 2. Select Check in new Map from Map Editor. 3. Locate the map file and click Open. C:\Program Files\Sterling Commerce\Map Editor\Source Maps\app2xml.map 4. Locate the compiled map filename and click Open. C:\Program Files\Sterling Commerce\Map Editor\Compiled Maps\app2xml.ltx 5. For Check-in Comments, type app2xml example. 6. Select Next. 7. Select Finish.

Create a Business Process


1. Open the Graphical Process Modeler (GPM). If it is already open, click View > Refresh Services. 2. Click File > New. 3. Drag Start, End, and XML Encoder Service stencils into the work area. Connect them as shown below.

4. Open the Service editor for the XML Encoder Service and choose XMLEncoder for the configuration.

Notes:

214

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

5. Enter the parameters from th

Notes:

Course 915: Gentran Integratio1undamentals

215

Lesson 9 Gentran Integration Suite Mapping

Manually run a business process


1. Click Business Process > Manager. 2. Type Test_app2xml in the Search text box and click Go! 3. Click the Execution Manager icon for Test_app2xml. 4. Click the execute icon. 5. Click Browse and navigate to C:\915 Fundamentals\Class Labfiles to locate the test data. 6. Locate the file file1.txt, and click Open. 7. Click Go! 8. Observe the separate Execute Business Process window while the business process runs. 9. After the process has run, click the Status Report icon for the Test_app2xml. Review the report. 10. Close the Execute Business Process window. 11. Click Return.

Notes:

216

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

Exercise: XML Encoder Object Mapping Function Converting EDI Data Into Process Data

Our Business Problem


When receiving 850 purchase orders from our trading partners we need to check to see if a drop ship notification has been received. Drop ship notification cause a problem for our ERP system because our trading partners insert 999999 into the N104 element and not their ship to customer id value. Our ERP system cannot complete the shipping information without a manual entry into our order entry system by our customer service team. The customer service rep will need to enter the shipping information from segments N1, N3 and N4. This exercise will show how to convert EDI data into XML data and then Xpath to make a decision based on the N101 and N104 element.
Note: The map editor and standards need to be downloaded for each unit before starting this exercise.

Create a new map


1. Open the map editor, Click Start > Programs > Sterling Commerce Map Editor > and then select File > New. 2. Select Sterling Integrator as the type of map. 3. Create a new map with the name edi2xml, click Next. 4. Input format, Select Delimited EDI (ANSI X12, UN EDIFACT, Tradacoms, etc) 5. Select Customize 6. Select Next 7. Select Sterling Integrator Standards, select Next. 8. Select [X] X12 for standards agency. 9. Select [003040] for which version do you want to use. 10. Select [850] PURCHASE ORDER for the transaction set. 11. Select Next. 12. Select Finish. 13. Select Next.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

217

Lesson 9 Gentran Integration Suite Mapping

14. Select XML (Extensible Markup Language) for the output format. 15. Select, Next and then Finish. 16. Activate all the segments and elements matching the input file of 850dropship.txt found in C:\915 Fundamentials\Class Labfiles.
Note: Using Edit/Find can make this task easier.
Segment BEG DTM TD5 N1 N3 N4 PER PO1 PID REF SAC SDQ CTT Elements 01, 02, 03, 05 01, 02 02, 03 01, 02, 03, 04 01 01, 02, 03, 04 01, 02, 03, 04 01, 02, 03, 04, 05, 06, 07, 08, 09 01, 05 01, 02 01, 02, 05, 12 01, 02, 03, 04, 05, 06, 07, 08, 09, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 01, 02

Click View, Show Activate Only

Notes:

218

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

After completion, the EDI layout should match the diagram below:
Note: Diagram only reflects active segments.

17. Save the map by selecting File > Save. 18. Compile the map by putting the cursor on 850 - M - 1 PURCHASE ORDER envelope icon and right clicking. Select Compile XML Encoder Object, and click Save.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

219

Lesson 9 Gentran Integration Suite Mapping

Check in the map


1. From the Administration UI, select Deployment > Maps. 2. Select Check in new Map for the Map Editor. 3. Locate the map file and click Open. a. C:\Program Files\Sterling Commerce\Map Editor\Source Maps\edi2xml.map 4. Locate the compiled map filename and click Open. a. C:\Program Files\Sterling Commerce\Map Editor\Compile Maps\edi2xml.ltx 5. For Check-in Comments, type Edi2xml example. 6. Select Next. 7. Select Finish.

Create a Business Process


1. Open the Graphical Process Modeler (GPM). 2. Click View > Refresh Services. 3. Create a business process comprised of: (1) Start (1) End (3) Sequence Start (3) Sequence End (1) File System Adapter (1) Choice Start (1) Choice End (2) Assign (2) XML Encoder

Notes:

220

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

4. Arrange and connect the services as shown below.

5. Change the name of the 3 sequence starts. a. Double click the first sequence start and type in start under the value column. b. Double click the top sequence start and type in true under the value column. c. Double click the bottom sequence start and type in not true under the value column.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

221

Lesson 9 Gentran Integration Suite Mapping

6. Click the first XML Encoder and configure as follows. a. Config select, XML Encoder
Name exhaust_input map_name Mode Output_to_process_data Value Yes edi2xml Encode non-XML document Yes

7. Click on Tools > Rule Manager > Add, name the rule Drop Ship Notification. 8. For expression enter: //N1/_0098[contains(text(), "ST")] and //N1/_0098[contains(text(), "999999")] a. Click Ok twice, this will save the rule and close the window. 9. In the top Edge Editor, click Add to display the name and value columns. Select Drop Ship Notification for the name and true under the value column. 10. In the bottom Edge Editor, click Add to display the name and value columns. Select Drop Ship Notification for the name and not true under the value column. 11. Click the top assign and enter:
Name Constant To Value Drop Ship Notification Results

Note: In a real situation you would replace this service with the SMTP send adapter so that the customer service team could be notified.

12. Click the bottom assign and enter:


Name Constant To Value Normal Order Results

Notes:

222

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

13. Click the second XML Encoder and configure as follows. a. Config select XML Encoder
Name exhaust_input Mode Root_element XPath output_to_process_data Value Yes Create document using Xpath movingprocessdatahere //ProcessData/* Yes

14. Click the File System Adapter Service and configure as follows. a. Config select FS_TEST
Name Action ExtractionFolder AssignedFilename Value Extraction c:\fsext //ProcessData/Results/text() Use Xpath? Yes

15. . Save and validate the business process (troubleshoot any errors that appear). Name the business process EDI2XML.bp

Check in and test the business process


1. Open the Admin console and choose Business Process > Manager. 2. Click Go! Next to Create Process Definition. 3. Enter edi2xml for the process name. a. Make sure that the radio button titled Check in Business Process created by the Graphical modeling tool is selected. b. Click Next. 4. Click Browse and navigate to your saved business process. Select it and click Open. 5. Type Converting EDI2XML and click Next.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

223

Lesson 9 Gentran Integration Suite Mapping

6. Use the default settings for the remaining parameters. Make sure the Business Process is enabled when you click Finish.

Run the business process two different times


1. From the Business Process Manager screen, search for your new business process. 2. Click on Execution Manager when you get the results screen. 3. Choose execute in the execution manager screen. 4. Click Browse and navigate to C:\915 Fundamentials\Class Labfiles to locate the test data. 5. Locate the file 850dropship.txt and click Open. 6. Click Go! 7. The process data and filename should reflect Drop Ship Notification.

Rerun the business process using a different input file.


1. From the Business Process Manager screen, search for your new business process. 2. Click on Execution Manager when you get the results screen. 3. Choose execute in the execution manager screen. 4. Click Browse and navigate to C:\915 Fundamentials\Class Labfiles to locate the test data. 5. Locate the file 850normal.txt and click Open. 6. Click Go! 7. The process data and filename should reflect Normal Order.

Notes:

224

Course 915: Gentran Integration Suite: Fundamentals

Lesson 9 Gentran Integration Suite Mapping

Lesson Review
Completed Objectives
You should now be able to: Basic understanding of the Map Editor Download and Install the Map Editor Understand the XML Encoder Object Map Function

Congratulations, you have completed Lesson 9, Gentran Integration Suite Mapping. Now lets move on to Tracking System Health.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

225

Lesson 9 Gentran Integration Suite Mapping

Notes:

226

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10

Tracking System Health

This lesson explains how to locate and correct potential problems in a business process.

Introduction
For instances that stopped running, you must troubleshoot the instance to identify the cause, reconcile the issue or error, and determine whether to restart, resume, or terminate the instance.

Lesson Objectives
By the end of this lesson, you should be able to perform: Troubleshooting and reconciling business processes Archiving business process data Restoring business process data archived offline Managing Resources Deleting a Business Process

Course 915: Gentran Integration Suite: Fundamentals

227

Lesson 10 Tracking System Health

Troubleshooting and Reconciling Business Processes


Gentran Integration Suite has a built-in system recovery business process that runs automatically every 45 minutes. The recovery business process monitors active business process instances and enables Gentran Integration Suite to report any issues that occurfor example, a system or service associated with an instance shuts down or a compliance error results while an instance that implements standards is running. When the recovery business process identifies issues or errors while an instance is running, Gentran Integration Suite halts the instance, indicates an advance status message of error and a state message of interrupted, and generates reports, as appropriate. When troubleshooting an instance that indicates a status error, consider: The terminated activity and state activity override all other activities and states. When an instance is terminated, all subprocesses and any subprocesses waiting to be processed in the instance terminate. Used in combination, the status indicator, advanced status and state messages, and reports can help to determine: Issues that result while an instance is running Errors or warnings that prevent an instance from running Actions to complete to reconcile errors or warnings

Notes:

228

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Status Indicators and State Messages


The following table describes the status indicators and state messages and possible actions to take in response to them:
Status Indicator State Active Action 1 2 3 4 Halting 1 2 3 4 View details to identify whether errors or warnings justify stopping the business process instance. Stop the instance if necessary. Correct the errors. Resume or restart the instance and run the same document. Wait for the business process instance to stop. View details to identify errors or warnings. Correct the errors. Resume or restart the instance and run the same document.

Gentran Integration Suite does not archive data for halted instances. To archive an instance, you must terminate it. Halted 1 2 3 Terminated 1 2 3 Waiting 1 2 3 View details to identify errors or warnings. Correct the errors. Resume or restart the instance and run the same document. View details to identify errors or warnings. Correct the errors. Restart the instance and run the same document. View details to identify whether errors or warnings justify stopping the business process instance. Stop the instance if necessary. Resume or restart the instance and run the same document.

If you terminate this instance, the state may change in the following order as Gentran Integration Suite terminates the instance: Waiting > Halting > Halted > Terminated. Interrupted 1 2 3 View details to identify any errors or warnings. Correct the errors if necessary. Restart the instance and run the same document.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

229

Lesson 10 Tracking System Health

Status Indicator

State Active

Action 1 2 3 Wait for the business process instance to complete. Check the accuracy of results, if appropriate. If the results are inaccurate, modify the business process and run the same document with the new version. Determine whether the new results are accurate. Check the accuracy of results, if appropriate. If the results are inaccurate, modify the instance and run the same document with the new version. Determine whether the new results are accurate. Wait for the current step in the instance to finish. Resume or restart when appropriate. Wait for the current step in the instance to finish. Resume or restart when appropriate. Wait for the business process instance to complete. Check the accuracy of results, if appropriate. If the results are inaccurate, modify the instance and run the same document with the new version. Determine whether the new results are accurate.

4 Completed 1 2 3 Halting 1 2 Waiting 1 2 Active 1 2 3 4

Notes:

230

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Advanced Status Messages


In the Business Process Detail page, check the message in the Advanced Status column of the business process instance to determine whether further action for the business process is required. The following table describes advanced status messages and possible actions:
Message None Invalid Business Process Description No advanced status is available for the current stage. Business process does not exist. Action No action is required. 1 2 3 Business Process Disabled Disabled feature selected for the business process. 1 2 In the Monitor page, find the instance. Select the ID of the instance From the Action field, select Restart. Find the instance by performing an advanced search. From the Business Process menu, select Manager, and then locate the instance. Click Enable for the selected instance. Click Execution Manager for the instance.

3 4

The business process resumes automatically. Service Disabled Disabled feature selected for this service in the business process. 1 From the Deployment menu, select Services > Configuration. Search and find the service. Click Enable for the selected service.

2 3

The business process resumes automatically.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

231

Lesson 10 Tracking System Health

Message Service Error

Description Error occurred with the service processing the data at this point in the business process.

Action 1 From the Operations menu, select System > Troubleshooter. Is the service active?

If Yes, go to step 3. If No, contact your system


administrator and restart the service. 3 4 From the Operations menu, select System > Logs. View the log associated with the service that encountered the error. The log may show where the error occurred or what caused the error. Correct the error where possible and select Resume from the Business Process Detail page. If the log does not contain information about the error, resume the instance and verify your results. In the Monitor page, find the instance. In the ID column, click the number identifying the instance to display the related Business Process Detail page. Identify which service stopped. Select Resume from the Action field.

Service Stopped

Service in the business process stopped.

1 2

3 4

Notes:

232

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Message Business Process Instance Stopped

Description Business process discontinued execution.

Action 1 2 In the Monitor page, find the instance. In the ID column, click the number identifying the instance to display the related Business Process Detail page. Review the advanced message to determine why the instance stopped and correct the problem. Return to the Monitor page and select Resume, Restart, or Advanced Restart in the Action field.

System Shutdown Invalid Service

Gentran Integration Suite was shut down. Service does not exist.

Restart Gentran Integration Suite. The instance restarts automatically. 1 2 Install and configure the service. Restart Gentran Integration Suite. Determine which parameter is missing. Modify the service properties of the instance in the business process document, if possible. Restart Gentran Integration Suite if necessary. Fix the incorrect parameter. Restart Gentran Integration Suite.

Mandatory parameter for service missing

Service is missing a required parameter.

1 2

3 Invalid value for mandatory parameter Value for required parameter is incorrect. 1 2

Notes:

Course 915: Gentran Integration Suite: Fundamentals

233

Lesson 10 Tracking System Health

Viewing Troubleshooting Reports


Gentran Integration Suite generates two reports to use for troubleshooting business processes. The reports are: Translation Status EDI Compliance

Exercise: Viewing a Troubleshooting Report

To view a troubleshooting report: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Current Processes. If you do not see the business process you want to monitor in the Current Process page, it is not active. Perform a search to find processes not listed in the Monitor page. 2. In the ID column, click the number identifying the business process for which you want to check the troubleshooting report. An Information icon in the Status Report column indicates that a report is available for a specific step. 3. Does the Status Report column display one or more Information icons?

If Yes, click the Information icon to view the troubleshooting report for the step
with which it is associated. The report then opens in a new window.

If No, no troubleshooting report is available.

Notes:

234

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Archiving and Restoring Business Process Data


Archiving your business process data not only protects your critical data but also conserves database disk space, improving the efficiency of Gentran Integration Suite. Gentran Integration Suite uses a set of components to move business process data out of the database and onto a persistence level of long-term storage. The components include:

Index Business Process service Archive system business process Purge system business process
Data that has been removed using the Backup Business Process component can later be restored to the same version of Gentran Integration Suite using the Restore Business Process component.
Note: The level of detail written to the database as a business process runs is affected by the persistence level, which you specify with the Business Process Manager or in the noapp.properties file. Decreasing the persistence level increases the business process performance at the cost of full-tracking for each step of the business process.

Business processes are eligible for archiving as soon as their archive flag is set by the Index Business Process service. You do not have to wait until a business process exceeds its lifespan before archiving it. After the archive flag is set, the business process is then archived the next time the Backup Business Process service is run either by schedule (at 2 A.M. each morning) or manually. The data is still available in the system because it cannot be purged (with the Purge service) until it has exceeded its lifespan. The Restore Business Process service restores archived business process data from physical media to a Gentran Integration Suite restored data location where it can be searched and viewed. After running a business process, when a business process terminates, and before archiving or purging business process data, the business process must first be indexed. That is, the Index Business Process service runs a process that looks for archiving parameters defined in the business process. When the process finds these parameters, the process creates summary information and writes the information to a table in the database. For information written to the table, the Backup Business Process service runs, according to how you have configured your archiving settings. The Backup Business Process service retains the business process and its related data to a file system as Java serialized objects for later backup to tape, some other long-term storage medium, or purging. The Purge

Notes:

Course 915: Gentran Integration Suite: Fundamentals

235

Lesson 10 Tracking System Health

service then runs and removes any data from the database or file system, or both, specified in archive settings not to retain. The following diagram shows the archiving process.

The Archive Flag is initially set by the Index Business Process service to 0 or 1. A value of 0 causes the data to be backed up. A value of 1 causes the data to be purged without being backed up. A data backup sets the flag to 2, which causes data to be purged.
Note: You cannot archive active business process instances (for example, halting, halted or interrupted). Only data for completed or terminated business processes that have been indexed can be archived. Note: You cannot delete a workflow definition of a business process (using the Source Manager of the Business Process Manager) while an instance of that process is being either indexed, archived or purged. If you try to delete such a definition, an error message appears.

In the same manner that you schedule business processes, you can schedule the intervals at which you want Gentran Integration Suite to index, archive, and purge the contents of the database. Two options affect the amount of database table space used when you archive or purge business processes:

Notes:

236

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

1. Persistence level

Full - Retain all data for this business process, including associated documents,
activities, and all process data.

Step Status (Engine May Override) - This is the recommended persistence level
for most process models because it helps optimize performance while providing a level of recovery suitable for most business needs. * Persists process data and documents for service steps according to the persistence level supported by the service in the step.

BP Start Stop (Engine May Override) - Choose this level if you know you do
not need persisted status data for successful processing. Because service level settings override the selection, you may have additional data in a recovery scenario. * Persists process data and documents for service steps according to the persistence level supported by the service in the step.

System Default - Assume that for the data, configuration is already defined in
Gentran Integration Suite to retain data. * Persists data according to the global persistence setting configured in the properties file.

Step Status Only - Choose this level if you need only status information for each
step and your recovery needs do not depend on additional data being saved.

BP Start Stop Only - Choose this level if your recovery needs do not depend on
data being saved for the processing steps.

Zero - This level does not persist any business process data you for recovery or
process tracking. Choose this level only if you are certain you will not need the data.
Note: Zero persistence is available only if the process is running in Synchronous start mode.

Error Only - Choose this level if you do not need tracking data for your process
when it is successful and your recovery does not depend on process step data being saved. 2. Life span

This option enables you to define the length of time, in days and hours, to retain the data in Gentran Integration Suite ONLINE tables. This is the length of time until the business process instance expires.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

237

Lesson 10 Tracking System Health

Configuring Archive Settings


You can configure Gentran Integration Suite to automatically archive business process data as often as you need. When archiving your business process data, consider that: You cannot archive active business process instances. Only data for completed or terminated business processes can be archived. You should indicate default values that apply to all business process instances that you run. How often you archive should depend on the volume of business processes that you run. Business level information should be archived for audit purposes, including: Security information, such as certificates Documents that support non-repudiation for AS1 and AS2 protocols Correlations that provide searching ability

Business process are archived or purged only when they have exceeded their life span. For any data that you may potential want to view in the immediate future, maintaining the data in live tables provides faster retrieval.

Configuring default archive settings


When configuring default archive settings, you can define whether Gentran Integration Suite should archive data for business process instances inside or outside of Gentran Integration Suite. After you configure and save the archive schedule, the archive process is automatic and runs based on the time parameters you provided during configuration.

Notes:

238

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Notes:

Course 915: Gentran Integration Suite: Fundamentals

239

Lesson 10 Tracking System Health

Viewing the Archive Log


In Gentran Integration Suite, you can view the archive log using either the: Archive Manager System logs

Using the Archive Manager


To view the archive log using the Archive Manager: 1. From the Gentran Integration Suite Operations menu, select Archive Manager. 2. In the Archive Log section, click Go! to view the archive log.

Using the System Logs


To view the archive log using the system logs: 1. From the Gentran Integration Suite Operations menu, select System > Logs. 2. In the environment section, click the link archive.log to view the archive log.

Restoring Archived Data


After you have archived business process data to an offline location, you can restore that data and view it in Gentran Integration Suite.

Notes:

240

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Notes:

Course 915: Gentran Integration Suite: Fundamentals

241

Lesson 10 Tracking System Health

Viewing Restored Business Process Data


To view archived business process data that you have restored in Gentran Integration Suite: 1. From the Gentran Integration Suite Business Process menu, select Monitor > Advanced Search > Business Processes. 2. Under Search Location, select Restore Tables. 3. In the Business Process Monitor Search (Restore) page, complete one of the following steps:

Click Go! to view all restored business process data. Search for specific restored business process data. Indicate any combination of the
following criteria and click Go! Process ID Display data identified by the number assigned by Gentran Integration Suite when the business process ran. Business Process Display data for business processes whose names contain the specified character or string. System Business Processes Display data for Gentran Integration Suite system business processes whose names contain the specified character or string. State Display data for business processes whose final state corresponds to the specified state. Status Display data for business processes whose final status corresponds to the specified status. Start date/time range Display data for business processes run within the specified start dates and times.

4. From Operations > Archive Manager, go to Restore Manager and click Go! 5. In the Clean restore area, click Go!

Notes:

242

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Managing Resources
In Gentran Integration Suite, resources are files, templates, and documents that are deployed in Gentran Integration Suite to perform various actions.
Gentran Integration Suite enables you to import and export resources, which can save time and increase the accuracy of duplicating resources on various Gentran Integration Suite systems that are set up for unique purposes. Specifically, the Import and Export options enable you to: Import resources from an Gentran Integration Suite test environment to a Gentran Integration Suite production environment. Import resources from one Gentran Integration Suite system to another. To import and export resources from Gentran Integration Suite environment to another Gentran Integration Suite environment, both environments must be the same version. You can import and export the following resource types:

Accounts
Business Processes ebXML Specifications Mailboxes Perimeter Servers Schedules Service Configurations Web Resources Web Templates

Application Configurations (only SAP) Communities Maps PGP Profiles Report Configurations XML Schemas Trading Partner Data WSDL XSLTs

Notes:

Course 915: Gentran Integration Suite: Fundamentals

243

Lesson 10 Tracking System Health

Exporting Resources
Before conversion, resources must be converted into the proper format for storage and transference. The Export option converts a group of resources that you specify into one of the following formats: XML - Enables you to transfer data or resources between two existing systems. Installable bundle - Optionally enables you to load during an Gentran Integration Suite install on a new system.
Note:

You cannot use the Export option to export .war files.


In the export process, after you have defined the file format to use for the export, you select the version of the resources to export: The Standard export copies non-versioned resources and the default version of versioned resources. The Advanced export copies non-versioned resources and enables you to choose to export just default versions or all versions of versioned resources.

You can export resources that are associated with a particular resource tag or resources not associated with a resource tag.

Notes:

244

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Exercise: Exporting Resources Out of Gentran Integration Suite

1. From the Administration Interface, click Deployment > Resource Manager > Import/Export. 2. To take information out of GIS, select Export Resources and click Go!. 3. On the Output Format Type screen, select the radio button for XML Files, and click Next. 4. On the Resource Group screen, accept the default of No to export based on resource tag name, and click Next. 5. On the Export Type screen, accept the default of Standard - exports default version, and click Next. 6. On the Select Resources screen, select Business Processes as the type of resources to export and click Next. 7. On the BP Definitions screen, select BasicInventoryProcess and move using the right arrow button to the To be exported list. Click Next. 8. Click Finish. 9. When the System Update has successfully completed, click Download Export data XML. 10. Click Save to download the file 11. Save with a unique .xml filename.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

245

Lesson 10 Tracking System Health

Importing Resources
When you import resources, the Import option converts an XML file or installable bundle to Gentran Integration Suite resources format.
Note: You cannot use the Import option to import .war files.

Depending on the type of export you used (standard or advanced, default or all versions), the Import option performs the following functions: Creates new non-versioned resources Creates and checks in new versioned resources (assigns time/date of the import) Updates or preserves existing non-versioned resources Preserves or appends existing checked-in resources
Caution:

To prevent the loss or corruption of existing records, preserve and download the backup file of all imports that you conduct.

Standard Import
The standard import: Replaces non-versioned records Appends to existing versioned resources Sets the default according to imported records Tips for Importing Resources Here is some important information about importing resources: You must manually update imported resources that contain hard-coded, computer-specific information. For example, system paths in scripts must be manually changed to use the new path after importing resources to their new location. During import, Gentran Integration Suite creates a backup file containing records as they existed prior to import. After you import the resources, you can download and preserve the backup file, which is named backup.xml by default.You can change the name of the backup file so that you do not overwrite an existing backup file. Update and Preserve Existing Resources Options For both non-versioned and versioned resources, the import process creates a new record where none exists. If you are importing resources to an environment that already contains the same resources, you have two options: Update
Notes:

246

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Preserve Existing (default)


Note:

Each option handles versioned and non-versioned resources differently.


The Preserving Existing option is the default option. Depending on whether you are working with versioned or non-versioned resources, different actions occur. Non-versioned resources - If a record already exists, nothing is imported. The import process does not change existing records. For versioned resources - The preserve existing option does not change any versions currently in the system, and adds only new versions. You see the Update option only when you select Update during the import process. If you are importing non-versioned resources, the Update option replaces the existing records.

If you are importing versioned resources, the Update option appends to the list when versions already exist, incrementing by one, according to the starting point of the import system.

Exercise: Importing Resources into Gentran Integration Suite

To add information into Gentran Intergation Suite: 1. From the Administration Interface, click Deployment > Resource Manager > Import/Export. 2. Select Import Resources and click Go!. 3. Browse to the location of the .xml file to import and click Next. 4. Click Next, do not create resource name 5. Click Yes to update objects in database, click Next. 6. Highlight name of resource to be imported and click Next. 7. Verify confirmation details and click Finish.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

247

Lesson 10 Tracking System Health

Deleting a Business Process


In Gentran Integration Suite, you can delete individual business processes (except business processes used by Gentran Integration Suite). Some reasons you might delete a business process are: Business activities have changed and, as a result, a business process can no longer accomplish the activities. You need to remove versions of a business process to reduce the database size. Before deleting a business process, consider that: Deleting a business process is permanent; it cannot be restored once deleted. If the business process runs on a schedule, the schedule is deleted with the business process. When a user account is required by a business process (for example, to perform a human interaction activity, such as approving a PO), and that user account is deleted, the business process does not run, and Gentran Integration Suite generates an error message instead. After you confirm that you want to delete a business process, Gentran Integration Suite deletes the business process and creates a log entry that contains the name of the business process, date and time of deletion, and the user account who performed the deletion. After a service configuration has been deleted, you can reuse the name. Only user accounts that have SII_DELETE and BPMANAGE permissions can delete business processes.

Before Deleting a Business Process


Before you delete a business process, ensure that you have completed the following tasks: 1. Use the Export Resources function to save a copy of the business process to offline storage. 2. Identify any uses of the business process to ensure the deletion does not prevent other business processes and ensuing services from running.

Notes:

248

Course 915: Gentran Integration Suite: Fundamentals

Lesson 10 Tracking System Health

Notes:

Course 915: Gentran Integration Suite: Fundamentals

249

Lesson 10 Tracking System Health

Lesson Review
Completed Objective
You should now be able to perform: Troubleshooting Archiving Business Processes Restoring business process data archived offline Managing Resources Deleting a Business Process

Congratulations! You have completed Lesson 10: Tracking System Health. Now lets apply what we have learned by Completing the Case Study!

Notes:

250

Course 915: Gentran Integration Suite: Fundamentals

Lesson 11

Case Study

This lesson provides an opportunity to analyze a business problem and create a comprehensive solution to that problem.

Introduction
Lesson Objectives:
After completing this lesson you should become familiar with: Analyzing a business problem Creating a comprehensive solution to solve the business problem

Course 915: Gentran Integration Suite: Fundamentals

251

Lesson 11 Case Study

Case Study Overview


This Case Study is based on a real implementation and is designed to test what youve learned in class. The Case Study is planned to take 8 hours (3 hours on Thursday afternoon, and 5 hours on Friday). Because of the complexity of this study, regular stopping points have been inserted to bring the class back together for discussion and progress checks. Those falling behind will be brought current by the instructor providing the solution to missing or non-working components

Timeline:
The following timeline has been established to assist you in managing your time for completing the Case Study. Thursday: 1:00pm - 2:00pm - Discuss and explain the case study; Q&A time regarding the exercise and what services/adapters will be required. 2:00pm - 4:00pm - Steps 1-5 from Steps for Completing the Case Study, pg 256. 4:00pm - 4:30pm - Breakpoint #1 - Class discussion and debugging of file directories and database table. Friday: 9:00am - 11:30am - Steps 6-9 from Steps for Completing the Case Study, pg 256. 11:30am - 12:00pm - Breakpoint #2 - Class discussion and debugging of ErrRtn, and Output processes, and services/adapters. 12:00pm - 1:00pm - Lunch 1:00pm - 2:30pm Steps 10-13 from Steps for Completing the Case Study, pg 256. 2:30pm - 3:00pm - Breakpoint #3 Class discussion and debugging of Main. 3:00pm - 3:30pm - Final Review/Course Wrap-up/Evals.

Notes:

252

Course 915: Gentran Integration Suite: Fundamentals

Lesson 11 Case Study

Our Business Problem


Historically, our company has operated as two autonomous divisions; one for trucking and logistics, and one for pharmaceuticals. Recently, we purchased and installed GIS, and plan to unite processing into a single system through it. Our backend systems will remain independent for the time being; were still evaluating which ERP software we may choose to implement in the future. We receive inbound data in EDI (X12) format, from Sterling Collaboration Network (our VAN of choice). Some of the data is intended for our pharmaceutical division, some for our logistics division. Pharma orders must be written to the ORDERS table of our database. Logistics documents must be sent to our logistics application, which requires the data be in EDI format, but with a specific set of delimiters that our app system needs and our partner will not provide. For data warehousing purposes, we must write a copy of the data to a directory, in XML format. Were pulling the data from the VAN by way of a communications package. This is being done thru FTP communications and is already established for us. Error handling is required, as is hands-free processing.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

253

Lesson 11 Case Study

The Business Flow


1. The Start business process collects data from a directory using a FSA (scheduled). When data is collected, bootstrap Main. If no data is present for collection, invoke ErrRtn business process. 2. Main will accept the data handed it by Start, and encode it into XML, placing it into ProcessData. Well test the data; if its for the Pharma division, well write the PO number, and customer number to the ORDERS table. If its for the logistics division, well change the segment terminator from a ~ to a = (equal) and write the altered EDI data out to a processing directory. After this processing is done, well pass the results to Output business process. If there are errors anywhere along the line, invoke ErrRtn. 3. Output will accept the data handed it by Main, and invoke two paths at the same time; one will call a script outside of GIS that will clear the inbound directory, The other will move the XML in Process Data to Primary Document, and write it to a data warehousing directory. If there are errors anywhere along the line, invoke ErrRtn. 4. ErrRtn is called from multiple processes, as a generic error handling process. Project specifications require that errors be reported to the GIS admin via e-mail, requiring the use of an SMTP Send Adapter.

Notes:

254

Course 915: Gentran Integration Suite: Fundamentals

Lesson 11 Case Study

To Complete this Case Study, you will need:


1. File System Adapter (2) 2. OnFault activity 3. Invoke Business Process Service 4. XML Encoder Service 5. Choice Start/Choice End 6. Lightweight JDBC Adapter In order to extract the correct values for using in updating the database in the lightweight JDBC Adapter, use the following xPath statements: a. On an Assign: substring(//_0353/text(), 8, 4) This reaches into ProcessData, locates element _0353, counts from the left 8 bytes, and extracts the next 4. Result: You have extracted the PO number from the data in ProcessData for use in the adapter. b. On an Assign: string-length(//_0098/text()) This reads the overall length of the element in ProcessData and stores that number of bytes as an integer for future use. c. On an Assign: substring(//_0098/text(), 5, CustNumLen) Note: where CustNumLen might be the To value from the last Assign. This reaches into the element in ProcessData, places a pointer at the 5th byte, and extracts the rest of the element for use in the adapter. 7. Document Keyword Replace Service Note: The Document Keyword Replace Service is not part of your course materials. However, all service and adapter documentation is available on http://www.sterlingcommerce.com. If you do not have a log on to our Support On Demand website, your instructor will log you in to make the information available. 8. Assign activity 9. Command Line Adapter Command Line Program: Batch program is supplied in lab files folders. Program name is Clear_Dir.bat, and will delete all files in directory c:\Inbound_from_Comms. 10. All Start/All End 11. SMTP Send Adapter 12. Create a table in the GIS database to our specs 13. Access to product documentation 14. xPath to conduct a choice 15. xPath for DOMToDoc
Notes:

Course 915: Gentran Integration Suite: Fundamentals

255

Lesson 11 Case Study

Steps for Completing the Case Study


In order to successfully complete the Case Study you must complete the following steps in their given order. 1. Analyze the business problem, plan/sketch a solution. 2. Gather requirements (directories to be created, e-mail address, mail host/port, command line script location and function, database table schema). 3. Develop three file system directories (Inbound_from_Comms, Altered_Delimiter, Output_Data). 4. Create database table ORDERS within the GIS database.

To Create the ORDERS database table:


Database Schema: Table is to be added to GIS database in class. Table Name: ORDERS Fields: CUST_ID (string 20), PO_NUM (string 10) Creation instructions:
a. Open a command line session and type: cd c:\sterlingcommerce\si\mysql\bin and press <enter>. b. Type mysql.exe u si --password=woodstock --port=9003 and press <enter>. c. e. Type use woodstock and press <enter>. Check your work by typing describe ORDERS; and pressing <enter>. d. create table ORDERS(CUST_ID char(20), PO_NUM char(10)); and press <enter>.

5. Configure services and adapters (disable schedule for Collection side of FSA). 6. Create and check in ErrRtn. 7. Test/debug ErrRtn. 8. Create and check in Output. 9. Test/debug Output with and without errors to call ErrRtn. 10. Create and check in Main. 11. Test/debug Main with and without errors to call ErrRtn. 12. Edit envelopes to call ErrRtn if an error is found. 13. Manually test entire process. 14. Re-enable schedule for Collection side of FSA.
Notes:

256

Course 915: Gentran Integration Suite: Fundamentals

Lesson 11 Case Study

Completed Objectives
You should now be familiar with: Analyzing a business problem Creating a comprehensive solution to solve the business problem

Congratulations! You have completed Lesson 11, Case Study.

Notes:

258

Course 915: Gentran Integration Suite: Fundamentals

Course Wrap Up

Introduction
Lesson Objectives
After completing this lesson you should be able to:

Locate additional help. Determine additional Gentran Integration Suite training needs. Complete the course evaluation.

Course Objectives
You should now be able to: Run a business process Create a business process using the Graphical Process Modeler Explain how to create a service configuration Explain how to track an executable business process Discuss the basics of Gentran Integration Suite

Course 915: Gentran Integration Suite: Fundamentals

259

Course Wrap Up

Sterling Commerce Educational Services


Sterling Commerce provides a number of solutions to help transfer knowledge and expertise into your organizations including: Classroom product training (public and onsite) WebCasts and Online Tutorials Custom course and e-Learning development services If you are interested in additional services, you have several options available for registering for additional courses.
You can register... On site Online email By telephone By fax At... This or any of our training facilities http://www.sterlingcommerce.com/Services/Education/ educational_services@stercomm.com 800-677-3342 208-692-6130

260

Course 915: Gentran Integration Suite: Fundamentals

Course Wrap Up

Gentran Integration Suite Training Tracks


Our training tracks explain the progression of courses. Prerequisites must be completed first. All Core courses must be completed by one or more members of your organization to gain full product competency. Note: *Onsite = taught at the customers facility.

Gentran Integration Suite Training Tracks


Course Name EDI End User 010-W Electronic Commerce Essentials Classroom (Onsite* Only) or Webcast 040-W XML Essentials Classroom (Onsite* Only) or WebCast 915 Gentran Integration Suite Fundamentals Classroom 936 Gentran Integration Suite Data Mapping and EDI Processing Classroom 938 Gentran Integration Suite JDBC Mapping and Processing Classroom 923 Gentran Integration Suite Advanced Business Process Modeling Classroom 933-W Gentran Integration Suite Communications (FTP) WebCast 935-W Gentran Integration Suite Communications (AS2) WebCast 1/2 day Optional 1/2 day Optional 2 days Optional 3 days Optional 5 days Required (1 day) or 1/2 day (1 day) or 1/2 day 5 days Required Required Required Duration Required? Optional

System Administrator 010-W Electronic Commerce Essentials Classroom (Onsite* Only) or Webcast 040-W XML Essentials Classroom (Onsite* Only) or WebCast 915 Gentran Integration Suite Fundamentals Classroom (1 day) or 1/2 day (1 day) or 1/2 day 5 days Required Required Required

Course 915: Gentran Integration Suite: Fundamentals

261

Course Wrap Up

Gentran Integration Suite Training Tracks


Course Name System Administrator - Cont 931 Gentran Integration Suite Administration and Tuning Classroom 923 Gentran Integration Suite Advanced Business Process Modeling Classroom 919 Gentran Integration Suite Interoperability (Connect:Direct) Classroom (Onsite* Only) 920 Gentran Integration Suite Interoperability (Connect:Enterprise) Classroom (Onsite* Only) 933-W Gentran Integration Suite Communications (FTP) WebCast 935-W Gentran Integration Suite Communications (AS2) WebCast 940-W Gentran Integration Suite Communications: Advanced File Transfer WebCast 1/2 day Optional 1/2 day Optional 1/2 day Optional (1 day) Optional (1 day) Optional 2 days Optional 3 days Required Duration Required? Optional

Connect: Direct End User 010-W Electronic Commerce Essentials Classroom (Onsite* Only) or Webcast 040-W XML Essentials Classroom (Onsite* Only) or WebCast 915 Gentran Integration Suite Fundamentals Classroom 919 Gentran Integration Suite Interoperability (Connect:Direct) Classroom (Onsite* Only) 933-W Gentran Integration Suite Communications (FTP) WebCast 935-W Gentran Integration Suite Communications (AS2) WebCast 940-W Gentran Integration Suite Communications: Advanced File Transfer WebCast 1/2 day Optional 1/2 day Optional 1/2 day Optional (1 day) Optional (1 day) or 1/2 day (1 day) or 1/2 day 5 days Required Required Required

262

Course 915: Gentran Integration Suite: Fundamentals

Course Wrap Up

Gentran Integration Suite Training Tracks


Course Name Connect: Enterprise End User 010-W Electronic Commerce Essentials Classroom (Onsite* Only) or Webcast 040-W XML Essentials Classroom (Onsite* Only) or WebCast 915 Gentran Integration Suite Fundamentals Classroom 920 Gentran Integration Suite Interoperability (Connect:Enterprise) Classroom (Onsite* Only) 933-W Gentran Integration Suite Communications (FTP) WebCast 935-W Gentran Integration Suite Communications (AS2) WebCast 940-W Gentran Integration Suite Communications: Advanced File Transfer WebCast 1/2 day Optional 1/2 day Optional 1/2 day Optional (1 day) Optional (1 day) or 1/2 day (1 day) or 1/2 day 5 days Required Required Required Duration Required? Optional

Course 915: Gentran Integration Suite: Fundamentals

263

Course Wrap Up

Support on Demand
Support Via the Web
Support On Demand is the doorway to Sterling Commerce Web support. Support On Demand provides ways for you to obtain product information and take part in information exchange. It also allows you to complete solution searches, report an issue, become a part of our subscription service, learn about workshops and find product documentation.

Support On Demand New Users Forum for Sterling Commerce Education


We are now offering customers, post-training, user-to-user message exchange where tips, tricks, and techniques can be shared online. Forums Include: Connect: Direct Connect: Enterprise E-Commerce/EDI/XML Courses Gentran Integration Suite Gentran: Basic for zSeries Gentran: Director Gentran: Server for iSeries Gentran: Server for UNIX Gentran: Server for Windows Sterling Distributed Order Management Sterling Networked Warehouse Management This Support on Demand feature is FREE to all customer who have attended training. Log on to Support on Demand and follow the ling for the User Forum. Go to http://support.sterlin

264

Course 915: Gentran Integration Suite: Fundamentals

Course Wrap Up

Course Evaluation
Completing the Evaluation
To ensure that the Gentran Integration Suite Fundamentals course is as effective as possible and meets the needs of our customers, we need your feedback.\ Please complete the on-line course evaluation found at: http://education.sterlingcommerce.com/TP2003/tp2000web.dll/TP2003 1. Log into the LMS using your email address and password. 2. Find your transcript for the Gentran Integration Suite 915 course. 3. Open the class details. 4. Launch the course evaluation. Thank you for your input.

Lesson Recap
Completed Objectives
You should now be able to:

Locate additional help. Determine additional Gentran Integration Suite training needs. Complete the course evaluation.

Course 915: Gentran Integration Suite: Fundamentals

265

Course Wrap Up

Additional Training
Course Offerings
We recommend that you take the following training courses to most effectively use Gentran Integration Suite.
Take this course 915 Gentran Integration Suite Fundamentals To learn about The Gentran Integration Suite Fundamentals course introduces you to the Gentran Integration Suite application, the Graphical Process Modeler (GPM), and the Map Editor. You will create a business process in the GPM, set up trading profiles, and monitor the health of your Gentran Integration Suite system. The Gentran Integration Suite Interoperability (Connect:Direct) course introduces you to the tasks to connect Gentran Integration Suite with Connect:Direct. You will learn about the components in Gentran Integration Suite and Connect:Direct and how to configure and manage each software application to pass data to each other. The Gentran Integration Suite Interoperability (Connect:Enterprise) course introduces you to the concepts and components to establish communication between Gentran Integration Suite and Connect:Enterprise. You will learn the requirements, configurations, and business processes necessary for Gentran Integration Suite and Connect:Enterprise to communicate with each other along with how to track activities between the two software applications and troubleshooting techniques. The Gentran Integration Suite Advanced Business Process Modeling Language course introduces you the advanced options available within the Graphical Process Modeler. Learn how to use a database in data routing, read configuration values from a flat file and convert the parameters into Xpath. Get further value from training as you apply advanced solutions to really life examples. This course is intended for an intermediate to advanced Gentran Integration Suite user. The Gentran Integration Suite Administration and Tuning course guides you through managing user accounts, designing dashboard themes for these various user accounts, tuning business processes and the Gentran Integration Suite server to meet your system performance requirements. You will also learn about sizing performance problems and the tools to monitor and diagnose these problems.

919 Gentran Integration Suite Inter-operability (Connect:Direct)

920 Gentran Integration Suite Inter-operability (Connect Enterprise)

923 Gentran Integration Suite Advanced Business Process Modeling Language

931 Gentran Integration Suite Administration and Tuning

266

Course 915: Gentran Integration Suite: Fundamentals

Course Wrap Up

Take this course 933 Gentran Integration Suite Communications: FTP

To learn about The Gentran Integration Suite Communications (FTP) course introduces you to the Gentran Integration Suite Mailbox, FTP Server adapter, digital certificates, and trading partner profiles. You will configure the mailbox, the FTP Server adapter, and digital certificates so that you can securely trade data with your trading partners using FTP. The Gentran Integration Suite Communications (AS2) introduces you to the Gentran Integration Suite AS2 Edition, digital certificates, trading partner configuration, and the Gentran Integration Suite Mailbox. You will configure organization and trading partner information and manage documents exchange using use Gentran Integration Suite AS2 Edition. In addition, you will learn how Gentran Integration Suite and the Gentran Integration Suite AS2 Edition work together to securely send documents to your trading partner using AS2. The Gentran Integration Suite Data Mapping and EDI Processing course introduces you to the Map Editor, mapping, and the Graphical Process Modeler (GPM). You will create maps and business processes and also process data to trade with your trading partners. The Gentran Integration Suite JDBC Mapping and Processing course will guide you through mapping EDI data with a JDBC-compliant database. You will create, test, and administer JDBC-compliant maps. In addition, you will run a JDBC-compliant map in a business process. The Gentran Integration Suite Communications: Advanced File Transfer course introduces you to the advanced file transfer concept and terminology. You will learn how to create partners, communities, and Pretty Good Privacy profiles. In addition, you will learn how to set up the PGPCmdline.

935 Gentran Integration Suite Communications: AS2

936 Gentran Integration Suite Data Mapping and EDI Processing

938 Gentran Integration Suite JDBC Mapping and Processing

940-W Gentran Integration Suite Communications: Advanced File Transfer WebCast

Course 915: Gentran Integration Suite: Fundamentals

267

Course Wrap Up

Contratulations! You have completed the Gentran Integration Suite Fundamentals course!

268

Course 915: Gentran Integration Suite: Fundamentals

Appendix A

Process Generation

Business Process Generation


The diagram on the next page shows an example of a business process generation.

Course 915: Gentran Integration Suite: Fundamentals

269

Appendix A Process Generation

Business Process Generation


1
Create .MAP and compile .TXO or .LTX

1
Install Adapter

Check in .MAP and .TXO or .LTX

Configure a Service Adapter

Service Configuration Name Map Name

4 5

Create .BP

6 5a

Check in .BP Execute .BP with an Input file Monitor .BP

270

Course 915: Gentran Integration Suite: Fundamentals

Appendix B

GIS Trading Partner Set Up

This lesson provides activities used to create and work with trading partners.

Introduction
Lesson Objectives
By the end of this lesson, you should be able to: Set up a Trading Partner for EDI. Create a contract. Manage trading partner records. Explain how document envelopes enable organizations to exchange documents. Create and manage document envelopes.

Course 915: Gentran Integration Suite: Fundamentals

271

Appendix B GIS Trading Partner Set Up

About Trading Partner Profiles


Trading Partners
A trading partner is an organization with whom your organization conducts e-business. Gentran Integration Suite must have certain information about organizations in order to automate exchanging business documents with them. Gentran Integration Suite stores this information in a trading partner profile. To conduct e-business, you must first set up a trading profile for every trading partner participating in the business process, including your organization. You can then create a business process that describes e-business transactions and execute the business process. The following diagram illustrates the GIS Trading Partner Set Up:

Notes:

272

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Trading Profiles
A trading partner profile is a collection of records that describe the technology and business capabilities of a trading partner to engage in electronic business with other trading partners. The trading profile: Links the trading partner with the business processes created to process the documents in Gentran Integration Suite. Describes the of a trading partner in those business processes as a producer of messages, consumer of messages, or both. Determines what documents are allowed into or out of Gentran Integration Suite. After setting up a trading partner, you need to create a business process that meets your business contractual requirements and those of your trading partners. When implementing business processes, consider that you need to use at least one of the preinstalled, preconfigured B2B services.
Note: To build or parse cryptographically enhanced EDIINT AS1 or AS2 messages, include the EDIINT Message service in your business process.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

273

Appendix B GIS Trading Partner Set Up

Trading Partner Menu


In Gentran Integration Suite, use the Trading Partners console to create and manage trading partner profiles. The following table describes each Trading Partner menu and the records accessible from each. Collectively, these records make up a trading partner profile.
Trading Partner Menu Setup Description of Records The setup menu enables you to create and manage trading partners. The records you can access from the Setup menu are: Basic - Use this page to create a new trading partner Advanced - Use this page to create:

Identities Name and description of the trading partner and information referenced by Gentran Integration Suite when it executes a business process involving the trading partner. Transports The message transport method used by Gentran Integration Suite to communicate with trading partners. Document Exchange The properties of the documents and messages passed between trading partners, including a trading partners selected messaging services and message envelopes. Delivery Channels The link between a document exchange record and a transport record. The combination of these two records provides a complete description of how a trading partner receives documents. Packaging The kind of envelope or document packaging used by the partner. Profile A collection of records that describe the technology and business capabilities of a trading partner to engage in e-business with other trading partners.

AS2 - Use this page to create GIS AS2 profiles and list all existing profile configurations. Digital Certificates Create, check in, locate, or list alphabetically digital certificates, which are specially formatted documents that authenticate or identify you to a Web browser, e-mail reader, or a secure server. Certificate options include:


Notes:

CA (Certificate authority) Trusted System

274

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Trading Partner Menu Document Envelopes Contracts

Description of Records Create a new envelope or control number and locate an envelope or a control number based on specified criteria. Agreements between trading partners detailing the terms and conditions about how to conduct business transactions. A single trading partner can be associated with more than one contract. From the contract page, you can:

create a new contract search for a contract list all contracts or list specific contracts based on the first letter of the contract name.

Note: The contract record is similar to a Collaboration Protocol Agreement (CPA) in ebXML. Code List A trading partner code list consists of one or many pairs of code values containing a sender code and a receiver code. Each code pair has one description and up to four additional codes relating to the pair. The Code List page enables you to create and locate a code list. Use this page to:


Help

create a new code list search for a code list list all code lists or list specific code lists based on the first letter of the code list name.

Provides on-line help for Gentran Integration Suite.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

275

Appendix B GIS Trading Partner Set Up

About Trading Partner Records


To set up a trading profile in Gentran Integration Suite, you need to create the following collection of records: Identity Transport Document exchange Delivery channel Packaging Profile

Identity Record
In Gentran Integration Suite, every trading partner is represented with at least one record, called an identity. An identity describes the trading partner and contains information referenced by Gentran Integration Suite when it executes a business process involving the trading partner. A trading partner can have more than one identity to represent the different ways it does business. For example, a companys central office procurement organization might be radically different from its manufacturing supplies procurement organization. In such cases, a separate identity record would be created for each organization. A base identity is a regular identity that you can use as a starting point to create a new identity. The base identity maintains a link to the identity that inherited its properties. If you modify the base identity, all related identities (ones that inherited the base identity properties) change, as well. When you create an identity using a base identity, everything in the new identity is the same as in the base identity, except the identity name, description, and other unique parameters, such as unique identification numbers.
Note: If you plan to create many identities using the base identity, do not use the base identity in production. Record the identities that are related to the base identity.

Notes:

276

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Transport Record
The Transport record describes the internet delivery protocol and security. Protocol choices are HTTP, FTP, or SMTP. In addition, the transport record details the use of the protocol, such as HTTP configured with SSL for secure data exchange.

Document Exchange Record


A document exchange record describes properties of the documents and messages passed between trading partners. These properties include the messaging services and message envelopes selected by a trading partner. For example, digital enveloping properties include the trading partner digital signature and encryption required when using the SMIME protocol.

Delivery Channel Record


A delivery channel record links a document exchange record and a transport record. The combination of these two records provide a complete description of how a trading partner expects to receive documents. A delivery channel record eliminates the re-entry of document exchange information for every transport protocol.

Packaging Record
A packaging record describes the organization of a message and its contents, including: The message header or envelope that contains identifying metadata. The message body or payload that contains the business content. In addition, a packaging record provides details about protocol-specific security, as well as envelope fields like a MIME content type or an XML namespace. A packaging record can be shared among trading partners (identities).

Profile Record
A profile record is a type of document exchange that links a delivery channel and a packaging record to a business process created in Gentran Integration Suite.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

277

Appendix B GIS Trading Partner Set Up

Digital Certificates
A digital certificate is a vehicle for the management and distribution of public keys. It binds a public key to identity information about the owner of the key. A digital certificate contains a public key, identity information, and one or more signatures to provide a chain of verification and to prevent tampering. Gentran Integration Suite associates digital certificates with trading profiles and recognizes two types of digital certificates:

CA and trusted certificates - Certificates for which Gentran Integration Suite


does not have the private key. They are stored in standard DER format.

System certificates - Certificates for which Gentran Integration Suite maintains


the private key. They are stored with the private key in a secure format. For more information about digital certificates, see:

RSA, www.rsasecurity.com Verisign, www.verisign.com

Terminology
Public key cryptography is based on key pairs. A key pair contains a private key and a public key. Anything encrypted with one key can be decrypted only with the other key. Keep private keys secret and publish public keys to those who want to send encrypted data or want to verify digital signatures. A digital signature is a cryptographic hash calculated over a block of data and then encrypted with the private key of a key pair. Anyone who has the public key in the key pair can use it to decrypt the hash and then independently calculate a hash over the data. If the results match, the signature verifies. Assuming that the private key is known only to its owner, a matching hash also authenticates the signer. Digital certificates can be self-signed or CA-signed.

A self-signed certificate is signed with the private key that corresponds to the
public key in the certificate, demonstrating that the issuer has the private key that corresponds to the public key in the certificate.

CA-signed certificates are signed using keys maintained by certificate authorities.


Before issuing a certificate, the CA typically evaluates a certificate requestor to

Notes:

278

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

determine that the requestor is in fact the certificate holder referenced in the certificate. A CA certificate is a certificate issued by a certificate authority (CA), for verifying trusted certificates. A CA certificate contains a public key corresponding to the private key which the CA owns to sign certificates it issues. A CA certificate can be used to verify that a trusted certificate was issued by a certain CA. The CA certificate can also verify that the trusted certificate has not been altered. Gentran Integration Suite stores CA certificates separately from trusted certificates.
Note: Although CA certificates are public documents, you should be careful about who has rights to add them to Gentran Integration Suite. Someone could maliciously add a false CA certificate in order to verify false end-user certificates.

Trusted certificates are end-user certificates that are trusted by Gentran Integration Suite. Generally, Gentran Integration Suite users receive trusted certificates from their trading partners. System certificates are certificates for which the user has the private key in Gentran Integration Suite. Gentran Integration Suite users use private keys to sign and decrypt documents. For this lesson we will create a Self-Signed Certificate.
Note: For more information relating to Digital Certificates, refer to the Sterling Integrator Trading Partner Guide or Appendix C of the Gentran Integration Suite course 915 Participant Guide.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

279

Appendix B GIS Trading Partner Set Up

Converting Trading Partner Envelope Information


Gentran Integration Suite provides utilities to convert information about trading partners from Gentran:Server UNIX versions 5.3 and 6.0, Gentran:Server Windows version 3.2 or later, and Gentran:Basic for OS/390 version 6.0 to an XML format that Gentran Integration Suite recognizes. After converting trading partner information and creating an XML file, you can then import the XML file into Gentran Integration Suite. Gentran Integration Suite supports the following records containing information about trading partners: Standard to application or XML Conversion generates an inbound envelope and an outbound acknowledgment envelope, if necessary. Application or XML to standard Conversion generates an outbound envelope and an outbound acknowledgment envelope, if necessary. Standard to standard Conversion generates an inbound envelope, an outbound envelope, and an outbound acknowledgment envelope, if necessary. The XML file that Gentran Integration Suite creates generates the following envelopes: EDIFACT (Inbound and Outbound) and Outbound acknowledgment UNH/UNT Syntax 4:

UNG/UNE Syntax 4 UNB/UNZ Syntax 4


X12 (Inbound and Outbound) and Outbound acknowledgment:

ST/SE GS/GE ISA/IEA


CII (Center for Informatization of Industry) (Inbound and Outbound) TRADACOMS and Outbound acknowledgement:

STX/END (Inbound and Outbound) MHD/MTR (Outbound only)

Notes:

280

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Before You Begin


Before you set up a trading profile: Create and/or Check in digital certificates for the secure transport of data. (If used) At a high-level, you need collect and prepare the following information about your organization and trading partners:

Trading partner name and address information Sending/receiving protocols and settings IP addresses and port numbers Enveloping properties Passwords

Setting Up a Trading Profile


Setup Options
The Trading Profile menu provides the following setup options that enable you to create the records that make up the trading profile. Setup menu options are: Basic Consolidates the configuration properties of all the records that make up a trading profile and provides them in a central area. Advanced Lists all the records individually for configuration. AS2 Provides records specific to configuring a trading profile for an AS2 trading partner.

Setting Up a Trading Profile: Basic


To simplify the process of setting up a trading profile, the pages that comprise the Basic option take you through the following processes: Configuring contact information Enables you to provide contact information about your trading partner. Configuring communications and document exchange Enables you to set up communication properties to exchange documents with your trading partner.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

281

Appendix B GIS Trading Partner Set Up

Setting Up a Trading Profile: Advanced


To set up a trading profile in Gentran Integration Suite, you MUST individually create the following records: Identity Transport Document exchange Delivery channel Packaging

Creating an Identity Record


You must create an identity before you can create a transport, document exchange, delivery channel, packaging, profile, or contract. Each of these components reference an identity. Also, you must have information about the trading partner, such as the address of the trading partner, before you can create an identity for the trading partner with Gentran Integration Suite.

Notes:

282

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Exercise - Trading Profile: Advanced

Creating an Identity Record


1. From the Gentran Integration Suite Trading Profile menu, select Setup > Advanced > Identities. 2. Next to Create New Identity, click Go! 3. On the New Identity: Base Identity page, click Next. The Select Base Identity field will be blank as we do not have any existing partners setup. NOTE: To create an identity record that inherits all the components of an existing trading profile, select an identity record from Base Identity list, and click Next. 4. On the New Identity: Information page, complete the following fields as appropriate and click Next:
In this field Name Reference URL DUNS Enter or select... SCI 127.0.0.1 123456789 Description, Tips, Guidelines Name for the identity record to create for this trading profile. Required. Uniform Resource Locator (URL) is the Internet address of the trading partner. Optional. Data Universal Numbering System (DUNS) is a unique nine-character company identification number issued by Dun & Bradstreet Corporation. Optional. Primary ID of this identity record. It could be a DUNS number, EDI interchange ID, e-mail address, or another unique string. Gentran Integration Suite use the identifier to identify the trading partner for message protocols like AS2. Required. Conventional mailing address of the trading partner organization. Required.

Identifier

kit.gato@SCI.com

Address

123 Sterling Way

Notes:

Course 915: Gentran Integration Suite: Fundamentals

283

Appendix B GIS Trading Partner Set Up

In this field City State or Province Zip or Postal Code Email Address Telephone Number Time Zone Country

Enter or select... Columbus OH 43211 kit.gato@SCI.com (614) 867-5309 (GMT-05:00) Eastern Time (US & Canada) United States

Description, Tips, Guidelines City where the trading partner is located. Required. State where the organization of the trading partner represented by the identity is located. Required. ZIP Code or postal code where the trading partner is located. Required. Email address of the trading partners key contact. Optional. Phone number of the trading partner organizations key contact. Optional. Time zone where the trading partner is located. Optional. Country where the trading partner is located. Optional.

5. Verify that the information you entered is correct and click Finish to add the identity to Gentran Integration Suite. 6. Click Return to be returned to the Identity page. Our next step will be to create a Self-Signed Certificate

Notes:

284

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Creating a Self-Signed Certificate


Gentran Integration Suite enables you to create your own certificates. When you create a self-signed certificate, Gentran Integration Suite generates a key pair and embeds the public key from the key pair in the certificate. The private key and associated certificate are stored securely in an encrypted format. For this Lesson, we will call ourselves MaxxMart, we are the originator of the Self-Signed Certificate. Our Trading Partner is SCI. To create a self-signed certificate: 1. From the Trading Partner menu, select Digital Certificates > System. 2. Next to Create Self-Signed Certificate, click Go! 3. Complete the fields with the following values and click Next:
In this field Name Enter or select... ForSCI Description, Tips, Guidelines

The name of the self-signed certificate. This must be a unique and meaningful name. The name of the originating organization. The country or origin of the self-signed certificate. Email address of the person responsible for certificates in the organization.

Organization Country Email

MAXXMART United States

urname@ maxxmart.com

4. Complete the fields with the following values and click Next:
In this field Serial Number Enter or select... 1234 Description, Tips, Guidelines

The serial number is whatever number you want to assign to the self-signed certificate. The number of days that the self-signed certificate is valid.

Duration

365

Notes:

Course 915: Gentran Integration Suite: Fundamentals

285

Appendix B GIS Trading Partner Set Up

In this field Key Length

Enter or select... 1024

Description, Tips, Guidelines

The key length 1024 provides a good balance between security, inter-operability, and efficiency. The key length 2048 is the most secure, but also the slowest, and may not work with some applications Choose 1, both, or none:

Validate When Used

Validity

Validity Verifies dates in the validity period


of the certificate are still in effect. If the dates are not in effect, the certificate is not used.

Auth Chain Constructs a chain of trust for


certificates that are not self-signed. If a chain of trust cannot be constructed using valid certificates, the certificate is not used. If the certificate is self-signed, this option verifies only the certificate signature.

5. In the Confirm page, verify the information about the self-signed certificate you are checking in and click Finish to check the self-signed certificate in to Gentran Integration Suite. 6. Click Return to be returned to the System Certificates page. You are now ready to create a Transport record.

Notes:

286

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Creating a Transport Record


Each identity can have more than one transport record because you can communicate with a given trading partner using multiple protocols. When an identity has more than one transport record, you must create a corresponding profile record. To create a transport record: 1. From the Gentran Integration Suite Trading Profile menu, select Setup > Advanced > Transports. 2. Next to Create New Transport, click Go! 3. On the New Transport: Information page, complete the following fields and click Next:
.

In this field Name Identity

Enter or select... SCIXport SCI

Description, Tips, Guidelines Name for the transport record to create for this trading profile. Required. Links this transport protocol to the identity record. It must match the Name field of the identity record. Required.

4. On the Communications page, complete the following fields as appropriate and click Next:
In this field Receiving Protocol Sending Protocol End Point IP End Point Port Enter or select... HTTP Description, Tips, Guidelines Communications protocol supported by this transport when receiving data. Valid values are FTP, HTTP, and SMTP. Required. Communications protocol supported by this transport when sending data. Valid values are FTP, HTTP, SMTP, and blank. Optional. Address on your companys server. Valid value is a valid IP address. Optional. Port that your server monitors for incoming sessions. Valid value is a valid port number. Optional.

HTTP

10.251.39.59 6000

Notes:

Course 915: Gentran Integration Suite: Fundamentals

287

Appendix B GIS Trading Partner Set Up

5. On the Communications: End Point Settings page, complete the following fields and click Next:
In this field End Point Enter or select... http://127.0.0.1:9000/ b2bhttp/inbound/AS2 Description, Tips, Guidelines End point at the trading partner. HTTP address of the transport. It can be a URL. For AS2, the end point must be the complete URL to send messages. Required. Note: Your trading partner will supply the End Point information. End Point Type All Purpose Purpose of this end point. Required. Valid values are:

Login Address where the initial HTTP session is established. Request Address to which HTTP request messages are sent. Response Address to which response messages are sent. Error Address to which HTTP error messages are sent. All Purpose End port can be used for login, request, response, or error messages.

6. On the Communications: Protocol Settings page, complete the following fields as appropriate and click Next:
In this field Response Timeout (seconds) Firewall Proxy Enter or select... 60 Description, Tips, Guidelines Number of seconds to wait for remote response to an outbound queue. Used for outbound sessions. Valid value is number of seconds. Zero (0) indicates wait indefinitely (default). Optional. IP address, port number, login ID, and password of the remote firewall. Separate values with a comma. If used, you must specify both login ID and password. Used for outbound sessions. Optional.

10.27.4.5,10000, My_ID,My_PWD

Notes:

288

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

In this field Firewall Connect Count (seconds) Socket Timeout (seconds)

Enter or select... 10

Description, Tips, Guidelines Number of seconds that Gentran Integration Suite attempts to contact the transports port address before timing out. Optional. Number of seconds to wait for remote response to a command. Valid value is any positive number that is optimal for your system. Zero (0) indicates wait indefinitely (default). Optional.

30

7. On the Communications: Security page, complete the following fields as appropriate and click Next:
In this field SMIME Encryption User Certificate SSL Enter or select... None Available Description, Tips, Guidelines Encryption certificate of the trading partner. This certificate is also used by the EDIINT Message service as the certificate to encrypt messages. Whether Secure Sockets Layer (SSL) should be active. Valid values are:

None

None SSL is not used by the transport. Optional FTP handles SSL encryption appropriately if present. Must Transport uses this protocol configured for SSL encryption (default).

Note: If Optional or Must is specified, the asset protection key must enable SSL for the appropriate protocol. Required. Key Certificate Passphrase leave blank Password that protects the server key certificate. Required if SSL option is anything other than None.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

289

Appendix B GIS Trading Partner Set Up

In this field Cipher Strength

Enter or select... ALL

Description, Tips, Guidelines Strength of the algorithms used to encrypt data. Optional. Valid values are:


Key Certificate ForSCI

ALL WEAK Often required for international e-commerce, because government regulations prohibit STRONG encryption from being exported. STRONG Required if SSL option is anything other than None (default).

Private key and certificate for the component. Used to encrypt and decrypt messages. Required if SSL option is anything other than None. Also used by the EDIINT Message service as the key for decrypting encrypted messages. Certificate used to validate the certificate of the trading partner. This is the public key. Required if the SSL option is set to Must or Optional.

CA Certificates

None Available

8. On the Protocol Mode page, complete the following fields and click Next:
In this field Protocol Mode Enter or select... Put Description, Tips, Guidelines Mode or method that will be used by the protocol (FTP). Valid values are:


Document leave blank

PUT - Send data to the remote party when making an FTP connection. GET - Receive data from the remote party.

Only applies when using FTP protocol. Document to be retrieved for selected protocol mode. If mode is GET, can leave the field blank. Optional if PUT is selected. Note: If you selected GET as the protocol mode, ensure the document you specified exists on the remote trading partner FTP server

Notes:

290

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

9. On the Transport Account page, complete the following fields and click Next:
In this field User ID Password Enter or select... leave blank leave blank Description, Tips, Guidelines Unique ID associated with a transport account. Required for FTP. Password that authenticates the user ID to the system. Required for FTP.

10. Verify that the information that you entered is correct and click Finish to update the transport record. 11. Click Return to be returned to the Transports page. You are now ready to create a Document Exchange record.

Creating a Document Exchange Record


To describe properties of the documents and messages passed between trading partners, you must create a document exchange record. To create a document exchange record: 1. From the Gentran Integration Suite Trading Profile menu, select Setup > Advanced > Document Exchange. 2. Next to Create New Document Exchange, click Go! 3. On the New Document Exchange: Information page, complete the following fields and click Next:
In this field Name Identity Enter for select... Description, Tips, Guidelines SCIDocXchg SCI Name for the document exchange record to create for this trading profile. Required. Unique ID associated with the identity that links this document exchange record to the identity record. The ID must match the Name field of the identity record. Required.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

291

Appendix B GIS Trading Partner Set Up

4. On the Retry Settings page, complete the following fields and click Next:
In this field Number of Retries Retry Interval (seconds) Enter or select... 10 Description, Tips, Guidelines Number of times that Gentran Integration Suite tries to contact the trading partner before timing out. Zero (0) is invalid. Required. Number of seconds that Gentran Integration Suite waits before trying again to contact the trading partner after the previous attempt timed out. Zero (0) is invalid. Required. Number of seconds that a message received by Gentran Integration Suite is kept before being passed to the integration engine. Zero (0) is invalid. Required.

30

Persist Duration (seconds)

5. On the Enveloping Properties page, complete the following field and click Next:
In this field Protocol Enter or select NONE Description, Tips, Guidelines Used only by the EDIINT Message service. The security protocol to be used. Valid values are SMIME and NONE (default). Required.

Note: If SMIME is entered, the Enveloping Properties: Security page appears for encryption and certificate information.

6. Verify that the information that you entered is correct and click Finish to add the Document Exchange record to Gentran Integration Suite. 7. Click Return to be returned to the Document Exchange page. You are now ready to create a Delivery Channel.

Creating a Delivery Channel Record


You can define several Delivery Channels in one trading partner profile, for example, one for inbound and another for outbound. To create a Delivery Channel record:
Notes:

292

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

1. From the Gentran Integration Suite Trading Profile menu, select Setup > Advanced > Delivery Channels. 2. Next to Create New Delivery Channel, click Go! 3. On the New Delivery Channel: Information page, complete the following fields and click Next:
In this field Name Identity Enter or select... SCIDelChan SCI Description, Tips, Guidelines Name for the delivery channel record to create for this trading profile. Required. Unique ID that links the delivery channel to the identity record. It must match the Name field of the identity record. Required.

4. On the Channel Definition page, complete the following fields and click Next:
In this field Transport Enter or select... SCIXport Description, Tips, Guidelines Name of the transport that links this delivery channel to the transport records. It must match the Transport Name field of the transport record. Required. Name of the document exchange associated with this delivery channel. It must match the Document Exchange Name field of the document exchange record. Required.

Document Exchange

SCIDocXchg

Notes:

Course 915: Gentran Integration Suite: Fundamentals

293

Appendix B GIS Trading Partner Set Up

5. On the Security page, complete the following fields and click Next:
In this field Sync Reply Mode Enter or select NONE Description, Tips, Guidelines Relates to MDN.

What the receiving application expects in a response when bound to a synchronous communications protocol such as HTTP. RequuTP. (Sy)-4(n)-6 m540.1(4(l)0.60 Tw[J/T4

Notes:

294

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

In this field Authorized

Enter or select No

Description, Tips, Guidelines Whether the message sender must be authorized (granted access to a network resource) before the message can be delivered to the application. Valid values are Yes and No. Required.

6. On the Delivery Settings page, complete the following fields as appropriate and click Next:
In this field Receipt Type Enter or select MDN Description, Tips, Guidelines Used only by the EDIINT Message service. The type of receipt to request. Valid values are MDN (Message Disposition Notification) and NONE (default). Used only by the EDIINT Message service. The type of signing algorithm requested on receipts.Valid values are None, MD5, and SHA1. Selection of a value other than None makes the EDIINT Message service request a signed MDN (Message Disposition Notification) when building messages to the trading partner. Timeout value for receipt of expected MDNs, in seconds. Required. Used only by the EDIINT Message service. Required. Valid values are:

Receipt Signature Type

SHA1

Receipt Timeout Delivery Mode

3600 Synchronous

Synchronous Used for AS2 only when you want a synchronous receipt. Asynchronous HTTP Used for AS2 only when you want an asynchronous receipt. Asynchronous HTTPS Used for AS2 only when you want an asynchronous receipt. Asynchronous SMTP Used for AS1 and AS2 when you want an asynchronous receipt.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

295

Appendix B GIS Trading Partner Set Up

In this field Receipt to Address

Enter or select leave blank

Description, Tips, Guidelines Used only by the EDIINT Message service. Indicates where a receipt should be sent if it is not going to the e-mail address in the associated identity. Optional. If you are using EDIINT AS2 requesting asynchronous MDNs, you must type the complete URL where you want the message to be sent.

7. Verify that the information that you entered is correct and click Finish to add the Delivery Channels record to Gentran Integration Suite. 8. Click Return to be returned to the Delivery Channels page. You are now ready to create a Packaging Record.

Creating a Packaging Record


Identities can share packaging components. An identity can have more than one packaging component. To create a Packaging Record: 1. From the Gentran Integration Suite Trading Profile menu, select Setup > Advanced > Packaging. 2. Next to Create New Packaging, click Go! 3. On the New Packaging: Information page, complete the following fields and click Next:
In this field Name Message Parsable Enter or select... SCIPkg Yes Description, Tips, Guidelines Name for the packaging record to create for this trading profile. Required. Whether the message can be parsed. Valid values are Yes and No. Required.

Notes:

296

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

4. On the Packaging Settings page, complete the following fields and click Next:
In this field Payload Type Enter or select... Signed Detached Encrypted Description, Tips, Guidelines Used only by the EDIINT Message service to create EDIINT messages. The payload is the document at the inner level of the message. The payload type describes the message format for transporting documents. Valid values are:

Plain Text Payload is not signed and it is not encrypted. Signed Detached Payload is signed with a detached signature, according to the EDIINT specifications. Encrypted Payload is encrypted according to the EDIINT specifications. Signed Detached Encrypted Payload is signed with a detached signature and then encrypted, according to the EDIINT specifications.

MIME Type

Application

Used only by the EDIINT Message service. Indicates how to package the lowest level of payload content (the document at the inner level of a message) to be sent. Helps to implement the EDIINT specification correctly, and provides some flexibility, because receiving programs might expect a specified MIME type and sub-type. Required. Valid values are:

Text For XML or text Application For EDI, or any other type of data Message Audio Video Image

Notes:

Course 915: Gentran Integration Suite: Fundamentals

297

Appendix B GIS Trading Partner Set Up

In this field MIME Sub Type

Enter or select... EDI-X12

Description, Tips, Guidelines Used only by the EDIINT Message service. Indicates how to package the lowest level of payload content (the document at the inner level of a message) to be sent. Required. Valid values are:


Compress Data None

EDI-X12 EDIFACT EDI-Consent Octet-stream For any type of data XML Plain

Used only by the EDIINT Message service. Specifies whether the payload should be compressed. Valid values are None, Low, Medium, High, and Default.

5. Verify that the information you entered is correct and click Finish to add the Packaging Record to Gentran Integration Suite. 6. Click Return to be returned to the Packaging page. You are now ready to create a Profile Record.

Creating a Profile Record


A profile links a Delivery Channel and Packaging Records of a trading partner profile to a business process created in Gentran Integration Suite. To create a Profile Record: 1. From the Gentran Integration Suite Trading Profile menu, select Setup > Advanced > Profiles. 2. Next to Create New Profile, click Go!

Notes:

298

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

3. On the New Profile: Information page, complete the following fields and click Next:
In this field Name Identity Enter or select... SCIProfile SCI Description, Tips, Guidelines Name for the profile record to create for this trading profile. Required. Unique ID that links this profile to the identity record. It must match the Name field of the identity record. Required.

4. On the Profile Definition page, complete the following fields and click Next:
In this field Profile Type Enter or select... EDI Description, Tips, Guidelines Type of processing that Gentran Integration Suite should complete for data exchanged for this trading profile. Required. Valid values are:


GLN Delivery Channel Packaging leave blank SCIDelChan

EDI AS1 AS2 RN RosettaNet

Global location number of this trading partner. Optional. Unique ID that links this profile to the delivery channel record. It must match the Name field of the delivery channel record. Required. Unique ID that links this trading profile to the packaging record. It must match the Name field of the packaging record. Required. Any third-party service provider name. Required.

SCIPkg

Provider

STERLING INFORMATION BROKER

Notes:

Course 915: Gentran Integration Suite: Fundamentals

299

Appendix B GIS Trading Partner Set Up

5. On the Business Processes page, complete the following fields and click Next:
In this field Send Respond Request_Response Enter or select... Not Applicable Not Applicable Not Applicable Description, Tips, Guidelines Profile associated with message consumer. Profile associated with the message producer. Profile associated with the message producer.

To enable the Gentran Integration Suite predefined business process (default) to communicate with the trading partner for the specified mode, ensure that Not Applicable is selected from the appropriate message mode list or lists.
Note: To communicate with a trading partner, the business process should include the B2B Send, B2B Respond, or B2B Request-Response service.

6. Verify that the information that you entered is correct and click Finish to add the Profile Record to Gentran Integration Suite. 7. Click Return to be returned to the Profiles page. You are now ready to create a Contract but first we must set up a BasicTrading Partner Profile for our customer MaxxMart.

Notes:

300

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Exercise - Set up a Profile for MaxxMart

To create a contract both parties must be defined as trading partners. In this exercise we use the Basic setup option to create a trading partner profile for MaxxMart. 1. From the Gentran Integration Suite Trading Partner menu, select Setup > Basic. 2. Under Create, next to New Trading Partner, click Go! 3. Complete the following fields as appropriate on the New Trading Partner: Partner page and click Next:
In this field Select Identity Enter or select... New Description, Tips, Guidelines How to create an identify record. Required. Valid values are:


Identity blank

Existing Copy and use the properties defined for an existing trading partner to create the identity record. New Add properties to create the identify record.

Trading partner from which to copy properties. Required if you selected Existing from Select Identity. Name of the trading partner for which you are creating the identity record. Required. Primary ID that identifies this trading partner. It could be a DUNS number, EDI interchange ID, e-mail address, or another unique string. Conventional mailing address of this trading partner organization. Required. City where this trading partner is located. Required.

Name Identifier

MAXXMART urname@maxxmart. com 1600 Lakehurst Ct Dublin

Address Line 1 City

Notes:

Course 915: Gentran Integration Suite: Fundamentals

301

Appendix B GIS Trading Partner Set Up

In this field State or Province

Enter or select... Ohio

Description, Tips, Guidelines State where the organization of this trading partner represented by the identity is located. Required. ZIP Code or postal code where this trading partner is located. Required. Country where this trading partner is located. Required.

Zip or Postal Code Country

43016 United States

4. Complete the following fields as appropriate on the New Trading Partner: Profile page and click Next:
In this field Profile Name Profile Type Enter or select... MaxxmartProfile EDI Description, Tips, Guidelines Name for the profile record to create for this trading partner. Required. Type of processing that Gentran Integration Suite should complete for data exchanged for this trading partner. Required. Valid values are:


GLN Select Delivery Channel leave blank New

EDI AS1 AS2

Global location number of this trading partner. Optional. How to create a new delivery channel record. Required. Valid values are:


Delivery Channel none available

Existing - Copy and use the properties defined for an existing delivery channel to create the new identity. New - Add properties to create the new delivery channel.

Delivery channel from which to copy properties. Required if you selected Existing from Select Identity.

Notes:

302

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

In this field Name

Enter or select... MaxxmartDelChan

Description, Tips, Guidelines Name of the delivery channel record to create for this trading partner. Required.

5. Complete the following fields as appropriate on the New Trading Partner: Profile: Communications page and click Next:
In this field Select Transport Enter or select New Description, Tips, Guidelines How to create the transport record. Required. Valid values are:


Transport none available

Existing Copy and use the properties defined for an existing trading partner to create the transport record. New Add properties to create the transport record.

Trading partner from which to copy properties. Required if you selected Existing from Select Transport. Name for the transport record to create for this trading partner. Required. Communications protocol supported by this transport when sending data. Valid values are FTP, HTTP, SMTP, and blank. Optional. Address where you can contact the server. Valid value is a valid IP address. Required for HTTP. Port that the server monitors for incoming sessions. Valid value is a valid port number. Required for FTP.

Name Sending Protocol

MaxxmartXport HTTP

End Point

127.0.0.1

End Point IP

leave blank

EndPoint Port Directory

leave blank leave blank Name of a directory on the server of the trading partner where outbound data is stored and awaits pickup by the trading partner. Used for outbound sessions. Required for FTP.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

303

Appendix B GIS Trading Partner Set Up

In this field Protocol Mode

Enter or select PUT

Description, Tips, Guidelines Mode or method that will be used by the protocol (FTP). Required for FTP. Valid values are:


Document leave blank

PUT Send data to the remote party when making an FTP connection (default). GET Receive data from the remote party.

Document to be retrieved if protocol mode is GET. Required if GET is selected. Optional if PUT is selected. Note: If you selected GET as the protocol mode, ensure the document you specified exists on the remote trading partner FTP server.

Mail Box Name From To User ID Password

leave blank leave blank leave blank leave blank leave blank

Mailbox name, alias, or ID number for a mail server. Required for SMTP. E-mail address of the sender. Required for SMTP. E-mail address of the receiver. Same as Mail To. Required for SMTP. Unique ID associated with a transport account. Required for FTP. Password that authenticates the user ID to the system. Required for FTP.

Notes:

304

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

6. Complete the following fields as appropriate on the New Trading Partner: Profile: Document Exchange page and click Next:
Field Select Document Exchange Enter or select... New Description, Tips, Guidelines How to create the document exchange record. Required. Valid values are:


Document Exchange none available

Existing Copy and use the properties defined for an existing trading partner to create the document exchange record. New Add properties to create the document exchange record.

Trading partner from which to copy properties. Required if you selected Existing from Select Document Exchange. Name for the document exchange record to create for this trading partner. Required.

Name

MaxxmartDocXchg

7. Verify that the information that you entered is correct and click Finish to add this trading partner to Gentran Integration Suite. 8. Click Return to be returned to the Trading Partner page. You are now ready to create a Contract.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

305

Appendix B GIS Trading Partner Set Up

Creating a Contract
A contract establishes the business and technology terms and conditions that two trading partners have agreed upon to conduct e-business transactions. Because one identity can exchange documents with many other identities, one identity may have more than one contract. Before creating a contract, ensure that you have completed the following tasks: You created trading profiles for all the trading partners and identities that will be participating. You determined business requirements and, if necessary, created a business process based on the requirements to associate with the contract. Note: Because a contract is between two trading partners, you must create a trading partner profile for your own company. The following figure shows contract negotiation process between two trading partners:

Profile for trading partner A (SC I)

Contract
N egotiate C ontract ID Profile A Profile B B usiness process N egotiate

Profile for trading partner B (M axxM art)

Agreed contract

3
Agreem ent on contract has arrived.

3
Agreem ent on contract has arrived.

Agreed contract

B egin business activities w ith one another

Notes:

306

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Exercise - Contracts

Creating a contract
1. From the Gentran Integration Suite Trading Profiles menu, select Contracts.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

307

Appendix B GIS Trading Partner Set Up

4. On the Contract Definition page, complete the following fields as appropriate and click Next:
In this field Production Profile Consumption Profile Enter or select... SCI - SCIProfile Description, Tips, Guidelines Unique ID of the profile that is acting as the producer in this contract. Values are displayed in format identity name-profile name. Required. Unique ID of the profile that is acting as the consumer in this contract. It must match the Name field of the profile record. Values are displayed in format identity name-profile name. Required. Unique ID of the business process for this contract. Optional.

MAXXMART MaxxmartProfile

Business Process

X12Deenvelope Unified

5. On the Extensions page, select X12 and click Next. 6. If the X12 Extensions page:
In this field Sender ID Receiver ID Interchange Test Indicator Group Version Release ID Code Enter or select... MAXXMART SCI P Description, Tips, Guidelines You are the sender. Your trading partner. Code to indicates whether data enclosed by this interchange envelope is test, production or informational. Code indicating the version, release, sub-release, and industry identifier of the EDI standard being used, including the GS and GE segments. Unique ID code of the transaction set; 3 characters.

004030

Transaction Set ID Code

850

7. Verify that the information that you entered is correct and click Finish to add the Contract record to Gentran Integration Suite. 8. Click Return to be returned to the Contract page.

Notes:

308

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

You are now ready to view the trading partner records that you have just created.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

309

Appendix B GIS Trading Partner Set Up

Managing Trading Partner Records


You can easily view, edit, delete, and change the status of trading partner profile records after creating them.

Exercise: Viewing a Trading Partner Record

After you have created a record, you can view its details. This may be helpful for reference purposes later. To view a record: 1. Which record do you want to view?
To View this Record: Identity Transport Document Exchange Delivery Channel Packaging Profile Contract Do This: Select Trading Partners > Setup> Advanced> Identities. Select Trading Partners > Setup > Advanced > Transports. Select Trading Partners > Setup > Advanced > Document Exchange. Select Trading Partners > Setup > Advanced > Delivery Channels. Select Trading Partners > Setup > Advanced > Packaging. Select Trading Partners > Setup > Advanced > Profiles. Select Trading Partners > Contracts.

2. Do you know the name of the record?

If Yes, in the Search section, type the name of the record and click Go! If No, in the List section, select All, or the first letter of the record name, and click
Go! Gentran Integration Suite returns the search results.
Notes:

310

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

3. Under Name, click the name of the record.

Editing a trading partner record


You can edit the information in a profile record after you have created it. This may be necessary, for example, if you are negotiating a contract and you or your trading partner wants to change some of the information in a particular record. To edit a record: 1. Which trading partner record do you want to edit?
To Edit this Record: Identity Transport Document Exchange Delivery Channel Packaging Profile Contract Do This: Select Trading Partners > Setup > Advanced > Identities. Select Trading Partners > Setup > Advanced > Transports. Select Trading Partners > Setup > Advanced > Document Exchange. Select Trading Partners > Setup > Advanced > Delivery Channels. Select Trading Partners > Setup > Advanced > Packaging. Select Trading Partners > Setup > Advanced >Profiles. Select Trading Partners > Contracts.

2. Do you know the name of the record?

If Yes, in the Search section, type the name of the record and click Go! If No, in the List section, select All, or the first letter of the record name, and click
Go! Gentran Integration Suite returns the search results. 3. Next to the appropriate record name, click edit. 4. On the Information page for the record, make the necessary changes and click Next until you reach the Confirm page. 5. Review the record settings. Are the settings correct?

If Yes, click Finish. If No, click Back, make the necessary changes, click Next, then click Finish.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

311

Appendix B GIS Trading Partner Set Up

Editing your organization information


To edit your organization information: 1. From the Gentran Integration Suite Trading Partner menu, select Setup > AS2. 2. In the Trading Partners page, next to List all configurations, click Go! In the Profiles page, Gentran Integration Suite displays a list of trading partners. 3. In the list, locate profile_organization and click edit. 4. Update your organization information as necessary and click Next. 5. Click Finish to update Gentran Integration Suite with your changes.

Editing Trading Partner Information


To edit trading partner information: 1. From the Gentran Integration Suite Trading Partner menu, select Setup > AS2. 2. In the Trading Partners page, next to List all configurations, click Go! In the Profiles page, Gentran Integration Suite displays a list of trading partners. 3. In the list, locate name of the trading partner whose information you want to edit and click edit. 4. Update the trading partner information as necessary and click Next. 5. Click Finish to update Gentran Integration Suite with your changes.

Disabling a Trading Partner Record


You can choose to disable a trading partner record, for example, if you want to create and use a new record in a contract. To disable a trading partner record: 1. Which trading partner record do you want to disable?
To Change The Status Of This Record Do This Identity Transport Document Exchange Select Trading Partners > Setup > Advanced > Identities. Select Trading Partners > Setup > Advanced > Transports. Select Trading Partners > Setup > Advanced > Document Exchange.

Notes:

312

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

To Change The Status Of This Record Do This Delivery Channel Packaging Profile Contract Select Trading Partners > Setup > Advanced > Delivery Channels. Select Trading Partners > Setup > Advanced > Packaging. Select Trading Partners Setup > Advanced > Profiles. Select Trading Partners > Contracts.

2. Do you know the name of the trading partner record?

If Yes, in the Search section, type the name of the trading partner record and click
Go!

If No, in the List section, select All, or the first letter of the name, and click Go!
Gentran Integration Suite returns the search results. 3. To disable the trading partner record, click the Enable check box (default) next to the appropriate record name. A cleared check box indicates a disabled status. 4. Click Finish to update the trading partner record.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

313

Appendix B GIS Trading Partner Set Up

Managing Document Envelopes


A document envelope consists of control information that allows organizations to effectively exchange documents. This information is added in headers and trailers to documents. Creating document envelopes is necessary if you wish to do EDI with your trading partners. This section covers the following topics: About Document Envelopes Creating Envelopes Managing Envelopes Viewing Generated Envelopes Managing Control Numbers

About Document Envelopes


Document envelopes are specific to an EDI protocol (EDIFACT, ASC X12, TRADACOMS, or CII). CII has only one level of envelopes, the Message Group Header. There are three layers of envelopes for EDIFACT and ASC X12:

Interchange, the outermost layer envelope, which contains an interchange header


and trailer, and all the data sent from one sender to one receiver in the same transmission.

Functional group, the middle layer envelope, which contains a group header and
trailer that surrounds a group of transaction sets of the same type.

Transaction set, the innermost layer envelope, which contains the transaction set
header and trailer.

Notes:

314

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

The following figure illustrates a sample enveloping structure:


Interchange Header
Functional Group Header

Interchange Envelope Functional Group Envelope

Transaction Set Header Transaction Set 850 (PO) Transaction Set Trailer Transaction Set Header

Transaction Set Envelopes

Transaction Set 850 (PO) Transaction Set Trailer Functional Group Trailer Functional Group Header Transaction Set Header

Functional Group Envelope

Transaction Set 997 (FA) Transaction Set Trailer Functional Group Trailer

Interchange Trailer

Envelopes in Gentran Integration Suite specify whether the document is inbound or outbound.

Inbound envelopes identify documents that come into Gentran Integration Suite
so they can be properly routed. Inbound envelopes also give you the option to translate documents when you choose to check documents for compliance. By choosing to translate documents during the compliance check, you can reduce document processing time because you do not need to specify a separate Translation service step in the business process.
Notes:

Course 915: Gentran Integration Suite: Fundamentals

315

Appendix B GIS Trading Partner Set Up

Outbound envelopes identify documents so that they can be sent to and received
by trading partners.

Before Using Generated Envelopes


Before using generated envelopes, you may need to modify them for one or more of the following reasons: To change to a version of the standards that Gentran Integration Suite supports, if you are using a version not supported by Gentran Integration Suite To specify a business process or contract to be used with an envelope To specify a map to be used with an envelope To specify an AccepterLookupAlias key to use with the EDI Encoder service

Using Envelopes
To use document envelopes in Gentran Integration Suite: 1. If maps are not already created, create all maps that will be used to translate the documents you are enveloping. Make sure the maps are checked in to Gentran Integration Suite. 2. Create a control number, if applicable. 3. Create EDIFACT and ASC X12 envelopes in the proper level order (CII has only one level of envelopes). a. Interchange envelope (EDIFACT UNB/UNZ or X12 ISA/IEA) b. Group envelope, if there is one (EDIFACT UNG/UNE or X12 GS/GE) c. Transaction envelope (EDIFACT UNH/UNT or X12 ST/SE)
Note: For more information about creating envelopes, see Creating Envelopes later in this chapter.

4. Gentran Integration Suite provide predefined enveloping and de enveloping business processes for you. Incorporate these business processes into your own business processes.

Notes:

316

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Base Envelopes A base envelope is a regular envelope that you use as a starting point to create a new envelope. The base envelope maintains a link to the envelopes that inherit its properties. If you modify the base envelope, all related envelopes (ones that inherited the base envelope properties) change as well. When you create an envelope using a base envelope, everything in the new envelope is the same as in the base envelope, except the envelope name, description, and other unique parameters such as unique identification numbers.
Note: If you plan to create many envelopes using base envelopes, do not use the base envelopes in production. Record the envelopes that are related to the base envelopes.

To use a base envelope: 1. Create the base envelope, following Creating Envelopes in the next section. 2. Specify the name and description of a new envelope. 3. Identify the base envelope that the new envelope uses.

Using Wildcards in Enveloping


As a way to help reduce the number of envelopes you need to create and use, the EDI Enveloping and EDI De enveloping services support use of an asterisk (*) as a wildcard character in mandatory envelope fields for X12 and EDIFACT only. By using wildcards, you can set up one set of envelopes that can be used for multiple trading partners. If certain trading partners have specific requirements, you can still have envelopes that pertain just to them, and the EDI Enveloping service chooses the envelope that is the best match. In other words, the envelope that has the most matches to specific fields in the data (for example Receiver ID, Receiver ID Qualifier), is the one selected.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

317

Appendix B GIS Trading Partner Set Up

Creating Envelopes
Inbound envelopes define expected header and trailer information for specific inbound documents. This information helps Gentran Integration Suite route and process documents. Outbound envelopes specify information about documents that allows them to be sent to and received by trading partners.

For EDIFACT standards field descriptions, refer to ISO 9735-1:198(E). For ASC X12 standards field descriptions, refer to ASC X12Version 004040.

Exercise: Creating an Envelope

To create an envelope: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Envelopes. 2. Next to Create New Envelope, click Go! 3. On the Envelope Standards page, select CII, EDIFACT, TRADACOMS, or ASC X12 and click Next. 4. Select the type of envelope you want to create and click Next. The Base Envelope page opens.
Note: Create outermost layer envelopes first, innermost layer envelopes last.

5. Do you want this envelope to inherit properties from a base envelope?

If Yes, select a base envelope and click Next. If No, (you want to create a new envelope) select Not Applicable and click Next.
Note: If a base envelope is not available, click Next to move on to the Name page.

6. On the Name page, type the name of the envelope and the description or comments and click Next. Each envelope must have a unique name.
Notes:

318

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

7. Complete the properties for the envelope as necessary, click Next after each page until you come to the confirmation page. For more information, see Envelope Properties in the next section. 8. Review your envelope settings. Are the settings correct?

If Yes, click Finish. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully. Note: If an error occurs, your changes are not saved. Review your parameter settings and make the necessary corrections.

Envelope Properties
Each envelope type has a specific properties page for the envelope and other pages that allow you to specify additional requirements for the envelope. Property information for the following envelope types are contained in the Trading Profile Administration Guide:

CII Inbound Envelope Properties CII Outbound Envelope Properties EDIFACT Inbound Syntax 4 UNB/UNZ Envelope Properties, Interchange Level EDIFACT Inbound Syntax 4 UNG/UNE Envelope Properties, Group Level EDIFACT Inbound Syntax 4 UNH/UNT Envelope Properties, Transaction Level EDIFACT Outbound Syntax 4 UNB/UNZ Envelope Properties, Interchange Level EDIFACT Outbound Syntax 4 UNG/UNE Envelope Properties, Group Level EDIFACT Outbound Syntax 4 UNH/UNT Envelope Properties, Transaction
Level

TRADACOMS Inbound STX/END TRADACOMS Outbound STX/END TRADACOMS Outbound MHD/MTR X12 Inbound ISA/IEA Envelope Properties, Interchange Level X12 Inbound GS/GE Envelope Properties, Group Level X12 Inbound ST/SE Envelope Properties, Transaction Level
Notes:

Course 915: Gentran Integration Suite: Fundamentals

319

Appendix B GIS Trading Partner Set Up

X12 Outbound ISA/IEA Envelope Properties, Interchange Level X12 Outbound GS/GE Envelope Properties, Group Level X12 Outbound ST/SE Envelope Properties, Transaction Level

Managing Envelopes
You can manage envelopes within Gentran Integration Suite by copying, editing, deleting, and creating new versions of them. You can also specify a default envelope.

Exercises: Managing Envelopes

Copying an Envelope
Copy an existing envelope to create a new, independent envelope. To copy an envelope: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Envelopes. 2. Find the envelope using the Search or List function. 3. In the list of envelopes, click copy for the envelope that you want to copy. 4. Change the envelope name and description and click Next. Each envelope must have a unique name. 5. Change envelope properties and settings as necessary, clicking Next to continue to each following page. For more information about parameters, see Envelope Properties in the next section. 6. Review the settings for the envelope. Are the settings correct?

If Yes, click Finish to apply your changes. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes.

Notes:

320

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Editing an Envelope
Each time you edit an envelope, Gentran Integration Suite saves a new version of that envelope without overwriting or replacing the original. Editing an envelope also requires you to specify a default version of the envelope. To edit an envelope: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Envelopes. 2. Find the envelope using the Search or List function. 3. From the list of envelopes, click Source Manager next to the envelope you want to modify. 4. Click edit next to the version of the envelope you want to modify. 5. Change envelope properties and settings as necessary, clicking Next to continue to each following page. For more information about parameters, see Envelope Properties. 6. Review the settings for the envelope. Are the settings correct?

If Yes, click Finish to apply your changes. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes. 7. If you want the new version to be the default, you must go to the Version Manager page for that envelope. When your changes have been applied, Gentran Integration Suite displays the message:
The system update has completed successfully.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

321

Appendix B GIS Trading Partner Set Up

Exercise: Specifying a Default Envelope

The default envelope is the version of the document envelope that Gentran Integration Suite uses. You can specify a default envelope only if there are two or more versions of the same envelope. One version must be selected as the default. To specify a default envelope: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Envelopes. 2. Find the envelope using the Search or List function. 3. Next to the envelope for which you want to alter the default, click Version Manager. 4. To make a version of an envelope the default, select the default button.
Note: A selected button indicates the envelope is the default. The previously selected default is cleared.

5. Click Save.

Viewing Generated Envelopes


To view generated envelopes: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Envelopes. 2. Select Gentran Integration Suite from the list of providers, if available. 3. Find the envelope using the Search or List function.

Notes:

322

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Viewing Gentran:Server UNIX Envelopes


In Gentran Integration Suite, you can view Gentran:Server UNIX document envelopes and other trading partner information. You cannot create or edit Gentran:Server UNIX envelopes from within Gentran Integration Suite; you can only view existing envelopes.
Note: You must have Attunity Data Connect installed in order to view Gentran:Server UNIX envelopes within Gentran Integration Suite. You must also have configured Gentran Integration Suite for Gentran:Server trading profile view support with the configGSUnix.sh script.

Exercises: Searching for Gentran: Server UNIX Document Envelopes

To search for Gentran:Server UNIX document envelopes: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Envelopes. 2. Select Gentran:Server for UNIX from the list of providers.
Note: If this option is not available, you have not yet configured Gentran Integration Suite for Gentran:Server trading profile view support.

3. Find the appropriate envelope using the Search or List function. To search for Gentran:Server UNIX interchange and group organization records: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes > Control Numbers. 2. Select Gentran:Server for UNIX from the list of providers.
Note: If this option is not available, you have not yet configured Gentran Integration Suite for Gentran:Server trading profile view support.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

323

Appendix B GIS Trading Partner Set Up

3. Find the appropriate record using the Search or List function.

Managing Control Numbers


Gentran Integration Suite uses incrementing control numbers that are mutually agreed upon by both sender and receiver to establish a verifiable sequence-checking process for transmitting and receiving EDI documents. Control numbers help to keep track of transmitted data and to guarantee that control code is unique. About Control Numbers A control number is an incrementing number in an EDI envelope. Gentran Integration Suite supports two types of control numbers: local control numbers and global control numbers. Local control numbers increment within an outbound document type. With global control numbers, each interchange and group control number increments by one from the previous document, regardless of document type. In Gentran Integration Suite Versions 3.1 and higher you can also delete control numbers.

Exercises: Creating a Control Number

To create a control number: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes> Control Numbers. 2. Next to New Control Number, click Go!

Notes:

324

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

3. On the New Control Number: Number Data page, complete the following fields and click Next.
Field Name Number Value Sender ID Receiver ID Description Name of the control number. Required. Number value of the control number. Use a number greater than zero. Required. Sender identification of the control number. Required. Receiver identification of the control number. Required.

4. On the Confirm page, review the control number settings. Are the settings correct?

If Yes, click Finish. If No, click Back, make the necessary changes, click Next, then click Finish.
5. Click Return.

Searching for a Control Number


After creating a control number, you can search for the control number and view its details. To search for a control number: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes> Control Numbers. 2. In the Search portion of the Control Numbers page, specify all or part of a sender ID or receiver ID and click Go! Gentran Integration Suite displays a list of control numbers that match your search criteria. 3. When done, click Return.

Editing a Control Number


You can edit only the number value of a control number and only if the provider is Gentran Integration Suite. To edit a control number: 1. From the Gentran Integration Suite Trading Profiles menu, select Document Envelopes> Control Numbers.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

325

Appendix B GIS Trading Partner Set Up

2. In the Search portion of the Control Numbers page, specify all or part or none of a sender ID or receiver ID and click Go! Gentran Integration Suite displays a list of control numbers that match your search criteria. 3. Click edit next to the control number you want to edit. 4. On the Number Data page, edit the value in the Number Value field and click Next. 5. On the Confirm page, review the control number settings. Are the settings correct?

If Yes, click Finish. If No, click Back, make the necessary changes, click Next, then click Finish.
6. Click Return.

Exercise: Test Your Knowledge

1. Explain the purpose of a trading partner.

2. List some of the information you may need to know about your trading partner before you can exchange documents.

3. List three activities you can perform from the contract page:

Notes:

326

Course 915: Gentran Integration Suite: Fundamentals

Appendix B GIS Trading Partner Set Up

Lesson Review
Completed Objectives
You should now be able to: Set up a Trading Partner for EDI. Create a contract. Manage trading partner records. Explain how document envelopes enable organizations to exchange documents. Create and manage document envelopes.

Notes:

Course 915: Gentran Integration Suite: Fundamentals

327

Appendix B GIS Trading Partner Set Up

Notes:

328

Course 915: Gentran Integration Suite: Fundamentals

Appendix C

Digital Certificates

Digital Certificates
A digital certificate is a vehicle for the management and distribution of public keys. It binds a public key to identity information about the owner of the key. A digital certificate contains a public key, identity information, and one or more signatures to provide a chain of verification and to prevent tampering. Gentran Integration Suite associates digital certificates with trading profiles and recognizes two types of digital certificates:

CA and trusted certificates - Certificates for which Gentran Integration Suite


does not have the private key. They are stored in standard DER format.

System certificates - Certificates for which Gentran Integration Suite maintains


the private key. They are stored with the private key in a secure format. For more information about digital certificates, see:

RSA, www.rsasecurity.com Verisign, www.verisign.com

Terminology
Public key cryptography is based on key pairs. A key pair contains a private key and a public key. Anything encrypted with one key can be decrypted only with the other key. Keep private keys secret and publish public keys to those who want to send encrypted data or want to verify digital signatures. A digital signature is a cryptographic hash calculated over a block of data and then encrypted with the private key of a key pair. Anyone who has the public key in the key pair can use it to decrypt the hash and then independently calculate a hash over the data. If the results match, the signature verifies. Assuming that the private key is known only to its owner, a matching hash also authenticates the signer. Digital certificates can be self-signed or CA-signed.

Course 915: Gentran Integration Suite: Fundamentals

329

Appendix C Digital Certificates

A self-signed certificate is signed with the private key that corresponds to the
public key in the certificate, demonstrating that the issuer has the private key that corresponds to the public key in the certificate.

CA-signed certificates are signed using keys maintained by certificate authorities.


Before issuing a certificate, the CA typically evaluates a certificate requestor to determine that the requestor is in fact the certificate holder referenced in the certificate. A CA certificate is a certificate issued by a certificate authority (CA), for verifying trusted certificates. A CA certificate contains a public key corresponding to the private key which the CA owns to sign certificates it issues. A CA certificate can be used to verify that a trusted certificate was issued by a certain CA. The CA certificate can also verify that the trusted certificate has not been altered. Gentran Integration Suite stores CA certificates separately from trusted certificates.
Note: Although CA certificates are public documents, you should be careful about who has rights to add them to Gentran Integration Suite. Someone could maliciously add a false CA certificate in order to verify false end-user certificates.

Trusted certificates are end-user certificates that are trusted by Gentran Integration Suite. Generally, Gentran Integration Suite users receive trusted certificates from their trading partners. System certificates are certificates for which the user has the private key in Gentran Integration Suite. Gentran Integration Suite users use private keys to sign and decrypt documents.

Managing Digital Certificates


Gentran Integration Suite uses digital certificates for secure data transport, EDIINT, and communication between system components. Before you set up trading partners, you must obtain and check in any digital certificates. To help you manage your digital certificates, Gentran Integration Suite includes the Certificate Wizard, a stand-alone tool that enables you to generate: Private and public keys protected with a passphrase A certificate signing request (CSR) to send to a trusted certificate authority (CA) After the CA authorizes the CSR and issues a digitally-signed certificate, you can then use the Certificate Wizard to generate and validate a key certificate that you check in to Gentran Integration Suite.

330

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

Checking In a CA Certificate
A CA certificate is a certificate issued by a certificate authority (CA) to verify trusted certificates. A CA certificate contains a public key corresponding to the private key, which the CA owns and uses to sign the certificates it issues.
Caution: Although CA certificates are public documents, you should be careful about who has rights to add them to Gentran Integration Suite. Someone could maliciously add a false CA certificate in order to verify false end-user certificates.

Gentran Integration Suite stores CA certificates separately from trusted certificates. To enable Gentran Integration Suite to validate a trusted certificate, you must first check in a CA certificate. To check in a CA certificate: 1. Save the CA certificate to a file on your local computer. 2. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > CA. 3. Next to Check in New Certificate, click Go! 4. In the Filename field, type or browse to the file name of the CA certificate and click Next. 5. Verify the name of the CA certificate you are checking in.
Note: For each certificate in the file you selected, the Certificate Name field contains a suggested name built out of the issuer relative distinguished name (RDN) and serial number of the certificate. Below the name is a summary of the identifying information in the certificate. For convenience, Gentran Integration Suite records the name of the certificate in its database. You can change the name to fit your file-name conventions or to something easier to remember.

6. If there is more than one CA certificate in the file you selected, you can check in each certificate by selecting the check box next to it. 7. Review the settings for the CA certificate you are checking in. Are the settings correct?

If Yes, click Finish. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

Course 915: Gentran Integration Suite: Fundamentals

331

Appendix C Digital Certificates

Editing a CA Certificate Name


A CA certificate name is not part of the content of the certificate. Certificates should have meaningful names, according to your file-name conventions or preference, because Gentran Integration Suite identifies them by name in the user interface. To edit a CA certificate name: 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > CA. 2. Locate the CA certificate you want to edit and click Go! Gentran Integration Suite displays a list of CA certificates. 3. Click Edit next to the CA certificate you want to edit. 4. Change the CA certificate name as necessary and click Next. 5. Review the name for the certificate. Is the name correct?

If Yes, click Finish. If No, click Back to change the name, or click Cancel to cancel without saving
changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

Checking In a Trusted Certificate


Trusted certificates are end-user certificates that are trusted by Gentran Integration Suite. Generally, Gentran Integration Suite users receive trusted certificates from their trading partners. Trusted certificates provide your public key to your trading partners and provide the public keys of trading partners to you. Store these certificates in Gentran Integration Suite by checking them in. To check in a trusted certificate: 1. Save the trusted certificate to a file on your local computer. 2. From the Gentran Integration Suite Trading Partner menu, select Digital Certificate > Trusted. 3. Next to Check in New Certificate, click Go! 4. In the Filename field, type or browse to the file name of the trusted certificate and click Next.

332

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

5. Verify the name of the trusted certificate you are checking in.
Note: For each certificate in the file you selected, the Certificate Name field contains a suggested name built out of the issuer relative distinguished name (RDN) and serial number of the certificate. Below the name is a summary of the identifying information in the certificate. For convenience, Gentran Integration Suite records the name of the certificate in its database. You can change the name to fit your file-name conventions or to something easier to remember.

6. If there is more than one trusted certificate in the file you selected, you can check in each certificate by selecting the check box next to it. 7. Review the settings for the certificate specification of the trusted certificate you are checking in. Are the settings correct?

If Yes, click Finish. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

Editing a Trusted Certificate Name


A trusted certificate name is not part of the content of the certificate. Certificates should have meaningful names, according to your file name conventions or preference, because they are identified in Gentran Integration Suite by name. To edit a trusted certificate name: 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > Trusted. 2. Locate the trusted certificate you want to edit and click Go! Product Name displays a list of trusted certificates. 3. Click Edit next to the trusted certificate you want to modify. 4. Change the trusted certificate name as necessary and click Next. 5. Review the name for the certificate. Is the name correct?

If Yes, click Finish. If No, click Back to change the name, or click Cancel to cancel without saving
changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

Course 915: Gentran Integration Suite: Fundamentals

333

Appendix C Digital Certificates

Creating a Self-Signed Certificate


Gentran Integration Suite enables you to create your own certificates. When you create a self-signed certificate, Gentran Integration Suite generates a key pair and embeds the public key from the key pair in the certificate. The private key and associated certificate are stored securely in an encrypted format. To create a self-signed certificate: 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > System. 2. Next to Create Self-Signed Certificate, click Go! 3. In the Name field, type the name of the self-signed certificate. This should be a unique and meaningful name. 4. In the Organization field, type the name of the originating organization. 5. In the Country field, select the country or origin of the self-signed certificate. 6. In the E-mail field, type a contact e-mail address for the person responsible for certificates in the organization and click Next. 7. In the Serial Number field, type the serial number. The serial number is whatever number you want to assign to the self-signed certificate. 8. In the Duration field, type the number of days that the self-signed certificate is valid. 9. From the Key Length field, select a key length (512, 1024, or 2048) and click Next.
Note: The key length 1024 provides a good balance between security, interoperability, and efficiency. The key length 2048 is the most secure, but also the slowest, and may not work with some applications.

10. In the Validate When Used: area you can select Validity, Auth Chain, or both. 11. Review the settings for the self-signed certificate. Are the settings correct?

If Yes, click Finish. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

334

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

About the Certificate Wizard


You can use the Certificate Wizard to generate certificate signing requests (CSRs) and key certificates that you can then check into Gentran Integration Suite. The Certificate Wizard is a Web-deployed application included with Gentran Integration Suite. To ensure proper deployment of the wizard, Gentran Integration Suite uses Java Web Start. If you have not downloaded Java Web Startfor example, when you install the Graphical Process Modeler, you also download Java Web Startyou need to download it before you can access the wizard.

Downloading Java Web Start


To download Java Web Start to access the Certificate Wizard, you must log in to Gentran Integration Suite using a login ID that has permission to create and maintain trading partner certificates.
Note: If you have already downloaded the Java Web Start, or have it installed, you do not have to do this exercise.

To download Java Web Start: 1. From the Gentran Integration Suite Trading Profiles menu, select Digital Certificates > System. 2. In the Certificate Signing Request section, next to Java Web Start, click Download. 3. In the File Download dialog box, select the Save option and click OK. 4. In the Save as dialog box, select a directory on your client computer and click Save to begin downloading Java Web Start.
Note: The download may require several minutes, depending on the speed of your connection.

5. When the download is complete, close the Download dialog box if it remains open. 6. Open the directory where you downloaded the file for Java Web Start. 7. Double-click the file javaws-1_0_1_02-win-int-rt.exe to begin the installation process. 8. After reading the license agreement, click Accept. 9. In the Installation Directory dialog box, either accept the default directory or click Browse to select another directory to install Java Web Start, and then click Next.

Course 915: Gentran Integration Suite: Fundamentals

335

Appendix C Digital Certificates

10. When you receive a message that setup was unable to detect a usable Java 2 Runtime Environment, either accept the default installation directory or click Browse to select another installation directory, and then click OK. The Installing Files dialog box opens and displays the in-progress installation. When the installation is complete, the setup program prompts you to read the Readme file. You can now access the Certificate Wizard.

Starting the Certificate Wizard


Typically, you start the Certificate Wizard within Gentran Integration Suite. However, you can start the wizard offline without logging in to Gentran Integration Suite.
Note: Initial startup may require several minutes, depending on the speed of your connection.

Starting the Certificate Wizard Online


To access the Certificate Wizard (and Java Web Start): 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > System. 2. In the Certificate Signing Request section, next to Run Certificate Wizard, click Go!

Starting the Certificate Wizard Offline


To start the Certificate Wizard offline through Java Web Start: 1. From the Windows Start menu, select Programs > Java Web Start > Java Web Start. 2. From the View menu, select Downloaded Applications to view the installed wizard application (or installed instances of the Certificate Wizard). 3. Select the Certificate Wizard application and click Start.

Exiting the Certificate Wizard


Whether you have started the Certificate Wizard online through Gentran Integration Suite, or offline through Java Web Start, you exit the wizard in the same way. To exit the Certificate Wizard, click Exit.

Uninstalling the Certificate Wizard


If you have several instances of the Certificate Wizard installedfor example, if you have installed an instance to use for testing and an instance to use for productionyou can remove an instance of the wizard using the Java Web Start Manager.

336

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

When you need to remove the wizard and the resource files associated with the wizard, you must remove all instances of the wizard from the Java Web Start Manager, and then remove both Java 2 Runtime Environment and Java Web Start.

Removing an Instance of the Certificate Wizard


To remove an instance of the Certificate Wizard from the Java Web Start Manager: 1. On the computer where the wizard is installed, from the Windows Start menu, select Programs > Java Web Start > Java Web Start. 2. From the View menu, select Downloaded Applications to view the wizard application (or installed instances of the wizard). 3. Select the Certificate Wizard (or the instance of the wizard) that you want to remove from the application window. 4. From the Application menu, select Remove Applications.

Removing the Certificate Wizard and Resource Files


To remove the Certificate Wizard and the resources files associated with the wizard: 1. On the computer where the wizard is installed, from the Windows Start menu, select Settings > Control Panel. 2. Double-click Add/Remove Programs. 3. In the Add/Remove Programs Properties dialog box, select Java 2 Runtime Environment Standard Edition v1.3.0_02, and click Add/Remove. 4. Follow the remaining instructions to complete the uninstall process.
Note: See the Microsoft Windows documentation for complete instructions.

5. Return to the Add/Remove Programs Properties dialog box, select Java Web Start and repeat steps 3 - 4.

Using the Certificate Wizard


A key certificate is a combination of ASCII-encoded certificate and ASCII-encoded PKCS12 encrypted key. To set up your environment for secure connections, you must acquire or create a key certificate and check it in to Gentran Integration Suite. The Certificate Wizard provides you with all the components you must create a key certificate that Gentran Integration Suite can easily identify upon check-in. To create a key certificate that you can check into Gentran Integration Suite, you must perform the following tasks in order: 1. Generate your PKCS12-formatted key and certificate signing request (CSR). 2. Send your certificate signing request (CSR) to the CA for authorization.

Course 915: Gentran Integration Suite: Fundamentals

337

Appendix C Digital Certificates

3. To authorize your CSR, the CA validates the information in the CSR and issues a digitally-signed (X.509 format) certificate as a binary CER or CRT file, which contains the information in the certificate signing request. 4. Use the certificate from the CA and your private key to create a key certificate. 5. Verify the key certificate is ready for check-in. For more information about checking in: PKCS12-formatted keys Key certificates

Generating a Certificate Signing Request (CSR)


The Certificate Wizard performs several tasks when generating a CSR: Creates a private key and writes it to a specified file name Designates whether the CSR is for a client or a server Creates the CSR and writes it to a specified file name Verifies and displays the contents of a certificate To generate a CSR: 1. Start the Certificate Wizard. 2. In the Certificate Wizard, click the Certificate Request tab. 3. Complete the following required fields and click Next:

Common Name Type the name of your client computerfor example, use an
e-mail or TCP/IP address.

Country Select your country or origin. State/Province Select your state or province. City/Locality Type your city or locality. Organization/Company Type the name of your organization or company. Organizational Unit Type your unit within your organization or company for
example, a division within a company can represent a unit. 4. To enable the pseudo-random number generator (PRNG) to generate a random number for the public/private key pair, type any random sequence of characters until processing stops. 5. In the Message dialog box that indicates enough random input is now available (random generated number for the public/private key pair), click OK, and then click Next. 6. Complete the following required fields and click Next:

Private Key Length Select the encryption strength of your private key. Passphrase Type the passphrase to use for encrypting the private key of the
certificate.

338

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

Confirm Passphrase Retype the passphrase you indicated for encrypting the
private key of the certificate. 7. Complete the following required fields and click Next:

Key File Name Either accept the default directory or click Browse to select
another directory to save the PKCS12-formatted key file.

CSR File Name Either accept the default directory or click Browse to select
another directory to save the CSR (csr.txt is default file name) file. 8. Click Finish to complete the CSR. 9. To generate another CSR, click Start Over, and repeat steps 1 - 8. You are now ready to send the CSR (csr.txt) to your CA for authorization.

Creating a Key Certificate


After the CA authorizes the CSR, the CA issues a digitally-signed (X.509 format) certificate, as appropriate. Using the PKCS12-formatted key and digitally-signed certificate, you can create a key certificate. To create a key certificate file: 1. In the Certificate Wizard, click the Generate KeyCert tab. 2. Either type the directory or click Browse to select the directory to which you have saved the following files:

PKCS12-formatted key Digitally-signed (.cer or .crt file) certificate from the CA


3. For the key certificate, either accept the default directory or click Browse to select another directory to save the key certificate (keycert.txt is default file name) file. 4. To enable the Certificate Wizard to create the key certificate, click Generate. You are now ready to verify the key certificate is ready for check-in. Validating the Key Certificate In addition to creating the key certificate, the Certificate Wizard also creates a trusted root (trusted.txt) file and saves the file to same directory as the key certificate (keycert.txt). The trusted root file contains a list of trusted sources that enables the Certificate Wizard to validate a key certificate and ensure a secure connection. To validate the key certificate: 1. In the Certificate Wizard, click the Verify Certificate tab. 2. Complete the following fields:

Passphrase Type the passphrase that you indicated for this key certificate when
you generated it.

Course 915: Gentran Integration Suite: Fundamentals

339

Appendix C Digital Certificates

Keycert Either type or click Browse to select the directory to which you have
saved the key certificate (keycert.txt file). This field can remain blank if you only want to verify a trusted root certificate file.

Trusted Root File Either type or click Browse to select the directory to which
you have saved the key certificate to obtain the trusted root certificate file (trust.txt file). 3. Click Verify to enable the Certificate Wizard to validate the key certificate. A message displays that includes the verification results for each file you selected. You are now ready to check the PKCS12 certificate and key certificate in to Gentran Integration Suite.

340

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

Checking In a PKCS12 Certificate


Before you check in a PKCS12 certificate, ensure that you have generated a PKCS12-formatted file. To check in a PKCS12 certificate: 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates> System. 2. Next to Check-in PKCS12 Certificate, click Go! 3. In the Name field, type the certificate name. This should be a unique and meaningful name. 4. In the Private Key Password field, type the private key password. This is the password used to encrypt the private key. 5. In the Key Store Password field, type the key store password. This is the password for the PKCS12 object. It may be the same as the private key password. If you have only one password, type that password in both this step and step 4. 6. In the Filename field, type or browse to the file name of the certificate and click Next. 7. Verify the PKCS12 certificate you are checking in and click Next.

Have you checked in all the parts of the certificate that you want to check in?
Select or clear as necessary.

Are the names of the certificate parts acceptable? If not, type the name you want.
8. Review your settings for the PKCS12 certificate you are checking in. Are the settings correct?

If Yes, click Finish. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

Course 915: Gentran Integration Suite: Fundamentals

341

Appendix C Digital Certificates

Checking In a Key Certificate


A key certificate is a combination of ASCII-encoded certificate and ASCII-encoded PKCS5 encrypted private key. Before you check a key certificate in to Gentran Integration Suite, ensure that you sent a CSR to your CA the and CA has issued a digitally-signed (.cer or .crt) certificate. After obtaining a key certificate, you must check it in to Gentran Integration Suite. To check in a key certificate: 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > System. 2. Next to Check in Key Certificate, click Go! 3. In the Certificate Name field, type the key certificate name. This should be a unique and meaningful name. 4. In the Private Key Password field, type the private key password. This is the password used to encrypt the private key. 5. In the Filename field, type or browse to the file name of the certificate and click Next. 6. Review your settings for the key certificate you are checking in. Are the settings correct?

If Yes, click Finish. If No, click Back to make changes to your selections, or click Cancel to cancel
without saving changes. When the update is complete, Gentran Integration Suite displays the message: The
system update has completed successfully.

Checking Out a System Certificate


In order to export a system certificate from Gentran Integration Suite, you must check out the certificate. Gentran Integration Suite users use private keys to sign and decrypt documents.
Note: The following procedure exports only the public certificate, not the private key. This provides you with a public certificate to send to a trading partner.

342

Course 915: Gentran Integration Suite: Fundamentals

Appendix C Digital Certificates

To check out a system certificate: 1. From the Gentran Integration Suite Trading Partner menu, select Digital Certificates > System. 2. Locate the system certificate you want to check out, using the Search or List function. Gentran Integration Suite displays a list of system certificates. 3. Next to the system certificate you want to check out, click Check Out. 4. Select the BASE64 or DER format for the certificate and click Go!

BASE64: This option uses BASE64 encoding on the standard DER certificate. DER: This standard format for digital certificates is accepted by most
applications. 5. Save the certificate on your local computer.
Note: The option to open the certificate is not supported by Gentran Integration Suite. You must open the certificate from within the Windows operating system.

Course 915: Gentran Integration Suite: Fundamentals

343

Appendix C Digital Certificates

344

Course 915: Gentran Integration Suite: Fundamentals

Appendix D

Case Study Hints

Introduction
The following pages contain some tips that can help you as you work through the case study.

Course 915: Gentran Integration Suite: Fundamentals

345

Appendix D Case Study Hints

Case Study Hints


1. The Start business process contains a File System Adapter and an Invoke Business Process stencil. The FSA should read from Inbound_from_Comms and pass the document to the Main business process. 2. Create a business process called ErrRtn that uses an XML Encoder Service and an SMTP Adapter to send an e-mail (optionally also a note added to Process Data) that there is an error in the business process instance. Use the XML Encoder and xpath to pull from Process Data the Error tag contents and insert into the e-mail. 3. Create a map for translating EDI to XML. This map must work for both the Ellis 850 documents and the Unlimited 216 documents. A suggestion is to create an 850 input side map first, then add the 216 segments not there already (PUN, G61, TEM) to the 850 map. Since the map is being used for conversion to XML, data not in the document will be ignored at this step. Here the XML Encoder map will just convert the data it receives. 4. Create in Main an XMLEncoder stencil, choose to Encode non-XML documents, and use the map you created. 5. Capture all errors with an OnFault that calls ErrRtn via Invoke Business Process. 6. Once the document has been converted into XML in Process Data, create a rule that tests whether the data is from Ellis Labs (N1 contains ST and Ellis) or from Unlimited (G61 contains SH and CHRISTIAN). If its for Ellis (Pharma), use Assign activities to pull the PO_Num and CustNum values out of the document and into their own Process Data tags. The XPath is given in the body of the case study. Using a Lightweight JDBC Adapter, write an insert statement that pulls the PO_Num and Cust_Num values from Process Data and inserts them into the table created earlier as CUST_ID and PO_NUM. 7. If the data is for Unlimited (Logistics), call the Document Keyword Replacement Service and replace ~ with = as the segment delimiter, and use an FSA to extract the document to the Altered_Delimiter directory. 8. After the Choice End, call an Invoke Business Process to invoke the Output BP. 9. Output uses an All Start to enact two different paths at the same time. One path uses a Command Line Adapter to call the Clear_Dir.bat script to clear Inbound_from_Comms. The other path uses an XML Encoder to convert Process Data to Primary Document. Use a File System Adapter to write the Primary Document to the Output directory. Configure an OnFault to handle any errors.

Notes:

346

Course 915: Gentran Integration Suite: Fundamentals