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

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

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

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

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

viii Table of Contents .

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

x List of Figures .

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

xii List of Tables .

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

The material in this book is also available online. 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. italicized text boldfaced text italicized monospaced text Note: Tip: Warning: monospaced text bold monospaced text xiv Preface . unless you follow the specified procedure. This is a code example.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. Document Conventions This guide uses the following formatting conventions: If you see… It means… The word or set of words are especially emphasized. Emphasized subjects. This is an operating system command you enter from a prompt to run a task. The following paragraph provides additional facts. The following paragraph provides suggested uses. The following paragraph notes situations where you can overwrite or corrupt data. This is generic text that should be replaced with user-supplied values. This is the variable name for a value you enter as part of an operating system command. This guide assumes that you have a working knowledge of web service concepts and PowerCenter mappings and workflows.

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

com for technical inquiries support_admin@informatica.Use the following email addresses to contact Informatica Technical Support: ♦ ♦ support@informatica. White Waltham Maidenhead.com for general customer service requests WebSupport requires a user name and password.informatica. North America / South America Informatica Corporation Headquarters 100 Cardinal Way Redwood City. You can request a user name and password at http://my. Berkshire SL6 3TN United Kingdom Asia / Australia Informatica Business Solutions Pvt. 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 . Ltd. California 94063 United States Europe / Middle East / Africa Informatica Software Ltd.com. 6 Waltham Park Waltham Road. Diamond District Tower B.

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

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

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

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

and a binding to a protocol or transport. 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. The WSDL file contains a description of the data. 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.Web Services Description Language (WSDL) The WSDL is an XML document that describes the protocols and formats used by a web service. so that the sender knows how to send it. see “Using the Web Services Hub Console” on page 15. For more information about the Web Services Hub Console. Web Services Description Language (WSDL) 5 . so that the receiver of a message knows how to process it. The WSDL elements also contain a description of the operations to be performed on that data.

6 Chapter 1: Web Services Concepts .

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

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

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

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. or get log information. 2. These web services communicate with the Integration Service and the Repository Service. the Integration Service sends the processed data to the Web Services Hub which uses the message ID to correlate the request with the response. The following process describes the architecture of the Web Services Provider: 1. start or stop the server.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 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 realtime service. The request may be to run or monitor a workflow. 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. For Batch web services or protected Realtime web services. the Web Services Hub generates a message ID and sends the SOAP request to the Integration Service. 4. 3. 10 Chapter 2: Understanding the Web Services Provider . The Web Services Hub generates a message ID for the request. The Integration Service processes the request. The Web Services Hub sends a SOAP response to the web service client. A web service client sends a SOAP message to the Web Services Hub to run a service. If the service request is for a batch service.

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

12 Chapter 2: Understanding the Web Services Provider .

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

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

Use the following URL to connect to the Web Services Hub console: http://<WebServicesHubHostName:PortNumber>/wsh The default port is 7333. The Batch web services page displays the list of available operations and their descriptions. Web Services Hub Console Batch Web Services To view the WSDL files for the Batch web services. save the WSDL file to your local machine. You can connect to the Web Services Hub from any browser. Using the Web Services Hub Console 15 . Figure 3-1 shows the main page for the Web Services Hub console: Figure 3-1. Note: You can also use the context name PowerCenter. The Web Services Hub redirects the URL http://<HostName>:<PortNumber>/PowerCenter to the default URL http://<HostName>:<PortNumber>/wsh . You can click the icons for the Metadata WSDL and DataIntegration WSDL to view the WSDL files. To download. click the Batch Web Services link.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. 16 Chapter 3: Understanding the Web Services Hub . You can click the WSDL icon for the service to view the WSDL file. you can view the list of available web services and the WSDL files for the services. save the WSDL file to your local machine. Realtime Web Services After you create mappings and web service workflows. On the Realtime Web Services page. see “Metadata Web Service Operations” on page 27.Figure 3-2 shows the main page for the Batch web services page: Figure 3-2. For more information about the Data Integration web service operations. you can view the web service information published by the Web Services Hub. For more information about the Metadata web service operations. see “Data Integration Web Service Operations” on page 29. Batch Web Services Page Use the Metadata WSDL to write client applications that call Metadata web service operations. Use the DataIntegration WSDL to write client applications that call Data Integration web service operations.

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

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

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

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

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

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

