Web Services Provider Guide

Informatica PowerCenter®
(Version 8.1.1)

Informatica PowerCenter Web Services Provider Guide Version 8.1.1 April 2007 Copyright (c) 1998–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, <Daniel@haxx.se>. 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 is protected by U.S. Patent Numbers 6,208,990; 6,044,374; 6,014,670; 6,032,158; 5,794,246; 6,339,775 and other U.S. 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 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix List of Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
About This Book . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv Document Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xiv Other Informatica Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Visiting Informatica Customer Portal . . . . . . . . . . . . . . . . . . . . . . . . . . xv Visiting the Informatica Web Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv Visiting the Informatica Developer Network . . . . . . . . . . . . . . . . . . . . . xv Visiting the Informatica Knowledge Base . . . . . . . . . . . . . . . . . . . . . . . xv Obtaining Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xv

Chapter 1: Web Services Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2 Simple Object Access Protocol (SOAP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 Web Services Description Language (WSDL) . . . . . . . . . . . . . . . . . . . . . . . . 5

Chapter 2: Understanding the Web Services Provider . . . . . . . . . . . . 7
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Web Services Hub . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Batch Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8 Realtime Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9 Web Services Provider Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Chapter 3: Understanding the Web Services Hub . . . . . . . . . . . . . . . 13
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14 Using the Web Services Hub Console . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Batch Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15 Realtime Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 Web Services Hub and Integration Service . . . . . . . . . . . . . . . . . . . . . . . . . 19 Integration Service on a Single Node . . . . . . . . . . . . . . . . . . . . . . . . . . 19 Integration Service on a Grid . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
iii

. . . . . 21 Configuring the Logs . . . . . . . . . . . . . . . . . . . . . . 28 Data Integration Web Service Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 pingDIServer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 getAllDIServers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 startSessionLogFetch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21 SOAP Fault Handling . . . . 31 getWorkflowLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 getWorkflowDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30 getSessionLog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 Metadata Web Service Operations . . . . . . . . . . . . . . . . . . 29 deinitializeDIServerConnection . . . . 21 Viewing the Logs . . . 25 Overview . . . . . . . . . . . . . . . . . . . 23 Chapter 4: Batch Web Service Operations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 iv Table of Contents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 SOAP Fault Header . . . . . . . . . . . . . . . . . . . . . 30 getNextLogSegment . . . . . . . .Integration Service in Safe Mode . . . . . . . . . . . . . . . . . . 27 getAllRepositories . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 getSessionStatistics . . . . . . . . . 30 getDIServerProperties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 getTaskDetails . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 recoverWorkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 getAllWorkflows . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22 SOAP Fault Body . . . . . . . . . . . . 33 scheduleWorkflow . . . . . . . . . . . 20 Web Services Hub Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32 monitorDIServer . . . . 27 getAllTaskInstances . . . . . . . . . . 33 resumeWorkflow . . . . . . . . . . . 19 Web Services Hub Security . . . . 32 initializeDIServerConnection . . . . . 28 Logout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33 startTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 getAllFolders . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31 getSessionPerformanceData . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . . . . . . . . 40 Session Maintenance in Axis . . . . . . . . .NET . . . . . . . . 34 waitTillWorkflowComplete . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48 Operation Calls . . . . . . . . . . . . . . . . . . 45 Making Operation Calls in . . . 48 Initialization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37 Session Maintenance . . . . . . . . . . . .NET . . . . . . . . . . . . . . . . . . . . 44 Generating Client Proxy Classes in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38 Resource Cleanup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36 Client Applications for Batch Web Services . . . . . . . . . . . 33 startWorkflowFromTask . . . . 37 Initialization . . . 46 Client Applications for Realtime Web Services . . . . . . . . . . . . . . . . . . . . .NET . . . . . . . . 34 unscheduleWorkflow . . . . . . . . . . . 39 Proxy Objects . . . . . . 40 Initialization in Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42 Making Operation Calls in Axis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 stopTask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 waitTillTaskComplete . . . . . . . . . . . . . . . 43 Error Handling in Axis . . 43 Writing a Client Application in C# for Batch Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Writing a Client Application in Java for Batch Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45 Error Handling in . . . . . . . . . . . . . . . . . . . . . . . 48 Web Service Workflows . . . . . . 37 Generating Client Proxy Classes . 42 Clean Up in Axis . . . . . . . . . . . . . . . . . . .startWorkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 v . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34 Chapter 5: Writing Client Applications . . . . 34 stopWorkflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40 Generating Client Proxy Classes in Axis . . . . . . . . . . . .NET . . . . . . . 33 startWorkflowLogFetch . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39 Error Handling . . . . . . . . . . . . . . 48 Generating Client Proxy Classes . . . . . . . . . . . . . . . . . . . . . . . 38 Operation Calls . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44 Session Maintenance in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .NET . . . . . . . . . . . . . . . . . . . . . 44 Initialization in . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .

. . . . . . . . . . 75 Chapter 7: Working With Web Service Workflows . . . . . . 51 Step 3. . . . 80 Creating and Configuring a Service Session . . . . . . . . . . . . . . . . . . 51 Step 4. . . . . . . . . 79 Creating a Web Service Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Initialize the Web Service Objects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51 Step 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61 Viewing and Editing Web Service Definitions . . . . . . . . . . . . . . . . . . . . . . 85 SOAP Message Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . Send the Request and Handle the Response . . . . . . . . . . . . . . . . . . . . . . . . . . . 72 Request-Response Mappings . . . . . . . . . . . . . . 53 Rules and Guidelines for Using Parameter Arrays . . . . . . . . 60 Steps for Importing Web Service Sources and Targets . . . . . . . . 69 Editing Web Service Targets in a Mapping . . . . . . . . . . . . . . . . 66 View Definitions in the XML Editor . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79 Configuring the Web Service Workflow . . . . . . . . . . . . . . . . . 66 Viewing and Editing Definitions in the Designer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50 Step 1. . . . Create the Request Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75 Requests with Attachments . . . . . . . . . . . . . . . . . . . . . . . . . . 78 Creating and Configuring a Web Service Workflow . . 73 Staged Mappings . . . . . . . . . . . . . . . . . . . . . 59 Importing Web Service Target Definitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49 Writing a Client Application in Java for Realtime Web Services . . . . . . . . . . . . . . . . 56 Chapter 6: Working with Mappings . . . . . . . . . . . . . 59 Importing Web Service Source Definitions . . . . . . . . . . . . . . 70 Working with Web Service Mappings . . . . . . . . . . . . . Generate Client Proxy Classes in Axis . . . . . 53 Parameter Array Definition . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77 Overview . . . . . . . . . . . . . . . 82 Configuring the Web Services Provider Reader . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82 Configuring the Web Services Provider Writer . . . . . . . . . . . . . 87 Recovering Messages . . . . . . . . . 73 Attachments . . . . . . . . . 58 Importing Web Service Source and Target Definitions . . . 52 Using Parameter Arrays . . 75 Flat File or XML Mappings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87 vi Table of Contents . . . .Error Handling . . . . .

. 88 Running Sessions and Web Service Workflows . . . . . . . . . . . . . . . . . . . . . .1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Single Row Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95 Overview . . . . . . . . 103 Web Services Hub Test . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112 Metadata Web Services . . . . . . . . . . . . . . . . . . . 99 Data Integration . . 92 Appendix A: Web Service Sample Client Applications . . . . . . . . . . . . . . . . Create the Lookup Tables . . . . . . . . . . . . . . . . . . . . . . . 114 Index . . . . . . . . . . . . . . . . . . . . . 97 Compiling the Batch Web Services Sample Programs . . . . . . . . . . . . . . . . . . . . . . . 107 Step 2. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111 Overview . . . . . . . . . . . . . 99 Browsing . . . . . . . . . . . . . . . . . . . 102 Multithreading . . . . . . . . . . . . . . . . . . . . . . . . .Configuring Commit Type . . . . . . . 115 Table of Contents vii . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101 Multiple Integration Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1. . . . . . . . . . . . . Modify the Database Connection Settings . . . . . . . . . . . 100 Logs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109 Multiple Row Lookup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90 Troubleshooting . 90 Understanding Service Timeout and Flush Latency . . . . . . . . . . . 106 Step 1. . . . . . . . . . . . . . . . . . 104 Using the Realtime Web Services Sample Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . 88 Configuring Partitions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98 Examples for Batch Web Services . . . . . . 108 Step 5. . 90 Working with XML and Flat File Sessions . . . . . . . . . . . . . 108 Examples for Realtime Web Services . . . . . . . . . . . . . . 113 Data Integration Web Services . . . . . . . . . . . . . . . . . . . . . . . . . . . 96 Using the Batch Web Services Sample Programs . . . . . . . . . . . . . . . . 97 Running the Batch Web Services Sample Programs . . . . . . . . . . . . 107 Step 4. . . . . . . . . . . . . . . . . . . . . . . . 109 Appendix B: Web Service Operations in 8. . . . . . . . . . . . . . Compile the Realtime Web Service Sample Programs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107 Step 3. . . . . . . . . . . . . . . . . . Run the Realtime Web Service Sample Programs . . . . . . . . . . . . . . . . . . . . . Import the Mappings and Workflows . . . . . . . . . . . . . .

viii Table of Contents .

. . . . .. ..... . . 7-4. .. . . .. . .. . Web Services Provider Reader Properties . .. .... .. .... . . . . .. ..... .. .. . 3-2... . .. . Columns Tab for a Web Service Definition .... 6-4. 3-3... .... . . . . .. . .. . 3-1.... .. . . . . .. . Web Service Configuration .... .. .. . .. . .. ... .... ..... . .. . . .. .... ... . . .. . Request-Response Mapping ......... . 6-5.... . . .. . . . .. . .. . .. .. ... ... . .. . . . . .. . .. ... .. . ... . ... ... Creating a Web Service Workflow .. . Metadata Extensions Tab for a Web Service Definition XML Editor Views of Web Service Definition ..... . Building Blocks of a Web Service ... .. . .. Web Services Provider Writer Properties . ... . . .. ..... ..... . . 3-4.. . .. . . 6-3. . ... . . . .. . .... . ....... ...... ..... . .. .. . ... . . ... ... .... .. ... ... ... ...... .. . . .. . . Web Services Hub Console . 2-1. . .. . . . . .. . . .. 6-1... . . . . ...... .. . . .. .. . . . ..... .... . ... .. .. .. ..List of Figures Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure Figure 1-1. ...... . . . . . . ... .. .. . ... 6-6.. . .. . .. . . . . ..... .. .. .. .. . . 6-7... ... ... . . . .. . . . .. .. . . Batch Web Services Page . Web Services Provider Architecture ... ... ... . 3 10 15 16 17 18 59 61 67 68 69 70 73 79 80 83 85 List of Figures ix . Attributes Tab for a Web Service Definition .. .. .. . . ... . . . .. Web Service Target Definitions ..... . Realtime Service Description Page . 7-3. . 6-2. . . .. . .... . . . . ... ....... . .. . .. .. . . .. . 7-1. .... ..... .. ..... . ... . . . Web Service Source Definition . . ...... .. .. .. . .. ... . ... .. .. .. . . 7-2. . ..... . . . .. Realtime Web Services Page .

x List of Figures .

. . . . . .. . . . . . .. . . . . . . .. . . . . .. . . . 3-2. . . . . . . .. 6-5. . . . . . . . Web Service Properties . . . . .. . .. .. . . . . . . . . . . . . . . . . . . . . . . .. 7-2. . . . . . . . . . . . . . . . . 6-4. . . .... . . . . .. . ... . . . . .. .List of Tables Table Table Table Table Table Table Table Table Table Table 3-1.. . . . .. . . . . . . . . . . .. .. . . . . . . . . . . . . . . . .. Columns in Realtime Web Services Page . . . . .. . . . . .. .. . . . Web Services Provider Writer Properties . . . . Web Services Provider Reader Properties . . . . . .. Realtime Service Description Page . Web Services Definition Groups .. . . . . . .. . .. . . . . . .. . .. . . . . . . . . . . . .. . . . . . . Message Header Ports . . .. .. . .. . .. . . . .. . . .. 6-1. . . . . . .. . . . . . . . . . . . . . . . . 7-3. . . . . . . . . .. .. . .. Advanced Options for Importing Web Service Definitions Required Sources and Targets in a Service .. . . . . . . 6-3. . . . . . . . . . . . . . . . . . . 7-1. . . 6-2. . . . . . .. . . . .. .. . Attachment Group Ports . . . . . . . ... . . . . . . 17 18 60 60 63 72 76 80 83 86 List of Tables xi . . . . ... .

xii List of Tables .

Preface Welcome to PowerCenter. data synchronization. PowerCenter can simplify and accelerate the process of building a comprehensive data warehouse from disparate data sources. including extracting. handle complex transformations on the data. transforming. The Integration Service can extract large volumes of data from multiple platforms. PowerCenter combines the latest technology enhancements for reliably managing data repositories and delivering information resources in a timely. scalable data integration solution addressing the complete life cycle for all data integration projects including data warehouses. the Informatica software product that delivers an open. loading. xiii . and efficient manner. and information hubs. usable. and managing data. and support high-speed loads. The PowerCenter repository coordinates and drives a variety of core functions. data migration.

unless you follow the specified procedure. The following paragraph notes situations where you can overwrite or corrupt data. This is generic text that should be replaced with user-supplied values. Emphasized subjects. This guide also provides information about how to turn PowerCenter workflows into web services and examples for how to create client applications that use the web services available on the Web Services Hub. This is the variable name for a value you enter as part of an operating system command. This is an operating system command you enter from a prompt to run a task. Document Conventions This guide uses the following formatting conventions: If you see… It means… The word or set of words are especially emphasized. italicized text boldfaced text italicized monospaced text Note: Tip: Warning: monospaced text bold monospaced text xiv Preface .About This Book The Web Services Provider Guide provides information about the Web Services Provider and the PowerCenter web services hosted by the Web Services Hub. The following paragraph provides suggested uses. This guide assumes that you have a working knowledge of web service concepts and PowerCenter mappings and workflows. This is a code example. The material in this book is also available online. The following paragraph provides additional facts.

You can contact a Technical Support Center by using the telephone numbers listed in the following table. newsletters. Obtaining Technical Support There are many ways to access Informatica Technical Support. market. upcoming events. 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 send email. and support customer-oriented add-on solutions based on interoperability interfaces for Informatica products. the Informatica Knowledge Base. its background. Informatica Documentation Center.com. The site contains information about how to create. and sales offices. Visiting the Informatica Web Site You can access the Informatica corporate web site at http://www. The Informatica Developer Network is a web-based forum for third-party software developers. technical white papers. training and education. you can access the Informatica Customer Portal site at http://my. The site contains information about Informatica. you can access the Informatica Knowledge Base at http://my.Other Informatica Resources In addition to the product manuals. and technical tips. The services area of the site includes important information about technical support.com.com.informatica. The site contains product information.informatica.com. and access to the Informatica user community.informatica. or you can use the WebSupport Service. user group information. access to the Informatica customer support case management system (ATLAS). Use the Knowledge Base to search for documented solutions to known technical issues about Informatica products.informatica. Visiting the Informatica Knowledge Base As an Informatica customer. Visiting the Informatica Developer Network You can access the Informatica Developer Network at http://devnet. and implementation services. You will also find product and partner information. Preface xv . You can also find answers to frequently asked questions.

North America / South America Informatica Corporation Headquarters 100 Cardinal Way Redwood City.com for general customer service requests WebSupport requires a user name and password.com. White Waltham Maidenhead.Use the following email addresses to contact Informatica Technical Support: ♦ ♦ support@informatica. Diamond District Tower B. You can request a user name and password at http://my. 3rd Floor 150 Airport Road Bangalore 560 008 India Toll Free Australia: 1 800 151 830 Singapore: 001 800 4632 4357 Standard Rate India: +91 80 4112 5738 Toll Free 877 463 2435 Toll Free 00 800 4632 4357 Standard Rate United States: 650 385 5800 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 xvi Preface . 6 Waltham Park Waltham Road.com for technical inquiries support_admin@informatica. California 94063 United States Europe / Middle East / Africa Informatica Software Ltd. Berkshire SL6 3TN United Kingdom Asia / Australia Informatica Business Solutions Pvt.informatica. Ltd.

4 Web Services Description Language (WSDL). 5 1 . 2 Simple Object Access Protocol (SOAP).Chapter 1 Web Services Concepts This chapter includes the following topics: ♦ ♦ ♦ Overview.

generate the client proxies. It is the specification that defines the XML format for web service messages. The components that enable web services include: ♦ ♦ ♦ Simple Object Access Protocol (SOAP). the data the web service requires. To build a web service client for the PowerCenter Web Services Provider. For more information about writing client applications. you select the web service you want to interface with and retrieve the WSDL file for the selected web service. Discovery. and the location of the service by examining the WSDL. and WSDL. 2 Chapter 1: Web Services Concepts . Examples of web services include business services. The client proxies contain all of the function calls required to interact with a web service. SOAP. which offer greater interoperability than traditional proprietary applications. Use the information in the WSDL to build a client application to use the services. WSDL is an XML document that describes web service operations. Some web service providers publish services in Universal Description. and Integration (UDDI). Registering a web service in the UDDI is optional. You can embed these applications easily in existing components and products. The WSDL describes the web service interfaces and the operations available for the service. You can determine what functions a web service offers. airline schedules. see “Writing Client Applications” on page 35. You can write applications that can communicate with Integration Services using any language and platform.Overview Web services are business functions that operate over the Web. SOAP is the communications protocol for web services. and credit checks. Note: The PowerCenter Web Services Provider does not use the UDDI registry. Web services are based on open standards. such as XML. Using a web service tool kit such as Axis. They describe a collection of operations that are network accessible through standardized XML messaging. The PowerCenter Web Services Provider lets you integrate the PowerCenter metadata and data integration functionalities and expose them as web services. Directory of published web services. Web Service Definition Language (WSDL). such as stock quotes. Registry.

Figure 1-1 shows the building blocks of a web service: Figure 1-1. Building Blocks of a Web Service Overview 3 .

such as Java. SOAP body. including the content of the message. Information related to authentication or transactions is usually contained in the header because this information identifies the entity that sent the SOAP message body and the context in which it will be processed. the Apache Axis toolkit translates Java function calls to SOAP. Use a SOAP toolkit to create and parse SOAP messages. 4 Chapter 1: Web Services Concepts . into SOAP XML. who or what should handle it. The body is the container for mandatory information that provides a mechanism for exchanging information with the intended recipient. Each SOAP implementation supports different function calls and parameters. Therefore. For example. SOAP and the WSDL dictate the communication between web services and their clients. A SOAP toolkit translates function calls from another language to a SOAP message. ♦ ♦ Authentication and transaction management are typical examples of extensions that can be implemented as header entries. and whether it is optional or mandatory. The envelope defines the framework of the message. The header is an element of the SOAP envelope that lets you add features to a SOAP message in a decentralized manner. Use SOAP to implement web services on different platforms both inside and outside an organization. SOAP Encoding is used to tell the SOAP runtime environment how to translate from data structures. It defines the format for web services messages. The SOAP header helps to process the data in the body of the SOAP message. A SOAP message contains the following sections: ♦ SOAP envelope. a function that works with one toolkit may not work with another. SOAP header.Simple Object Access Protocol (SOAP) SOAP is the communications protocol for web services.

For more information about the Web Services Hub Console. You can view and download the WSDL files for the web services hosted by the PowerCenter Web Services Provider on the Web Services Hub Console. see “Using the Web Services Hub Console” on page 15. Web Services Description Language (WSDL) 5 . so that the receiver of a message knows how to process it. typically using one or more XML schemas. to be passed to the web service so that both the sender and the receiver of the service request understand the data being exchanged.Web Services Description Language (WSDL) The WSDL is an XML document that describes the protocols and formats used by a web service. The WSDL elements also contain a description of the operations to be performed on that data. The WSDL file contains a description of the data. so that the sender knows how to send it. and a binding to a protocol or transport.

6 Chapter 1: Web Services Concepts .

8 Web Services Provider Architecture. 10 7 .Chapter 2 Understanding the Web Services Provider This chapter includes the following topics: ♦ ♦ Overview.

is a collection of services that interact to provide data integration functionality. Batch Web Services Batch web services are web services that allow access to the Integration Service and retrieve metadata from the repository. and workflow tasks to help you run and ♦ 8 Chapter 2: Understanding the Web Services Provider . For more information about the Data Integration web services. Realtime web services. It receives requests from web service clients and passes them to the Integration Service or the Repository Service.Overview PowerCenter. Metadata web services provide operations that retrieve metadata from PowerCenter repositories. SAP BW Service. see “Understanding the Web Services Hub” on page 13. workflows. It processes SOAP requests from clients that want to run or monitor PowerCenter workflows or access PowerCenter functionality. Services that enable you to access the PowerCenter data integration functionality from a web service client and run workflows. The Web Services Hub is a web service gateway that makes PowerCenter data integration functionality available to external client applications through web services. The Web Services Hub and the web services hosted by the Web Services Hub comprise the Web Services Provider. The Integration Service or the Repository Service process the requests and sends a response to the web service client through the Web Services Hub. schedule and run workflows. Metadata web services. Use the Data Integration web services to connect to the Integration Service and run and monitor PowerCenter workflows. Repository Service. and monitor and get statistics on sessions. The services include a Service Manager that supports domain administration and application services that provide PowerCenter data integration functionality. Use the Metadata web services to get information about repository objects such as folders. The Data Integration web services provides operations that allow you to get details on the Integration Service. see “Data Integration Web Service Operations” on page 29. For more information about the Web Services Hub. The Web Services Hub hosts the following web services: ♦ ♦ Batch web services. with its service-oriented architecture. The application services include the Integration Service. A domain is the basic administration unit for the PowerCenter services. and the Web Services Hub. Web Services Hub The Web Services Hub is the web service gateway for PowerCenter. Services that enable you to run and monitor workflows and access metadata information. Batch web services fall into two categories: ♦ Data Integration web services. start and stop tasks in a workflow.

The source and target definitions represent service operations: the source defines the user request and the target defines the response. see “Batch Web Service Operations” on page 25. You can also create a service mapping with both a web service source and target definition to receive a message request from a web service client. The Integration Service can perform parallel processing of both request-response and one-way services. You can create a service mapping to receive a message from a web service client. For more information about creating service mappings. transform the data. A web service workflow is a workflow enabled for web services. Overview 9 . and add sessions to the workflow.monitor workflows in a repository. see “Working With Web Service Workflows” on page 77. and write it to any target that PowerCenter supports. Configure service information. you can create a web service workflow. For more information about Batch web services operations. When you save the workflow. You create Realtime web services when you expose mappings and workflows as web services. see “Metadata Web Service Operations” on page 27. Realtime Web Services When you start the Web Services Hub. and send the response back to the web service client. you do not need to import a WSDL definition. see “Working with Mappings” on page 57. If you want to expose an existing mapping as a service or create a service that takes input parameters such as a flat file or XML file. transform it. After you create a mapping. For more information about creating web service workflows. You then import an operation from the WSDL as a source or target. you need to create WSDL that describes the service. the Web Services Hub publishes the service. If you want to create a service that takes a SOAP message as input or produces a SOAP response. For more information about the Metadata web services. no Realtime web services are available.

the Web Services Hub sends the request to the Integration Service or Repository Service to process. If the request is for a realtime service. If the service request is for a batch service. These web services communicate with the Integration Service and the Repository Service. start or stop the server. The Web Services Hub sends a SOAP response to the web service client. 10 Chapter 2: Understanding the Web Services Provider . The following process describes the architecture of the Web Services Provider: 1. or get log information. 4. A web service client sends a SOAP message to the Web Services Hub to run a service. If the service request is for a realtime service. Figure 2-1 shows the Web Services Provider architecture: Figure 2-1. the Web Services Hub authenticates the web service client based on the repository user name and password. the Web Services Hub generates a message ID and sends the SOAP request to the Integration Service. The Integration Service processes the request.Web Services Provider Architecture The Web Services Provider consists of a Web Services Hub and the web services hosted by the Web Services Hub. The Web Services Hub generates a message ID for the request. the Integration Service sends the processed data to the Web Services Hub which uses the message ID to correlate the request with the response. 3. Web Services Provider Architecture Web Service Client Security Gateway Web Services Hub Realtime Web Services Batch Web Services Integration Service Web Service Workflow Web Service Client Workflow Tomcat Servlet Container Realtime Web Services Batch Web Services Repository Service Communication Repository Service Repository The Web Services Hub processes service requests in similar ways for Realtime web services and Batch web services. The request may be to run or monitor a workflow. For Batch web services or protected Realtime web services. 2.

The Integration Service and Web Services Hub communicate with the Repository Service throughout the process. and the number of applied. the Web Services Hub response includes session information such as the folder and workflow name. and rejected rows. affected. if you request statistics for a session running on the Integration Service. session and task run status. Web Services Provider Architecture 11 . the Web Services Hub sends a response based on the request.If the service request is for a batch service. For example.

12 Chapter 2: Understanding the Web Services Provider .

15 Web Services Hub and Integration Service. 22 13 . 14 Using the Web Services Hub Console. 20 Web Services Hub Logs. 19 Web Services Hub Security.Chapter 3 Understanding the Web Services Hub This chapter includes the following topics: ♦ ♦ ♦ ♦ ♦ ♦ Overview. 21 SOAP Fault Handling.

see “Creating and Configuring the Web Services Hub” in the PowerCenter Administrator Guide. It receives requests from web service clients and passes them to the Integration Service. The Web Services Hub authenticates the web service client based on the repository user name and password included in every service request. 14 Chapter 3: Understanding the Web Services Hub . The Web Services Hub connects to the Repository Service and the Integration Service through TCP/IP. After installation. The Integration Service processes the requests and sends a response to the web service client through the Web Services Hub. Use the Web Services Hub console to view web service information and download the WSDL files necessary for running services and workflows. The Web Services Hub hosts Batch web services and Realtime web services. For more information about the Realtime web services. All services are stateless services. For more information about the Batch web services.Overview The Web Services Hub is a gateway that makes PowerCenter functionality accessible to external clients as web services. When you install PowerCenter. see “Realtime Web Services” on page 9. The Web Services Hub is an application service in the PowerCenter domain. use the Administration Console to create a Web Services Hub and enable it as you would other application services in the domain. Web service clients log in to the Web Services Hub through HTTP or HTTPS. see “Batch Web Services” on page 8. For more information about creating and enabling a Web Services Hub. the PowerCenter installer installs the Web Services Hub.

You can connect to the Web Services Hub from any browser. Note: You can also use the context name PowerCenter. Figure 3-1 shows the main page for the Web Services Hub console: Figure 3-1. save the WSDL file to your local machine. Using the Web Services Hub Console 15 . The Web Services Hub redirects the URL http://<HostName>:<PortNumber>/PowerCenter to the default URL http://<HostName>:<PortNumber>/wsh . Web Services Hub Console Batch Web Services To view the WSDL files for the Batch web services.Using the Web Services Hub Console Use the Web Services Hub console to view service information and download the WSDL required to run the web services. To download. You can click the icons for the Metadata WSDL and DataIntegration WSDL to view the WSDL files. The Batch web services page displays the list of available operations and their descriptions. Use the following URL to connect to the Web Services Hub console: http://<WebServicesHubHostName:PortNumber>/wsh The default port is 7333. click the Batch Web Services link.

On the Realtime Web Services page. Batch Web Services Page Use the Metadata WSDL to write client applications that call Metadata web service operations. Realtime Web Services After you create mappings and web service workflows. 16 Chapter 3: Understanding the Web Services Hub . For more information about the Data Integration web service operations. For more information about the Metadata web service operations. you can view the list of available web services and the WSDL files for the services. Use the DataIntegration WSDL to write client applications that call Data Integration web service operations. To download. save the WSDL file to your local machine. see “Metadata Web Service Operations” on page 27. you can view the web service information published by the Web Services Hub. You can click the WSDL icon for the service to view the WSDL file. see “Data Integration Web Service Operations” on page 29.Figure 3-2 shows the main page for the Batch web services page: Figure 3-2.

To view additional service information. Using the Web Services Hub Console 17 . Folder containing the service. Realtime Web Services Page Table 3-1 describes the columns displayed on the Realtime Web Services page: Table 3-1. Workflow associated with the web service. Name of the Repository Service. Domain containing the Repository Service. such as the Runnable and Protected properties. you can click on a service name. Columns in Realtime Web Services Page Column Service Name Domain Name Repository Name Folder Name Workflow Name WSDL Description Service name defined in the web service workflow. WSDL published by the Web Services Hub for the service.Figure 3-3 shows the main page for the Realtime Web Services page: Figure 3-3.

If the web service is public. Realtime Service Description Page Property Service Name Repository Name Folder Name Workflow Name Is Runnable Description Service name defined in the web service workflow. Indicates whether the service is protected or public. see “Creating and Configuring a Web Service Workflow” on page 79. the client application does not need authentication. Repository containing the service. you need to know the service name and the protected status of the service. Realtime Service Description Page Table 3-2 describes the properties on the Realtime Service Description page: Table 3-2. WSDL published by the Web Services Hub to run the service. For more information about protected services. Indicates the runnable value. Indicates whether the service is one-way or request-response. the client application must call the Login operation and pass the user name and password through the HTTP header. If the web service is protected. Folder containing the service. For more information about runnable services. Is Protected Is One Way Service WSDL Before you can build a client application to run a web service. 18 Chapter 3: Understanding the Web Services Hub . Workflow associated with the web service.Figure 3-4 shows the Realtime Service Description page: Figure 3-4. see “Creating and Configuring a Web Service Workflow” on page 79.

For information about running the Integration Service in safe mode. When Session on Grid is enabled. See also “Integration Service Architecture” in the Administrator Guide. Although you can run web service workflows with an Integration Service running in safe mode. the client application logs in with the user account for the repository associated with the Web Services Hub. For information about running workflows and sessions on a grid. run the web service workflow on the Integration Service associated with a grid. you can run a web service workflow on a grid. To run a web service workflow on a grid from a client application. You can also enable the Session on Grid property of the session task. Integration Service on a Single Node You can run a web service workflow with an Integration Service configured to run on a single node. It also supports an Integration Service running in safe mode. Note: The Web Services Hub is not a highly available service. For Realtime web services.Web Services Hub and Integration Service The Web Services Hub supports an Integration Service running on a single node or on a grid. Integration Service in Safe Mode The Integration Service can run in normal or safe operating mode. the client application can log in with a user account that has permission to administer the Integration Service running in safe mode. the Integration Service distributes the session threads to the nodes in a grid. Create the grid and associate an Integration Service with the grid in the Administration Console. the Web Services Hub does not take advantage of high availability features such as failover and automatic recovery. Only repository users with permission to administer the Integration Service can run and obtain information about sessions and workflows assigned to an Integration Service running in safe mode. Web Services Hub and Integration Service 19 . see “Running Workflows and Sessions on a Grid” in the Workflow Administration Guide. see “Creating and Configuring the Integration Service” in the PowerCenter Administrator Guide. Then assign the Integration Service to run the web service workflow. For Batch web services. Integration Service on a Grid When a PowerCenter domain contains multiple nodes.

The Web Services Hub authenticates requests from web service clients based on the user name and password. 20 Chapter 3: Understanding the Web Services Hub . the Web Services Hub does not authenticate web service requests. For more information about user access to the web service workflow. Authorization. and password in every SOAP request sent to the Web Services Hub. but it can invoke the service if the web service workflow is running. see “Creating and Configuring a Web Service Workflow” on page 79. a web service client cannot start the service.Web Services Hub Security The Web Services Hub has the following levels of security: ♦ Encryption. The Web Services Hub encrypts the repository login information in the configuration file used to connect to the repository. ♦ ♦ For more information about user access to services. A web service client with repository access must have execute permission on a folder to run a service. The Web Services Hub also supports the HTTPS protocol for encryption of web service client requests. the web service client application must call the Login operation before it calls other operations. For Batch web services and protected Realtime web services. The Web Services Hub authenticates a request based on the user name and password. For protected realtime services. Note: If a realtime web service is public. if the service is not runnable. a web service client with execute permission on a folder can run a service in that folder based on service configuration. Authentication. see “Managing Users and User Accounts” in the PowerCenter Administrator Guide. For example. A web service client must embed the repository user name.

For more information about the Log Manager and configuring the Web Services Hub logs. task execution. Configuring the Logs The Log Manager in the PowerCenter domain handles all logging functions for all services in the domain. the service the client invokes. and the associated workflow. For more information about fault handling.Web Services Hub Logs The Web Services Hub creates a log for status and error messages related to tasks. When you view log events in the Log Viewer. The logs include the IP address of the client. see “Managing Logs” in the PowerCenter Administrator Guide. you can configure the size and location of the Web Services Hub logs and the level of errors that would be included in the logs. and connection status. For more information about using the Log Viewer. You can troubleshoot problems by examining error messages in this log. the Log Manager displays the generated log event files in the log directory set by the domain administrator. see “Managing Logs” in the PowerCenter Administrator Guide. Viewing the Logs You can view Web Services Hub log events on the Administration Console Log Viewer. You can filter log events to get a list of only the log events for the Web Services Hub. Web Services Hub Logs 21 . such as service initialization. you must have permission for the Web Services Hub in the Administration Console. including the Web Services Hub. In the PowerCenter Administration Console. You can view and configure the logs for the Web Services Hub on the PowerCenter Administration Console. To view log events. Note: The Web Services Hub also writes messages in the fault element of a SOAP response when it cannot process the request. see “SOAP Fault Handling” on page 22.

the message code WSH_95002 has the following associated message text: Invalid request parameter. it does not process the body element. ♦ ♦ ♦ Messages contain a message code that includes a prefix and code number and the message text. The message code is the ErrorCode element in the detail element of a SOAP fault.informatica. The schema of this element is listed below: <ns1:HeaderFault xmlns:ns1=”http://www. see “WSH Messages” in the PowerCenter Troubleshooting Guide. The SOAP response to the request contains the header fault element in the SOAP header and a SOAP fault element without the detail element. the Integration Service writes messages to fault targets.SOAP Fault Handling If the Web Services Hub cannot process a request. the SOAP fault element in the SOAP response message contains a detail element with error information. For a listing of error codes related to the Web Services Hub. The Integration Service receives requests from the Web Services Hub to run web service workflows.com/wsh”> <ErrorCode> error code </ErrorCode <ErrorMessage> error message </ErrorMessage> </ns1:HeaderFault> 22 Chapter 3: Understanding the Web Services Hub . it returns error information related to the header entries of the SOAP request message in a child element of the SOAP response header element. The message target is based on the task the Web Services Hub was performing when it encountered the error: ♦ If the Web Services Hub cannot process the header element of a SOAP request message. and the message text is the faultstring element of the SOAP fault. SOAP Fault Header The Web Services Hub reports header related errors in the header fault element of a SOAP response header. If the Web Services Hub cannot process the contents of the body element. Workflow name cannot be null. it sends a response to the web service client that contains error information indicating the cause of the error. If the Web Services Hub encounters any error with the header element of a SOAP request. If the web service workflow is configured to send error data to the target. For example.

The faultstring value indicates that the error originated from the Integration Service. If the error originates at the web service client.com/wsh"> <ErrorCode> Error Code </ ErrorCode > <ExtendedDetails> Actual Error </ ExtendedDetails > </ns:WSHFaultDetails> </detail> </SOAP-ENV: Fault> SOAP Fault Handling 23 .informatica. The detail element contains error information that includes an error code. Web Services Hub. Faultstring. ♦ ♦ The Web Services Hub uses the following SOAP fault schema: <SOAP-ENV: Fault> <faultcode> Client/Server </faultcode> <faultstring>Brief Description of Error</faultstring> <detail> <ns:WSHFaultDetails xmlns:ns="www. and the extended details provide detailed error information when the faultstring is a Web Services Hub or repository error. the message may have the wrong structure. or Repository Service. The faultcode determines if the error originates at the web service client or the Integration Service. Detail.SOAP Fault Body The SOAP fault body contains the following sub-elements: ♦ Faultcode. The faultstring provides a description of the error.

24 Chapter 3: Understanding the Web Services Hub .

27 Data Integration Web Service Operations. 26 Metadata Web Service Operations. 29 25 .Chapter 4 Batch Web Service Operations This chapter includes the following topics: ♦ ♦ ♦ Overview.

The operations for the Metadata web services are defined in the Metadata WSDL file available on the Batch Web Services page of the Web Services Hub console. Data Integration web services. start. You can retrieve workflow and session logs. or stop existing workflows and tasks using Batch web service operations. You can get session statistics and performance data.Overview You can schedule. For more information about the request and response XML documents for these operations. The Batch web services consist of two groups of services defined in separate WSDLs: ♦ Metadata web services. 26 Chapter 4: Batch Web Service Operations . ♦ This chapter explains the operations provided by the Batch web services. Note: Log segments obtained by Batch web services operation calls are either in Integration Service code page or in UTF-8. The operations for the Metadata web services are defined in the DataIntegration WSDL file available on the Batch Web Services page of the Web Services Hub console. refer to the WSDL files.

Note: Since the getAllRepositories operation is not associated with a specific repository. getAllDIServers You can associate one or more Integration Services with a repository to run workflows and sessions. You can use the operations to log in to a repository and get the list of the following repository objects: ♦ ♦ ♦ ♦ ♦ All folders in a repository associated with the Web Services Hub All workflows in a folder All worklets and session tasks in a workflow All Integration Services registered for a repository All repositories associated with Web Services Hub The following section lists all operations available for the Metadata web services. it is important to enter descriptive service names for each associated service to help users differentiate among Integration Services. you must associate the repository with the Web Services Hub. you do not need to log in to a repository to use the operation. Use the Administration Console to associate a repository with a Web Services Hub.Metadata Web Service Operations Use the operations provided in the Metadata web services to retrieve metadata from the PowerCenter repositories associated with the Web Services Hub. getAllRepositories Use the getAllRepositories operation to view all repositories associated with the Web Services Hub. For more information about the Login operation. getAllFolders Use the getAllFolders operation to retrieve all folders in a repository. This operation returns the names of all Integration Services associated with a given repository. Before a Web Services Hub client application can use a repository. For more information about associating a repository with the Web Services Hub. Each Integration Service associated with a repository must have a service name and a combination of host name and port number that is unique among the services associated with the repository. Metadata Web Service Operations 27 . In a multiple Integration Service environment. see “Login” on page 28. see “Creating and Configuring a Web Services Hub” in the PowerCenter Administrator Guide. You can call the getAllRepositories operation without calling the Login operation.

you do not need to log in to a repository to use the operation. see “getAllRepositories” on page 27. For more information about the getAllRepositories operation. and whether the workflow is valid. You can call the getAllRepositories operation without calling the Login operation. and shell commands. email notifications. the Web Services Hub assumes that the domain for the repository is the same as the domain for the Web Services Hub. Call this operation at the end of a client application run to release resources in the Web Services Hub. user name. A workflow is a set of instructions that tells the Integration Service how to execute tasks. and password and returns an encrypted session ID.getAllTaskInstances Use the getAllTaskInstances operation to get information about all worklets and session task instances in a workflow for a specified depth. getAllWorkflows Use the getAllWorkflows operation to get information about all workflows in a folder. such as sessions. The client application must call this operation before calling any other operations. you must provide the domain name for the repository. Login The Login operation authenticates the user name and password for a specified repository. Note: Since the getAllRepositories operation is not associated with a specific repository. The Login operation requires a repository name. the web service client application can call any Batch web service operations. If the domain for the repository is different from the domain for the Web Services Hub. Otherwise. the name of the folder in which the workflow resides. Logout The Logout operation disconnects you from the repository and Integration Service connections. Workflow information includes the name of the workflow. 28 Chapter 4: Batch Web Service Operations . After calling the Login operation.

You can use the following operations to control the tasks in a workflows: − − − − − recoverWorkflow resumeWorkflow (deprecated) startTask stopTask waitTillTaskComplete ♦ Monitor and get statistics on sesstions. You can use the following operations to verify that the Integration Service is running and connect to or get information about the Integration Service: − − − − pingDIServer getDIServerProperties initializeDIServerConnection deinitializeDIServerConnection ♦ Schedule and run workflows.Data Integration Web Service Operations You can perform the following tasks with Data Integration web services operations: ♦ Connect to and get details regarding the Integration Service. You can use the following operations to control how workflows run: − − − − − − startWorkflow stopWorkflow scheduleWorkflow startWorkflowFromTask unscheduleWorkflow waitTillWorkflowComplete ♦ Start and stop tasks in a workflow. You can use the following operations to get details on a session or workflow run: − − − − − − − − − getNextLogSegment getSessionLog getSessionPerformanceData getSessionStatistics getTaskDetails getWorkflowDetails getWorkflowLog monitorDIServer startSessionLogFetch Data Integration Web Service Operations 29 .

deinitializeDIServerConnection This operation disconnects the client application from the Integration Service.− startWorkflowLogFetch This section lists all operations available for the Data Integration web services. You can use this operation if you want to get the information in a session or workflow log in increments. These operations are defined in the di. 30 Chapter 4: Batch Web Service Operations .wsdl. To get workflow log information in one operation. For more information about the startSessionLogFetch operation. Note: This operation is equivalent to the disconnect pmcmd command. Call the getNextLogSegment operation with the log handle generated by the startSessionLogFetch or startWorkflowLogFetch operation until the end of log is reached. see “getWorkflowLog” on page 32. see “startWorkflowLogFetch” on page 34. see “getSessionLog” on page 31. For more information about the startWorkflowLogFetch operation. see “startSessionLogFetch” on page 33. Use this operation in conjunction with initializeDIServerConnection to manage the connection from the client application to the Integration Service. getDIServerProperties Use this operation to get the properties of the Integration Service. see the PowerCenter Command Line Reference. The Integration Service properties include the following information: ♦ ♦ ♦ ♦ ♦ ♦ ♦ Integration Service name Integration Service version Product name Integration Service startup time Name of the repository associated with the Integration Service Data movement mode (ASCII or Unicode) Whether the Integration Service can debug mappings getNextLogSegment The getNextLogSegment operation returns a portion of a session or workflow log. For more information about the pmcmd command line program. The Logout operation also releases connections to the Integration Service acquired by the client application and performs cleanup operations. To get session log information in one operation. Use this operation with the startSessionLogFetch or startWorkflowLogFetch operation.

Note: Call this operation only for Session tasks. and the user that runs the workflow. the operation returns the details of the running workflow. getSessionStatistics Use this operation to get the statistics of a session running on the Integration Service. and run error codes and messages. When the session is not running. start time. workflow log file. getWorkflowDetails Use this operation to get the details of a given workflow. getSessionPerformanceData Use this operation to retrieve the performance data of a session running on the Integration Service. the operation returns the details of the last run of this workflow. such as initialization of processes. Data Integration Web Service Operations 31 . and rejected rows. the number of successful and failed rows for source and target. this operation provides the statistics of the most recently run session. the operation returns the task details of the last workflow run. workflow. affected. session validation. start and end time. Workflow details include the name of the folder. see “getNextLogSegment” on page 30. The performance details provide counters that help you understand the session and mapping efficiency. The getSessionLog operation returns the information in the session log. the Integration Service writes information to the session log. the operation returns the details of the current task in the running workflow. and load summary. getTaskDetails Use this operation to retrieve the details of a task from the Integration Service. Session statistics includes the folder and workflow name. and run error codes and messages. You can use this operation if you want to get all the information in the session log in one operation. session and task run status. task name and type. creation of SQL commands for reader and writer threads. If the workflow is not running. It includes workflow run type. run status.getSessionLog When a service session runs. If the parent workflow is not running. If the parent workflow is running and the task has already run. If the workflow is running. log file code page. The task detail information includes folder and workflow name. run status. To get session log information in increments. The amount of detail in the session log depends on the tracing level that you set. and the number of applied. Note: Call this operation only for Session tasks. errors encountered. error information.

you must provide the domain name for the Integration Service. you do not need to pass the Integration Service name when you call other Data Integration web service operations. you must pass the Integration Service name when you call Data Integration web service operations. Returns status details for active workflows. the Integration Service writes information to the workflow log. the Web Services Hub uses the same domain for the repository and Integration Service. errors encountered. ALL. To get workflow log information in increments. see the PowerCenter Command Line Reference. Returns status details for scheduled workflows. pingDIServer Use this operation to determine whether a Integration Service is running. details of active and scheduled workflows.getWorkflowLog When the web service workflow runs. The return values are ALIVE or FAIL. 32 Chapter 4: Batch Web Service Operations . Note: This operation is equivalent to the pmcmd connect command. You can call this operation in the following modes: ♦ ♦ ♦ RUNNING. suspended. Otherwise. Returns information for all scheduled and active workflows. details of the tasks and links within the workflows. and suspending workflows. If you do not call this operation. If you call this operation at the start of the client application run. monitorDIServer Use this operation to retrieve the status of the Integration Service. You can use this operation if you want to get all the information in the workflow log in one operation. SCHEDULED. If the domain for the Integration Service is different from the domain for the repository. and workflow run summary. The getWorkflowLog operation returns the information in the workflow log. see “getNextLogSegment” on page 30. such as initialization of processes. This operation requires the Integration Service name. For more information about the pmcmd command line program. workflow task run information. The amount of detail in the workflow log depends on the tracing level. initializeDIServerConnection You can use this operation to initialize a connection to an Integration Service. Active workflows include running.

After you call the startSessionLogFetch operation.<TaskName>.recoverWorkflow Recovers suspended workflows. Use the recoverWorkflow operation. A task within a worklet is identified by its worklet and task names separated by periods: <WorkletName>. Data Integration Web Service Operations 33 .B. scheduleWorkflow Use this operation to schedule a workflow. a workflow contains worklet A which contains another worklet. A task within a workflow is identified by its task name alone. You must specify the task instance path for the task to be started.C. The task instance path for task C is A. B. For example. The Integration Service recovers the workflow from all suspended and failed worklets and all suspended and failed Command. startSessionLogFetch The startSessionLogFetch generates a log handle for use with the getNextLogSegment operation. call the getNextLogSegment operation with the log handle generated by startSessionLogFetch until the end of log is reached. For more information about the getNextLogSegment operation. startWorkflow Use this operation to start a workflow. resumeWorkflow Deprecated operation. Email. startTask Use this operation to start a specific task within a workflow. the Integration Service runs the workflow from the selected task to the end of the workflow. startWorkflowFromTask Use this operation to stop a workflow from a task. You can schedule any workflow that does not run on demand. Task C is a task within worklet B. The task instance path uniquely identifies a task instance inside a workflow. see “getNextLogSegment” on page 30. and Session tasks. When you start a workflow from a task.

After you call the startWorkflowLogFetch operation. You can stop or abort a task. unscheduleWorkflow Use this operation to unschedule a workflow. 34 Chapter 4: Batch Web Service Operations . You can also abort a running task by setting the isAbort parameter to true.startWorkflowLogFetch The startWorkflowLogFetch generates a log handle for use with the getNextLogSegment operation. the Integration Service also tries to stop all the tasks that are currently running in the worklet. stopWorkflow Use this operation to stop a running workflow. In addition to stopping a workflow. Normally. When you stop a workflow. waitTillTaskComplete Use this operation to wait for a task running on an Integration Service to complete. workflow. Normally. For more information about the getNextLogSegment operation. stopTask Use this operation to stop a task running on an Integration Service. When you stop a task in the workflow. the Integration Service tries to stop all the tasks that are currently running in the workflow. you abort tasks only if the Integration Service fails to stop the task. You must specify the task instance path for the task to be aborted. You can prevent the client from starting the next workflow until the running workflow completes. see “startWorkflowFromTask” on page 33. or worklet at any time. the Integration Service stops processing the task and all other tasks in its path. Otherwise. see “getNextLogSegment” on page 30. For more information about the task instance path. waitTillWorkflowComplete Use this operation to wait for a workflow running on an Integration Service to complete. you can run workflows concurrently. you can abort a running workflow by setting the isAbort parameter to true. call the getNextLogSegment operation with the log handle generated by startWorkflowLogFetch until the end of log is reached. you abort workflows only if the Integration Service fails to stop the workflow. If the workflow contains a worklet.

44 Client Applications for Realtime Web Services. 36 Client Applications for Batch Web Services. 48 Writing a Client Application in Java for Realtime Web Services. 37 Writing a Client Application in Java for Batch Web Services. 40 Writing a Client Application in C# for Batch Web Services. 53 35 . 50 Using Parameter Arrays.Chapter 5 Writing Client Applications This chapter includes the following topics: ♦ ♦ ♦ ♦ ♦ ♦ ♦ Overview.

36 Chapter 5: Writing Client Applications . You can create a client application to run PowerCenter Batch or Realtime web services. The general discussion on the steps to create a client application is followed by examples of how to create client applications in the Java and . The application development follows the same basic steps. To create a client application for the PowerCenter web services. You can use the Microsoft .Overview This chapter provides an overview of how you can write client applications to use the web services offered by the PowerCenter Web Services Provider.NET and Apache Axis web services toolkits to write client applications for the PowerCenter web services. Web services toolkits make it easy to create client applications by generating client-side proxy classes from the web service WSDL files.NET frameworks. you need the web service WSDL files and a web service toolkit.

Generating Client Proxy Classes To use the Batch Web Services operations available in the Web Services Hub. 2. see “Batch Web Services” on page 15. For more information about writing a client application in C# using the . Each toolkit generates the client proxy classes in a specific way. Generate the client-side proxy classes from the WSDL files using the web service toolkit. when you download the WSDL files from the Web Services Hub console. see “Writing a Client Application in C# for Batch Web Services” on page 44.Client Applications for Batch Web Services Developing a client application to access the Batch web services available in the PowerCenter Web Services Provider involves the following elements: ♦ ♦ ♦ ♦ ♦ ♦ ♦ Client proxy classes Initialization Session maintenance Operation calls Resource cleanup Error handling Proxy objects For more information about writing a client application in Java using the Axis Web Services Toolkit to access the PowerCenter Batch web services. the endpoint URL is set to the Web Services Hub host name and port number. Select the web services toolkit for the platform and language in which you want to develop. Before you generate the proxy classes. Client Applications for Batch Web Services 37 . For more information about downloading the Batch Web Services WSDL files from the Web Services Hub console. Refer to the web services toolkit documentation for details on generating proxy classes.NET Web Services Toolkit to access the PowerCenter Batch web services. 3. Initialization The client application performs an initialization step before it makes calls to Metadata and Data Integration web services operations. Download the WSDLs for the Metadata web services and Data Integration web services from the Web Services Hub console. To generate client proxies. complete the following steps: 1. verify that the WSDL files contain the correct endpoint URL. By default. see “Writing a Client Application in Java for Batch Web Services” on page 40. you need to generate client proxy classes for the web service WSDL files using a web services toolkit.

Set the SOAP header in the MWSProxy object after the Login operation call. Session Maintenance The Web Services Hub requires session maintenance to cache resources. Set the SOAP header in the DIWSProxy object with the same session ID so that the same session ID will be sent for all subsequent requests made using the DIWSProxy object. This will send the session ID in the SOAP header for all subsequent requests using the MWSProxy object. This operation call associates the MWSProxy object with the repository name and user name pair. Extract the header with the root element name Context and namespace http://www.informatica.com/wsh from the response of the Login operation call. complete the following steps: 1. Use the MWSProxy object to call Metadata web service operations. The SOAP header in the SOAP message carries the session information facilitating session maintenance. user name. the name of the Data Integration API proxy object is DIWSProxy. All subsequent requests made to the Batch web services operations using the MWSProxy object use these repository and user names. For more information about using the Metadata web service operations. This section uses the name DIWSProxy to refer to the Data Integration API proxy object. This SOAP header contains the session ID sent by the Web Services Hub. Instantiate the proxy class for the Metadata API. The Login operation requires a repository name. complete the following steps: 1. This section uses the name MWSProxy to refer to the Metadata API proxy object. 3. the name of the Metadata API proxy object is MWSProxy. Call the Login operation using the MWSProxy object. In the example. 2. Use the DIWSProxy object to call Data Integration web service operations. For more information about using the Data Integration web service operations. 38 Chapter 5: Writing Client Applications . Operation Calls You are now ready to call Metadata web service and Data Integration web service operations using the MWSProxy and DIWSProxy objects. see “Data Integration Web Service Operations” on page 29. Instantiate the proxy class for the Data Integration API.To perform initialization. 2. 3. and password and returns a session ID. To set up and perform session maintenance. see “Metadata Web Service Operations” on page 27. In the example.

see “Error Handling in Axis” on page 43. For more information about error handling schemes used in the Axis Web Services Toolkit.NET” on page 46. While calling any of the Batch web services operations. Client Applications for Batch Web Services 39 . If you log in to a repository but do not call the Logout operation. This scheme varies according to the toolkit.NET Web Services Toolkit. the Web Services Hub performs resource cleanup after the session expiration period. call the Logout operation using the MWSProxy object. The session ID (which corresponds to the Metadata proxy object) that you get from the Login operation call identifies this session. A web services toolkit provides an exception handling scheme to get the faultcode and faultstring field of a fault element. see “Error Handling in . To release resources.Resource Cleanup The Web Services Hub implements session expiry for performance and resource clean up. After you call the Logout operation. For more information about error handling schemes used in the . you might need an XML parser to parse the detail element field to obtain the error code and extended details. Error Handling SOAP fault elements in the SOAP response contain the errors that occur during calls to web services. The Logout operation releases the Web Services Hub resources acquired by client applications and performs cleanup operations. However. Proxy Objects The Login operation call creates a session for the repository and user name you provide. This session (and Metadata proxy object) is valid as long as the session ID is valid. the session ID becomes invalid along with the corresponding Metadata and Data Integration proxy objects. the client application should implement the appropriate error handling scheme to retrieve the SOAP fault.

You can view the sample programs for the PowerCenter web services in the following directory: <PowerCenterInstallationDir>/server/samples/BatchWebServices/samples/axis Generating Client Proxy Classes in Axis You can generate client proxy classes in Java using the Axis Web Services Toolkit. which is available in the definitions\service\port hierarchy in the WSDL file. update the address element. run the following commands: java org.WSDL2Java --NStoPkg http://www. Verify that the WSDLs have the correct host name and port number for the Web Services Hub in the endpoint URL.apache.axis. complete the following steps: 1.wsdl.axis.com/wsh=ProxyClasses -W DataIntegration.wsdl.axis. Note: The sample code snippets in the following sections are taken from the Batch Web Services sample programs shipped with the Web Services Hub.informatica.wsdl.informatica. Use the following command to generate the client proxy classes: java org.wsdl. for WSDL files named Metadata.apache.java.java. Initialization in Axis The client application must perform an initialization step before it makes calls to Metadata web services and Data Integration web services. Contains the interface for the Data Integration web services. 2. DataIntegrationInterface.com/wsh=ProxyClasses -W <WSDLFile> The -W option turns off support for wrapped document literal services.apache. Download the Metadata web services and Data Integration web services WSDL files from the Web Services Hub console. If the endpoint URL is not correct. These commands generate the client proxy classes in the folder /ProxyClasses in the ProxyClasses package.WSDL2Java --NStoPkg http://www. 40 Chapter 5: Writing Client Applications .WSDL2Java --NStoPkg http://www. To generate client proxy classes in Java. Contains the interface for the Metadata web services.informatica.wsdl.Writing a Client Application in Java for Batch Web Services This section highlights the steps to write a client application in Java using the Axis Web Services Toolkit. The commands generate two proxy classes: − − MetadataInterface. For example. java org.wsdl.com/wsh=ProxyClasses -W Metadata.wsdl and DataIntegration.

4. loginReq. DataIntegrationService diService = new DataIntegrationServiceLocator(). get the MWSProxy object as follows: MWSProxy=mdService.wsdl has the correct URL. Otherwise. repository. Get a DataIntegrationInterface object (DIWSProxy) from the DataIntegrationService object created in step 1.net. Use the MWSProxy object to call Metadata web service operations.URL(DIWS_URL)). and PASSWORD is a string containing the password for the user to log in to the repository. complete the following steps: 1. The Login operation takes a domain.setUserName(USER_NAME). wrapped in an object LoginRequest and returns a session ID. get the DIWSProxy object as follows: DIWSProxy=diService. 2. REPO_NAME is a string containing the name of a repository in the domain.setRepositoryDomainName(REPO_DOMAIN_NAME).wsdl has the correct URL. Call the Login operation with the MWSProxy object to create a session ID for the client application user account. If the Metadata service endpoint URL in the Metadata. and password.getDataIntegration(new java. Get a MetadataInterface object (MWSProxy) from the MetadataService object created in step 1. USER_NAME is a string containing a user name valid for the repository.To perform initialization. REPO_DOMAIN_NAME is a string containing a PowerCenter domain name.login(loginReq). MWS_URL is a variable containing the endpoint URL for the Metadata web services. LoginRequest loginReq = new LoginRequest(). user name.getMetadata(). loginReq. loginReq. loginReq. Create MetadataService and DataIntegrationService objects by instantiating the service locator classes: MetadataService mdService = new MetadataServiceLocator().net.setRepositoryName(REPO_NAME). Writing a Client Application in Java for Batch Web Services 41 . If the service endpoint URL in the DataIntegration. get the MWSProxy object as follows: MWSProxy=mdService.getDataIntegration(). String sessionID = MWSProxy. Otherwise.setPassword(PASSWORD). get the DIWSProxy object as follows: DIWSProxy=diService.URL(MWS_URL)).getMetadata(new java. 3. Use the DIWSProxy object to call Data Integration web service operations. DIWS_URL is a variable containing the endpoint URL for the Data Integration web services.

5.

Associate the MWSProxy and DIWSProxy objects with the repository and user name in the session ID. All subsequent requests made to the Batch web services using the MWSProxy or DIWSProxy object use the repository and user name in the session ID.
((org.apache.axis.client.Stub)MWSProxy).setHeader(createSessionHeader(sessionID)); ((org.apache.axis.client.Stub)DIWSProxy).setHeader(createSessionHeader(sessionID));

Session Maintenance in Axis
The Web Services Hub requires session maintenance to cache resources. The SOAP header in the SOAP message carries the session information facilitating session maintenance. To perform session maintenance, complete the following steps: 1. Extract the SOAP header (MWSHeader) with the root element name “Context” and the namespace http://www.informatica.com/wsh from the response of the Login operation call using the MWSProxy object. This SOAP header contains the session ID sent by the Web Services Hub. Send this session ID in a SOAP header for all subsequent requests using the MWSProxy object. You set the SOAP header once in the MWSProxy object after the Login operation call, as follows:
SOAPHeaderElement MWSHeader =((org.apache.axis.client.Stub)MWSProxy).getResponseHeader( “http://www.informatica.com/wsh”,“Context”); ((org.apache.axis.client.Stub)MWSProxy).setHeader(MWSHeader);

2.

Set the SOAP header in the DIWSProxy object with the same SOAP header:
((org.apache.axis.client.Stub)DIWSProxy).setHeader(MWSHeader);

Making Operation Calls in Axis
You are now ready to call Metadata web service and Data Integration web service operations using the MWSProxy and DIWSProxy objects. For example, you can call the getAllDIServers operation to get a list of Integration Services:
DIServerInfoArray servers = MWSProxy.getAllDIServers(null); if (servers.getDIServerInfo() != null) { for(int i=0; i < servers.getDIServerInfo().length ; i++) { System.out.println("("+(i+1)+") "+servers.getDIServerInfo(i).getName()); } }

You can call the pingDIServer operation to check the state of an Integration Service:
DIServiceInfo diInfo = new DIServiceInfo(); diInfo.setDomainName(DI_DOMAIN_NAME); diInfo.setServiceName(SERVICE_NAME);

PingDIServerRequest pingReq = new PingDIServerRequest(); pingReq.setDIServiceInfo(diInfo); pingReq.setTimeOut(100);

42

Chapter 5: Writing Client Applications

EPingState eps = DIWSProxy.pingDIServer(pingReq);

DI_DOMAIN_NAME is a variable containing the name of the domain that contains the Integration Service. SERVICE_NAME is a variable containing the Integration Service name.

Clean Up in Axis
Clean up operations release the Web Services Hub resources acquired by client applications. To clean up and release resources, call the Logout operation using the MWSProxy object:
MWSProxy.logout(new VoidRequest());

Error Handling in Axis
You can implement client application error handling in Axis by placing the code in a try block and catching the FaultDetails object. The FaultDetails class is generated as part of the client proxies. You can use the following code in a try block to catch the FaultDetails object:
try { // Code for steps explained above. } catch(FaultDetails fault) { // Display fault code System.out.println(“fault code : “ + fault.getFaultCode()); // Display fault string System.out.println(“fault string : “ + fault.getFaultString()); // Display error code System.out.println(“error code is : “ + fault.getErrorCode()); // Display extended details System.out.println(“extended detail is : “ + fault.getExtendedDetails()); }

Writing a Client Application in Java for Batch Web Services

43

Writing a Client Application in C# for Batch Web Services
This section highlights the steps to write a client application in C# using the .NET Web Services Toolkit.
Note: The sample code snippets in the following sections are taken from the Batch Web

Services sample programs. You can view the sample programs in the following directory:
<PowerCenterInstallationDir>\server\samples\BatchWebServices\samples\dotnet\csharp

Generating Client Proxy Classes in .NET
You can create client proxy classes for the Web Services Hub in C# using the Microsoft .NET Web Services Toolkit. To generate client proxies in C#, complete the following steps: 1. Download the Metadata web services and Data Integration web services WSDL files from the Web Services Hub console. Verify that the WSDLs have the correct host name and port number for the Web Services Hub in the endpoint URL. If the endpoint URL is not correct, update the address element, which is available in the definitions\service\port hierarchy in the WSDL file. Use the following command to generate the client proxy classes:
wsdl <WSDLFile>

2.

For example, for WSDL files named Metadata.wsdl and DataIntegration.wsdl, run the following commands:
wsdl Metadata.wsdl wsdl DataIntegration.wsdl

The commands generate two proxy classes:
− −

MetadataService.cs. Contains the interface for the Metadata web services. DataIntegrationService.cs. Contains the interface for the Data Integration web services.

Initialization in .NET
The client application must perform an initialization step before it makes calls to Metadata web services and Data Integration web services. To perform initialization, complete the following steps: 1. Instantiate a MetadataServiceSoapBinding class object (MWSProxy):
MWSProxy= new MetadataServiceSoapBinding();

If the Metadata service endpoint URL in the Metadata.wsdl does not have the correct URL, you can set the URL with the following code:
MWSProxy.Url = MWS_URL;

44

Chapter 5: Writing Client Applications

SessionId = sessID. DIWS_URL is a string containing the Data Integration web service endpoint URL. If the Data Integration service endpoint URL in the DataIntegration. USER_NAME is a string containing a user name valid for the repository. The SOAP header in the SOAP message carries the session information facilitating session maintenance. LoginRequest loginReq = new LoginRequest(). Instantiate a DataIntegrationServiceSoapBinding class object (DIWSProxy): DIWSProxy= new DataIntegrationServiceSoapBinding ().Password = PASSWORD.NET client proxy classes handle session maintenance for you.SessionId = sessID. and password. REPO_DOMAIN_NAME is a string containing a PowerCenter domain name.Login(loginReq). MWSProxy. DIWSProxy.Context.NET You are now ready to call Metadata web service and Data Integration web service operations using the MWSProxy and DIWSProxy objects. loginReq. repository. Use the MWSProxy object to call Metadata web service operations. Use the DIWSProxy object to call the Data Integration web service operations.Url = DIWS_URL.RepositoryName = REPO_NAME. 3.UserName = USER_NAME.NET The Web Services Hub requires session maintenance to cache resources. String sessID = MWSProxy. loginReq. Writing a Client Application in C# for Batch Web Services 45 . user name. The . wrapped in an object LoginRequest and returns a session ID. Call the Login operation using the MWSProxy object to create a session ID for the client application user account. Session Maintenance in .MWS_URL is a variable containing the endpoint URL for the Metadata web services. Making Operation Calls in . and PASSWORD is a string containing the password for the user to log in to the repository. 4. You do not need to take additional steps. 2.Context.wsdl does not have the correct URL. you can set the URL with the following code: DIWSProxy. loginReq. REPO_NAME is a string containing the name of a repository in the domain. Associate the MWSProxy and DIWSProxy object with the repository and user name in the session ID. The Login operation takes a domain. loginReq.RepositoryDomainName = REPO_DOMAIN_NAME. All subsequent requests made to the Batch web services using the MWSProxy or DIWSProxy object use the repository and user name in the session ID.

NET framework SDK.pingDIServer(pingReq). i < servers. 46 Chapter 5: Writing Client Applications .NET by placing the code in a try block and catching the SOAP Exception object.WriteLine(“fault code is : “ + fault. i++) { Console.com/PowerCenter”]. DI_SERVICE_NAME is a variable containing the Integration Service name. EPingState pingResult = DIWSProxy1.For example. pingReq. diInfo1.DIServiceInfo = diInfo1. diInfo1. // Parsing detail element XmlNode detail = fault.Detail.GetAllDIServers(null). Error Handling in .Message). You can use the following code in a try block to catch the SOAP Exception object: try { //Code for steps explained above.WriteLine(“fault string is : “ + fault. pingReq.NET You can implement client application error handling in . } } You can call the pingDIServer operation to check the state of an Integration Service: PingDIServerRequest pingReq = new PingDIServerRequest().WriteLine("("+(i+1)+") "+servers[i]. The SOAP Exception class is part of the .Length . } catch(SoapException fault) { // Display fault code Console. XmlElement WSHFaultDetails = detail[“WSHFaultDetails”. DIServiceInfo diInfo1 = new DIServiceInfo(). // Display fault string Console.Code). “http:// www. you can call the getAllDIServers operation to get a list of Integration Services: DIServerInfo[] servers = MWSProxy.Name).DomainName = DI_DOMAIN_NAME. if (servers != null) { for(int i=0.informatica.ServiceName = DI_SERVICE_NAME1. DI_DOMAIN_NAME is a variable containing the name of the domain that contains the Integration Service.TimeOut = (PING_TIME_OUT).

InnerText). // Display extended details Console. } Writing a Client Application in C# for Batch Web Services 47 .InnerText).XmlElement ErrorCode= WSHFaultDetails [“ErrorCode”]. // Display error code Console.WriteLine (“error code is : “ + ErrorCode. XmlElement ExtendedDetails= WSHFaultDetails [“ExtendedDetails”].WriteLine (“extended detail is : “ + ExtendedDetails.

Client Applications for Realtime Web Services Client applications for Realtime web services involve the following elements: ♦ ♦ ♦ ♦ ♦ Web service workflows Client proxy classes Initialization Operation calls Error handling For more information about writing Java client applications to access Realtime web services in PowerCenter. Enable the following options in the workflow to allow a client application to run the workflow: ♦ ♦ ♦ Web Service. Initialization The client application must instantiate the web service object in the client proxy classes and get the port for the web service before the application can make calls to the web service operations. Generate the client-side proxy classes from the WSDL file using the web service toolkit. see “Writing a Client Application in Java for Realtime Web Services” on page 50. To generate client proxies. Visible. Runnable. create the mappings and workflows in PowerCenter. Select the web services toolkit for the platform and language in which you want to develop. Refer to the web services toolkit documentation for details on generating proxy classes. Before you create the client application. Web Service Workflows You build realtime web service client applications to run web services workflows. Each toolkit generates the client proxy classes in a specific way. Enable the Web Service option to turn a workflow into a web service workflow. 2. 3. Download the WSDL for the realtime web service from the Web Services Hub console. Enable the Visible option so that the Web Services Hub publishes the WSDL for the web service in the Web Services Hub console. Enable the Runnable option to allow a client application to run the web service workflow. Generating Client Proxy Classes To use Realtime web services you create in PowerCenter. 48 Chapter 5: Writing Client Applications . complete the following steps: 1. you need to generate client proxy classes from the WSDL files of the web service you want to access.

When the web service sends back a response.Operation Calls To invoke a web service operation. Error Handling Error handling in a Realtime web services client application is the same as in a Batch Web Services client application. the client application must handle the response as needed. The client application should implement the appropriate error handling scheme to retrieve the SOAP fault. the client application must create a request object and pass it to the port operation. Client Applications for Realtime Web Services 49 . SOAP fault elements in the SOAP response contain the errors that occur during calls to web services.

You can create a mapping to receive a message from a web service client. For more information about creating and configuring a web service workflow. Create a workflow to run the mapping and enable the Web Services option in the workflow properties. 3. complete the following steps: 1.html Before you create the client application that calls a PowerCenter web service workflow. For more information about configuring the web service workflow. transform the data. For more information about creating a PowerCenter mapping to use in a web service. create the Java application to call the web service. Create a mapping for the web service workflow. PowerCenter generates a WSDL for the web service. 2. 4. complete the following steps: 1. Perform the next steps within the Java application. see “Working With Web Service Workflows” on page 77. To create a client application that calls Realtime web services. you must first create the web service workflow and generate the WSDL for the web service. After you create the proxy classes. you can view the WSDL on the console of the Web Services Hub associated with the web service. You then create the client application based on the web service WSDL. and send the response back to the web service client or write it to any target that PowerCenter supports. 3. Initialize the web service objects. 2. After you create the web service. Create the request object. see “Configuring the Web Service Workflow” on page 80. If you configure the web service to be visible. see “Working with Mappings” on page 57. Select the Runnable option so that client applications outside of PowerCenter can run the workflow.org/axis/java/user-guide.apache. Pass the request object to the port operation and handle the response. When you create the web service workflow. To create a PowerCenter web service and generate the WSDL. For more information about using the Axis Web Services Toolkit see the documentation on the Apache web site: http://ws. you can develop a client application to run the web service workflow. 50 Chapter 5: Writing Client Applications . Locate and download the WSDL for the web service workflow. Generate the client proxy classes for the web service.Writing a Client Application in Java for Realtime Web Services This section provides instructions for using the Axis Web Services Toolkit to create a Java client application program that calls a PowerCenter realtime web service. Create a workflow and enable it as a web service.

if the namespace is of the form http://x.axis. Verify that the WSDL has the correct host name and port number for the web service in the endpoint URL. In the sample program. You can view the example in the following directory: <PowerCenterInstallationDir>/server/samples/RealtimeWebServices/samples /axis/CustomerLookup_MULTIPLEROW Step 1. Use the following command to generate the client proxy classes: java org.y. By default. the following code gets the port for the web service: CustomerLookup_MULTIPLEROWPort port = service.wsdl The -W option turns off support for wrapped document literal services. for a WSDL file named SampleWS. the corresponding package will be com. Generate Client Proxy Classes in Axis You can use the Axis Web Services Toolkit to generate Java client proxy classes for the web service WSDL. Writing a Client Application in Java for Realtime Web Services 51 .y. request. WSDL2Java generates a class for each data type defined in the WSDL.wsdl.y. you can run the WSDL2Java tool to generate the Java proxy class files.Note: The sample code snippets in the following sections are taken from the Realtime web services sample program for multiple row lookup. you must create the web service object in the client proxy classes and get the port for the web service.wsdl.apache. Create the Request Object You must create a request object and any required parameter to be passed to the web service.getCustomerLookup_MULTIPLEROWPort()). update the address element.WSDL2Java -W <WSDLFile> For example. In the sample program.setCustomerID_in(CustomerID). Step 2. Specifically. instantiate the service locator classes. Typically. To get the port for the web service.x. In the sample client application.com or urn:x. WSDL2Java generates package names based on the namespaces in the WSDL. Step 3.com. the following code creates a lookup request object: CustomerLookupRequest request = new CustomerLookupRequest(). Initialize the Web Service Objects Before you call any web service operation.WSDL2Java -W SampleWS. To create the web service object. run the following command: java org. which is available in the \definitions\service\port hierarchy in the WSDL file.axis.apache. If the endpoint URL is not correct.wsdl. use the proxy class created for the port type. the following code instantiates the service locator: CustomerLookup_MULTIPLEROW service = new CustomerLookup_MULTIPLEROWLocator().

The web service sends back a response. System.println("***** Customer Gender: " + response[i]..getCustomerName_out()).out.1) System.out. System. } else { CustomerLookupResponse[] response = responseOperation. if (i < response.out.getCustomerAddress_out()).out.. if (responseOperation == null) { System. for (int i = 0.length ."). System. pass it to the port operation.getCustomerAge_out()).getCustomerID_out()).println("***** Customer(s) that matches with the Customer ID is/are .out.println("***** Customer ID: " + response[i].out. i < response.println("***** Customer Name: " + response[i]. You can handle the response based on your requirements.out. } } 52 Chapter 5: Writing Client Applications . System.length.println().println("***** Customer Age: " + response[i]. i++) { System. System. System.println ().Step 4.customerLookup_MULTIPLEROWOperation(requestOperation). Send the Request and Handle the Response After you create the request object.println("Customer(s) with the ID as " + CustomerID + " does not exist!!!"). the following code passes the request object to the port and displays the response: _CustomerMultipleRowLookupOperationResponse responseOperation = port.out.getItem(). In the sample client application.println("***** Customer Address: " + response[i].getCustomerGender_out()).out.

For a web service client application. Parameter Array Definition The parameter definition in a SOAP request consists of the scope. a parameter represents a value you can change between sessions. The WSDL contains the following definition for the parameter array elements: <complexType name="Parameter"> <sequence> <element name="Scope" type="xsd:string" /> <element name="Name" type="xsd:string" /> <element name="Value" type="xsd:string" /> </sequence> </complexType> <complexType name="ParameterArray"> <sequence> <element maxOccurs="unbounded" minOccurs="0" name="Parameters" nillable="true" type="impl:Parameter" /> </sequence> </complexType> For example. you have the following parameters in a parameter file: [s_m_A] $a=1 $b=2 $c=3 Using Parameter Arrays 53 . such as a database connection or a source or target file. The parameter file must be accessible to the Integration Service. provide the parameter values in the elements of the parameter array in the client application. To use a parameter array. name. a request to start a workflow or task can specify the parameters associated with the workflow or task with the name of a parameter file or the list of parameters and values in parameter array. and value of the parameter. For example.Using Parameter Arrays In PowerCenter. When the Integration Service runs the workflow or task. specify the parameter file name in the client application. You can create parameters associated with a workflow or session to provide flexibility each time you run a workflow or session. it uses the parameters in an array the same way it uses parameters in a parameter file. you can define the values for parameters associated with a workflow or session in a parameter file or a parameter array. To use the parameters in a parameter file.

[WSH_Folder.s_m_B] $d=4 The SOAP request for a web service call to the StartWorkflow operation with the same parameters in a parameter array would include the following elements: <StartWorkflow> … <Parameters> <Parameter> <Scope>s_m_A</Scope> <Name>$a</Name> <Value>1</Value> </Parameter> <Parameter> <Scope>s_m_A</Scope> <Name>$b</Name> <Value>2</Value> </Parameter> <Parameter> <Scope>s_m_A</Scope> <Name>$c</Name> <Value>3</Value> </Parameter> <Parameter> <Scope>WSH_Folder. Parameter param1 = new Parameter(). The following sample code from a web service client application in Axis shows how to create the parameter array in a WorkflowRequest: Parameter[] parameters = new Parameter[4]. 54 Chapter 5: Writing Client Applications . You can specify any number of parameters in a parameter array.s_m_B</Scope> <Name>$d</Name> <Value>4</Value> </Parameter> … </StartWorkflow> The WorkflowRequest and TaskRequest types contain ParameterArray elements.

setName($a”). You can use parameter arrays in the following operations: ♦ ♦ ♦ ♦ ♦ StartWorkflow StartWorkflowFromTask RecoverWorkflow ResumeWorkflow (deprecated) StartTask Using Parameter Arrays 55 . Param1.setName(“$d”). Param2. Parameters[3] = param4. Param2. Parameter param2 = new Parameter().setScope(“s_m_A”). Param3. Param1. Param3.setScope(“WSH_Folder.setName(“$b”).setScope(“s_m_A”).setParameters(parameters). Param3. Param4. Param2. Parameters[1] = param2. Param4. Parameters[0] = param1. WorkflowRequest wfReq = new WorkflowRequest().setValue(“4”). Param4.setValue(“1”). wfReq. Parameters[2] = param3.setValue(“3”).Param1.setName(“$c”).setValue(“2”).s_m_B”). Parameter param4 = new Parameter().setScope(“s_m_A”). Parameter param3 = new Parameter().

the Integration Service uses the parameter array in the web service request when it runs the workflow. Do not specify a parameter file name and a parameter array in the a SOAP request when you make a web service operation call. 56 Chapter 5: Writing Client Applications . ♦ The parameter array in a SOAP request overrides any parameter file defined in the properties of a task or workflow.Rules and Guidelines for Using Parameter Arrays Use the following rules and guidelines when you use a parameter array in a web service request: ♦ Use a parameter file OR a parameter array. If you specify a parameter array in a web service request to start a workflow and the workflow has an associated parameter file defined in the workflow properties. the Web Services Hub returns the following fault: ERROR: Error: Both parameter list and parameter file are specified. If you specify both a parameter file and parameter array in the SOAP request.

66 Working with Web Service Mappings. 58 Importing Web Service Source and Target Definitions. 72 Attachments. 59 Viewing and Editing Web Service Definitions. 75 57 .Chapter 6 Working with Mappings This chapter includes the following topics: ♦ ♦ ♦ ♦ ♦ Overview.

Based on the source and target definitions. use the Designer to complete the following tasks: ♦ Import definitions. the Designer imports output and fault messages. You can edit properties such as description. You can view the groups and relationships in the XML Editor. When you import a source. and send the response back to the web service client or write it to any target PowerCenter supports. the Designer imports the input message. When you import a target. transform the data. The Designer creates multiple groups in a definition based on the XML hierarchy of the file. You can edit the definition in the Designer workspace. and precision for String and Binary datatypes.Overview Before you can define a web service workflow in the Workflow Manager. You can also create a mapping using flat file or XML sources and targets and use it in a web service workflow. Import operations from a WSDL file to create web service source and target definitions. Create mappings. metadata extensions. This allows you receive message data through a SOAP call by attachment instead of reading it from a file. View and edit definitions. ♦ ♦ 58 Chapter 6: Working with Mappings . PowerCenter can receive and send attachments as part of the SOAP request. You can create a mapping to receive a message from a web service client. Most properties of a web service definition are read-only.

If the Designer detects an attachment. The WSDL file contains information about a web service operation. Note: You can import definitions from a WSDL file with document/literal encoding. This represents the metadata for a web service SOAP request. it creates an attachment group in definition. This represents the metadata for a web service SOAP response. Importing Web Service Source Definitions When you use the Source Analyzer to import an operation from a WSDL file. Detail group has foreign key pointing to body group. Web Service Source Definition Root group contains message ID. the Import Wizard imports the input message associated with the operation. You create web service source and target definitions by importing a WSDL file. Figure 6-1 shows a source definition imported from a WSDL file: Figure 6-1. The Designer creates a source or target definition based on the operation you choose in the WSDL file you import: ♦ ♦ ♦ When you import a WSDL file in the Source Analyzer. Header group has foreign key pointing to root group. When you import a WSDL file in the Target Designer. the Designer imports output message of an operation. Importing Web Service Source and Target Definitions 59 . the Designer imports the input message of an operation. Each definition has multiple groups.Importing Web Service Source and Target Definitions Web service source and target definitions represent metadata for SOAP request and response messages. Body group has foreign key pointing to root group. You can import definitions that contain MIME attachments.

Body group contains a foreign key pointing to the root group. Table 6-2 describes the message header ports in a web service definition: Table 6-2. see “Steps for Importing Web Service Sources and Targets” on page 61. For information about importing web service source definitions. Message Header Ports Port Name PK_Message MessageID ClientID ClientIP Description Generated primary key for the root group. the Designer creates ports in the message header that are not part of the XML hierarchy. Attachment group contains a foreign key pointing to the root group. When you run a web service workflow. For information about the message header ports. User ID of the web service client. the Import Wizard imports the output message and any fault message associated with the operation. TCP/IP address of the web service client. Detail group contains a foreign key pointing to the body group. Importing Web Service Target Definitions When you use the Target Designer to import an operation from a WSDL file. The attachment group has an n:1 relationship with the root group. It uses this ID to correlate the incoming request with the outgoing response. Because a function within an operation can result in different faults. The message root group for a web service target definition contains a message ID port. 60 Chapter 6: Working with Mappings . Web Services Definition Groups Group Name Message Header_name Body_name X_ name Att_name Description Root group contains the message ID and client information. This detail group has an n:1 relationship with the body group. Web Services Hub generates the message ID when it receives a request. When you import a web service source definition. The header group has 1:1 relationship with the root group. A fault message represents an error processing the request. the Web Services Hub uses this information to identify the web service client and generate a message ID. the Import Wizard may create multiple fault definitions. Header group contains a foreign key to the root group. The body group has a 1:1 relationship with the root group. Each message contains a group for the message root and the message body.Table 6-1 describes the groups in a web service definition: Table 6-1. see Table 6-2.

Figure 6-2 shows a sample output message and fault message:
Figure 6-2. Web Service Target Definitions
Output Message Fault Message

Note: When the Designer imports a web service target definition, it names the definition based

on the operation and the target type, such as output or target. If you rename the definition, you can verify the target type on the Metadata Extensions tab. For information about importing web service target definitions, see “Steps for Importing Web Service Sources and Targets” on page 61.

Steps for Importing Web Service Sources and Targets
When you import a WSDL file, you can import it from a local file or you can import it from a URL. You can import definitions from a WSDL file with document/literal encoding. The Import Wizard imports the input message of operation as a source definition. It imports the output message and fault message of an operation as target definitions. If a service does not have an associated operation, you cannot import the definition. You can choose from the following options to create XML views:

Create entity relationships. Use this option to create views for multiple-occurring or referenced elements and complex types. You create relationships between views instead of creating one large hierarchy. For more information about entity relationships, see the PowerCenter XML Guide. Create hierarchical relationships. This is the default option for importing WSDLs. Use this option to create a root and expand the XML components under the root. If you choose to create a hierarchical relationship, then you create a normalized view. In a normalized view, every element or attribute appears once. One-to-many relationships become separate XML views with keys to relate the views. For more information about hierarchical relationships, see the PowerCenter XML Guide.

Importing Web Service Source and Target Definitions

61

To import a web service definition: 1.

From the Source Analyzer, click Sources > Import from WSDL (Provider). - or From the Target Designer, click Targets > Import from WSDL (Provider).

Select a URL.

Configure default precision. Choose to import from a local file or a URL. 2.

Choose to display import errors.

Click Advanced Options to configure the default precision for String datatype fields.

62

Chapter 6: Working with Mappings

Table 6-3 describes the options you can configure when you choose Advanced Options.
Table 6-3. Advanced Options for Importing Web Service Definitions
Option Override all infinite lengths Generate names for XML columns Description You can specify a default length for fields with undefined lengths, such as strings. You can choose to name XML columns with a sequence of numbers or with the element or attribute name from the schema. If you use names, choose from the following options: - When the XMLColumn refers to an attribute, prefix it with the element name. PowerCenter uses the following format for the name of the XML column:
NameOfElement_NameOfAttribute

- Prefix the XML view name for every XML column. PowerCenter uses the following format for the name of the XML column:
NameOfView_NameOfElement

- Prefix the XML view name for every foreign-key column. PowerCenter uses the following format for the name of a generated foreign key column:
FK_NameOfView_NameOfParentView_NameOfPKColumn

Maximum length for a column name is 80 characters. PowerCenter truncates column names longer than 80 characters. If a column name is not unique, PowerCenter adds a numeric suffix to keep the name unique. 3.

Select whether to import from a local file or a URL. If you choose to import from a URL, select a URL from the Address list and click Open. If you choose to import from a local file, select a file and click Open.

Importing Web Service Source and Target Definitions

63

Click Next. Choose an operation from the Import from WSDL dialog box.4. 64 Chapter 6: Working with Mappings . The Web Services Definition Creation Options dialog box appears. 5.

Hierarchy relationships with normalized XML views is the default option. Importing Web Service Source and Target Definitions 65 . 7. Click Finish. Choose to generate XML views as entity relationships or as hierarchy relationships. The web service definition appears in the workspace.6.

Columns Tab The Columns tab displays column information. and you can change the name of the definition. You can also edit some properties in the Designer workspace. You can edit precision for String and Binary datatypes. You can set the precision for String datatypes when you import the source or target. On the Attributes tab. On the Columns tab. When you set the precision. Note: The Mapping Designer invalidates mappings that use source and target web service definitions with a total column length greater than 500 MB. Viewing and Editing Definitions in the Designer Web service source definitions and target definitions contain the following tabs: ♦ ♦ ♦ ♦ Table. datatype. you can view attribute values for each column in a source or target definition. 66 Chapter 6: Working with Mappings . Columns. You cannot change the table type. On the Table tab. Metadata Extensions. such as port name. see “Steps for Importing Web Service Sources and Targets” on page 61. Attributes. the Designer uses the new value the next time you import a definition. you can view the definition in the Designer workspace or the XML Editor. and you can add business names and column descriptions. You can also modify the precision of individual columns after you import a definition. you can view the Web Services Domain metadata extensions. and scale. you can edit the precision for String datatypes. You can also add business names and column descriptions. You can also add metadata extensions in the User Defined Metadata Domain.Viewing and Editing Web Service Definitions After you import a web service source or target. you can provide the owner name and description. On the Metadata Extensions tab. For more information about modifying the precision when you import a definition. precision.

Figure 6-3 shows the Columns tab for a web service source definition: Figure 6-3. Columns Tab for a Web Service Definition Viewing and Editing Web Service Definitions 67 .

Figure 6-4 shows the Attributes tab for a web service target definition: Figure 6-4. the Attributes tab displays the MIME type in the data field.Attributes Tab The Attributes tab is a read-only tab that displays the XPath and XMLDataType values for each field in a source or target definition. Attributes Tab for a Web Service Definition MIME Type of Attachment 68 Chapter 6: Working with Mappings . If the definition has an Attachment group.

output. Output. To view a web service definition in the XML Editor: Right-click a definition and choose WSDL Workspace. Metadata Extensions Tab for a Web Service Definition Displays message type: Input. These metadata extensions identify the message type. see the PowerCenter XML Guide. You can perform functions such as validation and searching. or Fault. You can also view the vendor-defined extensions in the Web Services Provider Domain. or fault. Viewing and Editing Web Service Definitions 69 . you can view the groups and relationships in the XML Editor. The XML Editor is read-only for web service source and target definitions. Figure 6-5 shows the Metadata Extensions tab for a web service source definition: Figure 6-5.Metadata Extensions Tab You can create metadata extensions on the Metadata Extensions tab. which can be input. For more information about the XML Editor. View Definitions in the XML Editor After you import a web service source or target definition.

the Integration Service generates a response after it receives all incoming data. XML Editor Views of Web Service Definition Editing Web Service Targets in a Mapping When you work with web service targets in a mapping. All groups in the target must receive data from the same transaction generator. Transaction. ♦ 70 Chapter 6: Working with Mappings .Figure 6-6 shows the XML Editor view of the source definition shown in Figure 6-1 on page 59: Figure 6-6. When you set the load scope to transaction. Load scope in a web service target definition is similar to the transformation scope in a transformation. you can configure the load scope on the Properties tab. When you set the load scope to all input. The Integration Service ignores commits when the load scope is all input. Different groups in the target can receive data from different transaction generators. You can configure the following load scope values: ♦ All input. the Integration Service generates a response when it receives all data in the transaction.

Viewing and Editing Web Service Definitions 71 . For more information about transformation scope.You must set the load scope to transaction if you enable real-time flush and set the realtime flush latency to a value greater than zero. see “Understanding Commit Points” in the Workflow Administration Guide.

It can also contain flat file or XML source or target definitions. The mapping you create depends on the type of service that you want to run: ♦ Request-response service. The Integration Service loads data to a target. Required Sources and Targets in a Service Service Type Request-Response One-way Web Service Source Must have one instance of one web service source definition. and send the response back in a single session. When you create a one-way mapping. A one-way mapping uses a web service client for the source. often triggered by a real-time event through a web service request. Multiple mappings. 72 Chapter 6: Working with Mappings . For more information. When you create mappings for a request-response service. − ♦ One-way service. Can have multiple target fault definitions. see “Running Sessions and Web Service Workflows” on page 90. you do not need to propagate the message ID to the target. Contains no web service target definition. − One mapping. you must propagate the message ID from the source to the target. A request-response service receives an incoming request from the web service client.Working with Web Service Mappings You can create web service mappings to process web service requests. If you receive updates and notifications from a web service client. Note: You can also create mappings with flat file or XML source or targets and run them in web service workflows. You receive an incoming request. A web service mapping can contain source or target definitions imported from a Web Services Description Language (WSDL) file containing a web service operation. You can create one mapping or multiple mappings to process a request-response service. and sends the response back to the web service client. but do not need to send back a response. Create one mapping that contains both the web service source and web service target definitions. Web Service Target Can have multiple instances of one target output definition. The web service source and target definitions you include in the mapping depend on the type of mapping you create. Create multiple mappings if you need to stage data before sending a response back to the web service client. Must have one instance of one web service source definition. transforms the data. A request-response service uses both a web service source and a web service target. You can create a workflow that contains a session for each mapping. Table 6-4 describes the web service source and target definitions you use based on the mapping type: Table 6-4. you can create a one-way mapping. transform the data.

For example. you want to store all order information in a log and pass confirmation and order totals back to the customer.Request-Response Mappings A request-response mapping uses a web service source and target. For example. an organization has an online order service. If you do not import source and target definitions from the same WSDL file. and sends messages to another MQSeries queue. Request-Response Mapping Note: When you create request-response mappings. the SQL transformation receives the errors from the database and outputs the error text to the target. use source and target definitions imported from the same WSDL file. This mapping has a flat file target and an MQSeries target. For more information about the SQL transformation. When database errors occur in processing. 2. but you need to stage the data first. processes them. Create a request mapping with a web service source definition. When you create a request-response mapping. You must make an asynchronous call to an external system through IBM MQSeries. The SQL transformation can return multiple database rows to the target. An external application receives messages from the MQSeries target. you receive message data that you need to process. When a customer places an order. You create the following mappings: 1. you can create multiple mappings to process the data. Working with Web Service Mappings 73 . When you create a requestresponse mapping. Figure 6-7 shows a sample request-response mapping: Figure 6-7. you might get unexpected results. You write all message data to both targets. see “SQL Transformation” in the PowerCenterTransformation Guide. use source and target definitions imported from the same WSDL file. Staged Mappings If you want to run a request-response session. you must propagate the message ID to the target. You can use an SQL transformation to update a database or to retrieve multiple database rows midstream in a request-response mapping.

You can join the MQSeries source with the flat file source to propagate the message ID to the web service target. 74 Chapter 6: Working with Mappings .3. Create a response mapping with a web service target definition. It also uses the MQSeries queue with the processed data as a source. This mapping uses the flat file target as a source.

The document type you can attach is based on the MIME content of the WSDL file. Instead of using FTP. you periodically use FTP to access a flat file containing messages from a web service application. you can set up a SOAP call to receive messages through a service. Attachments 75 . or PDF. JPEG. change the reader from Flat File Reader to Web Services Provider Reader for Flat Files. This eliminates disk input and output and lets you receive the message as a SOAP request rather than wait to receive a file. When you configure the session. You can attach document types such as XML.Attachments The Web Services Provider supports attachments in web service client messages. For example. Flat File or XML Mappings You can read from or write to web service clients using flat file or XML mappings. You change the reader on the Mappings tab of the Edit Tasks dialog box: Change the reader to Web Services Provider Reader for Flat File. Requests with Attachments Based on the source and target definitions. GIF. you can receive and send attachments as part of the SOAP request.

you do not need to propagate the index to the target. If you receive messages from other sources. You can view the MIME type for the attachment on the Attributes tab. Table 6-5 describes the attachment group ports in a web service definition: Table 6-5. Attachment Group Ports Port Name FK_Att_Name Att_Data_Name Att_Index_Name Att_Type_Name Description Generated foreign key pointing to PK_Message in the root group. use a Sequence Generator transformation to generate a unique index for each attachment you send in a response. Or. you must propagate the index to the target if you pass the attached request to the response. you must create a client application using a toolkit that supports MIME attachments. Unique identifier for each attachment in the message. ♦ ♦ 76 Chapter 6: Working with Mappings . If you do not pass the attached request to the response. you can extract an XML document from an Oracle database and pass it to a web service client as an attachment to a response message. and each message contains the same number of attachments. To send or receive attachments. connect none of the ports in the group. If you want to pass attachments through requests or responses. you must connect all ports in the attachment group. Type of attachment. If a definition in the mapping contains an attachment group. you might set up a client application to allow web service clients to send PDF attachments in a request. Contains the attachment. Use the following rules and guidelines when you work with attachments: ♦ ♦ ♦ ♦ A request or response can contain zero or more attachments. If you receive more than one attachment in a request. but you do not want to send or receive attachments.For example.

82 Running Sessions and Web Service Workflows. 79 Creating and Configuring a Service Session. 92 77 . 90 Troubleshooting.Chapter 7 Working With Web Service Workflows This chapter includes the following topics: ♦ ♦ ♦ ♦ ♦ Overview. 78 Creating and Configuring a Web Service Workflow.

you must create and configure a Web Services Hub on the Administration Console and associate it with a repository. For more information about running sessions. flat file. You configure the service within the workflow properties. see “Creating and Configuring a Web Service Workflow” on page 79. see “Creating and Configuring a Web Services Hub” in the PowerCenter Administrator Guide. 78 Chapter 7: Working With Web Service Workflows . Note: Before you can run a web service workflow.Overview You configure web service workflows in the Workflow Manager. use a mapping that contains web service. you change the reader or writer type. If you use a flat file or XML source or target. For more information about creating sessions. or XML sources or targets. see “Creating and Configuring a Service Session” on page 82. see “Running Sessions and Web Service Workflows” on page 90. For more information. For more information about creating web service workflows. To create a web service workflow. you must enable it for web services. When you create a session to add to the workflow.

Complete the following tasks when you create and configure a web service workflow: ♦ ♦ Create a web service workflow. You can configure the web service to allow web service clients to run the workflow. Create a web service workflow. Ensure that you specify an Integration Service when you create a web service workflow. Figure 7-1 shows how to enable the workflow for web services: Figure 7-1. configure a workflow to process a web service mapping and enable the Web Services option in the workflow properties. A service session is based on a service mapping. you create a web service workflow. Creating and Configuring a Web Service Workflow 79 . Configure the web service. You can configure service information and add service sessions to the workflow. Each web service workflow must contain one web service input message source and at most one type of web service output message target. The workflow can write to multiple fault message targets. Creating a Web Service Workflow When you enable the Web Services option for a workflow. Creating a Web Service Workflow Browse list of Integration Services.Creating and Configuring a Web Service Workflow To create a web service workflow. Use the Browse button to the right of the Server field to select from a list of available Integration Services. Configure service.

timeout. you configure a web service name. and accessibility options. If you do not protect the service. For more information about timeout and flush latency. Web Service Configuration Table 7-1 describes the properties you can configure for a web service: Table 7-1. For more information about authentication. any web service client can start the service without authentication. The Web Services Hub authenticates the user based on the PowerCenter repository user name and password. Any PowerCenter user who can run a workflow can run a protected web service workflow using the Workflow Manager. The user must have execute permissions on the folder containing the workflow. see “Understanding Service Timeout and Flush Latency” on page 90. or LMAPI. When you protect the service. Limits the service to repository users. Default is 60 seconds. see “Web Services Hub Security” on page 20. Set to 0 to disable the timeout period. Figure 7-2 shows the Config Service dialog box: Figure 7-2. Timeout Protected 80 Chapter 7: Working With Web Service Workflows . If the Web Services Hub is unable to generate a response. Maximum number of seconds between the time the Web Services Hub receives a SOAP request and generates a SOAP response. pmcmd. Web Service Properties Option Service Name Description Name of the web service. and workflow name. This name must be unique. folder name. The Web Services Hub publishes this name when you check in the workflow and the service is visible. Set this to a value greater than the real-time flush latency in the reader properties. You can choose to protect the service or make it public. the web service client must log in to the repository through the Web Services Hub before it can start the service. The default name is a concatenation of the repository name. the request fails.Configuring the Web Service Workflow When you configure a web service workflow.

or pmcmd. If disabled. If disabled. you can start the workflow through the Workflow Manager. Runnable Creating and Configuring a Web Service Workflow 81 . the Web Services Hub publishes the service and WSDL in a list of services available to web service clients. Allows a web service client to start the service. web service clients can still run a service by submitting a request with the service name and WSDL. If the service is not visible. Web Service Properties Option Visible Description Makes the web service visible in the Web Services Hub to web service clients. If enabled. However. a web service client can invoke the service while the workflow is running. a web service client can start the workflow or invoke the service while the workflow is running. LMAPI. When you make the service visible. the Web Services Hub does not publish the service WSDL. schedule the workflow to run on demand.Table 7-1. If you want a web service client to start the workflow. but cannot start the workflow.

When you create a service session. Web Services Provider writer. You can configure partitioning properties based on the source and target type in the mapping. use a service mapping or any flat file or XML mapping. Commit type. you configure terminating conditions. you configure caching information that the Integration Service uses to cache target data. the Integration Service stores messages in the cache directory. see “Configuring the Web Services Provider Writer” on page 85. For more information about configuring the reader. When you enable recovery. Partitioning. You can also configure the output format for the target data. 82 Chapter 7: Working With Web Service Workflows . click the Mapping tab and select a source. see “Configuring Commit Type” on page 88. For more information about message recovery. When you configure the reader for a service session. For more information about configuring the writer. In the session properties. such as idle time and message count. ♦ ♦ ♦ ♦ Configuring the Web Services Provider Reader The properties you configure for a Web Services Provider reader depend on the source type in the mapping. When you configure the writer for a service session.Creating and Configuring a Service Session When you create a session in a web service workflow. For more information about partitioning. Recovery. Configure real-time sessions for a source-based commit. see “Configuring the Web Services Provider Reader” on page 82. see “Recovering Messages” on page 87. To configure the Web Services Provider reader. Configure the following properties when you configure a service session: ♦ Web Services Provider reader. you create a service session. see “Configuring Partitions” on page 88. edit a service session. For more information about commit behavior.

A value of -1 indicates an infinite number of messages. For more information.Web Service . always configure the message count to 1.Web Services Provider Reader Flat File .Web Services Provider Reader Flat File . see “Running Sessions and Web Service Workflows” on page 90. Default is -1 and indicates an infinite period of time.Web Service . The number of messages the Integration Service reads before it ends the session.Figure 7-3 shows the properties you configure for the Web Services Provider reader: Figure 7-3.Web Services Provider Reader XML File Description Amount of time in seconds the Integration Service waits to receive messages before it stops reading from the source and ends the session. Web Services Provider Reader Properties Table 7-2 describes the properties you configure for the different Web Services Provider readers: Table 7-2. Message Count* Creating and Configuring a Service Session 83 .Web Services Provider Reader XML File . Web Services Provider Reader Properties Property Idle Time* Source Type . Default is 1. If the session uses flat file or XML sources.

empty content is not null. Configuring Real-time Flush Latency Use flush latency to send response messages to the Web Services Hub after a specified number of seconds. see “Recovering Messages” on page 87. Interpret the value set for Real-time Flush Latency as milliseconds rather than seconds. Real-time Flush Latency Treat Real-time Flush as Milliseconds Web Service Recovery Cache Folder .Table 7-2. The Web Services Hub might not send responses to the web service client if you configure flush latency greater than the service timeout. Send response messages to the Web Services Hub after a specified number of seconds.Web Services Provider Reader XML File Web Service Description Amount of time in seconds that the Integration Service reads source messages from the Web Services Hub. When the Integration Service sends messages to the Web Services Hub more frequently. the Integration Service stops reading from the Web Services Hub after 10 seconds. Treats empty strings as null values.Web Services Provider Reader Flat File . if you specify 10 for a time limit. The Integration Service flushes messages to the Web Services Hub when it reaches the flush latency period or when the reader buffer is full. Default is disabled. the Integration Service measures the flush latency in milliseconds. the Integration Service measures the flush latency period in seconds. If you enable recovery. see “Running Sessions and Web Service Workflows” on page 90. When disabled. Setting flush latency to milliseconds affects performance. The Integration Service does not buffer messages longer than the flush latency period.Web Services Provider Reader Flat File . To commit messages in milliseconds.Web Service . For information about message caching. For more information. Or. whichever comes first. it consumes more system resources. enable the Treat Realtime Flush as Milliseconds option in the Web Services Provider reader properties. send response messages to the Web Services Hub after a specified number of milliseconds. if Treat Real-time Flush as Milliseconds is enabled. For example. Default is 0 and indicates an infinite period of time. When enabled. Use the following rules and guidelines when you configure flush latency: 84 Chapter 7: Working With Web Service Workflows .Web Services Provider Reader XML File Web Services Provider Reader XML File Treat Empty Content as Null *The session stops when it meets any of these conditions. Set this property to a value less than the service timeout in the service properties. You can configure the Web Services Provider reader to commit messages to the target in milliseconds rather than seconds. Default is $PMCacheDir/. Default is 0 (disabled).Web Service . the Integration Service stores messages in this location before processing them. By default. Web Services Provider Reader Properties Property Reader Time Limit* Source Type .

The session fails if a pipeline contains any transformation with Generate Transactions enabled. If the mapping contains a relational target. Web Services Provider Writer Properties Creating and Configuring a Service Session 85 . Configure the flush latency greater than the service timeout. The session fails if a pipeline contains any transformation that has row transformation scope and receives input from multiple transaction control points. Figure 7-4 shows the properties you configure for the Web Services Provider writer: Figure 7-4. click the Mapping tab and select a target. To configure the Web Services Provider writer. The session fails if the load scope is set to all input. The Integration Service ignores flush latency when you run a session in debug mode. The session fails if a pipeline contains any transformation with the transformation scope set to all input. edit a service session. In the session properties. configure the Target Load Type to be Normal. you configure cache size and cache directory.♦ ♦ ♦ ♦ ♦ ♦ ♦ ♦ The session fails if a pipeline contains a Transaction Control transformation. Configuring the Web Services Provider Writer When you configure session properties for a Web Services Provider writer.

Determines how the Integration Service handles orphan rows during a session. . Output just the tag. Determines how an empty string is represented in the target. .Local Time with Time Zone. The session fails when the error count exceeds the error threshold. Select from the following datetime formats: . The Integration Service passes the last duplicate row to the target. The time according to the Integration Service server time zone. Default is No Tag. .Tag with Empty Content. Determines how the Integration Service handles duplicate group rows during a session.Tag with Empty Content.First Row. Web Services Provider Writer Properties Property XML DateTime Format Target Type Web Services Provider Writer XML File Description Datetime format for the data passed to the service target. . The Integration Service rejects rows with the same primary key that it processes after this row. . 86 Chapter 7: Working With Web Service Workflows . Default is the $PMCacheDir server variable. Do not output a tag.No Tag.Web Services Provider Writer XML File .Web Service . Default is Error.000.Web Services Provider Writer XML File Cache Directory Directory for the target cache files. The Integration Service ignores orphan rows.Table 7-3 describes the properties you configure for a Web Services Provider writer: Table 7-3. The Integration Service passes the first row to the target. Greenwich Mean Time. Output just the tag. Select from the following options: .Error. Select from the following options: . . Select from the following options: . Do not output a tag. The difference in hours between the Integration Service time zone and Greenwich Mean Time. The Integration Service passes the first duplicate row to the target.No Tag. Total size in bytes for the memory cache used by writer.Web Service . Select from the following options: .Last Row. Determines how null content is represented in the target. The session fails when the error count exceeds the error threshold.Ignore.000 bytes. Default is Tag with Empty Content. Null Content Representation Web Services Provider Writer XML File Empty String Content Representation Web Services Provider Writer XML File Duplicate Group Row Handling Web Services Provider Writer XML File Orphan Row Handling Web Services Provider Writer XML File Cache Size . Default is 10.Error. Rows that follow with duplicate primary keys increment the error count.UTC.Local Time. .

Creating and Configuring a Service Session 87 . but not as a fault message. The cache size is the sum of all the groups in the target instance. The total cache requirement is the sum of the data cache and index cache requirements for each target group. It includes a primary key and a foreign key index cache for each group and one data cache for all groups. For more information about XML writer properties. you can recover read messages from a failed session. you still configure XML writer properties. use the target as a web service output message. When the session completes.Use the following rules and guidelines when you change the writer type to a Web Services Provider writer: ♦ ♦ ♦ When you change the writer type for a flat file target. you can recover the messages that the Integration Service could not process. When you change the reader or writer type. It empties the cache files at the end of the session. Configuring the Cache The Integration Service caches row data while it generates a message. The Integration Service reads and processes the messages from the cache. When you change the writer type for a flat file or an XML target. Recovering Messages When you enable recovery. the Integration Service pages to disk. the Integration Service does not cache the target messages. SOAP Message Attachments The Web Services Hub sends attachments to the web service client when you change the reader or writer type in the session properties to Web Services Provider reader or writer. requests and responses pass as MIME attachments to the SOAP message. The Integration Service removes messages from the message cache files after the flush latency period expires. If the session fails. the Integration Service releases cache memory and deletes the cache files. The Web Services Provider supports the following attachments: ♦ ♦ Flat file attachments XML attachments To send or receive attachments you must create a client application using a toolkit that supports MIME attachments. The Integration Service stores all read messages in a cache before processing the messages for the target. It does not continue to receive messages from the Web Services Hub. If the memory requirements exceed the cache size. When you change the writer type for an XML target. see the PowerCenter XML Guide.

the Web Services Hub uses a source connection to pass a request to the Integration Service. if you configure three partitions in a session that contains one source and one target. the Integration Service creates six connections to the Web Services Hub. When you run a multi-partitioned session. The Integration Service sends messages to the Web Services Hub based on the commit type that you choose. Note: The Integration Service ignores target-based commits for XML targets. three for each source and target. and you configure the on commit property to ignore. the interval begins when the Integration Service receives the first message from the Web Services Hub. see the PowerCenter Workflow Administration Guide. It does not send messages based on the commit interval. the Integration Service sends messages to the Web Services Hub based on the commit interval and the flush latency interval. Configuring Commit Type When you configure a real-time session. the Integration Service runs the session using sourcebased commit. The Integration Service sends messages to the Web Services Hub after receiving 1. Configuring Target-Based Commit If you configure a target-based commit. targets. For more information about recovery. For example. For example. The Integration Service uses a target connection to send a response to the Web Services Hub. The Web Services Hub and the Integration Service use the source and target connections in a round-robin fashion. you use five seconds as the flush latency interval and you set the source-based commit interval to 1. see the PowerCenter Workflow Administration Guide.000 messages from the source and after each five second flush latency interval. It does not issue a commit when it reaches the flush latency interval. If you configure a flush latency interval. Configuring Source-Based Commit If you configure a source-based commit. the Integration Service sends messages to the Web Services Hub when it reads 1. Configuring Partitions When you set up multiple partitions in a session that contains web service source and target definitions. and partitions in the session.000 messages. Note: The Integration Service ignores source-based commits for XML sources. the Integration Service creates a connection to the Web Services Hub based on the number of sources. It sends messages to the Web Services Hub based on the flush latency interval. idle time. If the session uses an XML target.Note: The Integration Service ignores the reader time limit. the Integration Service uses a source-based commit. and message count when it reads messages from the cache. 88 Chapter 7: Working With Web Service Workflows . For more information about commit types and intervals.000 messages.

For information about configuring partitioning for XML sources or targets or flat file sources or targets. you can configure pass-through partitioning for web service sources and targets. Creating and Configuring a Service Session 89 . see the PowerCenter Workflow Administration Guide.When you configure partitions for a service mapping.

it passes the response to the Web Services Hub. Working with XML and Flat File Sessions You can also create a web service session based on a mapping that contains XML or flat file sources and targets. The Integration Service generates an internal message ID for each request and automatically correlates the incoming request with the outgoing response. When you change the reader or writer type in the session properties. If the web service workflow is configured with an XML or flat file writer. For information about running services with flat file or XML mappings. the Integration Service starts a session instance for each request. change the reader or writer in the session properties to receive or send messages to the web service client. it sends a fault message to the web service client and drops the connection. If the request is request-reply. it generates a message ID and passes the request to the Integration Service. the Web Services Hub must generate the response message in the timeout period configured in the service properties. you must create a client application using a toolkit that supports MIME attachments. The Web Services Hub generates a SOAP message response and passes it back to the web service client. The Web Services Hub attaches the response to a SOAP message and sends it back to the web service client. see “Working with Web Service Mappings” on page 72. The Web Services Hub passes the SOAP message with the attachment to the Integration Service. Understanding Service Timeout and Flush Latency When you run a service session. To configure a web service session. To run a web service workflow with an XML or flat file reader. a client application sends a request to the Web Services Hub as an attachment to the SOAP message.Running Sessions and Web Service Workflows When the Web Services Hub receives a SOAP message request to run a web service based on a mapping containing web service sources or targets. which processes the attachment. Use the following rules and guidelines when you configure a request-response session with flat file or XML source or targets: ♦ ♦ ♦ Configure the message count to 1 in the reader properties. 90 Chapter 7: Working With Web Service Workflows . When the Web Services Hub reaches the timeout period. After the Integration Service runs the web service request. Include one session in a workflow when you change the reader or writer type to Web Services Provider. the Integration Service generates a response and passes the response to the Web Services Hub.

If the Web Services Hub reaches the timeout period before the reader buffer fills. ♦ You disable flush latency and use message count as the terminating condition. ♦ You disable flush latency and configure terminating conditions to infinite values. If the Integration Service does not process all 10 messages in the service timeout period. The Integration Service sends response messages when the buffer fills. Discarding the response. The following situations describe some session configurations that can result in dropped response messages: ♦ You configure flush latency to be greater than the service timeout period. You set the message count to 10. For example. the session runs continuously and never ends. if you disable flush latency.If the Integration Service sends a response message to the Web Services Hub after the timeout period. Running Sessions and Web Service Workflows 91 . the Web Services Hub drops the connection to the web service client and cannot send response messages received from the Integration Service. For example. For example. set the flush latency value to less than the service timeout. it drops the connection to the web service client and cannot send response messages received from the Integration Service. If you set the terminating conditions to infinite values. the Web Services Hub drops the response and writes the following message to the Web Services Hub log: WSH_95571 Unable to find invocation for message id <message ID>. To help ensure that the Web Services Hub does not reach the timeout period. The Web Services Hub reaches the timeout period and drops the connection to the web service client before the Integration Service flushes any response message to the Web Services Hub. you want the session to end after the Integration Service processes 10 messages. and you disable flush latency to flush all the messages at the end of the session. the Integration Service sends a response message to the Web Services Hub when the session reaches one of the terminating conditions or when the reader buffer fills. you set flush latency to 90 and the service timeout to 60.

See the Validate tab in the Workflow Manager for Web Services Hub error messages. When you invoke a protected web service workflow. A server must be associated with the workflow. and password. I am not able to start a protected web service workflow even though I am sending the proper repository name. The Web Services Hub validates web service workflows according to the following rules: ♦ ♦ ♦ ♦ ♦ There can be only one web service source definition in the mapping. You cannot run the Debugger against a service mapping or a reusable session without the workflow. and correct the problem indicated by the error message. My web service workflow was valid in the Workflow Manager. you need to edit and save the workflow. When you save the workflow. If there are no web service target definitions in the mapping.Troubleshooting I am trying to run the Debugger against a service session. After you start the Web Services Hub. If you want to debug a service session. the Web Services Hub generates WSDL to run the service. For more information. I updated the source WSDL file and reimported my source and target definitions. the Web Services Hub treats the service as a one-way service. but the service WSDL is not updated. To generate WSDL to reflect the mapping changes. A repository must be associated with the Web Services Hub. it validates each web service workflow according to its own validation rules in addition to those of the Workflow Manager. and I get the following message in the session log: WSP_34030 Must have workflow context to run this session. but became invalid when I started the Web Services Hub. There can be no more than one web service target definition in the mapping. user name. Changes to a mapping are not dynamically reflected in the Web Services Hub. you must run the Debugger against the web service workflow. The workflow is valid. but the session fails. see “Web Services Hub Security” on page 20. you must ensure that the repository user name and password is correctly set in the HTTP header. 92 Chapter 7: Working With Web Service Workflows .

Troubleshooting 93 . ERROR Thu Mar 23 08:45:50 2006 http-52962-Processor4 [WSH_735] DI Service is not specified for workflow [wf_amazon_actor_search].I received the following error while trying to fetch a workflow on a Web Services Hub: ERROR Thu Mar 23 08:45:51 2006 http-52962-Processor4 [WSH_501] Service Workflow [wf_amazon_actor_search] in Repository [zeus_RS1_sun920] and Folder [WSTest] is invalid. See “Creating a Web Service Workflow” on page 79. You must assign an Integration Service when you create a web service workflow. This workflow cannot be accessed using WSH.

94 Chapter 7: Working With Web Service Workflows .

99 Using the Realtime Web Services Sample Programs.Appendix A Web Service Sample Client Applications This appendix includes the following topics: ♦ ♦ ♦ ♦ ♦ Overview. 109 95 . 97 Examples for Batch Web Services. 106 Examples for Realtime Web Services. 96 Using the Batch Web Services Sample Programs.

see the PowerCenter Administrator Guide. For more information about creating. Use the PowerCenter Administration Console to create. configuring. or enabling a Web Services Hub. create and enable a Web Services Hub on the PowerCenter domain.exe tool. The C# sample programs use proxy classes generated for the .NET platform with the wsdl. and enable a Web Services Hub. The examples include programs in Java and C#. 96 Appendix A: Web Service Sample Client Applications .Overview Informatica ships sample client application programs that demonstrate how to use PowerCenter web services. The Java sample programs use proxy classes generated by the Axis Web Services Toolkit. configure. The web services sample programs are installed in the following directory: /<PowerCenterInstallDir>/server/samples/ Before running the web services sample programs. The sample programs work with the PowerCenter Batch web services and Realtime web services.

Contains the C# sample programs. This directory also contains the batch and script files to compile and run the sample programs. For example. PowerCenter must be installed and running. The Batch web services sample programs are installed in the following directory: /<PowerCenterInstallDir>/server/samples/BatchWebServices The /BatchWebServices directory contains the following files and directories: Directory /lib /ssl /samples/axis/<SampleProgramDirectory> Description Contains the library files needed to run the sample programs. Contains the Java sample programs. Contains the proxy classes for the Java sample programs. The source file for each Batch web services sample program can be found in a separate directory. Contains a sample keystore for running client applications in secure mode (HTTPS). This directory also contains the batch files to compile the proxy classes.Using the Batch Web Services Sample Programs Before you use the Batch web services sample programs. The PowerCenter domain must contain a Web Services Hub associated with a Repository Service. The name of the directory indicates the Batch web services operations demonstrated in the sample program. For example. Contains the proxy classes for the C# sample programs. Each sample program directory also contains the batch files to compile the sample programs. The source file for each Batch web services sample program can be found in a separate directory. The name of the directory indicates the Batch web services operations demonstrated in the sample program. the sample program in the /multiservers directory demonstrates logging in to more than one Integration Service associated with a Repository Service. Using the Batch Web Services Sample Programs 97 . the sample program in the /multiservers directory demonstrates logging in to more than one Integration Service associated with a Repository Service. /samples/axis/proxyclasses /samples/dotnet/csharp/<SampleProgramDirectory> /samples/dotnet/csharp/proxyclasses Compiling the Batch Web Services Sample Programs The steps to compile the Batch web services sample programs are determined by the programming language.

Running the Sample C# Programs To run the sample C# programs. to compile Sample1. Running the Sample Java Programs To run the sample Java programs. 98 Appendix A: Web Service Sample Client Applications . complete the following steps: 1. to run the Sample1. go to the sample program directory and run the batch or script file that matches the name of the sample program you want to run. go to the sample program directory and run the executable file for the sample program you want to run. For example. go to the directory and run RunSample1.sh (UNIX). Run the sample programs with the required parameters.sh (UNIX).exe extension.Compiling the Sample Java Programs To compile the sample Java programs. Run the batch or script file that matches the name of the sample program you want to compile. The steps to run the Batch web services sample programs are determined by the programming language. see “Examples for Batch Web Services” on page 99. For more information about the sample programs and parameters.dll in the /dotnet/csharp/bin directory.class file for the sample program in the same directory.bat (Windows) or RunSample1. Go to the sample program directory and run the compile batch file that matches the name of the sample program you want to compile.java program in the /axis/multithreaded directory.bat. The compile process creates a dynamic link library named WebServicesHub. The compile process creates an executable file with the name of the compiled program file and a . For example.java program in the /axis/multithreaded directory. Running the Batch Web Services Sample Programs The Web Services Hub must be running when you run a client application. Compiling the Sample C# Programs To compile the sample C# programs.bat (Windows) or CompileSample1. Go to the /dotnet/csharp/proxyclasses directory and run the compile. go to the directory and run CompileSample1. 2. The compile process creates a . go to the sample program directory and run the compile batch or script file.

The examples do not support secure mode (HTTPS).sh File to run C# sample: Sample1. User name to log in to the repository. Each platform has the same directories and each directory contains sample programs that demonstrate a different usage for web services.exe The following table describes the parameters you use to run the Sample1 application: Parameter Security mode Description Indicates the security mode in which to run the application.bat or RunSample1. Host name Port number Repository domain name Repository name User Name Password Examples for Batch Web Services 99 .sh File to run Java sample: RunSample1. Sample1. Name of the Repository Service. Password for the user name to log in to the repository. Browsing The sample programs in the /browsing directory demonstrate the use of web services operations that get information from the repository. Directory: /browsing File to compile Java and C# samples: CompileSample1. Port number on which the Web Services Hub is running.bat or CompileSample1.Examples for Batch Web Services The sample programs for Java and C# are in located in the following directories: Java: /WebServices/BatchWebServices/samples/axis/<SampleProgramDirectory> C#: /WebServices/BatchWebServices/samples/dotnet/csharp/<SampleProgramDirectory> The same set of sample programs are shipped for Java and C#. Name of the domain that contains the Repository Service. Pass the argument -ns to run the application in unsecure mode (HTTP). and tasks in the repository and the Integration Services registered with the repository. workflows. Name or IP address of the machine on which the Web Services Hub is running.cs This sample program logs in to a repository and then uses Metadata web services operations to get information about folders.java and Sample1. This section describes the Java and C# sample programs.

sh File to run C# sample: Sample1. It uses Metadata and Data Integration web services operations to access a folder in the repository and start and stop the first workflow found in the folder.bat or CompileSample1. Port number on which the Web Services Hub is running. The examples do not support secure mode (HTTPS).java and Sample2. Password for the user name to log in to the repository Name of the domain that contains the Integration Service.exe 100 Appendix A: Web Service Sample Client Applications .sh File to run C# sample: Sample2.exe The following table describes the parameters you use to run the Sample2 application: Parameter Security mode Description Indicates the security mode in which to run the application. Pass the argument -ns to run the application in unsecure mode (HTTP).bat or CompileSample2. Directory: /dataintegration File to compile Java and C# samples: CompileSample1. Name of the Repository Service. Name of the Integration Service. User name to log in to the repository.java and Sample1.Sample2. Host name Port number Repository domain name Repository name User Name Password Integration Service domain name Integration Service name Data Integration The sample program in the /dataintegration directory demonstrates the use of the workflow and task operations available in the Data Integration web services. Name of the domain that contains the Repository Service. Name or IP address of the machine on which the Web Services Hub is running.cs This sample program logs in to a repository and connects to the associated Integration Service. It uses Data Integration web services operations to start and stop a workflow running on the Integration Service.sh File to run Java sample: RunSample2.bat or RunSample1.sh File to run Java sample: RunSample1. Sample1.cs This sample program logs in to a repository and connects to the associated Integration Service.bat or RunSample2. Directory: /browsing File to compile Java and C# samples: CompileSample2.

The examples do not support secure mode (HTTPS). Name of the domain that contains the Integration Service.The following table describes the parameters you use to run the Sample1 application: Parameter Security mode Description Indicates the security mode in which to run the application. Name of the Integration Service.txt.bat or CompileSample1. Name of a folder in the repository. User name to log in to the repository.bat or RunSample1. Name of the Repository Service.exe Examples for Batch Web Services 101 . It stores the workflow logs in a text file named WorkflowLog. It stores the session logs in a text file named SessionLog.txt. Name of the workflow that contains the session. Host name Port number Repository domain name Repository name User Name Password Integration Service domain name Integration Service name Folder Name Workflow name Task name Logs The sample program in the /logfetching directory demonstrates the use of Data Integration web services operations to access the workflow and session logs. Name of the task to start. Port number on which the Web Services Hub is running.java and Sample1.cs This sample program logs in to a repository and connects to the associated Integration Service. It uses Data Integration web services operations to fetch workflow and session logs. Password for the user name to log in to the repository. Pass the argument -ns to run the application in unsecure mode (HTTP).sh File to run Java sample: RunSample1. Directory: /logfetching File to compile Java and C# samples: CompileSample1. Name of the domain that contains the Repository Service.sh File to run C# sample: Sample1. Name or IP address of the machine on which the Web Services Hub is running. Sample1.

You can use the same technique to simultaneously access any number of Integration Services associated with a Repository Service.bat or RunSample1. you must create two proxy objects for the Data Integration web services to log in to two Integration Services.cs This sample program logs in to a repository and connects to two of the Integration Services associated with the repository. Note: As the example shows.exe 102 Appendix A: Web Service Sample Client Applications .The following table describes the parameters you use to run the Sample1 application: Parameter Security mode Description Indicates the security mode in which to run the application.bat or CompileSample1. The examples do not support secure mode (HTTPS). Sample1. Name of the folder in the repository that contains the workflow. Name or IP address of the machine on which the Web Services Hub is running. Name of the Integration Service. Host name Port number Repository domain name Repository name User Name Password Integration Service domain name Integration Service name Folder Name Workflow name Task name Multiple Integration Services The sample program in the /multiservers directory demonstrates logging in to more than one Integration Service associated with a Repository Service. Name of a task in the workflow. Port number on which the Web Services Hub is running. Password for the user name to log in to the repository.sh File to run Java sample: RunSample1. It uses Data Integration web services operations to get the properties of both Integration Services.sh File to run C# sample: Sample1.java and Sample1. Directory: /multiservers File to compile Java and C# samples: CompileSample1. Name of the domain that contains the Repository Service. Create one proxy object for each Integration Service that you want to log in to. Pass the argument -ns to run the application in unsecure mode (HTTP). Name of the workflow that contains the task. Name of the domain that contains the Integration Service. User name to log in to the repository. Name of the Repository Service.

It starts two threads and passes the Data Integration web service proxy object to both threads. it starts a workflow on the Integration Service and waits until it completes.bat or RunSample1. On one thread.exe Examples for Batch Web Services 103 . Name of the domain that contains the Repository Service.java and Sample1. Name of the an Integration Service associated with the repository. Pass the argument -ns to run the application in unsecure mode (HTTP). Port number on which the Web Services Hub is running.bat or CompileSample1. it gets the properties of the Integration Service. Name of the Repository Service. The examples do not support secure mode (HTTPS). Similarly. Name of a second Integration Service associated with the repository. Directory: /multithreaded File to compile Java and C# samples: CompileSample1.The following table describes the parameters you use to run the Sample1 application: Parameter Security mode Description Indicates the security mode in which to run the application.cs This sample program logs in to a repository and connects to the associated Integration Service. Name of the domain that contains the Integration Service. You can use the same technique to enable a client application to continue running and calling other operations as it waits for an operation to complete. if a client application calls the WaitTillWorkflowComplete operation on thread. Host name Port number Repository domain name Repository name User Name Password Integration Service domain name Integration Service name 1 Integration Service name 2 Multithreading The sample program in the /multithreaded directory demonstrates the use of proxy objects in multiple threads to perform operations in parallel. Password for the user name to log in to the repository. On the other thread.sh File to run Java sample: RunSample1. User name to log in to the repository.sh File to run C# sample: Sample1. you can use a Metadata web services proxy object in multiple threads. Sample1. the application can continue to perform other operations on other threads. For example. Name or IP address of the machine on which the Web Services Hub is running.

bat or CompileSample1. Name of the folder in the repository that contains the workflow.sh File to run C# sample: Sample1. It uses Metadata and Data Integration web services operations to get the information about the Repository Service and Integration Service.java and Sample1.The following table describes the parameters you use to run the Sample1 application: Parameter Security mode Description Indicates the security mode in which to run the application. Directory: /testsamples File to compile Java and C# samples: CompileSample1. User name to log in to the repository. Port number on which the Web Services Hub is running. Pass the argument -ns to run the application in unsecure mode (HTTP).sh File to run Java sample: RunSample1.exe 104 Appendix A: Web Service Sample Client Applications . Name of the domain that contains the Repository Service. The examples do not support secure mode (HTTPS).cs This sample program logs in to a repository and connects to the associated Integration Service. Name or IP address of the machine on which the Web Services Hub is running. Name of the domain that contains the Integration Service. Password for the user name to log in to the repository. Sample1. Name of the Integration Service. Host name Port number Repository domain name Repository name User Name Password Integration Service domain name Integration Service name Folder Name Workflow name Web Services Hub Test The sample program in the /testsamples directory demonstrates how to verify that a valid Web Services Hub is running in a PowerCenter domain. Name of a workflow in the repository.bat or RunSample1. Name of the Repository Service.

The following table describes the parameters you use to run the Sample1 application: Parameter Security mode Description Indicates the security mode in which to run the application. Name or IP address of the machine on which the Web Services Hub is running. Port number on which the Web Services Hub is running. Host name Port number Repository domain name Repository name User Name Password Integration Service domain name Integration Service name Examples for Batch Web Services 105 . Name of the Repository Service. Name of the Integration Service. Pass the argument -ns to run the application in unsecure mode (HTTP). User name to log in to the repository. The examples do not support secure mode (HTTPS). Name of the domain that contains the Integration Service. Name of the domain that contains the Repository Service. Password for the user name to log in to the repository.

Run the Realtime web services sample programs. Contains the library files needed to run the sample programs. Import the mappings and web service workflows into the repository associated with the Web Services Hub. Each directory contains the batch and script files to compile and run the sample program and subfolders for the proxy classes used by the sample program. 4. Create the database tables that the sample programs will use as lookup tables. The source file for each Realtime web services sample program can be found in a separate directory. Contains the Java sample programs. Compile the Realtime web services sample programs. Set up the database connection settings in the sample workflows. 3. PowerCenter must be installed and running. 106 Appendix A: Web Service Sample Client Applications . 5. The /RealTimeWebServices directory contains the following files and directories: Directory /ImportXML Description Contains the web service workflows called by the Realtime web services sample programs. To use the sample programs. import the XML files into a repository and set up the database connections for the SQL and Lookup transformations in the web service workflows. The Realtime web services sample programs are installed in the following directory: /<PowerCenterInstallDir>/server/samples/RealTimeWebServices The Realtime web services examples include the files to create the lookup tables and web service workflows to be used by the sample programs. you must complete the following steps: 1. /lib /LookupSQL /samples/axis/<SampleProgramDirectory> To use the Realtime web services examples.Using the Realtime Web Services Sample Programs Before you use the Realtime web services sample programs. Contains the SQL scripts for creating the lookup tables used by the web service workflows called by the sample programs. The PowerCenter domain must contain a Web Services Hub associated with a Repository Service. 2. Run the SQL scripts to create tables in an Oracle database.

Step 1. Create the Lookup Tables
Use the SQL script files shipped with the Batch web services sample programs to create the lookup tables on an Oracle database. The SQL scripts include the following files:
Script File Name CustomerLookup_SINGLEROW.sql CustomerLookup_MULTIPLEROW.sql Description Creates a customer table named SINGLEROWLOOKUP for use with the sample program for single row lookup. Creates a customer table named MULTIPLEROWLOOKUP for use with the sample program for multiple row lookup.

Note the database connection settings. After you import the sample workflows into a repository, you need to modify the database connection settings of the transformations in the workflows to match your database settings.

Step 2. Import the Mappings and Workflows
The Realtime web services sample programs run the sample web service workflows. To use the sample programs, import the sample mappings and workflows into the repository associated with the Web Services Hub. The XML files include the following files:
Script File Name wf_CustomerLookup_SINGLEROW.XML wf_CustomerLookup_MULTIPLEROW.XML Description Contains a web service workflow with a Lookup transformation for use with the sample program for single row lookup. Contains a web service workflow with an SQL transformation for use with the sample program for multiple row lookup.

For more information about importing metadata objects into a repository, see the PowerCenter Repository Guide.

Step 3. Modify the Database Connection Settings
The SQL and Lookup transformations in the imported workflows must be able to connect to the sample database tables created in “Step 1. Create the Lookup Tables” on page 107. The import process does not import the connection object for the transformations in the sample workflows. You must create a connection object and use it in the session. To update the connection settings for the transformations, complete the following steps: 1. 2. In the PowerCenter Workflow Manager, create a connection object to connect to the sample tables. In the PowerCenter Workflow Manager edit the s_m_CustomerLookup_SINGLEROW session and update the relational connection information in the lkp_Customer transformation.
Using the Realtime Web Services Sample Programs 107

Set the relational connection to the name of the new connection object. Save the session with the new settings. 3. In the PowerCenter Workflow Manager, edit the s_m_CustomerLookup_MULTIPLEROW session and update the connection information in the sql_Customer transformation. Set the relational connection to the name of your connection object. Save the session with the new settings.

Step 4. Compile the Realtime Web Service Sample Programs
To compile the sample Java programs, go to the sample program directory and run the compile batch or script file. Run the batch or script file that matches the name of the sample program you want to compile. For example, to compile Sample.java program in the /axis/CustomerLookup_SINGLEROW directory, go to the directory and run CompileSample.bat (Windows) or CompileSample.sh (UNIX). The compile process creates a .class file for the sample program in the same directory.

Step 5. Run the Realtime Web Service Sample Programs
The Web Services Hub must be running when you run a sample program. To run the sample Java programs, go to the sample program directory and run the batch or script file for the sample program you want to run. For example, to run the Sample.java program in the /axis/CustomerLookup_MULTIPLEROW directory, go to the directory and run RunSample.bat (Windows) or RunSample.sh (UNIX). Run the sample program with the required parameters. For more information on the sample programs and parameters, see “Examples for Realtime Web Services” on page 109.

108

Appendix A: Web Service Sample Client Applications

Examples for Realtime Web Services
This section describes the sample programs for Realtime web services. Each directory contains a sample program that demonstrates a different way to use Realtime web services.

Multiple Row Lookup
The sample program in the /CustomerLookup_MULTIPLEROW directory demonstrates how a client application can run a web service workflow to perform a lookup and handle a response with multiple rows of data.

Sample.java
This sample program calls a PowerCenter web service workflow that looks up a customer ID in a database and prints out the customer information. The workflow uses an SQL transformation to retrieve multiple rows from the database. Directory: /CustomerLookup_MULTIPLEROW File to compile Java sample: CompileSample.bat or CompileSample.sh File to run Java sample: RunSample.bat or RunSample.sh The following table describes the parameters you use to run the Sample application:
Parameter Customer ID EndPoint URL Description ID for the customer to look up. Pass the customer ID as an integer. URL where the web service can be found. Pass the endpoint URL as a string. The endpoint URL for a realtime web service can be found in the soap:address location element of the service element in the web service WSDL. The default endpoint URL for the sample web service is http://<WSHHostName>:<WSHPort>/wsh/services/ts/CustomerLookup_MULTIPLEROW. If the Web Services Hub is running on HTTPS, the endpoint URL starts with HTTPS.

Single Row Lookup
The sample program in the /CustomerLookup_SINGLEROW directory demonstrates how a client application can run a web service workflow to perform a lookup and handle a response with single row of data.

Sample.java
This sample program calls a PowerCenter web service workflow that looks up a customer ID in a database and prints out the customer information. The mapping uses a Lookup transformation to retrieve one row from the database. Directory: /CustomerLookup_SINGLEROW File to compile Java samples: CompileSample.bat or CompileSample.sh File to run Java sample: RunSample.bat or RunSample.sh
Examples for Realtime Web Services 109

The default endpoint URL for the sample web service is http://<WSHHostName>:<WSHPort>/wsh/services/ts/CustomerLookup_SINGLEROW. the endpoint URL starts with HTTPS. 110 Appendix A: Web Service Sample Client Applications . Pass the endpoint URL as a string.The following table describes the parameters you use to run the Sample application: Parameter Customer ID EndPoint URL Description ID for the customer to look up. The endpoint URL for a realtime web service can be found in the soap:address location element of the service element in the Web service WSDL. Pass the customer ID as an integer. If the Web Services Hub is running on HTTPS. URL where the web service can be found.

1 This appendix includes the following topics: ♦ ♦ ♦ Overview.1. 113 Data Integration Web Services.Appendix B Web Service Operations in 8. 112 Metadata Web Services. 114 111 .

1 take the same required parameters as operations in version 7. add the repository authentication operations (Login and Logout) to the client application.1 can optionally take the same parameters as operations in version 8.1.Overview Effective in version 8.1.4.1 . Operations in version 8.1.1. To run client applications written for version 8.1. Most of these operations are also available in version 8.1. the Web Services Hub supports the web service operations available in version 7.1.1. 112 Appendix B: Web Service Operations in 8.1.1.4 with no changes in version 8. In addition.1.1.4. You can run client applications written for version 7. operations in version 8.1.

1.Metadata Web Services The Metadata web services provide the following operations: Operation getAllDIServers getAllFolders getAllRepositories getAllTaskInstances getAllWorkflows Login Logout Available in 7.1 Yes Yes Yes Yes Yes No No Metadata Web Services 113 .4 Yes Yes Yes Yes Yes Yes Yes Available in 8.

1 .1 No Yes No Yes Yes Yes Yes Yes Yes No Yes Yes No Yes Yes No Yes Yes Yes No Yes Yes Yes Yes Yes The following operations are not available: ♦ ♦ resumeTask stopDIServer 114 Appendix B: Web Service Operations in 8.1.Data Integration Web Services The Data Integration web services provide the following operations: Operation deinitializeDIServerConnection getDIServerProperties getNextLogSegment getSessionLog getSessionPerformanceData getSessionStatistics getTaskDetails getWorkflowDetails getWorkflowLog initializeDIServerConnection monitorDIServer pingDIServer recoverWorkflow resumeWorkflow (Deprecated) scheduleWorkflow startSessionLogFetch startTask startWorkflow startWorkflowFromTask startWorkflowLogFetch stopTask stopWorkflow unscheduleWorkflow waitTillTaskComplete waitTillWorkflowComplete Available in 7.1.4 Yes Yes Yes Yes Yes Yes Yes Yes No Yes Yes Yes No Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Yes Available in 8.

15. 48 initialization in . 26 downloading WSDL 15 Metadata web service operations 27 running sample programs 98 viewing published services 15 C caching configuring for web services 87 clean up Axis client application 43 web service client application 39 client applications clean up in Axis 43 creating request objects for Realtime web services 51 developing 37 error handling 39.NET 44 initialization in Axis 40 initializing objects for Realtime web services 51 operation calls 38.NET 46 error handling in Axis 43 generating proxy classes 37. 49 operation calls in .Index A attachments flat file mappings 75 mapping 75 SOAP messages 87 XML mappings 75 authentication Web Services Hub security 20 authorization Web Services Hub security 20 B Batch web services compiling sample programs 97 Data Integration web service operations 29 description 8. 49 error handling in .NET 45 session maintenance in Axis 42 115 .NET 44 generating proxy classes in Axis 40 initialization 37. 48 generating proxy classes for Realtime web services 51 generating proxy classes in .NET 45 operation calls in Axis 42 proxy objects 39 Realtime web services 50 resource clean up 39 sending request objects for Realtime web services 52 session maintenance 38 session maintenance in .

49 F fault body SOAP 23 fault detail SOAP 23 fault handling SOAP 22 fault header SOAP 22 faultcode SOAP 23 faultstring SOAP 23 flat file sessions guidelines 90 flat files mappings 75 flush latency description 90 D Data Integration web service operations deinitializeDIServerConnection 30 getDIServerProperties 30 getNextLogSegment 30 getSessionLog 31 getSessionPerformanceData 31 getSessionStatistics 31 getTaskDetails 31 getWorkflowDetails 31 getWorkflowLog 32 monitorDIServer 32 pingDIServer 32 recoverWorkflow 33 resumeWorkflow 33 scheduleWorkflow 33 startSessionLogFetch 33 startTask 33 startWorkflow 33 startWorkflowFromTask 33 startWorkflowLogFetch 34 stopTask 34 stopWorkflow 34 unscheduleWorkflow 34 waitTillTaskComplete 34 waitTillWorkflowComplete 34 Data Integration web services description 29 operations available in version 8.1 114 operations not available in version 8.NET client application 46 Axis client application 43 client application 39.1.1 114 G generating names XML columns 63 getAllDIServers Metadata web service operation 27 getAllFolders Metadata web service operation 27 getAllTaskInstances Metadata web service operation 28 getAllWorkflows Metadata web service operation 28 getDIServerProperties Data Integration web service operation 30 116 Index .1.writing in .NET using C# 44 writing in Java using Axis 40 client proxy classes See proxy classes commit type configuring 88 configuring cache for web services 87 commit type 88 reader properties 82 writer properties 85 console Web Services Hub 15 Create entity relationships XML view option 61 Create hierarchical relationships XML view option 61 deinitializeDIServerConnection Data Integration web service operation 30 deprecated operations resumeWorkflow 33 E encryption Web Services Hub security 20 error handling .

27 operations available in version 8. 48 initializing Realtime web services client applications 51 installation web services sample programs 96 O one-way mappings description 72 operation calls . 49 operations Data Integration web services 29 Metadata web services 27 L load scope configuring 70 log files configuring 21 viewing 21 Login Metadata web service operation 28 Logout Metadata web service operation 28 logs Web Services Hub 21 P parameter arrays defining in web service application 53 guidelines for web service clients 56 in web service application 53 parameters using a parameter array 53 partitioning web service sessions 88 Index 117 .1 113 monitorDIServer Data Integration web service operation 32 I importing web service source definitions 59 web service target definitions 60 importing source definitions steps 61 importing target definitions steps 61 infinite precision overriding 63 initialization .NET client application 44 Axis client application 40 client application 37.NET client application 45 Axis client application 42 web service client applications 38.1.getNextLogSegment Data Integration web service operation getSessionLog Data Integration web service operation getSessionPerformanceData Data Integration web service operation getSessionStatistics Data Integration web service operation getTaskDetails Data Integration web service operation getWorkflowDetails Data Integration web service operation getWorkflowLog Data Integration web service operation 30 31 31 31 31 31 32 M mappings attachment 75 flat file 75 one-way 72 request-response 72 staged 73 XML 75 message IDs propagating 73 messages recovering 87 metadata extensions web service definitions 69 Metadata web service operations getAllDIServers 27 getAllFolders 27 getAllTaskInstances 28 getAllWorkflows 28 Login 28 Logout 28 Metadata web services description 8.

16 request objects creating in Realtime web services client applications 51 sending from Realtime web services client applications 52 request-response mapping using a SQL transformation 73 request-response mappings description 72 resumeWorkflow Data Integration web service operation 33 deprecated operation 33 runnable service workflow property 81 S sample programs batch web services examples 99 compiling Batch web services examples 97 compiling Realtime web services examples 108 realtime web services examples 109 running Batch web services examples 98 running Realtime web services examples 108 web services 96 scheduleWorkflow Data Integration web service operation 33 security authentication 20 authorization 20 encryption 20 service configuring 79 service timeout description 90 service workflow configuring 79 creating 79 service workflows troubleshooting 92 session ID Metadata proxy objects 39 session maintenance .pingDIServer Data Integration web service operation 32 pipeline partitioning web service sessions 88 precision overriding infinite length 63 protected service workflow property 80 proxy classes generating 37. 48 generating for Realtime web services 51 generating in .NET client application 45 Axis client application 42 client application 38 session properties Reader Time Limit 84 Real-time Flush Latency 84 sessions guidelines for XML and flat file sessions 90 R reader properties configuring 82 Reader Time Limit description 84 Real-time Flush Latency configuring 84 description 84 real-time session property 84 real-time sessions configuring source-based commit 88 configuring target-based commit 88 Real-time Flush Latency property 84 Recovery Cache Folder property 84 Realtime web services compiling sample programs 108 creating web service 50 description 9. 50 running sample programs 108 using the Designer 58 viewing published services 16 recoverWorkflow Data Integration web service operation 33 recovery messages 87 Recovery Cache Folder real-time session property 84 118 Index .NET 44 generating in Axis 40 proxy objects client application 39 session ID 39 published services viewing 15. 16 developing client application 50 downloading WSDL 16.

1 112 not available in version 8.Simple Object Access Protocol See SOAP SOAP body 4 description 4 envelope 4 fault body 23 fault detail 23 fault handling 22 fault header 22 fault schema 23 faultcode 23 faultstring 23 guidelines for parameter arrays 56 header 4 message attachments 87 web service component 2 source definitions web services 59 source-based commit configuring 88 SQL transformation request-response mapping 73 staged mapping description 73 startSessionLogFetch Data Integration web service operation startTask Data Integration web service operation startWorkflow Data Integration web service operation startWorkflowFromTask Data Integration web service operation startWorkflowLogFetch Data Integration web service operation stopTask Data Integration web service operation stopWorkflow Data Integration web service operation troubleshooting service workflows 92 U UDDI web service component 2 Universal Description.1. Discovery. and Integration See UDDI unscheduleWorkflow Data Integration web service operation 34 V visible service workflow property 81 W waitTillTaskComplete Data Integration web service operation 34 waitTillWorkflowComplete Data Integration web service operation 34 web service components SOAP 2 UDDI 2 WSDL 2 Web Service Definition Language See WSDL web service definitions editing 66 viewing 66 viewing in the XML Editor 69 web service operations available in version 8.1 114 web service sessions pipeline partitioning 88 web service targets configuring load scope 70 web services Batch 8 batch client applications in Axis 40 batch client applications in C# 44 batch web services sample programs 99 building blocks 3 compiling Batch web services examples 97 compiling Realtime web services examples 108 configuring service workflows 80 Data Integration 8 Index 119 33 33 33 33 34 34 34 T target definitions web services 60 target-based commit configuring 88 TaskRequest using a parameter array 54 timeout description 90 service workflow property 80 .1.

importing source definitions 61 importing target definitions 61 Metadata 8 overview 2 overview of sample programs 96 Realtime 9 realtime client applications 50 realtime web services sample programs 109 running Batch web services examples 98 running Realtime web services examples 108 source definitions 59 target definitions 60 troubleshooting 92 Web Services Hub Batch web services 15 console 15 description 8. 14 logs 21 Realtime web services 16 Web Services Provider See also Web Services Hub architecture 10 configuring reader 82 configuring writer 85 WorkflowRequest using a parameter array 54 writer properties configuring 85 WSDL Batch web services 15 description 5 Realtime web services 16. 50 web service component 2 X XML columns generating names 63 XML Editor viewing web service definitions 69 XML sessions guidelines 90 XML views options 61 120 Index .

Sign up to vote on this title
UsefulNot useful