PowerCenter Connect for webMethods 8.1.1 User Guide Documentation... · 2016-07-24 · webMethods...

User Guide

Informatica PowerCenter

Connect

for webMethods

(Version 8.1.1)

Informatica PowerCenter Connect for webMethods User GuideVersion 8.1.1September 2006

Copyright © 2003-2006 Informatica Corporation.All rights reserved. Printed in the USA.

This software and documentation contain proprietary information of Informatica Corporation and are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright law. Reverse engineering of the software is prohibited. No part of this document may be reproduced or transmitted in any form, by any means (electronic, photocopying, recording or otherwise) without prior consent of Informatica Corporation.

Use, duplication, or disclosure of the Software by the U.S. Government is subject to the restrictions set forth in the applicable software license agreement and as provided in DFARS 227.7202-1(a) and 227.7702-3(a) (1995), DFARS 252.227-7013(c)(1)(ii) (OCT 1988), FAR 12.212(a) (1995), FAR 52.227-19, or FAR 52.227-14 (ALT III), as applicable. The information in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Informatica Corporation does not warrant that this documentation is error free.

Informatica, PowerCenter, PowerCenterRT, PowerCenter Connect, PowerCenter Data Analyzer, PowerMart, SuperGlue, Metadata Manager, Informatica Data Quality and Informatica Data Explorer are trademarks or registered trademarks of Informatica Corporation in the United States and in jurisdictions throughout the world. All other company and product names may be trade names or trademarks of their respective owners.

Portions of this software and/or documentation are subject to copyright held by third parties, including without limitation: Copyright DataDirect Technologies, 1999-2002. All rights reserved. Copyright © Sun Microsystems. All Rights Reserved. Copyright © RSA Security Inc. All Rights Reserved. Copyright © Ordinal Technology Corp. All Rights Reserved.

Informatica PowerCenter products contain ACE (TM) software copyrighted by Douglas C. Schmidt and his research group at Washington University and University of California, Irvine, Copyright (c) 1993-2002, all rights reserved.

Portions of this software contain copyrighted material from The JBoss Group, LLC. Your right to use such materials is set forth in the GNU Lesser General Public License Agreement, which may be found at http://www.opensource.org/licenses/lgpl-license.php. The JBoss materials are provided free of charge by Informatica, “as-is”, without warranty of any kind, either express or implied, including but not limited to the implied warranties of merchantability and fitness for a particular purpose.

Portions of this software contain copyrighted material from Meta Integration Technology, Inc. Meta Integration® is a registered trademark of Meta Integration Technology, Inc.