com/wsh"> <ErrorCode> Error Code </ ErrorCode > <ExtendedDetails> Actual Error </ ExtendedDetails > </ns:WSHFaultDetails> </detail> </SOAP-ENV: Fault> SOAP Fault Handling 23 . or Repository Service. Detail.informatica. If the error originates at the web service client. Web Services Hub. The faultcode determines if the error originates at the web service client or the Integration Service. 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. The faultstring value indicates that the error originated from the Integration Service. The detail element contains error information that includes an error code. The faultstring provides a description of the error. Faultstring.SOAP Fault Body The SOAP fault body contains the following sub-elements: ♦ Faultcode. ♦ ♦ 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.

24 Chapter 3: Understanding the Web Services Hub .

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

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

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. you do not need to log in to a repository to use the operation. 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. see “Login” on page 28. Before a Web Services Hub client application can use a repository. you must associate the repository with the Web Services Hub. In a multiple Integration Service environment. Metadata Web Service Operations 27 . You can call the getAllRepositories operation without calling the Login operation. getAllRepositories Use the getAllRepositories operation to view all repositories associated with the Web Services Hub. Use the Administration Console to associate a repository with a Web Services Hub. 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. 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. it is important to enter descriptive service names for each associated service to help users differentiate among Integration Services. Note: Since the getAllRepositories operation is not associated with a specific repository. see “Creating and Configuring a Web Services Hub” in the PowerCenter Administrator Guide. getAllDIServers You can associate one or more Integration Services with a repository to run workflows and sessions. For more information about associating a repository with the Web Services Hub.

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

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 . 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.

Use this operation with the startSessionLogFetch or startWorkflowLogFetch operation. see “startWorkflowLogFetch” on page 34. 30 Chapter 4: Batch Web Service Operations . see “getSessionLog” on page 31. deinitializeDIServerConnection This operation disconnects the client application from the Integration Service. You can use this operation if you want to get the information in a session or workflow log in increments. getDIServerProperties Use this operation to get the properties of the Integration Service. These operations are defined in the di. For more information about the pmcmd command line program.wsdl. Use this operation in conjunction with initializeDIServerConnection to manage the connection from the client application to the Integration Service. The Logout operation also releases connections to the Integration Service acquired by the client application and performs cleanup operations. 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. 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. For more information about the startSessionLogFetch operation.− startWorkflowLogFetch This section lists all operations available for the Data Integration web services. see “startSessionLogFetch” on page 33. For more information about the startWorkflowLogFetch operation. Note: This operation is equivalent to the disconnect pmcmd command. To get session log information in one operation. To get workflow log information in one operation. see the PowerCenter Command Line Reference.

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

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

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

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

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

The application development follows the same basic steps. Web services toolkits make it easy to create client applications by generating client-side proxy classes from the web service WSDL files.NET frameworks. To create a client application for the PowerCenter web services. You can use the Microsoft . 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 . you need the web service WSDL files and a web service toolkit. You can create a client application to run PowerCenter Batch or Realtime web services.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. 36 Chapter 5: Writing Client Applications .

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

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

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

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.java.apache. If the endpoint URL is not correct. 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.apache.wsdl. update the address element.wsdl. To generate client proxy classes in Java. Note: The sample code snippets in the following sections are taken from the Batch Web Services sample programs shipped with the Web Services Hub.WSDL2Java --NStoPkg http://www. These commands generate the client proxy classes in the folder /ProxyClasses in the ProxyClasses package. Use the following command to generate the client proxy classes: java org. Download the Metadata web services and Data Integration web services WSDL files from the Web Services Hub console. java org.apache. which is available in the definitions\service\port hierarchy in the WSDL file. for WSDL files named Metadata. DataIntegrationInterface.informatica.java.axis.wsdl.com/wsh=ProxyClasses -W <WSDLFile> The -W option turns off support for wrapped document literal services. The commands generate two proxy classes: − − MetadataInterface.informatica.wsdl and DataIntegration. For example. Contains the interface for the Metadata web services. run the following commands: java org. 2. complete the following steps: 1.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.wsdl. 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.com/wsh=ProxyClasses -W Metadata.axis. 40 Chapter 5: Writing Client Applications .informatica.wsdl.wsdl.WSDL2Java --NStoPkg http://www.axis.com/wsh=ProxyClasses -W DataIntegration.

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

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

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

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

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

see “Writing a Client Application in Java for Realtime Web Services” on page 50. 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. Visible. Before you create the client application. Generating Client Proxy Classes To use Realtime web services you create in PowerCenter. 2. Enable the Web Service option to turn a workflow into a web service workflow. Generate the client-side proxy classes from the WSDL file using the web service toolkit.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. Refer to the web services toolkit documentation for details on generating proxy classes. Enable the following options in the workflow to allow a client application to run the workflow: ♦ ♦ ♦ Web Service. Runnable. Web Service Workflows You build realtime web service client applications to run web services workflows. Download the WSDL for the realtime web service from the Web Services Hub console. you need to generate client proxy classes from the WSDL files of the web service you want to access. create the mappings and workflows in PowerCenter. Each toolkit generates the client proxy classes in a specific way. To generate client proxies. 48 Chapter 5: Writing Client Applications . 3. Enable the Runnable option to allow a client application to run the web service workflow. Enable the Visible option so that the Web Services Hub publishes the WSDL for the web service in the Web Services Hub console. complete the following steps: 1. Select the web services toolkit for the platform and language in which you want to develop.

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

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

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

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

The parameter file must be accessible to the Integration Service.Using Parameter Arrays In PowerCenter. you have the following parameters in a parameter file: [s_m_A] $a=1 $b=2 $c=3 Using Parameter Arrays 53 . name. When the Integration Service runs the workflow or task. To use a parameter array. such as a database connection or a source or target file. and value of the parameter. 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. specify the parameter file name in the client application. provide the parameter values in the elements of the parameter array in the client application. 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. 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. For example. 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. Parameter Array Definition The parameter definition in a SOAP request consists of the scope. For a web service client application. a parameter represents a value you can change between sessions.

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. 54 Chapter 5: Writing Client Applications .[WSH_Folder. Parameter param1 = new Parameter().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. 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].

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

the Integration Service uses the parameter array in the web service request when it runs the workflow. 56 Chapter 5: Writing Client Applications . 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. If you specify both a parameter file and parameter array in the SOAP request. the Web Services Hub returns the following fault: ERROR: Error: Both parameter list and parameter file are specified.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. Do not specify a parameter file name and a parameter array in the a SOAP request when you make a web service operation call. ♦ The parameter array in a SOAP request overrides any parameter file defined in the properties of a task or workflow.

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

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

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

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

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

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

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

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

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. Attributes Tab for a Web Service Definition MIME Type of Attachment 68 Chapter 6: Working with Mappings . If the definition has an Attachment group.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. the Attributes tab displays the MIME type in the data field.

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

the Integration Service generates a response after it receives all incoming data.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 all input. The Integration Service ignores commits when the load scope is all input. 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 transaction. XML Editor Views of Web Service Definition Editing Web Service Targets in a Mapping When you work with web service targets in a mapping. Transaction. the Integration Service generates a response when it receives all data in the transaction. All groups in the target must receive data from the same transaction generator. Different groups in the target can receive data from different transaction generators. You can configure the following load scope values: ♦ All input. ♦ 70 Chapter 6: Working with Mappings .

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. Viewing and Editing Web Service Definitions 71 . see “Understanding Commit Points” in the Workflow Administration Guide.

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

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

It also uses the MQSeries queue with the processed data as a source. 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. This mapping uses the flat file target as a source. Create a response mapping with a web service target definition.

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