This product includes software developed by the Apache Software Foundation (http://www.apache.org/). The Apache Software is Copyright (c) 1999-2005 The Apache Software Foundation. All rights reserved.

This product includes software developed by the OpenSSL Project for use in the OpenSSL Toolkit and redistribution of this software is subject to terms available at http://www.openssl.org. Copyright 1998-2003 The OpenSSL Project. All Rights Reserved.

The zlib library included with this software is Copyright (c) 1995-2003 Jean-loup Gailly and Mark Adler.

The Curl license provided with this Software is Copyright 1996-2004, Daniel Stenberg, <[email protected]>. All Rights Reserved.

The PCRE library included with this software is Copyright (c) 1997-2001 University of Cambridge Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel. The source for this library may be found at ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre.

InstallAnywhere is Copyright 2005 Zero G Software, Inc. All Rights Reserved.

Portions of the Software are Copyright (c) 1998-2005 The OpenLDAP Foundation. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted only as authorized by the OpenLDAP Public License, available at http://www.openldap.org/software/release/license.html.

This Software may be protected by U.S. and international Patents and Patents Pending.

DISCLAIMER: Informatica Corporation provides this documentation “as is” without warranty of any kind, either express or implied,including, but not limited to, the implied warranties of non-infringement, merchantability, or use for a particular purpose. The information provided in this documentation may include technical inaccuracies or typographical errors. Informatica could make improvements and/or changes in the products described in this documentation at any time without notice.

Table of Contents

List of Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii

Other Informatica Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Visiting Informatica Customer Portal . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Visiting the Informatica Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Visiting the Informatica Developer Network . . . . . . . . . . . . . . . . . . . . xiii

Visiting the Informatica Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . xiii

Obtaining Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Chapter 1: Understanding PowerCenter Connect for webMethods . . . 1

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Integrating PowerCenter with webMethods . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Designer Integration with the webMethods Broker . . . . . . . . . . . . . . . . . . 3

webMethods Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Integration Service and webMethods Integration . . . . . . . . . . . . . . . . . . . 5

Chapter 2: Configuring PowerCenter Connect for webMethods . . . . . 9

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Before You Begin . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Step 1. Configure JVM Options for the Integration Service . . . . . . . . . . . . . 11

Step 2. Register the webMethods Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . 12

Downloading the webMethods Service Pack . . . . . . . . . . . . . . . . . . . . . . 12

Setting the Path to the webMethods Broker \bin Directory . . . . . . . . . . . 12

Setting the CLASSPATH to the webMethods Client JAR File . . . . . . . . . 13

Chapter 3: webMethods Source and Target Concepts . . . . . . . . . . . . 15

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Envelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Data Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

i i i

Map Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17

webMethods Document Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

webMethods Sequence Metadata . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Sequence Containing a Structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22

Multidimensional Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Nested Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Chapter 4: Working with webMethods Sources . . . . . . . . . . . . . . . . . 25

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Creating a webMethods Source Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Displaying Document Types in a Document Folder . . . . . . . . . . . . . . . . 27

Importing a webMethods Source Definition . . . . . . . . . . . . . . . . . . . . . . 28

Editing a webMethods Source Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Working with the Application Multi-Group Source Qualifier . . . . . . . . . . . . 31

Creating an Application Multi-Group Source Qualifier . . . . . . . . . . . . . . 31

Transformation Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

Chapter 5: Working with webMethods Targets . . . . . . . . . . . . . . . . . .33

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Working with the pubSeqn Envelope Field . . . . . . . . . . . . . . . . . . . . . . . 34

Maintaining Transactional Consistency for webMethods Targets . . . . . . . 34

Determining Load Scope for webMethods Targets . . . . . . . . . . . . . . . . . 35

Creating a webMethods Target Definition . . . . . . . . . . . . . . . . . . . . . . . . . . 36

Importing a webMethods Target Definition . . . . . . . . . . . . . . . . . . . . . . 36

Creating a Target Definition Based on a Source Definition . . . . . . . . . . . 37

Editing webMethods Target Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38

Steps to Edit a webMethods Target Definition . . . . . . . . . . . . . . . . . . . . 38

Configuring Load Scope . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

Chapter 6: Creating and Configuring webMethods Workflows . . . . .41

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Working with webMethods Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43

Configuring the Delivery Model for webMethods Sources . . . . . . . . . . . . 43

Filtering Source Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Configuring Session Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46

Message Recovery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Configuring the Delivery Model for webMethods Targets . . . . . . . . . . . . 50

iv Table of Contents

Reading and Writing Sequences in webMethods Documents . . . . . . . . . . 51

Configuring Transactional Consistency for webMethods Targets . . . . . . . 51

Pipeline Partitioning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52

Configuring a Session with a webMethods Mapping . . . . . . . . . . . . . . . . . . . 53

Configuring and Scheduling Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Configuring Workflows to Run Multiple Sessions Simultaneously . . . . . . 60

Scheduling Workflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60

Troubleshooting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Appendix A: webMethods Datatype Reference . . . . . . . . . . . . . . . . . 63

Datatype Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

webMethods and Transformation Datatypes . . . . . . . . . . . . . . . . . . . . . . 64

Boolean Datatype . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67

Table of Contents v

vi Table of Contents

List of Figures

Figure 1-1. PowerCenter and webMethods Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Figure 1-2. webMethods Broker Document Metadata Structure . . . . . . . . . . . . . . . . . . . . . . . . 4

Figure 1-3. Integration Service and webMethods Integration . . . . . . . . . . . . . . . . . . . . . . . . . . 6

Figure 3-1. Map Values in webMethods Source and Target Definitions . . . . . . . . . . . . . . . . . 18

Figure 3-2. webMethods Source and Target Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19

Figure 3-3. webMethods Source Definition with a Simple Sequence . . . . . . . . . . . . . . . . . . . . 20

Figure 3-4. webMethods Source Definition with a Sequence Containing a Structure . . . . . . . . 22

Figure 3-5. webMethods Target Definition with a Multidimensional Sequence . . . . . . . . . . . . 23

Figure 3-6. webMethods Source Definition with a Nested Sequence . . . . . . . . . . . . . . . . . . . . 24

Figure 4-1. Import from webMethods Broker Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . 27

Figure 6-1. Configuring the Publish/Subscribe Delivery Mode for webMethods Sources . . . . . 44

Figure 6-2. Document Filter Condition in the Session Properties . . . . . . . . . . . . . . . . . . . . . . 46

Figure 6-3. Session Conditions in the Session Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

List of Figures vii

viii List of Figures

List of Tables

Table 1-1. webMethods Document Envelope Fields . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Table 3-1. webMethods Document Envelope Fields in Source and Target Definitions . . . . . . . 16

Table 3-2. Key Naming Convention for Sequences . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Table 6-1. Envelope Fields for Configuring the Delivery Model for webMethods Targets . . . . . 50

Table 6-2. Session Properties for Sequences in webMethods Documents . . . . . . . . . . . . . . . . . 51

Table 6-3. Partition Types for Partition Points in webMethods Mappings . . . . . . . . . . . . . . . . 52

Table A-1. webMethods and Transformation Datatypes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64

List of Tables ix

x List of Tables

Preface

Welcome to PowerCenter Connect, Informatica’s family of packaged software products that helps you extract data and metadata from ERP and other third-party applications.

PowerCenter Connect for webMethods is a natural extension to the open architecture of PowerCenter, which supports data extraction from a wide variety of operational data sources. PowerCenter Connect for webMethods allows you to directly extract data from webMethods documents, transform the data according to your business rules, and load data into webMethods documents or data warehouses.

xi

About This Book

The PowerCenter Connect for webMethods User Guide provides information to build webMethods mappings, extract data from webMethods documents, and load data into webMethods documents. It is written for the database administrators and developers who are responsible for extracting data from webMethods documents and loading data into webMethods documents.

This book assumes you have knowledge of relational database concepts and database engines, PowerCenter, and webMethods. You must also be familiar with the interface requirements for other supporting applications. For additional information about related webMethods issues, refer to the webMethods documentation.

The material in this book is also available online.

Document Conventions

This guide uses the following formatting conventions:

If you see… It means…

italicized text The word or set of words are especially emphasized.

boldfaced text Emphasized subjects.

italicized monospaced text This is the variable name for a value you enter as part of an

operating system command. This is generic text that should be

replaced with user-supplied values.

Note: The following paragraph provides additional facts.

Tip: The following paragraph provides suggested uses.

Warning: The following paragraph notes situations where you can overwrite

or corrupt data, unless you follow the specified procedure.

monospaced text This is a code example.

bold monospaced text This is an operating system command you enter from a prompt to

run a task.

xii Preface

Other Informatica Resources

In addition to the product manuals, Informatica provides these other resources:

♦ Informatica Customer Portal

♦ Informatica web site

♦ Informatica Developer Network

♦ Informatica Knowledge Base

♦ Informatica Technical Support

Visiting Informatica Customer Portal

As an Informatica customer, you can access the Informatica Customer Portal site at http://my.informatica.com. The site contains product information, user group information, newsletters, access to the Informatica customer support case management system (ATLAS), the Informatica Knowledge Base, Informatica Documentation Center, and access to the Informatica user community.

Visiting the Informatica Web Site

You can access the Informatica corporate web site at http://www.informatica.com. The site contains information about Informatica, its background, upcoming events, and sales offices. You will also find product and partner information. The services area of the site includes important information about technical support, training and education, and implementation services.

Visiting the Informatica Developer Network

You can access the Informatica Developer Network at http://devnet.informatica.com. The Informatica Developer Network is a web-based forum for third-party software developers. The site contains information about how to create, market, and support customer-oriented add-on solutions based on interoperability interfaces for Informatica products.

Visiting the Informatica Knowledge Base

As an Informatica customer, you can access the Informatica Knowledge Base at http://my.informatica.com. Use the Knowledge Base to search for documented solutions to known technical issues about Informatica products. You can also find answers to frequently asked questions, technical white papers, and technical tips.

Obtaining Technical Support

There are many ways to access Informatica Technical Support. You can contact a Technical Support Center by using the telephone numbers listed the following table, you can send email, or you can use the WebSupport Service.

Preface xiii

Use the following email addresses to contact Informatica Technical Support:

♦ [email protected] for technical inquiries

♦ [email protected] for general customer service requests

WebSupport requires a user name and password. You can request a user name and password at http://my.informatica.com.

North America / South America Europe / Middle East / Africa Asia / Australia

Informatica Corporation Headquarters

100 Cardinal Way

Redwood City, California

94063

United States

Toll Free

877 463 2435

Standard Rate

United States: 650 385 5800

Informatica Software Ltd.

6 Waltham Park

Waltham Road, White Waltham

Maidenhead, Berkshire

SL6 3TN

United Kingdom

Toll Free

00 800 4632 4357

Standard Rate

Belgium: +32 15 281 702

France: +33 1 41 38 92 26

Germany: +49 1805 702 702

Netherlands: +31 306 022 797

United Kingdom: +44 1628 511 445

Informatica Business Solutions Pvt. Ltd.

Diamond District

Tower B, 3rd Floor

150 Airport Road

Bangalore 560 008

India

Toll Free

Australia: 00 11 800 4632 4357

Singapore: 001 800 4632 4357

Standard Rate

India: +91 80 4112 5738

xiv Preface

C h a p t e r 1

Understanding PowerCenter

Connect for webMethods

This chapter includes the following topics:

♦ Overview, 2

♦ Integrating PowerCenter with webMethods, 3

1

Overview

PowerCenter Connect for webMethods integrates with webMethods to extract data from webMethods sources and write data to webMethods targets. With PowerCenter Connect for webMethods, you can define webMethods source and target metadata in the Designer. You can then use webMethods source and target definitions in a mapping to read documents from webMethods sources and write documents to webMethods targets during a PowerCenter workflow.

When extracting data from webMethods or writing data to webMethods, the Integration Service connects to a webMethods Broker. webMethods Brokers receive, queue, and send webMethods documents. They also store webMethods document metadata.

When the Integration Service reads webMethods documents from the source during a session, it can read webMethods documents based on the client ID. Or, it can read documents based on the document type you define in the webMethods source definition.

When the Integration Service writes webMethods documents to the target during a PowerCenter session, it can write webMethods documents based on the client ID. Or, it can write documents based on the document type you define in the webMethods target definition. The Integration Service can also read and write webMethods request/reply documents.

This chapter provides an overview of the integration between PowerCenter and webMethods. For more information about webMethods, consult the webMethods documentation.

2 Chapter 1: Understanding PowerCenter Connect for webMethods

Integrating PowerCenter with webMethods

PowerCenter Connect for webMethods enables the Integration Service to read documents from webMethods sources and write documents to webMethods targets. To read and write webMethods documents, create mappings with webMethods source and target definitions. Use the Designer to connect to a webMethods Broker to import webMethods source and target metadata for use in a mapping.

Once you create the mapping, use the Workflow Manager to create a session and workflow for the mapping. When you run the workflow, the Integration Service connects to a webMethods Broker to read and write webMethods documents.

Figure 1-1 shows the PowerCenter integration with webMethods:

Designer Integration with the webMethods Broker

The Designer connects to a webMethods Broker to import metadata for webMethods source and target definitions. Before you can connect to a webMethods Broker, define the Broker, the document metadata you want the Broker to contain, and a host name and port number for the Broker. During import, the Designer uses the host name and port number to connect to the Broker to retrieve webMethods document metadata.

webMethods Broker

The Designer connects to a webMethods Broker to import webMethods source and target metadata. A webMethods Broker stores metadata for webMethods documents in the form of document types. Each Broker has a host name and port number. The Designer uses the Broker host name and port number when it connects to the Broker to import webMethods source and target metadata.

Figure 1-1. PowerCenter and webMethods Integration

Designer

Integration

Service

PowerCenter

webMethods

Broker

Workflow

Manager

webMethods

Broker

The Designer connects to a webMethods Broker to define

webMethods sources and targets for use in webMethods

mappings. The Workflow Manager defines webMethods

sessions in workflows.

The Integration Service reads and writes webMethods

documents during a PowerCenter workflow.

A webMethods Broker sends webMethods documents to

Broker Clients and receives webMethods documents from

Broker Clients.

A webMethods Broker stores metadata for webMethods

documents.

Integrating PowerCenter with webMethods 3

Note: PowerCenter also integrates with webMethods Brokers to read and write webMethods documents during a session. For more information about PowerCenter integration with webMethods Brokers during a workflow, see “Integration Service and webMethods Integration” on page 5.

webMethods Enterprise Integrator allows you to define metadata for webMethods documents. The Broker stores the document metadata. When you define webMethods document metadata, you specify a client group, document folder, document type, and document data field metadata. Once you define document folders and types, you associate them with client groups in the Enterprise Server Manager.

The client group controls access to document types. When you connect to a Broker to import webMethods source or target metadata to the Designer, you specify a client group. The Designer displays document folders that belong to that client group.

Client groups can contain multiple document folders. Document folders can contain other document folders. They also contain document types. A document type represents the structure of the documents that belong to it. Document types contain data field names and datatypes for a webMethods document. When you import a webMethods source or target definition, you select a document type. The source or target definition contains metadata that represents that document type.

Figure 1-2 shows an example of document metadata structure in a webMethods Broker:

webMethods Documents

webMethods documents consist of data fields and envelope fields. You define data field names and their datatypes in a Broker. Envelope fields are header fields. webMethods source and target definitions in the Designer can include a predefined set of envelope fields.

Figure 1-2. webMethods Broker Document Metadata Structure

Broker Name

Client Group

Document Folder

Document Folder

Document Type

Data Field Name

Data Field Datatype


Table 1-1 describes the webMethods document envelope fields that appear in webMethods source and/or target definitions:

For more information about the envelope fields in webMethods source and target definitions, see “Envelope Fields” on page 16.

Integration Service and webMethods Integration

During a workflow, the Integration Service connects to a webMethods Broker to read webMethods source documents or write webMethods target documents. During session initialization, the Integration Service creates a Broker Client to connect to a Broker. The Integration Service connects to the Broker using the Broker name, host name, and port number you specified in the application connection you configured for a webMethods source or target. For more information about configuring application connections, see “Managing Connection Objects” in the PowerCenter Workflow Administration Guide.

Table 1-1. webMethods Document Envelope Fields

Header Field Description

pubID Client ID of the publisher of the document.

destID Client ID of the recipient of the document when the delivery mode is deliver/receive.

pubSeqn 64-bit value that represents the publish sequence number of the document.

recvTime Date and time the Broker receives the document.

enqueueTime Date and time the Broker places the document in the queue for the recipient.

trackId Tracks published documents.

tag Matches a request document with the corresponding reply document.

maxResults Maximum number of reply documents a requestor wants to receive.

startResult Value greater than or equal to 0 that signifies the starting number of the document to be

received. Generally used in conjunction with maxResults.

replyTo Client ID to which the document publisher sends reply documents instead of the source of the

request document.

errorsTo Client ID to which the document publisher forwards a document if it encounters an error

processing the document. When there is no value for the field, the publisher discards the

document.

errorRequestsTo Client ID to which the document publisher forwards a request/reply document if it encounters an

error processing the request. When there is no value for the field, the publisher discards the

document.

transactionId Indicates that a document is part of a transaction.

appSeqn Sequence number the document publisher sets for the document.

appLastSeqn Last event of the sequence. When you include a value for this field, it should be the same value

as the appSeqn field for the document.


Once the Integration Service connects to the Broker, it reads source documents from the Broker or writes target documents to the Broker.

The Integration Service can read and write documents using different document delivery models. It can read and write request/reply documents. It can also read and write documents using the publish/subscribe model.

Figure 1-3 shows how the Integration Service connects to a webMethods Broker during a session to read and write documents:

Document Delivery Models

The Integration Service can read documents from webMethods sources and write documents to webMethods targets using the following delivery models:

♦ Request/reply

♦ Publish/subscribe

The request/reply delivery model is for documents that should receive a reply. The reply may contain a response to the request or may just be an acknowledgement of receipt.

The publish/subscribe model is for documents you want to publish or receive that do not require a response. The publish/subscribe model enables the Integration Service to read and write documents in the following modes:

♦ Deliver/receive

♦ Broadcast

Deliver/receive mode is a point-to-point delivery of documents by client ID. Only a Broker Client with a certain client ID can receive the documents. When the Integration Service reads and writes documents in deliver/receive mode, it uses a client ID to read documents from a Broker. When you configure a webMethods application connection, you can specify a client

Figure 1-3. Integration Service and webMethods Integration

WorkflowwebMethods

Application

Connection

Workflow Manager

webMethods

Session

Integration Service

Broker Client

webMethods

Broker

The Integration Service reads and writes

webMethods documents based on workflow and

application connection configurations.

The Integration Service uses the Broker client to

connect to a webMethods Broker to read and write

webMethods documents according to the

document delivery model.

The Integration Service creates a Broker Client

during session initialization to connect to a

webMethods Broker.


ID for the Integration Service to use during a session. Or, the Integration Service can generate a client ID during session initialization.

Broadcast mode means that the document sender sends documents to a Broker for any Broker Client subscribing to the documents to receive. When the Integration Service reads documents in broadcast mode, it reads documents according to the document type that you define in the source definition in the mapping. When the Integration Service writes documents in broadcast mode, it writes documents according to the document type you define in the target definition in the mapping.

For information about configuring delivery models for PowerCenter sessions, see “Configuring the Delivery Model for webMethods Sources” on page 43 and “Configuring the Delivery Model for webMethods Targets” on page 50.


C h a p t e r 2

Configuring PowerCenter

Connect for webMethods


♦ Overview, 10

♦ Step 1. Configure JVM Options for the Integration Service, 11

♦ Step 2. Register the webMethods Libraries, 12

9

Overview

PowerCenter Connect for webMethods requires configuration on the Integration Service and PowerCenter Client to enable integration between PowerCenter and webMethods.

To install and configure PowerCenter Connect for webMethods, complete the following steps:

1. Configure JVM parameters the Integration Service. You must configure JVM options. For more information, see “Step 1. Configure JVM Options for the Integration Service” on page 11.

2. Register libraries and configure the Integration Service. Register webMethods libraries on the machine running the Integration Service and configure the Integration Service to set the CLASSPATH to the webMethods JAR files. For more information, see “Step 2. Register the webMethods Libraries” on page 12.

Note: Configuring the Integration Service to set the path and the CLASSPATH to the JVM library file is required for UNIX. It is optional for Windows.

The Integration Service uses webMethods application connections to connect to a webMethods Broker when it reads webMethods source documents and writes webMethods target documents. For more information about creating webMethods application connections, see “Managing Connection Objects” in the Workflow Administration Guide.

Before You Begin

Before configuring PowerCenter Connect for webMethods, install and configure the following webMethods components:

♦ webMethods Tools. Install and configure on the machine hosting the PowerCenter Client.

♦ webMethods Enterprise Server C API. Install and configure on the machine hosting the PowerCenter Client.

♦ webMethods Enterprise Server Java API. Install and configure on the machine running the Integration Service.

10 Chapter 2: Configuring PowerCenter Connect for webMethods

Step 1. Configure JVM Options for the Integration

Service

When you configure PowerCenter Connect for webMethods, you must configure JVM options. Configure JVM options to run Java-based programs. When you configure JVM options, set the following properties:

♦ Java SDK classpath

♦ Java SDK minimum memory

♦ Java SDK maximum memory

For more information about configuring the JVM options for the Integration Service, see “Creating and Configuring the Integration Service” in the PowerCenter Administrator Guide.

Step 1. Configure JVM Options for the Integration Service 11

Step 2. Register the webMethods Libraries

Before you can import webMethods source and target definitions in the Designer and run sessions to read from webMethods sources or write to webMethods targets, you must complete the following tasks:

♦ Download the webMethods service pack from webMethods.Advantage.

♦ Set the path to the webMethods Enterprise Server directory on Windows.

♦ Set the CLASSPATH to the client JAR file.

Downloading the webMethods Service Pack

The webMethods service pack allows PowerCenter Connect for webMethods to subscribe to webMethods Broker documents. The service pack contains a series of dynamic link libraries (DLLs) and the webMethods client JAR file.

To access the webMethods service pack, go to the webMethods.Advantage web site. webMethods provides instructions for copying the DLLs into a directory and accessing the client JAR file. Once you have completed the service pack download, you can set the path to the webMethods Enterprise Server directory and the CLASSPATH to the client JAR file.

Note: Before you can access the service pack download, you must request an account from webMethods.

To download the webMethods service pack:

1. Log in to: http://advantage.webmethods.com.

2. Click Service Packs from Product Downloads.

3. Scroll to webMethods Adapters and select Business Activity Platform 6.0.1.

4. Follow the instructions provided by webMethods in the readme file to complete the download.

Setting the Path to the webMethods Broker \bin Directory

When you install PowerCenter Connect for webMethods Client on Windows, you must set the path to the webMethods \bin directory to be able to import webMethods source and target definitions.

To set the path to the webMethods Broker \bin directory on Windows:

1. From the Control Panel, click System > Advanced > Environment Variables.

2. From the System Variables settings, select the Path variable and click Edit.


3. Enter the path to the webMethods Broker \bin directory.

For example:

;d:\<webMethods_Broker_directory>\bin

4. Click OK twice.

Setting the CLASSPATH to the webMethods Client JAR File

When you install the PowerCenter Connect for webMethods Server, you must set the CLASSPATH to the client JAR file to be able to run sessions to read from webMethods sources and write to webMethods targets.

If you have webMethods 5.0, set the CLASSPATH to the client50.jar file. If you have webMethods 6.0, set the CLASSPATH to the client60.jar file.

Setting the CLASSPATH to the webMethods Client JAR File on

Windows

You can set the CLASSPATH to the webMethods client JAR File on Windows from the Control Panel.

For example, to set the CLASSPATH to the client60.jar file, enter the following text:

;d:\<webMethods_directory>\common\lib\client60.jar

Setting the CLASSPATH to the webMethods client JAR File on UNIX

When you set the CLASSPATH, use the following guidelines for a UNIX shell:

For example, to set the CLASSPATH to the client JAR file using the C shell, enter the following text:

setenv CLASSPATH /home/<wM_directory>/common/lib/client60.jar:$CLASSPATH

For example, to set the CLASSPATH to the client JAR file using the Bourne shell, enter the following text:

CLASSPATH = home/<wM_directory>/common/lib/client60.jar; export CLASSPATH

UNIX Shell Description

C shell setenv CLASSPATH <JVM_SDK_file_path>:$CLASSPATH

Bourne shell CLASSPATH = <JVM_SDK_file_path>; export CLASSPATH

Step 2. Register the webMethods Libraries 13

C h a p t e r 3

webMethods Source and

Target Concepts


♦ Overview, 16

♦ webMethods Document Metadata, 19

♦ webMethods Sequence Metadata, 20

♦ Sequence Containing a Structure, 22

♦ Multidimensional Sequence, 23

♦ Nested Sequence, 24

15

Overview

webMethods source and target definitions represent metadata for webMethods documents. When the Integration Service extracts documents from a webMethods source during a workflow, it reads documents based on the document type defined in the source definition. When the Integration Service writes documents to a webMethods target during a workflow, it writes documents based on the document type defined in the target definition.

Note: If the document type of a source or target document does not match the document type of the source or target definition, the Integration Service rejects the document during the session. When the Integration Service rejects a document, it enters the content of the rejected document into the session log, and the document is no longer available at the Broker.

A webMethods document can contain the following types of fields:

♦ Envelope fields

♦ Data fields

Envelope Fields

webMethods source and target definitions can include webMethods document envelope fields. You can include envelope fields in a source definition when you want to process data that pertains to the header information in webMethods documents. For example, you may want to track the publisher ID of webMethods documents you read from a source.

Include envelope fields in a target definition when you want to write document header information to a webMethods target. For example, you may want the Integration Service to send target documents according to a particular publication sequence.

Include envelope fields in a source or target definition when you import the source or target definition. When you define a webMethods target based on a source definition, and the source definition contains envelope fields, the Designer adds the appropriate envelope fields to the target definition.

Table 3-1 shows the envelope fields webMethods source and target definitions can contain:

Table 3-1. webMethods Document Envelope Fields in Source and Target Definitions

webMethods Document Envelope Field

webMethods Source Definition

webMethods Target Definition

pubID Yes No

destID Yes Yes

pubSeqn Yes Yes

recvTime Yes No

enqueueTime Yes No

trackId Yes Yes

16 Chapter 3: webMethods Source and Target Concepts

Data Fields

webMethods source and target definitions can also contain webMethods document data fields. When you import webMethods source and target definitions, the data fields in the source and target definitions represent webMethods documents of the document type you imported.

Data fields include webMethods sequence fields. You can extract data from webMethods sequence fields and load data into webMethods sequence fields. A webMethods sequence field contains a sequence of multiple values of the same datatype. When you import webMethods source or target definitions that contain sequence fields, the metadata for each sequence field is represented by a distinct group.

You can import the following kinds of webMethods sequences in the Designer:

♦ Sequence containing a structure

♦ Multidimensional sequence

♦ Nested sequence

For more information, see “webMethods Sequence Metadata” on page 20.

Map Values

Each column in a webMethods source or target definition has a map value. The map value indicates the relationship of the field in the document type hierarchy. When the Integration Service reads documents from a webMethods source, it reads the documents according to the document type structure defined in the map value of the webMethods source definition. Similarly, when the Integration Service writes documents to a webMethods target, it writes the documents according to the document type structure defined in the map value of the webMethods target definition.

Tag Yes Yes

maxResults No Yes

startResult Yes Yes

replyTo Yes Yes

errorsTo Yes Yes

errorRequestsTo Yes Yes

transactionId Yes Yes

appSeqn Yes Yes

appLastSeqn Yes Yes

Table 3-1. webMethods Document Envelope Fields in Source and Target Definitions

webMethods Document Envelope Field

webMethods Source Definition

webMethods Target Definition

Overview 17

The map value shows which columns in a source or target definition represent metadata for envelope fields or data fields. In the map value, all envelope fields include the prefix “_env.”. All data fields contain the name of the corresponding field you defined for the document type in webMethods Enterprise Integrator.

For example, in Enterprise Integrator you define data fields under the document type BUY. You include some of the data fields under a structure folder called DESCRIPTION. The document type BUY is in the document folder TRADE. When you import a source or target definition, you import the document type BUY from the document folder TRADE and include the default envelope fields in the target definition. When you view the Attributes tab of the target definition, you see the envelope fields preceded by _env. and the data fields.

Figure 3-1 shows the target definition TRADE::BUY with the default envelope fields and the data fields for the document type BUY:

Figure 3-1. Map Values in webMethods Source and Target Definitions

Envelope Field Map Value

Column Name: Lowest

Node in the Map Value

Structure Name: Highest

Node in the Map Value

Data Field Map Value

Map Values


webMethods Document Metadata

You can import webMethods document metadata as a source or target definition. When you import a webMethods source or target definition, the Designer creates the appropriate envelope and data fields. For example, if you import a source definition of the document type BUY, the source definition contains the envelope and data fields for the document type BUY.

Figure 3-2 shows webMethods source and target definitions, which contain metadata for the webMethods envelope fields and data fields defined for the document type BUY in webMethods Enterprise Integrator:

Figure 3-2. webMethods Source and Target Definitions

Document Folder NameDocument Type Name

Envelope Fields

Data Fields

Group Name

webMethods Document Metadata 19

webMethods Sequence Metadata

webMethods documents can include webMethods sequence data fields. A sequence field contains a sequence of multiple values of the same datatype. When you import webMethods document metadata that contains a sequence field, the Designer creates a source definition with multiple groups. When you import webMethods document metadata that contains a sequence, the Designer creates a target definition with multiple groups.

When you import a webMethods source or target definition, the Designer creates a root group with top-level webMethods data fields. The root group includes envelope fields and single-dimensional sequences of the Char, Unichar, or Byte webMethods datatypes. For each sequence in a webMethods document that is of a webMethods datatype other than Char, Unichar, or Byte, the Designer creates a sequence group. The Designer also creates a sequence group for Char, Unichar, or Byte datatypes if there is more than one dimension. The Designer names each sequence group according to the sequence name.

Figure 3-3 shows a webMethods source definition with a sequence:

The Designer creates a key relationship between each sequence group in a webMethods source definition and its parent group. It also creates an index key for each dimension in a sequence. Each key is named according to the following convention:

{GPK|GFK|IDX}_<group_name>_<index_number>

Table 3-2 describes the components of a key name in a webMethods source or target definition with a sequence:

Figure 3-3. webMethods Source Definition with a Simple Sequence

Table 3-2. Key Naming Convention for Sequences

Key Name Component Description

GPK|GFK|IDX Type of key. The key name begins with GPK when it is a primary key. The key name begins

with GFK when it is a foreign key. The key name begins with IDX when it is an index key.

group_name Name of the group to which the key belongs.

index_number Distinguishes index keys in the same group. The value of this component for the first index

key in a group is 0. For each subsequent index key in a group, the value is incremented by

one. This component only appears for index keys.

Root Group

Sequence Group

Root Primary Key

Top-level Data Field

Child Foreign Key

Sequence Data Field

Index Key


For example, you want to import metadata for a document type with sequence data fields as a source definition into Sales. The document type contains the following fields:

Type Name

string a

int[] b

As show in Figure 3-3 on page 20, the root group, which is the first group in the source definition, takes the name of the webMethods document, Sales::Simple Array. The Sales::Simple_Array group contains the data field a. The Designer represents the webMethods sequence field b as a group called b. The Sales::Simple_Array and b groups share a primary key/foreign key relationship. The Sales::Simple_Array root group contains the GPK_Sales::Simple_Array primary key. Since the GFK_b foreign key in group b references the GPK_Sales::Simple_Array primary key, group b is a child group to the Sales::Simple_Array group. Group b also contains the IDX_b_0 index key.

webMethods Sequence Metadata 21

Sequence Containing a Structure

A webMethods sequence can contain a structure. A structure is a collection of fields that defines a webMethods data field. The fields that comprise a structure can be simple datatypes, sequences, or other structures. When you import a webMethods source or target definition with a sequence that contains a structure, the Designer creates the structure fields in the sequence group.

For example, you want to import metadata for a document type with a sequence that contains a structure as a source definition in the Designer. The document type is called dept and is in the Sales folder. The document type contains the following fields:

Type Name

string dept_name

struct[] dept_people

string ssn

string name

The Designer creates a multi-group source definition for the dept webMethods document. The source definition for the dept webMethods document includes the dept_people sequence group with the structure fields ssn and name.

Figure 3-4 shows the source definition for the dept webMethods document:

Note: The Designer displays an error when you try to import a sequence with a structure that does not contain fields.

Figure 3-4. webMethods Source Definition with a Sequence Containing a Structure

Structure Fields

Parent Root

Group

Child Group


Multidimensional Sequence

A webMethods document can contain a sequence with multiple dimensions. When you import a webMethods source or target definition with a multidimensional sequence, the Designer creates a unique index key for each dimension in the sequence.

For example, you want to import metadata for a document type with a multidimensional sequence as a source definition in the Designer. The document type is called company and is in the Sales folder. The document type contains the following fields:

Type Name

string company_name

string dept_name

struct[][] company_people

string ssn

string name

The company webMethods document contains a two-dimensional sequence called company_people. When you create the target definition for the company webMethods document, the Designer creates the IDX_company_people_0 index key for the first dimension and the IDX_company_people_1 index key for the second dimension.

Figure 3-5 shows the target definition for a webMethods document with a multidimensional sequence:

Figure 3-5. webMethods Target Definition with a Multidimensional Sequence

Index Key for

First Dimension

Index Key for

Second Dimension

Multidimensional Sequence 23

Nested Sequence

A webMethods document can contain a nested sequence. When you import a webMethods source or target definition with a nested sequence, the Designer creates a group for each sequence. The Designer creates a foreign key in the child sequence group and a primary key in the parent sequence group. This foreign key references the primary key that the Designer creates in the parent sequence group.

For example, you want to import metadata for a document type with a nested sequence as a source definition in the Designer. The document type is called org and is in the Sales folder. The document type contains the following fields:

Type Name

string org_name

struct[] dept

string dept_name

struct[] people

int ssn

string name

The company webMethods document contains the people sequence nested in the dept sequence. When you import the company webMethods document, the Designer creates a key relationship between the dept and people groups. Since the dept sequence contains the people sequence, the Designer includes a primary key in the dept group and a foreign key in the people group. The Designer also creates a key relationship between the Sales::org root group and the dept group.

Figure 3-6 shows the source definition for a webMethods document with a nested sequence:

Figure 3-6. webMethods Source Definition with a Nested Sequence

Primary Key in

Parent Sequence

Foreign Key in Child

Sequence Referencing

Parent Primary Key


C h a p t e r 4

Working with webMethods

Sources


♦ Overview, 26

♦ Creating a webMethods Source Definition, 27

♦ Editing a webMethods Source Definition, 30

♦ Working with the Application Multi-Group Source Qualifier, 31

25

Overview

Use the Designer to import webMethods sources into the PowerCenter repository. You can also use the Designer to manually create webMethods sources. When you import or create webMethods sources, the Designer displays a table with document fields and webMethods datatypes. When the Integration Service extracts data from a webMethods source, it converts the data based on the datatypes in the Application Multi-Group Source Qualifier transformation associated with the source.

26 Chapter 4: Working with webMethods Sources

Creating a webMethods Source Definition

You define a webMethods source by importing webMethods document metadata from a Broker. To import a source definition from a Broker, you enter a Broker host name. If the Broker port number is not the default port number, you also enter a port number. In addition, you must enter the name of a client group the Broker contains. When you connect to the Broker, it lists all document folders and document types in the folders that belong to the client group.

Figure 4-1 shows sample document types and folders in the Import from webMethods Broker dialog box:

Displaying Document Types in a Document Folder

You can display document types that belong to a single document folder. Enter a document folder name in the Scope Name option to when you import a source definition from a webMethods Broker.

For example, you want to view those document types that belong to the document folder ORDER in the client group SALES. In the Import from webMethods Broker dialog box, enter ORDER as the Scope Name to display the document types that directly belong to the document folder ORDER.

If a document type belongs to a document folder within a document folder, it does not display when you use a scope name to filter document types. For example, if a document folder ORDER contains a subfolder SUPPLIES, when you enter ORDER for the scope name, document types in the subfolder SUPPLIES do not display.

Figure 4-1. Import from webMethods Broker Dialog Box

Document Folder Document Type

Creating a webMethods Source Definition 27

Importing a webMethods Source Definition

When you import a webMethods source definition from a webMethods Broker, the Designer names it according to the document folder and document type on which you base the source definition. When you import the first source definition, the Designer places it under a database definition node in the repository folder named for the Broker host name, port number, and Broker name from which you imported the source definition.

To import a source definition from a Broker, define the following parameters:

♦ Broker host name

♦ Client group that the Broker contains

♦ Port number, if the Broker port number is not the default port number

♦ Document folder name, if you want to display the document types that belong to the document folder

To import a webMethods source definition from a Broker:

1. In the Source Analyzer, click Sources > Import from webMethods Broker.

The Import from webMethods Broker dialog box appears.

2. Enter the following information:

3. Click Connect.

The Designer displays a list of document types and their corresponding document folders.

4. Select the document type you want to import.

5. Optionally, select Create Default Envelope Fields to add the default envelope fields to the source definition.

For more information about the default envelope fields for a source definition, see “Overview” on page 16.

Import AttributeRequired/ Optional

Description

Broker Host Required Enter the host name and port number of the Broker in the following format:<host_name>:<port_number>You can omit the port number if the port number for the Broker is the default

port number. Default port number is 6849.

Broker Name Optional Name of the Broker.

Client Group Required Client group where the document metadata is stored.

Scope Name Optional Enter a document folder name to display the document types that appear in

the document folder. Document types that belong to subfolders of the

document folder you enter for the scope name do not display.


6. Click Import.

A webMethods source definition appears in the Source Analyzer.

Note: webMethods document types are case sensitive. However, PowerCenter source definition names are not. Therefore, when you import a webMethods source definition, and the repository already contains a source definition with the same name that uses different capitalization, the Designer may ask if you want to overwrite the existing source definition. Also, the Designer displays an error when you try to import a sequence with a structure that does not contain fields.

Creating a webMethods Source Definition 29

Editing a webMethods Source Definition

You can edit webMethods source definitions to change the precision of certain fields. You can also modify the name and description of source definitions. In addition, you can change the name of the fields in a source definition. When you change the names of fields, the Designer does not update the map value to reflect the changes. For more information about map values, see “Map Values” on page 17.

Note: You cannot edit a webMethods source definition to reflect changes in document metadata. To update a source definition to reflect changes in the webMethods document metadata, recreate the source definition.

To edit webMethods source definitions:

1. Double-click the title bar of the source definition in the Source Analyzer.

2. On the Table tab of the Edit Tables dialog box, optionally edit the following settings:

3. Click the Columns tab.

4. Optionally, edit the precision of any applicable fields.

5. Optionally, modify the name of any fields.

6. Click OK.

Table Settings Edit Description

Select Table Yes Displays the source definition you are editing. To edit a different source or

target definition, select it from the list.

Rename button Yes Edit the name of the source definition. You can also edit the database

definition node name.

Business Name No Not applicable for webMethods source definitions.

Owner Name Yes Not applicable for webMethods source definitions.

Description Yes Optional description of the source definition. Character limit is 2000 bytes/K,

where K is the maximum number of bytes for each character in the

PowerCenter repository code page. Enter links to business documentation.

Database Type No Database type is set to webMethods.


Working with the Application Multi-Group Source

Qualifier

An Application Multi-Group Source Qualifier in a mapping determines how the Integration Service reads data from the webMethods source. To extract data from multiple webMethods sources, you must have an Application Multi-Group Source Qualifier for each source definition in the mapping. During a session, the Integration Service reads documents from the webMethods source based on the connected ports and transformation properties.

Note: You cannot edit an Application Multi-Group Source Qualifier transformation.

The following mapping shows webMethods source definition connected to an Application Multi-Group Source Qualifier:

Creating an Application Multi-Group Source Qualifier

By default, the Designer creates an Application Multi-Group Source Qualifier when you add a webMethods source definition to a mapping. If you configure the Designer to manually create a Source Qualifier when you add a source definition to a mapping, you must manually connect an Application Multi-Group Source Qualifier to a webMethods source definition. For more information about manually connecting Source Qualifiers to source definitions in a mapping, see the PowerCenter Designer Guide.

Transformation Datatypes

The transformation datatypes in the Application Multi-Group Source Qualifier are internal datatypes based on ANSI SQL-92 generic datatypes, which PowerCenter uses to move data across platforms. When the Integration Service reads data from a webMethods source, it converts the data from its native datatype to the transformation datatype. When you run a session, the Integration Service performs transformations based on the transformation datatypes. When writing data to a target, the Integration Service converts the data based on the native datatypes in the target definition.

Working with the Application Multi-Group Source Qualifier 31

C h a p t e r 5

Working with webMethods

Targets


♦ Overview, 34

♦ Creating a webMethods Target Definition, 36

♦ Editing webMethods Target Definitions, 38

33

Overview

Use the Designer to import webMethods targets into the PowerCenter repository. You can also use the Designer to manually create webMethods targets. When you import or create webMethods targets, the Designer displays a table with document fields and webMethods datatypes.

Working with the pubSeqn Envelope Field

When you want the Integration Service to write target webMethods documents with a publication sequence number, you must pass a value to the pubSeqn envelope field in the webMethods target definition in the mapping. The Integration Service does not generate a value for this field.

Also, ensure that the Integration Service writes documents to the target according to the sequence number in the pubSeqn field. The webMethods Broker does not accept documents out of sequence.

Maintaining Transactional Consistency for webMethods Targets

The Integration Service can maintain transactional consistency when writing data to webMethods targets. When the Integration Service maintains transactional consistency, it commits messages to webMethods targets once all documents in a transaction group are loaded to the targets.

A transaction group consists of all documents that the Integration Service commits when it reaches a commit point. If a session aborts or fails during a transaction, the Integration Service rolls back all documents in the transaction group from the targets. When you enable recovery and a session aborts or fails, you can restart the session in recovery mode. During a recovery session, the Integration Service loads the documents to the targets.

To ensure transactional consistency, all webMethods targets in the same pipeline must belong to the same target connection group. webMethods targets that are in the same target connection group receive data from the same transactional source. Additionally, two or more webMethods targets are in the same target connection group if they have the same value for each of the following connection properties:

♦ Broker Host

♦ Broker Name

♦ Client ID

♦ Client Group

♦ Application Name

♦ Automatic Reconnection

♦ Preserve Client State

For more information about source and target-based commits, see the PowerCenter Workflow Administration Guide. For more information about running sessions with transactional

34 Chapter 5: Working with webMethods Targets

consistency, see “Configuring Transactional Consistency for webMethods Targets” on page 51. For more information about target connection groups, see the PowerCenter Workflow Administration Guide.

Determining Load Scope for webMethods Targets

After you add a webMethods target definition to a mapping, use the Load Scope option in the target properties to determine how the Integration Service writes documents to the target. You can generate document data after each row, after each transaction, or at the end of file. For more information about using the Load Scope option, see “Configuring Load Scope” on page 39.

Overview 35

Creating a webMethods Target Definition

You can create a webMethods target definition by importing webMethods document metadata from a Broker. You can also create a webMethods target definition based on a webMethods source definition.

Importing a webMethods Target Definition

You define a webMethods target by importing webMethods document metadata from a Broker. To import a target definition from a Broker, define the following parameters:

♦ Broker host name

♦ The client group that the Broker contains

♦ Port number, if the Broker port number is not the default port number

♦ Document folder name, if you want to display the document types that belong to the document folder

To import a webMethods target definition from a Broker:

1. In the Target Designer, click Targets > Import from webMethods Broker.

The Import from webMethods Broker dialog box appears.

2. Enter the following information:

3. Click Connect.

The Designer displays a list of document types and their corresponding document folders.

4. Select the document type you want to import.

Import AttributeRequired/ Optional

Description

Broker Host Required Enter the host name and port number of the Broker in the following format:<host_name:port>You can omit the port number if the port number for the Broker is the default

port number. The default port number is 6849.

Broker Name Optional Name of the Broker.

Client Group Required Client group where the document metadata is stored.

Scope Name Optional Enter a document folder name to display the document types that appear in

the document folder. Document types that belong to subfolders of the

document folder you enter for the scope name do not display.


5. Optionally, select Create Default Envelope Fields to add the default envelope fields to the target definition.

For more information about the default envelope fields for a target definition, see “Overview” on page 16.

6. Click Import.

A webMethods target definition appears in the Target Designer.

Note: webMethods document types are case sensitive. However, PowerCenter target definition names are not. Therefore, when you import a webMethods target definition, and the repository already contains a target definition with the same name that uses different capitalization, the Designer may ask if you want to overwrite the existing target definition.

Creating a Target Definition Based on a Source Definition

Use the following procedure to create a webMethods target definition based on a webMethods source definition.

To create a webMethods target definition based on a webMethods source definition:

In the Target Designer, drag a webMethods source definition to the workspace.

If the source definition contains envelope fields, the Designer adds the appropriate envelope fields to the target definition. For more information about the default envelope fields for a target definition, see “Overview” on page 16.

Creating a webMethods Target Definition 37

Editing webMethods Target Definitions

You can edit webMethods target definitions to change the precision of certain fields. You can also modify the name and description of target definitions. In addition, you can change the name of the fields in a target definition. When you change the names of fields, the Designer does not update the map value to reflect the changes. For more information about map values, see “Map Values” on page 17.

Note: You cannot edit a webMethods target definition to reflect changes in document metadata. To update a target definition to reflect changes in the webMethods document metadata, recreate the target definition.

Steps to Edit a webMethods Target Definition

Use the following procedure to edit a webMethods target definition.

To edit webMethods target definitions:

1. Double-click the title bar of the target definition in the Target Designer.

2. On the Table tab of the Edit Tables dialog box, optionally edit the following settings:

3. Click the Columns tab.

4. Optionally, edit the precision of any applicable fields.

5. Optionally, modify the name of any fields.

6. Click OK.

Table Settings Edit Description

Select Table Yes Displays the target definition you are editing. To edit a different target definition,

select it from the list.

Rename button Yes Edit the name of the target definition.

Business Name No Not applicable for webMethods target definitions.

Constraints Yes Not applicable to webMethods target definitions. Any entry is ignored.

Creation Options Yes Not applicable to webMethods target definitions. Any entry is ignored.

Description Yes Optional description of the target definition. Character limit is 2000 bytes/K,

where K is the maximum number of bytes for each character in the PowerCenter

repository code page. Enter links to business documentation.

Database Type No Database type is set to webMethods.

Edit Keywords Yes Add keywords to the target definition. Use the keywords to perform searches in

the Repository Manager.


Configuring Load Scope

After you add a webMethods target definition to a mapping, you can set the Load Scope option to determine how the Integration Service writes webMethods documents to the target.

To set the Load Scope option:

1. Double-click the title bar of the target definition in the Mapping Designer.

2. Click the Properties tab.

3. Select a value for Load Scope:

♦ Row. Generates document data for each row.

♦ Transaction. Generates document data for all fields in a transaction on commit.

♦ All Input. Generates document data at end of file. This is the default value.

4. Click OK.

Load Scope

Editing webMethods Target Definitions 39

C h a p t e r 6

Creating and Configuring

webMethods Workflows


♦ Overview, 42

♦ Working with webMethods Workflows, 43

♦ Configuring a Session with a webMethods Mapping, 53

♦ Configuring and Scheduling Workflows, 60

♦ Troubleshooting, 61

41

Overview

After you create mappings in the Designer, you can create a session and use the session in a workflow to extract, transform, and load data. You create sessions and workflows in the Workflow Manager.

Before configuring a webMethods workflow, you must complete the following tasks:

♦ Configure an Integration Service. Configure an Integration Service to run webMethods workflows. For more information about configuring an Integration Service, see the PowerCenter Administrator Guide.

♦ Configure source and target connections. To read data from webMethods or write data to webMethods during a workflow, you need to configure an application connection for webMethods sources and targets in the Workflow Manager. For more information about configuring connections, see “Managing Connection Objects” in the PowerCenter Workflow Administration Guide.

You cannot use a connection variable for an application connection. For more information about connection variables, see the PowerCenter Workflow Administration Guide.

42 Chapter 6: Creating and Configuring webMethods Workflows

Working with webMethods Workflows

When you configure a webMethods workflow, you define the session and scheduler properties that determine how the Integration Service reads documents from a webMethods source or writes documents to a webMethods target. You can configure the following webMethods session and workflow properties:

♦ Delivery model for sources. Configure the delivery model for webMethods sources. For more information, see “Configuring the Delivery Model for webMethods Sources” on page 43.

♦ Document filtering. Enter a filter condition to filter source documents. For more information, see “Filtering Source Documents” on page 44.

♦ Session conditions. Set session conditions for a session in a workflow. For more information, see “Configuring Session Conditions” on page 46.

♦ Real-time data extraction. Configure a session in a workflow to extract data in real time. For more information, see “Real-time Flush Latency” on page 48.

♦ Message recovery. Enable recovery for a session in a workflow. For more information, see “Message Recovery” on page 49.

♦ Delivery model for targets. Configure the delivery model for webMethods targets. For more information, see “Configuring the Delivery Model for webMethods Targets” on page 50.

♦ Sequence support. Configure how the Integration Service reads data from webMethods sequences and writes data to webMethods sequences. For more information, see “Reading and Writing Sequences in webMethods Documents” on page 51.

♦ Transactional consistency for targets. Configure transactional consistency for webMethods targets. For more information, see “Configuring Transactional Consistency for webMethods Targets” on page 51.

♦ Pipeline partitioning. Set partitions in a pipeline for a session in a workflow. For more information, see “Pipeline Partitioning” on page 52.

Configuring the Delivery Model for webMethods Sources

When the Integration Service reads documents from a webMethods source, it uses the publish/subscribe model by default. When the Integration Service reads documents using the publish/subscribe model, it reads documents in both deliver/receive mode and broadcast mode.

You can configure the session properties to enable the Integration Service to only read source documents in deliver/receive mode. When you configure this option, the Integration Service only receives documents that have a particular client ID.

You can specify the client ID in one of the following ways:

♦ Enter the client ID in the webMethods application connection properties.

♦ The webMethods Broker can generate a client ID when you run the session.

Working with webMethods Workflows 43

Note: If you want to run multiple sessions simultaneously that read documents from webMethods sources, enter a separate client ID for each source. For more information about running multiple sessions simultaneously, see “Configuring Workflows to Run Multiple Sessions Simultaneously” on page 60.

To configure the delivery model for webMethods sources, select one of the following options:

♦ Select the Subscribe Document option for the Integration Service to subscribe to source documents using the publish/subscribe model. When the Subscribe Document option is selected, the Integration Service reads documents using the publish/subscribe model. It reads documents in both deliver/receive mode and broadcast mode.

♦ Clear the Subscribe Document option for the Integration Service to receive source documents in deliver/receive mode only.

Figure 6-1 shows the Subscribe Document option in the session properties:

Filtering Source Documents

When you configure a webMethods session in a workflow to read documents using the publish/subscribe model to read documents in deliver/receive and broadcast mode, you can enter a filter condition to filter source documents. You cannot filter source documents when you want to read source documents in deliver/receive mode only.

Figure 6-1. Configuring the Publish/Subscribe Delivery Mode for webMethods Sources

Subscribe

Document Option


You can filter documents by document data fields. When you enter a filter condition and run the session, the Broker only makes documents available for the Integration Service that meet the filter condition.

For example, you want to read documents from a webMethods source of the document type TRADE::BUY. The document type contains a data field SYMBOL. When the Integration Service reads source documents, you want the webMethods Broker to only make documents available that contain the value INFA in the data field SYMBOL. You can enter a filter condition to only receive documents of the value INFA in the data field SYMBOL from source documents of type TRADE::BUY. During the session, the Broker only makes the documents that meet the filter condition available for the Integration Service to read from the source.

To filter documents from a webMethods source, complete the following tasks in the session properties:

1. Select Subscribe Document option in the Properties settings on the Mapping tab (Sources node).

2. Enter a filter condition for the Subscription Filter Expression attribute in the Properties settings on the Mapping tab (Sources node).

Specify a filter condition according to the syntax in the webMethods documentation. If you do not use webMethods syntax when entering a filter condition, the Integration Service fails the session during session initialization. For example, you can enter the following filter condition to read documents with the value INFA in the data field SYMBOL:

SYMBOL = “INFA”

If you modified a field name in the source definition, make sure the filter condition you enter uses the map value for the field, not the modified field name. For example, you imported a source definition with the data field NAME. You changed the field in the source definition to CUSTOMER_NAME. If you enter a filter condition for this field, use the value NAME instead of CUSTOMER_NAME according to the map value for the field in the source definition. For more information about map values in source definitions, see “Map Values” on page 17.


Figure 6-2 shows the Properties settings on the Mapping tab (Sources node) where you enter a document filter condition:

Configuring Session Conditions

When you configure a webMethods session in a workflow, you can set values for session conditions. You set the session conditions from the Properties settings on the Mapping tab in the session properties.

You can define the following session conditions:

♦ Idle Time

♦ Message Count

♦ Reader Time Limit

♦ Real-time Flush Latency

The Idle Time, Message Count, and Reader Time Limit session conditions control when the Integration Service stops reading from the webMethods Broker. The Real-time Flush Latency session condition controls when the Integration Service commits documents to the target for real-time data extraction during the session.

Figure 6-2. Document Filter Condition in the Session Properties

Document

Filter

Condition


Figure 6-3 shows the Properties settings on the Mapping tab (Sources node) in the session properties where you set session conditions:

When you enter values for multiple session conditions, the Integration Service stops reading from the webMethods Broker when the first session condition is met. For example, if you set the Idle Time value to 10 seconds and the Message Count value to 100 documents, the Integration Service stops reading from the webMethods Broker after 10 seconds or after reading 100 documents, whichever comes first.

Idle Time

Use the Idle Time session condition to indicate how many seconds the Integration Service waits when no documents arrive before it stops reading from the webMethods Broker. For example, if you enter 30 for Idle Time, the Integration Service waits 30 seconds after reading from the webMethods Broker. If no new documents arrive in the webMethods Broker within 30 seconds, the Integration Service stops reading from the webMethods Broker.

Message Count

Use the Message Count session condition to control the number of documents the Integration Service reads from the webMethods Broker before stopping. For example, when you specify 100 for Message Count, the Integration Service reads 100 documents from the webMethods Broker.

Figure 6-3. Session Conditions in the Session Properties

Session

Conditions


If you enter a Message Count value, and you configure the session to use pipeline partitioning, the session can run on a single node only. The Integration Service that runs the session cannot run on a grid or on primary and backup nodes.

Reader Time Limit

Use the Reader Time Limit session condition to read documents from the webMethods Broker for a set period of time in seconds. The Integration Service reads documents from the webMethods Broker for the number of seconds you specify. For example, if you specify 10 for Reader Time Limit, the Integration Service stops reading from the webMethods Broker after 10 seconds.

Real-time Flush Latency

Use the Real-time Flush Latency session condition in a session with a webMethods source in the mapping to run the session in real time. When you use the Real-time Flush Latency session condition, the Integration Service commits webMethods source documents to the target at the end of a specified maximum latency period. Specify a Real-time Flush Latency value in seconds in the session properties.

For example, if the value for Real-time Flush Latency is 5, the Integration Service commits all documents read from the source five seconds after the first document enters the source. The lower you set the interval, the faster the Integration Service commits documents to the target.

Note: When you specify a low Real-time Flush Latency interval, the session might consume more system resources.

When you want to use the Real-time Flush Latency session condition to run a session in real time, complete the following steps:

1. If the pipeline contains an XML target definition, select Append to Document for the On Commit option from the Properties tab when you edit the target definition.

2. Configure the session for source-based commits in the session properties.

3. When you configure the session to use source-based commits and add partitions to the pipeline, you must specify pass-through partitioning at each partition point.

4. Configure a real-time session to run as a continuous workflow. For more information about scheduling a workflow, see “Configuring and Scheduling Workflows” on page 60.

When the Integration Service runs the session, it begins to read documents from the source. Once documents enter the source, the Real-time Flush Latency interval begins. At the end of each five second Real-time Flush Latency interval, the Integration Service commits all documents read from the source.

When you set the Real-time Flush Latency session condition and configure the session to use source-based commits, the Integration Service commits documents to the target using the source-based commit interval and the Real-time Flush Latency interval.

For example, you use 5 seconds as the Real-time Flush Latency session condition and you set the source-based commit interval to 1,000 documents. The Integration Service commits


documents to the target at two points: after reading 1,000 documents from the source and after each five second Real-time Flush Latency interval.

If you configure the session to use target-based commits, the Integration Service runs the session using source-based commits. Also, it only commits documents to the target based on the Real-time Flush Latency interval. It does not commit documents to the target based on the commit interval. For more information about commit types and intervals, see the PowerCenter Workflow Administration Guide.

When you use the Real-time Flush Latency session condition, the following limitations apply:

♦ The pipeline cannot contain Transaction Control transformations.

♦ The pipeline cannot contain Custom transformations with the Generate Transaction option selected. You select the Generate Transaction option on the Properties tab of the Edit Transformations dialog box.

♦ The pipeline cannot contain transformations with the All Input option selected for the Transformation Scope property. You select a value for the Transformation Scope property on the Properties tab of the Edit Transformations dialog box.

♦ The pipeline cannot contain any transformation that has row transformation scope and receives input from multiple transaction control points.

♦ The mapping cannot contain a flat file target definition.

♦ The session cannot contain partition types other than pass-through at all partition points.

♦ The Integration Service ignores the Real-time Flush Latency session condition when you run a session in debug mode.

♦ If the mapping contains a relational target, the Target Load Type attribute in the Properties settings on the Mapping tab (Targets node) in the session properties should be Normal.

Message Recovery

You can configure message recovery for sessions that fail when reading documents from a webMethods source. When you enable message recovery, the Integration Service stores all documents it reads from the webMethods source in a cache before processing the documents for the target. If the session fails, run the session in recovery mode to recover the documents the Integration Service could not process during in the previous session run.

During the recovery session, the Integration Service reads the documents from the cache. After the Integration Service reads the documents from the cache and processes them for the target, the recovery session ends.

The Integration Service removes documents from the cache after the Real-time Flush Latency period expires. It also empties the cache at the end of the session. If the session fails after the Integration Service commits documents to the target but before it removes the documents from the cache, targets may receive duplicate rows during the next session run.


To enable session recovery, complete the following tasks:

1. Select a recovery strategy in the session properties.

2. Specify a recovery cache folder in the session properties at each partition point.

If you change the mapping or the session properties and then restart the session, the Integration Service creates a new cache file and then runs the session. This can result in data loss during the session run.

For more information about message recovery, see “Real-time Processing” in the Workflow Administration Guide.

Configuring the Delivery Model for webMethods Targets

By default the Integration Service writes webMethods documents to targets using the publish/subscribe model in broadcast mode. You can configure document envelope fields in the session properties to write webMethods target documents in the following ways:

♦ Deliver/receive mode

♦ Request/reply model

Configure the envelope fields in the session properties to change the delivery model when the mapping does not pass data to the corresponding envelope fields in the webMethods target definition. For example, you want to write documents to a webMethods target using the request/reply model. The mapping contains a flat file source definition. The mapping transforms the source data and writes the data to data fields in the webMethods target. However, it does not pass data to the envelope fields. You can configure the session properties to pass a value to the replyTo, errorsTo, and errorRequestsTo envelope fields in the target documents to write documents in deliver/receive mode.

Table 6-1 describes the envelope fields you can configure in the session properties to set the delivery model:

Table 6-1. Envelope Fields for Configuring the Delivery Model for webMethods Targets

Properties Settings Delivery Mode Description

Destination Client ID Deliver/Receive Client ID with which you want the Integration Service to deliver target

documents. The Broker Client that receives the target documents must

use this client ID to receive the documents.

Reply To Request/Reply Client ID of the webMethods target to whom you want to send target

documents that are replies. The Reply To client ID should not be the

originator of the document.

Errors To Request/Reply Client ID of the webMethods target to whom you want to send target

documents if there are any errors processing a request document.

Error Requests To Request/Reply If there is an error processing the request document, enter another

destination for the request.


If the mapping passes values to the envelope fields in the target, and the session configuration contains values for these fields, the Integration Service overwrites the values in the session properties with the values in the target.

For more information about webMethods envelope fields, see “webMethods Documents” on page 4, “Working with webMethods Sources” on page 25, and “Working with webMethods Targets” on page 33. For more information about configuring values for webMethods document header fields in the session properties, see “Configuring a Session with a webMethods Mapping” on page 53.

Reading and Writing Sequences in webMethods Documents

You can configure how the Integration Service reads and writes webMethods documents that contain sequences.

Table 6-2 describes the options you can configure in the session properties to define how the Integration Service reads and writes webMethods sequences:

Configuring Transactional Consistency for webMethods Targets

The Integration Service can maintain transactional consistency for sessions with webMethods sources and targets. With transactional consistency, the Integration Service commits documents to webMethods targets in transaction groups. If the session aborts or fails during a transaction, the Integration Service rolls back all documents in the group from the targets.

Use the following guidelines when you configure transactional consistency:

♦ Select an application connection with the same connection properties for each webMethods target in the pipeline. Using the same connection properties ensures that all webMethods targets in a single pipeline belong to the same target connection group.

♦ Configure source-based commits for the session.

♦ Set a commit interval to define the commit point for a transaction group.

For more information about transactional consistency in webMethods mappings with webMethods targets, see “Maintaining Transactional Consistency for webMethods Targets” on page 34. For more information about target connection groups and source and target-based commits, see the PowerCenter Workflow Administration Guide.

Table 6-2. Session Properties for Sequences in webMethods Documents

Properties

Settings

Required/ Optional

Description

Orphan Handling Required Specifies how to handle the error if sequence group data does not correspond to

parent group data.

Duplicate Handling Required Specifies how to handle the error if two or more rows contain the same primary key

value.

Process Messages

on Transaction

Optional Specifies whether documents are flushed when a transaction is committed.


Pipeline Partitioning

You can increase the number of partitions in a pipeline to improve session performance. Increasing the number of partitions allows the Integration Service to create multiple connections to sources and process partitions of sources and targets concurrently.

When you create a session in a workflow, the Workflow Manager validates each pipeline in the mapping for partitioning. You can specify multiple partitions in a pipeline if the Integration Service can maintain data consistency when it processes the partitioned data.

Table 6-3 describes the partition types for partition points in webMethods mappings:

For more information about partitioning and a list of all partitioning restrictions, see the PowerCenter Workflow Administration Guide.

Specifying Partitions and a Recovery Cache Folder

When you specify partitions for a webMethods mapping in a session, and you configure the Recovery Cache Folder attribute in the session properties, enter a cache folder on a different physical drive for each reader partition in the pipeline for better performance.

Table 6-3. Partition Types for Partition Points in webMethods Mappings

Partition Point Partition Type

Application Multi-Group Source Qualifier Pass-through

webMethods target All


Configuring a Session with a webMethods Mapping

When you configure a session using a webMethods source or target definition, set the following session properties:

♦ Connection type for Application Multi-Group Source Qualifiers for webMethods sources

♦ Connection type for webMethods targets

You can also configure the session with the following properties:

♦ Commit type and interval

♦ Error handling

♦ Message recovery

♦ Delivery model for webMethods sources

♦ Document filter condition

♦ Session conditions

♦ Delivery model for webMethods targets

♦ Transactional consistency

♦ Pipeline partitioning

Configuring a Session with a webMethods Mapping 53

To configure session properties for a webMethods session:

1. In the Task Developer, double-click a webMethods session to open the session properties.

2. From the Connections settings on the Mapping tab (Sources node), select a webMethods application connection for Application Multi-Group Source Qualifiers connected to webMethods source definitions.

For more information about configuring application connections, see “Managing Connection Objects” in the PowerCenter Workflow Administration Guide.


3. From the Connections settings on the Mapping tab (Targets node), select a webMethods application connection for each webMethods target definition.

Tip: If you configure the session for transaction consistency, verify that all webMethods target definitions in a single pipeline belong to the same target connection group. For more information about configuring transaction consistency, see “Configuring Transactional Consistency for webMethods Targets” on page 51. For more information about configuring application connections, see “Managing Connection Objects” in the PowerCenter Workflow Administration Guide.


4. From the General Options on the Properties tab, select Source as the commit type to extract data in real time and ensure transactional consistency.

5. Optionally, edit the commit interval.

6. Select a recovery strategy.

To enable message recovery, select Resume from Last Checkpoint.

If you enable message recovery, you can configure a value for the recovery cache folder from the Properties settings of the Mapping tab (Sources node). Or, use the default cache folder $PMCacheDir\.

Commit

Type

Commit

Interval

Recovery

Strategy


7. From the Error Handling settings on the Config Objects tab, optionally select a value for Stop on Errors.

When you select a value for Stop on Errors, the Integration Service fails the session when it reaches the number of specified errors for the partition.

8. From the Properties settings on the Mapping tab (Sources node), clear Subscribe Documents if you want the Integration Service to only receive webMethods documents in deliver/receive mode from the source.

If you want the Integration Service to subscribe to webMethods documents with both the broadcast and deliver/receive modes using the publish/subscribe model, make sure Subscribe Documents is selected. For more information about configuring the delivery mode for webMethods source documents, see “Configuring the Delivery Model for webMethods Sources” on page 43.

9. Optionally, enter a filter condition in the Subscription Filter Expression option if you want to filter webMethods source documents.

For more information about filtering webMethods source documents, see “Filtering Source Documents” on page 44.

10. Optionally, edit the values for the Idle Time, Message Count, Reader Time Limit, and/or Real-time Flush Latency session conditions.

Stop on

Errors


The Workflow Manager assigns the following default values to the session conditions:

For more information about session conditions, see “Configuring Session Conditions” on page 46.

11. If you enabled message recovery, you can enter a value for the recovery cache folder. Or, use the default cache folder $PMCacheDir\.

12. Click the Properties settings on the Mapping tab (Targets node).

Session ConditionDefault Value

Description

Idle Time -1 webMethods Broker can remain idle for an infinite period of time before

the PowerCenter session ends.

Message Count -1 Integration Service can read an infinite number of documents from the

webMethods Broker before the session ends.

Reader Time Limit 0 Integration Service can read source documents from a webMethods

Broker for an infinite period of time.

Real-time Flush Latency 0 Integration Service does not run the session in real time.


13. Enter the following properties:

For more information about setting values for webMethods document envelope fields for webMethods targets in the session properties, see “Configuring the Delivery Model for webMethods Targets” on page 50.

14. Click OK to exit the session properties.

Properties

Settings

Required/ Optional

Description

Destination

Client ID*

Optional Client ID with which you want the Integration Service to deliver target documents.

The Broker Client that receives the target documents must use this client ID to

receive the documents. Use this option to send target documents in deliver/

receive mode.

Reply To* Optional Client ID of the webMethods target to whom you want to send target documents

that are replies. The Reply To client ID cannot be the originator of the document.

Use this option to send target documents using the request/reply delivery model.

Errors To* Optional Client ID of the webMethods target to whom you want to send target documents if

there are any errors processing a request document. Use this option to send

target documents using the request/reply delivery model.

Error

Requests To*

Optional If there is an error processing the request document, this field states another

destination for the request. Use this option to send target documents using the

request/reply delivery model.

Send Interval Required Minimum amount of time in milliseconds the Integration Service waits between

each document when writing documents to the target. For example, if you set the

send interval to 2, the Integration Service waits at least two milliseconds before

writing documents to the target. The targets receive the documents once the

Integration Service issues a commit.

If you stop the session during the session run, the Integration Service waits until

it writes the document it is processing to the target before stopping the session.

Therefore, if you set a high value for Send Interval, the session may take longer

to stop. Default is 1.

Orphan

Handling

Required Select Ignore to ignore errors when sequence group data does not correspond to

parent group data. Otherwise, select Error.

Duplicate

Handling

Required Select Error, First, or Last.

Process

Messages on

Transaction

Optional Specifies whether documents are flushed when a transaction is committed.

*If the target definition contains a value for any of these fields, it overwrites the value you provide in the session properties.


Configuring and Scheduling Workflows

Before you run a session in a workflow, you must configure and schedule the workflow.

Configuring Workflows to Run Multiple Sessions Simultaneously

When you configure a workflow to simultaneously run multiple sessions to read documents from webMethods sources or write documents to webMethods targets, make sure that each source or target that shares the same client state uses a different client ID. Otherwise, the session may not process the expected data.

To ensure that each source uses a different client ID, create multiple application connections with different client IDs. Assign each Application Multi-Group Source Qualifier associated with a webMethods source a different webMethods application connection.

To ensure that each target uses a different client ID, create multiple application connections with different client IDs. Assign each target a different application connection.

For more information about configuring application connections, see “Managing Connection Objects” in the PowerCenter Workflow Administration Guide.

Scheduling Workflows

Before you run a session in a workflow, configure and schedule the workflow. You can schedule a workflow to run continuously, run at a given time or interval, or you can manually start a workflow. The Integration Service runs scheduled workflows through the duration of the schedule, unless the workflow fails.

To run a continuous workflow, select Run Continuously when you edit the scheduler for the workflow. A continuous workflow starts as soon as the Integration Service initializes. When the workflow stops, it restarts immediately. For more information about scheduling workflows, see the PowerCenter Workflow Administration Guide.


Troubleshooting

I ran a session to write documents to a webMethods target. The session log reported that the

Integration Service wrote all of the documents to the target successfully. However, my

Broker Client did not receive all of the documents.

When the Integration Service wrote documents to the target, the documents were not in sequence according to the pubSeqn envelope field. The webMethods Broker only accepts documents in sequence. For more information, see the webMethods documentation.

I ran multiple sessions simultaneously to read documents from webMethods sources. The

session completed successfully. However, the Integration Service did not receive all of the

documents.

If you run multiple sessions simultaneously to read documents from webMethods sources, each source must use a different client ID. For more information about configuring client IDs for multiple webMethods targets during a session, see “Configuring a Session with a webMethods Mapping” on page 53.

A source or target document is missing after running a session.

Make sure that the document type of the source or target document matches the document type of the source or target definition. If these document types do not match, the Integration Service rejects the document, and the document is no longer available at the Broker. You can view the content of a rejected document in the session log file.

Troubleshooting 61

A p p e n d i x A

webMethods Datatype Reference

This appendix includes the following topics:

♦ Datatype Reference, 64

63

Datatype Reference

PowerCenter uses the following datatypes in webMethods mappings:

♦ webMethods datatypes. webMethods datatypes appear in webMethods source and target definitions in a mapping.

♦ Transformation datatypes. Transformation datatypes are generic datatypes that PowerCenter uses during the transformation process. They appear in all transformations in a mapping.

webMethods and Transformation Datatypes

When the Integration Service reads data from a webMethods source, it converts the data in the document envelope and data fields to transformation datatypes used in the Application Multi-Group Source Qualifier transformation. When writing data to a webMethods target, the Integration Service converts the data based on the native datatypes in the target documents. The Integration Service converts webMethods data with webMethods datatypes.

Table A-1 lists the webMethods datatypes that PowerCenter supports and the corresponding transformation datatypes:

Table A-1. webMethods and Transformation Datatypes

webMethods Datatype Transformation Datatype Range and Description

Boolean String Precision of 1 and scale of 0.

Byte Small Integer Precision of 3 and scale of 0.

Byte_Seqn Binary Precision of 10 and scale of 0.

Char String Precision of 1 and scale of 0.

Char_Seqn String Precision of 1 and scale of 0.

Date Date/Time Precision of 23.

Double Double Precision of 15 and scale of 0.

Float Double Precision of 10 and scale of 0.

Int Integer Precision of 10 and scale of 0.

Long Decimal Precision of 19 and scale of 0.

Short Small Integer Precision of 5 and scale of 0.

String String Precision of 1 to 65,535 and scale of 0.

Unicode_Char String Precision of 1 and scale of 0.

Unicode_String String Precision of 1 to 65,535 and scale of 0.

64 Appendix A: webMethods Datatype Reference

Boolean Datatype

When the Integration Service reads data from a webMethods source field of the Boolean datatype, the Integration Service converts the value “True” to “T” and the value “False” to “F.”

When the Integration Service writes data to a webMethods target field of the Boolean datatype, it converts the value “T” to “True” and the value “F” to “False.” If the field contains any other value, the Integration Service rejects the field.

Datatype Reference 65

66 Appendix A: webMethods Datatype Reference

I n d e x

Aapplication connections (webMethods)

See PowerCenter Workflow Administration GuideApplication Multi-Group Source Qualifier (webMethods)

creating 31datatypes 31description 31

Cclient ID (webMethods)

configuring for deliver/receive mode 43setting for multiple simultaneous sessions 60

code pages (webMethods)See PowerCenter Administrator Guide

continuous workflows (webMethods)description 60

Ddatatypes (webMethods)

Application Multi-Group Source Qualifier 31Boolean datatype 65transformation 64webMethods 64

deliver/receive mode (webMethods)configuring for webMethods sources 43

configuring for webMethods targets 50delivery models (webMethods)

configuring for webMethods sources 43configuring for webMethods targets 50

Ggrid (webMethods)

restriction 47

Hhigh availability (webMethods)

restriction 47

IIdle Time (webMethods)

configuring 58description 47

installing (webMethods)webMethods 10webMethods installation and configuration steps 10

Integration Service (webMethods)See PowerCenter Administrator Guideconfiguring 42

67

JJVM options (webMethods)

configuring for webMethods 11

LLoad Scope (webMethods)

description 35setting for webMethods targets 39

Mmap value (webMethods)

using with a filter condition 45Message Count (webMethods)

configuring 58description 47high availability 47

message recovery (webMethods)See also PowerCenter Workflow Administration Guideconfiguringdescription 49recovery cache folder 50specifying partitions and a file cache folder 52

Ppipeline partitioning (webMethods)

description 52specifying partitions and a file cache folder 52

publish/subscribe delivery model (webMethods)configuring for webMethods sources 43configuring for webMethods targets 50

pubSeqn envelope fields (webMethods)in a webMethods target definition 34

RReader Time Limit (webMethods)

configuring 58description 48

Real-time Flush Latency (webMethods)configuring 58configuring continuous workflows 60configuring source-based commit 56description 48

real-time sessions (webMethods)configuring source-based commit 48defined 48

setting the Real-time Flush Latency session condition 48

recovery (webMethods)See message recovery

recovery cache folder (webMethods)for message recovery 50

Ssession conditions (webMethods)

description 46entering 46Idle Time 47Message Count 47Reader Time Limit 48Real-time Flush Latency 48

sessions (webMethods)configuring 53

source documents (webMethods)filtering 44

source-based commit (webMethods)configuring 56

Ttargets (webMethods)

Load Scope option 35transactional consistency for sessions 51

troubleshooting (webMethods)workflows 61

WwebMethods (webMethods)

installing 10webMethods source definition (webMethods)

creating 27editing 30, 38overview 26, 34

webMethods sources (webMethods)running multiple sessions simultaneously 60

webMethods target definition (webMethods)creating 36editing 30, 38overview 26, 34

webMethods targets (webMethods)running multiple sessions simultaneously 60

workflows (webMethods)See also PowerCenter Workflow Administration Guideconfiguring sessions in a workflow 53

68 Index

overview 42scheduling 60troubleshooting 61

Index 69

70 Index

PowerCenter Connect for webMethods 8.1.1 User Guide Documentation... · 2016-07-24 · webMethods...

Documents

Transcript of PowerCenter Connect for webMethods 8.1.1 User Guide Documentation... · 2016-07-24 · webMethods...