you must connect all ports in the attachment group. 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.For example. you must create a client application using a toolkit that supports MIME attachments. Type of attachment. If you receive more than one attachment in a request. Or. Contains the attachment. 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. ♦ ♦ 76 Chapter 6: Working with Mappings . 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. you must propagate the index to the target if you pass the attached request to the response. If you do not pass the attached request to the response. If a definition in the mapping contains an attachment group. Unique identifier for each attachment in the message. If you receive messages from other sources. and each message contains the same number of attachments. you might set up a client application to allow web service clients to send PDF attachments in a request. To send or receive attachments. you do not need to propagate the index to the target. use a Sequence Generator transformation to generate a unique index for each attachment you send in a response. Use the following rules and guidelines when you work with attachments: ♦ ♦ ♦ ♦ A request or response can contain zero or more attachments. If you want to pass attachments through requests or responses. but you do not want to send or receive attachments. connect none of the ports in the group.

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

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

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. You can configure the web service to allow web service clients to run the workflow.Creating and Configuring a Web Service Workflow To create a web service workflow. Configure the web service. Create a web service workflow. Creating a Web Service Workflow Browse list of Integration Services. you create a web service workflow. Complete the following tasks when you create and configure a web service workflow: ♦ ♦ Create a web service workflow. Creating a Web Service Workflow When you enable the Web Services option for a workflow. The workflow can write to multiple fault message targets. Ensure that you specify an Integration Service when you create a web service workflow. configure a workflow to process a web service mapping and enable the Web Services option in the workflow properties. Creating and Configuring a Web Service Workflow 79 . Configure service. A service session is based on a service mapping. Figure 7-1 shows how to enable the workflow for web services: Figure 7-1. Use the Browse button to the right of the Server field to select from a list of available Integration Services.

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

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

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

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

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

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

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

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

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

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.When you configure partitions for a service mapping. Creating and Configuring a Service Session 89 . see the PowerCenter Workflow Administration Guide.

The Web Services Hub passes the SOAP message with the attachment to the Integration Service. If the web service workflow is configured with an XML or flat file writer. 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 Web Services Hub must generate the response message in the timeout period configured in the service properties. When the Web Services Hub reaches the timeout period. If the request is request-reply. it passes the response to the Web Services Hub. which processes the attachment. To configure a web service session. The Web Services Hub attaches the response to a SOAP message and sends it back to the web service client. 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. the Integration Service generates a response and passes the response to the Web Services Hub. 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. a client application sends a request to the Web Services Hub as an attachment to the SOAP message. Include one session in a workflow when you change the reader or writer type to Web Services Provider.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. 90 Chapter 7: Working With Web Service Workflows . The Web Services Hub generates a SOAP message response and passes it back to the web service client. For information about running services with flat file or XML mappings. After the Integration Service runs the web service request. When you change the reader or writer type in the session properties. The Integration Service generates an internal message ID for each request and automatically correlates the incoming request with the outgoing response. see “Working with Web Service Mappings” on page 72. it sends a fault message to the web service client and drops the connection. Understanding Service Timeout and Flush Latency When you run a service session. you must create a client application using a toolkit that supports MIME attachments. To run a web service workflow with an XML or flat file reader. it generates a message ID and passes the request to the Integration Service.

Running Sessions and Web Service Workflows 91 . the session runs continuously and never ends. 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>. For example. and you disable flush latency to flush all the messages at the end of the session. The Integration Service sends response messages when the buffer fills. you set flush latency to 90 and the service timeout to 60. Discarding the response. it drops the connection to the web service client and cannot send response messages received from the Integration Service. 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. If the Integration Service does not process all 10 messages in the service timeout period. if you disable flush latency. For example. 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. For example. 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. the Web Services Hub drops the connection to the web service client and cannot send response messages received from the Integration Service. To help ensure that the Web Services Hub does not reach the timeout period. you want the session to end after the Integration Service processes 10 messages. ♦ You disable flush latency and configure terminating conditions to infinite values.If the Integration Service sends a response message to the Web Services Hub after the timeout period. If you set the terminating conditions to infinite values. You set the message count to 10. If the Web Services Hub reaches the timeout period before the reader buffer fills. set the flush latency value to less than the service timeout. ♦ You disable flush latency and use message count as the terminating condition.

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

Troubleshooting 93 .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. This workflow cannot be accessed using WSH. ERROR Thu Mar 23 08:45:50 2006 http-52962-Processor4 [WSH_735] DI Service is not specified for workflow [wf_amazon_actor_search]. You must assign an Integration Service when you create a web service workflow.

94 Chapter 7: Working With Web Service Workflows .

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

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

The name of the directory indicates the Batch web services operations demonstrated in the sample program. This directory also contains the batch and script files to compile and run the sample programs. The source file for each Batch web services sample program can be found in a separate directory. Contains the Java sample programs. 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. For example. The PowerCenter domain must contain a Web Services Hub associated with a Repository Service. Contains a sample keystore for running client applications in secure mode (HTTPS). Contains the C# sample programs. the sample program in the /multiservers directory demonstrates logging in to more than one Integration Service associated with a Repository Service. Contains the proxy classes for the Java sample programs. The name of the directory indicates the Batch web services operations demonstrated in the sample program. For example. 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. This directory also contains the batch files to compile the proxy classes. Contains the proxy classes for the C# sample programs. The source file for each Batch web services sample program can be found in a separate directory.Using the Batch Web Services Sample Programs Before you use the Batch web services sample programs. Using the Batch Web Services Sample Programs 97 . Each sample program directory also contains the batch files to compile the sample programs.

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

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

Sample1. Name of the domain that contains the Repository Service.bat or CompileSample2.cs This sample program logs in to a repository and connects to the associated Integration Service.bat or CompileSample1. User name to log in to the repository.java and Sample2. Directory: /browsing File to compile Java and C# samples: CompileSample2.java and Sample1.sh File to run Java sample: RunSample2. Pass the argument -ns to run the application in unsecure mode (HTTP). Port number on which the Web Services Hub is running. The examples do not support secure mode (HTTPS).Sample2.sh File to run Java sample: RunSample1. It uses Data Integration web services operations to start and stop a workflow running on the Integration Service. 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.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. Name of the Repository Service.sh File to run C# sample: Sample2.bat or RunSample2. Name of the Integration Service.sh File to run C# sample: Sample1.exe 100 Appendix A: Web Service Sample Client Applications . Name or IP address of the machine on which the Web Services Hub is running. Password for the user name to log in to the repository Name of the domain that contains the Integration Service.cs This sample program logs in to a repository and connects to the associated Integration Service. Directory: /dataintegration File to compile Java and C# samples: CompileSample1. 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 RunSample1.

It stores the workflow logs in a text file named WorkflowLog.bat or RunSample1.txt. The examples do not support secure mode (HTTPS). Name of the domain that contains the Integration Service.cs This sample program logs in to a repository and connects to the associated Integration Service. Directory: /logfetching File to compile Java and C# samples: CompileSample1.exe Examples for Batch Web Services 101 . Name of the Integration Service. Port number on which the Web Services Hub is running. Sample1. Name of the workflow that contains the session. Name or IP address of the machine on which the Web Services Hub is running. Pass the argument -ns to run the application in unsecure mode (HTTP).txt. User name to log in to the repository.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 domain that contains the Repository Service.java and Sample1. Password for the user name to log in to the repository. Name of the task to start. Name of a folder in the repository.sh File to run C# sample: Sample1.bat or CompileSample1.sh File to run Java sample: RunSample1. It uses Data Integration web services operations to fetch workflow and session logs. Name of the Repository Service. It stores the session logs in a text file named SessionLog. 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.

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

Name of the Repository Service. Password for the user name to log in to the repository.bat or RunSample1. Name of the an Integration Service associated with the repository. The examples do not support secure mode (HTTPS). you can use a Metadata web services proxy object in multiple threads. Name of the domain that contains the Integration Service.java and Sample1. User name to log in to the repository.sh File to run C# sample: Sample1. it gets the properties of the Integration Service. Name of the domain that contains the Repository Service. On the other thread.cs This sample program logs in to a repository and connects to the associated Integration Service.sh File to run Java sample: RunSample1. For example.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. Sample1.bat or CompileSample1. Port number on which the Web Services Hub is running. Name of a second Integration Service associated with the repository. if a client application calls the WaitTillWorkflowComplete operation on thread. It starts two threads and passes the Data Integration web service proxy object to both threads. Directory: /multithreaded File to compile Java and C# samples: CompileSample1. 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. the application can continue to perform other operations on other threads. On one thread. it starts a workflow on the Integration Service and waits until it completes. 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. Name or IP address of the machine on which the Web Services Hub is running. Pass the argument -ns to run the application in unsecure mode (HTTP).exe Examples for Batch Web Services 103 . Similarly.

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. Pass the argument -ns to run the application in unsecure mode (HTTP). 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.sh File to run C# sample: Sample1. Directory: /testsamples File to compile Java and C# samples: CompileSample1. Port number on which the Web Services Hub is running. It uses Metadata and Data Integration web services operations to get the information about the Repository Service and Integration Service.bat or RunSample1.sh File to run Java sample: RunSample1. The examples do not support secure mode (HTTPS). Name or IP address of the machine on which the Web Services Hub is running. Name of the domain that contains the Repository Service.java and Sample1. Name of a workflow in the repository. Password for the user name to log in to the repository.exe 104 Appendix A: Web Service Sample Client Applications . Name of the Repository Service.bat or CompileSample1. Name of the Integration Service. Sample1.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. Name of the folder in the repository that contains the workflow. User name to log in to the repository.

Name of the Repository Service. Name of the domain that contains the Repository Service. Password for the user name to log in to the repository. Port number on which the Web Services Hub is running. User name to log in to the repository. Pass the argument -ns to run the application in unsecure mode (HTTP).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 domain that contains the Integration Service. Name of the Integration Service. 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 or IP address of the machine on which the Web Services Hub is running. The examples do not support secure mode (HTTPS).

To use the sample programs. Run the Realtime web services sample programs. Set up the database connection settings in the sample workflows. 3. 4. Import the mappings and web service workflows into the repository associated with the Web Services Hub. /lib /LookupSQL /samples/axis/<SampleProgramDirectory> To use the Realtime web services examples. Compile the Realtime web services sample programs. Run the SQL scripts to create tables in an Oracle database.Using the Realtime Web Services Sample Programs Before you use the Realtime web services sample programs. 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. 2. 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. 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 PowerCenter domain must contain a Web Services Hub associated with a Repository Service. Create the database tables that the sample programs will use as lookup tables. Contains the Java sample programs. 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. PowerCenter must be installed and running. 106 Appendix A: Web Service Sample Client Applications . 5. The source file for each Realtime web services sample program can be found in a separate directory. you must complete the following steps: 1. Contains the SQL scripts for creating the lookup tables used by the web service workflows called by the sample programs. Contains the library files needed to run the sample programs.

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

If the Web Services Hub is running on HTTPS. the endpoint URL starts with HTTPS.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 endpoint URL as a string. The default endpoint URL for the sample web service is http://<WSHHostName>:<WSHPort>/wsh/services/ts/CustomerLookup_SINGLEROW. Pass the customer ID as an integer. URL where the web service can be found. 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. 110 Appendix A: Web Service Sample Client Applications .

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

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

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

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.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.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.

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 .NET 44 generating proxy classes in Axis 40 initialization 37.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.NET 46 error handling in Axis 43 generating proxy classes 37. 15. 48 generating proxy classes for Realtime web services 51 generating proxy classes in .NET 44 initialization in Axis 40 initializing objects for Realtime web services 51 operation calls 38. 48 initialization in . 49 operation calls 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 45 session maintenance in Axis 42 115 . 49 error handling in .

1.NET client application 46 Axis client application 43 client application 39. 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.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 .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 .

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 .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.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 45 Axis client application 42 web service client applications 38.1.NET client application 44 Axis client application 40 client application 37.

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. 16 developing client application 50 downloading WSDL 16. 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 . 48 generating for Realtime web services 51 generating in .NET 44 generating in Axis 40 proxy objects client application 39 session ID 39 published services viewing 15.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. 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 .

Discovery.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. 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.1 112 not 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 .

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 . 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.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.

Sign up to vote on this title
UsefulNot useful